Skip to Content

Wiki source code of 04. Technické informace

Version 7.1 by Branislav ŠIŠKA on 2024/09/12 19:01
Show last authors
1 = {{id name="04.Technickéinformace-1.Hardware"/}}1. Hardware =
2
3 Software Clindata běží na serverech umístěných v Institutu molekulární a translační medicíny (IMTM), Lékařské a stomatologické fakulty, Univerzity Palackého v Olomouci. Zařízení je zabezpečeno a pod dohledem globálního sledování.
4
5 === {{id name="04.Technickéinformace-Popishardwaru"/}}**Popis hardwaru** ===
6
7 **Server zapojený ve virtualizaci proxmox**
8
9 Paměť: 48 GB
10
11 Procesory: 8 jader
12
13 \\
14
15 (% style="color: rgb(55,65,81);" %)**Datová úložiště**
16
17 (% style="color: rgb(55,65,81);" %)Objektové úložiště
18
19 **Firewall**
20
21 FortiGate 600E
22
23 **~ **
24
25 = {{id name="04.Technickéinformace-2.Software"/}}2. Software =
26
27 === {{id name="04.Technickéinformace-Požadavkynasoftware"/}}(% style="color: rgb(55,65,81);" %)Požadavky na software(%%) ===
28
29 (% style="color: rgb(55,65,81);" %)Jediným požadavkem pro použití softwaru Clindata je webový prohlížeč podporující standard HTML5. Seznam podporovaných prohlížečů:
30
31 * Chrome: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
32 * Edge: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
33 * Firefox: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
34 * Internet Explorer: 11+
35 * Safari: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
36 * Opera: (% style="color: rgb(55,65,81);" %)Aktuální
37
38 (% style="color: rgb(55,65,81);" %)(Aktuální znamená poslední dostupná verze daného prohlížeče)
39
40 === {{id name="04.Technickéinformace-Programovacíjazyk"/}}Programovací jazyk ===
41
42 Hlavním programovacím jazykem používaným pro vývoj aplikace Clindata je Java 8. Další technologie používané při vývoji jsou:
43
44 * Spring Framework v5.
45 * HTML, CSS
46 * JavaScript
47 * jQuery
48 * jQuery UI
49 * Bootstrap
50 * MathJS
51 * Datatables
52 * SQL
53 * Oracle database
54
55 === {{id name="04.Technickéinformace-Operačnísystém"/}}Operační systém ===
56
57 Operační systém nainstalovaný na produkčních serverech je RedHat Enterprise Linux 9.4.
58
59 === {{id name="04.Technickéinformace-Proxyserver"/}}Proxy server ===
60
61 Jako brána z vnějšího světa do vnitřní aplikace běžící na produkčním serveru se používá Apache HTTP Server.
62
63 === {{id name="04.Technickéinformace-Aplikačníserver"/}}Aplikační server ===
64
65 Aplikace ClinData běží na Apache Tomcat, což je open-source Java Servlet Container vyvíjený nadací Apache Software Foundation.
66
67 **~ **
68
69 = {{id name="04.Technickéinformace-3.Databáze"/}}3. Databáze =
70
71 === {{id name="04.Technickéinformace-DatabázeClindata"/}}Databáze Clindata ===
72
73 Databáze používaná pro ukládání dat ze softwaru Clindata je Oracle Database (obvykle označovaná jako Oracle RDBMS), kterou vyvíjí společnost Oracle Corporation. Verze databáze je 12.1. Standard Edition.
74
75 Oracle databáze běží na odděleném serveru založeném na Linuxu, který je chráněn firewallem před vnější sítí (Internetem). Tento databázový server není přístupný zvenčí organizace, ale pouze ze zapsaných vnitřních serverů (aplikační a záložní servery).
76
77 = {{id name="04.Technickéinformace-4.Zálohy"/}}4. Zálohy =
78
79 Existují více úrovní archivace dat, které zajišťují bezpečnost dat a rychlé obnovení databáze. Data jsou archivována na úrovni databáze a operačního systému.
80
81 1. Zálohy na úrovni databáze
82 Nástroj **RMAN** je nedílnou součástí Oracle databáze. Vytváří binární kopii celé databáze a ukládá ji do souborového systému. Nástroj RMAN je spuštěn každý týden. Soubory jsou uloženy interně na serveru databáze a jsou zkopírovány na dvě nezávislá záložní místa.
83 **EXPDP/IMPDP** je datová pumpa, která exportuje data do textových záloh. Nástroj EXPDP je spuštěn každé 4 hodiny. Cílem zálohování je stejné jako u RMAN. Data jsou uložena na dvou nezávislých záložních místech.
84 **Redo Logy** jsou každý den archivovány do souborového systému.
85 1. Zálohy na úrovni operačního systému
86 **IBM Tivoli Storage Manager** (TSM Admin) je firemní řešení od společnosti IBM pro zálohy a obnovu fyzických nebo virtuálních serverů. Záloha vytvořená pomocí TSM Admin zahrnuje redo logy, RMAN a EXPDP exporty. Spouští se každý den a záložní data jsou uložena na diskovém poli.
87
88 RMAN konfigurační soubor
89
90 CONFIGURE RETENTION POLICY TO REDUNDANCY 1; # default
91 CONFIGURE BACKUP OPTIMIZATION OFF; # default
92 CONFIGURE DEFAULT DEVICE TYPE TO DISK; # default
93 CONFIGURE CONTROLFILE AUTOBACKUP ON;
94 CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE DISK TO '%F'; # default
95 CONFIGURE DEVICE TYPE DISK PARALLELISM 1 BACKUP TYPE TO BACKUPSET; # default
96 CONFIGURE DATAFILE BACKUP COPIES FOR DEVICE TYPE DISK TO 1; # default
97 CONFIGURE ARCHIVELOG BACKUP COPIES FOR DEVICE TYPE DISK TO 1; # default
98 CONFIGURE MAXSETSIZE TO UNLIMITED; # default
99 CONFIGURE ENCRYPTION ALGORITHM 'AES128'; # default
100 CONFIGURE COMPRESSION ALGORITHM 'BASIC' AS OF RELEASE 'DEFAULT' OPTIMIZE FOR LOAD TRUE ; # default
101 CONFIGURE RMAN OUTPUT TO KEEP FOR 7 DAYS; # default
102 CONFIGURE ARCHIVELOG DELETION POLICY TO NONE; # default
103 CONFIGURE SNAPSHOT CONTROLFILE NAME TO '/../../oracle/12c/dbs/snapcf_imtm.f'; # default
104
105 EXPDP configuration file
106
107 DIRECTORY=dtpump
108 DUMPFILE=registry.dmp
109 LOGFILE=registry.log
110 CONTENT=ALL
111 COMPRESSION=NONE
112 JOB_NAME=registry_migration
113 SCHEMAS=registry,registry_aud
114
115 = {{id name="04.Technickéinformace-05.Bezpečnostpřipojení"/}}05. Bezpečnost připojení =
116
117 === {{id name="04.Technickéinformace-Zabezpečenépřipojení"/}}Zabezpečené připojení ===
118
119 Jelikož aplikace Clindata je webová aplikace, je nezbytné zajistit zabezpečenou komunikaci mezi serverem a klientovým počítačem. To je dosaženo pomocí komunikačního protokolu HTTPS, který je šifrován pomocí protokolu Transport Layer Security (TLS). Tento protokol je široce používán pro veškeré bezpečné transakce na internetu (platby, e-maily atd.) a je považován za bezpečný a nedekódovatelný. Chrání proti útokům prostředníka. Komunikace bez bezpečnostní vrstvy (HTTP) může být narušena útočníky, kteří ji mohou odposlouchávat nebo měnit.
120
121 === {{id name="04.Technickéinformace-Přesměrovánízabezpečení"/}}Přesměrování zabezpečení ===
122
123 Všechny požadavky uživatele přicházející prostřednictvím nezabezpečeného protokolu HTTP jsou automaticky přesměrovány na zabezpečený protokol HTTPS. Veškerá komunikace mezi klientem a serverem je zabezpečena a není možné se připojit k softwaru Clindata prostřednictvím nezabezpečeného spojení.
124
125 === {{id name="04.Technickéinformace-Certifikát"/}}Certifikát ===
126
127 Pro zabezpečenou komunikaci je vyžadován certifikát uložený na webovém serveru. Certifikát musí být podepsán důvěryhodnou certifikační autoritou. Server Clindata používá certifikát, který je digitálně podepsán autoritou TERENA.
128
129 = {{id name="04.Technickéinformace-06.Autenzizaceaautorizace"/}}06. Autenzizace a autorizace =
130
131 === {{id name="04.Technickéinformace-Správauživatelů"/}}Správa uživatelů ===
132
133 Všichni uživatelé používající aplikaci Clindata musí být registrováni před přihlášením. Není možné získat neoprávněný přístup k serveru ani pro demonstrační účely. Existuje specializovaná aplikace pro správu uživatelů - nástroj IMTM Admin.
134
135 Nástroj Admin je zodpovědný za:
136
137 * Správu institucí, společností, nemocnic a jejich oddělení. Může existovat neomezený počet úrovní organizací, například univerzita může mít strukturu univerzita-fakulta-oddělení-laboratoř. Každá úroveň organizace může získat odlišnou sadu oprávnění a rolí. Správa uživatelů. Každý uživatel je identifikován e-mailovou adresou jako přihlašovacím jménem a heslem.
138 * Uživatelé jsou přiřazeni ke svým organizacím. Uživatelé mohou pracovat na více projektech s různými rolemi. To je umožněno pomocí uživatelských profilů. Počet profilů pro jednoho uživatele není omezen. Každý profil může mít odlišnou sadu oprávnění a rolí.
139 * Správa rolí a profilů.
140
141 Databáze Admin s uživatelskými údaji je uložena v Oracle databázi jako samostatné schéma. Přístup k tomuto schématu je omezen pouze pro správce. Server s Oracle databází je oddělen firewallem od veřejné sítě a není přístupný z internetu.
142
143 Nový účet uživatele může být vytvořen pouze administrátorem. Uživatel nemá možnost vytvořit si účet sám.
144
145 Následující kroky musí být dodrženy při vytváření nového účtu:
146
147 * Nový uživatel požádá vlastníka projektu o vytvoření nového účtu.
148 * Vlastník projektu požádá administrátora o vytvoření nového účtu s určenými oprávněními a rolími.
149 * Administrátor vytvoří nový účet a nastaví požadovaná oprávnění a role.
150 * Vlastník projektu zkontroluje nastavení účtu a schválí ho.
151 * Nový uživatel obdrží přihlašovací údaje a může se přihlásit.
152
153 === {{id name="04.Technickéinformace-Centrálníautentizačníslužba(CAS)"/}}Centrální autentizační služba (CAS) ===
154
155 Aplikace Clindata musí být propojena s daty z IMTM Admin k ovládání účtů, rolí a oprávnění. To se provádí integrací technologie CAS do softwaru ClinData. Technologie CAS se skládá z CAS serveru a CAS klienta. CAS server je zodpovědný za ověřování uživatelů a poskytování přístupu k aplikacím. CAS klienti chrání aplikace CAS a získávají identitu povolených uživatelů ze serveru CAS.
156
157 = {{id name="04.Technickéinformace-07.Roleaoprávnění"/}}07. Role a oprávnění =
158
159 === {{id name="04.Technickéinformace-Omezenípřístupu"/}}Omezení přístupu ===
160
161 Přístup uživatele může být omezen ve dvou různých oblastech:
162
163 * omezení přístupu k funkcionalitě ClinData
164 * omezení přístupu k datům uloženým v softwaru ClinData
165
166 Veškerá omezení jsou nastavena v nástroji IMTM Admin.
167
168 === {{id name="04.Technickéinformace-Omezenífunkcí"/}}Omezení funkcí ===
169
170 === {{id name="04.Technickéinformace-Oprávnění"/}}Oprávnění ===
171
172 Oprávnění k přístupu určují, ke kterým objektům v ClinData může uživatel prohlížet nebo je upravovat. Každá funkcionalita v softwaru ClinData je odrážena v odpovídajícím oprávnění, takže přístup ke všem funkcím je kontrolován. Každý uživatel nebo skupina uživatelů může mít přístup k přiděleným nebo omezeným oprávněním.
173
174 Na obrázku je zobrazeno schéma oprávnění v softwaru ClinData.
175
176 === {{id name="04.Technickéinformace-Role"/}}Role ===
177
178 Role jsou virtuální entity, které slouží jako kontejnery pro více oprávnění.
179
180 Existují předdefinované role a uživatelé nebo skupiny uživatelů mohou být jim přiřazeny. Nejčastěji používané role jsou:
181
182 * admin systému ClinData - plný přístup ke všem funkcím v ClinData, žádná omezení, vytváření nových projektů
183 * projekt admin systému ClinData - plný přístup ke všem funkcím ve vybraném projektu včetně tvorby studií
184 * manažer dat projektu ClinData - přístup ke všem funkcím potřebným pro vkládání nebo aktualizaci dat pacienta
185 * monitor dat projektu ClinData - přístup ke všem funkcím potřebným pro sledování studie, validaci a dokončení CRFs (formuláře pro sběr dat)
186 * prohlížeč dat projektu ClinData - pouze čtení vybraných dat
187
188 === {{id name="04.Technickéinformace-Omezenídat"/}}Omezení dat ===
189
190 Výchozí nastavení pro přístup k datům v softwaru ClinData je maximálně omezené. Uživatel vidí pouze data, která sám vložil. Výchozí nastavení neumožňuje vidět žádná data vložená jiným uživatelem. Přístup k ostatním datům musí být explicitně povolen.
191
192 Tato nastavení lze upravit:
193
194 * uživatel vidí pouze svá data
195 * uživatel vidí data vložená jiným uživatelem nebo skupinou uživatelů
196 * uživatel vidí data spojená s organizací
197 * uživatel vidí všechna data ve studii
198
199 === {{id name="04.Technickéinformace-Osobníúdaje"/}}Osobní údaje ===
200
201 Studie nebo registry mohou obsahovat osobní údaje. Přístup k těmto údajům může být omezen pomocí speciálního oprávnění.
202
203 Tato nastavení lze upravit:
204
205 * uživatel vidí osobní údaje
206 * uživatel nevidí osobní údaje
207
208 = {{id name="04.Technickéinformace-8.Logování"/}}8. Logování =
209
210 Systém ClinData zaznamenává všechny události, které se v systému odehrávají. Administrátor může tyto záznamy procházet v uživatelsky přívětivé formě a analyzovat potenciální problémy, sledovat aktivity uživatelů atd.
211
212 Existují tři různé typy mechanismů pro zaznamenávání událostí:
213
214 * Záznamy softwaru se provádějí na úrovni programovacího jazyka a jsou velmi podrobné. Soubory se záznamy obsahují údaje o vnitřním stavu celého systému v době události. Tento přístup slouží pro podrobnou analýzu problémů, které se v minulosti vyskytly.
215 * Záznamy přístupu jsou určeny k řízení činnosti uživatelů. Záznam o přístupu obsahuje údaje o tom, kdo provedl akci a kdy. Zaznamenává veškeré akce provedené na objektech v systému. Objektem může být studie, pacient, formulář CRF, soubor. Zaznamenávají se následující akce:
216 ** vytvoření
217 ** otevření
218 ** změna
219 ** přidání
220 ** odebrání
221 ** smazání
222 ** export
223 * Audit je zaměřený na změny provedené ve formulářích CRF. Zaznamenává kompletní historii toho, co bylo uživateli změněno. Jeden záznam obsahuje údaje o:
224 ** kdy byla změna provedena
225 ** kdo změnil data
226 ** co bylo změněno
227 ** jaká je nová hodnota
228
229 Důležitou informací je, že systém ClinData neodstraňuje žádné záznamy. Každý záznam v databázi má systémový příznak AKTIVNÍ. Smazání řádku pouze nastaví tento příznak AKTIVNÍ na hodnotu false. Neaktivní řádky se nezobrazují ve softwaru ClinData, ale stále jsou uloženy v databázi.
230
231 = {{id name="04.Technickéinformace-9.Vývojsoftwaru"/}}9. Vývoj softwaru =
232
233 === {{id name="04.Technickéinformace-Sledováníproblémů"/}}Sledování problémů ===
234
235 Jakýkoli problém nalezený ve softwaru ClinData je zdokumentován a vytvořen jako nový problém v softwaru JIRA. JIRA software je vyvíjen společností Atlassian a slouží jako nástroj pro sledování problémů. Nový problém je analyzován a je mu přiřazena priorita. Seznam problémů je řazen podle priorit a zpracováván vývojáři. Pokud je závažný problém opraven, je publikován ve nové verzi softwaru ClinData. Problém je také uzavřen jako vyřešený v JIRA.
236
237 === {{id name="04.Technickéinformace-Správazměn"/}}Správa změn ===
238
239 Všechny požadavky na změny plánované ve softwaru ClinData jsou uloženy v JIRA. Když přichází nový požadavek, je analyzován, provedena časová odhad a přiřazena priorita. Seznam problémů je řazen podle priorit a zpracováván vývojáři.
240
241 === {{id name="04.Technickéinformace-Verzování"/}}Verzování ===
242
243 Zdrojový kód softwaru ClinData je uložen v repozitáři GIT, který umožňuje sledování změn v souborech. Je možné procházet historii libovolného souboru se zdrojovým kódem v repozitáři. Každá změna je také zdokumentována, aby bylo snadné pochopit vývojový cyklus.
244
245 === {{id name="04.Technickéinformace-Revizekódu"/}}Revize kódu ===
246
247 Jakákoliv změna provedená ve zdrojovém kódu softwaru ClinData musí být zkontrolována jiným vývojářem. Tento proces se nazývá revize kódu. Tento proces minimalizuje počet chyb ve zdrojovém kódu, protože vše je dvojnásobně zkontrolováno. Pro revize kódu se používá software Bitbucket (vyvinutý společností Atlassian). Tento software brání vývojářům v používání neprokázaného kódu ve veřejných verzích softwaru ClinData.
248
249 = {{id name="04.Technickéinformace-10.Zajišteníkvality"/}}10. Zajištení kvality =
250
251 === {{id name="04.Technickéinformace-Testovacíprostředí"/}}Testovací prostředí ===
252
253 Všechny nové verze softwaru ClinData musí být otestovány a ověřeny jako funkční a správné před jejich zveřejněním. Existuje zvláštní prostředí, které se používá k testování nové verze před jejím zveřejněním. Testovací prostředí musí být podobné produkčnímu prostředí, aby se předešlo problémům s konfigurací.
254
255 === {{id name="04.Technickéinformace-Unittestování"/}}Unit testování ===
256
257 Unit testování je metoda testování softwaru, při které jsou testovány jednotlivé části zdrojového kódu, aby se zjistilo, zda jsou vhodné k použití. Ve zdrojovém kódu softwaru ClinData existuje více než tisíc unit testů. Všechny kritické části zdrojového kódu jsou pokryty unit testem téměř na 100 %. Celkový zdrojový kód je pokryt unit testem více než 85 %. Jakýkoli problém v unit testování je blokující pro zveřejnění verze softwaru.
258
259 === {{id name="04.Technickéinformace-Testováníaplikace"/}}Testování aplikace ===
260
261 Celá aplikace je testována prostřednictvím průzkumného testování aplikace před jejím zveřejněním. Testování aplikace se provádí v testovacím prostředí. Jakýkoli problém při testování aplikace je blokující pro zveřejnění verze.
262
263 === {{id name="04.Technickéinformace-Zveřejnění"/}}Zveřejnění ===
264
265 Proces zveřejnění znamená, že nová verze softwaru ClinData je uvolněna a zpřístupněna uživatelům. Pro sestavení a zveřejnění nových verzí se používá software Bamboo (vyvinutý společností Atlassian). Jednotkové testování je také součástí procesu zveřejnění nové verze. V případě jakéhokoli problému v jednotkovém testování je celý proces zveřejnění přerušen a zodpovědným osobám je zasláno oznámení emailem.