Funkce pro MS Excel

Sada funkcí pro MS Excel umožňuje v reálném čase pracovat s daty čerpanými z informačního systému ABRA FLORES v prostředí tohoto tabulkového procesoru. Jedná se o samostatně dodávané rozšíření.

  • Instalace:

    • Funkce pro MS Excel se instalují samostatně prostřednictvím dodávaného instalátoru, což je excelový sešit s podporou maker (soubor s příponou XLSM). Funkce instalátoru spočívá v automatizovaném zkopírování veškeré potřebné funkcionality do zvoleného vlastního excelového sešitu s podporou maker, ve kterém chcete funkce používat. Instalátor je k dispozici ke stažení, podrobnější popis naleznete v sekci Instalace a nastavení.
    • Dále je zapotřebí mít nainstalovanou verzi systému ABRA FLORES, která má potřebnou funkcionalitu v rozhraní Web API implementovanou, tj. 19.2 či vyšší.
    • MS Excel je podporován ve verzích pro Windows i pro macOS.

  • Licencování:

    • K provozu funkcí pro MS Excel je zapotřebí rozhraní Web API, které je součástí licence jádra s pokročilou automatizací a vizualizací. V případě, že vaše licence jádra toto rozšíření neobsahuje, je zapotřebí licenci rozšířit. Pro více informací kontaktujte dodavatele systému.

    • Funkce pro MS Excel jsou licencovány samostatně - viz licencované celky. Každý uživatel, který bude funkce pro MS Excel používat, potřebuje dvě licence:

      1. Pro přihlášení nevizuálního uživatele API.

        Licenční soubor LICENCE.CFG musí obsahovat klíč s definicí oprávnění pro přihlášení nevizuálních uživatelů API. Počet uživatelů se zobrazuje v agendě Správa licencí na záložce Licencované moduly a vlastnosti jako součást informace o licencích k modulu Jádro systému.

        Hodnota obsažená v klíči určuje, kolika uživatelům v agendě Uživatelé budete moci zatrhnout příznak Přihlášení nevizuálního uživatele API. Přihlašovací údaje těchto uživatelů později použijete při definici připojení do Web API v jednotlivých excelových sešitech, ve kterých budete funkce pro MS Excel využívat.

        Více uživatelů s příznakem Přihlášení nevizuálního uživatele API si nadefinujte a následně používejte v případech, kdy chcete jednotlivým excelovým sešitům resp. jejich uživatelům přidělit rozdílná přístupová práva.

        V současné době se při přístupu prostřednictvím API zohledňují pouze práva k chráněným objektům, do budoucna je plánováno také zohledňování práv k funkcím.

      2. Pro WebAPI doplňky.

        Licenční soubor LICENCE.CFG musí obsahovat klíč s definicí oprávnění pro modul Web API doplňky.

        Licence umožňuje dotazování speciálních Web API zdrojů pro doplňky v MS Excelu. Vždy stačí jedna licence - pokud je součástí licenčního klíče, mohou se do těchto speciálních zdrojů dotazovat všichni uživatelé.

      Počet souběžně pracujících uživatelů není licenčně omezen. Můžete si tak například vytvořit libovolný počet excelových sešitů se zmíněnými funkcemi a ze všech se do Web API přihlašovat pod stejným uživatelem.

Pro úspěšné používání funkcí je zapotřebí postupně provést následující kroky:

  • Zprovoznit Web API.
  • Od dodavatele systému získat licenci k modulu WebAPI doplňky (tj. licenční soubor LICENCE.CFG obsahující licenci k tomuto modulu, podrobnosti viz aktuální obchodní podmínky).
  • V agendě Správa licencí načíst získaný soubor soubor LICENCE.CFG funkcí Aktivace. Úspěšnou instalaci signalizuje symbol zatržení u modulu Web API doplňky.

  • Ve vlastnostech uživatele, který bude k datům prostřednictvím Web API přistupovat, zatrhnout příznak Přihlášení nevizuálního uživatele API a nastavit mu potřebná oprávnění (prostřednictvím rolí nebo skupin rolí). V současné době se zohledňují práva k chráněným objektům.

  • Stáhnout si instalátor.

  • Připravit si excelové sešity, ve kterých budete chtít funkce používat. Sešity mohou a nemusí být prázdné. Do zvolených souborů je pouze doplněna nová funkcionalita, veškerý obsah těchto souborů je zachován.

    I tyto sešity musí být ve formátu XLSM - do sešitů ve formátech XLSX, XLS, ODS a dalších není možné funkce nakopírovat.

  • V průběhu instalace je zapotřebí mít v MS Excelu zatrženou volbu Důvěřovat přístupu k objektovému modelu projektu VBA:
    • Soubor → Možnosti → Přizpůsobit pás karet: pokud nemáte v sekci Hlavní karty zatrženou kartu Vývojář, zatrhněte ji.
    • Na kartě Vývojář klikněte na tlačítko Zabezpečení maker a v sekci Nastavení maker → Nastavení maker pro vývojáře zatrhněte tuto volbu.

    Po dokončení úpravy jednotlivých sešitů můžete volbu opět deaktivovat.

  • V aplikaci MS Excel otevřete instalátor (stažený XLSM soubor). Instalátor obsahuje jediný list, do kterého je vložený formulář umožňující nakopírování potřebné funkcionality do vašich vlastních XLSM souborů.

  • Tlačítkem Browse vyvolejte standardní dialog operačního systému pro výběr souboru. Vyberte z disku XLSM soubor, do kterého chcete podporu funkcí doplnit.

  • Tlačítkem Install / Update spusťte vlastní instalaci (úpravu zvoleného sešitu). Instalátor provede následující kroky:

    • Pokud v upravovaném sešitu neexistuje list nazvaný API (viz následující bod), instalátor ho vytvoří a naplní výchozími hodnotami. Pokud již list s tímto názvem existuje, ponechá ho instalátor beze změny.

    • Pokud v upravovaném sešitu neexistuje modul AbraUtils, instalátor ho vytvoří a nakopíruje do něj aktuální obsah (jednotlivé funkce). Pokud modul v upravovaném sešitu existuje, instalátor ho aktualizuje (přepíše existující funkce, případně doplní nové).

      Pokud pomocí instalátoru aktualizujete již používaný sešit, aktualizujte nejprve jeho kopii a aktualizovaný sešit otestujte.

      Kromě AbraUtils instalátor do sešitu vkládá ještě několik pomocných modulů.

  • Takto upravený soubor otevřete. Naleznete v něm nový list nazvaný API obsahující tabulku, do které vyplňte připojovací údaje k Web API serveru:

    • URL - adresa Web API serveru, včetně případného portu a názvu spojení

      Hodnota parametru bude záviset na konkrétní konfiguraci vašeho Web API serveru. URL může a nemusí končit lomítkem. Například:

      https://api.firma.cz:8089/data_cz
    • Username - uživatelské jméno pro připojení do API (musí se jednat o uživatele systému ABRA FLORES se zatrženým příznakem Přihlášení nevizuálního uživatele API).
    • Password - heslo uživatele pro připojení do API.
    • Max. Timeout - maximální doba v sekundách, po kterou klient čeká na dokončení každé z fází požadavku (Resolve, Connect, Send, Receive).
    • Max. Connection Timeout - maximální doba v sekundách, po jejímž vypršení pokus o navázání spojení skončí chybou.
  • Postup zopakujte pro všechny soubory, ve kterých chcete funkce používat.

  • Dle svých individuálních specifických požadavků do sešitů doplňte vlastní obsah (tabulky, grafy), který prostřednictvím těchto funkcí čerpá data ze systému ABRA FLORES. Popis dostupných funkcí naleznete v následující kapitole.

    Pro inspiraci si můžete stáhnout soubor se vzorovými příklady.

    Pokud převáděný nebo již dříve funkční převedený excelovský sešit přestane fungovat, nepřipojí se nebo vykazuje chyby je nutné pro jeho další možné používání jej nejdříve vyčistit od systémově nainstalovaných skriptů, zkontrolovat případné další uživatelské změny a následně znovu pomocí instalátoru převést.

    Vyčištění od systémově nainstalovaných skriptů

    Při novém převádění sešitu se kontroluje, zda vše níže uvedené v sešitu již existuje a pokud ano, tak je přeskočeno. Tímto krokem tedy zajistíme opětovné výchozí nastavení.

    Otevřete sešit v aplikaci MS Excel a z listu API si za zálohujte všechny přihlašovací údaje tak, aby je bylo možné po novém převedení sešitu znovu vyplnit.

    Odstraňte celý list API. (Skryté listy je možné zobrazit např.. po kliknutím pravým tlačítkem myši na jiný list a zvolením „Zobrazit…“)

    Přepněte se na záložku Vývojář a spusťte Visual Basic (případně pomocí klávesové zkratky Alt + F11) a zde odstraňte z VBAProject následující položky:

    • Modules – ABRAUtils
    • Modules – WebHelpers
    • Class Modules – Dictionary
    • Class Modules – HttpBasicAuthenticator
    • Class Modules – IWebAuthenticator
    • Class Modules – WebClient
    • Class Modules – WebRequest
    • Class Modules – WebResponse

    Výše vypsané body naleznete na této obrazovce. Tu spustíte v režimu Vývojář, viz popis výše.

    Kontrola uživatelských změn a maker

    Ve Visual Basic zvolte menu „Debug“ a zde funkci „Compile VBAProject“.

    Všechny skripty/makra musí být před převedením v daném sešitu Excelu zkompilované. Zde nejčastěji dochází k problémům mezi operačními systémy Windows a macOS, kdy sešit vytvořený na jednom operačním systému nebude fungovat na druhém a naopak. Nejlépe tedy mít, pokud je potřeba pro každý operační systém vlastní sešit.

Poté, co provedete úvodní instalaci a nastavení, můžete v excelových sešitech (upravených instalátorem a doplněných o přihlašovací údaje k Web API) začít používat níže popsané funkce. Funkce se používají úplně stejně, jako běžné funkce v Excelu. Na základě zadaných argumentů vracejí hodnoty získávané ze systému ABRA FLORES.

V textu níže zmíníme všechny dostupné funkce a seznamy argumentů. Argumenty uvedené kurzívou jsou volitelné. Je možné uvést pouze povinné argumenty, nebo povinné argumenty a prvních několik volitelných argumentů. Vždy je nutné dodržovat pořadí argumentů.

Pokud neuvedete hodnotu argumentu výčet firem, získáte hodnotu za všechny firmy.

Argumenty excelových funkcí jsou ekvivalentem query parametrů odpovídajících Web API zdrojů, u jednotlivých funkcí jsou proto uvedeny odkazy na tyto zdroje, které můžete využít jako zdroj dalších informací.

Většina funkcí je k dispozici ve dvou variantách:

  • funkce s názvy uvozenými prefixem Get- umožňují použití všech parametrů příslušného zdroje
  • funkce s názvy uvozenými prefixem Abra- zpravidla nabízejí úspornější zápis, kdy jsou za část parametrů dosazeny výchozí hodnoty

Všechny funkce vyžadují zadání hodnot argumentů URL, jméno a heslo pro přihlášení k Web API. Pravděpodobně je budete zadávat formou odkazu do buněk na listu API, který do sešitu vložil instalátor. Z tohoto předpokladu vycházejí i všechny uvedené ilustrační příklady - argumenty URL;Username;Password; znamenají následující:

  • na listu API je v konkrétní buňce (C3) zadáno URL Web API serveru; tato buňka je pro snadnější odkazování pojmenována URL
  • v další buňce (C4) je zadáno přihlašovací jméno do Web API; tato buňka je pojmenována Username
  • v další buňce (C5) je zadáno heslo tohoto uživatele; tato buňka je pojmenována Password

Jinými slovy, v příkladech používaný zápis:

=AbraSale(URL;Username;Password;"a";"1.1.2019";"31.12.2019")

je ekvivalentem následujícího zápisu:

=AbraSale(API!$C$3;API!$C$4;API!$C$5;"a";"1.1.2019";"31.12.2019")

Pokud si nejste jistí přesným názvem konkrétní funkce, množinou podporovaných argumentů nebo jejich pořadím, postupujte následovně:

  • V MS Excelu do řádku vzorců vepište začátek názvu funkce, tj.:
    =Abra
    nebo
    =Get
    Zobrazí se vám seznam dostupných funkcí začínajících zadaným řetězcem, podle anglického názvu požadovanou funkci vyberte (poklepejte na její název myší).
  • Po poklepání na název funkce se do řádku vzorců vloží celý název funkce včetně otevírací závorky a systém očekává zadání argumentů:
    =AbraAsset(
    V tomto bodě můžete stisknout klávesovou zkratku shift+ctrl+A, která do řádku vzorců k funkci doplní seznam argumentů a uzavírací závorku, případně ctrl+A , která vyvolá dialog, ve kterém je možné hodnoty jednotlivých argumentů zadat interaktivně.

Pokud je argumentem určité funkce výčet, je možné jednotlivé hodnoty oddělit čárkami a získat tak například hodnotu za několik vyjmenovaných středisek.

=AbraBalance(URL;jméno;heslo;výčet účtů;datum;výčet středisek)
=AbraBalance(URL;Username;Password;"6";"31.12.2019";"000,100,400")

  • Funkce GetTurnover vrací obraty z účetního deníku a volitelně i z účetních žádostí. Má celkem 16 argumentů. 

    =GetTurnover(URL;jméno;heslo;výčet účtů;započítat žádosti ano/ne;datum od;datum do;výčet středisek;střediska včetně podřízených ano/ne;výčet zakázek;zakázky včetně podřízených ano/ne;výčet obchodních případů;obchodní případy včetně podřízených ano/ne;výčet projektů;projekty včetně podřízených ano/ne;výčet firem)

  • K dispozici je také zjednodušená varianta AbraTurnover:

    =AbraTurnover(URL;jméno;heslo;výčet účtů;datum od;datum do;výčet středisek;výčet zakázek;výčet obchodních případů;výčet projektů;výčet firem)

    Místo argumentů, které jsou ve funkci GetTurnover navíc, se při použití funkce AbraTurnover dosadí výchozí hodnoty: započítat žádosti ano, střediska, zakázky, obchodní případy a projekty bez podřízených.

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Obrat na účtu 22110 za roky 2005 až 2010 včetně účetních žádostí na střediscích 000 a 100 (bez podřízených), ale jen za firmu s kódem 00002:

    =AbraTurnover(URL;Username;Password;"22110";"1.1.2005";"31.12.2010";"000,100";;;;"00002")

    Pokud by bylo zapotřebí změnit některé argumenty nahrazené ve funkci AbraTurnover výchozími hodnotami (např. nezohledňovat účetní žádosti nebo započítávat střediska včetně podřízených), bylo by nutné použít variantu GetTurnover.

    Pokud potřebujete zjistit obrat pouze na jedné straně účtu, použijte v argumentu výčet účtů postfix -A (MD) nebo -B (Dal):

    =AbraTurnover(URL;Username;Password;"22110A";"1.1.2005";"31.12.2010";"000,100";;;;"00002")

    Argument výčet účtů provede dohledání všech účtů, jejichž kód začíná zadaným řetězcem. Pokud nás tedy zajímají všechny výnosové účty (třída 6), nemusíme je explicitně vyjmenovávat, ale zavoláme funkci s následujícími argumenty:

    =AbraTurnover(URL;Username;Password;"6";"1.1.2005";"31.12.2010";"000,100";;;;"00002")

  • Poslední variantou je funkce GetTurnoverSimple:

    =GetTurnoverSimple(URL;jméno;heslo;datum od;datum do;omezení)

    Podrobnosti k argumentu omezení viz parametr conditions v popisu zdroje turnover-simple.

Implementace excelových funkcí GetTurnover a AbraTurnover provádějí dotazování zdroje turnover, GetTurnoverSimple dotazuje zdroj turnover-simple. V popisu těchto zdrojů naleznete také podrobnější informace k jednotlivým parametrům.

  • Funkce GetBalance slouží k získávání informací o zůstatcích účtů k určitému datu (z účetního deníku, případně také z účetních žádostí).

    =GetBalance(URL;jméno;heslo;výčet účtů;započítat žádosti ano/ne;datum;výčet středisek;střediska včetně podřízených ano/ne)

  • K dispozici je také zjednodušená varianta AbraBalance:

    =AbraBalance(URL;jméno;heslo;výčet účtů;datum;výčet středisek)

    Účetní žádosti se při použití funkce AbraBalance započítávají vždy, podřízená střediska se naopak nezapočítávají nikdy.

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Celkový zůstatek na účtu 02100 ke dni 31. 12. 2018.

    =AbraBalance(URL;Username;Password;"02100";"31.12.2018")

    Podobně jako v případě funkce AbraTurnover, pokud nechceme započítat účetní žádosti a/nebo chceme započítat podřízená střediska, je zapotřebí použít variantu GetBalance.

    Argument výčet účtů provede dohledání všech účtů, jejichž kód začíná zadaným řetězcem. Pokud nás tedy zajímají všechny výnosové účty (třída 6), nemusíme je explicitně vyjmenovávat, ale zavoláme funkci s následujícími argumenty:

    =AbraBalance(URL;Username;Password;"6";"31.12.2018")

Implementace excelových funkcí GetBalance a AbraBalance provádějí dotazování zdroje balance, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

  • Funkce GetStock slouží k získávání informací o stavu skladu (počet, cena) k určitému datu podle zvolených kritérií.

    =GetStock(URL;jméno;heslo;typ informace;datum;výčet skladových menu;výčet skladových typů;výčet skladových karet;výčet skladů)

    Typ informace může nabývat hodnot q (počet) nebo a (skladová cena).

  • K dispozici je také varianta AbraStock, která se volá se stejnými argumenty, jedná se tedy o synonyma.

    =AbraStock(URL;jméno;heslo;typ informace;datum;výčet skladových menu;výčet skladových typů;výčet skladových karet;výčet skladů)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Celkové množství položek ze skladového menu HW ke dni 31. 12. 2018 na skladech s kódy 01 a 02.

    =AbraStock(URL;Username;Password;"q";"31.12.2018";"HW";;;"01,02")

Implementace excelových funkcí GetStock a AbraStock provádějí dotazování zdroje stock, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

  • Funkce GetMoves slouží k získávání informací o skladových pohybech (počet, cena) za určité období podle zvolených kritérií.

    =GetMoves(URL;jméno;heslo;typ informace;datum od;datum do;výčet skladových menu;výčet skladových typů;výčet skladových karet;výčet skladů;výčet středisek;střediska včetně podřízených ano/ne;výčet zakázek;zakázky včetně podřízených ano/ne;výčet obchodních případů;obchodní případy včetně podřízených ano/ne;výčet projektů;projekty včetně podřízených ano/ne;výčet firem)

    Typ informace může nabývat hodnot q (počet) nebo a (skladová cena).

  • K dispozici je také varianta AbraMoves, při jejímž použití se do výpočtu nezahrnují podřízená střediska, zakázky, obchodní případy a projekty (pokud je potřebujete zahrnout, použijte variantu GetMoves; totéž platí pro ostatní funkce).

    =AbraMoves(URL;jméno;heslo;typ informace;datum od;datum do;výčet skladových menu;výčet skladových typů;výčet skladových karet;výčet skladů;výčet středisek;výčet zakázek;výčet obchodních případů;výčet projektů;výčet firem)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Celková skladová cena zásob všech položek na všech skladech, se kterými byly provedeny skladové pohyby v roce 2019.

    =AbraMoves(URL;Username;Password;"a";"1.1.2019";"31.12.2019")

Implementace excelových funkcí GetMoves a AbraMoves provádějí dotazování zdroje moves, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

  • Funkce GetSale slouží k získávání informací o prodejích skladových položek (počet, prodejní cena bez DPH) za určité období podle zvolených kritérií.

    =GetSale(URL;jméno;heslo;typ informace;datum od;datum do;výčet skladových menu;výčet skladových typů;výčet skladových karet;výčet skladů;výčet středisek;střediska včetně podřízených ano/ne;výčet zakázek;zakázky včetně podřízených ano/ne;výčet obchodních případů;obchodní případy včetně podřízených ano/ne;výčet projektů;projekty včetně podřízených ano/ne;výčet firem)

    Typ informace může nabývat hodnot q (počet) nebo a (prodejní cena bez DPH).

  • K dispozici je také varianta AbraSale, při jejímž použití se do výpočtu nezahrnují podřízená střediska, zakázky, obchodní případy a projekty (pokud je potřebujete zahrnout, použijte variantu GetSale; totéž platí pro ostatní funkce).

    =AbraSale(URL;jméno;heslo;typ informace;datum od;datum do;výčet skladových menu;výčet skladových typů;výčet skladových karet;výčet skladů;výčet středisek;výčet zakázek;výčet obchodních případů;výčet projektů;výčet firem)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Celková prodejní cena bez DPH všech položek prodaných v roce 2019.

    =AbraSale(URL;Username;Password;"a";"1.1.2019";"31.12.2019")

Implementace excelových funkcí GetSale a AbraSale provádějí dotazování zdroje sale, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

  • Funkce GetReceivable slouží k získávání informací o pohledávkách - vrací částku zvoleného typu vypočítanou podle zvolených kritérií.

    =GetReceivable(URL;jméno;heslo;typ informace;datum dokladu od;datum dokladu do;datum splatnosti od;datum splatnosti do;výčet firem;měna)

    Typ informace může nabývat hodnot t (celkem), p (zaplaceno), np (nezaplaceno) nebo c (dobropisováno). V případě uvedení nepovinného argumentu měna se zohlední pouze doklady vystavené v této měně.

  • K dispozici je také varianta AbraReceivable, která se volá se stejnými argumenty, jedná se tedy o synonyma.

    =AbraReceivable(URL;jméno;heslo;typ informace;datum dokladu od;datum dokladu do;datum splatnosti od;datum splatnosti do;výčet firem;měna)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Dosud neuhrazená částka pohledávek vystavených v roce 2011 pro firmu 00011, v lokální měně.

    =AbraReceivable(URL;Username;Password;"np";"1.1.2011";"31.12.2011";;;"00011")

Implementace excelových funkcí GetReceivable a AbraReceivable provádějí dotazování zdroje receivable, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

  • Funkce GetPayable slouží k získávání informací o závazcích - vrací částku zvoleného typu vypočítanou podle zvolených kritérií.

    =GetPayable(URL;jméno;heslo;typ informace;datum dokladu od;datum dokladu do;datum splatnosti od;datum splatnosti do;výčet firem;měna)

    Typ informace může nabývat hodnot t (celkem), p (zaplaceno), np (nezaplaceno) nebo c (dobropisováno). V případě uvedení nepovinného argumentu měna se zohlední pouze doklady vystavené v této měně.

  • K dispozici je také varianta AbraPayable, která se volá se stejnými argumenty, jedná se tedy o synonyma.

    =AbraPayable(URL;jméno;heslo;typ informace;datum dokladu od;datum dokladu do;datum splatnosti od;datum splatnosti do;výčet firem;měna)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Celková částka závazků vůči firmě 00006 z dokladů vystavených v roce 2018, v lokální měně, bez ohledu na stav zaplacení.

    =AbraPayable(URL;Username;Password;"t";"1.1.2018";"31.12.2018";;;"00006")

Implementace excelových funkcí GetPayable a AbraPayable provádějí dotazování zdroje payable, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

  • Funkce GetDepreciation slouží k získávání informací o odpisech - vrací celkovou výši účetních nebo daňových odpisů vypočítanou podle zvolených kritérií.

    =GetDepreciation(URL;jméno;heslo;typ informace;datum dokladu od;datum dokladu do;výčet druhů majetku;výčet účetních odpisových skupin;výčet daňových odpisových skupin;výčet umístění;umístění včetně podřízených ano/ne;výčet odpovědných osob;výčet evidenčních středisek;evidenční střediska včetně podřízených ano/ne)

    Typ informace může nabývat hodnot a (účetní odpisy) nebo t (daňové odpisy).

  • K dispozici je také varianta AbraDepreciation, při jejímž použití se do výpočtu nezahrnují podřízená umístění a podřízená evidenční střediska (pokud je potřebujete zahrnout, použijte variantu GetDepreciation; totéž platí pro ostatní funkce).

    =AbraDepreciation(URL;jméno;heslo;typ informace;datum dokladu od;datum dokladu do;výčet druhů majetku;výčet účetních odpisových skupin;výčet daňových odpisových skupin;výčet umístění;výčet odpovědných osob;výčet evidenčních středisek)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Celková výše daňových odpisů za rok 2018 za střediska 01 a 02.

    =AbraDepreciation(URL;Username;Password;"t";"1.1.2018";"31.12.2018";;;;;;"01,02")

Implementace excelových funkcí GetDepreciation a AbraDepreciation provádějí dotazování zdroje depreciation, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

Pokud při používání Web API zdroje depreciation uvedete parametr date-from (resp. ve funkci GetDepreciation nebo AbraDepreciation v prostředí MS Excelu použijete argument datum dokladu od), zahrnou se do výpočtu pouze odpisy, které jsou zaúčtované.

V opačném případě (pokud datum dokladu od neuvedete) se započítají všechny odpisy bez ohledu na zaúčtování.

Pokud chcete získat hodnotu všech zaúčtovaných odpisů od začátku odepisování, parametr resp. argument specifikující začátek intervalu použijte, ale jako počáteční datum uveďte 1.1.1900 (MS Excel) resp. 1900-01-01 (Web API).

  • Funkce GetAsset slouží k získávání informací o stavu majetku - vrací vstupní nebo zůstatkovou cenu vypočítanou podle zvolených kritérií.

    =GetAsset(URL;jméno;heslo;typ informace;datum stavu;výčet druhů majetku;výčet účetních odpisových skupin;výčet daňových odpisových skupin;výčet umístění;umístění včetně podřízených ano/ne;výčet odpovědných osob;výčet evidenčních středisek;evidenční střediska včetně podřízených ano/ne)

    Typ informace může nabývat hodnot tb (daňová vstupní cena), ab (účetní vstupní cena), tr (daňová zůstatková cena) nebo ar (účetní zůstatková cena).

  • K dispozici je také varianta AbraAsset, při jejímž použití se do výpočtu nezahrnují podřízená umístění a podřízená evidenční střediska (pokud je potřebujete zahrnout, použijte variantu GetAsset; totéž platí pro ostatní funkce)..

    =AbraAsset(URL;jméno;heslo;typ informace;datum stavu;výčet druhů majetku;výčet účetních odpisových skupin;výčet daňových odpisových skupin;výčet umístění;výčet odpovědných osob;výčet evidenčních středisek)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Daňová zůstatková cena majetku ke dni 31. 12. 2018 přiřazeného osobě s ID 4000000101.

    =AbraAsset(URL;Username;Password;"tr";"31.12.2018";;;;;"4000000101")

Implementace excelových funkcí GetAsset a AbraAsset provádějí dotazování zdroje asset, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

  • Funkce GetPayroll slouží k získávání informací z oblasti mezd a personalistiky - vrací informace různých typů vypočítané podle zvolených kritérií.

    =GetPayroll(URL;jméno;heslo;typ informace;výčet mzdových období;výčet druhů pracovních poměrů;výčet středisek;střediska včetně podřízených ano/ne)

    Typ informace může nabývat hodnot n (počet mzdových listů), d (úvazky v hodinách), f (fond pracovní doby), t (odpracovaná doba) nebo g (hrubá mzda).

  • K dispozici je také varianta AbraPayroll, při jejímž použití do výpočtu nezahrnují podřízená střediska. (Středisky se rozumí střediska, na kterých jsou evidovány pracovní poměry.) Pokud podřízená střediska potřebujete zahrnout, použijte variantu GetPayroll.

    =AbraPayroll(URL;jméno;heslo;typ informace;výčet mzdových období;výčet druhů pracovních poměrů;výčet středisek)

    Instalátor vložil do sešitu list API, na kterém jsme do buňky C3 pojmenované URL zapsali URL Web API serveru, do buňky C4 pojmenované Username přihlašovací jméno a do buňky C5 pojmenované Password heslo. Zbývající argumenty zajistí, že se v buňce zobrazí následující hodnota: Celková odpracovaná doba v hodinách za mzdové období 2018/12, pouze HPP.

    =AbraPayroll(URL;Username;Password;"t";"2018/12";"HPP")

Do argumentu výčet mzdových období je zapotřebí předávat kódy mzdových období ve stejném tvaru, ve kterém jsou zadány v systému ABRA FLORES, tj. např. 2019/03 (nikoli 2019/3 nebo 2019/003). Nejedná se o položku složenou z roku, lomítka a pořadového čísla měsíce, ale o kód období (textový řetězec).

Implementace excelových funkcí GetPayroll a AbraPayroll provádějí dotazování zdroje payroll, v jehož popisu naleznete podrobnější informace k jednotlivým parametrům.

Jak je uvedeno v sekci Instalace a nastavení, při používání funkcí pro MS Excel resp. příslušných Web API zdrojů se zohledňují práva k objektům. Web API zdroj payroll (a tedy i funkce GetPayroll a AbraPayroll) vyžadují právo Zobrazit pro používané řady dokladů dílčích mzdových listů.

  • abra-utils-installer.xlsm - Instalátor sloužící k doplnění potřebné funkcionality do vašich vlastních sešitů. Podrobnější informace naleznete v části Nastavení a instalace.

  • abra-utils-template-simple.xlsm - Vzorový sešit sloužící pro inspiraci, jakým způsobem je možné jednotlivé funkce využívat. Obsahuje konkrétní ukázky použití všech podporovaných funkcí. (Podobné sešity si budete vytvářet sami, dle svých specifických potřeb.)

V rozhraní Web API je implementována sada speciálních zdrojů, které umožňují snadné získávání nejrůznějších údajů z účetnictví, skladového hospodářství, prodeje, pohledávek a závazků, evidence a odpisů majetku nebo mezd a personalistiky.

Všechny zdroje z této skupiny akceptují dotazy v podobě GET požadavků (s parametry předávanými v URL) a vracejí odpovědi ve formátu prostého textu (konkrétní číselné hodnoty).

Web API serveru zašleme požadavek v následujícím tvaru:

GET http://localhost:81/demodata/utils/stock?date-to=2019-10-15&stores=04&store-cards=G04101&information-type=q

Obratem obdržíme odpověď:

Status: 200 OK 

20

Jednoduchým způsobem jsme tak zjistili, že se na skladu 04 ke dni 15. 10. 2019 nacházelo 20 kg jablek (skladová karta s kódem G04101).

Aby bylo možné podobné informace získávat a pracovat s nimi i bez detailních znalostí rozhraní Web API, tj. bez nutnosti sestavovat URL s požadavky a odpovědi nějakým způsobem zpracovávat, součástí rozšíření je předpřipravená sada funkcí pro MS Excel, které tyto činnosti vykonávají na pozadí (funkce se dotazují do Web API zdrojů, vrácené hodnoty se zobrazují v buňkách v excelovém sešitu).

K plnému využití funkcionality tak uživatelům postačují znalosti základů práce v MS Excelu (používání funkcí).

Do verze 19.1 včetně byla se systémem ABRA FLORES dodávána starší verze funkcionality, která umožňovala zjišťovat obraty na účtech, rovněž přímo prostřednictvím Web API nebo na Web API navázaných funkcí v Excelu.

Tato původní funkcionalita byla ve verzi 19.2 plně nahrazena (balíček funkcí instalovaných instalátorem zahrnuje i funkce GetTurnover a AbraTurnover), nicméně je stále plně funkční a pokud vám původní řešení vyhovuje, můžete ho používat i nadále, níže naleznete jeho popis.

S přechodem na verzi 19.2 nebo novější nemusíte doplněk nebo stávající sešity nijak upravovat, ale pro jejich používání budete nově potřebovat licenci k modulu WebAPI doplňky.

Rozdíly obou řešení:

Vlastnost ABRA FLORES 19.1 a nižší ABRA FLORES 19.2 a vyšší Poznámka
Způsob instalace XLA doplněk do MS Excelu (GetTurnoverAPI.xla) XLSM instalátor upravující jednotlivé sešity -
Umístění funkcí v doplňku přímo v sešitech, ve kterých se funkce používají -
Použitelnost funkcí v sešitech XLS, XLSX, XLSM XLSM -
Pokrytých oblastí 1 (obraty na účtech) 10 -
Licenční požadavky Web API Web API + WebAPI doplňky Verze 19.2 a novější umožňují využívání původní verze řešení (s XLA doplňkem), ale i pro ni je nově zapotřebí licence k modulu WebAPI doplňky (od verze 19.2 jsou licencovány všechny související WebAPI zdroje pro funkce v MS Excelu, včetně zdrojů turnover a turnover-simple).

,Existuje doplněk NxTurnover.xla, který umožňuje získávat výstupní účetní přehledy přes FLORES OLE rozhraní. Obdobná funkcionalita (rovněž ve formě doplňku pro aplikaci MS Excel a sešitu s ukázkami použití) je dostupná také ve verzi využívající rozhraní Web API.

Stejně jako OLE varianta slouží tento doplněk k vytváření přehledů o účetních obratech na základě dat získávaných ze systému ABRA FLORES v reálném čase. Funkčně jsou obě verze shodné, pokud dosud ani jednu z nich nevyužíváte a máte možnost volby, zvolte si tuto Web API verzi.

Co je k provozu zapotřebí:

  • Přidat do MS Office doplněk GetTurnoverAPI.xla, který je součástí nainstalovaného produktu ABRA FLORES (naleznete jej přímo v kořenové složce).

    V MS Office 2013/2016 doplněk nainstalujete postupnou volbou položek menu/funkcí Soubor, Možnosti, Doplňky, Spravovat: Doplňky Excelu, Přejít, Procházet. Následně vyberete GetTurnoverAPI.xla ze složky, ve které máte nainstalovanou aplikaci ABRA FLORES.

  • Zprovoznit Web API.
  • Získat licenci k modulu WebAPI doplňky.
  • Uživateli, který bude k datům prostřednictvím Web API přistupovat, nastavit potřebná oprávnění.

Použití je patrné z ukázkového souboru GetTurnoverAPIExample.xls. V souboru jsou použity funkce definované ve zmíněném doplňku GetTurnoverAPI.xla, konkétně GetTurnover, GetTurnoverSimple, Real a AbraTurnover. Tyto funkce se připojují do systému ABRA FLORES přes Web API rozhraní a vracejí obraty z účetnictví na základě předaných parametrů.

  • Funkce GetTurnover:

    Funkce vrací obraty z agendy Účetní deník a volitelně i z agendy Účetní žádosti. Odpovídá metodě GetTurnover objektu BookEntry z OLE. Má celkem 16 parametrů.

    =GetTurnover(URL;jméno;heslo;výčet účtů;započítat žádosti ano/ne;datum od;datum do;výčet středisek;střediska včetně podřízených ano/ne;výčet zakázek;zakázky včetně podřízených ano/ne;výčet obchodních případů;obchodní případy včetně podřízených ano/ne;výčet projektů;projekty včetně podřízených ano/ne;výčet firem)

  • Funkce GetTurnoverSimple:

    Funkce vrací obraty z agendy Účetní deník a volitelně i z agendy Účetní žádosti. Odpovídá metodě GetTurnoverSimple objektu BookEntry z OLE. Včetně přihlašovacích údajů má pouze 6 parametrů, veškerá omezení se funkci předávají posledním parametrem ve formě strukturovaného řetězce.

    =GetTurnoverSimple(URL;jméno;heslo;datum od;datum do;omezení)

  • Funkce Real:

    Funkce vrací obraty z agendy Účetní deník a volitelně i z agendy Účetní žádosti. Odpovídá zjednodušené metodě GetTurnover objektu BookEntry z OLE. Jedná se o zjednodušenou variantu funkce GetTurnover - podřízené dimenze se nikdy nezapočítávají, žádosti se započítávají vždy.

    =Real(URL;jméno;heslo;výčet účtů;datum od;datum do;výčet středisek;výčet zakázek;výčet obchodních případů;výčet projektů;výčet firem)
  • Funkce AbraTurnover je synonymem funkce Real.

Funkce v některých případech neberou v potaz účty, kde jsou v analytice zadány znaky používané jako řídící znaky dané funkce, tj. D či MD. Např. pokud bychom měli účty s kódy 520BYT a 520DUM. Funkce by pro účet 520DUM vrátila chybnou hodnotu, jelikož nerozlišuje znak obsažený v kódu analytiky od řídícího znaku D pro určení obratu na straně Dal. Proto funkce pro takové účty nevyužívejte. Obdobně, pokud by se účet jmenoval např. 520MdBYT apod.

Pokud je GetTurnoverAPI.xla přidáván do aplikace Excel na terminálovém serveru (tj. GetTurnoverAPI.xla je načítán ze sítě), je nutné při jeho instalaci nekopírovat doplněk do lokální knihovny (na toto je uživatel při importu doplňku dotázán). Pokud by došlo k jeho zkopírování, nebude funkční.

Použití funkcí a možný způsob zadání parametrů je zřejmý z následujícího obrázku. U funkce Real resp. TurnoverAbra nelze nastavovat započtení žádostí a výpis včetně podřízených, viz výše, což je v příkladu zvýrazněno tím, že jsou příslušné buňky s hodnotami započítat žádosti a včetně podřízených tmavě podbarvené.

Všechny čtyři funkce při tomto zadání vrátí stejnou hodnotu, tj. obrat za rok 2008 na straně D účtů 343 s omezením za středisko 000 bez podřízených, z deníku i žádostí. Pokud by u funkce GetTurnover bylo nastaveno započítat žádosti=False, příp. pokud by u středisek atd. bylo nastaveno včetně podřízených=True, mohly by být výsledné hodnoty u obou funkcí s ohledem na konkrétní data jiné.

Červené zvýraznění naznačuje, jak se řeší přihlášení do API - URL k API včetně aliasu spojení, jméno a heslo jsou uloženy v samostatných buňkách a ve vzorci s funkcí GetTurnaround jsou použity odkazy na tyto buňky. Funkční ukázka je k dispozici ve zmíněném souboru GetTurnaroundAPIExample.xls.

Web API požadavek, kterým uvedené VBA funkce implementované v doplňku GetTurnoverAPI.xla získávají požadované hodnoty, vypadá například takto:

http://localhost:699/data/bookentries/turnover?date-from=2008-01-01&date-to=2008-12-31&accounts=343MD&divisions=000&include-requests=true

Více informací viz popis zdrojů turnover a turnover-simple v kapitole Web API zdroje pro funkce v MS Excelu.