Nastavenie Web API

Adresa, na ktorej Web API počúva. Súvisiaci parameter: port

Východisková hodnota: 0.0.0.0

Východisková hodnota "0.0.0.0" znamená, že aplikácia bude dostupná na ľubovoľnej IPv4 adrese, ktorú má daný počítač pridelenú.

Port, na ktorom Web API počúva. Súvisiaci parameter: host

Východisková hodnota: 80

Cesta k súboru ApiLib.dll.

Východisková hodnota: null

Východisková hodnota null predpokladá, že sa súbory APIServer.jar a ApiLib.dll nachádzajú v rovnakej zložke. Pokiaľ tomu tak nie je, je potrebné týmto parametrom špecifikovať cestu k súboru ApiLib.dll, aby API server knižnicu našiel.

Minimálny počet súčasných pripojení k serveru (vláken).

Východisková hodnota: 16

Maximálny počet súčasných pripojení k serveru (vláken).

Východisková hodnota: 250

Určuje maximálnu veľkosť requestu v bytoch (B).

Východisková hodnota: 10000000 B (10 MB).

V defaultním stavu je kontrola SNI zapnuta. Na každém connectoru je následně možná pomocí stejné proměnné nastavit, zda SNI používat. Pokud nemá connector proměnnou nastavenu, použije se hodnota z globálniho nastaveni v sekci Server.

Výchozí hodnota: true

Cesta k certifikátu vo formáte PKCS #12 (typicky súbor s príponou .pfx) alebo do Java keystore. Súvisiaci parameter: certPassword

Východisková hodnota: ""

server:
	certPfx: "C:\\mnt\\datashareone\\abra\\tslssl\\cert\\MyPKCS12Certificate.pkcs12"
	certPassword: "fk45235#!@41324zfaABCD"

openssl pkcs12 -inkey MyPrivateKey.key -in MyPEMCertificate.crt -export -out MyPKCS12Certificate.pkcs12

Heslo k certifikátu vo formáte PKCS #12 (typicky súbor s príponou .pfx) alebo do Java keystore. Súvisiaci parameter: certPfx

Východisková hodnota: ""

Viď popis pri parametri certPfx.

V prehliadači Google Chrome povoľuje API dopyt z verejnej siete do siete privátnej. Defaultnou hodnotou je true. Pokiaľ je hodnota false, komunikácia nebude možná.

Nepovinná sekcia. Sekcia slúži hlavne pre zadávanie viacerých IP adries protokolov IPv4 alebo IPv6, na ktorých bude server počúvať. Pokiaľ nie je sekcia uvedená, správa sa nastavenie bežným spôsobom. Pokiaľ sa sekcia uvedie, tak sa pri štarte servera vytvoria konektory pre každú položku tu uvedenú namiesto jediného podľa sekcie server.

Subsekcia Connector môže obsahovať položky Host, Port, Cert_pfx, Cert_password. Pokiaľ nejaká nie je uvedená alebo je prázdna alebo nula (v prípade portu), tak sa hodnota vezme z rovnomennej položky v sekcii Server.

Príklad použitia subsekcie Connectors

Interval pro sbírání dat o paměti a cpu. Výchozí hodnota je 30000 ms. Lze nastavit v rozmezí 15000 -180000 ms.

Interval pro odesílání dat na aplikační server. Výchozí hodnota je 600000 ms. Lze nastavit v rozmezí od dvojnásobku hodnoty parametru telemetrySampleIntervalMs do 600000 ms.

Obecný popis:

CORS - Fetch Standard - jedná se o protokol realizovaný pomocí přidaných http hlaviček v request a response.

V options dotazu(takzvaném preflight) se posílá hlavička Origin a hlavička access-control-request-method. Pro úspěšnou odpověď je třeba vrátit status 200 nebo 204 a správně vyplněné hlavičky access-control-allow-origin, access-control-allow-methods a případně access-control-allowed-headers. Preflight dotaz posílá prohlížeč automaticky v případě tzv. cross origin requestu - tedy skript stažený z origin X dělá v javascriptu request na origin Y. Pokud preflight dotaz selže anebo nemá nastavené výše uvedené hlavičky, prohlížeč vlastní dotaz ani neposílá.

V non options dotazu může být taky hlavička Origin, na kterou se dle protokolu odpoví access-control-allow-origin a v případě, že je zapotřebí credential, tak i hlavičkou access-control-allow-credentials. Tady nejde jednoduše odlišit normální request od cors requestu, ale hlavičku Origin používá CORS vždy. Pokud prohlížeč nedostane v odpovědi správné hlavičky, nezprostředkuje odpověď zpátky do skriptu, který request vyvolal a ten skončí chybou.

CORS protokol použije prohlížeč automaticky a použije se jen v případě cross origin site request.

PNA - Private Network Access: introducing preflights je rfc od googlu, které není součástí CORS protokolu. Pro potřeby ověření posílání dotazů do lokální sítě ale zavedlo rfc, které doplňuje sadu cors hlaviček o access-control-request-private-network a access-control-allow-private-network.

Na rozdíl od CORS se vyskytuje nejen v rámci cross origin request, ale může se volat i v případě sop - same origin policy, tedy pokud java skript posílá dotaz na stejnou adresu odkud byl stažen, ale adresa je soukromější(viz výše uvedené rfc, kde se klasifikují různé private adresy).

V případě, že se jedná o cors dotaz, je access-control-request-private-network přímo součástí cors preflightu.

V případě, že se nejedná o cors dotaz, je součástí preflight dotazu opět hlavička Origin.

Na rozdíl od cors zavádí ještě jednu hlavičku access-control-request-credentials, na kterou přímo v preflight je odpověď access-control-allow-credentials. CORS tuto request hlavičku nepotřebuje, protože případnou hlavičku access-control-allow-credentials uvádí až v non preflight dotazu, kdy už je jasné, co je to za dotaz a jesti jsou credentials protřebné.

Nastavení v ABRA Gen

V případě cross dotazů z prohlížeče je třeba pomocí této volby nakonfigurovat origin skriptů, u kterých je povolené cross dotazy provádět. V definici jednotlivých povolených domén je možné použít wildcard znaky * a ? s obvyklým významem.

Východisková hodnota: *.abra.software".

CORS je také logováno v rámci logů. Více viz popis logování CORS volání.

Zapnutie (true) alebo vypnutie (false) zohľadňovania všeobecnej ochrany dát.

Východisková hodnota: false

Kombinuje sa s nastavením položky Obísť ochranu dát vo vlastnostiach používateľa, ktorý sa pre prístup k API využíva. Východisková hodnota je false.

APIServer.yaml, parameter dataProtection	Agenda Používatelia, položka Obísť ochranu dát	Web API zohľadňuje ochranu dát
-		nie
false		nie
true		áno
-		nie
false		nie
true		nie

Maximálny počet vláken, ktoré môžu súbežne spracovávať požiadavky.

Východisková hodnota: 64

Doba, po ktorej sú vlákna určené na spracovanie požiadaviek ukončené.

Východisková hodnota: 3600000

Doba (v milisekundách), po ktorej je vlákno ukončené, pokiaľ sa počas nej požiadavku nepodarí spracovať (vybaviť). Počíta sa len doba samotného spracovania požiadavky, nie čas, kedy požiadavka čaká v rade. Po ukončení vlákna vráti server chybu 408 Request Timeout.

Východisková hodnota: 600000

Doba (v milisekundách), počas ktorej požiadavka čaká v rade, než sa uvoľní vlákno, ktoré by ho mohlo začať spracovávať. Po uplynutí tejto doby vráti server chybu 503 Service Unavailable, požiadavka je z radu vyradená a je nutné ju zaslať znovu.

Východisková hodnota: 30000

Parameter bol vo verzii 21.3.5 odstránený.

Parameter ovplyvňoval, či sa má s každou požiadavkou realizovať nové prihlásenie.

V súčasnej dobe je každá požiadavka autorizovaná novým prihlásením automaticky. Pokiaľ je používateľ s rovnakými prihlasovacími údajmi uložený v cache, vykoná sa prihlásenie len v prípade, pokiaľ medzitým došlo ku zmene (napr. nastavenie nového hesla).

Vďaka tomuto správaniu sa zmena prihlasovacích údajov používateľa realizujúceho požiadavky prejaví okamžite. Zmenami sa môže rozumieť:

• zmena prihlasovacieho hesla
• Zmena ďalších vlastností používateľa (napr. príznaku Prihlásenie nevizuálneho používateľa API)
• zmena oprávnení (prístupových práv)

V klauzule Select sa pre reťazenie (konkatenáciu) aktuálne používa operátor "||". Pokiaľ je potrebné vrátiť pôvodné správanie a pre reťazenie použiť operátor "+", je potrebné parameter nastaviť na hodnotu True.

Východisková hodnota: False.

Primárne je vykonanie v EXE určené pre požiadavky, pri ktorých sú problémy s chodom v threade. Ide hlavne o tlače, skripting a čokoľvek, čo vytvára vizuálne prvky(aj keď sa nakoniec samozrejme nezobrazujú). Parameter nie je v konfigurácii predvyplnený, je potrebné ho v prípade prepnutia na iné ako defaultné správanie doplniť ručne.

Parameter defaultExecutor má dve hodnoty:

• inprocess - vykonanie vo vlákne (threade) - Východisková hodnota.
• outprocess - vykonanie v externom EXE (použitie tejto voľby so sebou nesie využitie viac pamäte systému).

Parameter určuje počet neprihlásených apirunner.exe procesov v API poole a ak príde požiadavka, ktorá sa má vybaviť outofprocess, vezme sa z tohto poolu a použije. Tým sa ušetrí čas pri prvom dotaze (spustenie apirunner.exe). Ak je pool prázdny, apirunner.exe sa normálne spustí.

Ak je parameter defaultExecutor (popis uvedený vyššie) nastavený na outprocess, pool sa vytvorí hneď pri štarte servera. Ak je inprocess, zostáva pool prázdny až do príchodu prvej požiadavky, ktorá sa má vykonať pomocou outprocess (s parametrom ?executor=outprocess).

Východisková hodnota: 2

Parameter je možné nastaviť len od 4 GB a vyššie a je odporúčané ho nastaviť, ak budú nejaké requesty nadmerne leakovať a bežná doba životnosti executora (štandardne 1h) nestačí.

Parameter funguje na 2 rôznych miestach a kontroluje private pamäť zabranú procesom:

• Pri vykonávaní requestu - ak pamäť zabraná outprocesom presiahne túto veľkosť, outprocess sa ukončí a klientovi je zaslaná chyba, že pamäť prekročila túto hranicu.

• Na outprocess samotnom (apirunner.exe) - ak pamäť mimo vykonávania requestu presiahne túto veľkosť - 1, tak sa outprocess tiež ukončí. Dôvod pre -1 je ten, aby prípadne klient nedostal na vykonanie executor s pamäťou tesne pred limitom, pretože potom by ani relatívne malý request nemusel prejsť.

V prípade akéhokoľvek prekročenia limitov je informácia zapísaná do logu s úrovňou 3.

Východisková hodnota: 0 - vypnuté

Parameter určuje, ako sa budú novo prichádzajúce požiadavky mapovať na ApiRunner.exe.

• Hodnota 1 - v rovnakom ApiRunner.exe sa spustia len požiadavky s rovnakým credentials. Je to východisková hodnota a credentials sa berú tak, ako prichádzajú. To znamená, že napr. obnovený JWT token je považovaný za odlišný od predchádzajúceho.

• Hodnota 2 - v rovnakom ApiRunner.exe môžu bežať požiadavky akéhokoľvek klienta.

S týmto parametrom úzko súvisia nasledujúce parametre outprocessLifeTimeMs a outprocessMaxClients, ktoré sú popísané nižšie.

Východisková hodnota: 1

Parameter určuje životnosť ApiRunner.exe. Po uplynutí tejto doby sa prestane ponúkať klientom, avšak uvoľní sa až po uzavretí poslednej požiadavky klienta na ňom. V prípade serverstate môže dôjsť k výraznému predĺženiu doby uvoľnenia.

Východisková hodnota: 28800000

Parameter určuje maximálny počet klientov, ktorých môže hostiť jeden ApiRunner.exe. Východisková hodnota je 1, čo znamená, že systém sa bude správať rovnako ako pred vznikom tohto parametra. Až keď sa táto hodnota zvýši, uplatní sa vyššie uvedený parameter stratégie pre alokovanie jednotlivých klientov.

Východisková hodnota: 1

Počet vlákien v Connection poole pre neoverené (neprihlásené) volania.

Doba v milisekundách, ktorá určuje, ako dlho sa čaká na pridelenie vlákna Connection poolu na spracovanie požiadavky.

Doba v milisekundách, ktorá určuje, ako dlho je možné spracovávať požiadavku v rámci Connection poolu.

Parameter definuje maximálny počet vlákien dostupných v dedikovanom poole pre používateľské relácie v endpointe /serverstate. Každé vlákno je vyhradené jednému používateľovi a spravuje jeho dočasnú medzipamäť, ktorá slúži na spracovanie požiadaviek na business objekty (BO). Požiadavky od toho istého používateľa sú spracovávané serializovane (v poradí, v akom prichádzajú), aby sa zabránilo kolíziám v rámci relácie.

Vlákna tohto poolu sú oddelené od štandardných požiadaviek, čo zabezpečuje lepšiu správu výkonu a izoláciu operácií spojených s medzipamäťou.

Východisková hodnota: 128

Parameter sa týka nastavenia Spracovanie požiadaviek v medzipamäti.

Parameter určuje maximálnu dobu nečinnosti (v milisekundách) pre každé vlákno používateľskej relácie v endpointe /serverstate. Ak od poslednej požiadavky uplynie zadaná doba, relácia je automaticky ukončená, vlákno uvoľnené späť do poolu a všetky medzipamäte priradené k relácii sú odstránené. Toto nastavenie umožňuje optimalizáciu pamäťových zdrojov a zabraňuje neobmedzenému hromadeniu neaktívnych relácií.

Východisková hodnota: 14400000

Parameter sa týka nastavenia Spracovanie požiadaviek v medzipamäti..

Po prepnutí na true je do query podmienok where na položku odkazujúcu na firmu doplnená podmienka aj za predchodcov.

Parameter ovplyvňuje generovanie SQL. Ak je nastavený na true, použije sa v SQL dopyte INNER JOIN namiesto LEFT JOIN v prípadoch, keď je väzobné pole (field) definované ako NOT NULL (pretože väzba v takom prípade vždy existuje a zmena neovplyvní výsledok dopytu).

Východisková hodnota: false (zachováva spätnú kompatibilitu a vždy používa LEFT JOIN). Prepnutie na true môže pomôcť vyriešiť problémy s výkonom SQL dopytov.

Pomocou tohto parametra je možné ovplyvniť, v akom časovom pásme sú vypisované hodnoty dátumových polí. V predvolenom stave sú dátumy vracané v UTC (napr. "2024-01-04T13:04:00.000Z"). Ak je parameter nastavený na true, dátumy sú vracané v lokálnom časovom pásme (napr. "2024-01-04T14:04:00.000+01:00").

Parametrom je možné definovať, do ktorých adresárov je možné uložiť externé súbory ako prílohy a obrázky. Bez definovaných adresárov nie je možné ukladať externé prílohy a obrázky.

Východisková hodnota: Nie je povolený žiadny adresár.

Vypína mechanizmus, ktorý mení vykonávanie poddotazov typu objektový odkaz. Takéto poddotazy sa vykonávajú v rámci nadradeného dotazu, kam sa položky pripájajú pomocou JOIN väzby. Netýka sa poddotazov obsahujúcich klauzuly where, skip a take alebo položiek, ktoré vo výraze obsahujú metafunkciu treepath.

Východisková hodnota: true

         {
        "class": "05CPMINJW3DL342X01C0CX3FCC", # receivedorderrow
        "select": [
            "providerow_id.displayname",
            "providerow_id.id",
            "id",
            "displayname",
            {
                "name": "poskytovatel",
                "value": {
                    "field": "providerow_id",
                    "query": {
                        "select": [
                            "displayname",
                            "displayname + '_TEST'",
                        ],
                    },
                },
            },
        ],
        "where": "parent_id eq '1100000101'",
    }

Parameter kontroluje, že do konkrétnych BO položiek je možné v danom okamihu zapisovať, rovnako ako vo vizuálnom prostredí, a ďalej kontroluje, že je možné do kolekcie vkladať riadky a je možné už existujúci riadok editovať alebo mazať. Bežne je žiaduce, aby sa API správalo rovnako ako vizuálne prostredie, teda aby položky, ktoré nie je možné editovať, nebolo možné editovať ani v rámci API. Napr. celkovú cenu na riadku dokladu, ktorá nie je používateľsky editovateľná a počíta sa.

V niektorých veľmi špecifických prípadoch môže byť potrebné takúto možnosť aktivovať. V takom prípade je potrebné parameter nastaviť na hodnotu false, čím sa kontrola vypne.

Východisková hodnota: true

Adresárová cesta, do ktorej sú logy ukladané. Viac informácií viď popis v sekcii Konfigurácia logovania.

Východisková hodnota: ""

Úroveň podrobnosti logovania (čím vyššie číslo, tým detailnejšie logovanie). Viac informácií viď popis v sekcii Konfigurácia logovania.

Východisková hodnota: 1

Aktivuje logovanie. Pokiaľ chcete logovanie používať, zmeňte východiskovú hodnotu false na hodnotu true.

Východisková hodnota: false

Maximálna veľkosť logu v bajtoch. Východisková hodnota 0 znamená, že je veľkosť logu neobmedzená

Východisková hodnota: 0

Počet logov zaradených do rotácie. Viac informácií viď popis v sekcii Konfigurácia logovania.

Východisková hodnota: 1