Skip to Content

Changes for page 04. Technical information

Last modified by Branislav ŠIŠKA on 2024/09/12 19:30
From version 6.1
edited by Branislav ŠIŠKA
on 2024/09/12 19:30
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,31 +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 virtualization system proxmox**
10 +(% style="" %)
11 +**Servers**
8 8  
9 -Memory: 48 GB
13 +(% style="" %)
14 +HPE DL385 Gen10 CTO Mod-X 8SFF Svr
10 10  
11 -Processors: 8 cores
16 +(% style="" %)
17 +8x HPE 16GB 2Rx8 PC4-2933Y-R
12 12  
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="" %)
13 13  **Data Storages**
14 14  
28 +(% style="" %)
29 +HP 3PAR data storage 700TB.
30 +
31 +(% style="" %)
32 +HP EML tape library
33 +
34 +(% style="" %)
15 15  Object storage
16 16  
37 +(% style="" %)
17 17  **Firewall**
18 18  
19 -FortiGate 600E
40 +(% style="" %)
41 +HP F1000-S-EI VPN Firewall
20 20  
43 +(% style="" %)
21 21  **~ **
22 22  
46 +(% style="" %)
23 23  = {{id name="04.Technicalinformation-2.Software"/}}2. Software =
24 24  
49 +(% style="" %)
25 25  === {{id name="04.Technicalinformation-Thesoftwarerequirements"/}}The software requirements ===
26 26  
52 +(% style="" %)
27 27  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:
28 28  
55 +(% style="" %)
29 29  * Chrome: (Current - 1) and Current
30 30  * Edge: (Current - 1) and Current
31 31  * Firefox: (Current - 1) and Current
... ... @@ -33,12 +33,16 @@
33 33  * Safari: (Current - 1) and Current
34 34  * Opera: Current
35 35  
63 +(% style="" %)
36 36  (Current means the last available version of given browser)
37 37  
66 +(% style="" %)
38 38  === {{id name="04.Technicalinformation-Programminglanguage"/}}Programming language ===
39 39  
69 +(% style="" %)
40 40  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:
41 41  
72 +(% style="" %)
42 42  * Spring Framework v5.
43 43  * HTML, CSS
44 44  * JavaScript
... ... @@ -50,43 +50,62 @@
50 50  * SQL
51 51  * Oracle database
52 52  
84 +(% style="" %)
53 53  === {{id name="04.Technicalinformation-Operationsystem"/}}Operation system ===
54 54  
55 -Operation system installed on production servers is **RedHat Enterprise Linux 9.4.**
87 +(% style="" %)
88 +Operation system installed on production servers is **RedHat Enterprise Linux 7.4.**
56 56  
90 +(% style="" %)
57 57  === {{id name="04.Technicalinformation-Proxyserver"/}}Proxy server ===
58 58  
93 +(% style="" %)
59 59  The **Apache HTTP Server** is used as gateway from outside world to internal application running in the production server.
60 60  
96 +(% style="" %)
61 61  === {{id name="04.Technicalinformation-Applicationserver"/}}Application server ===
62 62  
99 +(% style="" %)
63 63  The **ClinData** application runs on **Apache Tomcat,** which is an open-source Java Servlet Container developed by the Apache Software Foundation
64 64  
102 +(% style="" %)
65 65  **~ **
66 66  
105 +(% style="" %)
67 67  = {{id name="04.Technicalinformation-3.Database"/}}3. Database =
68 68  
108 +(% style="" %)
69 69  === {{id name="04.Technicalinformation-TheClindataDatabase"/}}The (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) Database ===
70 70  
111 +(% style="" %)
71 71  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.
72 72  
114 +(% style="" %)
73 73  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).
74 74  
117 +(% style="" %)
75 75  **~ **
76 76  
120 +(% style="" %)
77 77  = {{id name="04.Technicalinformation-4.Backup"/}}4. Backup =
78 78  
123 +(% style="" %)
79 79  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**
80 80  
126 +(% style="" %)
81 81  1. Database level backups
82 82  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.
83 83  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.
84 84  1*. **Redo Logs** are archived **every day** to filesystem.
85 85  1. Operation system backups
86 -(% style="color: rgb(23,43,77);" %)Application server is backuped up on operational system level regularly in virtualization sytem (% style="text-align: left;" %)**Proxmox**(% style="color: rgb(23,43,77);" %).
87 87  
133 +(% style="" %)
134 +* **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.
135 +
136 +(% style="" %)
88 88  RMAN configuration file
89 89  
139 +(% style="" %)
90 90  CONFIGURE RETENTION POLICY TO REDUNDANCY 1; # default
91 91  CONFIGURE BACKUP OPTIMIZATION OFF; # default
92 92  CONFIGURE DEFAULT DEVICE TYPE TO DISK; # default
... ... @@ -102,8 +102,10 @@
102 102  CONFIGURE ARCHIVELOG DELETION POLICY TO NONE; # default
103 103  CONFIGURE SNAPSHOT CONTROLFILE NAME TO '/../../oracle/12c/dbs/snapcf_imtm.f'; # default
104 104  
155 +(% style="" %)
105 105  EXPDP configuration file
106 106  
158 +(% style="" %)
107 107  DIRECTORY=dtpump
108 108  DUMPFILE=registry.dmp
109 109  LOGFILE=registry.log
... ... @@ -112,40 +112,57 @@
112 112  JOB_NAME=registry_migration
113 113  SCHEMAS=registry,registry_aud
114 114  
167 +(% style="" %)
115 115  = {{id name="04.Technicalinformation-05.Secureconnection"/}}05. Secure connection =
116 116  
170 +(% style="" %)
117 117  === {{id name="04.Technicalinformation-Security"/}}Security ===
118 118  
173 +(% style="" %)
119 119  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.
120 120  
176 +(% style="" %)
121 121  === {{id name="04.Technicalinformation-Securityredirection"/}}Security redirection ===
122 122  
179 +(% style="" %)
123 123  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.
124 124  
182 +(% style="" %)
125 125  === {{id name="04.Technicalinformation-Certificate"/}}Certificate ===
126 126  
185 +(% style="" %)
127 127  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.
128 128  
188 +(% style="" %)
129 129  **~ **
130 130  
191 +(% style="" %)
131 131  = {{id name="04.Technicalinformation-06.Authenticationandauthorization"/}}06. Authentication and authorization =
132 132  
194 +(% style="" %)
133 133  === {{id name="04.Technicalinformation-Usersadministration"/}}Users administration ===
134 134  
197 +(% style="" %)
135 135  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.
136 136  
200 +(% style="" %)
137 137  The **Admin tool** is responsible for:
138 138  
203 +(% style="" %)
139 139  * 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.
140 140  * 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**.
141 141  * Management **roles and profiles**.
142 142  
208 +(% style="" %)
143 143  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.
144 144  
211 +(% style="" %)
145 145  An account for new user can be created **only by administrator**. There is no way that user could create his account on its own.
146 146  
214 +(% style="" %)
147 147  These steps must be followed to **create new account**:
148 148  
217 +(% style="" %)
149 149  * New user asks a project owner to create new account
150 150  * The project owner asks administrator to create new account with specified privileges and roles
151 151  * The administrator creates new account and sets required privileges and roles
... ... @@ -152,35 +152,53 @@
152 152  * The project owner checks account setting and approve it.
153 153  * New user receives his credentials and can log in.
154 154  
224 +(% style="" %)
155 155  === {{id name="04.Technicalinformation-Centralauthenticationservice(CAS)"/}}Central authentication service (CAS) ===
156 156  
227 +(% style="" %)
157 157  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.
158 158  
230 +(% style="" %)
159 159  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.
160 160  
233 +(% style="" %)
161 161  = {{id name="04.Technicalinformation-07.PrivilegesandRoles"/}}07. Privileges and Roles =
162 162  
236 +(% style="" %)
163 163  === {{id name="04.Technicalinformation-Accessrestrictions"/}}**Access restrictions** ===
164 164  
239 +(% style="" %)
165 165  A user access can be restricted in two different areas:
166 166  
242 +(% style="" %)
167 167  * restriction in **access to** ClinData **functionality**
168 168  * restriction in **access to data** stored in the ClinData software
169 169  
246 +(% style="" %)
170 170  All restriction is set in the **IMTM Admin tool**.
171 171  
249 +(% style="" %)
172 172  === {{id name="04.Technicalinformation-Functionalityrestrictions"/}}Functionality restrictions ===
173 173  
252 +(% style="" %)
174 174  **Privileges**
175 175  
255 +(% style="" %)
176 176  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.
177 177  
258 +(% style="" %)
259 +The picture shows schema of privileges in the (% style="color: rgb(23,43,77);text-decoration: none;" %)Clindata(%%) software.
260 +
261 +(% style="" %)
178 178  **Roles**
179 179  
264 +(% style="" %)
180 180  Roles are virtual entities which serve as container for more privileges.
181 181  
267 +(% style="" %)
182 182  There are predefined roles and users, or groups of users can be assigned to them. The most frequently used roles are:
183 183  
270 +(% style="" %)
184 184  * ClinData system admin - full access to all functions in ClinData, no restrictions, creating new project
185 185  * ClinData project admin - full access to all function in selected project including study designer
186 186  * ClinData project data manager - access to all functions needed to insert new/update patient’s data.
... ... @@ -187,36 +187,50 @@
187 187  * ClinData project data monitor - access to all functions needed for study monitoring, validation and finishing CRFs.
188 188  * ClinData project data browser - read only access to selected data.
189 189  
277 +(% style="" %)
190 190  \\
191 191  
280 +(% style="" %)
192 192  === {{id name="04.Technicalinformation-Datarestrictions"/}}Data restrictions ===
193 193  
283 +(% style="" %)
194 194  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.
195 195  
286 +(% style="" %)
196 196  These options can be set:
197 197  
289 +(% style="" %)
198 198  * user can see only his data
199 199  * user can see data inserted by other user or group of users
200 200  * user can see data linked with an organization
201 201  * user can see all data in a study
202 202  
295 +(% style="" %)
203 203  === {{id name="04.Technicalinformation-Personaldata"/}}Personal data ===
204 204  
298 +(% style="" %)
205 205  There can be studies or registers which contain personal data. Access to this data can be restricted by special privilege.
206 206  
301 +(% style="" %)
207 207  These options can be set:
208 208  
304 +(% style="" %)
209 209  * user can see personal data
210 210  * user can't see personal data
211 211  
308 +(% style="" %)
212 212  \\
213 213  
311 +(% style="" %)
214 214  = {{id name="04.Technicalinformation-8.Logging"/}}8. Logging =
215 215  
314 +(% style="" %)
216 216  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.
217 217  
317 +(% style="" %)
218 218  There are three different types of logging mechanisms:
219 219  
320 +(% style="" %)
220 220  * **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.
221 221  * **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:
222 222  ** create
... ... @@ -232,44 +232,65 @@
232 232  ** what was changed
233 233  ** what is the new value
234 234  
336 +(% style="" %)
235 235  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.
236 236  
339 +(% style="" %)
237 237  **~ **
238 238  
342 +(% style="" %)
239 239  = {{id name="04.Technicalinformation-9.Softwaredevelopment"/}}9. Software development =
240 240  
345 +(% style="" %)
241 241  === {{id name="04.Technicalinformation-Issuetracking"/}}Issue tracking ===
242 242  
348 +(% style="" %)
243 243  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.
244 244  
351 +(% style="" %)
245 245  === {{id name="04.Technicalinformation-Changesmanagement"/}}Changes management ===
246 246  
354 +(% style="" %)
247 247  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.
248 248  
357 +(% style="" %)
249 249  === {{id name="04.Technicalinformation-Versioning"/}}Versioning ===
250 250  
360 +(% style="" %)
251 251  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.
252 252  
363 +(% style="" %)
253 253  === {{id name="04.Technicalinformation-Codereview"/}}Code review ===
254 254  
366 +(% style="" %)
255 255  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.
256 256  
369 +(% style="" %)
257 257  **~ **
258 258  
372 +(% style="" %)
259 259  = {{id name="04.Technicalinformation-10.Qualityassurance"/}}10. Quality assurance =
260 260  
375 +(% style="" %)
261 261  === {{id name="04.Technicalinformation-Testingenvironment"/}}Testing environment ===
262 262  
378 +(% style="" %)
263 263  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.
264 264  
381 +(% style="" %)
265 265  === {{id name="04.Technicalinformation-Unittesting"/}}Unit testing ===
266 266  
384 +(% style="" %)
267 267  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.
268 268  
387 +(% style="" %)
269 269  === {{id name="04.Technicalinformation-Applicationtesting"/}}Application testing ===
270 270  
390 +(% style="" %)
271 271  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.
272 272  
393 +(% style="" %)
273 273  === {{id name="04.Technicalinformation-Publishing"/}}Publishing ===
274 274  
396 +(% style="" %)
275 275  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 -106791071
1 +153059348