Last modified by Dennis Segebarth on 2024/12/18 11:45
From version 3.1
edited by Dennis Segebarth
on 2023/09/13 18:05
Change comment: There is no comment for this version
To version 1.1
edited by Dennis Segebarth
on 2023/09/13 17:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,88 +4,9 @@
1 -{{box cssClass="floatinginfobox" title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
4 4  
5 5  
6 -The [[EBRAINS Knowledge Graph>>https://docs.kg.ebrains.eu/]] (KG) is a metadata management system that allows researchers to share and discover datasets, computational models, and software. The HDC’s **KG Space integration** offers easy-to-use tools for researchers to upload openMINDS metadata directly from an HDC Dataset to the EBRAINS Knowledge Graph. This direct integration with the EBRAINS Knowledge Graph fosters the discoverability and sharing of Dataset metadata created and maintained in the HealthDataCloud (HDC) with other Project members and, ultimately, into the public EBRAINS Knowledge Graph.
7 7  
8 -= How it works =
9 -
10 -Members of an HDC Project can create Datasets for the management, annotation, versioning, and sharing of subsets of the Projects' data (see //Working with HDC Datasets// for more details). When it’s time to share openMINDS metadata from an HDC Dataset with the EBRAINS Knowledge Graph, users can use the **KG Space integration** tools in the HDC Portal to create a new space in the EBRAINS Knowledge Graph dedicated to that Dataset, then upload KG-compatible metadata files directly from the HDC Dataset interface. Access to the new KG Space is fully automatized and roles and permissions are synced with the HDC Project ensuring that only members of the Project from which the Data originated can access the KG space for that Dataset. Further, access to the KG space is role-based and permissions (Owner, Editor, Reader) map to Project members' HDC roles. As an HDC Project can have many Datasets associated with it, and each Dataset can have its own dedicated KG space in the EBRAINS Knowledge Graph, all Project members will have access to all the Project’s associated Dataset KG spaces. Ultimately, when HDC metadata are ready to be published in the public EBRAINS Knowledge Graph, users would submit a request to the EBRAINS Curation Team and follow their curation and publication processes (see //Submiting a curation request//).
11 -
12 -Importantly, all sensitive data and metadata must remain within the HDC, and only non-sensitive metadata can be shared via the Knowledge Graph (please carefully read the //Limitations// section below).
13 -
14 -= Creating a Knowledge Graph Space for an HDC Dataset =
15 -
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 -
18 -[[image:KG_integration_Space_creation_button.png||height="369" width="996"]]
19 -
20 -
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 -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 -1. Upon successful creation of the KG space, the Dataset interface is updated to display the KG Space name:
24 -
25 -
26 -[[image:KG_integration_indicated_space_name.png||height="410" width="983"]]
27 -
28 -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.
29 -
30 -= Access management of KG Spaces for HDC Project members =
31 -
32 -Since the Identity and Access Management of both the HDC and the KG are based on EBRAINS accounts, roles and permissions granted to a given EBRAINS account in an HDC Project can be directly mapped to roles and permissions in the corresponding KG Spaces of the associated Datasets. Please refer to the table below for an overview of how HDC Project member roles are mapped to the KG Space roles and what permissions these roles grant in the KG Space. Please also find more details in the [[KG documentation of user roles>>url:https://docs.kg.ebrains.eu/8387ccd27a186dea3dd0b949dc528842/user_roles.html]].
33 -
34 -(% style="width:50%" %)
35 -|=Role in HDC Project|=Role in KG Space|=Permissions in KG Space
36 -|Project Admin|Owner|(((
37 -* Read, write, and release instances
38 -* Maintain the space information
39 -)))
40 -|Project Collaborator|Editor|(((
41 -* Read and write instances, but NOT release them
42 -)))
43 -|Project Contributor|Reviewer|(((
44 -* Read instances, but cannot create nor manipulate them
45 -)))
46 -
47 -
48 -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.
49 -
50 -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.
51 -
52 -= Uploading metadata from HDC to a KG Space =
53 -
54 -Metadata files can be uploaded directly to the dedicated KG Space from the Dataset interface in the HDC web portal. Please refer to the HDC user guide article //Working with Datasets// on detailed information on how to create and edit Datasets in the HDC, and the section //Creation of a Knowledge Graph Space for an HDC Dataset //above on how to create an associated KG Space for this Dataset.
55 -
56 -To upload metadata from the HDC Dataset interface,
57 -
58 -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.
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.
60 -1. Click on the **Upload **icon. Your file will be transferred into the corresponding KG Space.
61 -[[image:KG_integration_Metadata_Upload_via_UI.png||height="337" width="1066"]]
62 -
63 -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:
64 -\\[[image:KG_integration_successful_upload.png||height="348" width="1065"]]
65 -
66 -
67 -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.
68 -
69 -= Submitting a curation request =
70 -
71 -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.
72 -
73 -= Limitations =
74 -
75 -A set of limitations applies for the integration of the EBRAINS Knowledge Graph and the HealthDataCloud:
76 -
77 -* Only non-sensitive metadata may be uploaded to the KG. All sensitive data and metadata must remain in the HealthDataCloud.
78 -* 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).
80 -
81 -
82 -
83 -
84 84  ----
85 85  
86 86  Copyright © 2023 [[Indoc Systems>>url:https://www.indocsystems.com]].
87 87  
88 88  HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].
9 +
KG_integration_Metadata_Upload_via_UI.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -772.1 KB
Content
KG_integration_Space_creation_button.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -1.8 MB
Content
KG_integration_indicated_space_name.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -717.3 KB
Content
KG_integration_successful_upload.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -764.0 KB
Content