You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f1d049c
Browse filesBrowse the repository at this point in the historyBrowse files
feat(ontology): new cardinality workflow (DSP-1652) (#455)
* refactor(ontology): init new cardinality workflow
* refactor(ontology): more on cardinality
* fix(ontology): update last modification date (DSP-1656)
* feat(ontology): add prop and set cardinality
* fix(ontology): update cardinality if prop not in use
* fix(ontology): cardinality in form
* fix(ontology): add property to res class
* refactor(ontology): clean up code
* feat(ontology): add existing prop to res class
* test(ontology): fix tests
* refactor(ontology): delete unused components and services
* chore(app): undo previous import organisation
* test(resource): fix routes issue in tests
* fix(ontology): make ts-lint happy
* docs(ontology): update ontology documentation
* docs(ontology): update ontology documentation incl. refactoring
* fix(ontology): bug and style fix in property form
Copy file name to clipboardExpand all lines: docs/how-to-use/project.md
+55-25Lines changed: 55 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,29 @@
2
2
3
3
## Project
4
4
5
-
Once you are [logged in](/user-guide/#login), the dashboard displays the list of your project(s). If you are a project administrator or a system administrator, you can edit the project information or archive your project from the project menu. Archived projects are stored in a list on your dashboard and they can be "reactivated" at any time.
5
+
Once you are [logged in](/user-guide/#login), the dashboard displays the list of your project(s). If you are a project administrator or a system administrator, you can edit the project information or archive your project from the project menu. Archived projects are stored in a list on your dashboard and they can be "reactivated" at any time.
6
6
7
-
*https://app2.dasch.swiss/dashboard - By clicking on the project name, you get access to the full project information.*
7
+
*<https://admin.dasch.swiss/dashboard> - By clicking on the project name, you get access to the full project information.*
8
8
9
9
System administrator can create your new research project. Essential information are required such as the project name, a short project description and institution information.
10
10
11
11
<center>*Form to create a new project.*</center>
12
12
13
13
As project administrator or system administrator, you can define your project, add your team members, create permission groups and as most important, define your data model (ontology) and the lists of your project.
14
14
15
-
*https://app2.dasch.swiss/project/0803/info - Project management functionalities; e.g. Incunabula project. Project information page is displayed without restricted content, the other functionalities are reserved for project admin and system admin.*
15
+
*<https://admin.dasch.swiss/project/0803/info> - Project management functionalities; e.g. Incunabula project. Project information page is displayed without restricted content, the other functionalities are reserved for project admin and system admin.*
16
16
17
17
---
18
18
19
19
## Collaboration
20
-
⚠*WORK IN PROGRESS*
21
20
22
21
As system admin, you can add users as project member and define their permissions roles: *Who is able to edit or to see data in the project?* Data includes the research sources and their metadata. [Permissions](/user-guide/project/#permission-groups) can be set for the entire project or for single metadata fields.
23
22
24
23
A user menu with different actions is accessible for each member of the project (link to the right side of the user line). The admin can appoint another user as project admin (or remove this permission), edit user's information, change user's password if forgotten, and remove a user.
25
24
26
-
*https://app2.dasch.swiss/project/0803/collaboration - Collaboration page where project admin and system admin can add new user to the team.*
25
+
*<https://admin.dasch.swiss/project/0803/collaboration> - Collaboration page where project admin and system admin can add new user to the team.*
27
26
28
-
***Permissions for project admins to add new users as project member will be implemented soon.***
27
+
> **_NOTE:_****Permissions for project admins to add new users as project member will be implemented soon.**
29
28
30
29
---
31
30
@@ -37,7 +36,6 @@ Project admin can create one or several permission groups in their project to se
37
36
---
38
37
39
38
## Data model
40
-
⚠*NOT YET IMPLEMENTED* (only mockups are presented)
41
39
42
40
The most important step in the project is the definition of the data model. DSP-APP will provide a tool for easy creation of data models. First, you have to know which data and sources you want to work with. The data model can be flexible and customizable. With DSP-APP, you can comply with the FAIR data standard, but compliance is not required to analyze your data.
43
41
@@ -54,19 +52,38 @@ The questions to answer in creating your data model:
54
52
- data about the person you interviewed
55
53
- location where the photograph was taken
56
54
57
-
Diagram 1 shows the relationships of the data by source type from these experiences.
55
+
Diagram 1 shows the relationships of the data by resource classes from these experiences.
56
+
57
+
*Relationship of the data by resource classes*
58
+
59
+
### Create your data model
60
+
61
+
Go to your project, select the tab `Data model` and click on button `New data model` or `Create your first data model` (in case of a brand new project). This will open a form in a dialog box where you have to set a unique name and a label. Optional you can also add a short description of form of a comment.
58
62
59
-
*Relationship of the data by source type*
63
+
> **_NOTE:_** There are some rules for the unique name:
64
+
>
65
+
> - must be at least 3 characters long
66
+
> - shouldn't begin with a number
67
+
> - shouldn't begin with the letter v and a number
68
+
> - spaces or special characters are not allowed
69
+
> - the term "ontology" is not allowed
70
+
> - the unique name can't be changed afterwards
71
+
72
+
The label is a combination of project's shortname and the unique name. You can replace with any other string.
73
+
74
+
*Data model editor | Step 1: Start by creating a new data model.*
60
75
61
76
---
62
77
63
-
### Select your SOURCE TYPES
78
+
### Create the resource CLASSES
64
79
65
-
In the data model editor, you select your source types from a predefined list on the right-hand side. Later, you will be able to customize the source type or define an additional default source type, if the one you need doesn't exist by default.
80
+
In the data model editor, you create your resource classes by selecting a default representation type from a predefined list on the right-hand side.
66
81
67
-
*Data model editor 1: Select all your main source types by drag and drop; e.g. for an interview, select the source type "Audio / Sound / Interview".*
82
+
Click on `+ Create new class`and select a representation type for your resource class.
68
83
69
-
In our example with the interview and the photographs, you drag and drop the following main source types from the list on the right-hand side:
84
+
*Data model editor | Step 2: Create all your main resource classes by selecting a predefined representation type; e.g. for a taped interview, select the representation type "Audio / Sound / Interview".*
85
+
86
+
In our example with the interview and the photographs, you drag and drop the following main resource classes from the list on the right-hand side:
70
87
71
88
- Audio / Sound / Interview
72
89
- Transcript
@@ -76,30 +93,42 @@ In our example with the interview and the photographs, you drag and drop the fol
76
93
77
94
---
78
95
79
-
### Select the METADATA fields for each source type (optional)
96
+
### Select or create the PROPERTIES for each resource class
80
97
81
-
The predefined source types offer a suggested list of metadata fields. This list could help to create a data model simply and quickly. It's also possible to deselect the suggested metadata fields (e.g., no metadata), to adapt others and to customize them.
98
+
<!-- TODO: nice idea, but not yet implemented >>> The predefined resource classes offer a suggested list of metadata fields. This list could help to create a data model simply and quickly. It's also possible to deselect the suggested metadata fields (e.g., no metadata), to adapt others and to customize them.-->
82
99
83
-
*Data model editor 2: Add additional metadata fields to your source type; e.g. add the missing field "Person".*
100
+
There are two possibilites to add properties to a resource class:
84
101
85
-
---
102
+
#### Create new property by selecting from list of default property types
86
103
87
-
### Customize the SOURCE TYPES and the METADATA fields (optional)
104
+
*Data model editor | Step 3: Add properties to your resource class by selecting from list of default property types.*
88
105
89
-
It's possible to customize the predefined source type and the metadata field values by clicking on the edit button of the source type. You can rename the source type, rearrange the order of the metadata fields, and set permissions.
106
+
#### Select from list of existing properties
90
107
91
-
*Data model editor 3: Customize the source type AUDIO; e.g. rename it into Interview*
108
+
If you have already created some properties in another resource classes or in the property section <!-- TODO: add link to property section as soon this section exists --> you can select one of them to add it to the resource class. This way you have to define — for example — a "Title" property only once.
92
109
93
-
---
110
+
*Data model editor | Step 3: Add properties to your resource class by selecting from list of already existing properties*
111
+
112
+
In both cases it will open the property form where you have to define a label and optional a comment. If you have selected an existing property, you can also change the label and comment. Be careful in this case, because it can have an effect on other resource classes that use the same property!
113
+
114
+
The property type can't be changed here. Depending on the property type you have to set additional attributes, e.g. in a resource link property you have to select a resource class to which the property will point to. Similar in case of a list property where you have to select the corresponding list. In both cases a the linked resource class or the list should already exist.
115
+
116
+
*Data model editor | Step 4: Define property's label and comment and set the cardinality corresponding to the resource class.*
117
+
118
+
For each property in a resource class you can define some rules. For example you can define if one of the property can have `multiple` values or if a property is a mandatory (`requiered`) field.
119
+
120
+
After adding more than one property to a resource class you can change the displayed order by drag'n'drop the properties in the list.
121
+
122
+
<!--- TODO: add definition for each property type and maybe also for the representation type
94
123
95
124
### Connect SOURCE TYPES in the data model (optional)
96
125
97
-
If you have reusable metadata value in a source type (A), you should create an additional source type (B) and drag-and-drop it over the metadata field of the first source type (A) to connect the two data types.
98
-
E.g., For the metadata "Photographer" in source type "Photograph", you should create a source type "Person" and connect it in "Photograph".
126
+
If you have reusable metadata value in a resource type (A), you should create an additional resource type (B) and drag-and-drop it over the metadata field of the first resource type (A) to connect the two data types.
127
+
E.g., For the metadata "Photographer" in resource type "Photograph", you should create a resource type "Person" and connect it in "Photograph".
99
128
100
-
*Data model editor 4: Manage connections between the source types.*
129
+
*Data model editor 4: Manage connections between the resource classes.*
101
130
102
-
----
131
+
---
103
132
104
133
## Lists
105
134
⚠ *WORK IN PROGRESS*
@@ -109,3 +138,4 @@ Projects often need to define lists or hierarchies of categories that can be ass
109
138
*https://app2.dasch.swiss/project/0803/lists - Project lists: create a new list, add items by selecting the language and enter the corresponding value, repeat for each translation and press the + sign to create another item to the same level.*
110
139
111
140
**The edition of items and child items will be implemented in a later version.**
0 commit comments