Kapcsolódó információk:
› Paraméterezési útmutatók

A DbConnector a SUP® Rendszerhez kapcsolódó kiegészítő modulok gyűjtőneve. Két almodulból áll:

  • DbConnector (Windows app és Windows srv)
  • DbConnector API (JRE 1.8 app ill. srv)

Az mely modulok és funkciók telepítése szükséges, előzetes egyeztetés, esetenként interface építési rendszerterv alapján kerül megállapításra.

Tartalom

DbConnector app és srv

A DbConnector alkalmazás Windows operációs rendszer alatt működő, különböző időzítetten futtatható feldolgozó, exportáló, más gyártók által készített API-k hoz kapcsolódó funkciókat tartalmaz. A funkciók nagyobb része a Windows alkalmazásként futtatható DbConnector modulba van befordítva. Mivel a modul alkalmazásként fut, ezért a működtetéséhez bejelentkezett Windows felhasználó szükséges.
A funkciók kisebb része már be van fordítva a Windows serviceként futtatható modulba. Ez a termékfejlesztés során jelenleg is változik.
A DbConnector alkalmazás működési feltételei megegyeznek a SUP® Rendszer működési feltételeivel.

DbConnectorAPI

A Java VM környezetet igénylő DbConnector API segítségével más gyártók által készített rendszerek tudnak kapcsolódni a SUP® Rendszerhez. A kapcsolódás lehetőségek különböző lekérdezés, ill. adatbeküldés funkciókból állnak.
A működés szempontjából az API funkciók két csoportra bonthatók.

  • Szinkron - a funkciók nagyobb része szinkron működésű. Ide sorolhatók a lekérdezések, és bizonyos adatbeküldési lehetőségek. A szinkron funkciók működtetéséhez elegendő a DbConnector API telepítése.
  • Aszinkron - azok az adatbeküldési funkciók, melyek feldolgozása hosszabb ideig tart, aszinkron API funkcióként lettek megvalósítva. Ezen funkciók használatához a DbConnector API mellett szükséges a DbConnector alkalmazás, mint feldolgozó modul. Tehát az API-n beküldött adatok feldolgozási várólistába kerülnek. A DbConnector feldolgozó végzi az érdemi munkát.

A DbConnector modulokat az intraneten kell telepíteni. Az intraneten kívüli elérhetőséggel a DbConnector REST API dokumentációs oldal foglalkozik. A DbConnector alkalmazás és az DbConnector API nem feltétlenül ugyanazon a gépen kell, hogy működjön, de jellemezően egy könyvtárban szoktuk telepíteni.

A modulok telepítési helye lehetőség szerint nem a <SupHome>\BIN könyvtár. Javasolt hely a <SupHome>\DbConnector vagy <SupHome>\DbConnectorApi könyvtár.

Szükséges file-ok:

  • aDbConnector.exe - DbConnector alkalmazás, ha szükséges.

  • aDbConnectorSrv.exe - DbConnector (Windows) szolgáltatás, ha szükséges.

  • aDbConnector.ini - Közös INI file az alkalmazáshoz és a szolgáltatáshoz. Az aDbConnector.ini írja az adatbázis kapcsolatot a SUP.INI-hez hasonló módon.

  • Servers.ini - A Windows alkalmazás és szerviz működéséhez szükséges. A <SupHome>\SysData könyvtárból a SERVERS.INI másolata, ill. azok a bejegyzések, amik a DbConnector adatbázis kapcsolathoz szükségesek.

  • DbConnectorApi.jar - valamint működéshez szükséges property és futtató file-ok.

 Megjegyzés

Mivel a DbConnector modul számos funkciót tartalmaz, előfordulhat, hogy a különböző funkciók megfelelő időzítéssel futtatásához az alkalmazást több példányban kell futtatni. A szolgáltatásként futó modult jelenleg nem lehet több példányban futtatni.

Beüzemelés

A beüzemelést a DbConnector alkalmazással célszerű kezdeni. Első lépés, hogy a kívánt feladatot kézzel indítva jól működik-e. Ehhez már jól beállított INI-file-ok szükségesek.

Ha kívánt feladat kézi indítással megfelelően végrehajtódott, kerülhet sor az Ütemező, és az értesítések beállítására.

A feladatok többsége jelenleg csak alkalmazás módban futtatható, tehát az automatikus, időzített működtetéshez bejelentkezett Windows felhasználó szükséges.

Értesítések beállítása
Az automatikusan futó feladatok során bekövetkező eseményekről, és hibákról külön a modul értesítéseket küld. Az értesítéseket e-mailen küldi, ezért a cím megadása mellett az SMTP szerver beállításokat is ki kell tölteni.

Futtatás Windows szolgáltatásként

Néhány DbConnector feladat Windows szolgáltatásként is futtatható. Ilyen például a NAV Online Számla szerver kommunikáció (KOBAK agent) funkció.
A paraméterek beállítása a DbConnector alkalmazáson keresztül történik.

Szolgáltatásként az aDbConnectorSrv.exe állítható be. A szolgáltatást először installálni kell a Windows-ba, majd el kell indítani. Utána ellenőrizni kell a megfelelő működést.

aDbConnectorSrv.exe /INSTALL
NET START QsDbConnectorService

Az indítás a SERVICES.MSC utility segítségével is történhet.

Az időzített futtatás napló (LOG) file-ok a .\LOG könyvtárban jönnek létre. Emellett a szolgáltatás bejegyzéseket írhat a Windows eseménynaplóba, melyet az EVENTVWR.EXE utility használatával lehet megnézni. Itt a Windows-naplók | Alkalmazás nézetet kell választani.

A DbConnector API működik Linux vagy Windows környezetben. A Java VM gépen futó modult egy ú.n. service wrapper segítségével szoktuk Windows környezetben üzemeltetni.

DbConnector API - feldolgozó, TCP trigger

Az API-n beérkező aszinkron feldolgozású hívások egy TCP triggerrel azonnal képesek aktiválni a feldolgozó alkalmazást. A TCP trigger beállítása opcionális. ennek hiányában a feldolgozás a DbConnector alkalmazás ütemező beállítások alapján hajtódik végre.

TCP trigger beállítása

  • Feldolgozó alkalmazás beállítása.  Az aDbConnector.ini konfigurációs állományban, a [TCPServer] szekcióban be kell állítani a TCP portot, és be kell kapcsolni a szervert. A beállítások megváltoztatása a feldolgozó újraindítását igénylik.
    A TCP szerver indulása, és működése a .\LOG\zTcpServer.log naplóban ellenőrizhető.

  • API beállítása. Az aszinkron működéshez kapcsolódó feldolgozóval összhangban kell az API-ban a TCP klienst beállítani. A beállítás a DbConnector.properties konfigurációs állományban végezhető el a qsoft.dbconnector.server sorok segítségével. A beállítások megváltoztatása az API újraindítását igénylik.

  • Működés tesztelése. A feldolgozó TCP szerver működése a DbConnector modulok telepítési könyvtárában található tcpDbCTester konzol-alkalmazással, illetve a hasonló nevű batch file futtatásával ellenőrizhető. A batch file-ban a futtatás előtt át kell írni a paramétereket a feldolgozó alkalmazás TCP szerver beállításokkal összhangban.
    A TCP szerver működése szintén ellenőrizhető az API modul újraindításával. A .\LOG\Api-out-yyyy-ww.log naplóban bejegyzésre kerül az API indulásakor végrehajtott a TCP szerver sikeres illetve sikertelen tesztelése.

Működés, feldolgozás napló file-ok

A végrehajtott műveletek futásáról, és az előforduló hibákról .log kiterjesztéssel napló file-ok készülnek. A napló file-ok a .\LOG könyvtárban találhatók, kivéve a LOG_ERR.LOG file-t, mely  DbConnector modulok telepítési könyvtárába készül.

  • LOG_ERR.LOG. A file a DbConnector app és srv modulok általános működéséhez kapcsolódó bejegyzéseket tartalmaz. A nevével ellentétben nemcsak hibákat, hanem egyéb információkat is.

  • DbConnector app és srv log-ok. A DbConnector Windows alkalmazás és szerviz modulok által végzett feldolgozási feladatokról futásonként külön napló file készül. A napló neve a futtatott művelet neve és időpontja alapján képződik. A tevékenység napló és az esetleges hiba külön file-t hoz létre. Pl.: Fokfelad-20210630-1522_ERR.log. ERR.log csak akkor jön létre, ha a futtatott művelet során hiba történt. Abban az esetben, ha a művelet során volt hiba, a napló file azonnal elküldésre kerül az üzemeltetésért felelős e-mail címére.

  • DbConnector API log-ok. Az API működéséről szintén külön napló file készül az általános, futtatás során bekövetkezett eseményekről, és a hibákról. A futási LOG file-ok hetente rotálódnak. A hiba LOG-ok napi rotálásban vannak. A rotálás nulla óra egy perckor történi. Ha volt az előző napon hiba, az a rotálással együtt elküldésre kerül az üzemeltetésért felelős e-mail címére.

Rendszerfelügyeleti eszközök használata

A DbConnector modulok egyszerűen beköthetők az informatikai üzemeltetési feladatokat támogató rendszerfelügyeleti eszközökbe.

DbConnector app. A Windows alkalmazásként futó DbConnector modul a korábban leírt TCP szerver funkcióval felügyelhető legkönnyebben. A tcpDbCTester.bat-ban korábban beállított hívást kell betenni az időszakosan futtatott feladatok közé.
Pl.:   tcpDbcTester.exe 192.168.111.164 15998

DbConnector srv. Mivel a modul Windows szervizként fut, csak ennek a futását kell figyelni., de az előzőleg leírt TCP szerver figyelés is működhet.

DbConnector API. Mivel a DbConnector API egy webszolgáltatás, a meg kell hívni egy http GET-tel, az erre a célra készített ....\test végpontot.
Pl.:   https://dbconnector-apitest.sup.hu/api/v1/test

Verzió frissítés

A normál SUP rendszerkövetés ezeket a modulokat nem frissíti automatikusan. A verzió frissítés a következőképpen történik:

  • Kilépés futó alkalmazásból vagy Windows szolgáltatás leállítása. A régi verziók dátumozott archiválását is célszerű elvégezni. Erre alkalmazható a 7Zip-Service.cmd batch file.

  • A DbConnector alkalmazás telepítő file-ok letölthetők a www.sup.hu/kov helyről. A DbConnectorApi.jar file-t általában a direkt letöltési link-ként juttatjuk el, amikor ez esedékes.

  • Az újabb verziójú file-ok bemásolása a <SupHome>\DbConnectorApi könyvtárba. Csak a szükséges file-okat kell átmásolni.
    Pl.: ha nincs DbConnector Windows szervizként működtetett funkció, akkor az  aDbConnectorSrv.exe átmásolása fölösleges.
  • Alkalmazás vagy Windows szolgáltatás elindítása.

  • Futás ellenőrzése. Ez leginkább az API modul esetén érdekes. Mivel ez egy webszolgáltatás, egy böngészőből meg kell nyitni az erre a célra készített ....\test végpontot.
    Pl.:   https://dbconnector-apitest.sup.hu/api/v1/test