Parser Routingu

Instrukcja uytkownika, Dokumentacja Parsera Routingu

Niniejszy dokument zawiera dokumentacj dotyczc Parsera Routingu. Wyjaniony zostaje sposb konfiguracji programu. Dokument jest poufny, do wgldu tylko osobom do tego uprawnionym.
Przygotowano dla: Autor: Wersja programu Data ostatniej modyfikacji Ilo stron:

4studio sp. z o.o.

Pawe Suchodolski 1.0.0.0 5.08.2011 4

Spis treci
Sposb dziaania programu..................................................................................................................3 1. Konfiguracja programu....................................................................................................................3 1.1 Zmienna rodowiskowa STUDIO..........................................................................................3 1.2 Konfiguracja pliku app.config...................................................................................................4 1.2.1 Domylny profil mapowania..............................................................................................4 1.2.2 Spersonalizowany profil mapowania.................................................................................4 1.3 Zmiany w projekcie...................................................................................................................4

Sposb dziaania programu

Program w sposb automatyczny na podstawie pliku Global.asax generuje klas UrlExtensionHelper. Typy parametrw uywanych w Global.asax s rozpoznawane na podstawie przyjtych konwencji nazewniczych, okrelanych w pliku konfiguracyjnym app.config.

1. Konfiguracja programu
1.1 Zmienna rodowiskowa STUDIO
Przed pierwszym uruchomieniem programu naley doda do systemu operacyjnego zmienn rodowiskow o nazwie STUDIO zawierajc ciek do katalogu z solucj Studio.sln programu Visual Studio. Aby dowiedzie si w jaki sposb doda now zmienn rodowiskow odwied link http://support.microsoft.com/kb/310519/pl. Rys. 1.1 Pokazuje poprawne utworzenie zmiennej rodowiskowej STUDIO. Po jej dodaniu moe by potrzebne ponowne uruchomienie programu Visual Studio.

Rys. 1.1

1.2 Konfiguracja pliku app.config 1.2.1 Domylny profil mapowania

Domylny sposb konfiguracji powinien wystarczy na poprawn prac programu. Jeli nie chcemy zdefiniowa wasnego profilu parsowania, zostanie uyty profil domylny o nazwie Ogolny. Uywanie profilu oglnego zakada stosowanie si do pewnej konwencji nazewnictwa parametrw przekazywanych w pliku Global.asax. Konwencja ta polega na wprowadzeniu do nazwy parametrw przedrostka bdcego trzema pierwszymi literami z nazwy typu tego parametru. Przykadowo dla zmiennej typu string o nazwie NazwaModulu dodajemy przedrostek str otrzymujc strNazwaModulu. Dziki uyciu przedrostka bdzie mozliwe deterministyczne okrelenie typu zmiennej i jej poprawne wygenerowanie w klasie wynikowej UrlExtensionHelper. Ta nazewnicza konwencja ma swoj reprezentacj w pliku konfiguracyjnym app.config. Listing 1.1 pokazuje notacj tej konwencji nazewniczej na przykadzie typu zmiennej string Waciwo Projekt okrela nazw projektu, dla ktrego uywana jest dana konwencja. Waciwo typ okrela typ zmiennej, ktrej dotyczy konwencja. Waciwo wzorzec okrela wzorzec zapisany jako wyraenie regularne, wg ktrego typ zmiennej jest rozpoznawany.
<add projekt="Ogolny" typ="string" wzorzec="^str.*"/>

Listing 1.1

1.2.2 Spersonalizowany profil mapowania

W przypadku, kiedy nie chcemy korzysta z domylnego profilu mapowania typu zmiennych moemy stworzy swj wasny dla konkretnego projektu. Listing 1.2 pokazuje sposb skonfigurowania mapowania dla typw zmiennych String, dla konkretnego projektu (W tym przypadku dla projektu Dentico). Jak wida po waciwoci wzorzec wszystkie parametry zaczynajce si od czonu nazwa, oraz wszystkie parametry nazwane returnUrl zostan zakwalifikowane jako parametry typu string.
<add projekt="Dentico" typ="string" wzorzec="^nazwa.*;returnUrl/>

Listing 1.2

1.3 Zmiany w projekcie

We waciwociach projektu w sekcji Build events w polu Pre-build event naley doda polecenie:
"$(STUDIO)\Studio.Aplikacje\ParserRoutingu\bin\Release\ParserRoutingu.exe" "$(SolutionName)" "$(SolutionDir)$ (ProjectName)/" "$(ProjectDir)Helper\UrlExtensionHelper.designer.cs"

Dziki niej, za kadym razem gdy projekt zostanie zbudowany, wygeneruje si plik UrlExtensionHelper.designer.cs. Naley doda go do projektu, w tej samej lokalizacji, w ktrej dodany zosta plik UrlExtensionHelper.cs. Klas UrlExtensionHelper, naley oznaczy jako partial.