Skip to Content

Wiki source code of 04. Technické informace

Version 9.1 by Branislav ŠIŠKA on 2024/09/12 19:14
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 (% style="color: rgb(55,65,81);" %)**Datová úložiště**
14
15 (% style="color: rgb(55,65,81);" %)Objektové úložiště
16
17 **Firewall**
18
19 FortiGate 600E
20
21 **~ **
22
23 = {{id name="04.Technickéinformace-2.Software"/}}2. Software =
24
25 === {{id name="04.Technickéinformace-Požadavkynasoftware"/}}(% style="color: rgb(55,65,81);" %)Požadavky na software(%%) ===
26
27 (% 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čů:
28
29 * Chrome: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
30 * Edge: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
31 * Firefox: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
32 * Internet Explorer: 11+
33 * Safari: ((% style="color: rgb(55,65,81);" %)Aktuální(%%) - 1) a a(% style="color: rgb(55,65,81);" %)ktuální
34 * Opera: (% style="color: rgb(55,65,81);" %)Aktuální
35
36 (% style="color: rgb(55,65,81);" %)(Aktuální znamená poslední dostupná verze daného prohlížeče)
37
38 === {{id name="04.Technickéinformace-Programovacíjazyk"/}}Programovací jazyk ===
39
40 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:
41
42 * Spring Framework v5.
43 * HTML, CSS
44 * JavaScript
45 * jQuery
46 * jQuery UI
47 * Bootstrap
48 * MathJS
49 * Datatables
50 * SQL
51 * Oracle database
52
53 === {{id name="04.Technickéinformace-Operačnísystém"/}}Operační systém ===
54
55 Operační systém nainstalovaný na produkčních serverech je RedHat Enterprise Linux 9.4.
56
57 === {{id name="04.Technickéinformace-Proxyserver"/}}Proxy server ===
58
59 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.
60
61 === {{id name="04.Technickéinformace-Aplikačníserver"/}}Aplikační server ===
62
63 Aplikace ClinData běží na Apache Tomcat, což je open-source Java Servlet Container vyvíjený nadací Apache Software Foundation.
64
65 **~ **
66
67 = {{id name="04.Technickéinformace-3.Databáze"/}}3. Databáze =
68
69 === {{id name="04.Technickéinformace-DatabázeClindata"/}}Databáze Clindata ===
70
71 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.
72
73 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).
74
75 = {{id name="04.Technickéinformace-4.Zálohy"/}}4. Zálohy =
76
77 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.
78
79 1. Zálohy na úrovni databáze
80 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.
81 **EXPDP/IMPDP** je datová pumpa, která exportuje data do textových záloh. Nástroj EXPDP je spuštěn každých 24 hodin. 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.
82 **Redo Logy** jsou každý den archivovány do souborového systému.
83 1. Zálohy na úrovni operačního systému
84 Aplikační server je zálohován na úrovni operačního systému ve virtualizaci **Proxmox**.
85 \\
86
87 RMAN konfigurační soubor
88
89 CONFIGURE RETENTION POLICY TO REDUNDANCY 1; # default
90 CONFIGURE BACKUP OPTIMIZATION OFF; # default
91 CONFIGURE DEFAULT DEVICE TYPE TO DISK; # default
92 CONFIGURE CONTROLFILE AUTOBACKUP ON;
93 CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE DISK TO '%F'; # default
94 CONFIGURE DEVICE TYPE DISK PARALLELISM 1 BACKUP TYPE TO BACKUPSET; # default
95 CONFIGURE DATAFILE BACKUP COPIES FOR DEVICE TYPE DISK TO 1; # default
96 CONFIGURE ARCHIVELOG BACKUP COPIES FOR DEVICE TYPE DISK TO 1; # default
97 CONFIGURE MAXSETSIZE TO UNLIMITED; # default
98 CONFIGURE ENCRYPTION ALGORITHM 'AES128'; # default
99 CONFIGURE COMPRESSION ALGORITHM 'BASIC' AS OF RELEASE 'DEFAULT' OPTIMIZE FOR LOAD TRUE ; # default
100 CONFIGURE RMAN OUTPUT TO KEEP FOR 7 DAYS; # default
101 CONFIGURE ARCHIVELOG DELETION POLICY TO NONE; # default
102 CONFIGURE SNAPSHOT CONTROLFILE NAME TO '/../../oracle/12c/dbs/snapcf_imtm.f'; # default
103
104 EXPDP configuration file
105
106 DIRECTORY=dtpump
107 DUMPFILE=registry.dmp
108 LOGFILE=registry.log
109 CONTENT=ALL
110 COMPRESSION=NONE
111 JOB_NAME=registry_migration
112 SCHEMAS=registry,registry_aud
113
114 = {{id name="04.Technickéinformace-05.Bezpečnostpřipojení"/}}05. Bezpečnost připojení =
115
116 === {{id name="04.Technickéinformace-Zabezpečenépřipojení"/}}Zabezpečené připojení ===
117
118 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.
119
120 === {{id name="04.Technickéinformace-Přesměrovánízabezpečení"/}}Přesměrování zabezpečení ===
121
122 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í.
123
124 === {{id name="04.Technickéinformace-Certifikát"/}}Certifikát ===
125
126 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.
127
128 = {{id name="04.Technickéinformace-06.Autenzizaceaautorizace"/}}06. Autenzizace a autorizace =
129
130 === {{id name="04.Technickéinformace-Správauživatelů"/}}Správa uživatelů ===
131
132 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.
133
134 Nástroj Admin je zodpovědný za:
135
136 * 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.
137 * 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í.
138 * Správa rolí a profilů.
139
140 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.
141
142 Nový účet uživatele může být vytvořen pouze administrátorem. Uživatel nemá možnost vytvořit si účet sám.
143
144 Následující kroky musí být dodrženy při vytváření nového účtu:
145
146 * Nový uživatel požádá vlastníka projektu o vytvoření nového účtu.
147 * Vlastník projektu požádá administrátora o vytvoření nového účtu s určenými oprávněními a rolími.
148 * Administrátor vytvoří nový účet a nastaví požadovaná oprávnění a role.
149 * Vlastník projektu zkontroluje nastavení účtu a schválí ho.
150 * Nový uživatel obdrží přihlašovací údaje a může se přihlásit.
151
152 === {{id name="04.Technickéinformace-Centrálníautentizačníslužba(CAS)"/}}Centrální autentizační služba (CAS) ===
153
154 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.
155
156 = {{id name="04.Technickéinformace-07.Roleaoprávnění"/}}07. Role a oprávnění =
157
158 === {{id name="04.Technickéinformace-Omezenípřístupu"/}}Omezení přístupu ===
159
160 Přístup uživatele může být omezen ve dvou různých oblastech:
161
162 * omezení přístupu k funkcionalitě ClinData
163 * omezení přístupu k datům uloženým v softwaru ClinData
164
165 Veškerá omezení jsou nastavena v nástroji IMTM Admin.
166
167 === {{id name="04.Technickéinformace-Omezenífunkcí"/}}Omezení funkcí ===
168
169 === {{id name="04.Technickéinformace-Oprávnění"/}}Oprávnění ===
170
171 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.
172
173 Na obrázku je zobrazeno schéma oprávnění v softwaru ClinData.
174
175 === {{id name="04.Technickéinformace-Role"/}}Role ===
176
177 Role jsou virtuální entity, které slouží jako kontejnery pro více oprávnění.
178
179 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:
180
181 * admin systému ClinData - plný přístup ke všem funkcím v ClinData, žádná omezení, vytváření nových projektů
182 * projekt admin systému ClinData - plný přístup ke všem funkcím ve vybraném projektu včetně tvorby studií
183 * manažer dat projektu ClinData - přístup ke všem funkcím potřebným pro vkládání nebo aktualizaci dat pacienta
184 * 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)
185 * prohlížeč dat projektu ClinData - pouze čtení vybraných dat
186
187 === {{id name="04.Technickéinformace-Omezenídat"/}}Omezení dat ===
188
189 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.
190
191 Tato nastavení lze upravit:
192
193 * uživatel vidí pouze svá data
194 * uživatel vidí data vložená jiným uživatelem nebo skupinou uživatelů
195 * uživatel vidí data spojená s organizací
196 * uživatel vidí všechna data ve studii
197
198 === {{id name="04.Technickéinformace-Osobníúdaje"/}}Osobní údaje ===
199
200 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í.
201
202 Tato nastavení lze upravit:
203
204 * uživatel vidí osobní údaje
205 * uživatel nevidí osobní údaje
206
207 = {{id name="04.Technickéinformace-8.Logování"/}}8. Logování =
208
209 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.
210
211 Existují tři různé typy mechanismů pro zaznamenávání událostí:
212
213 * 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.
214 * 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:
215 ** vytvoření
216 ** otevření
217 ** změna
218 ** přidání
219 ** odebrání
220 ** smazání
221 ** export
222 * 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:
223 ** kdy byla změna provedena
224 ** kdo změnil data
225 ** co bylo změněno
226 ** jaká je nová hodnota
227
228 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.
229
230 = {{id name="04.Technickéinformace-9.Vývojsoftwaru"/}}9. Vývoj softwaru =
231
232 === {{id name="04.Technickéinformace-Sledováníproblémů"/}}Sledování problémů ===
233
234 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.
235
236 === {{id name="04.Technickéinformace-Správazměn"/}}Správa změn ===
237
238 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.
239
240 === {{id name="04.Technickéinformace-Verzování"/}}Verzování ===
241
242 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.
243
244 === {{id name="04.Technickéinformace-Revizekódu"/}}Revize kódu ===
245
246 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.
247
248 = {{id name="04.Technickéinformace-10.Zajišteníkvality"/}}10. Zajištení kvality =
249
250 === {{id name="04.Technickéinformace-Testovacíprostředí"/}}Testovací prostředí ===
251
252 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í.
253
254 === {{id name="04.Technickéinformace-Unittestování"/}}Unit testování ===
255
256 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.
257
258 === {{id name="04.Technickéinformace-Testováníaplikace"/}}Testování aplikace ===
259
260 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.
261
262 === {{id name="04.Technickéinformace-Zveřejnění"/}}Zveřejnění ===
263
264 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.