DOKUMENTACE MTJ SERVICE S.R.O. Guardian - základní uživatelská příručka Vypracoval: Václav Pur Datum: 19.4.2011 Verze: 2.7.9
OBSAH OBSAH... 2 ÚVOD... 3 INSTALACE... 3 1) ÚVODNÍ OBRAZOVKA... 3 2) VÝBĚR UMÍSTĚNÍ... 3 3) POTVRZENÍ INSTALACE... 4 4) DOKONČENÍ INSTALACE... 5 SPUŠTĚNÍ... 6 PROSTŘEDÍ KONFIGURÁTORU GUARDIANA... 7 1) GUARDIAN TOOLBAR... 7 2) GUARDIAN MENU... 8 3) PROFILY... 9 4) PLATFORMA, PŘENOS... 9 5) DALŠÍ NASTAVENÍ... 10 6) SLUŽBA... 12 7) PRŮBĚH SLUŽBY... 12 8) MINIMALIZACE... 12 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.2
ÚVOD Program Guardian je určen pro synchronizaci dat mezi prostředími Soft-4-Sale a E-řešeními (E-Shop, E-HelpDesk, E-Portál, aj.) firmy MTJ Service s.r.o. INSTALACE Při instalaci programu Guardian je použit standartní instalátor, takže je instalace velice intuitivní. 1) Úvodní obrazovka 2) Výběr umístění Vybrte umístění instalace Guardiana, případně zda-li má být dostupný pouze pro Vás, nebo pro všechny uživatele počítače. 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.3
3) Potvrzení instalace Po stisknutí "Next >" následuje instalace. 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.4
4) Dokončení instalace 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.5
SPUŠTĚNÍ Po dokončení instalace se v nabídce "Start" -> "Programy" -> "Guardian 2008" ( ). Po kliknutí se objeví v ikonách vedle hodin, dále jen "Systray" ikona konfigurátor zjednodušenou volbu:. Pravým tlačítkem nabízí Otevřít konfigurátor - otevře hlavní okno Guardiana s možnostmi nastavení, tvorby a mazání profilů Spustit službu - spustí automatickou službu Guardiana - nastavené a povolené profily, které mají zadány časový plán budou automaticky probíhat. Zastavit službu - ukončení automatického režimu programu Guardian. Ukončit konfigurátor - ukončí program i službu Guardian. Tímto dojde i k odpojení všech databází a souuborů, s kterými Guardian pracuje (pouze k odpojení, ne ke smazání) Dvojklikem na systray ikonu se otevře konfigurátor také. 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.6
PROSTŘEDÍ KONFIGURÁTORU GUARDIANA 1) Guardian Toolbar Povolit profil - u vytvořeného profilu povolí jeho spuštění v rámci automatického běhu služby Guardian. Mimo jiné nelze spustit ani manuálně. Zakázat profil - zakáže spuštění daného profilu (tedy importu/exportu dat). Nový profil - lze přidat nový profil.!! POZOR - profily pro E-Shop musí být pojmenovány stejně jako v nastavení v S4S. Jinak bude profil nefunkční. Pokud je ve volbě platformy zvoleno "pouze přenos" potom na volbě názvu nezáleží (samozřejmě pokud se nekryje s případným profilem pro eshop, ale i tak bude pouze přenášet soubory dle nastaveného adresáře v záložce "Přenos". Úprava profilu - Umožní editovat profil - volba platformy, způsob přenosu, nastavení cest k datům, případně souborům. Nastavení připojení k FTP serveru, cest ke skriptům zpracovávajícím soubory, nastavení časového plánu profilu v automatickém běhu a nastavení logů. Uložit profil - Uloží editované informace do profilu Odstranit profil - Smaže aktuálně vybraný profil 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.7
2) Guardian Menu Soubor - základní nabídka profilu Spustit Inicializační Export profilu - spustí inicializační ("totální") export profilu, pro e - shopy to znamená kompletní přenos zvolených věcí profilem na e-shop.!! POZOR - při spuštění tohoto exportu můžete přijít o data (objednávky, kontakty), které vzniknou na eshopu, či portále před posledním Importem. Proto doporučujeme před spuštěním tohoto exportu provést Import a celou operaci provádět pokud možno ve večerních hodinách, kdy je menší předpoklad vzniku objednávek. To samozřejmě neplatí pro úplně první Inicializační export, či pokud se jedná o volbu "pouze přenos". Spustit Export vybraného profilu - tato nabídka spustí částečný export - budou exportovány pouze nově vzniklé a upravené dokumenty. Při automatickém běhu se spouští tento export - nikoliv inicializační (před prvním spuštěním daného profilu do automatického režimu je tedy nutné provést Inicializační export!). V režimu "pouze přenos" neprobíhá žádné exportování dat, či spouštění skriptů, jedná se pouze o zkopírování souborů s předvolenou koncovkou ze zadaného adresáře dle typu přenosu. Spustit Import vybraného profilu - stejně jako u předchozího bodu se jedná pouze o částečný import dat z databáze na internetu, tedy nově vzniklá a upravená data. V režimu "pouze přenos" se při této volbě nic nestane. Minimalizovat - Program se minimalizuje. Zůstane pouze ikona v systray. Ukončit konfigurátor - ukončí program i službu Guardian. Tímto dojde i k odpojení všech databází a souuborů, s kterými Guardian pracuje (pouze k odpojení, ne ke smazání). Zobrazit - Styl zobrazení konfigurátoru. Při detailní volbě se nabízí okno konfigurátoru jak je zobrazeno na začátku kapitoly. V kompaktním režimu potom vypadá takto: Nástroje - Tato část programu je zatím ve vývoji a pouze v testovacím provozu. 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.8
Nápověda - Základní informace o verzi programu, apod. 3) Profily - poskytuje výpis profilů. Zelené šipky znázorňují aktivní profily, červené naopak neaktivní. Modře podbarvený je aktuálně zvolený profil. Při stisknutí pravého tlačítka se nabízí volby k profilu. 4) Platforma, přenos Změnit název profilu - umožní změnit název Odstranit profil - odstraní aktuální profil - volba platformy, na které S4S pracuje. Přenos je způsob přenosu na server, kde je umístěn e-shop, e-helpdesk, e-portál apod. Platforma: Access - S4S pracuje s databází MS Access, k tomuto se vztahuje záložka "Access" v dalším nastavení. SQL Server - S4S pracuje s databází MS SQL, k tomuto se vztahuje záložka "SQL Server" v dalším nastavení. pouze přenos - jedná se pouze o přenos souborů dle typu přenosu, k tomuto se vztahuje záložka "Přenos" v dalším nastavení. Přenos: FTP - přenos souborů a dat na ftp server (nejčastější použití), k tomuto se bztahuje záložka "FTP" v dalším nastavení. Copy - přenos souborů v rámci počítače, případně interní sítě, k tomuto se bztahuje záložka "FTP" v dalším nastavení, kde se nevyplní údaje o FTP serveru. SSL - přenos souborů na šifrované FTP pomocí SSL (FTPS), k tomuto se bztahuje záložka "FTP" v dalším nastavení.!! POZOR - tuto konfiguraci je nutné dohodnout a nastavit individuálně, jedná se o pokročilejší funkčnost. SFTP - přenos souborů na šifrované FTP pomocí SSH (SFTP), k tomuto se bztahuje záložka "FTP" v dalším nastavení.!! POZOR - tuto konfiguraci je nutné dohodnout a nastavit individuálně, jedná se o pokročilejší funkčnost. 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.9
5) Další nastavení - detailní nastavení profilu. Tedy zadání všech potřebných parametrů pro spolehlivý přenos. Access - S4S pracuje s databází MS Access. Nutnost zaškrtnuté platformy "Access". zde se nastavuje cesta k datům S4S SQL Server - S4S pracuje s databází MS SQL. Nutnost zaškrtnuté platformy "SQL Server". zde se nastavuje cesta k SQL serveru a volba databáze Přenos - pouhý přenos souborů s daty S4S se nepracuje. Nutnost zaškrtnuté platformy "pouze přenos". zde se nastavuje cesta k souborům pro přenos a jejich koncovka (soubory s jinou koncovkou se přenášet nebudou) Soubor - nastavení pro eshopy - způsob výstupu dat, jejich rozdělování, zda mazat zálohovací soubory, stahování připojených objektů k HelpDeskům. Typ výstupu - formát výstupního souboru - S4S je standartní typ výstupu. XML je formátování výstupu dle XML standartu. Max. velikost souboru - maximální velikost souborů, pokud je překročena dojde k rozdělení Mazat BAK soubory - pokud je zaškrtnuto neudržuje se na FTP historie importů/exportů Stahovat připojené objekty - pokud je k HelpDesku nějaký přiložený soubor, přenese se z portálu do předen zvolené adresy na PC dle pole Cesta k uložení připojených objektů. Připojené objekty - Tato část programu slouží pro nastavení synchronizace objektů. Dle filtru nastaveném v profilu v S4S pro tabulku objektů je program automaticky při exportu dat směrem na web nahraje na webový server do určené složky. Synchronizovat objekty - zda-li má synchronizace probíhat. na FTP adresářová strukture - Pokud jsou v S4S v připojených objektech definovaný ROOT adresář pro objekty a další složky jsou v S4S uvedeny relativně, potom Guardian tuto strukturu dodrží i v dané složce na FTP, pokud není zaškrtnuto nakopíruje je pouze do této složky - bez tvorby podadresářů. Adresář na FTP s objekty - složka kam se budou objekty synchronizovat. 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.10
Výchozí složka objektů - Pokud je nastavena složka s objekty jako síťový disk, Guardian nebude mít jako běžící služba přistup k takovému disku - do tohoto pole se tedy vyplní zástupné umístění objektů, které je přístupné. FTP - Nastavení připojení k FTP serveru a složky pro jednotlivé části přenosu. FTP Server - adresa ftp serveru (např. "mtj.cz") Port - port, přes který probíhá komunikace se serverem - Test připojení (zda-li je vše správně zadáno) Pasivní - má-li Guardian komunikovat s FTP serverem pasivně, či aktivně (některé servery umožňují pouze pasivní přístup) Proxy - zda-li použít při připojení Proxy server Jméno a Heslo - přihlašovací jméno a heslo na FTP Server - měly by jste obdržet od poskytovatele webhostingu Proxy Jméno a Proxy Heslo - pokud je zvýšené zabezbečení, nebo se k FTP připojujete přes proxy server je nutné vyplnit tyto údaje. Nutností je zatržená volba "Proxy ". Proxy Hostitel - adresa proxy serveru Kde je Importovací adresář? - Umístění adresáře pro import souborů na FTP serveru Kde je Exportovací adresář? - Umístění adresáře pro export souborů na FTP serveru Kde je potvrzovací adresář? - Umístění adresáře pro kontrolní funkčnost Guardianu a skriptů, jsou zde umístěny logy pro Import a Export na úrovni úspěšnosti skriptů na FTP serveru HTTP - Umístění php skriptů, které Guardian po provedení exportu, resp. před provedením importu spustí. Http adresa k Importovacímu skriptu - umístění importovacího souboru, který zapisuje data do SQL databáze (např.: "www.vasedomena.cz/import.php"). Http adresa k Exportovacímu skriptu - umístění exportovacímu souboru, který porovná databázi a nově založené nebo změněné položky zapíše do souboru(např.: "www.vasedomena.cz/export.php"). Plán - časový plán automatického běhu služby Guardian. Dny v týdnu - specifikace, ve které dny má probíhat služba, pokud je zapnuta. - Přidání nového intervalu ve Vámi zvoleném dni - Úprava zvoleného časového intervalu - Smazaní zvoleného časového intervalu Příklad - Tedy takto zvolený případ - v úterý bude údržba probíhat od v úseku 5. - 8. hodiny ranní každých 60 minut, potom od 8-16 každých 20 minut (větší pravděpodobnost změny v rámci firmy, případně objednání ze strany zákazníků) a od 16-24 každých 45 minut (není nutné tak často. Tedy půlnoci do 5.hodiny ranní nebude služba probíhat - v tuto dobu tak mohou proběhnout automatické funkčnosti S4S jako komprese a údržba databáze, replikace apod. Nastavení - nastavení logů profilu (tedy výpisu běhu Guardiana). Základní Log - základní log Guardiana, zapisuje se do adresářové struktury Guardiana do nově vytvořeného adresáře "Logs" a souboru " GUARDIAN.log". Potvrzení tohoto logu není 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.11
nutné, ale velmi doporučujeme jej mít zapnutý, usnadní nám to při jakékoliv komplikaci přijít na příčinu. Zapisují se zde informace o zpracovaných souborech a spouštění služby. Debug Log - detailní log Guardiana, zapisuje se do adresářové struktury Guardiana do nově vytvořeného adresáře "Logs" a souboru "Debug.log". Potvrzení tohoto logu není nutné, zapnutí doporučujeme pouze po konzultaci, nebo při neobjasněných vyjímkách v rámci přenosů. Zapisují se zde detailní informace importu a exportu, zápisu na úrovni databáze v S4S, a jiné podobné informace. Režim Guardiana - určuje vytížení procesoru Guardianem - při porovnávání je potřeba velké množství výkonu. Rapid - maximální přidělené množství procesoru. Optimal - výkon na procesoru by neměl překročit přibližně 10-25% výkonu procesoru, ale prodlouží se doba vykonávání exportu/importu. Výrazně se prodlouží doba vykonávávání exportu/importu, avšak výkon procesoru by neměl překročit 5%. Profil Guardiana - zpětná kompatibilita pro starší definici menu v S4S - definice pro B2B Guardiana. Komprese souborů - V zapnutém stavu Guardian vytvoří exportní soubor/y, ty následně zabalí - u pomalejších připojení tento režim uspoří i několik minut 6) Služba - signalizace zda-li je služba spuštěna, nebo zastavená a možnost jejího spuštění/zastavení. Zastavená V běhu 7) Průběh služby - Výpis aktuálně probíhající činnosti Guardiana Služba: - zda-li běží služba, nebo je zastavená (a případně probíhá manuální export/import). Popisek - aktuálně probíhající operace, či zpracovávaná tabulka Ukazatelé - horní ukazatel znázorňuje stav dokončení aktuální operace, pokud je rozdělena na více činností. Dolní potom celkový průběh importu/exportu. 8) Minimalizace - Program se minimalizuje. Zůstane pouze ikona v systray. 19.4.2011 Dokument: Guardian 2.7.9 - Základní uživatelská příručka.doc, rev.:66, vytvořil: Václav Pur Str.12