{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 |
| Item | As an item will be referred any of the following concepts, when displayed on the screen and when no special distinction is required: object record, object field and object field value. Each item is a RFD graph node. The object record itself is the 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; |
h3. State Chart Diagrams
h4. Object Record Item Versions
* Data entry against an object item 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 will be developed only part of the version record’s lifecycle.
* 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 research may select this status, when he is not sure that the value is correct, but want 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 or 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
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 v2.png|border=1!
Diagram 06.2 Use Case Diagram
h4. 06.DAUC01: View Object Record
*Preconditions:*
| 06.DANNOTATION.R5 | 06.DAUC01.R1 | | UC “TBD: Search Object” has been performed, an object record is successfully found and selected for review. |
| 06.DANNOTATION.R5 | 06.DAUC01.R2 | | Link (URI) to a data item is selected for review \- from a Data Basket, Discussion, Wiki page, etc. |
* *
*Constraints:*
| \\ | 06.DAUC01.R3 | RS3.3 \\ | Initially (TBD: When? RS3.3) only object records for CIDOC-CRM Paintings will be displayed for review and annotation. |
* *
*Transitions:* No
*Initiating operation/ button:* Link (URI) to object record, Link (URI) to object node/ literal
*GUI:*
* Object Record Details
*Description:*
| 06.DANNOTATION.R6 | 06.DAUC01.R4 | | When the user selects a link to an item, 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.DANNOTATION.R6 | 06.DAUC01.R6 | | *Object Record* area displays the information entered for an object. All data is displayed into one page and the user will be able to scroll it. |
| 06.DANNOTATION.R6 | 06.DAUC01.R6-1 | | * Information for all nodes of the object is expanded by default. |
| 06.DANNOTATION.R6 | 06.DAUC01.R6-2 | | * The user could manually collapse/ expand nodes |
| 06.DANNOTATION.R6 | 06.DAUC01.R6-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 neighbors. 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 area, by default for the object are displayed only field values with status “Original”. |
| 06.DANNOTATION.R15-1 | 06.DAUC01.R12-1 | | * If there is no value with status “Original” then will be displayed an empty value holder, thus the users will be able to propose new values. |
| \\ | 06.DAUC01.R13 | | Next to each node/literal in the Object Record area will be displayed the following indicators: |
| 06.DANNOTATION.R15-1 | 06.DAUC01.R13-1 | | * *Version Indicator:* If for a value 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. |
* *
*Post-Conditions*
| 06.DANNOTATION.R6 | 06.DAUC01.R15 | | Object record and all its related data are displayed successfully |
* *
h4. 06.DAUC02: View Field Versions
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC02.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
* *
*Constraints:*
| \\ | 06.DAUC02.R2 | | Version indicator is available only for field values (TBD: Is this correct?) |
| \\ | 06.DAUC02.R3 | | Version records with status “Deleted” from the current project are not displayed. |
* *
*Transitions:* No
*Initiating operation/ button:* Version indicator
*GUI:*
* Field Versions
*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: \\
* Value -- shows the new/updated value
* Research Project \--the project name, during which the value has been created/changed.
* 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
* 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. |
*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.R10 | | UC “06.DAUC03: Edit Field Version” could be started. |
| \\ | 06.DAUC02.R11 | | UC “06.DAUC04: Create Field Version” could be started. |
| \\ | 06.DAUC02.R12 | | A discussion for field version could be opened or new one started. |
* *
h4. 06.DAUC03: Edit Field Versions
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC03.R1 | | UC “06.DAUC02: View Field Version” has been performed and screen “Field Versions” is opened. |
| \\ | 06.DAUC03.R2 | | There is existing field version, which is displayed as record on the Field Versions screen |
* *
*Constraints:*
| \\ | 06.DAUC03.R3 | | Version records could be edited only from the researcher who created the version and the RS Project Admin. |
* *
*Transitions:*
\- Possible >Under Research
\- Possible >Proposed
\- Under Research >Proposed
*Initiating operation/ button:* Edit
*GUI:* Screen “Field Versions”
*Description:*
| \\ | 06.DAUC03.R4 | | For each version records will be provided an edit mode. |
| \\ | 06.DAUC03.R4-1 | | * The edit mode will be accessible only for the user who created the version and the RS Project Admin of the current project. |
| \\ | 06.DAUC03.R4-2 | | * The edit mode will be accessible only for version records in status Possible or Under Research. |
| \\ | 06.DAUC03.R5 | | The following information for each version could be edited: |
| \\ | 06.DAUC03.R5-1 | | * Version Status -- the version status could be updated manually from:\\
Possible to Under Research \\
Under Research to Proposed \\
Possible to Proposed |
| \\ | 06.DAUC03.R5-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 | The changes in field version are saved successfully and displayed on the screen. |
* *
h4. 06.DAUC04: Create Field Versions
*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 | | Different versions could be created only for field values (TBD: Is this correct?) |
* Transitions:*
\- New >Possible
\- New >Under Research
\- New >Proposed
*Initiating operation/ button:* Create New Version
*GUI*: Screen “Field Versions
*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.DANNOTATION.R8-1 | 06.DAUC04.R4 | | 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 “Start new discussion” becomes active and the user should start a 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. |
| \\ | 06.DAUC04.R6-1 | | * If the user does not save the new field version and cancels the entry then the created discussion 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 is linked to the version record, the version indicator is increased with 1 and the discussion indicator is also increased. |
| 06.DANNOTATION.R11 | 06.DAUC04.R7 | | When the version record is saved the following additional metadata are created: \\
\- 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*
| 06.DANNOTATION.R9 | 06.DAUC04.R8 | | A new version record is created and is visualized in Field Versions screen. |
| \\ | 06.DAUC04.R9 | | The version indicator counter is increased with 1 |
| \\ | 06.DAUC04.R10 | | The discussion indicator counter is increased with the new discussion and the number of new posts in the discussion. |
* *
h4. 06.DAUC05: Delete Field Versions
*Preconditions:*
| 06.DANNOTATION.R15-2 | 06.DAUC05.R1 | | UC “06.DAUC02: View Field Version” has been performed and screen “Field Versions” is opened. |
* *
*Constraints:*
| \\ | 06.DAUC05.R2 | | Version records could be deleted only if in status “Possible”, “Under Research” and “Proposed”. |
| \\ | 06.DAUC05.R3 | | Version records 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:* Screen “Field Versions
*Description:*
| 06.DANNOTATION.R15-6 | 06.DAUC05.R4 | | When a version record is deleted: |
| \\ | 06.DAUC05.R4-1 | | \- Version status changes to “Deleted” |
| \\ | 06.DAUC05.R4-2 | | \- The discussion associated with the version is deleted (TBD: or probably to be unlinked) |
| \\ | 06.DAUC05.R4-3 | | \- The version indicator decreases with 1 |
*Post-Conditions*
| 06.DANNOTATION.R15-6 | 06.DAUC05.R5 | | A version record is deleted and is no more visible in the Field Versions screen |
* *
h4. 06.DAUC06: View and Create Discussions on Object Record
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC06.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
*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
*Initiating operation/ button:* Link to a discussion, Discussion indicator
*GUI: *
\- Object Record Details/ Discussion area
\- 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.R15-1 | | * When 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.R16 | | When a discussion indicator next to version record is selected then user will be navigated to the discussion component, 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 is started from the discussion indicator in the “Field Versions” screen (see DAUC02: View Field Versions): |
| \\ | 06.DAUC06.R17-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.R17-2 | | * The discussion is automatically linked to the respective version record. |
| \\ | 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#\]. |
*Post-Conditions*
| \\ | 06.DAUC06.R21 | | All discussions linked to an object record are accessible from the Object Record Details screen. |
| \\ | 06.DAUC06.R22 | | A new comment/ discussion for a node/ record could be started easily from the Object Record Details screen. |
\\
h4. 06.DAUC07: Sort and Filter Discussions on Object Record
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC07.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
| 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
*GUI: *
\- Object Record Details/ Discussion area
*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.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. |
\\
h4. 06.DAUC08: View Linked Records
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC07.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
*Constraints:*
*Transitions:*
*Initiating operation/ button:* Linked Records Indicator
*GUI: *
\- Object Record/ Linked Records
*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). |
\\
*Post-Conditions*
| 06.DANNOTATION.R10 | | 06.DAUC07.R7 | All items linked to the current object item are counted and listed under linked records indicator. |
* *
h4. 06.DAUC09: View Thumbnails
*Preconditions:*
| \\ | 06.DAUC08.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
* *
*Constraints:*
*Transitions:*
*Initiating operation/ button:*
*GUI: *
\- Object Record/ Images Thumbnails
*Description:*
| 06.DANNOTATION.R17-1 \\
\\ | 06.DAUC08.R2 | | In Thumbnails area are displayed thumbnails to all images linked to the object record. |
| 06.DANNOTATION.R17-2 | 06.DAUC08.R3 | | Thumbnails will provide basic information for an image - file size, type, filename. |
| 06.DANNOTATION.R17-2 | 06.DAUC08.R4 | | Thumbnails to images will be used as links to Image Annotation tool |
\\
*Post-Conditions*
| 06.DANNOTATION.R17-1 | 06.DAUC08.R5 | | All thumbnails associated with an object record are displayed in the Thumbnail area \\ |
\\
\\
h3. Activity Diagrams
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
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 |
| Item | As an item will be referred any of the following concepts, when displayed on the screen and when no special distinction is required: object record, object field and object field value. Each item is a RFD graph node. The object record itself is the 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; |
h3. State Chart Diagrams
h4. Object Record Item Versions
* Data entry against an object item 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 will be developed only part of the version record’s lifecycle.
* 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 research may select this status, when he is not sure that the value is correct, but want 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 or 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
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 v2.png|border=1!
Diagram 06.2 Use Case Diagram
h4. 06.DAUC01: View Object Record
*Preconditions:*
| 06.DANNOTATION.R5 | 06.DAUC01.R1 | | UC “TBD: Search Object” has been performed, an object record is successfully found and selected for review. |
| 06.DANNOTATION.R5 | 06.DAUC01.R2 | | Link (URI) to a data item is selected for review \- from a Data Basket, Discussion, Wiki page, etc. |
* *
*Constraints:*
| \\ | 06.DAUC01.R3 | RS3.3 \\ | Initially (TBD: When? RS3.3) only object records for CIDOC-CRM Paintings will be displayed for review and annotation. |
* *
*Transitions:* No
*Initiating operation/ button:* Link (URI) to object record, Link (URI) to object node/ literal
*GUI:*
* Object Record Details
*Description:*
| 06.DANNOTATION.R6 | 06.DAUC01.R4 | | When the user selects a link to an item, 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.DANNOTATION.R6 | 06.DAUC01.R6 | | *Object Record* area displays the information entered for an object. All data is displayed into one page and the user will be able to scroll it. |
| 06.DANNOTATION.R6 | 06.DAUC01.R6-1 | | * Information for all nodes of the object is expanded by default. |
| 06.DANNOTATION.R6 | 06.DAUC01.R6-2 | | * The user could manually collapse/ expand nodes |
| 06.DANNOTATION.R6 | 06.DAUC01.R6-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 neighbors. 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 area, by default for the object are displayed only field values with status “Original”. |
| 06.DANNOTATION.R15-1 | 06.DAUC01.R12-1 | | * If there is no value with status “Original” then will be displayed an empty value holder, thus the users will be able to propose new values. |
| \\ | 06.DAUC01.R13 | | Next to each node/literal in the Object Record area will be displayed the following indicators: |
| 06.DANNOTATION.R15-1 | 06.DAUC01.R13-1 | | * *Version Indicator:* If for a value 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. |
* *
*Post-Conditions*
| 06.DANNOTATION.R6 | 06.DAUC01.R15 | | Object record and all its related data are displayed successfully |
* *
h4. 06.DAUC02: View Field Versions
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC02.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
* *
*Constraints:*
| \\ | 06.DAUC02.R2 | | Version indicator is available only for field values (TBD: Is this correct?) |
| \\ | 06.DAUC02.R3 | | Version records with status “Deleted” from the current project are not displayed. |
* *
*Transitions:* No
*Initiating operation/ button:* Version indicator
*GUI:*
* Field Versions
*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: \\
* Value -- shows the new/updated value
* Research Project \--the project name, during which the value has been created/changed.
* 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
* 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. |
*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.R10 | | UC “06.DAUC03: Edit Field Version” could be started. |
| \\ | 06.DAUC02.R11 | | UC “06.DAUC04: Create Field Version” could be started. |
| \\ | 06.DAUC02.R12 | | A discussion for field version could be opened or new one started. |
* *
h4. 06.DAUC03: Edit Field Versions
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC03.R1 | | UC “06.DAUC02: View Field Version” has been performed and screen “Field Versions” is opened. |
| \\ | 06.DAUC03.R2 | | There is existing field version, which is displayed as record on the Field Versions screen |
* *
*Constraints:*
| \\ | 06.DAUC03.R3 | | Version records could be edited only from the researcher who created the version and the RS Project Admin. |
* *
*Transitions:*
\- Possible >Under Research
\- Possible >Proposed
\- Under Research >Proposed
*Initiating operation/ button:* Edit
*GUI:* Screen “Field Versions”
*Description:*
| \\ | 06.DAUC03.R4 | | For each version records will be provided an edit mode. |
| \\ | 06.DAUC03.R4-1 | | * The edit mode will be accessible only for the user who created the version and the RS Project Admin of the current project. |
| \\ | 06.DAUC03.R4-2 | | * The edit mode will be accessible only for version records in status Possible or Under Research. |
| \\ | 06.DAUC03.R5 | | The following information for each version could be edited: |
| \\ | 06.DAUC03.R5-1 | | * Version Status -- the version status could be updated manually from:\\
Possible to Under Research \\
Under Research to Proposed \\
Possible to Proposed |
| \\ | 06.DAUC03.R5-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 | The changes in field version are saved successfully and displayed on the screen. |
* *
h4. 06.DAUC04: Create Field Versions
*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 | | Different versions could be created only for field values (TBD: Is this correct?) |
* Transitions:*
\- New >Possible
\- New >Under Research
\- New >Proposed
*Initiating operation/ button:* Create New Version
*GUI*: Screen “Field Versions
*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.DANNOTATION.R8-1 | 06.DAUC04.R4 | | 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 “Start new discussion” becomes active and the user should start a 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. |
| \\ | 06.DAUC04.R6-1 | | * If the user does not save the new field version and cancels the entry then the created discussion 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 is linked to the version record, the version indicator is increased with 1 and the discussion indicator is also increased. |
| 06.DANNOTATION.R11 | 06.DAUC04.R7 | | When the version record is saved the following additional metadata are created: \\
\- 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*
| 06.DANNOTATION.R9 | 06.DAUC04.R8 | | A new version record is created and is visualized in Field Versions screen. |
| \\ | 06.DAUC04.R9 | | The version indicator counter is increased with 1 |
| \\ | 06.DAUC04.R10 | | The discussion indicator counter is increased with the new discussion and the number of new posts in the discussion. |
* *
h4. 06.DAUC05: Delete Field Versions
*Preconditions:*
| 06.DANNOTATION.R15-2 | 06.DAUC05.R1 | | UC “06.DAUC02: View Field Version” has been performed and screen “Field Versions” is opened. |
* *
*Constraints:*
| \\ | 06.DAUC05.R2 | | Version records could be deleted only if in status “Possible”, “Under Research” and “Proposed”. |
| \\ | 06.DAUC05.R3 | | Version records 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:* Screen “Field Versions
*Description:*
| 06.DANNOTATION.R15-6 | 06.DAUC05.R4 | | When a version record is deleted: |
| \\ | 06.DAUC05.R4-1 | | \- Version status changes to “Deleted” |
| \\ | 06.DAUC05.R4-2 | | \- The discussion associated with the version is deleted (TBD: or probably to be unlinked) |
| \\ | 06.DAUC05.R4-3 | | \- The version indicator decreases with 1 |
*Post-Conditions*
| 06.DANNOTATION.R15-6 | 06.DAUC05.R5 | | A version record is deleted and is no more visible in the Field Versions screen |
* *
h4. 06.DAUC06: View and Create Discussions on Object Record
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC06.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
*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
*Initiating operation/ button:* Link to a discussion, Discussion indicator
*GUI: *
\- Object Record Details/ Discussion area
\- 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.R15-1 | | * When 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.R16 | | When a discussion indicator next to version record is selected then user will be navigated to the discussion component, 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 is started from the discussion indicator in the “Field Versions” screen (see DAUC02: View Field Versions): |
| \\ | 06.DAUC06.R17-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.R17-2 | | * The discussion is automatically linked to the respective version record. |
| \\ | 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#\]. |
*Post-Conditions*
| \\ | 06.DAUC06.R21 | | All discussions linked to an object record are accessible from the Object Record Details screen. |
| \\ | 06.DAUC06.R22 | | A new comment/ discussion for a node/ record could be started easily from the Object Record Details screen. |
\\
h4. 06.DAUC07: Sort and Filter Discussions on Object Record
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC07.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
| 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
*GUI: *
\- Object Record Details/ Discussion area
*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.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. |
\\
h4. 06.DAUC08: View Linked Records
*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC07.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
*Constraints:*
*Transitions:*
*Initiating operation/ button:* Linked Records Indicator
*GUI: *
\- Object Record/ Linked Records
*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). |
\\
*Post-Conditions*
| 06.DANNOTATION.R10 | | 06.DAUC07.R7 | All items linked to the current object item are counted and listed under linked records indicator. |
* *
h4. 06.DAUC09: View Thumbnails
*Preconditions:*
| \\ | 06.DAUC08.R1 | | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
* *
*Constraints:*
*Transitions:*
*Initiating operation/ button:*
*GUI: *
\- Object Record/ Images Thumbnails
*Description:*
| 06.DANNOTATION.R17-1 \\
\\ | 06.DAUC08.R2 | | In Thumbnails area are displayed thumbnails to all images linked to the object record. |
| 06.DANNOTATION.R17-2 | 06.DAUC08.R3 | | Thumbnails will provide basic information for an image - file size, type, filename. |
| 06.DANNOTATION.R17-2 | 06.DAUC08.R4 | | Thumbnails to images will be used as links to Image Annotation tool |
\\
*Post-Conditions*
| 06.DANNOTATION.R17-1 | 06.DAUC08.R5 | | All thumbnails associated with an object record are displayed in the Thumbnail area \\ |
\\
\\
h3. Activity Diagrams
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