Skip to Content

Changes for page 04. Technical information

Last modified by Branislav ŠIŠKA on 2024/09/12 19:30
From version 3.1
edited by Branislav ŠIŠKA
on 2024/09/12 19:03
Change comment: There is no comment for this version
To version 2.1
edited by Branislav ŠIŠKA
on 2023/06/06 09:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,33 +1,58 @@
1 +(% style="" %)
1 1  = {{id name="04.Technicalinformation-1.Hardware"/}}1. Hardware =
2 2  
4 +(% style="" %)
3 3  The Clindata software runs on computer cluster located on Institute of Molecular and Translational Medicine (IMTM), Faculty of Medicine and Dentistry, Palacky University in Olomouc. The facility is secured and under global surveillance.
4 4  
7 +(% style="" %)
5 5  === {{id name="04.Technicalinformation-Descriptionofhardware"/}}Description of hardware ===
6 6  
7 -**Server in(% style="" %) virtualization system proxmox(%%)**
10 +(% style="" %)
11 +**Servers**
8 8  
9 9  (% style="" %)
10 -Paměť: 48 GB
14 +HPE DL385 Gen10 CTO Mod-X 8SFF Svr
11 11  
12 12  (% style="" %)
13 -Procesory: 8 jader
17 +8x HPE 16GB 2Rx8 PC4-2933Y-R
14 14  
19 +(% style="" %)
20 +2x HPE DL385 Gen10 AMD EPYC 7302
21 +
22 +(% style="" %)
23 +2x HPE 240GB SATA RI SFF SC DS SSD
24 +
25 +(% style="" %)
15 15  **Data Storages**
16 16  
28 +(% style="" %)
29 +HP 3PAR data storage 700TB.
30 +
31 +(% style="" %)
32 +HP EML tape library
33 +
34 +(% style="" %)
17 17  Object storage
18 18  
37 +(% style="" %)
19 19  **Firewall**
20 20  
21 -FortiGate 600E
40 +(% style="" %)
41 +HP F1000-S-EI VPN Firewall
22 22  
43 +(% style="" %)
23 23  **~ **
24 24  
46 +(% style="" %)
25 25  = {{id name="04.Technicalinformation-2.Software"/}}2. Software =
26 26  
49 +(% style="" %)
27 27  === {{id name="04.Technicalinformation-Thesoftwarerequirements"/}}The software requirements ===
28 28  
52 +(% style="" %)
29 29  The only requirement for using the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software is Internet browser which supports HTML5 standard. The list of supported browsers:
30 30  
55 +(% style="" %)
31 31  * Chrome: (Current - 1) and Current
32 32  * Edge: (Current - 1) and Current
33 33  * Firefox: (Current - 1) and Current
... ... @@ -35,12 +35,16 @@
35 35  * Safari: (Current - 1) and Current
36 36  * Opera: Current
37 37  
63 +(% style="" %)
38 38  (Current means the last available version of given browser)
39 39  
66 +(% style="" %)
40 40  === {{id name="04.Technicalinformation-Programminglanguage"/}}Programming language ===
41 41  
69 +(% style="" %)
42 42  The main programming language used for development of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) application is Java 8. Other technologies used for development are:
43 43  
72 +(% style="" %)
44 44  * Spring Framework v5.
45 45  * HTML, CSS
46 46  * JavaScript
... ... @@ -52,34 +52,49 @@
52 52  * SQL
53 53  * Oracle database
54 54  
84 +(% style="" %)
55 55  === {{id name="04.Technicalinformation-Operationsystem"/}}Operation system ===
56 56  
87 +(% style="" %)
57 57  Operation system installed on production servers is **RedHat Enterprise Linux 7.4.**
58 58  
90 +(% style="" %)
59 59  === {{id name="04.Technicalinformation-Proxyserver"/}}Proxy server ===
60 60  
93 +(% style="" %)
61 61  The **Apache HTTP Server** is used as gateway from outside world to internal application running in the production server.
62 62  
96 +(% style="" %)
63 63  === {{id name="04.Technicalinformation-Applicationserver"/}}Application server ===
64 64  
99 +(% style="" %)
65 65  The **ClinData** application runs on **Apache Tomcat,** which is an open-source Java Servlet Container developed by the Apache Software Foundation
66 66  
102 +(% style="" %)
67 67  **~ **
68 68  
105 +(% style="" %)
69 69  = {{id name="04.Technicalinformation-3.Database"/}}3. Database =
70 70  
108 +(% style="" %)
71 71  === {{id name="04.Technicalinformation-TheClindataDatabase"/}}The (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) Database ===
72 72  
111 +(% style="" %)
73 73  The database used for storing data from the (% style="color: rgb(23,43,77);text-decoration: none;" %)**Clindata**(%%)** **software is **Oracle Database** (commonly referred to as **Oracle RDBMS**) which is produced by Oracle Corporation. Version of database is 12.1. Standard edition.
74 74  
114 +(% style="" %)
75 75  The Oracle database runs on separated Linux based server which si firewalled from external network (Internet) by hardware firewall. This database server is not accessible from outside of organization but only from enlisted inner servers (application and backup servers).
76 76  
117 +(% style="" %)
77 77  **~ **
78 78  
120 +(% style="" %)
79 79  = {{id name="04.Technicalinformation-4.Backup"/}}4. Backup =
80 80  
123 +(% style="" %)
81 81  There are more levels of data archiving to ensure data safety and quick database recovery. Data are archived on **database level** and **operation system level**
82 82  
126 +(% style="" %)
83 83  1. Database level backups
84 84  1*. **RMAN** utility is integral part of the Oracle database. It creates binary copy of whole database and stores it to filesystem. The RMAN utility is run **every week**. The files are stored internally on database server and are copied to two independent backup sites.
85 85  1*. **EXPDP/IMPDP** is data pump exporting data into text base backups. The EXPDP utility is run **every 4 hours**. The backup target is the same as with RMAN. It is stored to two independent backup sites.
... ... @@ -86,10 +86,13 @@
86 86  1*. **Redo Logs** are archived **every day** to filesystem.
87 87  1. Operation system backups
88 88  
133 +(% style="" %)
89 89  * **IBM Tivoli Storage Manager** (TSM Admin) is enterprise solution from IBM for backups and recovery of physical or virtual servers. The backup created by TSM Admin includes redo logs, RMAN and EXPDP exports. It runs **every day** and the backup data is stored to disk array.
90 90  
136 +(% style="" %)
91 91  RMAN configuration file
92 92  
139 +(% style="" %)
93 93  CONFIGURE RETENTION POLICY TO REDUNDANCY 1; # default
94 94  CONFIGURE BACKUP OPTIMIZATION OFF; # default
95 95  CONFIGURE DEFAULT DEVICE TYPE TO DISK; # default
... ... @@ -105,8 +105,10 @@
105 105  CONFIGURE ARCHIVELOG DELETION POLICY TO NONE; # default
106 106  CONFIGURE SNAPSHOT CONTROLFILE NAME TO '/../../oracle/12c/dbs/snapcf_imtm.f'; # default
107 107  
155 +(% style="" %)
108 108  EXPDP configuration file
109 109  
158 +(% style="" %)
110 110  DIRECTORY=dtpump
111 111  DUMPFILE=registry.dmp
112 112  LOGFILE=registry.log
... ... @@ -115,40 +115,57 @@
115 115  JOB_NAME=registry_migration
116 116  SCHEMAS=registry,registry_aud
117 117  
167 +(% style="" %)
118 118  = {{id name="04.Technicalinformation-05.Secureconnection"/}}05. Secure connection =
119 119  
170 +(% style="" %)
120 120  === {{id name="04.Technicalinformation-Security"/}}Security ===
121 121  
173 +(% style="" %)
122 122  As the (% style="color: rgb(23,43,77);text-decoration: none;" %)**Clindata**(%%)** **application is **web-based** application there is need to **secure communication** between **server** and **client's computer**. It is done by using **HTTPS** communication protocol which is encrypted using Transport Layer Security **(TLS).** This protocol is widely used for all secure transactions on the Internet (payment, emails etc.) and is considered as safe and unbreakable. It protects against man in-the middle attacks. Communication without the security layer (HTTP) is can be interfered by attackers, they can listen to it or change it.
123 123  
176 +(% style="" %)
124 124  === {{id name="04.Technicalinformation-Securityredirection"/}}Security redirection ===
125 125  
179 +(% style="" %)
126 126  All user requests coming via unsecured **HTTP** protocol are automatically **redirected** to secure **HTTPS** protocol. All communication between client and server is secured and there is no way how to connect to the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software via unsecured connection.
127 127  
182 +(% style="" %)
128 128  === {{id name="04.Technicalinformation-Certificate"/}}Certificate ===
129 129  
185 +(% style="" %)
130 130  The secured communication requires a certificate stored on the web server. The certificate must be signed by **trusted certificate authority**. The (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) server uses the certificate digitally signed by **TERENA** authority.
131 131  
188 +(% style="" %)
132 132  **~ **
133 133  
191 +(% style="" %)
134 134  = {{id name="04.Technicalinformation-06.Authenticationandauthorization"/}}06. Authentication and authorization =
135 135  
194 +(% style="" %)
136 136  === {{id name="04.Technicalinformation-Usersadministration"/}}Users administration ===
137 137  
197 +(% style="" %)
138 138  All user using the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) application must be registered before they can log in. There is no possibility to get unauthorized access to the server even for some demonstration purposes. There is a specialized application for user management - IMTM Admin tool.
139 139  
200 +(% style="" %)
140 140  The **Admin tool** is responsible for:
141 141  
203 +(% style="" %)
142 142  * Management of **institutions, companies, hospitals** and their departments. There can be unlimited number of organization levels, for example a university can have such structure university-faculty-department-laboratory. Each organization level can obtain different set of privileges and roles.
143 143  * Management of **users**. Every user is identified by email address as login and password. Users are assigned to their organizations. Users can work on more projects with different roles. It is allowed by** user profiles**. Number of profiles for a user is not limited. Each profile can have different set of **privileges and roles**.
144 144  * Management **roles and profiles**.
145 145  
208 +(% style="" %)
146 146  The Admin database with user's data is stored in the Oracle database as separated schema. Access to this schema is restricted only for admin users. The server with the Oracle database is firewalled out of public network and not accessible from Internet.
147 147  
211 +(% style="" %)
148 148  An account for new user can be created **only by administrator**. There is no way that user could create his account on its own.
149 149  
214 +(% style="" %)
150 150  These steps must be followed to **create new account**:
151 151  
217 +(% style="" %)
152 152  * New user asks a project owner to create new account
153 153  * The project owner asks administrator to create new account with specified privileges and roles
154 154  * The administrator creates new account and sets required privileges and roles
... ... @@ -155,37 +155,53 @@
155 155  * The project owner checks account setting and approve it.
156 156  * New user receives his credentials and can log in.
157 157  
224 +(% style="" %)
158 158  === {{id name="04.Technicalinformation-Centralauthenticationservice(CAS)"/}}Central authentication service (CAS) ===
159 159  
227 +(% style="" %)
160 160  The (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) application must be connected with data from the IMTM Admin to control accounts, roles and privileges. It is done by integrating of the CAS technology into the ClinData software. The CAS technology consists of CAS Server and CAS Client.
161 161  
230 +(% style="" %)
162 162  The CAS server is responsible for authenticating users and granting accesses to applications. The CAS clients protect the CAS applications and retrieve the identity of the granted users from the CAS server.
163 163  
233 +(% style="" %)
164 164  = {{id name="04.Technicalinformation-07.PrivilegesandRoles"/}}07. Privileges and Roles =
165 165  
236 +(% style="" %)
166 166  === {{id name="04.Technicalinformation-Accessrestrictions"/}}**Access restrictions** ===
167 167  
239 +(% style="" %)
168 168  A user access can be restricted in two different areas:
169 169  
242 +(% style="" %)
170 170  * restriction in **access to** ClinData **functionality**
171 171  * restriction in **access to data** stored in the ClinData software
172 172  
246 +(% style="" %)
173 173  All restriction is set in the **IMTM Admin tool**.
174 174  
249 +(% style="" %)
175 175  === {{id name="04.Technicalinformation-Functionalityrestrictions"/}}Functionality restrictions ===
176 176  
252 +(% style="" %)
177 177  **Privileges**
178 178  
255 +(% style="" %)
179 179  Access privileges determine which (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) objects a user can browse or edit. Each functionality in the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software is reflected in corresponding privilege so the access to everything is controlled. Any user or group of users can have access to any privilege granted or restricted.
180 180  
258 +(% style="" %)
181 181  The picture shows schema of privileges in the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software.
182 182  
261 +(% style="" %)
183 183  **Roles**
184 184  
264 +(% style="" %)
185 185  Roles are virtual entities which serve as container for more privileges.
186 186  
267 +(% style="" %)
187 187  There are predefined roles and users, or groups of users can be assigned to them. The most frequently used roles are:
188 188  
270 +(% style="" %)
189 189  * ClinData system admin - full access to all functions in ClinData, no restrictions, creating new project
190 190  * ClinData project admin - full access to all function in selected project including study designer
191 191  * ClinData project data manager - access to all functions needed to insert new/update patient’s data.
... ... @@ -192,36 +192,50 @@
192 192  * ClinData project data monitor - access to all functions needed for study monitoring, validation and finishing CRFs.
193 193  * ClinData project data browser - read only access to selected data.
194 194  
277 +(% style="" %)
195 195  \\
196 196  
280 +(% style="" %)
197 197  === {{id name="04.Technicalinformation-Datarestrictions"/}}Data restrictions ===
198 198  
283 +(% style="" %)
199 199  Default setting for accessing of data in the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software is maximally restricted. A user can see only data he inserted himself. By default, he doesn't see any data inserted by any other user. Access to any other data must be explicitly permitted.
200 200  
286 +(% style="" %)
201 201  These options can be set:
202 202  
289 +(% style="" %)
203 203  * user can see only his data
204 204  * user can see data inserted by other user or group of users
205 205  * user can see data linked with an organization
206 206  * user can see all data in a study
207 207  
295 +(% style="" %)
208 208  === {{id name="04.Technicalinformation-Personaldata"/}}Personal data ===
209 209  
298 +(% style="" %)
210 210  There can be studies or registers which contain personal data. Access to this data can be restricted by special privilege.
211 211  
301 +(% style="" %)
212 212  These options can be set:
213 213  
304 +(% style="" %)
214 214  * user can see personal data
215 215  * user can't see personal data
216 216  
308 +(% style="" %)
217 217  \\
218 218  
311 +(% style="" %)
219 219  = {{id name="04.Technicalinformation-8.Logging"/}}8. Logging =
220 220  
314 +(% style="" %)
221 221  The ClinData software **records everything** happening in the system. Admin user can browse these records in user friendly way and analyze potential problems, watch user activities etc.
222 222  
317 +(% style="" %)
223 223  There are three different types of logging mechanisms:
224 224  
320 +(% style="" %)
225 225  * **Software logging** is done on programming language level and is very detailed. The log files contain data about internal state of the whole system in time of logging event. This approach is designed for detailed analyses of problems which happened in past.
226 226  * **Access logging** is designed for controlling of user’s activities. The access record contains data about who did an action and when. It logs all actions done on all objects in the system. Object can be study, patient, CRF form, file. These actions are logged:
227 227  ** create
... ... @@ -237,44 +237,65 @@
237 237  ** what was changed
238 238  ** what is the new value
239 239  
336 +(% style="" %)
240 240  The important information is that the ClinData software** doesn't delete any record**. Every record in the database has system **flag ACTIVE**. Deleting of the row just sets this **ACTIVE** flag to **false**. The inactive rows are not displayed in the ClinData software but are still stored in the database.
241 241  
339 +(% style="" %)
242 242  **~ **
243 243  
342 +(% style="" %)
244 244  = {{id name="04.Technicalinformation-9.Softwaredevelopment"/}}9. Software development =
245 245  
345 +(% style="" %)
246 246  === {{id name="04.Technicalinformation-Issuetracking"/}}Issue tracking ===
247 247  
348 +(% style="" %)
248 248  Any problem found in the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software is documented and created as a **new issue in JIRA software**. JIRA software is developed by Atlassian and is an issue tracking tool. The new issue is analyzed, and priority is assigned.  The list of issues is sorted by priorities and processed by developers. When a serious problem is fixed then it is published in new version of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software. The issue is also closed as done in JIRA.
249 249  
351 +(% style="" %)
250 250  === {{id name="04.Technicalinformation-Changesmanagement"/}}Changes management ===
251 251  
354 +(% style="" %)
252 252  All requests for changes planned in the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software are stored in JIRA. When a new request is coming then it is analyzed, time estimation is done, and priority assigned. The list of issues is sorted by priorities and processed by developers.
253 253  
357 +(% style="" %)
254 254  === {{id name="04.Technicalinformation-Versioning"/}}Versioning ===
255 255  
360 +(% style="" %)
256 256  The source code of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software is stored in** GIT repository** which allows tracking of changes in files. There is possibility to browse history of any source code file in the repository. Every change is also documented so it is easy to understand the development cycle.
257 257  
363 +(% style="" %)
258 258  === {{id name="04.Technicalinformation-Codereview"/}}Code review ===
259 259  
366 +(% style="" %)
260 260  Any change done in source code of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software must be **reviewed** by another developer. This process is called **code review**. This process minimizes number of bugs in source code because everything is double checked. **Bitbucket software** (developed by Atlassian) is used for code reviews. It prevents developers from using not proven code in public versions of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software.
261 261  
369 +(% style="" %)
262 262  **~ **
263 263  
372 +(% style="" %)
264 264  = {{id name="04.Technicalinformation-10.Qualityassurance"/}}10. Quality assurance =
265 265  
375 +(% style="" %)
266 266  === {{id name="04.Technicalinformation-Testingenvironment"/}}Testing environment ===
267 267  
378 +(% style="" %)
268 268  All new versions of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software must be tested and proven as functional and correct before they are published. There is a special environment which is used form testing of the new version before it is published. The testing environment must be similar to production environment to avoid configuration issues.
269 269  
381 +(% style="" %)
270 270  === {{id name="04.Technicalinformation-Unittesting"/}}Unit testing ===
271 271  
384 +(% style="" %)
272 272  Unit testing is a software testing method by which individual units of source code are tested to determine whether they are fit for use. There are actually more than one thousand-unit tests in the source code of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software. All critical parts of the source code are covered by unit test close to 100%. Overall source code is covered by unit test by more than 85%. Any problem in unit testing is blocker for publishing of the version of the software.
273 273  
387 +(% style="" %)
274 274  === {{id name="04.Technicalinformation-Applicationtesting"/}}Application testing ===
275 275  
390 +(% style="" %)
276 276  The whole application is tested by application exploratory testing before it is published. The application testing is done in testing environment. Any problem in application testing is blocker for publishing of the version.
277 277  
393 +(% style="" %)
278 278  === {{id name="04.Technicalinformation-Publishing"/}}Publishing ===
279 279  
396 +(% style="" %)
280 280  Publishing process means that a new version of the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software is being released and made accessible for users. The Bamboo software (developed by Atlassian) is used for building and publishing new versions. Unit testing is also involved in publishing of the new version. In case of any problem in any unit test the whole publishing, process is interrupted, and an notification email is sent to responsible persons.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -153059352
1 +153059348