Moduly

Moduly umožňují rozšířit funkcionalitu systému ObjectGears o nové funkce. Modulů můžete vytvořit kolik potřebujete a nasazení je velmi jednoduché.

Implementace

Moduly jsou implementovány jako DLL knihovna v .NET jazyce (C#, VB.NET...). Knihovna musí dědit ze třídy ModuleInterfaceBase z knihovny Com.ObjectGears.Common.dll.

Třída poskytuje několik metod a funkcí pro komunikaci mezi systémem ObjectGears a modulem.

Nasazení

Pro nasazení stačí nakopírovat dll soubor modulu do adresáře Modules webové aplikace. Zároveň jej nahrajte do adresáře Modules k windows službě. To pokud modul budete používat z workflow, jobů nebo asynchronních pravidel.

Po nakopírování restartujte webovou aplikaci, aby se načetl nový modul. Pokud již modul byl načtený dříve, pak nepůjde nakopírovat a je třeba nejprve aplikaci zastavit, nakopírovat nový modul a následně aplikaci zase spustit.

Stejná pravidla platí i pro window službu. Před kopírováním nového modulu službu nejdříve zastavte, nakopírujte a opět službu spusťte.

Pokud modul obsahuje více souborů nebo chcete používat různé verze jednoho modulu, pak jej umístěte do samostatného adresáře v adresáři Modules.

Po nasazení modulu není modul automaticky dostupný v systému. Automaticky je pouze načten, ale před použítím mu musíte přidělit vlastní kód na stránce Seznam modulů. Tímto kódem jej budete ze skriptů volat. Po nastavení/změně kódu modulu restartujte aplikaci a windows službu.

Vlastnosti modulu

Všechny nastavené moduly jsou zobrazeny v seznamu modulů na stránce Správa / Integrace / Moduly. V seznamu je možné si pomocí první ikony zobrazit vlastnosti modulu, nebo zobrazit všechny chybové záznamy v ErrorLogu. Pomocí ikony Registrace získáte přehled o všech funkcích, vlastnostech a metodách objektu, který modul vrací funkcí GetScriptObject(). 

Mezi vlastnostmi modulu je zobrazena verze modulu, jeho výrobce, název a popis.

Důležitá je vlastnost Kód. Ten musíte po nahrátí modulu ručně nastavit. Kód slouží pro volání modulu ze skriptů. Pokud kód nenastavíte, pak nemůžete modul používat.

Odesílání SMS

Modul může zajišťovat odesílání SMS směrem k telefonnímu operátoru. Pokud tuto funkcionalitu bude modul podporovat, pak systém ObjectGears ji bude dále podporovat při odesílání notifikace na distribuční skupinu s nastavenými telefony, případně při odeslání SMS pomocí skriptů.

Volání ve skriptech

Pro volání ve skriptech se používá následující objekt OG.Module.

OG.Module[kod]

Při volání se nejprve najde modul podle zadaného kódu, pak je na třídě modulu (dědí z ModuleInterfaceBase) zavolána funkce GetScriptObject(), která vrátí objekt, se kterým již můžete dělat, co chcete. Objekt má funkce a metody, které autor modulu zpřístupnil. Ty naleznete na stránce dostupné pod ikonou Registrace v seznamu modulů.

Webparty v modulech

V modulu můžete definovat své webparty, které je možné okamžitě (po zadání kódu modulu) přidávat na stránky. V případě, že modul není systémem později načten, jsou webparty z modulu skryty. Pokud obsluhujete takový to webpart pomocí skriptů, pak dojde k chybě.