OTRS Developer Manual Kiadás 7.0 OTRS AG júl. 08, 2020 Tartalom 1 Kezdeti lépések 3 1.1 Fejlesztői környezet ......................................... 3 1.1.1 A keretrendszer letöltése .................................. 3 1.1.2 Hasznos eszközök ..................................... 4 1.1.3 Bővítőmodulok hozzákapcsolása ............................. 4 1.2 Szerkezeti áttekintés ........................................ 4 1.2.1 Könyvtárak ......................................... 7 1.2.2 Fájlok ............................................ 7 1.2.3 Alapmodulok ........................................ 7 1.2.4 Előtétprogram kezelés ................................... 8 1.2.5 Előtétprogram-modulok .................................. 8 1.2.6 Parancssori előtétprogram ................................. 8 1.2.7 Általános felület modulok ................................. 8 1.2.8 Ütemező feladatkezelő modulok .............................. 10 1.2.9 Adatbázis .......................................... 10 2 OTRS belsőségek - hogyan működik 11 2.1 Beállítási mechanizmus ....................................... 11 2.1.1 Defaults.pm: az OTRS alapértelmezett beállításai .................. 11 2.1.2 Automatikusan előállított beállítófájlok .......................... 11 2.1.3 XML beállítófájlok ...................................... 11 2.1.4 Hozzáférés a beállítási lehetőségekhez futási időben .................. 21 2.2 Adatbázis mechanizmus ...................................... 21 2.2.1 SQL ............................................. 21 2.2.2 XML ............................................. 22 2.2.3 Adatbázis-meghajtók .................................... 25 2.2.4 Támogatott adatbázisok .................................. 25 2.3 Naplózó mechanizmus ....................................... 25 2.3.1 Rendszernapló ....................................... 25 2.3.2 Kommunikációs napló ................................... 26 2.4 Dátum és idő ............................................. 29 2.4.1 Bevezetés .......................................... 29 2.4.2 Egy DateTime objektum létrehozása .......................... 29 2.4.3 Időzónák ........................................... 29 2.4.4 Metódus összefoglaló ................................... 30 2.4.5 Elavult Kernel::System::Time csomag ....................... 31 i 2.5 Felszínek ............................................... 31 2.5.1 Felszín alapok ....................................... 31 2.5.2 Hogyan töltődnek be a felszínek .............................. 32 2.5.3 Új felszín létrehozása ................................... 33 2.6 A CSS és JavaScript betöltő .................................... 35 2.6.1 Hogyan működik ...................................... 35 2.6.2 Alapvető működés ..................................... 36 2.6.3 A betöltő beállítása: JavaScript .............................. 37 2.6.4 A betöltő beállítása: CSS ................................. 39 2.7 Sablonozó mechanizmus ...................................... 39 2.7.1 Sablonparancsok ...................................... 39 2.7.2 Egy sablonfájl használata ................................. 47 2.8 Saját témák létrehozása ...................................... 47 2.9 Honosítási és fordítási mechanizmus ............................... 47 2.9.1 Lefordítható szövegek megjelölése a forrásfájlokban .................. 48 2.9.2 Lefordítható szövegek összegyűjtése a fordítási adatbázisba ............. 48 2.9.3 Maga a fordítási folyamat ................................. 50 2.9.4 A lefordított adatok használata a kódból ......................... 50 3 Hogyan bővíthető az OTRS 51 3.1 Egy új OTRS előtétprogram-modul írása ............................. 51 3.1.1 Mit szeretnénk írni ..................................... 51 3.1.2 Alapértelmezett beállítófájl ................................. 51 3.1.3 Előtétprogram-modul .................................... 53 3.1.4 Alapmodul .......................................... 54 3.1.5 Sablonfájl .......................................... 56 3.1.6 Nyelvi fájl .......................................... 56 3.1.7 Összefoglaló ........................................ 57 3.2 Egy új OTRS előtétprogram összetevő írása ........................... 57 3.2.1 A cél ............................................. 57 3.2.2 A csontváz parancs használata .............................. 57 3.2.3 Az útvonal beállítása .................................... 58 3.2.4 Összetevő sablon kód ................................... 59 3.2.5 Összetevő alapkódja .................................... 60 3.2.6 Összetevő stílus kód .................................... 60 3.2.7 Paraméterek átadása az útvonal összetevőnek ..................... 61 3.2.8 Összetevőmappák ..................................... 61 3.2.9 További gyártók moduljainak csomagolása ........................ 62 3.3 Az OTRS modulrétegek erejének használata ........................... 64 3.3.1 Ügyintézői hitelesítő modul ................................ 65 3.3.2 Hitelesítés szinkronizációs modul ............................. 68 3.3.3 Ügyfél hitelesítő modul ................................... 70 3.3.4 Ügyfél-felhasználó beállítások modul ........................... 73 3.3.5 Várólista beállítások modul ................................ 77 3.3.6 Szolgáltatás beállítások modul .............................. 79 3.3.7 SLA beállítások modul ................................... 82 3.3.8 Naplózás modul ....................................... 85 3.3.9 Kimenetszűrő ........................................ 88 3.3.10 Statisztikák modul ..................................... 90 3.3.11 Jegyszám előállító modulok ................................ 108 3.3.12 Jegyesemény modul .................................... 109 3.3.13 Vezérlőpult modul ...................................... 111 3.3.14 Értesítési modul ....................................... 115 3.3.15 Jegymenü modul ...................................... 118 ii 3.3.16 Hálózati átvitel ....................................... 121 3.3.17 Leképezés .......................................... 126 3.3.18 Meghívó ........................................... 131 3.3.19 Művelet ........................................... 135 3.3.20 OTRS démon ........................................ 146 3.3.21 OTRS ütemező ....................................... 150 3.3.22 Áttekintés .......................................... 153 3.3.23 Dinamikus mezők keretrendszer ............................. 153 3.3.24 Dinamikus mező kölcsönhatása az előtétprogram-modulokkal ............. 156 3.3.25 Hogyan lehet kiterjeszteni a dinamikus mezőket ..................... 158 3.3.26 Egy új dinamikus mező létrehozása ............................ 159 3.3.27 Egy dinamikus mező funkcionalitás kiterjesztés létrehozása .............. 185 3.3.28 Jegy levelezési modul ................................... 190 3.3.29 Folyamatkezelés ...................................... 193 4 Hogyan tehetők közzé az OTRS kiterjesztések 203 4.1 Csomagkezelés ........................................... 203 4.1.1 Csomagterjesztés ..................................... 203 4.1.2 Csomagparancsok ..................................... 203 4.2 Csomagkészítés ........................................... 204 4.2.1 Csomagspecifikációs fájl .................................. 204 4.2.2 Példa .sopm ......................................... 210 4.2.3 Csomagösszeállítás .................................... 211 4.2.4 Csomagéletciklus ...................................... 211 4.3 Csomagátírás ............................................ 211 4.3.1 A munkamenetek mindig igénylik a sütiket ........................ 211 4.3.2 A groups tábla átnevezésre került ............................ 212 4.3.3 Új külső felület ....................................... 212 4.3.4 Változtatások a folyamatkezelésben ........................... 212 4.3.5 Változtatások a LayoutObject objektumban ...................... 213 5 Dokumentáció 215 5.1 Dokumentációs infrastruktúra .................................... 215 5.2 reStructuredText alapozó ...................................... 215 5.2.1 Címsorok .......................................... 216 5.2.2 Bekezdések ......................................... 216 5.2.3 Sorközi jelölők ....................................... 217 5.2.4 Listák ............................................ 217 5.2.5 Szó szerinti blokkok .................................... 217 5.2.6 Táblázatok .......................................... 218 5.2.7 Hiperhivatkozások ..................................... 218 5.2.8 Képek ............................................ 219 5.2.9 Színes dobozok ....................................... 219 5.3 Stílus irányelvek ........................................... 220 5.3.1 Tartalom írása ........................................ 220 5.3.2 Képernyőképek ....................................... 220 5.3.3 Nagybetűs írás a dokumentációban ............................ 223 5.3.4 Gombok és képernyőnevek ................................ 223 5.3.5 Fogalmazás ......................................... 224 5.3.6 Változónevek ........................................ 224 5.4 A dokumentáció fordítása ...................................... 224 6 Közreműködés az OTRS-ben 227 6.1 Hozzájárulások küldése ....................................... 227 iii 6.2 Fordítás ................................................ 228 6.3 Kódolási stílus irányelvek ...................................... 228 6.3.1 Perl ............................................. 228 6.3.2 JavaScript .......................................... 241 6.3.3 HTML ...........................................