1. Objekt skriptu OG

    Článek: AN0002182Aktualizováno:: 09.03.2020

    Základní přístupový bod pro funkce společné všem skriptům. Tyto funkce jsou dostupné pro všechny skripty.

    Funkce skriptu

    Název Popis
    string GetAppVersion() Verze webové části aplikace.
    string GetActualLocalize() Funkce vrátí aktuální lokalizaci například cs-CZ nebo en-US.
    string GetActualShortLocalize() Funkce vrátí aktuální lokalizaci například cs nebo en.
    string GetWebUrl()

    Funkce vrátí URL na aktuální instanci systému ObjectGears.

    Funkce vždy vrací na konci URL lomítko. Hodnota se bere z web.configu nebo z aktuálního požadavku.

    int? PersonClassDefId Vlastnost vrací Id třídy vlastnosti pro uživatele.
    int? PersonColumnClassDefId Vlastnost vrací Id sloupce osoby ze třídy vlastností uživatele.
    int? PersonPhoneColumnClassDefId Vlastnost vrátí Id sloupce telefonu ze třídy vlastností uživatele.
    string GetAppConfigParameterString(string key) Funkce vrací hodnotu parametru z nastavení aplikace dle zadaného jména parametru.
    int? GetAppConfigParameterInt(string key) Funkce vrací hodnotu parametru z nastavení aplikace dle zadaného jména parametru.
    void EnvelopeToTransaction(ActionInTransaction action) Funkce pro spuštění více operací v jedné transakce.
    bool IsAcceptance Vlastnost určuje, zda jde o akceptační instanci ObjectGears.
    bool IsDevelopment Vlastnost určuje, zda jde o vývojovou instanci ObjectGears.
    bool IsProduction Vlastnost určuje, zda jde o produkční instanci ObjectGears.
    bool IsTest Vlastnost určuje, zda jde o testovací instanci ObjectGears.
    bool IsWebAccess Vlastnost určuje, zda jde o volani z webu a web service nebo admintoolu a winservice.
    JSRegistry Registry   Vlastnost pro práci s registry Windows.
    JSLog Log   Vlastnost pro práci s logem.
    JSNotification Notification   Vlastnost pro práci s upozorněními.
    JSColumn Column   Vlastnost pro práci se sloupci tříd a dotazů.
    JSContentPage ContentPage Vlastnost pro práci se stránkami.
    JSQuery Query   Vlastnost pro práci s dotazy.
    JSClassDef ClassDef   Vlastnost pro práci s třídami.
    JSDateTime DateTime Vlastnost pro práci s časem.
    JSDebug Debug Vlastnost pro práci s laděním.
    JSDistributionGroup DistributionGroup Vlastnost pro práci s distribučními skupinama.
    JSModel Model   Vlastnost pro práci s modely.
    JSModule Module Vlastnost pro práci s moduly.
    JSColor Color Vlastnost pro prácí s barvami.
    JSWorkflowSeq WorkflowSeq   Vlastnost pro práci s workflow.
    JSJob Job   Vlastnost pro práci s joby.
    JSPerson Person   Vlastnost pro práci s uživateli.
    JSEmail Email   Vlastnost pro práci s emailem.
    JSEncoding Encoding Vlastnost pro práci s kódováním.
    JSExport Export   Vlastnost pro práci s exporty.
    JSImport Import   Vlastnost pro práci s importy.
    JSIO IO Vlastnost pro práci se soubory a adresáři.
    JSDataParameter DataParameter   Vlastnost pro práci s datovými parametry.
    JSQueryString QueryString Objekt zjednodušující práci s proměnnými z url.
    JSReport Report Vlastnost pro práci s reporty.
    JSRole Role   Vlastnost pro práci s rolemi.
    JSDataRow DataRow   Vlastnost pro práci se záznamy ve třídách a dotazech.
    JSSql Sql   Vlastnost pro práci s SQL v databázi.
    JSScript Script Vlastnost pro práci se skripty.
    JSLanguage Language   Vlastnost pro práci s jazyky.
    Hashtable CreateHashtable Funkce vytvoří novou instanci hashtable.
    string GetLocText(string allLocalizeText) Funkce vrátí lokalizovaný text podle aktuálního nastavení uživatele. Do funkce předávejte text všech lokalizací.
    TypeBaseList GetAllEncodingCodePage() Funkce vrátí seznam všech v .NET Frameworku známých kódových stránek.
    void RunLogMaintenance() Metoda spustí Údržbu logů.
    object GetItem(string code) Funkce vrátí objekt podle zadaného kódu. Pokud objekt se zadaným kódem neexistuje, pak je vráceno NULL.
    void SetItem(string code, object value) Metoda uloží objekt pod zadaným kódem. Pokud již takový objekt existuje, pak bude přepsán.
    void Throw(string message) Metoda vyvolá vyjímku.
    IDbTransaction Trans Vlastnost vrátí aktuálně otevřenou transakci. Transakce je otevřena jen v určitých případech.
    void ReturnFileFromWeb(string fileName, string content, byte[] contentInBytes, string contentType, Encoding en) Funkce ukončí aktuální požadavek na serveru a vrátí obsah jako soubor na klienta.

    Konfigurační nastavení

    Význam některých následujících parametrů je popsán v konfiguraci systému ObjectGears.

    Název Popis
    int? PersonOrgStructureId  
    int? PersonGroupClassDefId  
    int? PersonsInGroupColumnClassDefId  
    int? GroupCodeColumnClassDefId  
    string ActualLocalize Aktuálně vybraná lokalizace systému: např. en-US
    string ActualShortLocalize Krátký název lokalizace:  cs, de, en
    string LDAP  
    string LDAPLogin  
    string LDAPPassword  
    bool EnablePersonDeputies  
    int? AuthenticateUsersRoleId Id role pro všechny autentifikované uživatele. Id je pro aktuální instanci.
    int? ReportRoleId Id role pro reporty. Id je pro aktuální instanci.
    bool LimitedAccess Příznak, zda je nastaven omezený přístup do systému.
    bool AssignRoleToUser  
    bool IsFormAuthentication Příznak, zda je nastavena forms autentifikace (pomocí jména a hesla).
    bool IsWindowsAuthentication Příznak, zda je nastavena windows autentifikace (pomocí windows účtu).
    bool EnableCreateUsers  
    bool EnableWebServices  
    string WebAssemblyVersion

    Číslo verze nainstalovaného systému ObjectGears.

    Např: 1.7.0.0

    string InstanceName  

    Volání objektu

    OG

    Funkce GetItem a metoda SetItem

    Funkce GetItem a metoda SetItem je možné použít jen ve skriptech ve webovém prostředí. Při použití při volání z windows služby je vždy vráceno NULL (např. při použití ve workflow, jobech...).

    Příklad použití najdete v případové studii Baseline záznamu.

    Metoda ReturnFileFromWeb

    Metodou ReturnFileFromWeb můžete na klienta vrátit soubor. Jako obsah souboru zadejte text v parametru content nebo pole bytů v parametru contentInBytes.

×