u Kapra
Osobná stránka Petra BohunskéhoVítam vás na mojej stránke
Táto špecifikácia požiadaviek na softvér (ďalej ŠPS) popisuje používateľské, funkčné a parametrické požiadavky prvej verzie systému inteligentného archívu odborných publikácií. Špecifikácia je súčasťou zmluvy medzi objednávateľom a dodávateľom. Bude slúžiť ako východisko pre vyhodnocovanie správnosti softvéru.
Systém bude prostredníctvom webového rozhrania sprostredkovávať archív odborných publikácií. Úlohou systému bude umožniť používateľom pohodlné vyhľadávanie medzi odbornými publikáciami a nahrávanie nových publikácií. Systém by mal umožniť taktiež vytváranie zoznamov publikácií pre každého používateľa osobitne pre opätovné prezeranie (napríklad za účelom vytvorenia rešerše).
|
|
Portable Document Format – súborový formát používaný na ukladanie dokumentov. |
|
Apache |
Softwarový webový server. |
|
Fulltextové vyhľadávanie |
Technika hľadania, pri ktorej sú preskúmavané všetky slová v každom prehľadávanom dokumente. |
Kontextový diagram poskytuje pohľad na okolie systému. So systémom pracuje užívateľ, ktorý vyhľadáva alebo pridáva publikácie do systému. Systém komunikuje s databázou kde vyhľadáva poprípade pridáva záznamy o publikácií. Publikácie sú uložené v úložisku dát. Konvertor premieňa publikáciu vo formáte nezrozumiteľnom pre systém do textovej podoby bez formátovania (kvôli indexácii).
Obrázok 1: kontext systému
|
SR-1 |
Rozhranie k databáze. |
|
SR-1.1 |
Systém vyhľadáva v databáze referencie na súbory a informácie o nich. |
|
SR-1.2 |
Systém pridáva do databázy informácie a referencie k súborom. |
|
SR-2 |
Rozhranie k úložisku dát. |
|
SR-2.1 |
Načítavanie súborov publikácií. |
|
SR-2.2 |
Ukladanie súborov publikácií. |
|
SR-3 |
Rozhranie ku konvertoru slúži na konverziu nezrozumiteľného formátu na zrozumiteľnú pre systém. |
|
PR-1 |
Používateľské rozhranie musí byť formou webovej aplikácie. |
Systém neobsahuje žiadne hardvérové rozhrania
|
SSR-1 |
Systém by mal byť spustiteľný na linuxovom serveri s nainštalovaným Apache. Server by mal podporovať spúšťanie php skriptov vo verzií 5. |
|
SSR-2 |
Na serveri by mala byť dostupná aplikácia XPDF. |
|
SSR-3 |
Používateľské rozhranie musí korektne fungovať v prehliadačoch Internet Explorer 8, Firefox 10, Opera 10 a Google Chrome 17. |
Prehľad funkcií, ktoré systém poskytuje je znázornený diagramom prípadov použitia na Obrázku 2.
Obrázok 2: Diagram prípadov použitia
| Trieda | Popis |
|---|---|
| Administrátor | Je špeciálny používateľ, ktorý je vytvorený počas inštalácie alebo už existujúcim administrátorom. V systéme môže byť viacero administrátorov s rôznymi prihlasovacími údajmi. Administrátor |
| Člen | Je používateľ s vytvoreným kontom, ktoré mu bolo vytvorené administrátorom. Pre prístup na systém potrebuje meno a heslo |
| Hosť | Je špeciálny používateľ, vytvorený administrátorom, ktorý nemá vlastné konto. Má však prístup ku všetkým publikáciám rovnako ako člen. Táto trieda používateľa vyžaduje pre prístup tiež meno a heslo. |
|
Označenie: |
UC01 |
Názov: |
Vyhľadávanie publikácií |
Priorita: |
vysoká |
|
|---|---|---|---|---|---|---|
|
Popis: |
Používateľ si vyhľadá potrebné publikácie podľa zvolených vyhľadávacích kritérií. Výsledkom je zoznam publikácií vyhovujúcich zadaným vyhľadávacím kritériám (viď Prílohu Dátový slovník). |
|||||
|
Vstupné podmienky: |
Používateľ je prihlásený |
|||||
|
Výstupné podmienky: |
- |
|||||
|
Opakovanosť |
Stokrát do dňa |
|||||
|
|
Krok |
Činnosť |
||||
|
Bežná cesta |
0.1 |
Používateľ vyberie možnosť vyhľadávania publikácií. |
||||
|
|
0.2 |
Systém požaduje zadanie vyhľadávacích kritérií. |
||||
|
|
0.3 |
Používateľ zadá kritéria. |
||||
|
|
0.4 |
Systém zobrazí publikácie vyhovujúce kritériám. |
||||
|
|
0.5 |
Užívateľ si môže prezerať nájdené publikácie a následne ich aj stiahnuť poprípade vložiť do zoznamu publikácií. |
||||
|
Alternatívna cesta |
1.1 |
(po kroku 0.4) Používateľ nastaví, podľa čoho majú byť zoradené nájdené publikácie. |
||||
|
|
1.2 |
Systém aktualizuje zoznam nájdených publikácií. |
||||
|
Výnimky |
|
Nie je žiadna |
||||
|
Označenie |
Popis |
|---|---|
|
vyhľadanie.kritériá.viacSlov |
V prípade viacerých slov v jednom poli kritérií sa bude vstup deliť po slovách. |
|
vyhľadanie.výsledok.prázdny |
V prípade prázdneho zoznamu nájdených publikácií, oznámi systém používateľovi, že sa nenašli publikácie vyhovujúce jeho požiadavkám. |
|
vyhľadanie.výsledok.usporiadaj |
Zoznam bude zoradený podľa používateľových nastavení. |
|
vyhľadanie.výsledok.stránkuj |
Zoznam bude stránkovaný po počte záznamov zvoleným používateľom. |
|
Označenie: |
UC02 |
Názov: |
Pridávanie publikácií |
Priorita: |
vysoká |
|
|---|---|---|---|---|---|---|
|
Popis: |
Používateľ si môže pridať publikácie do systému. Bude im môcť nastaviť, či sú dostupné pre všetkých používateľov alebo len pre neho. Pre lepšie vyhľadávanie bude môcť pridať doplňujúce informácie (viď Prílohu Dátový slovník). |
|||||
|
Vstupné podmienky: |
Používateľ je prihlásený, používateľ je člen alebo administrátor |
|||||
|
Výstupné podmienky: |
- |
|||||
|
Opakovanosť |
jedenkrát do dňa |
|||||
|
|
Krok |
Činnosť |
||||
|
Bežná cesta |
0.1 |
Používateľ vyberie možnosť pridávania publikácií. |
||||
|
|
0.2 |
Systém požaduje načítanie súboru publikácie |
||||
|
|
0.3 |
Používateľ nahrá súbor do systému |
||||
|
|
0.4 |
Systém prekóduje obsah súboru do potrebnej podoby a uloží do databázy spolu s indexom pre rýchle vyhľadávanie. |
||||
|
|
0.5 |
Systém požiada používateľa o doplňujúce informácie k publikácií |
||||
|
Alternatívna cesta |
V1.1 |
Systém nedokáže rozpoznať text v dokumente (napríklad je dokument skenovaný). |
||||
|
|
V1.2a |
Systém požiada užívateľa o zadanie kompletného textu dokumentu. |
||||
|
|
V1.3a |
Systém text spracuje ako keby bol získaný zo súboru a pokračuje bodom 0.4. |
||||
|
|
V1.2b |
Používateľ nenahrá text, systém pokračuje bodom 0.5. Tento dokument nie je možné hľadať podľa obsahu. |
||||
|
Výnimky |
|
Nie je žiadna |
||||
|
Označenie |
Popis |
|---|---|
|
pridajie.dostupnosť |
Nastavenie, či je publikácia dostupná pre všetkých alebo len pre vlastníka. |
|
pridanie.kontrolaRovnakých |
Rovnaké súbory sa budú kontrolovať, či nie sú totožne s iným súborom na serveri. Kvôli šetreniu miesta bude nechávaná na serveri len jedna kópia súboru. Pre používateľov sa bude publikácia tváriť, akoby bola pridaná dvomi používateľmi. |
|
Označenie: |
UC03 |
Názov: |
Spravovanie publikácií |
Priorita: |
vysoká |
|
|---|---|---|---|---|---|---|
|
Popis: |
Používateľ si bude môcť upravovať údaje o publikácií pridanej ním samým. Administrátor môže upravovať všetky publikácie dostupné pre všetkých. Môže taktiež publikáciu odstrániť zo systému alebo nastaviť, či bude viditeľná aj pre iných používateľov. Pri odstránení administrátorom sa publikácia zmení na nedostupnú pre všetkých. |
|||||
|
Vstupné podmienky: |
Používateľ je prihlásený, používateľ je člen poprípade administrátor |
|||||
|
Výstupné podmienky: |
- |
|||||
|
Opakovanosť |
jedenkrát do dňa |
|||||
|
|
Krok |
Činnosť |
||||
|
Bežná cesta |
0.1 |
Používateľ vyberie možnosť správy publikácií. |
||||
|
|
0.2 |
Systém požaduje vybratie požadovanej publikácie. |
||||
|
|
0.3 |
Používateľ vyberie požadovanú publikáciu. |
||||
|
|
0.4 |
Systém mu ponúkne upraviť doplňujúce informácie o publikácií alebo vymazať publikáciu zo systému. |
||||
|
|
0.5 |
Užívateľ upraví informácie a potvrdí zmenu. |
||||
|
|
0.6 |
Systém zmeny vykoná v databáze. |
||||
|
Alternatívna cesta |
V1.1 |
(po kroku 0.4) Používateľ vyberie možnosť vymazať. |
||||
|
|
V1.2a |
Systém vymaže publikáciu z databázy aj z úložiska dát. |
||||
|
|
V1.2b |
Ak systém zistí, že rovnaký súbor už existuje u iného užívateľa, vymaže len záznam z databázy o tomto používateľovi ako vlastníkovi publikácie. |
||||
|
Výnimky |
|
Nie je žiadna |
||||
|
Označenie |
Popis |
|---|---|
|
správaPublikácií.mazanie |
Zachovať konzistentný stav databázy aj po odstránení indexov na publikáciu. |
|
Označenie: |
UC04 |
Názov: |
Vytváranie, spravovanie a prezeranie zoznamov publikácií |
Priorita: |
stredná |
|
|---|---|---|---|---|---|---|
|
Popis: |
Používateľ si bude môcť vytvárať zoznamy publikácií pre opätovné prezretie. Keďže budú tieto zoznamy určené prevažne pre vytváranie rešerší, bude umožnené aj zobrazenie základných údajov o publikáciách v textovej podobe pre jednotlivé zoznamy. |
|||||
|
Vstupné podmienky: |
Používateľ je prihlásený, používateľ je člen |
|||||
|
Výstupné podmienky: |
- |
|||||
|
Opakovanosť |
desaťkrát do dňa |
|||||
|
|
Krok |
Činnosť |
||||
|
Bežná cesta |
0.1 |
Používateľ vyberie možnosť správy zoznamov publikácií |
||||
|
|
0.2 |
Systém požaduje vytvorenie nového zoznamu, odstránenie alebo správu existujúcich. |
||||
|
|
0.3 |
Používateľ vyberie existujúci zoznam. |
||||
|
|
0.4 |
Systém mu ponúkne prehľad celého zoznamu. Používateľ môže prezerať publikácie (ako pri vyhľadávaní) alebo ich odstraňovať. |
||||
|
|
0.5 |
Používateľ vyberie možnosť odstrániť publikáciu zo zoznamu. |
||||
|
|
0.6 |
Systém odstráni publikáciu v databáze zo zoznamu. |
||||
|
Alternatívna cesta |
V1.1 |
(po kroku 0.2) Používateľ vytvorí nový zoznam. |
||||
|
|
V1.2 |
Systém vytvorí prázdny zoznam v databáze. Prípad použitia pokračuje v bode 0.2. |
||||
|
|
V2.1 |
(po kroku 0.2) Používateľ vymaže existujúci zoznam. |
||||
|
|
V2.2 |
Systém vymaže zoznam v databáze. Prípad použitia pokračuje v bode 0.2. |
||||
|
|
V2.2 |
Systém vymaže zoznam v databáze. |
||||
|
Výnimky |
|
Nie je žiadna |
||||
|
Označenie |
Popis |
|---|---|
|
zoznamPublikácií.export |
Export bude výpis textu, kde budú uvedené informácie o publikáciách podľa zvoleného formátu. |
|
Označenie: |
UC05 |
Názov: |
Spravovanie užívateľov |
Priorita: |
vysoká |
|
|---|---|---|---|---|---|---|
|
Popis: |
Používateľ bude môcť vytvárať nových používateľov, odstraňovať ich a generovať im nové heslá pri zabudnutí. |
|||||
|
Vstupné podmienky: |
Používateľ je prihlásený, používateľ je administrátor |
|||||
|
Výstupné podmienky: |
- |
|||||
|
Opakovanosť |
jedenkrát do dňa |
|||||
|
|
Krok |
Činnosť |
||||
|
Bežná cesta |
V0.1 |
Používateľ vyberie možnosť správy užívateľov. |
||||
|
|
V0.2 |
Systém dá na výber možnosť pridať užívateľa, odstrániť užívateľa a generovanie nového hesla. |
||||
|
|
V0.3 |
Používateľ vyberie možnosť pridať nového používateľa |
||||
|
|
V0.3 |
Systém ponúkne nastavenie informácií o používateľovi (výber triedy používateľa, prihlasovacie meno, heslo a e-mail). |
||||
|
|
V0.3 |
Systém vytvorí v databáze nového používateľa. |
||||
|
Alternatívna cesta |
V1.1 |
(po kroku 0.2) Používateľ vyberie možnosť odstrániť používateľa. |
||||
|
|
V1.2 |
Systém označí v databáze používateľa ako odstráneného a používateľ sa už nebude môcť prihlásiť. |
||||
|
|
V2.1 |
(po kroku 0.2) Používateľ vyberie možnosť vygenerovanie nového hesla. |
||||
|
|
V2.2 |
Systém vygeneruje v systéme dočasné heslo na jedno prihlásenie sa do systému, ktoré umožní si nastaviť heslo. |
||||
|
Výnimky |
|
Nie je žiadna |
||||
|
Označenie |
Popis |
|
spravovanieUžívateľov.odstránenie |
Odstrániť nebude možné samého seba. |
|
spravovanieUžívateľov.dočasnéHeslo |
Heslo bude odoslané v podobe hypertextového odkazu formou e-mailu. |
|
VP-1 |
Plno-textové vyhľadávanie by malo prebiehať za bežnej prevádzky do 10 sekúnd. |
|
VP-2 |
Vyhľadávanie podľa atribútov by malo prebiehať za bežnej prevádzky do 2 sekúnd. |
|
BP-1 |
Súbory obsahujúce publikácie by mali byť prístupne len pre prihlásených používateľov. |
|
BP-2 |
Používateľ hosť bude mať povolený prístup len z prednastaveného rozsahu ip adries. |
|
Vyhľadávacie kritéria= |
Celý text publikácie (fulltextovo) +Autor publikácie +Názov článku +Názov a číslo žurnálu +Rok vydania +Prvá a posledná strana +Číslo článku +DOI (Digital Object Identifier) +Skratka názvu žurnálu +Abstrakt (fulltextovo) +Kategória |
|
Doplňujúce informácie |
Autor publikácie Názov článku Názov a číslo žurnálu Rok vydania Prvá a posledná strana Číslo článku DOI (Digital Object Identifier) Skratka názvu žurnálu Abstrakt Kategória |
Tu si môžete voľne stiahnuť špecifikáciu vo formáte pdf: specifikacia.pdf (652kB)