Webszolgáltatások

OTRS mint szolgáltató

Távoli kérés:

1. HTTP-kérés

   • Az OTRS fogadja a HTTP-kérést és továbbadja a rétegeken keresztül.

   • A szolgáltató modul felelős ezen tevékenységek végrehajtásáért és vezérléséért.

2. Hálózati átvitel

   • A hálózati átvitel modul dekódolja az adat hasznos terhét, és elválasztja a művelet nevét az adat többi részétől.

   • A művelet neve és a művelet adatai visszakerülnek a szolgáltatóhoz.

3. Külső adatok

   • Az adatok, ahogy a távoli rendszer elküldte (ez nem egy modul alapú réteg).

4. Leképezés

   • Az adatok átalakításra kerülnek a külső rendszer formátumáról az OTRS belső formátumára, ahogy a leképezési beállításban meg van adva ennél a műveletnél (leképezés a bejövő kérés adataihoz).

   • A már átalakított adatok visszakerülnek a szolgáltatóhoz.

5. Belső adatok

   • Az adatok, ahogy át lettek alakítva és elő lettek készítve a műveletnek való átadáshoz (ez nem egy modul alapú réteg).

6. Művelet

   • Fogadja és ellenőrzi az adatokat.

   • Felhasználói hozzáférés-vezérlést hajt végre.

   • Végrehajtja a műveletet.

OTRS-válasz:

1. Művelet

   • Visszaadja az eredmény adatait a szolgáltatónak.

2. Belső adatok

   • Az adatok, ahogy visszaadásra kerültek a műveletből.

3. Leképezés

   • Az adatok visszaalakításra kerülnek a távoli rendszer formátumára, ahogy a leképezési beállításban meg van adva (leképezés a kimenő válasz adataihoz).

   • A már átalakított adatok visszakerülnek a szolgáltatóhoz.

4. Külső adatok

   • Az adatok, ahogy át lettek alakítva és elő lettek készítve a hálózati átvitelhez való átadáshoz válaszként.

5. Hálózati átvitel

   • Fogadja a már a távoli rendszer formátumában lévő adatokat.

   • Felépít egy érvényes választ ehhez a hálózati átviteltípushoz.

6. HTTP-válasz

   • A válasz visszaküldésre kerül a webszolgáltatás kliensének.

   • Egy hiba esetén hibaválasz kerül elküldésre a távoli rendszernek (például SOAP-hiba, HTTP-hiba, stb.).

OTRS mint kérelmező

OTRS-kérés:

1. Esemény-aktiváló kezelő

   • A webszolgáltatás beállítása alapján meghatározza, hogy a kérés szinkron vagy aszinkron lesz-e.

     • Szinkron

       • Egy közvetlen hívás készül a kérelmezőhöz azért, hogy létrehozzon egy új kérést és továbbadja a rétegeken keresztül.

     • Aszinkron

       • Egy új általános felület (kérelmező) feladat létrehozása az OTRS démonhoz (a kérés végrehajtását az ütemező démonra delegálva a felhasználói élmény erősen növelhető, egyébként a kérés előkészítéséhez szükséges összes idő és a távoli végrehajtás hozzáadásra kerül az OTRS eseményekhez, amely aktiválja azokat a kéréseket).

       • A következő ciklusában az OTRS démonfolyamat beolvassa az új feladatot, és létrehoz egy hívást a kérelmezőhöz, amely létre fog hozni egy új kérést, és azután továbbadja azt a rétegeken keresztül.

2. Meghívó

   • Fogadja az adatokat az eseményből.

   • Ellenőrzi a fogadott adatokat (ha szükséges).

   • Meghívja a központi modulokat az adatok kiegészítéséhez (ha szükséges).

   • Visszaadja a kért adatszerkezetet, vagy egy kommunikáció leállítása jelet küld a kérelmezőnek a kérés elegáns megszakításához.

3. Belső adatok

   • Az adatok, ahogy a meghívó átadta (ez nem egy modul alapú réteg).

4. Leképezés

   • Az adatok átalakításra kerülnek a távoli rendszer formátumára, ahogy a leképezési beállításban meg van adva (leképezés a kimenő válasz adataihoz).

   • A már átalakított adatok visszakerülnek a kérelmezőhöz.

5. Külső adatok

   • Az adatok, ahogy át lettek alakítva és elő lettek készítve a távoli rendszernek való küldéshez.

6. Hálózati átvitel

   • Fogadja a távoli művelet nevét és a már a távoli rendszer formátumára átalakított adatokat a kérelmezőtől.

   • Felépít egy érvényes kérést a hálózati átvitelhez.

   • Elküldi a kérést a távoli rendszernek, és várakozik a válaszra.

Távoli válasz:

1. Hálózati átvitel

   • Fogadja a választ és dekódolja az adat hasznos terhét.

   • Visszaadja az adatokat a kérelmezőnek.

2. Külső adatok

   • Az adatok, ahogy a távoli rendszerről érkeztek.

3. Leképezés

   • Az adatok átalakításra kerülnek a külső rendszer formátumáról az OTRS belső formátumára, ahogy a leképezési beállításban meg van adva ennél a műveletnél (leképezés a bejövő válasz adataihoz).

   • A már átalakított adatok visszakerülnek a kérelmezőhöz.

4. Belső adatok

   • Az adatok, ahogy át lettek alakítva és elkészültek visszaadásra a kérelmezőnek.

5. Meghívó

   • Fogadja a visszaadott adatokat.

   • Kezeli az adatokat, ahogy minden egyes meghívónál speciálisan szükséges (beleértve a hibakezelést, ha van).

   • Visszaadja a meghívó eredményét és adatait a kérelmezőnek.

6. Eseménykezelő vagy OTRS démon

   • Fogadja az adatokat a kérelmezőtől. Az OTRS démon esetében ezek az adatok információkat tartalmazhatnak egy feladat jövőbeli létrehozásához.

OTRS mint szolgáltató – HTTP::REST

A beállítás egy kissé bonyolultabb lehet, mivel az dinamikusan nő minden beállított műveletnél az egyes műveletekhez való útvonal-leképezésnek és az egyes műveletekhez való érvényes kérési módszereknek az alapértelmezett átviteli beállításokhoz való hozzáadásával.

A következő beállítások akkor érhetők el, ha hozzáadja vagy szerkeszti ezt az erőforrást. A csillaggal jelölt mezők kitöltése kötelező.

Útvonal leképezés a művelethez: „<MűveletNeve>” *

Meghatározza azt az útvonalat, amelyet ehhez a művelethez kellene leképezni. A kettősponttal : megjelölt változók a megadott névhez lesznek leképezve, és a többivel együtt kerülnek átadásra a leképezéshez (például /Ticket/:TicketID).

Ebben a beállításban egy erőforrás útvonala van beállítva. Ezt az útvonalat a webszolgáltatás igényei szerint kell meghatározni, figyelembe véve hogy az útvonal a HTTP kérési módszerrel együtt határozza meg a végrehajtandó általános felületi műveletet.

Az útvonal tartalmazhat változókat :<Változónév> formájában. Minden útvonalszöveg, amely megfelel a változónév pozícióján, hozzá lesz adva a kérés hasznos terhéhez az ebben a beállításban meghatározott változónév használatával. Példák:

Érvényes kérések a /Resource útvonal-leképezéshez:

https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource?Param1=One

Érvénytelen kérések a /Resource útvonal-leképezéshez:

https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherResource
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherResource?Param1=One

Érvényes kérések a /Resource:ID útvonal-leképezéshez:

https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/1
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/1?Param1=One

Mindkét esetben az ID = 1 lesz elküldve a műveletnek a hasznos teher részeként. A második esetben a Param1 = One is hozzá lesz adva. A HTTP kérési módszertől függően egyéb paraméterek is hozzá lesznek adva, ha azok JSON szövegként érkeznek a kérés fejlécében.

Érvénytelen kérések a /Resource:ID útvonal-leképezéshez:

https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource?Param1=One

Érvényes kérések a /Resource/OtherResource/:ID/:Color útvonal-leképezéshez:

https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherResource/1/Red
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherReosurce/123/Blue?Param1=One

Az első példában ID = 1 és Color = Red, míg a másodikban ID = 123 és Color = Blue.

Érvénytelen kérések a /Resource/OtherResource/:ID/:Color útvonal-leképezéshez:

https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/1
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherResource/1
https://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherResource/1?Param1=One

Az első példában a /OtherResource útvonal része, valamint a :Color változó hiányzik. A második példában csak a :Color változó hiányzik.

Érvényes kérési módszerek a művelethez: „<MűveletNeve>”

Ezen művelet korlátozása a megadott kérési módszerekre. Ha nincs módszer kiválasztva, akkor minden kérés el lesz fogadva.

A HTTP kérési módszerek az útvonal leképezéssel együtt használandó művelet meghatározásához. Lehetséges lehetőségek: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT és TRACE.

Teljesen különböző műveletek is megoszthatják pontosan ugyanazt a leképezési útvonalat, de a kérési módszernek egyedinek kell lennie minden egyes műveletnél azért, hogy minden kérésnél helyesen meghatározható legyen a használandó művelet.

Legnagyobb üzenethossz *

Megadja a REST üzenetek legnagyobb méretét (bájtban), amelyeket az OTRS fel fog dolgozni.

Életben tartás küldése *

Ez a beállítás azt határozza meg, hogy a bejövő kapcsolatok le legyenek-e zárva vagy maradjanak életben.

További válaszfejlécek (összes művelet)

Adott esetben meghatározhat további válaszfejléceket is az összes művelethez. Ezek használhatók az egyes válaszokhoz történő statikus fejlécértékek hozzáadásához. Egyszerűen kattintson a Fejléc hozzáadása gombra, és töltse ki mind a fejléc, mind az érték mezőket. Nincs korlát a további fejlécsorok számára vonatkozóan.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

További válaszfejlécek (műveletre jellemző)

Ezek a fejlécek a kiválasztott művelethez tartozó válaszokban lesznek beállítva. A beállítás célja ugyanaz, mint a fentiekben.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

OTRS mint szolgáltató – HTTP::SOAP

Nagyon egyszerű a HTTP::SOAP protokoll szolgáltatóként történő beállítása.

A következő beállítások akkor érhetők el, ha hozzáadja vagy szerkeszti ezt az erőforrást. A csillaggal jelölt mezők kitöltése kötelező.

SOAP-művelet ellenőrzése *

Állítsa Igen értékre a fogadott SOAPAction fejléc ellenőrzéséhez (ha nem üres). Állítsa Nem értékre a fogadott SOAPAction fejléc figyelmen kívül hagyásához.

SOAP-művelet séma *

Válassza ki, hogy a SOAPAction fejlécet hogyan kell felépíteni. Néhány webszolgáltatás különleges szerkezetet küld.

SOAP-művelet elválasztó *

Az elválasztóként használt karakter a névtér és a SOAP-művelet között. Általában a .Net webszolgáltatások / karaktert használnak elválasztóként.

Névtér *

URI egy környezethez való SOAP metódusok adásához csökkentve a kétértelműséget.

Kérés névséma *

Válassza ki, hogy a SOAP-kérés függvénycsomagolót hogyan kell felépíteni. A FunctionName példaként van használva az aktuális meghívó vagy művelet nevénél. A FreeText példaként van használva az aktuális beállított értéknél.

Válasz névséma *

Válassza ki, hogy a SOAP-válasz függvénycsomagolót hogyan kell felépíteni. A FunctionName példaként van használva az aktuális meghívó vagy művelet nevénél. A FreeText példaként van használva az aktuális beállított értéknél.

Legnagyobb üzenethossz *

Megadja a SOAP üzenetek legnagyobb méretét (bájtban), amelyeket az OTRS fel fog dolgozni.

További válaszfejlécek (összes művelet)

Adott esetben meghatározhat további válaszfejléceket is az összes művelethez. Ezek használhatók az egyes válaszokhoz történő statikus fejlécértékek hozzáadásához. Egyszerűen kattintson a Fejléc hozzáadása gombra, és töltse ki mind a fejléc, mind az érték mezőket. Nincs korlát a további fejlécsorok számára vonatkozóan.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

További válaszfejlécek (műveletre jellemző)

Ezek a fejlécek a kiválasztott művelethez tartozó válaszokban lesznek beállítva. A beállítás célja ugyanaz, mint a fentiekben.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

További válasz SOAP-névterek (összes művelet)

Ezek a névterek lesznek használva minden válaszban.

További válasz SOAP-névterek (műveletre jellemző)

Ezek a névterek lesznek használva ennek a bizonyos műveletnek a válaszaiban.

Rendezési beállítások

Kimenő rendezési sorrend az XML-mezőknél (a szerkezet a függvénynév csomagoló alatt indul) – nézze meg a SOAP-átvitel dokumentációját.

Webszolgáltatás művelete

Azokat a tevékenységeket, amelyeket akkor lehet végrehajtani, amikor az OTRS-t szolgáltatóként használja, művelteknek hívják. Minden művelet egy vezérlőhöz tartozik. A vezérlők műveletek vagy meghívók gyűjteményei. Normális esetben az azonos vezérlőtől származó műveleteknek hasonló beállításokra van szükségük, és ugyanazon a beállítási párbeszédablakon osztoznak. Azonban az egyes műveleteknek lehetnek független beállítási párbeszédablakaik is, ha szükséges.

A következő beállítások akkor érhetők el, ha hozzáadja vagy szerkeszti ezt az erőforrást. A csillaggal jelölt mezők kitöltése kötelező.

Név *

Ennek az erőforrásnak a neve. Bármilyen típusú karakter beírható ebbe a mezőbe, beleértve a nagybetűket és a szóközt is. A név megjelenik az áttekintő táblázatban.

Leírás

Adjon további információkat ehhez az erőforráshoz. Mindig ajánlott egy teljes mondattal kitölteni ezt a mezőt az erőforrás leírásaként a jobb érthetőségért, mert a leírás is megjelenik az áttekintő táblázatban.

Műveleti háttérprogram

Ez az OTRS műveleti háttérprogram-modul lesz belsőleg meghívva a kérés feldolgozásához, és az adat előállításához a válasz számára.

A művelet háttérprogramja előre ki van töltve és nem szerkeszthető. Akkor fogja látni ezt a paramétert, amikor kiválasztja a műveletet a webszolgáltatás szerkesztési képernyőjén. Ez a mező csak tájékoztató.

Leképezés a bejövő kérés adataihoz

Ez a leképezés fogja a kérés adatait feldolgozni olyan formára alakítva át azokat, ahogy az OTRS várja.

Leképezés a kimenő válasz adataihoz

Ez a leképezés fogja a válasz adatait feldolgozni olyan formára alakítva át azokat, ahogy a távoli rendszer várja.

Jegyadatok felvétele

Tartalmazza-e a válasz a jegyadatokat vagy sem.

A leképezések azok a mezők, amelyek normális esetben minden egyes műveletnél megjelennek, de egyéb speciális mezők jelenhetnek meg a nem alapértelmezett beállítási párbeszédablakokban, hogy teljesítsék a művelet különleges szükségleteit.

Normális esetben két leképezés-beállítási szakasz van minden egyes műveletnél: egy a bejövő adatokhoz, és egy másik a kimenő adatokhoz. Különböző leképezési típusokat (háttérprogramokat) választhat minden egyes leképezési irányhoz, mivel a beállításaik függetlenek egymástól, valamint függetlenek a művelet háttérprogramjától is. A normál és leggyakoribb gyakorlat az, hogy a művelet ugyanazt a leképezési típust használja mindkét esetben (fordított beállítással). A teljes leképezési beállítás külön képernyőn végezhető el, amely a leképezési típustól függ.

A képernyő bal oldalán lévő művelet oszlopban lehetőség van a webszolgáltatáshoz való visszatérésre (az összes változtatás eldobása a legutóbbi mentés óta) és a törlésre. Ha az utóbbira kattint, akkor egy párbeszédablak fog megnyílni, és azt fogja kérdezni, hogy el szeretné-e távolítani a műveletet. Kattintson a Törlés gombra a művelet és annak beállításai eltávolításának megerősítéséhez, vagy kattintson a Mégse gombra a törlés párbeszédablak bezárásához.

Általános objektum-összekapcsolási meghívó

Ezenkívül a konfigurációelem funkcionalitáshoz a Generic::LinkObject meghívó az objektumok összekapcsolásának funkcionalitását is biztosítja, mint például egy jegyet konfigurációelemekhez vagy konfigurációelemeket más konfigurációelemekhez való kapcsolást. A meghívó használható egy távoli rendszerből származó új kapcsolatok lekéréséhez, vagy a megadott kapcsolatok szinkronban tartásához és az OTRS adatbázisából eltávolított kapcsolatok törléséhez. Nincsenek korlátok a különböző objektumok összekapcsolásában.

Különböző objektumok egymáshoz kapcsolásához a következő leképezési kulcsokhoz szükségesek értékek:

- SourceClass
- SourceObject
- TargetClass
- TargetObject
- Type

Az OTRS belső objektum-azonosítója megadható közvetlenül a SourceKey és a TargetKey kulcsokkal, vagy kikereshető az OTRS objektumszámok alapján a SourceNumber és a TargetNumber kulcsokkal.

Ahhoz, hogy az OTRS szinkronban maradjon a távoli rendszerrel, lehetőség van különböző kapcsolatkombinációk kiválasztására, például szülő-gyermek jegyet a jegyhez, hogy szinkronizálva legyenek. Ez azt jelenti, hogy ha egy távoli kapcsolatkombinációt eltávolítottak, akkor a helyi kapcsolat is eltávolításra fog kerülni.

A konfigurációelem-osztályok szinkronizálása korlátozható a meghívó adminisztrátori nézetén lévő listából történő azon osztályok kiválasztásával, amelyeket szinkronizálni kell.

Általános műveletek meghívó

A Generic::Operations meghívó lehetővé teszi Szakaszok meghatározását, ahol a szakaszként meghatározott egyes leképezések egymás után kerülnek végrehajtásra. Az egyik szakasz kimenete lesz a következő szakasz bemenete.

A következő beállítások akkor érhetők el, ha hozzáadja vagy szerkeszti ezt az erőforrást. A csillaggal jelölt mezők kitöltése kötelező.

Név *

Ennek az erőforrásnak a neve. Bármilyen típusú karakter beírható ebbe a mezőbe, beleértve a nagybetűket és a szóközt is. A név megjelenik az áttekintő táblázatban.

Leírás

Adjon további információkat ehhez az erőforráshoz. Mindig ajánlott egy teljes mondattal kitölteni ezt a mezőt az erőforrás leírásaként a jobb érthetőségért, mert a leírás is megjelenik az áttekintő táblázatban.

Műveleti háttérprogram

Ez az OTRS műveleti háttérprogram-modul lesz belsőleg meghívva a kérés feldolgozásához, és az adat előállításához a válasz számára.

A művelet háttérprogramja előre ki van töltve és nem szerkeszthető. Akkor fogja látni ezt a paramétert, amikor kiválasztja a műveletet a webszolgáltatás szerkesztési képernyőjén. Ez a mező csak tájékoztató.

Leképezés a kimenő válasz adataihoz

Ez a leképezés fogja a válasz adatait feldolgozni olyan formára alakítva át azokat, ahogy a távoli rendszer várja.

Leképezés a bejövő kérés adataihoz

Ez a leképezés fogja a kérés adatait feldolgozni olyan formára alakítva át azokat, ahogy az OTRS várja.

Felhasználó a műveletekhez *

A műveletek ezen felhasználó használatával kerülnek feldolgozásra.

Szakaszok

Itt adhatja hozzá a szakaszokat, amelyek egymás után kerülnek feldolgozásra. A Szakasz hozzáadása gombbal annyi szakaszt lehet hozzáadni, amennyi szükséges.

Kattintson a Mentés gombra, hogy az egyes szakaszok mellett megjelenjen egy Beállítás gomb. Itt adhat hozzá XSLT-stíluslapot az egyes szakaszokhoz.

Eseményaktiválók

Ezt a meghívót a beállított események fogják aktiválni.

Eseményaktiváló hozzáadása

Egy új esemény hozzáadásához válassza ki az eseményobjektumot és az eseménynevet, majd kattintson a + gombra.

Konfigurációelem meghívó

Az ITSM::ConfigItem meghívó funkcionalitást nyújt ahhoz, hogy konfigurációelemek listáját lehessen kérni egy távoli rendszerből az általános felülettel. Egy teljes leképezés lehetséges a távoli érték kulcsainak nevei között a helyi konfigurációelem-osztály meghatározásaira. Annak érdekében, hogy lehetőséget adjon az összes osztályattribútum meghatározására a leképezésben, egy speciális leképezés is biztosított.

A távoli konfigurációelemek és kapcsolatok kezeléséhez egy speciális leképezés biztosított ezzel a funkcióval. A funkcionalitás használatához válassza ki az ITSMConfigItem elemet a leképezésválasztó dobozban.

A speciális leképezési funkciók egyike statikus érték. Ez lehetővé teszi statikus értékek meghatározását a megadott kulcsokhoz, például a konfigurációelem-osztály beállítását minden egyes elemnél. Ezek a bejegyzések felülírhatják a távoli rendszertől küldött adatokat.

A speciális leképezés által biztosított másik funkció a karakterláncok átalakítása listaszerkezetekké. Egy karakterláncból való lista létrehozásához egy listaelválasztó határozható meg, mint például a ; karakter. Az elválasztómező olyan reguláris kifejezéseket vesz fel, amelyek összetettebb elválasztókat hoznak létre, mint például a ;(?:\s+)? is lehetséges (egy ; karaktert esetlegesen több üres karakter is követhet).

Lehetőség van annak meghatározására, hogy az elemek indexe hol szerepeljen a konfigurációelem szerkezetében. Ehhez az ###INDEX### helykitöltőt kell elhelyezni a kulcsleképezésben. A képernyőképen lévő beállítás a különálló IP-címlistát egy új csatolóba tárolná el mindegyikhez. Ha nincs index meghatározva a leképezésben, akkor az index növelni fogja a főattribútum számlálóját, mintegy utótagot.

A konfigurációelem Number attribútuma használható a távoli adatok és az OTRS adatbázisában tárolt adatok közti logikai kapcsolat létesítéséhez. Ahhoz, hogy a konfigurációelemeket ennek a meghívónak az értékeivel hozza létre vagy frissítse, a következő kulcsok szükségesek:

- Name
- Class
- Number
- DeploymentState
- IncidentState

Ezen kulcsok értékei (kivéve a Number kulcsot) lehetnek statikusak vagy származhatnak a távoli rendszertől.

Konfigurációelem szinkronizációs meghívó

Az ITSM::ConfigItemSync meghívó egy különleges szinkronizációs meghívóval funkcionalitást biztosít a konfigurációelemek két OTRS példány közti szinkronizálásához. Ez a meghívó lehetővé teszi a szinkronizációk létrehozáshoz, frissítéshez és törléséhez szükséges meghívók meghatározást, amelyek automatikusan meg lesznek hívva, ha szükséges.

Két rendszer közti konfigurációelemek szinkronizálásához az szükséges, hogy hozzáadjanak egy ITSM::ConfigItemSync típusú meghívóval rendelkező webszolgáltatást. Ez a meghívó az alapvető (kereső) meghívó, amelyet a távoli rendszeren történő ITSM objektumkeresések végrehajtásához használnak a módosítandó konfigurációelemek meghatározásához.

Két lépésben működik minden szinkronizációs műveletnél:

1. Először a helyi rendszerben elvégzett változtatástól függően (konfigurációelem hozzáadása, frissítése vagy törlése) a meghívó végrehajtja a kapcsolódó keresést a távoli rendszeren annak meghatározásához, hogy szükség van-e egy távoli konfigurációelem létrehozására, frissítésére vagy törlésére.

2. Második lépésként a létrehozás műveletekhez, a frissítés műveletekhez vagy a törlés műveletekhez kapcsolódó meghívó kerül meghívásra, amely végrehajtja a fő változtatásokat a távoli rendszeren. Azokat a meghívókat is létre kell hozni, és ITSM::ConfigItem típusú meghívóknak kell lenniük annak biztosításához, hogy a kommunikáció megfelelően működjön.

Nézze meg a meghívópéldák alábbi áttekintőjét:

A keresési meghívó beállításán belül a változtatásokat elvégző tényleges meghívókat egyesével kell beállítani minden egyes művelethez a kapcsolódó legördülő menükben.

Ha egy meghívó nincs beállítva a kapcsolódó művelethez, akkor ki lesz hagyva. A beállított meghívó fel lesz sorolva minden egyes legördülő menüben, és egyszerűen kiválasztható a különböző műveletekhez.

A különböző meghívóknak le kell képezniük az adataikat. Ahhoz, hogy ez megfelelően működjön, az ITSMConfigItem leképezőmodul használta javasolt, amely ebben a dokumentációban kerül bemutatásra, de valójában lehetőség van más típusú, mint például XSLT leképezések használatára is, ha helyesen be van állítva.

Mivel ez a szerkezet távoli rendszereket hív meg, legalább a kapcsolat hitelesítési adatait be kell állítani, hogy hozzáférjen a távoli CMDB-hez.

Az összes többi beállítás esetlegesen beállítható, de azok nem szükségesek az alapfunkció működéséhez.

Annak biztosításához, hogy a keresési meghívó csak bizonyos eseményekre figyeljen, ez a funkcionalitás kiterjeszti az OTRS-ből származó meghívóesemény-szűrő funkció lehetőségeit, ami azon eseményaktiválókhoz való további feltételek hozzáadásához használható, amelyek a keresési meghívóhoz vannak beállítva. Egy példa lehet erre, hogy csak a Számítógép ITSM osztály konfigurációelemei legyenek szinkronizálva a távoli rendszerre.

A szinkronizálandó távoli rendszer beállításának nem kell különlegesnek lennie, de biztosítani kell hozzá legalább egy műveletet a keresési végrehajtásokhoz és különálló műveleteket minden egyes olyan szinkronizációs művelethez, amelyet végre kell hajtani.

Jegy meghívó

Ez a funkció a TicketCreate és TicketUpdate meghívók funkcionalitását adja a webszolgáltatásokhoz.

Ezenkívül a csomag követi a HTTP átirányítási válaszokat (301-es, 307-es és 308-as HTTP-kód) a HTTP::REST és a HTTP::SOAP alapú webszolgáltatások kimenő kommunikációjánál.

Továbbá csomag lehetővé teszi az üres törzsű HTTP-kérések küldését (POST, PUT, PATCH) a HTTP::REST alapú webszolgáltatások kimenő kommunikációjánál.

A TicketCreate és TicketUpdate meghívó visszaadja a teljes jegy- és bejegyzésadatokat az aktivált esemény jegyazonosítója és bejegyzés-azonosítója alapján.

Készítse elő a beállított távoli webszolgáltatás meghívását. Az eseményadatok:

my $Result = $InvokerObject->PrepareRequest(
    Data => {                                               # data payload
        TicketID => 123,
        ArticleID => 123,                                   # optional
    },
);

A meghívó eredménye:

{
    Data => {
        Ticket => {
            Title         => 'some ticket title',
            Queue         => 'some queue name',
            Lock          => 'some lock name',              # optional
            Type          => 'some type name',              # optional
            Service       => 'some service name',           # optional
            SLA           => 'some SLA name',               # optional
            State         => 'some state name',
            Priority      => 'some priority name',
            Owner         => 'some user login',             # optional
            Responsible   => 'some user login',             # optional
            CustomerUser  => 'some customer user login',
            PendingTime {       # optional
                Year   => 2011,
                Month  => 12
                Day    => 03,
                Hour   => 23,
                Minute => 05,
            },
        },
        Article => {
            SenderType       => 'some sender type name',    # optional
            AutoResponseType => 'some auto response type',  # optional
            From             => 'some from string',         # optional
            Subject          => 'some subject',
            Body             => 'some body'
            ContentType      => 'some content type',        # ContentType or MimeType and Charset is required
            MimeType         => 'some mime type',
            Charset          => 'some charset',
            TimeUnit         => 123,                        # optional
        },
        DynamicField => [                                   # optional
            {
                Name   => 'some name',
                Value  => 'Value',                          # value type depends on the dynamic field
            },
            # ...
        ],
         Attachment => [
            {
                Content     => 'content'                    # base64 encoded
                ContentType => 'some content type'
                Filename    => 'some fine name'
            },
            # ...
        ],
    },
};

OTRS mint kérelmező – HTTP::REST

A HTTP::REST esetén ez a beállítás is dinamikusan nő a beállított meghívóktól függően. A hitelesítés és az SSL beállítások hasonlóak a HTTP::SOAP szakaszban lévőkhöz.

A következő beállítások akkor érhetők el, ha hozzáadja vagy szerkeszti ezt az erőforrást. A csillaggal jelölt mezők kitöltése kötelező.

Végpont *

Adott helyet jelző távoli rendszer URI egy webszolgáltatáshoz való hozzáféréshez.

Időkorlát *

Időkorlátérték a kérésekhez.

Hitelesítés

Egy választható hitelesítési mechanizmus a távoli rendszer eléréséhez. Válasszon egy hitelesítési mechanizmust a listából, és további mezők fognak megjelenni.

Hitelesítési adatok *

Válasszon egy hitelesítési adatot, amely a Hitelesítési adatok képernyőn lett hozzáadva. Kattintson a Hitelesítési adatok hozzáadása gombra a hitelesítési adatok kezelőképernyőjének megnyitásához.

Hitelesítés-szolgáltató (CA) tanúsítvány

A hitelesítés-szolgáltató tanúsítványfájljának teljes elérési útja és neve, amely hitelesíti az SSL tanúsítványt.

Hitelesítés-szolgáltató (CA) könyvtár

A hitelesítés-szolgáltató könyvtárának teljes elérési útja, ahol a CA tanúsítványok tárolva vannak a fájlrendszeren.

Proxybeállítások használata *

Proxybeállítások megjelenítése vagy elrejtése a távoli rendszerhez való csatlakozáshoz.

Vezérlő leképezés a meghívóhoz: „<MeghívóNeve>” *

Az a vezérlő, amelyhez a meghívónak kéréseket kell küldenie.

A kettősponttal : megjelölt változók az adatok értékével lesznek helyettesítve és a kéréssel együtt kerülnek átadásra. (például /Ticket/:TicketID?UserLogin=:UserLogin&Password=:Password).

Érvényes kérés parancs a meghívóhoz: „<MeghívóNeve>”

A kérésekhez használandó megadott HTTP parancs ezzel a meghívóval (opcionális).

Alapértelmezett parancs

A kéréseknél használandó alapértelmezett HTTP parancs. A lehetséges lehetőségek: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT és TRACE. Ha nincs parancs kiválasztva, akkor az Alapértelmezett parancs lesz használva.

További kérésfejlécek (összes meghívó)

Adott esetben meghatározhat további kérésfejléceket is az összes meghívóhoz. Ezek használhatók az egyes kérésekhez történő statikus fejlécértékek hozzáadásához. Egyszerűen kattintson a Fejléc hozzáadása gombra, és töltse ki mind a fejléc, mind az érték mezőket. Nincs korlát a további fejlécsorok számára vonatkozóan.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

További kérésfejlécek (meghívóra jellemző)

Ezek a fejlécek a kiválasztott meghívóhoz tartozó kérésekben lesznek beállítva. A beállítás célja ugyanaz, mint a fentiekben.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

Ha legalább két meghívó kerül hozzáadásra, a HTTP::REST kérelmező átviteli képernyője két mezővel lesz kiegészítve.

Vezérlő leképezés a meghívóhoz: „<MeghívóNeve>” *

Ebben a beállításban egy erőforrás útvonala van beállítva. Ezt az útvonalat a távoli webszolgáltatás igényei szerint kell meghatározni, és követni kell annak meghatározását.

Az útvonal tartalmazhat változókat :<Változónév> formájában. Minden változónév, amely illeszkedik az (elküldendő) jelenlegi adatokra, ki lesz cserélve a megfelelő adatértékkel. Ezek az illesztett változónevek és értékek el lesznek távolítva a jelenlegi adatokból. A HTTP kérési parancstól függően a megmaradó adatok elküldhetők JSON-szövegként a kérés törzsében, vagy lekérdezési paraméterekként az URI-n belül.

Példák a következő adatokkal: Valtozo1 = Egy, Valtozo2 = Kettő, Valtozo3 = Három és Valtozo4 = Négy.

• Vezérlő leképezés: /Eroforras, helyettesítés után: /Eroforras, megmaradt adatok: Valtozo1 = Egy, Valtozo2 = Kettő, Valtozo3 = Három és Valtozo4 = Négy

• Vezérlő leképezés: /Eroforras:Valtozo1, helyettesítés után: /Eroforras/Egy, megmaradt adatok: Valtozo2 = Kettő, Valtozo3 = Három és Valtozo4 = Négy

• Vezérlő leképezés: /Eroforras:Valtozo1?Parameter1=:Valtozo2&Valtozo3=:Valtozo3, helyettesítés után: /Eroforras/Egy?Parameter1=Kettő&Valtozo3=Három, megmaradt adatok: Valtozo4 = Négy

Érvényes kérés parancs a meghívóhoz: „<MeghívóNeve>”

Ez határozza meg a használandó HTTP kérési módszert. A lehetséges lehetőségek: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT és TRACE. Ha nincs parancs kiválasztva, akkor az Alapértelmezett parancs lesz használva.

OTRS mint kérelmező – HTTP::SOAP

A kérelmező HTTP::SOAP hálózati átvitelénél több beállítandó mező található.

A következő beállítások akkor érhetők el, ha hozzáadja vagy szerkeszti ezt az erőforrást. A csillaggal jelölt mezők kitöltése kötelező.

Végpont *

Adott helyet jelző távoli rendszer URI egy webszolgáltatáshoz való hozzáféréshez.

Időkorlát *

Időkorlátérték a kérésekhez.

SOAP-művelet beállítása *

Állítsa Igen értékre egy kitöltött SOAPAction fejléc küldéséhez. Állítsa Nem értékre egy üres SOAPAction fejléc küldéséhez.

SOAP-művelet séma *

Válassza ki, hogy a SOAPAction fejlécet hogyan kell felépíteni. Néhány webszolgáltatás különleges szerkezetet igényel.

SOAP-művelet elválasztó *

Az elválasztóként használt karakter a névtér és a SOAP-művelet között. Általában a .Net webszolgáltatások / karaktert használnak elválasztóként.

Névtér *

URI egy környezethez való SOAP metódusok adásához csökkentve a kétértelműséget.

Kérés névséma *

Válassza ki, hogy a SOAP-kérés függvénycsomagolót hogyan kell felépíteni. A FunctionName példaként van használva az aktuális meghívó vagy művelet nevénél. A FreeText példaként van használva az aktuális beállított értéknél.

Válasz névséma *

Válassza ki, hogy a SOAP-válasz függvénycsomagolót hogyan kell felépíteni. A FunctionName példaként van használva az aktuális meghívó vagy művelet nevénél. A FreeText példaként van használva az aktuális beállított értéknél.

Kódolás

A SOAP üzenettartalmak karakterkódolása.

Hitelesítés

Egy választható hitelesítési mechanizmus a távoli rendszer eléréséhez. Válasszon egy hitelesítési mechanizmust a listából, és további mezők fognak megjelenni.

Hitelesítési adatok *

Válasszon egy hitelesítési adatot, amely a Hitelesítési adatok képernyőn lett hozzáadva. Kattintson a Hitelesítési adatok hozzáadása gombra a hitelesítési adatok kezelőképernyőjének megnyitásához.

Hitelesítés-szolgáltató (CA) tanúsítvány

A hitelesítés-szolgáltató tanúsítványfájljának teljes elérési útja és neve, amely hitelesíti az SSL tanúsítványt.

Hitelesítés-szolgáltató (CA) könyvtár

A hitelesítés-szolgáltató könyvtárának teljes elérési útja, ahol a CA tanúsítványok tárolva vannak a fájlrendszeren.

Proxybeállítások használata *

Proxybeállítások megjelenítése vagy elrejtése a távoli rendszerhez való csatlakozáshoz.

További kérésfejlécek (összes meghívó)

Adott esetben meghatározhat további kérésfejléceket is az összes meghívóhoz. Ezek a fejlécek lesznek beállítva minden kérésben.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

További kérésfejlécek (meghívóra jellemző)

Ezek a fejlécek a kiválasztott meghívóhoz tartozó kérésekben lesznek beállítva. A beállítás célja ugyanaz, mint a fentiekben.

A : karakterrel megjelölt fejlécérték-változók ki lesznek cserélve a megfelelő adatértékkel (például a :TicketID helyett 1 lesz).

További kérés SOAP-névterek (összes meghívó)

Ezek a névterek lesznek használva minden kérésben.

További kérés SOAP-névterek (meghívóra jellemző)

Ezek a névterek lesznek használva ennek a bizonyos meghívónak a kéréseiben.

Rendezési beállítások

Kimenő rendezési sorrend az XML-mezőknél (a szerkezet a függvénynév csomagoló alatt indul) – nézze meg a SOAP-átvitel dokumentációját.

XSLT-leképezés

XSLT-stíluslap *

Itt adhatja hozzá vagy módosíthatja az XSLT-leképezés kódját.

A szerkesztőmező lehetővé teszi különböző függvények használatát, mint például automatikus formázás, ablakátméretezés, valamint címke- és zárójel-kiegészítés.

Kulcs attribútumának használata

A bejövő adatoknál ez a beállítás határozza meg, hogy az XML-kulcs attribútumai át legyenek-e alakítva Perl adatstruktúrává, vagy figyelmen kívül legyenek hagyva.

Példa: bejövő XML-adatok

<Article>
    <Subject>some subject</Subject>
    <Body>some body</Body>
    <ContentType>text/plain; charset=utf8</ContentType>
    <TimeUnit>1</TimeUnit>
</Article>
<Attachment>
    <Content>someTestData</Content>
    <ContentType>text/plain</ContentType>
    <Filename>test1.txt</Filename>
</Attachment>
<Attachment Content="someTestData" ContentType="text/plain" Filename="test2.txt" />

Az eredményül kapott Perl-adatok a Kulcs attribútumának használata beállítás letiltásával:

$VAR1 = {
    Article => {
        Body => 'some body',
        ContentType => 'text/plain; charset=utf8',
        Subject => 'some subject',
        TimeUnit => '1',
    },
    Attachment => [
        {
            Content => 'someTestData',
            ContentType => 'text/plain',
            Filename => 'test1.txt',
        },
        {},
    ],
};

Az eredményül kapott Perl-adatok a Kulcs attribútumának használata beállítás engedélyezésével:

$VAR1 = {
    Article => {
        Body => 'some body',
        ContentType => 'text/plain; charset=utf8',
        Subject => 'some subject',
        TimeUnit => '1',
    },
    Attachment => [
        {
            Content => 'someTestData',
            ContentType => 'text/plain',
            Filename => 'test1.txt',
        },
        {
            Content => 'someTestData',
            ContentType => 'text/plain',
            Filename => 'test2.txt',
        },
    ],
};

Attribútum beállításai

Ezt a beállítást kell használni ahhoz, hogy kulcs attribútumait a kimenő elemekhez használhassuk. Az első szintű beállítások határozzák meg azokat az elemeket, amelyeknek a kulcs attribútumait meg kell kapniuk. A második szintű beállítások határozzák meg, hogy mely alelemeket kell alakítani attribútumokká és csatolni az azt körülvevő elemhez. Csak a beállítások két szintje lesz figyelembe véve a kulcs attribútumainál. Ezek lesznek használva az XML-szerkezetben lévő elemek bármelyik szintjénél (nem csak az első szinten).

Ne feledje, hogy az attribútum beállításaiban lehetséges az elemek rendezése, de ez nem befolyásolja a kulcs attribútumainak kezelését.

Ha egy elem minden aleleme attribútumokká van átalakítva, és az elem tartalmaz egy bizonyos ContentKey alelemet, akkor ennek az alelemnek a tartalma lesz használva az azt körülvevő elem értékeként. Nézze meg a következő példát ezen lehetőségek illusztrációjaként.

Példa: XSLT-leképezés

<?xml version="1.0" encoding="UTF-8"?>
<xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:date="http://exslt.org/dates-and-times" version="1.0" extension-element-prefixes="date">
        <xsl:template match="RootElement">
        <xsl:copy>
            <header>
                <messageID>someMessageID</messageID>
                <Attachment>
                    <ContentKey>text1.txt</ContentKey>
                    <Content>someValue</Content>
                    <ContentType>text/plain</ContentType>
                </Attachment>
                <Attachment>
                    <Filename>text2.txt</Filename>
                    <Content>someValue</Content>
                    <ContentType>text/plain</ContentType>
                </Attachment>
                <Attachment>
                    <ContentKey>text3.txt</ContentKey>
                    <Content>someValue</Content>
                    <ContentDisposition>inline</ContentDisposition>
                    <ContentType>text/plain</ContentType>
                </Attachment>
            </header>
            <ticketID>someTicketID</ticketID>
            <returnCode>0</returnCode>
        </xsl:copy>
    </xsl:template>
</xsl:transform>

Adatfelvételek

Egy vagy több adathalmaz kiválasztása, amely korábbi kérés/válasz állapotokban lett létrehozva, hogy belekerüljenek a leképezhető adatokba.

Ezek a halmazok az adatszerkezetben fognak megjelenni itt: /DataInclude/<AdatHalmazNev> (a részletekért nézze meg az aktuális kérések hibakeresési kimenetét).