Preskoči na glavno vsebino

Používateľské tlačidlo

Ako si prispôsobiť ABRA Flexi pomocou používateľských tlačidiel?

Avtor: Petr Pech

Možnosti použitia

Používateľské tlačidlo slúži na prispôsobenie ABRA Flexi, keď dáva vývojárom a používateľom možnosť definovať vlastnú akciu vo forme tlačidla. Po aktivácii tlačidla dôjde k zobrazeniu panela v ABRA Flexi alebo k otvoreniu webového prehliadača, v oboch prípadoch s ľubovoľnou webovou stránkou.

Pomocou používateľského tlačidla môže byť zobrazená relevantná časť intranetového informačného systému, vyhľadaný tovar v porovnávači cien, otvorená príslušná časť webového rozhrania ABRA Flexi alebo vyvolaná akcia prostredníctvom nášho REST-API. Do adresy webovej stránky je možné dynamicky vkladať parametre ako napr. IČO práve upravovanej firmy alebo EAN zobrazeného tovaru.

Spôsob použitia

Parametre používateľského tlačidla ako napr. jeho text, cieľové URL alebo umiestnenie v ABRA Flexi sa zapíšu do definície tlačidla, súboru vo formáte XML. Vytvorená definícia používateľského tlačidla sa načíta do ABRA Flexi importom z XML súboru a pri opätovnom pripojení k firme bude tlačidlo súčasťou používateľského rozhrania (či už klientskej aplikácie alebo webového rozhrania).

Definícia používateľského tlačidla

Uvedenie niektorých prvkov je povinné (nepovinný prvok je browser), každý prvok môže byť v rámci definície jedného tlačidla uvedený najviac raz (výnimkou je prvok id). Súbor môže obsahovať definíciu viacerých používateľských tlačidiel; pri viacnásobnom uvedení definície tlačidla sa jednotlivé definície považujú za jeho aktualizáciu a fakticky sa prejaví posledná aktualizácia jeho vlastností. Nevyhovujúca definícia používateľského tlačidla bude odmietnutá už pri importe do ABRA Flexi.

id

  • Identifikátory záznamu slúžia na pridelenie kódu/skratky pri vytváraní a na presné určenie používateľského tlačidla pri jeho neskoršej aktualizácii alebo mazaní.

  • Na identifikáciu používateľského tlačidla je možné použiť:

    • Kód/skratku – používateľské označenie (prefix code:)

    • Externý identifikátor – identifikátor z externej aplikácie (prefix ext:)

    • Identifikátor ABRA Flexi – číselný nemenný identifikátor prideľovaný aplikáciou (bez prefixu)

  • Povinný prvok; pri vytváraní používateľského tlačidla musí byť prvok uvedený s kódom (skratkou).

  • Podrobnejšie informácie o použití prvku nájdete v časti Identifikátory záznamov.

url

  • Určuje URL webovej stránky alebo sieťového zdroja, ktorý sa po stlačení tlačidla otvorí.

  • URL musí byť uvedené v plnom, absolútnom tvare, t. j. musí obsahovať schému a doménovú adresu servera (napr. https://www.flexibee.eu/).

  • URL odporúčame zadávať v <![CDATA[ ]]>, aby prítomnosť znaku '&' nespôsobila nevalidné XML.

  • V hodnote URL nie je podporovaná URI schéma file používaná na prístup k lokálne uloženým súborom. Definície používateľských tlačidiel obsahujúce URL s file:// budú pri importe odmietnuté ako nepovolené.

  • Pri konštrukcii URL je možné uviesť premenné, ktoré budú vyhodnotené FreeMarkerom počas behu aplikácie a zabezpečia odovzdanie hodnôt z aplikácie. Napr. zápis ${object.ic} slúži na získanie IČO partnera v adresári. Reťazec object je v názvoch premenných povinný; pomocou neho sa odkazuje na aktuálny záznam zobrazenej evidencie. Zoznam dostupných atribútov jednotlivých evidencií je možné zobraziť vo webovom rozhraní (adresy ako https://localhost:5434/c/mojefirma/adresar/properties).

  • Podporované premenné:

    • object – aktuálny záznam (pozri predchádzajúci bod).

    • objectIds – zoznam ID vybraných záznamov oddelených čiarkou.

    • user – aktuálne prihlásený používateľ (pozri https://localhost:5434/c/mojefirma/uzivatel/properties).

    • url – úplná URL adresa objektu, na ktorom bolo tlačidlo vyvolané (napr. https://instance.flexibee.eu/c/demo/adresar/1).

    • companyUrl – adresa API rozhrania firmy, v ktorej je tlačidlo umiestnené (napr. https://instance.flexibee.eu/c/demo/).

    • evidence – názov evidencie, na ktorej je tlačidlo umiestnené.

    • authSessionId – autentizačný token aktuálnej relácie používateľa. Po dobu platnosti relácie ho možno využiť na autentizáciu dotazov. Pozri využitie autentizačného tokenu v popise Autentizácie.

    • customerNo – číslo zákazníka zodpovedajúce licencii.

    • licenseId – identifikátor licencie

    • flexiUrl - URL adresa webového rozhrania.

    • language - jazyk desktopovej aplikácie.

  • Pozor: Premenné object a objectIds sa vzájomne vylučujú!

evidence

  • Určuje evidenciu, príp. konkrétnu väzbu (reláciu) evidencie ABRA Flexi, pre ktorú má byť tlačidlo zobrazované.

  • Napr. adresar pre evidenciu obchodných partnerov, faktura-vydana pre evidenciu vydaných faktúr atď. Vo variante pre väzby určitej evidencie potom napr. faktura-vydana-polozka pre položky vydanej faktúry alebo majetek-zapujcka pre zapožičania v evidencii majetku atď.

  • Pre evidencie všeobecne použite reťazec zobrazovaný v URL webového rozhrania v sekcii evidencie (https://localhost:5434/c/mojefirma/cenik).

  • Zoznam všetkých evidencií je k dispozícii na adrese https://localhost:5434/c/mojefirma/evidence-list

  • Pre väzby evidencií všeobecne použite reťazec evidencie (pozri vyššie) doplnený o spojovník (pomlčku) a reťazec väzby zistený v prehľade väzieb evidencie (https://localhost:5434/c/mojefirma/cenik/relations).

location

  • Určuje zobrazenie tlačidla v prehľade záznamov alebo na karte konkrétneho záznamu.

  • Prípustné hodnoty:

    • list – pre prehľad záznamov

    • detail – pre konkrétny záznam

  • Ak má byť tlačidlo dostupné v paneli nástrojov v prehľade záznamov a zároveň na karte konkrétneho záznamu, je potrebné pripraviť dve definície používateľského tlačidla, ktoré sa budú líšiť hodnotou prvku location.

title

  • Text zobrazený na tlačidle.

description

  • Podrobný popis tlačidla zobrazovaný v bubline.

browser

  • Určuje prehliadač, v ktorom sa URL otvorí. Interný prehliadač sa zobrazí rýchlejšie, ale nemusí obsahovať používateľské prispôsobenie a údaje (heslá, cookies, údaje formulárov, navštívené odkazy). Externý prehliadač je prostredie, na ktoré je používateľ zvyknutý.

  • Nepovinný prvok, predvolená hodnota je automatic.

  • Z podstaty webového rozhrania je v ňom nastavenie prvku browser ignorované.

  • Prípustné hodnoty:

    • desktop – externý prehliadač

    • automatic – interný prehliadač; ak nie je dostupný, otvorí sa externý prehliadač

Príklad vytvorenia

<?xml version="1.0"?><winstrom version="1.0">  <custom-button>    <id>code:JUSTICECZ</id>    <url><![CDATA[https://or.justice.cz/ias/ui/rejstrik-$firma?ico=${object.ic}&jenPlatne=VSECHNY]]></url>    <title>Obch. rejst&#x159;&#xED;k</title>    <description>Zobraz z&#xE1;znam firmy v obchodn&#xED;m rejst&#x159;&#xED;ku justice.cz</description>    <evidence>adresar</evidence>    <location>detail</location>    <browser>desktop</browser>  </custom-button></winstrom>

Príklad aktualizácie tlačidla

Ak uvediete v definícii jednoznačnú identifikáciu existujúceho tlačidla, môžete ho aktualizovať. ABRA Flexi umožňuje čiastočné aktualizácie záznamov, takže pri zmene adresy obchodného registra vo vyššie uvedenom príklade stačí používateľské tlačidlo identifikovať a uviesť novú hodnotu URL:

<?xml version="1.0"?><winstrom version="1.0">  <custom-button>    <id>code:JUSTICECZ</id>    <url><![CDATA[https://or.justice.cz/ias/ui/rejstrik-$firma?ico=${object.ic}&jenPlatne=VSECHNY&polozek=500]]></url>  </custom-button></winstrom>

Príklad zmazania tlačidla

Na zmazanie existujúceho tlačidla je potrebné použiť atribút action (viac o jeho použití nájdete v časti Vykonávanie akcií). Používateľské tlačidlo z vyššie uvedeného príkladu možno zmazať pomocou:

<?xml version="1.0"?><winstrom version="1.0">  <custom-button action="delete">    <id>code:JUSTICECZ</id>  </custom-button></winstrom>
Sorodni članki
Prihlásenie do aplikácie
Problém s vrátením polí
Ako preniesť údaje z primaERP do Flexi
Užívateľské tlačidlá
Import faktúry vo formáte ISDOC cez REST API
Ste s tem dobili odgovor na svoje vprašanje?