Skip to content
Snippets Groups Projects
Verified Commit 769e4a16 authored by Laurent Heirendt's avatar Laurent Heirendt :airplane:
Browse files

change all links to imgs

parent 71853f9c
No related branches found
No related tags found
2 merge requests!19Regular merge of develop,!18Central image folder
Hide whitespace changes
Inline Side-by-side
Showing
with 172 additions and 172 deletions
external/daisy/at_a_glance.md
+ 7
− 7
View file @ 769e4a16
......@@ -4,24 +4,24 @@
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](./images/menubar.png "DAISY Menubar")
![Alt](../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.
* _Dataset Management_ module allows for the recording of personal data held by the institution. The dataset may or may not fall in the context of a particular project. DAISY allows Datasets to be defined in a granular way; where - if desired - each data subset, called a data declaration, can be listed individually. These declarations may list data from a particular partner, data of a particular cohort or data of a particular type.
* _Contract Management_ module allows the recording and storage of legal contracts of various types that have been signed with partner institutes or suppliers. Consortium agreements, data sharing agreements, material transfer agreements are examples of contracts. For GDPR compliance contracts become useful when documenting the source of datasets received or the target datasets transferred.
* _Definitions Management_. DAISY comes pre-packed with default lookup lists; these can be changed during application deployment. Lookup lists are used when defining contracts, projects or datasets. The definitions module of the DAISY application allows the management of dynamic lookup lists, specifically those of cohorts, partner institutes and contact persons.
* _Dataset Management_ module allows for the recording of personal data held by the institution. The dataset may or may not fall in the context of a particular project. DAISY allows Datasets to be defined in a granular way; where - if desired - each data subset, called a data declaration, can be listed individually. These declarations may list data from a particular partner, data of a particular cohort or data of a particular type.
* _Contract Management_ module allows the recording and storage of legal contracts of various types that have been signed with partner institutes or suppliers. Consortium agreements, data sharing agreements, material transfer agreements are examples of contracts. For GDPR compliance contracts become useful when documenting the source of datasets received or the target datasets transferred.
* _Definitions Management_. DAISY comes pre-packed with default lookup lists; these can be changed during application deployment. Lookup lists are used when defining contracts, projects or datasets. The definitions module of the DAISY application allows the management of dynamic lookup lists, specifically those of cohorts, partner institutes and contact persons.
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](./images/dependencies.png "DAISY module dependencies")
![Alt](../img//dependencies.png "DAISY module dependencies")
<center>DAISY module dependencies</center>
<mark>Our suggestion to first-time users is the following</mark>:
1. Familiarise yourself with DAISY's interface conventions by reading the [relevant section of this guide](#DIC).
2. Login to DAISY with a user that has Administrator or VIP privileges. E.g. In the demo deployment the _admin_ user has Administrator privileges and _alice.white_ has VIP privileges.
3. Use Project Management to [create a project](#PM1).
3. Use Project Management to [create a project](#PM1).
4. Use Dataset Management to [create a dataset](#PM21) within the defined project.
......
external/daisy/contract_management.md
+ 13
− 13
View file @ 769e4a16
<a name="CM"></a>
# 5 Contract Management
# 5 Contract Management
The Contract Management module allows recording legal documents signed in the context of research activities. Contracts are typically linked to Projects and provide the necessary traceability for the GDPR compliant provision and transfer of data.
<a name="CM1"></a>
## 5.1 Create New Contract
## 5.1 Create New Contract
<mark>In order to create a new contract</mark>:
1. Click Contracts from the Menu Bar.<br />
![Alt](./images/contract_menubar.png)
![Alt](../img//contract_menubar.png)
2. Click the add button from the Contract Search Page.<br />
![Alt](./images/add_button.png)
![Alt](../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](./images/contract_add_form.png)
![Alt](../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](./images/contract_created.png)
![Alt](../img//contract_created.png)
<a name="CM2"></a>
## 5.2 Manage Contract Details
## 5.2 Manage Contract Details
After initial creation the contract will be in a skeletal form and would need further input on its signatories and document attachments.
### 5.2.1 Manage Contract Partners (Signatories)
Contracts have multiple signatories. These can be managed via the **Partners (Signatories)** detail box.
Contracts have multiple signatories. These can be managed via the **Partners (Signatories)** detail box.
1. Click the plus button on the **Partners (Signatories)** details box, as seen below.<br />
![Alt](./images/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](./images/contract_add_partner_form.png)
![Alt](../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)
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](./images/project_ref_user_search.png)
![Alt](../img//project_ref_user_search.png)
### 5.2.2 Manage Contract Documents
......
external/daisy/dataset_management.md
+ 46
− 46
View file @ 769e4a16
<a name="DM"></a>
# 4 Dataset Management
# 4 Dataset Management
<a name="DM1"></a>
## 4.1 Create New Dataset
## 4.1 Create New Dataset
In order to create a new Dataset:
1. Click Datasets from the Menu Bar.<br />
![Alt](./images/dataset_menubar.png)
![Alt](../img//dataset_menubar.png)
2. Click the add button from the Dataset Search Page.<br />
![Alt](./images/add_button.png)
![Alt](../img//add_button.png)
3. You will see the **Dataset Creation Quick Form**<br />
![Alt](./images/dataset_quick_form.png)
![Alt](../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](./images/dataset_details.png)
![Alt](../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.
## 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](./images/datadec_empty.png)
![Alt](../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](./images/datadec_quick_form.png)
![Alt](../img//datadec_quick_form.png)
3. Click SUBMIT. The data declaration will be created you will be taken to the **Data Declaration Editor Page**.
......@@ -31,63 +31,63 @@ Before we describe the details of data declaration editing we will discuss the t
<a name="DDEC_OPTIONS"></a> <mark>The <strong>Obtained from</strong> field captures important information, but, for the first-time users of DAISY it can be difficult to populate. Your choice among the three options will determine if and how your dataset will be linked to other entities in DAISY. If you are a first-time user and you're creating records for learning purposes, we suggest that you choose the option "Other" for simplicity.</mark>
<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.
<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](./images/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.
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](./images/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//from_existing_topology.png)
![Alt](./images/datadec_newly_incoming.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)
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](./images/newly_incoming_topology.png)
![Alt](../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](./images/datadec_other.png)
![Alt](../img//datadec_other.png)
Data declared with the **Other** option will not have links to any other records as to its origin.
![Alt](./images/other_topology.png)
![Alt](../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](./images/datadec_added.png)
![Alt](../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](./images/datadec_edit_1.png)
![Alt](../img//datadec_edit_1.png)
## 4.3 Manage Dataset Locations
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](./images/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.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](./images/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](./images/dataset_remove_location.png)
![Alt](../img//dataset_remove_location.png)
## 4.4 Manage Dataset Accesses
As per GDPR, any access to personal data held in an institution needs to be recorded. The **Accesses detail box** allows you to do this. **IMPORTANT NOTE: Before recording access, make sure you have recorded storage locations of data.**
......@@ -95,18 +95,18 @@ 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](./images/dataset_add_access.png)
![Alt](../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](./images/dataset_add_access_form.png)
![Alt](../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](./images/dataset_remove_access.png)
![Alt](../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](./images/dataset_access_other_project.png)
![Alt](../img//dataset_access_other_project.png)
<br />
<br />
......
external/daisy/definitions_management.md
+ 13
− 13
View file @ 769e4a16
<a name="DEF_M"></a>
# 6 Definitions Management
# 6 Definitions Management
With the _Definitions_ module, DAISY allows the management of _Contacts, _Cohorts_ and _Partners_. All pages within _Definitions_ operate according to the interface conventions given in the [relevant section of this guide](#DIC). In the following sections we only discuss what information is held in these definitions.
With the _Definitions_ module, DAISY allows the management of _Contacts, _Cohorts_ and _Partners_. All pages within _Definitions_ operate according to the interface conventions given in the [relevant section of this guide](#DIC). In the following sections we only discuss what information is held in these definitions.
<a name="COH_M"></a>
## 6.1 Cohorts Management
<a name="COH_M"></a>
## 6.1 Cohorts Management
Cohort is a study that collects data and/or bio-samples from a group of participants (e.g. longitudinal case-control or family studies). A cohort is linked to the creation of data and is considered its ultimate source.
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_.
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](./images/cohort_edit_form.png)
![Alt](../img//cohort_edit_form.png)
<a name="PAR_M"></a>
<a name="PAR_M"></a>
## 6.2 Partners Management
A _Partner_ is a research collaborator that is the source and/or recipient of human data. Partners are also legal entities with whom contracts are signed. Clinical entities that run longitudinal cohorts, research institutes, or data hubs are all examples of Partners.
A _Partner_ is a research collaborator that is the source and/or recipient of human data. Partners are also legal entities with whom contracts are signed. Clinical entities that run longitudinal cohorts, research institutes, or data hubs are all examples of Partners.
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](./images/partner_edit_form.png)
![Alt](../img//partner_edit_form.png)
<a name="CONN_M"></a>
## 6.3 Contacts Management
<a name="CONN_M"></a>
## 6.3 Contacts Management
DAISY allows keeping an address book of all contact persons related to the _Projects_, _Datasets_, _Cohorts_ and _Contracts_.
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](./images/contact_edit_form.png)
![Alt](../img//contact_edit_form.png)
......
external/daisy/interface_conventions.md
+ 17
− 17
View file @ 769e4a16
<a name="DIC"></a>
# 2 DAISY Interface Conventions
# 2 DAISY Interface Conventions
<a name="SP"></a>
## 2.1 Search Pages
<a name="SP"></a>
## 2.1 Search Pages
DAISY provides search pages for all entities manageable via modules. Currently these are: _Projects, Contracts, Datasets_, and, under definitions, _Partners, Cohorts, Contacts_. All search pages have similar layout and operational conventions. Search pages are also the only entry point for the functions in a module. When you select a module from the menu bar, you will be taken to the search page for the entity managed by that module.
A screenshot of the search page for Projects is given below.
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](./images/search_page.png)
![Alt](../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.
On the top right section of search results a few attributes will be listed. Clicking on these attributes repeatedly will respectively (1) enable the ordering either (2) change order to ascending/descending (3) disable ordering for the clicked attribute.
On the top right section of search results a few attributes will be listed. Clicking on these attributes repeatedly will respectively (1) enable the ordering either (2) change order to ascending/descending (3) disable ordering for the clicked attribute.
Each entity listed in the search results will be displayed in a shaded box are listing few of attributes; in our example the project's name and number of publications are listed. Each result box will also contain a "DETAILS" link, through which you can go to the [Entity Details Page](#EDP).
Each entity listed in the search results will be displayed in a shaded box are listing few of attributes; in our example the project's name and number of publications are listed. Each result box will also contain a "DETAILS" link, through which you can go to the [Entity Details Page](#EDP).
Depending on the permissions associated with your user type, you may see a **add button (denoted with a plus sign)** at the bottom right section of the search page. You can add a new entity by clicking the plus button, which will open up an empty editor form for you to fill in.
Depending on the permissions associated with your user type, you may see a **add button (denoted with a plus sign)** at the bottom right section of the search page. You can add a new entity by clicking the plus button, which will open up an empty editor form for you to fill in.
<a name="EDP"></a>
## 2.2 Entity Details Pages
<a name="EDP"></a>
## 2.2 Entity Details Pages
Information about a single entity is provided through a Details Page. As example page for a _Project_ named ``SYSCID'' is given below.
![Alt](./images/details_page.png)
![Alt](../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.
Each Details Page is headed with an **overview box) listing some of the entity's attributes. Depending on the permissions associated with your user type, you may see an **edit entity button (denoted with a pencil icon)** and an **permissions button (denoted with an eye icon)**. These will take you to the Entity Editor Page and the Permissions Management Page respectively.
Each Details Page is headed with an **overview box) listing some of the entity's attributes. Depending on the permissions associated with your user type, you may see an **edit entity button (denoted with a pencil icon)** and an **permissions button (denoted with an eye icon)**. These will take you to the Entity Editor Page and the Permissions Management Page respectively.
Beneath the overview box several information boxes will be listed displaying further details of the entity.
......@@ -43,26 +43,26 @@ If you have edit permissions for the entity, then at the top right corner of som
* create links to other entities e.g. link contacts with projects.
* create (inline) detail records to the current entity e.g. one or more publications to a project.
<a name="EEP"></a>
<a name="EEP"></a>
## 2.3 Entity Editor Pages
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](./images/editor_form.png)
![Alt](../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](./images/validation_error.png)
![Alt](../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](./images/page_messages.png)
![Alt](../img//page_messages.png)
<center>Message display in DAISY</center>
......
external/daisy/project_management.md
+ 48
− 48
View file @ 769e4a16
<a name="PM"></a>
# 3 Project Management
<a name="PM1"></a>
## 3.1 Create New Project
<mark>In order to create a new project</mark>:
1. Click Projects from the Menu Bar.<br />
![Alt](./images/project_menubar.png)
![Alt](../img//project_menubar.png)
2. Click the add button from the Project Search Page.<br />
![Alt](./images/add_button.png)
![Alt](../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](./images/project_custodians.png)
![Alt](../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](./images/project_created.png)
![Alt](../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](./images/project_add_dataset.png)
![Alt](../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](./images/project_add_dataset_form.png)
![Alt](../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](./images/project_add_dataset_result.png)
![Alt](../img//project_add_dataset_result.png)
<a name="PM22"></a>
### 3.2.2 Add Contract to Project
......@@ -50,76 +50,76 @@ TBC
A project's _Personnel_ refer to those persons that work on the project, we assume that these persons will all have a user account for the DAISY system. The **Personnel** detail box on the _Project_ page also allows linking DAISY _Users_ as personnel of a Project, to do so;
1. Click the plus button on the **Personnel** details box, as seen below.<br />
![Alt](./images/project_ref_user.png)
![Alt](../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](./images/project_ref_user_search.png)
![Alt](../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](./images/project_remove_user.png)
![Alt](../img//project_remove_user.png)
<a name="PM24"></a>
### 3.2.4 Manage Project Contacts
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;
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](./images/project_add_contact.png)
![Alt](../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](./images/project_ref_contact.png)
![Alt](../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](./images/project_add_contact_form.png)
![Alt](../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](./images/project_remove_contact.png)
![Alt](../img//project_remove_contact.png)
<a name="PM25"></a>
### 3.2.5 Manage Project Documentation
<a name="PM25"></a>
### 3.2.5 Manage Project Documentation
You can attach documents to a project record in DAISY. Examples of documents are the Project Proposal, Ethics Approvals, Templates of Consent Form or the Subject Information Sheet. Documents can be in any format, PDF, Word or scans. If the document is stored already in an external system, you can also record its link in DAISY.
You can attach documents to a project record in DAISY. Examples of documents are the Project Proposal, Ethics Approvals, Templates of Consent Form or the Subject Information Sheet. Documents can be in any format, PDF, Word or scans. If the document is stored already in an external system, you can also record its link in DAISY.
Document management is done via the **Documents** detail box, as follows:
1. Click the plus button on the **Documents** detail box.<br />
![Alt](./images/project_add_document.png)
![Alt](../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](./images/project_add_document_form.png)
![Alt](../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](./images/project_remove_document.png)
![Alt](../img//project_remove_document.png)
### 3.2.6 Manage Project Publications
### 3.2.6 Manage Project Publications
<a name="PM26"></a>
A project's _Publications_ can be managed via the **Publications 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](./images/project_add_publication.png)
![Alt](../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](./images/project_ref_publication.png)
![Alt](../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](./images/project_add_publication_form.png)
![Alt](../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](./images/project_remove_publication.png)
![Alt](../img//project_remove_publication.png)
<br />
......
external/daisy/user_management.md
+ 7
− 7
View file @ 769e4a16
# 7 Login, Types of Users and Permissions
Upon successful installation of DAISY, going to the web address ```https://${IP_ADDRESS_OR_NAME_OF_DEPLOYMENT_SERVER}```
should display the login page.
![Alt](./images/login.png)
![Alt](../img//login.png)
<center>DAISY Login Page</center>
Based on the authentication configuration made for your deployment, you may login by:
* user definitions in an existing LDAP directory, e.g. institutional/uni credentials
......@@ -20,15 +20,15 @@ Specifically, DAISY has the following **user groups** to support record access
* **standard**: This is the default role assigned to all users. All DAISY users can view all Dataset, Project, Contract and Definitions (Cohorts, Partner, Contact). The document attachments of records are excluded from this view permission.
* **vip**: This role is typically given to research principle investigators. VIP users have all privileges on the records they own, meaning the records where the user has been appointed as the ``Local Custodian``. They also have the right to give permissions to others on these records.
* **legal**: This role is given to users that will be managing _Contract_ records. Legal personnel will be able to create view and edit contract as well as view all other records in DAISY and manage their document attachments
* **auditor**: This role would designed to an external person, who is given view-only temporary access to all DAISY records. This would typically happening an audit scenario.
* **legal**: This role is given to users that will be managing _Contract_ records. Legal personnel will be able to create view and edit contract as well as view all other records in DAISY and manage their document attachments
* **auditor**: This role would designed to an external person, who is given view-only temporary access to all DAISY records. This would typically happening an audit scenario.
DAISY supports fine-grained permission management with the following categories of permissible actions. The ability to _View_ records, _View Document_ attachments of records, ability to _Edit_ and _Delete_ records. The ability to _Administer Permissions_.
| User Category | Administer Permissions | Delete | Edit | View | View Document Attachments |
| -------------|:-------------:|:-------------:|:-------------:|:-------------:|:-----|
| superuser | P<sub>all</sub>, D<sub>all</sub>, C<sub>all</sub>, Def<sub>all</sub> | P<sub>all</sub>, D<sub>all</sub>, C<sub>all</sub>, Def<sub>all</sub>| P<sub>all</sub>, D<sub>all</sub>, C<sub>all</sub>, Def<sub>all</sub>| P<sub>all</sub>, D<sub>all</sub>, C<sub>all</sub>, Def<sub>all</sub> | P<sub>all</sub>, D<sub>all</sub>, C<sub>all</sub>, Def<sub>all</sub>|
......
external/exchange-channels/duma.md
+ 13
− 13
View file @ 769e4a16
......@@ -14,7 +14,7 @@ You need an **access link** to use AsperaWEB. An access link is a temporary, pas
An access link can be reached via standard web browsers. Data can be transferred to/from an access link in two ways:
* Through the web browser by visiting the link, which is our recommended way of data transfer, described in this [section of the guide](#ASPERAWEB_WEB)
* Through the use of a command line tool. If your data sits in an environment, where you can not launch a web browser, then you may use use a command line client tool to reach an access link. This process is described in this [section of this guide](#ASPERAWEB_CLI).
* Through the use of a command line tool. If your data sits in an environment, where you can not launch a web browser, then you may use use a command line client tool to reach an access link. This process is described in this [section of this guide](#ASPERAWEB_CLI).
The use of DUMA is mediated by LCSB's data stewards. If you require assistance in using DUMA, you should send an email to [LCSB admin team](mailto:lcsb-sysadmins@uni.lu).
......@@ -24,22 +24,22 @@ The use of DUMA is mediated by LCSB's data stewards. If you require assistance i
In the following steps we provide instructions on how to use AsperaWEB web interface.
1. Once you receive your **access link** and **password** from the LCSB, visit the link using a standard web browser. Firefox 66.x (or higher) recommended, but others should also work. You will be prompted for your password (see below).<br/>
![Alt](duma_1.png "Title")
![Alt](../img/duma_1.png "Title")
2. When you visit a AsperaWEB access link for the very first time, you will be prompted to install or update **IBM Aspera Connect** client.
* click **Download** or **Download the App** buttons (see below). <br/>![Alt](duma_2.png "Title")
* click **Download** or **Download the App** buttons (see below). <br/>![Alt](../img/duma_2.png "Title")
* wait for the download to finish, the prompt should go to step 3. <br/>![Alt](duma_3.png "Title")
* wait for the download to finish, the prompt should go to step 3. <br/>![Alt](../img/duma_3.png "Title")
* open the installer just downloaded and start the installer. <br/>![Alt](../img/duma_4.png "Title")
* open the installer just downloaded and start the installer. <br/>![Alt](duma_4.png "Title")
* close the installer, the Aspera Connect should try to open - *depending on your Operating System you may be asked if you are sure to open it* -
* the prompt should disapears
3. The **access link** page will display a **File Browser** section. Depending on the settings per access link, users can create or delete folders in the File Browser and upload and/or download data.<br/>
![Alt](duma_6.png "Title")
![Alt](../img/duma_6.png "Title")
4. Clicking **Upload** or **Download** will launch the **IBM Aspera Connect** client on your computer. You first will be asked whether you allow the client to connect to aspera.lcsb.uni.lu. Choose **Allow**.
......@@ -47,14 +47,14 @@ In the following steps we provide instructions on how to use AsperaWEB web inter
5. At any time you can launch **IBM Aspera Connect** to display the status of uploads to or downloads from your computer. <br/>
![Alt](duma_8.png "Title")
![Alt](../img/duma_8.png "Title")
6. All data are encrypted on server side and they stay encrypted also upon download. For decryption, you have to navigate into your **IBM Aspera Connect** window and click "**Unlock encrypted files**". <br/>
![Alt](duma_9.png "Title") <br/>
![Alt](../img/duma_9.png "Title") <br/>
You will be prompted for encryption passphrase which is present on the file browser. <br/>
![Alt](duma_10.png "Title") <br/>
![Alt](../img/duma_10.png "Title") <br/>
Encrypted files are by default kept on your disc after decryption. If you want to change this behaviour, navigate to Options->Settings and check "Delete encrypted files when finished" box.
......@@ -64,10 +64,10 @@ Encrypted files are by default kept on your disc after decryption. If you want t
## Accessing AsperaWEB via Command-Line Tool
Go to the help section of your access link
Go to the help section of your access link
<br/> ![Alt](duma_help_link.png "Title") <br/><br/><br/>
<br/> ![Alt](../img/duma_help_link.png "Title") <br/><br/><br/>
And follow the steps in the **Using the command line** section.
<br/> ![Alt](duma_cli_tokens.png "Title") <br/><br/><br/>
\ No newline at end of file
<br/> ![Alt](../img/duma_cli_tokens.png "Title") <br/><br/><br/>
\ No newline at end of file
external/exchange-channels/owncloud.md
+ 8
− 8
View file @ 769e4a16
# Owncloud Quickguide
**LCSB ownCloud** is a private cloud storage service for the use of LCSB staff and collaborators. It is suitable for exchanging small-sized files (up to 1-2 gigabyte). All communication with the LCSB ownCloud server is SSL encrypted.
**LCSB ownCloud** is a private cloud storage service for the use of LCSB staff and collaborators. It is suitable for exchanging small-sized files (up to 1-2 gigabyte). All communication with the LCSB ownCloud server is SSL encrypted.
## Obtaining a LUMS account
......@@ -10,28 +10,28 @@ A LUMS (LCSB User Management System) account is needed in order to use LCSB ownC
## Using LCSB ownCloud
Similar to other cloud storage systems, ownCloud is accessible both via a browser and also via a client application. On the web, LCSB's ownCloud is at [https://owncloud.lcsb.uni.lu/](https://owncloud.lcsb.uni.lu/)
Similar to other cloud storage systems, ownCloud is accessible both via a browser and also via a client application. On the web, LCSB's ownCloud is at [https://owncloud.lcsb.uni.lu/](https://owncloud.lcsb.uni.lu/)
![LCSB ownCloud web login](owcld_1.png)
![LCSB ownCloud web login](../img/owcld_1.png)
You can download the ownCloud client suitable for your staff computer [here](https://owncloud.org/download/). User documentation on ownCloud tools and portal can be found [here](https://doc.owncloud.com/server/index.html).
When sharing research data, one should observe the following guidance using Owncloud:
* Limit folder shares to only the personnel that needs to access data.
* Limit folder shares to only the personnel that needs to access data.
* When sharing via Links, always set a **password** and an **expiration date** for the link.
![](owcld_2.png)
![](../img/owcld_2.png)
* When sharing folders via Links, **the link passwords should not be sent plain in email**. Instead, password links should be used. If you need to generate link passwords can use the [Private bin](https://privatebin.lcsb.uni.lu) service hosted by the LCSB.
* When sharing folders via Links, **the link passwords should not be sent plain in email**. Instead, password links should be used. If you need to generate link passwords can use the [Private bin](https://privatebin.lcsb.uni.lu) service hosted by the LCSB.
**IMPORTANT NOTE: Whenever the LCSB shares an ownCloud folder with you (collaborator), the share password will be reachable via link, which will expire. Therefore you should make a record of your password once you view it.**
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