Last modified by Dennis Segebarth on 2024/12/18 11:45
From version 11.3
edited by Dennis Segebarth
on 2024/12/18 11:45
Change comment: deny view right for XWiki.XWikiAdminGroup
To version 4.3
edited by Dennis Segebarth
on 2024/08/14 09:02
Change comment: allow edit right for XWiki.XWikiAdminGroup

Summary

Details

Page properties
Content
... ... @@ -15,7 +15,7 @@
15 15  
16 16  After creating an HDC Dataset (please see //Working with HDC Datasets//), the user who created the Dataset can create a KG Space for this Dataset at any time. The only prerequisite is that the Dataset already contains data from a Project, thereby establishing the association between the Dataset and an HDC Project (see //Working with Project Files in the Portal //or //Working with Project Files in the Command Line Interface)//. This association is automatically made as soon as data from a Project is added to the Dataset. The **KG Space integration **tools are found directly on the Datasets interface.
17 17  
18 -[[image:1723654516142-916.png||height="322" width="868"]]
18 +[[image:KG_integration_Space_creation_button.png||height="369" width="996"]]
19 19  
20 20  
21 21  1. After creating an HDC Dataset and adding Project data into it, click the **Create a KG Space** button in the Dataset interface.
... ... @@ -22,8 +22,9 @@
22 22  1. The KG Space will be created in a protected namespace of the central EBRAINS Knowledge Graph, using the naming convention prefix {{code language="none"}}collab-hdc-{{/code}} added to the Dataset Code. For instance, if the HDC Dataset Code is {{code language="none"}}demodataset{{/code}}, the name of the created KG Space will be {{code language="none"}}collab-hdc-demodataset{{/code}}.
23 23  1. Upon successful creation of the KG space, the Dataset interface is updated to display the KG Space name:
24 24  
25 -[[image:1723654530597-697.png||height="362" width="868"]]
26 26  
26 +[[image:KG_integration_indicated_space_name.png||height="410" width="983"]]
27 +
27 27  All members of the associated Project will now also have access to the created KG Space, with permissions that match those of their role in the HDC Project (please see //Access management of KG Spaces for HDC Project members //for details). However, please be aware that it can take up to one hour until access is granted for all Project members after the initial KG Space creation.
28 28  
29 29  = Access management of KG Spaces for HDC Project members =
... ... @@ -43,6 +43,7 @@
43 43  * Read instances, but cannot create nor manipulate them
44 44  )))
45 45  
47 +
46 46  Note: The role in KG Space of the HDC user who created both the Dataset and the corresponding Dataset will be also match the users role in the Project, i.e. if a Project Collaborator creates a Dataset with a KG Space, the role in the KG Space will be Editor - not Owner.
47 47  
48 48  Importantly, when members are added to or removed from the HDC Project, or their roles within the HDC Project are changed, the changes are automatically broadcasted to all KG Spaces associated with this Project as well. Thus, removing a member from a Project will also disable their access to the corresponding Projects' KG Spaces.
... ... @@ -54,58 +54,16 @@
54 54  To upload metadata from the HDC Dataset interface,
55 55  
56 56  1. Go to the **Metadata** tab and select the **openMINDS Schemas** in the Existing Schemas overview panel. If you have no openMINDS compatible schema files in the Dataset yet, you can use the **Upload Schemas** button for uploading.
57 -1. Select an openMINDS compatible schema file you want to upload to the KG Space by clicking on it in the list. Upon selection of a file, four icons offer additional actions that can be performed with this file.
59 +1. Select an openMINDS compatible schema file you want to upload to the KG Space by clicking on it in the list. Upon selection of a file, three icons offer additional actions that can be performed with this file.
58 58  1. Click on the **Upload **icon. Your file will be transferred into the corresponding KG Space.
59 -[[image:1723654548709-344.png||height="262" width="829"]]
61 +[[image:KG_integration_Metadata_Upload_via_UI.png||height="337" width="1066"]]
62 +
60 60  1. Upon successful transfer of the file, the date and time at which the file was transferred to the KG Space will be indicated next to the file:
61 -\\[[image:1723654561600-690.png||height="271" width="829"]]
64 +\\[[image:KG_integration_successful_upload.png||height="348" width="1065"]]
62 62  
66 +
63 63  The uploaded metadata file will now be discoverable for all EBRAINS users with access and view permissions to this KG Space, i.e. all members of the corresponding HDC Project (see //Access management of KG Spaces for HDC Project members//). Please be aware that uploading metadata from a HDC Dataset to the associated KG Space does not result in automatic publication of these files, neither in the public EBRAINS Knowledge Graph, nor the EBRAINS Knowledge Graph search tool. To do so, please see //Submit a curation request// below.
64 64  
65 -{{info}}
66 -If you created the KG Space just moments ago before uploading an openMINDS metadata file, the upload may fail, indicated by a pop-up message stating a permission error. This is due to a delayed update of your permissions associated with your EBRAINS account (outside of the HDC platform). Simply logout and login again to enforce an update of the permissions and you will be able to upload the file.
67 -{{/info}}
68 -
69 -= Deleting metadata in the HDC Dataset and in the KG Space =
70 -
71 -Metadata files can be deleted from the HDC Dataset and/or from the dedicated KG Space, directly from the Dataset interface in the HDC web portal.
72 -
73 -To delete a metadata file,
74 -
75 -1. Go to the **Metadata** tab and select the **openMINDS Schemas** in the Existing Schemas overview panel.
76 -1. Select the openMINDS file you want to delete by clicking on it in the list. Upon selection of a file, four icons offer additional actions that can be performed with this file.
77 -1. Click on the **Delete** icon. If your file has not been transferred to or from KG, it will be deleted instantly from your HDC Dataset.
78 -If your file has been transferred from or to KG, a pop-up window will prompt you to specify where you want to delete the file.
79 -You can chose to delete the file only in the HDC Dataset, only in KG, or in both locations. Upon clicking the corresponding button, the file will be deleted instantly at the specified location(s).
80 -You can abort the deletion by clicking on **Cancel**.
81 -
82 -[[image:1727895633789-733.png||height="267" width="904"]] [[image:1727895895627-519.png||height="262" width="530"]]
83 -
84 -
85 -= Downloading metadata from KG to the HDC Dataset =
86 -
87 -Metadata files can be downloaded from the EBRAINS Knowledge Graph to the HDC Dataset, directly from the Dataset interface in the HDC web portal.
88 -
89 -To download a metadata instance from KG which does not yet exist in your HDC Dataset,
90 -
91 -1. Go to the **Metadata** tab and select the **openMINDS Schemas** in the Existing Schemas overview panel.
92 -1. Click on the **Download Instances** button. This will open a pop-up window that prompts you to input the KG UUID of the openMINDS instance you want to download.
93 -Optionally, you can specify a filename that will be used in the displayed list of metadata files in the HDC Dataset interface. If you don´t provide a filename, the KG UUID will be used per default.
94 -[[image:1727897008202-845.png||height="331" width="756"]][[image:1727896452582-622.png]]
95 -
96 -1. You can confirm and start the download by clicking on the **Download** button. The file will be added to your list of metadata instances in your HDC Dataset interface:
97 -\\[[image:1727896792502-312.png||height="384" width="826"]]
98 -
99 -To download the latest version of a metadata instance from KG which does already exist in your HDC Dataset,
100 -
101 -1. Go to the **Metadata** tab and select the **openMINDS Schemas** in the Existing Schemas overview panel.
102 -1. Select the openMINDS file you want to update with the latest version in KG by clicking on it in the list. Upon selection of a file, four icons offer additional actions that can be performed with this file.
103 -1. Click on the **Update **icon.
104 -[[image:1727897465730-525.png]]
105 -
106 -1. Upon successful transfer of the file, the date and time at which the file was transferred from the KG Space will be indicated next to the file:
107 -[[image:1727897549750-642.png]]
108 -
109 109  = Submitting a curation request =
110 110  
111 111  Once you have uploaded all relevant metadata files that describe your HDC Dataset and are ready to initiate the publication of the metadata in the public EBRAINS Knowledge Graph, please refer to these [[instructions and guidelines>>https://wiki.ebrains.eu/bin/view/Collabs/data-curation]] to get in touch with the EBRAINS Knowledge Graph Curation Team.
... ... @@ -116,7 +116,11 @@
116 116  
117 117  * Only non-sensitive metadata may be uploaded to the KG. All sensitive data and metadata must remain in the HealthDataCloud.
118 118  * Only valid JSON files can be uploaded. However, the use of openMINDS compatible schemas (JSON-LD files) is highly recommended to make use of the full functionality of the KG.
79 +* HDC users can login to the KG Editor using the same EBRAINS account and explore all KG Spaces to which they were granted access. Based on their permissions (see //Access management of KG Spaces for HDC Project members//), they may view and edit the uploaded metadata, or even create new metadata files. However, any files that are created or modified in the KG Editor currently cannot be synced directly to the corresponding HDC Dataset. Instead, users must download the respective file from the KG Space and upload it manually to the Dataset using the HDC portal UI (see step 1 in the section //Uploading metadata to KG Spaces from HDC// above on how to upload openMINDS compatible schemas to a HDC Dataset).
119 119  
81 +
82 +
83 +
120 120  ----
121 121  
122 122  Copyright © 2023-2024 [[Indoc Systems>>url:https://www.indocsystems.com]].
1723654516142-916.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -250.0 KB
Content
1723654530597-697.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -127.1 KB
Content
1723654548709-344.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -138.6 KB
Content
1723654561600-690.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -136.5 KB
Content
1727895633789-733.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -115.9 KB
Content
1727895895627-519.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -28.0 KB
Content
1727896452582-622.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -15.4 KB
Content
1727896611022-257.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -53.8 KB
Content
1727896792502-312.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -140.4 KB
Content
1727897008202-845.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -114.9 KB
Content
1727897265592-986.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -117.0 KB
Content
1727897465730-525.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -130.2 KB
Content
1727897549750-642.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -136.7 KB
Content
KG_integration_Metadata_Upload_via_UI.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +772.1 KB
Content
KG_integration_Space_creation_button.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +1.8 MB
Content
KG_integration_indicated_space_name.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +717.3 KB
Content
KG_integration_successful_upload.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +764.0 KB
Content
XWiki.XWikiRights[0]
Levels
... ... @@ -1,1 +1,1 @@
1 -edit
1 +view,edit
XWiki.XWikiRights[1]
Allow/Deny
... ... @@ -1,1 +1,0 @@
1 -Allow
Levels
... ... @@ -1,1 +1,0 @@
1 -view
Users
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
XWiki.XWikiRights[2]
Allow/Deny
... ... @@ -1,1 +1,0 @@
1 -Deny
Groups
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiAdminGroup
Levels
... ... @@ -1,1 +1,0 @@
1 -view