Nápověda k aplikaci EA Script Engine Object Consulting s.r.o. 2006 Obsah Nápověda k aplikaci EA Script Engine...1 1. Co je EA Script Engine...2 2. Důležité upozornění pro uživatele aplikace EA Script Engine...3 3. Instalace aplikace EA Script Engine...4 3.1 Požadavky na instalaci...4 3.2 Postup instalace...4 4. Ovládání aplikace EA Script Engine...6 4.1 Spuštění aplikace EA Script Engine...6 4.2 Práce se skripty, editace, uložení, spuštění skriptu...7 4.2.1. Editace skriptu...7 4.2.2. Load script, Save script...8 4.2.3. Spuštění skriptu pomocí Run script...8 4.3 Práce s permanentními skripty...10 4.3.1. Spuštění permanentního skriptu...10 4.3.2. Přidání skriptu mezi permanentní skripty, smazání, přejmenování permanentního skriptu...11 4.3.3. Změna adresáře permanentních skriptů...11 5. Použití externího editoru PSPad...12 5.1 Nastavení editoru PSPad...12
1. Co je EA Script Engine Utilita EA Script Engine je velmi výkonným a užitečným doplňkem CASE nástroje Enterprise Architect (dále EA). Utilita EA Script Engine je aplikace typu ADD-IN, která vkládá do CASE nástroje EA skriptovací jádro pro psaní vlastních skriptů přímo v otevřené aplikaci EA. Utilita EA Script Engine na rozdíl od klasických technik použití skriptu pracuje přímo nad otevřenou aplikací CASE nástroje a přistupuje k aktuálně otevřenému modelu uvnitř EA, tj. skriptovací jádro pracuje přímo nad otevřenou aplikací EA a jeho aktuálním objektem Repository stejně jako při použití aplikace typu ADD-IN. Na rozdíl od aplikace ADD-IN jsou však vytvořené skripty snadno vyměnitelné a měnitelné. Díky utilitě EA Script Engine můžete přímo do otevřené aplikace EA jednoduše a přehledně vkládat skripty ovládající výstupy, přehledy a reporty z EA, můžete si vytvořit jednoduše vlastní generátory kódu, případně můžete propojit CASE nástroj s jinou aplikací, například s aplikací WORD, Excel, s nástrojem pro řízení verzí apod. Aplikace navíc umožňuje vkládat hotové a odladěné skripty mezi tzv. permanentní skripty, které lze spouštět přímo z menu aplikace. Skripty se tak mohou stát plnohodnotným doplňky CASE nástroje podobně jako jsou komponenty ADD IN, oproti prvkům ADD IN jsou však skripty mnohem jednodušší, nepotřebují žádnou registraci a podporu vývojového prostředí. Utilita EA Script Engine používá jako skriptovací jazyk VBScript. strana 2
2. Důležité upozornění pro uživatele aplikace EA Script Engine Utilita EA Script Engine je silný nástroj, který umožňuje provádět také nevratné změny (mazání, přidání, změny apod.) ve vašem modelu v nástroji EA, a to mohou být také změny nežádoucí (omyl, chyba apod.). Autoři aplikace EA Script Engine neručí a nenesou žádnou odpovědnost za možné důsledky použití skriptů a jejich spouštění uživatelem aplikace EA Script Engine. Zodpovědnost za následky použití aplikace EA Script Engine nese pouze uživatel aplikace EA Script Engine. Doporučujeme v každém případě před každým spuštěním aplikace EA Script Engine nejen uložit, ale také zálohovat údaje obsažené v CASE nástroji EA. strana 3
3. Instalace aplikace EA Script Engine 3.1 Požadavky na instalaci Aplikace je určena pro OS Microsoft Windows 2000 a vyšší. Pro běh aplikace EA Script Engine je nezbytné mít nainstalované prostředí Microsoft.NET Framework 2.0 a CASE nástroj Enterprise Architect (EA). Nemáte-li k dispozici licencovanou verzi Enterprise Architect, je možné nainstalovat její 30- denní trial verzi. Utilita EA Script Engine se dodává v plné verzi jako licencovaný software nebo jako 15-denní trial verze. Plnou verzi lze objednat e-mailem viz stránky http://www.objects.cz, kde je umístěna také trial verze. 3.2 Postup instalace Stáhněte ze stránky http://www.objects.cz příslušný instalační soubor, uložte jej na libovolné místo a spusťte. Instalační soubor nainstaluje utilitu EA Script Engine včetně nutných změn v registrech a registrace knihoven. V průběhu instalace je nutné zvolit adresář, do kterého se nainstalují soubory aplikace EA Script Engine. Implicitně je nabídnut adresář C:\Program Files\Object Consulting\EA Script Engine\bin, pomocí tlačítka vpravo je možné vybrat libovolný jiný adresář (viz obrázek 1 výběr adresáře pro instalaci). Pokud zvolený adresář neexistuje, instalátor se dotáže, zda má adresář založit. strana 4
obrázek 1 výběr adresáře pro instalaci Po zjištění instalačního adresáře je instalace připravena. Instalaci potvrdíte a spustíte tlačítkem Start (viz obrázek 2 potvrzení instalace). obrázek 2 potvrzení instalace Instalaci lze kdykoliv opustit tlačítkem Exit. strana 5
4. Ovládání aplikace EA Script Engine 4.1 Spuštění aplikace EA Script Engine 1. Otevřete projekt v CASE nástroji Enterprise Architect (EA) 2. Klikněte pravým tlačítkem myši na vybraný prvek modelu v okně Project View aplikace EA 3. Vyberte položku menu Add-In -> EA Script Engine, objeví se položky menu EA Script Engine (viz obrázek 3 Přístup k aplikaci EA Script Engine) obrázek 3 Přístup k aplikaci EA Script Engine strana 6
Poznámka: Pokud používáte trial verzi, ve formuláři pro zadání licence zvolte mezi zadáním údajů licence anebo použitím trial verze. 4.2 Práce se skripty, editace, uložení, spuštění skriptu Položka menu EA Script Engine -> Run Edited Script spouští dialog pro práci se skripty (viz obrázek 4 Dialog pro práci se skripty). obrázek 4 Dialog pro práci se skripty 4.2.1. Editace skriptu strana 7
Textové editační pole Script Window slouží pro jednoduchou ruční editaci skriptu v jazyce VBScript a pro testování skriptů. Poznámka: Pro profesionální editaci a uložení skriptu doporučujeme používat externí editor s plnou podporou prostředí jazyka VBScript, viz kapitola Použití externího editoru PSPad 4.2.2. Load script, Save script Pro načtení uloženého souboru slouží tlačítko Load Script. Po jeho stisknutí se zobrazí dialogové okno pro výběr jednoho nebo vícero souborů. V nabídce souborů se zobrazují soubory typu *.eas (EA Script) nebo *.* (All files). Vybraný soubor se načte a zobrazí v editačním okně. V dialogovém okně pro výběr souborů skriptu je možné vybrat více souborů (pomocí podržení klávesy Shift nebo Ctrl), v tom případě se do editačního okna načtou všechny vybrané soubory. Poznámka: Doporučujeme, aby při načtení vícero souborů skriptů do aplikace EA Script Engine jeden soubor obsahoval výkonnou část skriptu a aby ostatní soubory skriptů obsahovaly nevýkonné části skriptů (procedury, funkce, třídy, ) podobně jako v Pascalu hlavní program a moduly unit. Výkonné a nevýkonné části skriptu lze odlišit názvem souboru, např. main*.eas, lib*.eas apod. Pro případné uložení editovaného skriptu slouží tlačítko Save Script. Poznámka: Pro editaci a uložení skriptu doporučujeme raději používat externí editor s plnou podporou prostředí jazyka VBScript, (viz kapitola Použití externího editoru PSPad) Při editaci editaci a ukládání skriptů v externím editoru (doporučeno) používejte v aplikaci EA Script Engine pouze načtení skriptu a jeho spuštění. 4.2.3. Spuštění skriptu pomocí Run script Tlačítko Run Script spouští skript viditelný v editačním okně v jazyce VBScript, přičemž skript používá aktuální objekt Repository. Syntaxe skriptů: syntaxe jazyka VBScript, viz např. stránky MSDN: http://msdn.microsoft.com/library/default.asp?url=/library/enus/script56/html/0a8270d7-7d8f-4368-b2a7-065acb52fc54.asp aktuální objekt repository z EA se nazývá Repository strana 8
výpis do Debug okna se provádí pomocí příkazu Debug.AppendText <string> znak pro nový řádek je VbCrlf vymazání Debug okna Debug.Clear Příklady (skripty jsou uloženy v instalačním adresáři): example1.eas Hello world example2.eas výpis obsahu Repository do Debug okna example3.eas výpis názvu aktuálně vybraného prvku v Project View do Debug okna strana 9
4.3 Práce s permanentními skripty Permanentní skripty slouží ke spouštění již odladěných a připravených skriptů přímo kliknutím z menu EA Script Engine (tj. pro často používané skripty). Tím se permanentní skripty stávají součástí funkcionalit CASE nástroje EA podobně jako při použití vlastních ADD IN aplikací. Permanentní skripty se ukládají do zvláštního adresáře a jsou nabízeny ke spuštění přímo v menu aplikace EA Script Engine. Při odinstalování EA Script Engine se tyto skripty nevymažou a zůstávají jako soubory v adresáři zachovány. 4.3.1. Spuštění permanentního skriptu Pokud jsou permanentní skripty již vytvořeny (viz kapitola Přidání skriptu mezi permanentní skripty, smazání, přejmenování permanentního skriptu), jsou nabízeny pro spuštění přímo v menu aplikace EA Script Engine pod položkou Run Permanent Scripts. Klepnutím na vybranou položku daného skriptu se spustí příslušný permanentní skript (viz obrázek 5 Spuštění permanentního skriptu). obrázek 5 Spuštění permanentního skriptu strana 10
4.3.2. Přidání skriptu mezi permanentní skripty, smazání, přejmenování permanentního skriptu Pro přidání skriptu viditelného v editačním okně Script Window slouží tlačítko Add Script to Permanent Scripts v dialogu pro editaci a spouštění skriptů (viz obrázek 4 Dialog pro práci se skripty). Při ukládání prvního skriptu je třeba zvolit adresář pro uložení permanentních skriptů, implicitně se nabízí cesta: Program Files\Object Consulting\EA Script Engine\Permanent Scripts. Pro následnou změnu této cesty viz kapitola Změna adresáře permanentních skriptů. Při vkládání dalších skriptů mezi permanentní skripty se kontroluje existence permanentního skriptu se stejným názvem, nelze uložit dva permanentní skripty se stejným názvem. Tlačítko View Permanent Scripts nabízí prohlížení permanentních skriptů v needitovatelném okně, přejmenování a případně smazání vybraného permanentního skriptu. Poznámka: Kromě vkládání skriptů mezi permanentní skripty přes aplikaci EA Script Engine lze skript přidat mezi permanentní skripty také ručně uložením jeho souboru s příponou *.eas do adresáře permanentních skriptů. Stejně tak je možné permanentní skripty ručně přejmenovávat a mazat v adresáři permanentních skriptů. Existence permanentního skriptu znamená jeho fyzickou existenci v adresáři permanentních skriptů. 4.3.3. Změna adresáře permanentních skriptů Změnu cesty adresáře s permanentními skripty lze provést ručně zápisem cesty do textové hodnoty Directory klíče v registru: HKEY_CURRENT_USER\Software\Object Consulting\EA Script Engine\Permanent Scripts. Změny v registrech neprovádějte při běžící aplikaci EA Script Engine. strana 11
5. Použití externího editoru PSPad Pro editaci skriptu doporučujeme používat externí editor PSPad. Domovská stránka aplikace PSPad je http://www.pspad.com/, kde je ke stažení zdarma. 5.1 Nastavení editoru PSPad Nastavte příponu *.eas pro VBScript přes menu položky: Nastavení -> Nastavení zvýrazňovačů -> vybrat VBScript -> záložka Upřesnění a poté přidejte masku souboru *.eas pod *.vbs, viz obrázek 6 Nastavení přípony *.eas pro VBScript. obrázek 6 Nastavení přípony *.eas pro VBScript strana 12