Webszolgáltatások

Ahogy a funkciólistában említve lett, mind az OTRS, mind a SolMan webszolgáltatások alapszintű ismeretét feltételezzük.

Egy példa webszolgáltatás biztosítva van a csomaggal a doc/SolManConnectorExample.yml fájlban. Jó ötlet lenne kettőzöttként megtartani telepítve (de letiltva) ezt a webszolgáltatást hivatkozásként a rendszeren.

Az egyes webszolgáltatásrészek szükséges és ajánlott módosításaiért nézze meg az alábbi szakaszokat. A módosítások a biztosított példára hivatkoznak.

Kérelmező átvitel

Győződjön meg arról, hogy a HTTP::SOAPSolMan átvitelt használja-e. Ez szükséges a megfelelő névtér előállításához.

Állítsa be a SolMan példánya végpontját (URI) és állítsa be a hitelesítést, a proxy és az SSL-beállításokat, ha szükséges.

A SOAPAction beállításait, névterét és névsémáját nem kellene megváltoztatni.

Kérelmező meghívók

Ez a csomag három különböző meghívó vezérlőt tartalmaz, amelyek funkcionalitást nyújtanak az összes támogatott függvényhíváshoz.

  • A SolMan::IncidentCreate vezérlő kezeli a jegy kezdeti átvitelét a SolMan rendszerbe (például ProcessIncident, ReplicateIncident).

  • A SolMan::IncidentUpdate vezérlő kezeli egy jegy követő átvitelét a SolMan rendszerbe (például AcceptIncidentProcessing, AddInfo, CloseIncident, RejectIncidentSolution, VerifyIncidentSolution).

  • A SolMan::RequestSystemGuid vezérlő a SolMan rendszerből származó rendszer GUID információk kéréséhez használható.

Fontos különbséget tenni az IncidentCreate és az IncidentUpdate vezérlők között. Egyébként az meghívó nevei nem tesznek különbséget kezelési szempontból az OTRS-ben (kivéve a CloseIncident vezérlőt, amely panaszkodni fog, ha egy már lezárt jegyet próbál frissíteni).

Ha egy frissítés típusú meghívót aktiválnak egy semmilyen előző szinkronizációs tevékenységgel sem rendelkező jegynél, akkor az automatikusan aktiválni fog egy létrehozás típusú meghívót (ProcessIncident, ha létezik vagy ReplicateIncident alternatívaként).

A SolMan rendszer GUID lekéréséhez használt meghívó automatikusan aktiválva lesz, amikor ez az információ nem ismert az OTRS-ben.

Minden szabályos meghívó át fogja vinni az összes meglévő bejegyzést, amelyek még nem lettek átküldve ezen a ponton.

Alapértelmezetten az AddInfo meghívó aktiválva lesz az OTRS-ben létrehozott minden bejegyzéshez egy eseményaktiválón keresztül. Erősen ajánlott eseménymeghívók beállítása az összes fontos meghívóhoz (például állapot- és prioritásváltoztatásokhoz), valamint azok eseményfeltételeken keresztüli korlátozása (például bizonyos várólistákban lévő jegyekben).

Kérelmező leképezés

Az OTRS és a SolMan közti leképezés az OTRS-ben XSLT-beállításon keresztül történik.

A megadott beállítás működő XSLT-sablonokat tartalmaz. A szabványos követelményekhez csak a kimenő leképezés sablonjának módosítása szükséges a következők tekintetében:

  • OTRS fájl útvonala az XSL segítő sablonoknál

  • OTRS → SolMan állapotleképezés

  • OTRS → SolMan prioritásleképezés

  • Dinamikus mező kiválasztás és névleképezés

  • OTRS → SolMan bejegyzéstípus-leképezés

A sablonokat meghívónként egyénileg kell módosítani, de ezek (alapértelmezetten) azonosak az összes szabályos meghívónál.

A meghívók által biztosított adatszerkezet hasonló az OTRS jegycsatlakozó szerkezetéhez, de tartalmaz néhány módosítást és további adatokat. Ez egy gyors hivatkozás:

<Customer>
    <*> customer attributes, e.g. 'UserEmail' </*>
</Customer>
<Owner>
    <*> owner (agent) attributes, e.g. 'UserEmail' </*>
</Owner>
<SolMan>
    <IncidentId> incident id </IncidentId>
    <IncidentGuid> incident guid </IncidentGuid>
    <LocalSystemGuid> OTRS system guid </LocalSystemGuid>
    <RemoteSystemGuid> SolMan system guid </RemoteSystemGuid>
</SolMan>
<Ticket>
    <Article> # can occur 0-n times
        <Attachment> # can occur 0-n times
            <*> attachment attributes, e.g. 'Filename' </*> # 'Content' is base64-encoded automatically
        </Attachment>
        <DynamicField> # can occur 0-n times
            <Name> dynamic field name </Name>
            <Value> dynamic field value(s) </Value>
        </DynamicField>
        <*> article attributes, e.g. 'From' </*>
    </Article>
    <DynamicField> # can occur 0-n times
        <Name> ticket dynamic field name </Name>
        <Value> ticket dynamic field value(s) </Value>
    </DynamicField>
    <*> ticket attributes, e.g. 'TicketNumber' </*>
</Ticket>

Az alapértelmezett XSLT-sablontípusok egyéni fájlokként vannak megadva a hivatkozáshoz (nézze meg a csomag által biztosított doc/ExampleMapping-Invoker-*.xsl fájlokat).

Kérelmező hibakezelés

Néhány hibakezelő modul előre be van állítva a kérések újraütemezéséhez, ha bizonyos probléma történik. Az újraütemezett kérések 1 perces időközökkel lesznek végrehajtva legfeljebb 5 próbálkozásig.

Alapértelmezetten az összes átviteli hiba újraütemezést, valamint adat-előkészítést okoz ott, ahol a SolMan rendszer GUID-ot nem sikerül lekérni.

A kérések akkor is újra lesznek ütemezve, ha a SolMan hibakóddal tér vissza, kivéve ha ez a kód 01, 02, 03 vagy 04.

Ajánlott megváltoztatni az újrapróbálási beállításokat az igényeinek megfelelően, és ellenőrizni, hogy a hibakódra vonatkozó kezelés megfelel-e a követelményeinek.

Szolgáltató átvitel

A félreértések elkerülése érdekében a HTTP::SOAPSolMan átvitelt kell használnia. A kérelmezővel ellentétben ez nem feltétlenül szükséges.

Módosítsa az üzenet hosszát, ha szükséges.

A SOAPAction beállításait, névterét és névsémáját nem kellene megváltoztatni.

Szolgáltató műveletei

Ez a csomag három különböző műveleti vezérlőt tartalmaz, amelyek funkcionalitást nyújtanak az összes támogatott függvényhíváshoz.

  • A SolMan::IncidentCreate vezérlő kezeli a jegy kezdeti átvitelét a SolMan rendszerből (például ProcessIncident, ReplicateIncident).

  • A SolMan::IncidentUpdate vezérlő kezeli egy jegy követő átvitelét a SolMan rendszerből (például AcceptIncidentProcessing, AddInfo, CloseIncident, RejectIncidentSolution, VerifyIncidentSolution).

  • A SolMan::RequestSystemGuid vezérlő a SolMan rendszerbe küldendő rendszer GUID információk szolgáltatásához használható.

Fontos különbséget tenni az IncidentCreate és az IncidentUpdate vezérlők között. Egyébként az meghívó nevei nem tesznek különbséget kezelési szempontból az OTRS-ben.

Ha egy jegynek olyan függőben lévő frissítései vannak, amelyeket át kell küldeni az OTRS-ből a SolMan rendszerbe (például új bejegyzések), akkor a SolMan felől történő frissítés átmenetileg tiltva van.

A SolMan természeténél fogva az elküldött mellékleteket nem lehet egynél több bejegyzéshez hozzárendelni. Egy kérésen belül elküldött mellékletek automatikusan az adott kérésen belül létrehozott utolsó bejegyzéshez lesznek csatolva. Ha a kérés nem tartalmaz semmilyen bejegyzést, akkor egy üres bejegyzés lesz létrehozva a mellékletekhez.

Szolgáltató leképezés

Az OTRS és a SolMan közti leképezés az OTRS-ben XSLT-beállításon keresztül történik.

A megadott beállítás működő XSLT-sablonokat tartalmaz. A szabványos követelményekhez csak a bejövő leképezés sablonjának módosítása szükséges a következők tekintetében:

  • OTRS fájl útvonala az XSL segítő sablonoknál

  • OTRS célvárólista

  • SolMan → OTRS állapotleképezés

  • SolMan → OTRS prioritásleképezés

  • Dinamikus mező kiválasztás és névleképezés

  • SolMan → OTRS bejegyzéstípus-leképezés

A sablonokat műveletenként egyénileg kell módosítani, de ezek (alapértelmezetten) azonosak az összes szabályos műveletnél.

A műveletek által elvárt adatszerkezet hasonló az OTRS jegycsatlakozó szerkezetéhez, de tartalmaz néhány módosítást és további adatokat. Ez egy gyors hivatkozás:

<Attachment> # can occur 0-n times
    <*> attachment attributes, e.g. 'Filename' </*> # 'Content' is base64-decoded automatically
</Attachment>
<Ticket>
    <Article> # can occur 0-n times
        <*> article attributes, e.g. 'From' </*>
    </Article>
    <DynamicField> # can occur 0-n times
        <Name> ticket dynamic field name </Name>
        <Value> ticket dynamic field value(s) </Value>
    </DynamicField>
    <*> ticket attributes, e.g. 'TicketNumber' </*>
</Ticket>
<SolMan>
    <IncidentGuid> incident guid </IncidentGuid>
    <LocalSystemGuid> OTRS system guid </LocalSystemGuid>
    <RemoteSystemGuid> SolMan system guid </RemoteSystemGuid>
    <Person> # can occur 0-n times
        <Meta>
            <ID> OTRS id of agent / or login of customer user </ID>
            <ExternalID> SolMan id of person </ExternalID>
            <Type> CustomerUser, Owner or Agent </Type>
        </Meta>
        <*> agent or customer user attributes, e.g. 'UserEmail' </*>
    </Person>
</SolMan>

Az alapértelmezett XSLT-sablontípusok egyéni fájlokként vannak megadva a hivatkozáshoz (nézze meg a csomag által biztosított doc/ExampleMapping-Operation-*.xsl fájlokat).

Scroll to Top