1. fejezet - Kezdeti lépések

Tartalom

Fejlesztői környezet
A keretrendszer letöltése
Hasznos eszközök
Bővítőmodulok hozzákapcsolása
Szerkezeti áttekintés
Könyvtárak
Fájlok
Alapmodulok
Előtétprogram kezelés
Előtétprogram modulok
CMD előtétprogram
Általános felület modulok
Általános felület meghívó modulok
Általános felület leképező modulok
Általános felület műveleti modulok
Általános felület átviteli modulok
Ütemező feladatkezelő modulok
Adatbázis

Kivonat

Az OTRS egy többplatformos webes alkalmazás-keretrendszer, amelyet eredetileg hibajegyrendszernek fejlesztettek. Különböző webkiszolgálókat és adatbázisokat támogat.

Ez a kézikönyv azt mutatja be, hogy hogyan fejleszthet saját OTRS modulokat és alkalmazásokat az OTRS stílus útmutatók alapján.

Fejlesztői környezet

Az OTRS bővítőmodulok írásának megkönnyítéséhez egy fejlesztői környezet létrehozása szükséges. Az OTRS és a további nyilvános modulok forráskódja megtalálható a githubon.

A keretrendszer letöltése

Először is létre kell hozni egy könyvtárat, amelyben eltárolhatók a modulok. Ezután lépje be az új könyvtárba a parancssor használatával, és töltse le azokat a következő parancs használatával:

# a git master ágnál
shell> git clone git@github.com:OTRS/otrs.git -b master
# egy adott ágnál, például OTRS 3.3
shell> git clone git@github.com:OTRS/otrs.git -b rel-3_3
            

Töltse le a module-tools modult is (a githubról) a fejlesztői környezetéhez. Ez számos hasznos eszközt tartalmaz:

shell> git clone git@github.com:OTRS/module-tools.git
            

Állítsa be az OTRS rendszert az adminisztrációs kézikönyvben olvasható telepítési utasítások szerint.

Hasznos eszközök

Létezik két modul, amely erősen ajánlott az OTRS fejlesztésnél: OTRSCodePolicy és Fred.

Az OTRSCodePolicy egy kódolási minőségellenőrző, amely kikényszeríti a közös kódolási szabványok használatát az OTRS fejlesztőcsapatnál is. Erősen ajánlott ennek használata, ha hozzájárulásokat tervez készíteni. Használhatja önálló tesztelő parancsfájlként, vagy akár regisztrálhatja egy olyan git véglegesítés horogként, amely minden alkalommal lefut, amikor egy véglegesítést készít. A részletekért nézze meg a modul dokumentációját.

A Fred egy kicsi fejlesztést segítő modul, amelyet ténylegesen telepíthet vagy hozzákapcsolhat (a lent leírt módon) a fejlesztői rendszeréhez. Számos hasznos modult szerepeltet, amelyet bekapcsolhat, mint például egy SQL naplózóként vagy egy szabványos hibakimenet konzolként. Néhány további részletet találhat a modul dokumentációjában.

Mellesleg ezek az eszközök szintén nyílt forrásúak, és nagyon örülnénk bármilyen továbbfejlesztésnek, amellyel hozzájárul.

Bővítőmodulok hozzákapcsolása

Egyértelmű szétválasztás szükséges az OTRS és a modulok között a megfelelő fejlesztéshez. Különösen egy git klón használatakor kritikus az egyértelmű szétválasztás. Annak érdekében, hogy megkönnyítse az OTRS-nek a fájlokhoz történő hozzáférést, linkeket kell létrehozni. Ez megtehető a könyvtármodul eszközök tárolójában lévő parancsfájllal. Példa: a Naptár modul hozzákapcsolása:

shell> ~/src/module-tools/link.pl ~/src/Calendar/ ~/src/otrs/
            

Amikor új fájlok kerülnek hozzáadásara, akkor azokat a fent bemutatott módon kell hozzákapcsolni.

Amint a hozzákapcsolás befejeződött, újra kell építeni a rendszerbeállításokat a modul regisztrálásához az OTRS-be. A további SQL vagy Perl-kódot is végre kell hajtani a modulból. Példa:

shell> ~/src/otrs/bin/otrs.Console.pl Maint::Config::Rebuild
shell> ~/src/module-tools/DatabaseInstall.pl -m Calendar.sopm -a install
shell> ~/src/module-tools/CodeInstall.pl -m Calendar.sopm -a install
            

A kapcsolatoknak az OTRS-ből történő eltávolításához adja ki a következő parancsot:

shell> ~/src/module-tools/remove_links.pl ~/src/otrs/