PŘÍRUČKA UŽIVATELE Připraveno společností Neit Consulting, s.r.o. Datum poslední aktualizace: 6. 4. 2017 Verze: 2.0
Obsah A. Předmluva... 3 A.1. Slovníček pojmů... 3 B. Profil uživatele... 5 C. Nahrávání souborů... 6 D. Běžící procesy... 7 E. Soubory... 9 E.1. Úprava tagů... 11 F. Vyhledávání... 12 F.1. Vyhledávání podle Podrobnosti o souboru... 12 F.2. Vyhledávání pomocí tagů... 12 F.3. Vyhledávání podle indexu... 13 F.4. Vyhledané soubory... 15 G. Výsledky filtrování... 17 G.1. Prohlížeč pro zvolený filtr... 17 H. Oblíbené soubory... 19, Washingtonova 1624/5, 110 00 Praha 1 Strana 2
A. Předmluva Příručka slouží jako návod pro práci ve webovém rozhraní CloudStorage a je určena pro standartního uživatele, který není přidělen do žádných administrativních rolí, které jsou předmětem jiné příručky. Naleznete zde postupy jak vyhledávat, filtrovat, nahrávat, stahovat a mazat soubory, nebo jak lze spravovat tagy nad přidělenými definicemi typu souboru (FTD). Dále vás naučí jak spravovat výsledky filtrování, nebo jak sledovat své běžící procesy, jako například nahrávání či stahování dat. Obrázek 1: CloudStorage menu A.1. Slovníček pojmů Slovníček pojmů FTD File Type Definition neboli Definice typu souboru. Tato zkratka vás bude provázet po celou dobu práce se soubory v CloudStorage. FTD popisuje každou jednu skupinu dat definovanou FTD Administrátorem. Pomocí těchto definic jsou do systému nahrávána všechna data. Každý nahraný soubor musí mít přiřazeno FTD, nejde aby v systému existoval soubor, který by nespadal do žádného FTD. FTD obsahuje název,, Washingtonova 1624/5, 110 00 Praha 1 Strana 3
výčet přípon, které mohou být do FTD archivována, způsob indexace archivovaných dat dle přípony, povolené IP adresy klientských stanic pro dané FTD, do kterého úložiště mají být data archivována, výčet TAGů povolených pro dané FTD, atd. Skupiny Oprávnění k FTD TAG Indexace Pro použití výše zmíněných FTD je nutností, aby byla uživateli přidělena skupina, ve které se požadované FTD nachází. V této skupině je dále možné specifikovat, jaké oprávnění nad jednotlivými FTD bude uživatel mít. Skupina obsahuje libovolný počet FTD, kterým jsou přidělená v rámci této skupiny oprávnění. Např. pokud uživatel u daného FTD má oprávnění Stahovat, Nahrávat a chybí mu Odstranit, tak jednotlivé soubory mohou pouze stahovat a nahrávat, avšak odstranit soubory už nemohou. Každé FTD může mít oprávnění Vyhledávat, Filtrovat, Stahovat, Nahrávat, Reindexovat, Upravovat tagy, Odstranit. Tagy a jejich definice slouží k filtrování souborů při vyhledávání. Každé FTD má definované tagy, které v rámci daného FTD lze použít pro soubory které do něj patří. Tagům lze nastavit hodnota, pomocí které budou soubory vyhledatelné. Hodnotu tagu lze pak zpětně na každém souboru měnit. Pokud mají tagy specifikovaný regulární výraz nebo datový typ, hodnota jim musí odpovídat. Pokud je tag povinný a nemá nastavenou hodnotu, nelze daný soubor nahrát. Indexace umožňuje uživateli vyhledávat v obsahu souborů. Tedy dává možnost filtrovat soubory podle jejich obsahu. Indexovat se soubor může již při nahrávání, dá se však zaindexovat i zpětně, pokud to FTD dovoluje. Ne každý soubor lze indexovat. Pro různé typy souborů lze nastavit různé způsoby indexace. Např. u souborů CSV se může indexovat celý soubor dohromady, nebo každá řádka zvlášť. Zatím co u PDF se indexuje jen textový obsah celého souboru dohromady., Washingtonova 1624/5, 110 00 Praha 1 Strana 4
B. Profil uživatele Každý uživatel má svůj profil. K jeho nastavení se dostane kliknutím v hlavním menu na položku pod oddělovačem Uživatelé, které odpovídá jeho Jméno Příjmení (v našem případě Ondřej Novák). Uživatelské jméno je neměnné, zbarvené šedou barvou a další položky, které již měnit smí. Jedná se o jméno, příjmení mail, počet zobrazovaných řádků, možnost výběru jazyka, možnost změnit heslo atd. Ve spodní části jsou zobrazeny administrátorem přidělené skupiny, obsahující určitá FTD. Jednotlivé FTD nemohou být uživateli přiděleny jinak, než přes skupinu ve které se nachází. Každá skupina může obsahovat libovolný počet FTD, která mají přidělena určitá oprávnění. Jedná se o oprávnění Vyhledávat, Filtrovat, Stahovat, Nahrávat, Reindexovat, Upravovat tagy, Odstranit. Dále je zde uvedeno, zda je uživatel vedoucím skupiny. Pokud ano, vidí nad přiřazenými FTD skupiny všechny operace ostatních uživatelů, kteří mají danou skupinu přidělenou. Skupiny a další oprávnění uživateli přiděluje Správce uživatelských účtů (USER Administrátor). Po zaškrtnutí políčka Posílat mail při dokončení procesu, vám na výše zadaný mail budou chodit oznámení o dokončení vašich procesů. Obrázek 2: Profil uživatele, Washingtonova 1624/5, 110 00 Praha 1 Strana 5
C. Nahrávání souborů Má-li profil uživatele alespoň u jednoho FTD oprávnění Nahrávat může do něj přidávat nové soubory přes grafické rozhraní. 1) V hlavním menu klikněte na položku Nahrát soubory 2) Vyberte FTD, podle kterého se budou soubory nahrávat na server. 3) Zobrazí se seznam tagů, přidělených pro vybrané FTD. Jsou zde vidět Identifikátory tagů, jejich regulární výrazy, popis, a zda jsou povinné. U povinných tagů musí být nastavena hodnota, jinak se nepodaří soubory odeslat na server. V případě, že některý tag má specifikovaný regulární výraz, tak zadaná hodnota uživatelem musí být dle tohoto výrazu validní. Zadané tagy budou sloužit k budoucímu vyhledávání. Pro přidání a nahrání souborů musejí být všechny povinné tagy vyplněné a případně odpovídat regulárním výrazům, pokud jsou definovány. 4) Dále vyberte patřičné soubory, které chcete nahrát na server. Tlačítko Vyberte soubory 5) Pro nahrání na server stačí stisknout tlačítko Nahrát 6) Pro kompletní nahrání souborů na server je důležité nechat všechny soubory nahrát před odchodem z této stránky. V opačném případě, soubory, u nichž nebylo dokončeno zpracování při odchodu ze stránky, nebudou zpracovány! Obrázek 3: Nahrát soubory Další ovládací prvek je zde tlačítko Zrušit, které slouží k odebrání všech vybraných souborů, poté můžete začít vybírat znova. Popřípadě tlačítka s křížkem na konci řádky s názvem souboru odebírají ze seznamu jednotlivé soubory., Washingtonova 1624/5, 110 00 Praha 1 Strana 6
D. Běžící procesy Záložka Běžící procesy umožňuje sledovat a kontrolovat všechny běžící operace. Je zde vidět ID, název souboru, typ operace, velikost daného souboru a jeho procentuální průběh. Mezi typy operace patří komprese, nahrávání, indexování a mazání. Při neúspěšném procesu, se zobrazí příčina. Neúspěšné procesy inicializované vaším uživatelským účtem mohou být spuštěny znovu. Obrázek 4: Běžící procesy V tabulce jsou vypsány jednotlivé chybové hlášky u procesů, které mohou nastat. Jsou zde též vypsány příčiny a rady, jak se s danou chybou vypořádat. Chybové hlášky procesů Databáze je nedostupná Není spuštěná databáze, kontaktujte Systémového Administrátora. Chyba souborového systému Nesprávné přihlašovací údaje k úložišti Chyba kontrolního součtu Index je nedostupný Chyba při komunikaci s indexem Nelze se spojit s úložištěm Nejde číst nebo zapisovat do složky určené pro dočasné soubory. Kontaktujte Systémového Administrátora. Jsou špatně nastaveny přihlašovací údaje k úložišti, na které se uživatel snaží připojit. Kontaktujte Systémového Administrátora. Při manipulaci se souborem, byl vrácen jiný kontrolní součet. Restartujte proces, a pokud chyba přetrvá, kontaktujte Systémového Administrátora. Index do 10s neodpověděl, kontaktujte Systémového Administrátora. Vyskytl se problém na straně indexu, kontaktujte Systémového Administrátora. Mohl se vyskytnout problém na straně úložiště., Washingtonova 1624/5, 110 00 Praha 1 Strana 7
Vyskytl se problém s připojením na straně serveru, nebo s připojením na straně úložiště. Pokud problém potrvá déle jak 30 minut, kontaktujte Systémového Administrátora. Index má málo paměti Nespecifikovaná chyba Nečekaná chyba při filtraci Modifikace indexu selhala Index má nedostatek operační paměti, kontaktujte Systémového Administrátora. Kontaktujte Systémového Administrátora. Jedná se o nespecifikovanou chybu při filtraci souboru. Nastala chyba při vytváření či mazání indexu, kontaktujte Systémového Administrátora., Washingtonova 1624/5, 110 00 Praha 1 Strana 8
E. Soubory V panelu soubory uživatel uvidí všechny sobory, k jejichž FTD má přístup. Jiné soubory mu nebude umožněno vidět. Soubory zde může řadit či filtrovat podle jejich ID, názvu, velikosti, existence dočasné kopie, data nahrání, názvu FTD a stavu souboru. Každý soubor má v prvním sloupci šipku, po jejímž rozkliknutí se zobrazí jednotlivé tagy nad vybraným souborem. Aby uživatel mohl vykonávat některé níže popsané akce, tak musí mít administrátorem přidělena potřebná oprávnění. Oprávnění se nastavují pro každé FTD zvlášť, je tedy možné, aby měl uživatel v každém FTD jiná oprávnění. Možná oprávnění: Vyhledávat, Filtrovat, Stahovat, Nahrávat, Reindexovat, Upravovat tagy, Odstranit Možné stavy souboru Čeká na nahrání Nahrává se na úložiště Uloženo pouze na úložišti Stahuje se z úložiště Připraveno ke stažení Odstraňuje se Soubor ještě nebyl zcela nahrán na úložiště (čeká ve frontě). Soubor je nahráván na úložiště. Soubor je uložen pouze na úložišti, nikoliv na lokálním disku. Soubor se stahuje z úložiště na server, ze kterého bude možno soubor stáhnout na disk. Soubor je na serveru připraven ke stažení. Soubor se odstraňuje. Dialogové okno na souboru Stáhnout V tomto případě se to, co se stane, odvíjí od aktuálního stavu souboru, který chceme stahovat. Je-li soubor ve stavu Připraveno ke stažení tak se uloží uživateli na disk v jeho počítači. Je-li ovšem soubor ve stavu Uloženo pouze na úložišti, tak se začne stahovat do dočasné složky na Metadata Serveru, čímž získá stav Připraveno ke stažení, odkud si ho posléze uživatel může stáhnout. Viz první případ. Při stažení souboru je tento soubor přidán mezi Oblíbené soubory, pro jeho rychlejší nalezení při případné budoucí práci. Upravit Odstranit Umožní úpravu jednotlivých tagů na souboru. Smaže vybraný soubor z celého systému., Washingtonova 1624/5, 110 00 Praha 1 Strana 9
Indexovat Indexace slouží k rychlému vyhledávání souborů na základě jejich obsahu. Indexace souboru je povolena pouze pokud je ve FTD pro daný typ souboru indexace zapnuta. Server si z úložiště stáhne soubor, a ten následně znovu zaindexuje. Vytvořený dočasný soubor bude smazán. Smazat z indexu Smazat dočasný soubor Přidat k oblíbeným Vytvořit filtr Zavřít Smaže zaindexovaná data souboru. (soubor samotný není smazán) Smaže vytvořený dočasný soubor ze serveru. (po smazání dočasného souboru stále zůstává originální soubor bezpečně v úložišti) Přidá soubor do záložky v menu Oblíbené soubory. Filtruje soubor podle zadaného dotazu. Prohledá celý soubor řádek po řádku a zobrazí pouze ty, které se budou shodovat se zadaným dotazem. Vytvořený filtr se vytvoří v menu pod položkou. Vytvořený filtr se zobrazí v menu pod záložkou Výsledky filtrování. Zavře dialogové okno. Obrázek 5: Seznam souborů, Washingtonova 1624/5, 110 00 Praha 1 Strana 10
E.1. Úprava tagů Vybráním položky Upravit z kontextového menu (obrázku č.5) se vám zobrazí panel se seznamem všech aktuálně přiřazených tagů k danému souboru. Tagy zde můžete editovat, přidávat a odebírat. Máte možnost vidět jednotlivé parametry tagů a jejich hodnoty. Hodnotu můžete měnit, avšak je závislá na regulárním výrazu. Podle zadaných hodnot tagů bude soubor vyhledatelný. Před uložením musí být připojeny a nastaveny povinné tagy. Obrázek 6: Úprava tagů, Washingtonova 1624/5, 110 00 Praha 1 Strana 11
F. Vyhledávání Na začátku si uživatel vybere FTD, nad kterým chce vyhledávat. Vyhledávat lze podle podrobností o souboru, pomocí tagů, a pokud má FTD zapnuté indexování, tak lze vyhledávat i za pomoci rozšířeného vyhledávání, což znamená, že lze vyhledávat v obsahu uložených souborů. Tyto způsoby vyhledávání lze libovolně kombinovat pro co nejpřesnější výsledky hledání. Při zadávání hodnot a názvů souborů nezáleží na velikosti písmen. Aby uživatel mohl používat funkce vyhledávání a filtrování, musí mít administrátorem nastavené oprávnění Vyhledávat a Filtrovat. Pro reindexování souboru je dále potřeba oprávnění Reindexovat pro dané FTD. F.1. Vyhledávání podle Podrobnosti o souboru Vyhledávat lze podle názvu souboru, přičemž lze vyhledávat jen podle několika znaků, kterým se dá blíže specifikovat, zda soubory při hledání touto hodnotou začínají, končí, rovnají se jí, nebo zda jsou v názvu jen obsaženy. Vyhledávat lze také podle časového rozmezí, kdy byl soubor nahrán. Na závěr lze vyhledávat dle velikosti souboru. Při nezadání žádného názvu souboru, budou vyhledány všechny soubory v daném FTD. Obrázek 7: Vyhledávání podle souborů F.2. Vyhledávání pomocí tagů Při tomto typu vyhledávání, je možné vyhledávat pomocí jednotlivých tagů připojených k souborům a jejich hodnot. Jednotlivé tagy se dají kombinovat. Lze také použít více stejných tagů, s odlišnou hodnotou. Pokud neznáte přesnou hodnotu vybraného tagu, lze vyhledávání podle vámi zadané hodnoty blíže určit podle nastavení, které je stejné jako při vyhledávání podle podrobností souboru. Například zda vámi zadané znaky značí začátek nebo konec tagu., Washingtonova 1624/5, 110 00 Praha 1 Strana 12
Kombinování tagů Stejné tagy Různé tagy Při kombinaci stejných tagů se vám vyhledají soubory podle všech hodnot. Jedná se o logický operátor NEBO (OR). Při kombinaci různých tagů, vyhledávání musí odpovídat všem hodnotám tagů, které byly zadány. Jedná se o logický operátor A (AND). Pomocí těchto tagů budou vyhledány všechny diplomové práce psané na Elektrotechnické fakultě. Obrázek 8: Vyhledávání podle tagů F.3. Vyhledávání podle indexu Pokud jsou vaše soubory indexované, přibude vám nová možnost vyhledávání. Touto možností je vyhledávání v obsahu uložených souborů. V některých případech lze zapnout Rozšířené vyhledávání kde je možné hledat v datech podle konkrétních polí. Převážně u CSV souborů lze hledat nad konkrétním sloupcem. Výstupem tohoto vyhledávání jsou soubory, které obsahují zadané hodnoty z jednotlivých sloupců, které jste zadali. Na obrázku je příklad vyhledaných souborů, které ve sloupci OPERATORVOLAJICIHO obsahují alespoň jednou hodnotu O2., Washingtonova 1624/5, 110 00 Praha 1 Strana 13
Obrázek 9: Rozšířené vyhledávání podle indexu Druhou, asi běžnější možností, je vyhledávání indexu pomocí obecného dotazu. Do políčka pro hledání zadáte to, co chcete hledat a systém se to pokusí najít. Text lze dále více specifikovat pomocí operátorů. Základní syntaxe a použití operátorů je uvedená níže. Pokud mezi výrazy není použit žádný operátor, je defaultně použit logický operátor NEBO (OR). Kompletní specifikaci najdete na webové stránce pro Apache Lucene - Query Parser Syntax https://lucene.apache.org/core/2_9_4/queryparsersyntax.html Všechny operátory a textové pole nemusí nutně fungovat, jelikož záleží na nastavení Solru a charakteru indexovaných dat. Textové řetězce Jednotlivá slova AND OR nebo Textové řetězce se označují v uvozovkách, aby bylo poznat, že daný výraz Solr hledá v celku. Apache test. Pro hledání výrazu, kterým je pouze jedno slovo, je možné zadávat dotaz bez uvozovek, i s uvozovkami. Operátor AND hledá dokumenty, které obsahují všechny zadané výrazy. Např. pro dokumenty obsahující výrazy Test Java a Apache Lucene se použije dotaz Test Java AND Apache Lucene. Operátor OR hledá dokument, ve kterém se některý z výrazů nachází. Např. Test Java OR Apache Lucene vyhledá dokumenty, které jeden z výrazů obsahují. + Slovo po symbolu + musí být v dokumentu nalezeno. Slova zadaná za ním mohou být obsažena, ale nemusí. Např. +testovací Apache NOT - Uvedené symboly vyloučí dokumenty, které obsahují zadaný výraz. Např. pro vyhledání dokumentu, Washingtonova 1624/5, 110 00 Praha 1 Strana 14
! obsahující Jakarta apache a neobsahující Apache test bude použit dotaz jakarta apache NOT Apache test.? Zastoupí jeden znak ve slovu, např. te?t, tedy výsledek může být text i test * Zastoupí libovolný počet znaků (tedy i nulový), např. pro test* mohou být například výsledky test, testovací, tester ^ Slouží k přidání váhy vyhledaného výrazu, např. pro navýšení relevantnosti výrazu jakarta oproti apache. jakarta ^4 apache Obrázek 10: Vyhledávání podle indexu F.4. Vyhledané soubory Za použití výše popsaných způsobů vyhledávání, se zobrazí vyhledané soubory. Po vybrání určitého souboru, lze pomocí pravého tlačítko zobrazit nabídku akcí. Akce nad vyhledanými soubory: Stáhnout Vyhledaný soubor se ze serveru stáhne na disk. (pro stažení z Cloudu platí stejný postup jako v kapitole E) Při stažení se soubor zařadí mezi Označené soubory. Upravit Vytvořit filter Upravovat tagy nad nalezeným souborem, stejný postup jako v kapitole E.1. Filtruje soubor podle zadaného dotazu. Prohledá celý soubor řádek po řádku a zobrazí pouze ty, které se budou shodovat se zadaným dotazem. Vytvořený filtr se vytvoří v menu pod, Washingtonova 1624/5, 110 00 Praha 1 Strana 15
položkou. Vytvořený filtr se zobrazí v menu pod položkou Výsledky filtrování. Filtrovat jde jen některé typy souborů, jako napříkald CSV. Odstranit Indexovat Smazat z indexu Smazat dočasný soubor Přidat k oblíbeným Smaže vybraný soubor z celého systému. Reindexuje vybraný soubor. Pro reindexaci souboru, který je uložen na úložišti, se soubor musí nejdříve z úložiště stáhnout, poté bude teprve umožněna opětovná indexace. Smaže zaindexovaná data souboru. (soubor samotný není smazán) Odstraní dočasný soubor ze serveru. (po smazání dočasného souboru stále zůstává originální soubor bezpečně v úložišti) Přidá soubor do záložky v menu Oblíbené soubory. Tvorba filtrů Ve Výsledcích vyhledávání bude vytvořen filtr, obsahujíc řádky se zadaným dotazem, v tomto příkladu každý řádek obsahující slovo Vodafone Obrázek 11: Tvorba filtrů, Washingtonova 1624/5, 110 00 Praha 1 Strana 16
G. Výsledky filtrování Ve výsledcích filtrování se ukládají veškeré vytvořené filtry nad soubory. Každý filtr obsahuje své ID, název a ID souboru, nad kterým je vytvářen, vyhledaný text v souboru a velikost samotného filtru. Každý z filtrů má uvedenou skupinu a uživatele, kterým byl vytvořen. Ve filtru jsou dále obsaženy všechny odpovídající řádky obsahující vyhledaný text. Jednotlivé filtry se dají prohlížet, odstraňovat, či rovnou je stahovat na disk. Obrázek 12: Výsledky vyhledávání G.1. Prohlížeč pro zvolený filtr Při prohlížení zvoleného filtru, jsou vypsány řádky souboru, které odpovídají vyhledanému textu. Zároveň jsou zahrnuty při zobrazování všechny sloupce souboru. Podle hodnot v jednotlivých sloupcích se dá soubor dále filtrovat. Na obrázku je soubor dále filtrován podle operátorů příjemce a volajícího. Obrázek 13: Prohlížení filtrů, Washingtonova 1624/5, 110 00 Praha 1 Strana 17
Pro uložení dat do vašeho počítače klikněte na ikonku Download v pravém horním rohu. Zobrazí se nabídka 3 možností, jak data uložit. Obrázek 14: Download Nabídky stahování Stáhnout osekaný a filtrovaný soubor Stáhnout filtrovaný soubor Stáhnout původní soubor Stáhne ze serveru na váš disk osekanou verzi filtru. To znamená aktuální podobu osekanou dodatečnými filtry. Stáhne filtrovaný soubor, vytvořený v předchozí kapitole (F. Vyhledávání). Ve stahovaném souboru se neprojeví dodatečné filtry. Stáhne kompletní soubor, který je uložen na úložišti, v podobě, ve které byl nahrán. Nebudou v něm promítnuty žádné filtry., Washingtonova 1624/5, 110 00 Praha 1 Strana 18
H. Oblíbené soubory Jednotlivé Oblíbené soubory představují pouze odkaz na určitý soubor, který si do oblíbených souborů přidáte. Fungují jako záložky. Do oblíbených souborů se hodí přidat soubory, se kterými často pracujete. Vyhnete se tak opakovanému vyhledávání a filtrování. Tyto odkazy slouží pouze pro vaší rychlejší orientaci, vidíte je tedy pouze vy, nikdo jiný. Můžete s nimy dělat stejné operace jako se soubory v menu záložce Soubory + odstranění vybrané záložky. Operace nad označenými soubory Stáhnout Upravit Odstranit Indexovat Smazat dočasný soubor Smazat z indexu Odebrat z oblíbených Vytvořit filter Stáhne vybraný soubor. Postup je stejný jako v předchozích kapitolách. Nejdříve se soubor stáhne z úložiště na server a až poté bude ke stažení na lokální disk. Upraví tagy na souboru. Odstraní soubor trvale z úložiště. Zaindexuje soubor. Smaže dočasný soubor vytvořený na serveru. Dočasné soubory jsou vytvořeny při stahování nebo editaci souborů. Smaže zaindexovaná data souboru. (soubor samotný není smazán) Odstraní soubor z oblíbených souborů (ne z úložiště). Filtruje soubor podle zadaného dotazu. Prohledá celý soubor řádek po řádku a zobrazí pouze ty, které se budou shodovat se zadaným dotazem. Vytvořený filtr se vytvoří v menu pod položkou. Vytvořený filtr se zobrazí v menu pod položkou Výsledky filtrování. Obrázek 15: Oblíbené soubory, Washingtonova 1624/5, 110 00 Praha 1 Strana 19