Definovatelné business objekty a agendy - obecně
Zde naleznete:
Vlastní údaje lze přidávat k existujícím agendám pomocí uživatelsky definovatelných položek. Extra položky s prefixem X_ rozšiřují příslušnou databázovou tabulku, obyčejné položky s prefixem U_ ukládají hodnoty do společné tabulky UserData. Definovatelný business objekt umožňuje vytvořit samostatnou datovou entitu s vlastní tabulkou a vlastní agendou.
Definovatelný business objekt řeší přesně tuto situaci: pro každou vlastní evidenci vznikne vlastní, vyhrazená databázová tabulka a REST API endpoint, stejně čistě, jako by šlo o běžnou, výrobcem dodávanou agendu. Vlastní řešení tak může postupně růst - dalšími položkami i dalšími evidencemi - bez dopadu na strukturu ostatních tabulek v systému. Jde o jednu z možností zákaznické modifikovatelnosti systému, určenou především konzultantům a vývojářům, kteří přizpůsobují řešení konkrétnímu zákazníkovi bez zásahu do zdrojového kódu.
Na definovatelném business objektu je pak možné - stejně jako na kterémkoli Business objektu dodaném výrobcem - dále postavit vlastní tiskovou sestavu, definovatelný formulář, přenášet jej mezi spojeními instalační sadou, nebo s ním pracovat přes REST API zcela bez nutnosti cokoli v GUI klikat.
Při založení business objektu v agendě Definice business objektů se volí jeden ze čtyř typů (položka Typ), který určuje, jaké vlastnosti objekt automaticky získá:
- Prázdný objekt - základní objekt s položkou Název, který lze rozšířit o vlastní položky.
- Číselníkový objekt - objekt typu Kód/Název, nad kterým vznikne číselníková agenda.
- Doklad - hlavičkový objekt dokladového typu; automaticky získá pole Firma a sekci Procesní řízení (Stav, Zodpovědná role, Zodpovědná osoba) se záložkou Historie změn stavu, aniž by je bylo nutné definovat jako vlastní položky, a lze mu založit vlastní řadu dokladů.
- Řádek - podřízený objekt navázaný na hlavičkový business objekt (systémový i jiný definovatelný) prostřednictvím položky Třída hlavičky. Řádkový objekt nemá samostatnou agendu - jeho záznamy se zobrazují jako editovatelný seznam (multigrid) v rámci hlavičky.
Typ objektu lze zvolit pouze při jeho založení - dodatečně už jej nelze změnit.
Definice vlastních business objektů a agend patří do databáze konkrétního spojení. V jiném spojení nejsou dostupné jen tím, že používá stejný aplikační server. Pro přenos řešení použijte instalační sadu.
Při vytvoření definovatelného objektu systém založí jeho databázovou tabulku, primární klíč a potřebné indexy podle typu objektu. U řádkového objektu vytvoří také cizí klíč na hlavičku. Tyto součásti nemusíte zakládat ručně v databázi.
Také pro záznamy definovatelných objektů platí omezení počtu záznamů v režimech Demo a Free. Počet se vyhodnocuje nad vlastní tabulkou příslušného objektu; vytvoření nové definice tato omezení neruší.
Vytvoření vlastního řešení se skládá z několika na sebe navazujících kroků, rozdělených do samostatných agend:
- Business objekt - v agendě Definice business objektů vznikne datový objekt a jeho databázová tabulka - určí se typ, interní názvy a technické identifikátory.
- Vlastní položky - v agendě Definovatelné položky se doplní, jaké údaje bude business objekt obsahovat.
- Agenda - v agendě Definice agend vznikne nad business objektem (kromě typu Řádek, který samostatnou agendu nemá) vizuální agenda, ve které budou uživatelé data evidovat, včetně jejího umístění v nabídce agend.
- Práva - teprve v roli/skupině rolí na záložce Práva k funkcím, kategorii Definovatelné agendy, se nová agenda zpřístupní uživatelům.
Business objekt tedy sám o sobě definuje jen datovou strukturu a úložiště - dokud nad ním nevznikne agenda (a dokud k ní role nezíská právo), nemají k němu uživatelé přes GUI přístup. Naproti tomu přes REST API je business objekt dostupný po obnovení metadat API, nezávisle na existenci vizuální agendy. Podrobnosti uvádí obnovení definic; při přístupu se uplatňují příslušná práva API.
Agendy Definice business objektů a Definice agend vyžadují licencování na pojmenované uživatele. Stejná licenční podmínka platí při zakládání nových definic přes API a další nevizuální rozhraní; bez odpovídající licence validace jejich uložení odmítne. Již nasazené definovatelné agendy a jejich datové záznamy lze používat nezávisle na tomto omezení tvorby definic. Přístup přes API navíc vyžaduje příslušné oprávnění a licenci pro API.
Krok za krokem, s konkrétním příkladem, popisuje postup návod Jak vytvořit definovatelnou agendu a celá skupina navazujících kapitol Definovatelné objekty.
Definovatelné business objekty, jejich tabulky, API endpointy a agendy mají automatické prefixy, které je odlišují od systémových objektů. Do definice zadáváte jen vlastní část názvu bez prefixu. Formulář prefix zobrazuje odděleně před editovatelnou částí pole; v definici se ukládá pouze zadaná část. Při registraci se použije úplný název s prefixem.
| Položka definice | Zadaná hodnota | Úplný název |
|---|---|---|
| Interní název třídy | ServiceRecord | DefBO_ServiceRecord |
| Název tabulky | ServiceRecords | ET$ServiceRecords |
| API endpoint | servicerecords | defbo_servicerecords |
| Interní název agendy | ServiceRecords | DefSite_ServiceRecords |
Stejné pravidlo platí při vytváření definic přes API: hodnoty polí name, tablename a apiendpoint se zadávají bez příslušného prefixu. Ruční zadání stejného prefixu znovu systém odmítne. Prázdný nepovinný API endpoint řádkového objektu zůstává prázdný.
Při práci s daty se používá úplný název: například REST cesta /<spojení>/defbo_servicerecords nebo název třídy DefBO_ServiceRecord ve skriptování. V OLE se při odkazování na třídu názvem používá @DefBO_ServiceRecord. Prefixy nemění CLSID ani uživatelské zobrazované názvy objektu a agendy.
Příklady najdete v návodech Jak vytvořit definovatelnou agendu, Založení přes REST API a OLE příklad 28.
Business objekty lze vzájemně kombinovat a odkazovat mezi sebou, obdobně jako systémové (výrobcem dodané) objekty:
- Existující agenda jako hlavička - Třída hlavičky řádkového objektu může být kterákoli registrovaná třída v systému, tedy i systémová (výrobcem dodaná) hlavičková agenda, např. Objednávky přijaté - a stejně tak i vlastní definovatelný číselníkový objekt, ne jen dokladový. Vznikne tak nová kolekce, která se na existující agendě zobrazí jako další samostatná záložka, aniž by bylo nutné do systémové agendy jakkoli zasahovat.
- Kolekce v kolekci - řádkový objekt může být hlavičkou pro další řádkový objekt, tedy jde vytvořit i vícestupňové vnořené kolekce. Na rozdíl od kolekce na existující agendě se ale vnořená kolekce v GUI nezobrazí automaticky - vyžaduje ruční doplnění pluginu Definovatelné řádky na definovatelný formulář rodičovského řádku.
- Odkaz do číselníku - vlastní položka business objektu může typem Identifikátor a cizím klíčem odkazovat do libovolného systémového i definovatelného číselníku, který je zaregistrován jako číselník. U vlastního číselníkového business objektu nejprve vytvořte jeho agendu typu Číselník; teprve tím vznikne číselník nabízený v definici položky.
Podrobný postup pro oba způsoby napojení na existující agendu (existující agenda jako hlavička i kolekce v kolekci) popisuje návod Jak připojit definovatelnou kolekci k existující agendě.
Definovatelná agenda se po svém vytvoření chová jako plnohodnotná agenda a zapojuje se do stejných standardních mechanismů systému jako agendy dodávané výrobcem:
- Fulltextové vyhledávání - definovatelnou agendu lze vybrat jako zdroj u nové definice v agendě Fulltextové hledání, stejně jako u kterékoli jiné agendy.
- Naplánované úlohy typu Tisk a Export - definovatelná agenda se nabízí i jako místo programu pro naplánovanou úlohu typu Tisk nebo Export.
- Omezení a třídění záznamů - podmínky omezení a klíče pro třídění se generují z vlastností business objektu. Základní podmínky, například Kód a Název u číselníku nebo Řada a Období u dokladu, mají přednost; ostatní generované podmínky jsou seřazeny podle zobrazovaného názvu. Nabídka zohledňuje také přítomnost údajů o vytvoření a opravě.
- Rozložení řádkového multigridu - zobrazení sloupců editovatelné kolekce nastavíte v editoru rozložení sloupců.
- Definovatelné importy - definovatelný business objekt lze zvolit jako Třídu objektu v agendě Definice definovatelných importů, takže lze pomocí definovatelných importů plnit data i do vlastní definovatelné agendy.
- Balíčky skriptů - ve výběrech pro skript typu Business objekt, Agenda a Číselník se nabízejí také odpovídající definovatelné objekty. V balíčku skriptů vyberte objekt podle jeho zobrazovaného názvu a požadovaný háček. Konstanty pro skriptování vycházejí z registrovaných interních názvů: například Class_DefBO_Complaint pro business objekt a Site_DefSite_Complaints nebo Roll_DefSite_Complaints pro agendu a její číselník. Číselníková konstanta je k dispozici jen u agendy s číselníkem.
- Uživatelské X-vazby - vlastní X-vazbu lze přidat i na záznam definovatelného business objektu.
- OLE (otevřené rozhraní) - se záznamy definovatelného business objektu lze pracovat i programově přes FLORES OLE, stejně jako u systémových objektů - viz Příklad 28. Přitom je potřeba pamatovat na to, že název třídy je za "@" potřeba doplnit o prefix DefBO_, který se do editovatelné části názvu v definici nezadává - viz popis funkcí CreateObject a CreateValues.