Předvyplnění metadat dokumentu z URL

Pro zrychlení a zefektivnění práce uživatelů může být dialog pro vytvoření nového dokumentu vyvolán odkazem z externí aplikace. Odkaz již obsahuje data z externího systému, která se použijí na předvyplnění metadat dokumentu. Tato kapitola popisuje zásady, podle kterých má být takový odkaz sestaven.

Předvyplnění metadat nového dokumentu probíhá na základě dat předávaných v GET parametrech URL odkazu. Odkaz je vytvořen externí aplikací. Otevření prohlížeče s daným URL linkem provádí volající externí aplikace.

Odkaz se skládá ze dvou částí: statické a dynamické.

Statická část odkazu

Tvar odkazu vypadá například takto:

https://firemniserver.cz/create_docu.php

Tento URL link je standardně autentizovaný. Pokud jej použije nepřihlášený uživatel, proběhne před zobrazením příslušného dialogu přihlášení.

Dynamická část odkazu

Dynamická část se skládá z předávaných parametrů. Před každým parametrem se uvádí znak „&“, před folder se píše znak „?“.

Parametr 1

sid_fldr – zde se uvádí SID složky, do které se vloží nový dokument. Pokud není známý sid_fldr, FormFlow ohlásí chybu.

Parametr 2–N

Předávaná metadata k předvyplnění do dialogu. Název parametru je podle názvu metadat (NAME_META). Předávaná metadata jsou vázána na složku. Pokud je v odkazu uveden neznámý název metadata pro danou složku, bude tento parametr ignorován. Pokud metadatum není v odkazu nastaveno a v nastavení je výchozí hodnota, použije se výchozí hodnota z nastavení. A obráceně, pokud je hodnota nastavena v odkazu i ve výchozí konfiguraci, použije se hodnota z odkazu.

V parametrech mohou být předána následující metadata:

Název zobrazený v dialogu Název v URL Hodnota

SID složky

SID_FLDR

SID dokumentové složky (nelze použít diakritiku)

Spravovat LTD:

LTD_ACCEPT_DOCU

TRUE / FALSE

Konfigurace LTD:

ID_LTD_CONF_DOCU

Hodnota číselníku

Garant:

WARRANTOR_ID_GROU_DOCU

ID_GROU (např. 4123)

Zpracovatel dokumentu:

OFFICER_ID_USER_DOCU

ID_USER (např. 3951)

Stav:

ID_STAT_DOCU

Kód (nelze použít diakritiku)

Název dokumentu:

NAME_DOCU

Název (pouze bez diakritiky)

Dokumentová třída:

ID_CLAS_DOCU

Kód třídy (nelze použít diakritiku)

Klasifikace dokumentu:

ID_RANK_DOCU

Kód klasifikace (nelze použít diakritiku)

Skartační znak dokumentu:

SHRED_MARK_DOCU

Jakýkoli znak – při uložení je hlídán formát

Platnost dokumentu do:

SHRED_TE_VALID_UP_TO_DOCU

Datum zadané bez mezer, čas oddělen dvojtečkou (dd.mm.yyyy hh:ii:ss, např. 1.12.2017 3:55:12)

Počet let platnosti dokumentu:

SHRED_TE_VALIDITY_PERIOD_DOCU

Jakýkoli znak – při uložení je hlídán formát

Rok skartace dokumentu:

SHRED_YEAR_DOCU

Jakýkoli znak – při uložení je hlídán formát

ID obsluhovaného subjektu:

ID_CERT_DOCU

ID_CERT

JID:

JID_DOCU

Jakýkoli znak bez diakritiky

Číslo jednací:

CJ_DOCU

Jakýkoli znak bez diakritiky

Očekávané tvary jednotlivých datových typů metadat:

Typ metadata Očekávaný tvar

Číslo

1234

Datum

d.m.yyyy – 1.12.2017

Datum a čas

dd.mm.yyyy hh:ii:ss 1.12.2017 3:55:12

Text

Text

Číselník

Hodnota číselníku (nikoliv zobrazovaná hodnota)

Subjekt (uživatel nebo skupina)

ID uživatele nebo skupiny

Třída/klasifikace/stav

Kód stavu/třídy/klasifikace (nikoliv ID)

Obecně platí, že se nevyužívají ID z databáze (jen u uživatelů a skupin), ale jinak vždy kódy.

Příklad a očekávaný výstup

https://firemniserver.cz/create_docu.php?sid_fldr=DOCLI&ESX_DOCLI_DOCTYPE=1100&ESX_DOCLI_BCID=1257

Tento odkaz otevře dialog pro nový dokument ve složce „Klientská dokumentace“ (SID složky je DOCLI). Předvyplněna budou tato metadata:

  • Typ dokumentu bude „Úvěrová smlouva“ (klíč této hodnoty z číselníku typu dokumentů je 1100).

  • Číslo obchodního případu bude „1257“.