Příklad spouštění akcí pomocí zpráv

Upravit obsah stránky

Při přípravě a dalším rozšiřování možností cílové aplikace se v rámci replikátoru nebo intranetu připravují a generují tzv. transformační procesy. Tyto procesy lze následně vyvolávat i nepřímo, a to pomocí zaslání zprávy do doplňku (add-on), který má daný transformační proces registrován a aktivně jej zpracuje. 

Zpráva sloužící ke spuštění transformace musí mít specifickou formu, kterou může zajistit buď:
    bullet

    server automaticky, např. při uložení dokumentu, který obsahuje prvek nastavený jako messenger, nebo

    bullet

    ji lze odeslat manuálně pomocí požadavku <send-message>.


Tento požadavek musí být sestaven na základě:
    bullet

    znalosti ID uživatele s patřičnými oprávněními (tj. uživatele, pod kterým je přihlášen transformační add-on),

    bullet

    správného typu zprávy a

    bullet

    přesně definovaného obsahu zprávy.

Klíčové parametry zprávy

    bullet

    Typ zprávy:

    @type="1"
    

    bullet

    Obsah zprávy:

     @msg="doc-type={#typ-dokumentu} d-key={#primární-klíč} [xds-id={#xds-id}] [&{parametr}={hodnota}]..."
    

Taková zpráva tedy musí vždy obsahovat minimálně:
    bullet

    atribut

    doc-type
    – typ cílového dokumentu,

    bullet

    atribut

    d-key
    – primární klíč (ID) konkrétní instance dokumentu.

Volitelně může obsahovat i:
    bullet

    atribut xds-id – odkaz na konkrétní messenger prvek (pokud se v dokumentu vyskytuje více možností),

    bullet

    libovolné množství dalších parametrů, které odpovídají definici vstupů dané transformace (např. volba roku, měsíce, regionu apod.).


Každý transformační proces má seznam požadovaných parametrů uložen v souboru své konfigurace a bez jejich předání může být spuštění neúplné nebo zcela zamítnuto.

Příklad zprávy pro vyvolání transformace

Příklad zprávy, která spouští transformační proces pro dokument typu statistika_obchodu s ID 123, a předává tři vstupní parametry:
 
 <send-message user-id="5" type="1" 
    msg="doc-type='statistika_obchodu' d-key='123' params='idRegionu=9876&Rok=2013&Mesic=9'" />
 
Poznámka: Parametry uvedené v části params musí odpovídat definici vstupů v transformačním procesu – v opačném případě nemusí být požadavek zpracován očekávaným způsobem.