Verified Commit 7006cf59 authored by Laurent Heirendt's avatar Laurent Heirendt
Browse files

fix links for daisy card

parent 72391d12
......@@ -4,7 +4,7 @@
DAISY is a tool that assists GDPR compliance by keeping a register of personal data used in research. DAISY's application menu Bar lists the main functions provided.
![Alt](../img/menubar.png "DAISY Menubar")
![Alt](../../external/img/menubar.png "DAISY Menubar")
<center>DAISY Menubar</center>
* _Project Management_ module allows for the recording of research activities as projects. Documenting projects is critical for GDPR compliance as projects constitute the purpose and the context of use of personal data. Any document supporting the legal and ethical basis for data use can be stored in DAISY. Examples are ethics approvals, consent configurations, or subject information sheets.
......@@ -14,7 +14,7 @@ DAISY is a tool that assists GDPR compliance by keeping a register of personal d
The dependencies between DAISY modules is given below. There are no hard dependencies between the Projects, Contracts and Datasets modules. In principle you may start using any of these modules once DAISY is deployed with pre-packed definitions.
![Alt](../img//dependencies.png "DAISY module dependencies")
![Alt](../../external/img/dependencies.png "DAISY module dependencies")
<center>DAISY module dependencies</center>
<mark>Our suggestion to first-time users is the following</mark>:
......
......@@ -10,13 +10,13 @@ The Contract Management module allows recording legal documents signed in the co
<mark>In order to create a new contract</mark>:
1. Click Contracts from the Menu Bar.<br />
![Alt](../img//contract_menubar.png)
![Alt](../../external/img/contract_menubar.png)
2. Click the add button from the Contract Search Page.<br />
![Alt](../img//add_button.png)
![Alt](../../external/img/add_button.png)
3. You will see an empty Contract Form. The _Project_ field is optional, meanwhile, in practice most contracts are signed in the context of a research project. In the _Roles_ field, you are expected to select one or more GDPR role that identifies your institutions roles as described in the Contract. In the _Other comments_ section you may describe the nature of the document or if the document has an ID/REF e.g. from a document management system, you may put it in. Just like projects and datasets, when creating contracts you are expected to provide a local responsible in the _Local Custodians_ field. As stated before, one of the Local Custodians must be a user with VIP Privileges. E.g. in the demo deployment _alice.white_ is a research principle investigator and is a VIP user.<br />
![Alt](../img//contract_add_form.png)
![Alt](../../external/img/contract_add_form.png)
4. Click SUBMIT. Once you successfully save the form, you will be taken to the newly created contract's details page, as seen below.<br />
![Alt](../img//contract_created.png)
![Alt](../../external/img/contract_created.png)
<a name="CM2"></a>
## 5.2 Manage Contract Details
......@@ -29,11 +29,11 @@ Contracts have multiple signatories. These can be managed via the **Partners (S
1. Click the plus button on the **Partners (Signatories)** details box, as seen below.<br />
![Alt](../img//contract_add_partner.png)
![Alt](../../external/img/contract_add_partner.png)
2. You will see the **Partner and role** addition form. In this form, you will be asked to select the _Partner_ as well as the GDPR _Roles_ that this partner assumes in the contract. You can select more than one role. It is also mandatory to provide a contact person that is with the selected partner institute. You can either select from the list or you can add a new contact if it does not already exist.
![Alt](../img//contract_add_partner_form.png)
![Alt](../../external/img/contract_add_partner_form.png)
3. Once you fill in the information and click SUBMIT the partner will be added to the list of signatories, as seen below. Partners can be removed from a contract by clicking on the trash icon that will appear when hovering over the items in the **Partner and role detail box**.<br />
![Alt](../img//project_ref_user_search.png)
![Alt](../../external/img/project_ref_user_search.png)
### 5.2.2 Manage Contract Documents
......
......@@ -6,24 +6,24 @@
In order to create a new Dataset:
1. Click Datasets from the Menu Bar.<br />
![Alt](../img//dataset_menubar.png)
![Alt](../../external/img/dataset_menubar.png)
2. Click the add button from the Dataset Search Page.<br />
![Alt](../img//add_button.png)
![Alt](../../external/img/add_button.png)
3. You will see the **Dataset Creation Quick Form**<br />
![Alt](../img//dataset_quick_form.png)
![Alt](../../external/img/dataset_quick_form.png)
4. Click SUBMIT. Once you successfully save the form, you will be taken to the newly created dataset's details page, as seen below. <br />
![Alt](../img//dataset_details.png)
![Alt](../../external/img/dataset_details.png)
<a name="DM2"></a>
## 4.2 Declare Data within the Dataset
After initial creation the dataset will be in a skeletal form. The dataset needs to be fleshed out with further information on the characteristics of the data it contains. We do this by creating **data declarations** within the dataset, by following these steps.
1. Click the plus button on the **Data declarations** details box.<br />
![Alt](../img//datadec_empty.png)
![Alt](../../external/img/datadec_empty.png)
2. You will see the **Data declaration Creation Quick Form** as below. With the **Data declaration Creation Quick Form** you are asked for a **Title** for the declaration and denote where the data was **Obtained from** by selecting one of three options. For the **Title** one can use the same title you used earlier when creating the dataset. However, if you're going to have multiple declarations within a dataset you can give them names based on their source or their type (e.g. Helsinki Cohort, Parkinson Study-2, LuxPARK PARK2 Cell lines etc). It is important that the **Title** is a name that is familiar to you and your research group as it will be used in free text search over datasets. The options for the **Obtained from** field is described in detail [in the remainder of this section](#DDEC_OPTIONS). <br />
![Alt](../img//datadec_quick_form.png)
![Alt](../../external/img/datadec_quick_form.png)
3. Click SUBMIT. The data declaration will be created you will be taken to the **Data Declaration Editor Page**.
......@@ -33,42 +33,42 @@ Before we describe the details of data declaration editing we will discuss the t
<span>&#9675; </span><mark><strong>From existing data/samples:</strong></mark> When you state that the data is obtained from existing data/samples in your institution, DAISY will prompt you (as below) to search for and choose the data record which is the origin for your current declaration.
![Alt](../img//datadec_from_existing.png)
![Alt](../../external/img/datadec_from_existing.png)
You will be provided a searchable selection box, through which you can find existing data records by their Project, by responsible PI or by their title. As you will be making a selection from existing records, with this option, it is necessary that origin data had been entered into DAISY earlier.
By choosing the **from existing data/samples:** you will link the newly created data declaration to an existing data declaration in daisy, as depicted below.
![Alt](../img//from_existing_topology.png)
![Alt](../../external/img/from_existing_topology.png)
<span>&#9675;</span><mark><strong>Newly incoming data/samples:</strong></mark> When you select this option, it means you are obtaining data from a collaborator institute or from a repository and this data is being recorded for the first time in DAISY. With this option DAISY will first ask you to select a partner (institutes and repositories are both in the partner list). Once you select a partner DAISY will then list all those contracts that are in the system involving this partner and that have local custodians overlapping with the custodians of the dataset you're detailing. If there are no such contracts or if none of the existing contracts foresee the receipt of this data, then you have to option to create an empty contract. You can later on provide the details and documentation for this empty contract. It is possible that in some DAISY deployments the _Contract Management_ module, in that case the empty contract acts as a link to the source partner for the data.
![Alt](../img//datadec_newly_incoming.png)
![Alt](../../external/img/datadec_newly_incoming.png)
When the **newly incoming data/samples** option is chose, DAISY will link the newly created data declaration to a Contract and and associated Partner(s), as depicted below.
![Alt](../img//newly_incoming_topology.png)
![Alt](../../external/img/newly_incoming_topology.png)
<span>&#9675;</span><mark><strong>Other:</strong></mark> When you select this option, it means you do not want to create any structured DAISY records to denote the origin of data being declared. DAISY will prompt you to provide a free-text description of the origin of data as seen below.
![Alt](../img//datadec_other.png)
![Alt](../../external/img/datadec_other.png)
Data declared with the **Other** option will not have links to any other records as to its origin.
![Alt](../img//other_topology.png)
![Alt](../../external/img/other_topology.png)
After selecting any one of the options and creating the data declaration, you will be taken back to the Dataset Details Page. You can see the newly added declaration listed in the **Data Declarations** detail box. This box also provides action buttons for editing, deleting, and cloning data declarations, as seen below.
![Alt](../img//datadec_added.png)
![Alt](../../external/img/datadec_added.png)
Once created you're advised to edit the declaration to provide further information about the data. Data declarations have several fields in addition to the title and origin supplied during their creation.
![Alt](../img//datadec_edit_1.png)
![Alt](../../external/img/datadec_edit_1.png)
## 4.3 Manage Dataset Locations
......@@ -76,17 +76,17 @@ Once created you're advised to edit the declaration to provide further informati
As per GDPR, the storage of personal data is considered as a``data processing'' and needs tone recorded. The **Storage Locations detail box** allows you to do this. In order to record a new storage location:
1. click the plus button on the **Storage Locations** detail box depicted below. <br />
![Alt](../img//dataset_add_location.png)
![Alt](../../external/img/dataset_add_location.png)
2. You will see the location creation form asking you for the _Storage Backend_ and the _Nature of data copy_ the _Stored datatypes_ (optional) and _Location of the data_ for the paper. The backends box will list storage platforms for your institution, you need to select one and in the location box you're expected to provide information on where the data can be found on the selected platform. Please note that you are not expected to document individual files. E.g. it is good practice to record the top level folder in which a certain dataset exists. The datatypes are optional and if you're not separately storing data subsets by type then there is no need to specify datatype information for a location.
![Alt](../img//dataset_add_location_form.png)
![Alt](../../external/img/dataset_add_location_form.png)
3. Click SUBMIT and the new location will be listed as below. Storage locations can be deleted by clicking on the trash icon that will appear when hovering over items in the **Storage Locations detail box**. <br />
![Alt](../img//dataset_remove_location.png)
![Alt](../../external/img/dataset_remove_location.png)
## 4.4 Manage Dataset Accesses
......@@ -95,15 +95,15 @@ As per GDPR, any access to personal data held in an institution needs to be reco
In order to add a new access record:
1. Click the plus button on the **Accesses** detail box depicted below.<br />
![Alt](../img//dataset_add_access.png)
![Alt](../../external/img/dataset_add_access.png)
2. You will see the access creation form. Access is defined over a specific storage location, so you'd need to select one from the _Data Locations_ list. In addition you'd need to document the access control policy in the _Remarks_ section. If access is time-limited you may specify the start and end dates for its validity. By default all accesses recorded will fall under the scope of the project, which owns the dataset. It is also possible to record accesses, in the scope of other projects, to do so you must select one from the _Project_ list. We discuss access across projects later in this section.<br />
![Alt](../img//dataset_add_access_form.png)
![Alt](../../external/img/dataset_add_access_form.png)
3. Click SUBMIT and the new access will be recorded and listed on the dataset's page as below. Accesses can be deleted by clicking on the trash icon that will appear when hovering over items in the **Accesses detail box**. <br />
![Alt](../img//dataset_remove_access.png)
![Alt](../../external/img/dataset_remove_access.png)
As discussed above, when data of one project is being access in the context of another project, this can be specified by in the access creation form by selecting a Project (see below left). When you create access records in this way, the dataset will be linked to the project accessing it. This dataset will be listed in the **Dat used from other projects** detail box (see below right).
![Alt](../img//dataset_access_other_project.png)
![Alt](../../external/img/dataset_access_other_project.png)
......
......@@ -11,7 +11,7 @@ Cohort is a study that collects data and/or bio-samples from a group of particip
In order to effectively handle data subjects' requests, as per GDPR, it is crucial that an institution keeps track of what data it keeps from which cohorts. Inline with this, DAISY allows maintaining a list of _Cohorts_ and link _Datasets_ to _Cohorts_.
The information kept on cohorts can be seen in the associated _Editor Page_ seen below. Cohorts are expected to have a _Title_ unique to them, and they are linked to one or more _Cohort Owners_, which are that are Principle Investigators, Clinicians running the study. Cohorts owners are kept as _Contacts_ in DAISY. In order to maintain a controlled list of cohorts, the administrator for the DAISY deployment may assign an accession number to the _Cohort_, which would be the unique identifier for this Cohort. <br />
![Alt](../img//cohort_edit_form.png)
![Alt](../../external/img/cohort_edit_form.png)
<a name="PAR_M"></a>
......@@ -21,7 +21,7 @@ A _Partner_ is a research collaborator that is the source and/or recipient of hu
In accordance, when maintaining _Dataset_ source info, _Dataset_ transfer info or when creating _Contract_ records, you will be asked to select Partners.
The information kept on partners can be seen in the associated _Editor Page_ seen below. <br />
![Alt](../img//partner_edit_form.png)
![Alt](../../external/img/partner_edit_form.png)
<a name="CONN_M"></a>
## 6.3 Contacts Management
......@@ -29,7 +29,7 @@ The information kept on partners can be seen in the associated _Editor Page_ see
DAISY allows keeping an address book of all contact persons related to the _Projects_, _Datasets_, _Cohorts_ and _Contracts_.
The information kept on contacts is pretty standard as can be seen in the associated _Editor Page_ given below. <br />
![Alt](../img//contact_edit_form.png)
![Alt](../../external/img/contact_edit_form.png)
......
......@@ -12,7 +12,7 @@ A screenshot of the search page for Projects is given below.
Each search page is headed with _help text search facets on the left hand side and search results on the right hand side.
![Alt](../img//search_page.png)
![Alt](../../external/img/search_page.png)
<center>Search Page for Projects</center>
By default, all entities - in our example, all projects- will be listed on the search page. The list can be filtered by either selecting one or more facet from the left hand side or by typing in a keyword into the search box. Currently DAISY search does not support partial matching; instead the entire keyword will be matched in a case insensitive manner.
......@@ -29,7 +29,7 @@ Depending on the permissions associated with your user type, you may see a **add
Information about a single entity is provided through a Details Page. As example page for a _Project_ named ``SYSCID'' is given below.
![Alt](../img//details_page.png)
![Alt](../../external/img/details_page.png)
<center>Details page of a Project in DAISY</center>
You may end up on an Entity Details Page in two primary ways. (1) Through the ``DETAILS'' link of a search results in a search page (2) Through links on details pages of other (linked) entities in DAISY.
......@@ -49,20 +49,20 @@ If you have edit permissions for the entity, then at the top right corner of som
When you click the edit button on the Details Page of an entity, you will be taken to the Editor Page containing a form for entity update. An example is given below.
![Alt](../img//editor_form.png)
![Alt](../../external/img/editor_form.png)
<center>Editor page of a Project</center>
Each field in the form will be listed with a **Name**, a **Value** and a **Help text**. Names of fields that are required to have a value will end with a red asterisk.
Editor forms can be saved by pressing the **SUBMIT** button found at the bottom of the page. Forms will be validated upon submission. If validation fails for one or more fields, these will be highlighted with inline validation _ERROR_ messages, illustrated below.
![Alt](../img//validation_error.png)
![Alt](../../external/img/validation_error.png)
<center>Field validation error</center>
Upon successful save of a form, you will be returned to the entity details page. DAISY may give **SUCCESS** and/or **WARNING** messages upon form save; these will be displayed at the top of the page, as illustrated below.
![Alt](../img//page_messages.png)
![Alt](../../external/img/page_messages.png)
<center>Message display in DAISY</center>
......
......@@ -8,13 +8,13 @@
<mark>In order to create a new project</mark>:
1. Click Projects from the Menu Bar.<br />
![Alt](../img//project_menubar.png)
![Alt](../../external/img/project_menubar.png)
2. Click the add button from the Project Search Page.<br />
![Alt](../img//add_button.png)
![Alt](../../external/img/add_button.png)
3. You will see an empty Project Form. _Acronym, Title_ and _Local Custodians_ are mandatory fields, whereas others are optional. Provide values for fields. Please note that one of the Local Custodians must be a user with VIP Privileges. E.g. in the demo deployment _alice.white_ is a research principle investigator and is a VIP user.<br />
![Alt](../img//project_custodians.png)
![Alt](../../external/img/project_custodians.png)
4. Click SUBMIT. Once you successfully save the form, you will be taken to the newly create project's details page, as seen below.<br />
![Alt](../img//project_created.png)
![Alt](../../external/img/project_created.png)
<a name="PM2"></a>
......@@ -28,16 +28,16 @@ When you first create a _Project_ in DAISY, it will be isolated, with no links t
When a project is created, it will have no associated Datasets. On the project's details page this situation will be highlighted in the **Data of this project** detail box as follows:
![Alt](../img//project_add_dataset.png)
![Alt](../../external/img/project_add_dataset.png)
<mark>In order to create a Dataset and automatically link it to the project</mark>:
1. Click the **Add** button pointed by the arrow in the **Data of this project** detail box.
2. You will see the **Dataset Creation Quick Form** as below. The _Project_ field will be auto-selected, in addition you need to provide _Local Custodians_ and a _Title_ for your dataset. Typically the local custodians would be the same as the project, but you are free to choose any user as the custodian. Remember that one of the custodians needs to be a VIP User. Provide the field values and press submit.\
![Alt](../img//project_add_dataset_form.png)
![Alt](../../external/img/project_add_dataset_form.png)
3. Once the dataset is created, you will be taken to the **Dataset's Details Page**, seen below. You can continue working on the data set as described in [this part of the guide](#DM). If you want to go pack to the Project that owns this dataset, then you can click the project link in the dataset's overview box, highlighted below.<br />
![Alt](../img//project_add_dataset_result.png)
![Alt](../../external/img/project_add_dataset_result.png)
<a name="PM22"></a>
### 3.2.2 Add Contract to Project
......@@ -52,15 +52,15 @@ A project's _Personnel_ refer to those persons that work on the project, we assu
1. Click the plus button on the **Personnel** details box, as seen below.<br />
![Alt](../img//project_ref_user.png)
![Alt](../../external/img/project_ref_user.png)
2. You will be asked to select one user from a searchable list of existing users. Users will be listed with their name and surname. Make a selection and click SUBMIT. <br />
![Alt](../img//project_ref_user_search.png)
![Alt](../../external/img/project_ref_user_search.png)
Personnel can be unlinked from a Project by clicking on the trash icon that will appear when hovering over items in the **Personnel detail box**, as seen below. Note that the personnel will not be deleted from the system, it will simply be unlinked.<br />
![Alt](../img//project_remove_user.png)
![Alt](../../external/img/project_remove_user.png)
<a name="PM24"></a>
### 3.2.4 Manage Project Contacts
......@@ -69,17 +69,17 @@ A project's _Personnel_ refer to those persons that work on the project, we assu
A project's _Contacts_ refer to those persons that are associated with the Project, but that are not a user of the DAISY system. Under the _Definitions Management_ module, it is possible to manage _Contacts_ and search for them. The **Contacts** detail box on the _Project_ page also allows contact management, as follows;
1. Click the plus button on the **Contacts** details box. You will be given the options to either **Create a new contact** or **Reference an existing contact** as seen below.<br />
![Alt](../img//project_add_contact.png)
![Alt](../../external/img/project_add_contact.png)
2. If you choose to reference, you will be asked to select one contact from a searchable list of existing contacts. Contacts will be listed with their name, surname and role as seen below. Make a selection and click SUBMIT.<br />
![Alt](../img//project_ref_contact.png)
![Alt](../../external/img/project_ref_contact.png)
3. If you choose to create new, you will see the contact creation form. Once you fill in the details and click SUBMIT a new contact will be created and automatically linked to the project.<br />
![Alt](../img//project_add_contact_form.png)
![Alt](../../external/img/project_add_contact_form.png)
Contacts can be unlinked from a Project by clicking on the trash icon that will appear when hovering over items in the **Contacts detail box**, as seen below. Note that the contact will not be deleted from the system, it will simply be unlinked.<br />
![Alt](../img//project_remove_contact.png)
![Alt](../../external/img/project_remove_contact.png)
<a name="PM25"></a>
......@@ -91,13 +91,13 @@ You can attach documents to a project record in DAISY. Examples of documents are
Document management is done via the **Documents** detail box, as follows:
1. Click the plus button on the **Documents** detail box.<br />
![Alt](../img//project_add_document.png)
![Alt](../../external/img/project_add_document.png)
2. You will see the _Document_ creation form. Either select _Content_, i.e. file to upload, or paste the document link (if in external system). You will be required to provide a brief description of the document in _Document Notes_. Also you will also be required to select a _Type_ for the document. <br />
![Alt](../img//project_add_document_form.png)
![Alt](../../external/img/project_add_document_form.png)
3. Click SUBMIT and the new document will be listed as below. Documents can be deleted by clicking on the trash icon beside each document, also document information can be edited by clicking the pencil icon.<br />
![Alt](../img//project_remove_document.png)
![Alt](../../external/img/project_remove_document.png)
......@@ -107,19 +107,19 @@ Document management is done via the **Documents** detail box, as follows:
A project's _Publications_ can be managed via the **Publications detail box**, as follows:
1. Click the plus button on the **Publications** detail box. You will be given the options to either **Create a new publication** or **Reference an existing publication** as seen below.<br />
![Alt](../img//project_add_publication.png)
![Alt](../../external/img/project_add_publication.png)
2. If you choose to reference, you will be asked to select one publication from a searchable list of existing publications. Publications will be listed with their citation string. Make a selection and click SUBMIT.<br />
![Alt](../img//project_ref_publication.png)
![Alt](../../external/img/project_ref_publication.png)
3. If you choose to create new, you will see the publication creation form asking you for the _Citation string_ and the _DOI_ for the paper. Once you fill in the details and click SUBMIT a new publication will be created and automatically linked to the project.<br />
![Alt](../img//project_add_publication_form.png)
![Alt](../../external/img/project_add_publication_form.png)
Publications can be unlinked from a Project by clicking on the trash icon that will appear when hovering over items in the **Publications detail box**, as seen below. Note that the publication will not be deleted from the system, it will simply be unlinked.<br />
![Alt](../img//project_remove_publication.png)
![Alt](../../external/img/project_remove_publication.png)
<br />
......
......@@ -5,7 +5,7 @@
Upon successful installation of DAISY, going to the web address ```https://${IP_ADDRESS_OR_NAME_OF_DEPLOYMENT_SERVER}```
should display the login page.
![Alt](../img//login.png)
![Alt](../../external/img/login.png)
<center>DAISY Login Page</center>
Based on the authentication configuration made for your deployment, you may login by:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment