From d30c9d6be762778a944fba4d16e437948488baae Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 19 Mar 2021 09:42:29 +0100 Subject: [PATCH 1/8] initial explanation on attribute description --- source/guides/admin.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/source/guides/admin.rst b/source/guides/admin.rst index f3f7696..0240017 100644 --- a/source/guides/admin.rst +++ b/source/guides/admin.rst @@ -41,6 +41,16 @@ Customize Roles 6. Click on one of the saving options +.. _admin-attributes: + +Add Attribute Descriptions +========================== + +Castellum allows to dynamically add attribute descriptions that can be used to +store filterable information on subjects. This takes into account that there are +only very few attributes that can be seen as commonly used at every institute. + + .. _admin-consent-document: Upload a consent document @@ -74,5 +84,3 @@ case there is a two step process: up in the data protection dashboard. The legal basis for each subject can be found in the subject detail view. - - -- GitLab From b124d4955a05e94f0f3015a7b64fb18166b3aa1c Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 19 Mar 2021 09:43:00 +0100 Subject: [PATCH 2/8] add guide links, remove todos --- source/features.rst | 2 +- source/roles.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/features.rst b/source/features.rst index 6992551..867ac99 100644 --- a/source/features.rst +++ b/source/features.rst @@ -42,10 +42,10 @@ Relevant guides: - :ref:`recruitment` - :ref:`recruitment-mail` - :ref:`study-recruitment-settings` +- :ref:`admin-attributes` .. TODO:: - - manage attribute descriptions - attribute download Appointments diff --git a/source/roles.rst b/source/roles.rst index 8b77952..5abc229 100644 --- a/source/roles.rst +++ b/source/roles.rst @@ -91,12 +91,12 @@ Relevant guides: - :ref:`admin-users` - :ref:`admin-unlock` - :ref:`admin-roles` +- :ref:`admin-attributes` - :ref:`admin-consent-document` .. TODO:: - manage resources - - manage attribute descriptions Study specific roles -- GitLab From 782a0bcfe99e67099c340e008d6fd6ce0280b517 Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 26 Mar 2021 15:59:19 +0100 Subject: [PATCH 3/8] simple step by step description for attribute add --- source/guides/admin.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/source/guides/admin.rst b/source/guides/admin.rst index 0240017..57ba53c 100644 --- a/source/guides/admin.rst +++ b/source/guides/admin.rst @@ -50,6 +50,20 @@ Castellum allows to dynamically add attribute descriptions that can be used to store filterable information on subjects. This takes into account that there are only very few attributes that can be seen as commonly used at every institute. +1. Click on **Admin** on the front page +2. Go to **Attribute description** +3. Click on **Add attribute description** (oval with grey background) +4. Select an appropriate **Field type** that should be used for the attribute +5. **URL** allows you to link to a formal definition that may clarify baseline + or rather scientific grounding of the attribute +6. Set **privacy levels** of the attribute for **read** and **write** +7. **Order** and **Category** can be used to position the attribute in UI +8. **Statistics rank** can be used to set this attribute as primary or + secondary feature that should be presented in statistics of recruitment +9. **Label** should be the actual name of the attribute +10. Fill in all **Attribute choices** that represent the possible values of that + attribute and will be used for filtering + .. _admin-consent-document: -- GitLab From e5a457c150bb39a51d02a97f7374977aabaf9c45 Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 26 Mar 2021 16:27:27 +0100 Subject: [PATCH 4/8] add explaining notes to attribute description --- source/guides/admin.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/source/guides/admin.rst b/source/guides/admin.rst index 57ba53c..64c49b2 100644 --- a/source/guides/admin.rst +++ b/source/guides/admin.rst @@ -56,14 +56,35 @@ only very few attributes that can be seen as commonly used at every institute. 4. Select an appropriate **Field type** that should be used for the attribute 5. **URL** allows you to link to a formal definition that may clarify baseline or rather scientific grounding of the attribute + + .. note:: + This is only shown in admin interface. So, this is only supporting the + actual maintenance of the attributes. For example, a Handedness + attribute could link to a definition at `bioontology.org `_ + helping other admin members to understand the chosen + **attribute choices**. + 6. Set **privacy levels** of the attribute for **read** and **write** 7. **Order** and **Category** can be used to position the attribute in UI 8. **Statistics rank** can be used to set this attribute as primary or secondary feature that should be presented in statistics of recruitment + + .. note:: + Castellum offers to set up two attributes to be used in statistics of + recruitment. If there is already a primary or secondary attribute it + will be removed when selecting a different attribute to be primary or + secondary. + 9. **Label** should be the actual name of the attribute -10. Fill in all **Attribute choices** that represent the possible values of that +10. Fill in all **Attribute choices** that represent the possible values of the attribute and will be used for filtering + .. note:: + Attributes will always allow to select **Declined to answer**. So, there + is no need to specify this as an attribute choice. Furthermore, all + three ChoiceField types will automatically provide an **Unknown** + option. + .. _admin-consent-document: -- GitLab From b356f30812c6de08d18b0bd8c4d37d1f25fb7b8e Mon Sep 17 00:00:00 2001 From: TiG Date: Tue, 13 Apr 2021 09:07:11 +0200 Subject: [PATCH 5/8] Correct explanation for URL in attr descriptions --- source/guides/admin.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/source/guides/admin.rst b/source/guides/admin.rst index 64c49b2..390b26b 100644 --- a/source/guides/admin.rst +++ b/source/guides/admin.rst @@ -58,11 +58,10 @@ only very few attributes that can be seen as commonly used at every institute. or rather scientific grounding of the attribute .. note:: - This is only shown in admin interface. So, this is only supporting the - actual maintenance of the attributes. For example, a Handedness - attribute could link to a definition at `bioontology.org `_ - helping other admin members to understand the chosen - **attribute choices**. + This is used to support Attribute Export in BIDS format. Hence, it is + only shown in admin interface. For example, a Handedness attribute could + link to a definition at + `bioontology.org `_. 6. Set **privacy levels** of the attribute for **read** and **write** 7. **Order** and **Category** can be used to position the attribute in UI -- GitLab From 0e54ee6c963dbdcdfecaaa5fc25c0d3b83c4e9be Mon Sep 17 00:00:00 2001 From: TiG Date: Tue, 13 Apr 2021 09:12:25 +0200 Subject: [PATCH 6/8] clarify selecting primary/secondary attr --- source/guides/admin.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/guides/admin.rst b/source/guides/admin.rst index 390b26b..52b4803 100644 --- a/source/guides/admin.rst +++ b/source/guides/admin.rst @@ -71,8 +71,8 @@ only very few attributes that can be seen as commonly used at every institute. .. note:: Castellum offers to set up two attributes to be used in statistics of recruitment. If there is already a primary or secondary attribute it - will be removed when selecting a different attribute to be primary or - secondary. + will show an error warning. Accordingly, you have to deselect a primary + or secondary attribute first to select a new one. 9. **Label** should be the actual name of the attribute 10. Fill in all **Attribute choices** that represent the possible values of the -- GitLab From 842f9f1d749bd6108dfe51e19e26667b70a035a7 Mon Sep 17 00:00:00 2001 From: TiG Date: Tue, 13 Apr 2021 09:14:59 +0200 Subject: [PATCH 7/8] add soft tone to attribute choices --- source/guides/admin.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/guides/admin.rst b/source/guides/admin.rst index 52b4803..8c57497 100644 --- a/source/guides/admin.rst +++ b/source/guides/admin.rst @@ -75,8 +75,8 @@ only very few attributes that can be seen as commonly used at every institute. or secondary attribute first to select a new one. 9. **Label** should be the actual name of the attribute -10. Fill in all **Attribute choices** that represent the possible values of the - attribute and will be used for filtering +10. If appropriate, fill in all **Attribute choices** that represent the + possible values of the attribute and will be used for filtering .. note:: Attributes will always allow to select **Declined to answer**. So, there -- GitLab From 942cec17f35c40d7c942fa746825129705a5ebca Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 16 Apr 2021 10:01:07 +0200 Subject: [PATCH 8/8] mention translations for attribute label / choice --- source/guides/admin.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/source/guides/admin.rst b/source/guides/admin.rst index 8c57497..aa6d143 100644 --- a/source/guides/admin.rst +++ b/source/guides/admin.rst @@ -74,9 +74,11 @@ only very few attributes that can be seen as commonly used at every institute. will show an error warning. Accordingly, you have to deselect a primary or secondary attribute first to select a new one. -9. **Label** should be the actual name of the attribute -10. If appropriate, fill in all **Attribute choices** that represent the - possible values of the attribute and will be used for filtering +9. **Label** should be the actual name of the attribute. Be sure to provide + translations if Castellum is set to support more than one language +10. If appropriate, fill in all **Attribute choices** (if needed also add + translations) that represent the possible values of the attribute and will + be used for filtering .. note:: Attributes will always allow to select **Declined to answer**. So, there -- GitLab