Skip to content

Commit 4dd1dae

Browse files
committed
Merge branch 'release-1.2.2'
2 parents c0bfada + 0db49b4 commit 4dd1dae

File tree

7 files changed

+52
-45
lines changed

7 files changed

+52
-45
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@ The webserver will start initialising, create any missing required tables in the
149149
#### Notes
150150
* The organisms table is prepopulated on creation however all but human are turned off. Set the active column to 1 in the database to turn on an organism (Example (this will activate mouse): `update taxon set active=1 where taxon_id=10090`)
151151
* If a required table is not found in the database upon application startup it will create it, it will NOT delete existing data.
152+
* In order to access the RDMMN shared data system (international search), your application must use HTTPs. If you do not have HTTPs setup for you domain, you can consult the following guides on how to set it up:
153+
- [medium.com/@raupach/how-to-install-lets-encrypt-with-tomcat-3db8a469e3d2](https://medium.com/@raupach/how-to-install-lets-encrypt-with-tomcat-3db8a469e3d2)
154+
- [community.letsencrypt.org/t/configuring-lets-encrypt-with-tomcat-6-x-and-7-x/32416](https://community.letsencrypt.org/t/configuring-lets-encrypt-with-tomcat-6-x-and-7-x/32416)
152155

153156
## Building From Source
154157

faq.properties

+17-14
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ rdp.faq.questions.purpose=What is the purpose of the registry?
88
rdp.faq.questions.who=Who should register?
99
rdp.faq.questions.privacy=Who will see the information I submit?
1010
rdp.faq.questions.privacy-settings=What Data Privacy Settings should I choose?
11-
rdp.faq.questions.isearch=What does it mean to share data with international partners?
11+
rdp.faq.questions.isearch=What does it mean to share data with partner registries?
1212
rdp.faq.questions.whatnow=What happens after I fill in my information?
1313
rdp.faq.questions.process=What is the process for making a catalyst grant award?
1414
rdp.faq.questions.organisms=What model organisms are directly supported within the registry?
@@ -42,25 +42,28 @@ target="_blank" href="http://www.rare-diseases-catalyst-network.ca/register-as-a
4242

4343

4444
rdp.faq.answers.privacy=The registry is password-protected and the information you enter will be kept secure. \
45-
The visibility of your information depends on your <a href="#privacy-settings">Data Privacy \
46-
and International Sharing settings</a> on the Profile page.
45+
The visibility of your information depends on your <a href="#privacy-settings">Data Privacy</a> \
46+
and <a href="#isearch">Partner registry sharing settings</a> on the Profile page.
4747

48-
rdp.faq.answers.privacy-settings=Data Privacy Settings section on your Profile page lets you choose your local data sharing preferences. The default setting for the registry is pre-selected, but can be changed. The options are: \
49-
<ul><li><b>private (admin-only)</b> - your information will only be accessible by \
48+
rdp.faq.answers.privacy-settings=Data Privacy Settings section on your Profile page lets you choose your local \
49+
data sharing preferences. The default setting for the registry is pre-selected, but can be changed. The options are: \
50+
<ul><li><b>private</b> - your information will only be accessible by \
5051
Network administrators for matching you to a new rare disease gene and considering you for funding opportunities.</li> \
51-
<li><b>shared</b> - your information will be accessible by other researchers who are registered.\
52-
Registered users will be able to access your information through the provided search interface.</li>\
53-
<li><b>public</b> - your information will be visible publicly. Your information will be shared (see above)\
54-
with registered users and will be accessible to non-registered users through the registrys public search webpage (<i>${rdp.site.host}</i>)</li></ul>
52+
<li><b>shared</b> - your information will be accessible by other researchers who are registered. \
53+
Registered users will be able to access your information through the provided search interface.</li> \
54+
<li><b>public</b> - your information will be visible publicly. Your information will be shared (see above) \
55+
with registered users and will be accessible to non-registered users through the registry's public search webpage (<i>${rdp.site.host}</i>)</li></ul>
5556

5657
rdp.faq.answers.isearch=<p>The RDMM Network has recently established linkages with similar rare disease networks around the world, \
5758
with the intention to enable matches across borders when there is no MO expertise within the country where the disease variant is discovered. \
58-
We have shared the registry software with these international networks and implemented changes so that these different software instances can exchange data in a secure way.\
59+
We have shared the registry software with these partner networks and implemented changes so that these different software instances \
60+
can exchange data in a secure way. \
5961
<p/><p>\
60-
International Sharing section on your Profile page gives you the option to set your preference for sharing your data with the RDMM Network's international \
61-
partners for the purposes of establishing connections between international clinician sciences and Canadian model organism researchers. \
62-
The internationally shared data will only be visible to the administrators of remote registries. The default setting, that the data is shared internationally, \
63-
is pre-selected, but can be changed (unless your data privacy level is "public", in which case the "international sharing" will be the only option).</p>
62+
Partner registry sharing section on your Profile page gives you the option to set your preference for sharing your data with the RDMM Network's \
63+
partner registries for the purposes of establishing connections between clinician sciences who are submitting their rare \
64+
disease genes to partner registries and Canadian model organism researchers. \
65+
The shared data will only be visible to the administrators of the partner registries. \
66+
If your data privacy level is set to "public", partner registries will gain access automatically.</p>
6467

6568
rdp.faq.answers.whatnow=In response to a Connection \
6669
Application, the Scientific Advisory Committee will search the \

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<groupId>ubc.pavlab</groupId>
77
<artifactId>rdp</artifactId>
8-
<version>1.2.1</version>
8+
<version>1.2.2</version>
99

1010
<parent>
1111
<groupId>org.springframework.boot</groupId>

src/main/java/ubc/pavlab/rdp/controllers/ApiController.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@
3030
public class ApiController {
3131

3232
private static final Log log = LogFactory.getLog( ApiController.class );
33-
private static final String API_VERSION = "1.0.0";
33+
private static final String API_VERSION = "1.0.0"; //TODO update every time there is any change in how the API works.
3434
private static final String MISCONF_REMOTE_ADMIN = "The remote admin account is misconfigured! Remote searches won't be able to authenticate even with valid security tokens!";
3535
private static final Map<String, String> ROOT_DATA;
3636
private static final ResponseEntity<String> TIER3_RESPONSE = new ResponseEntity<>(
37-
"Tier3 genes not published internationally.", null, HttpStatus.NOT_FOUND );
37+
"Tier3 genes not published to partner registires.", null, HttpStatus.NOT_FOUND );
3838
private static final ResponseEntity<String> GENE_NULL_RESPONSE = new ResponseEntity<>( "Unknown gene.", null,
3939
HttpStatus.NOT_FOUND );
4040
private static final ResponseEntity<String> ORTHOLOG_NULL_RESPONSE = new ResponseEntity<>(
@@ -224,7 +224,7 @@ private TierType restrictTiers( TierType tier ) throws TierException {
224224
case ANY:
225225
return TierType.TIERS1_2;
226226
case TIER3:
227-
throw new TierException( "TIER3 not allowed for international search" );
227+
throw new TierException( "TIER3 not allowed for partner search" );
228228
default:
229229
return tier;
230230
}

src/main/resources/application.properties

+9-8
Original file line numberDiff line numberDiff line change
@@ -98,21 +98,22 @@ ga.domain=
9898
# ==============================================================
9999

100100
# Privacy settings
101-
## Whether the search page is accessible by visitors (i.e. non-registered users)
101+
## whether the public search webpage will be shown (the root URL for the registry).
102+
## If "false" is selected, the root URL we go directly to login/register page.
102103
rdp.settings.privacy.public-search=true
103-
## Whether the search page is accessible by registered users
104+
## Whether logged in users will be able to access the Search tab and thus perform searches of shared and public data.
104105
rdp.settings.privacy.registered-search=true
105-
## 0 = private, 1 = shared with registered users, 2 = public
106+
## Default Data Privacy Level. New users will have this option selected. 0 = private, 1 = shared with registered users, 2 = public
106107
rdp.settings.privacy.default-level=0
107-
## Minimum allowed privacy level
108+
## Minimum allowed Data Privacy Level. Options lower than this level will not be shown in the user’s Profile.
108109
rdp.settings.privacy.min-level=0
109-
## share with international instances
110+
## Default setting for partner registries sharing. If true, new users will have the sharing setting enabled by default.
110111
rdp.settings.privacy.default-sharing=false
111-
## whether users are allowed to change their privacy settings
112+
## Determines if users are allowed to change their privacy settings. If "false" the Data Privacy Settings section in the Profile will not be displayed.
112113
rdp.settings.privacy.customizable-level=false
113-
## whether users are allowed to change their international sharing setting
114+
## Determines if users are allowed to change their partner registries sharing setting. If "false" the "Share data with partner registries" section in the Profile will not be displayed.
114115
rdp.settings.privacy.customizable-sharing=false
115-
## whether users are allowed to hide their gene-list when their data is shared or public
116+
## Allows users to hide their gene list (but still show their profile info) in search results when their data privacy level is 1 or 2. If "false" the option will no be displayed in the Profile.
116117
rdp.settings.privacy.allow-hide-genelist=false
117118

118119
# international search settings

src/main/resources/templates/search.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<div th:replace="fragments/header">...</div>
4141

4242
<div class="container p-4">
43-
<div th:replace="fragments/title :: title(title='Search', subtitle='researchers &amp; genes')"
43+
<div th:replace="fragments/title :: title(title='Search', subtitle='Researchers &amp; genes')"
4444
th:remove="tag">...
4545
</div>
4646

@@ -189,7 +189,7 @@ <h5>Search for researchers that study the following organism-specific gene:</h5>
189189
data-ot-background="cornflowerblue"
190190
data-ot-border-color="white"
191191
data-ot-shadow-color="lightgray"
192-
data-ot="If enabled, the search will include matches found in registries of our international partners">
192+
data-ot="If enabled, the search will include matches found in our partner registries">
193193
</i>
194194
</span>
195195
</label>

src/main/resources/templates/user/documentation.html

+17-17
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h5 class="mb-0">
102102
The options are:
103103
</p>
104104
<ul>
105-
<li><b>private (admin-only)</b> - your information will only be accessible by
105+
<li><b>private</b> - your information will only be accessible by
106106
Network administrators for matching you to a new rare disease gene and considering you for funding opportunities.</li>
107107
<li><b>shared</b> - your information will be accessible by other researchers who are registered.
108108
Registered users will be able to access your information through the provided search interface.</li>
@@ -111,13 +111,13 @@ <h5 class="mb-0">
111111
</ul>
112112
</div>
113113
<p th:if="${@applicationSettings.getPrivacy().isCustomizableSharing()}">
114-
International Sharing section gives you the option to set your preference for
115-
sharing your data with the Network’s international partners for the purposes of
116-
establishing connections between international clinician sciences and Canadian model
117-
organism researchers. The internationally shared data will only be visible to the
118-
administrators of remote registries. The default setting, that the data is
119-
shared internationally, is pre-selected, but can be changed. If your data privacy
120-
level is set to "public", the "international sharing" will be automatic.
114+
Furthermore this section gives you the option to set your preference for
115+
sharing your data with the network’s partner registries for the purposes
116+
of establishing connections between clinician sciences who are submitting
117+
their rare disease genes to partner registries and Canadian model organism
118+
researchers. The data shared with partner registries will only be visible to
119+
the administrators of those registries. If your data privacy level is set to "public",
120+
partner registries will gain access automatically.
121121
</p>
122122
</div>
123123
</div>
@@ -371,25 +371,25 @@ <h5 class="mb-0">
371371
<p>
372372
The Search page allows you to browse or search for other registered users
373373
who chose to share their data by selecting "shared" or "public" data privacy setting.
374-
If "Include international search results" option is selected,
375-
the registry will connect to remote registries of the RDMM international
374+
If "Include results from partner registries" option is selected,
375+
the registry will connect to remote registries of the RDMM
376376
partners and display/search their "public" users.
377377
</p>
378378
<p>
379379
There are two ways to search for users: using their name and profile information
380380
("researcher" tab) or using gene search ("Gene" tab). In the "researcher" tab you can search in the following ways:
381381
</p>
382382
<ul>
383-
<li>Click on letters of the alphabet to retrieve all users whose first or last letter begin with that letter</li>
384-
<li>Enter one or more letters of the user"s name in "Search by name" box</li>
385-
<li>Search for keywords in the user"s research description</li>
383+
<li>Click on letters of the alphabet to retrieve all users whose last name begins with that letter</li>
384+
<li>Enter one or more letters of the user's name in "Search by name" box</li>
385+
<li>Search for keywords in the user's research description</li>
386386
</ul>
387387
<p>
388388
After clicking on the Search button (or a letter of the alphabet) the list of
389-
results will be displayed at the bottom of the page. If "Include international search results" is selected,
390-
the international results will be displayed in a separate section with the
391-
indication from which international registry the matches are coming from ("Origin").
392-
Clicking on a user"s email address will open a new tab with the user"s profile and gene information.
389+
results will be displayed at the bottom of the page. If "Include results from partner registries" is selected,
390+
the partner registries results will be displayed in a separate section with the
391+
indication from which registry the matches are coming from ("Origin").
392+
Clicking on a user's email address will open a new tab with the user's profile and gene information.
393393
</p>
394394
<p>
395395
"Gene" tab allows you to search for registered users based on genes they study.

0 commit comments

Comments
 (0)