Marbes Consulting s.r.o.
EOS4
Podmínky omezující zveřejnění
Autorem tohoto dokumentu je společnost MARBES CONSULTING s.r.o. Dokument obsahuje informace důvěrného charakteru a ve smyslu definice autorského práva (viz § 2, odst. 1 Zákona č. 121/2000 Sb., zákon o právu autorském) je duševním vlastnictvím autora a předmětem práva autorského. Dokument smí být použit výhradně za účelem, za kterým byl poskytnut a nesmí být bez předchozího souhlasu autora citován, kopírován, vytěžován1 nebo předán třetí fyzické či právnické osobě.
© 2009 MARBES CONSULTING s.r.o.
1 Vytěžováním se podle zákona č. 121/2000 Sb. rozumí trvalý nebo dočasný přepis celého obsahu nebo jeho podstatné části na jiný podklad, a to jakýmikoli prostředky nebo jakýmkoli způsobem.
Pokud metoda vrací seznam objektů, může být výsledný vracený seznam stránkovaný. Informaci o stránkování obsahuje atribut paging, ve kterém se nachází i informace, zda server uchovává další data (existuje další stránka). Vychozí velikost jedné stránky je 500 záznamů. Objekt paging obsahuje identifikátor seznamu dat (lid) a ten je nutné předat do metody, která načte další stránku (typický název metody je getNextXxx).
Při načítání stránkovaného seznamu nemusí vždy odpovídat počet vrácených záznamů parametru totalCount, který je uveden v objektu paging. Toto se projeví pouze v případě, že jsou během stránkovaného načítání některé vracené objekty z EOS odstraněny.
Některé metody podporují filtrování dat, např. načtení seznamu aplikací. Filtr se předává formou řetězce, ve kterém je zapsána podmínka. Podmínku lze použít POUZE na základní atributy vracených objektů. Podmínku nelze tedy použít na další vnořené hodnoty, např. kontakty osoby. Pro tento účel existují samostatné metody.
Podmínky u filtrů je možné sestavovat pouze stylem ATRIBUT OPERÁTOR HODNOTA, nelze tedy např. porovnávat dva atributy
navzájem. Řetězcová hodnota se VŽDY uvádí v apostrofech (jinak bude chybně chápána jako název atributu a bude vyhozena
chyba), pokud hodnota obsahuje apostrof, musí být znak zapsán jako dva apostrofy ''. U operátorů like a ilike je možné
použít znak %, který nahrazuje žádný nebo libovolný počet znaků. Znak % lze používat pouze na začátku
a konci hodnoty. Pokud je potřeba zapsat hodnotu null, je zapsána bez uvozovek. Datum je nutné zapsat ve formátu:
dd.MM.yyyy HH:mm:ss.SSS
nebo zkráceně bez času dd.MM.yyyy
. Pro boolean hodnoty se uvádí
hodnota 'true' nebo 1 pro true a 'false' nebo 0 pro false, textové reprezentace musí být uvedeny v apostrofech.
Podmínky jsou omezeny na počet porovnávaných hodnot. U výrazu jmeno = 'petr' and id in ('1', '2', '3')
je počet podmínek 4. Maximální bezpečný počet je 1000, ale EOS toto nijak nekontroluje. Při použití vyššího počtu může,
ale nemusí dotaz projít. Toto je z důvodu, že EOS do některých dotazů přidává vlastní podmínky a tudíž se může stát,
že bude překročen limit DB serveru na velikost podmínky.
Příklad zapsání filtru na osoby, jejichž uživatelské jméno je "kolomaznik" a titul začíná na 'i':
username = "kolomaznik" and degreeBefore ilike 'i%'
EosApplications apps = WS.findApplicationsByFilter(sid, null, null); // Zpracování aplikací ... while (apps.getPaging().getNext()) { apps = WS.getNextApplications(apps.getPaging().getLid()); // Zpracování aplikací ... }
Seznam atributů dle kterých lze filtrovat osoby:
Název | Popis |
---|---|
findApplicationsByFilter | Hledání aplikací podle předaného filtru. |
findApplicationsByIds | Hledání aplikací podle předaného seznamu id. |
findPersonsRoleActProfile | Získání osob podle zadaného filtru. |
getApplicationsWithoutEnvironment | Načte senzam aplikací, které nejsou v žádném prostředí. |
getEnvironmentApplications | Načtení aplikací, které jsou v daném prostředí. |
getNextApplications | Načtení další části stránkovaného seznamu aplikací. |
getNextPersonsRoleActProfile | Načte další seznam osob získaný dle filtru z {@link #findPersonsRoleActProfile(String, String)}. |
getPersonApplications | Načtení aplikací, které jsou dostupné pro danou osobu nebo osobu v zařazení nebo osobu v primárním zařazení. |
placePersonAttributeValue | Přiřadí hodnotu atributu na osobu. |
placePersonAttributeValues | Přiřadí hodnoty atributu na osobu. |
placePersonMultiColumnAttributeValue | Přiřadí hodnotu vícesloupcového atributu na osobu. |
placePersonMultiColumnAttributeValues | Přiřadí hodnoty vícesloupcového atributu na osobu. |
removePersonAttributeValues | Odstraní hodnoty atributu osoby. |
Název | Popis |
---|---|
Cz.marbes.eos4.module.ws.v5.rights.wo.WOAttributeValue | Objekt reprezentuje hodnotu atributu (oprávnění). |
Cz.marbes.eos4.module.ws.v5.rights.wo.WOAttributeValues | Objekt obsahující seznam hodnot atributů aplikace. |
Cz.marbes.eos4.module.ws.v5.rights.wo.WOMultiColumnAttributeValue | Objekt reprezentuje hodnotu atributu (oprávnění) pro vícesloupcový atribut. |
Cz.marbes.eos4.module.ws.v5.rights.wo.WOMultiColumnAttributeValues | Objekt obsahující seznam hodnot atributů vícesloupcového atributu. |
Cz.marbes.eos4.module.ws.v5.rights.wo.WOMultiValueMultiColumnAttributeValues | Objekt obsahující seznam hodnot vícehodnotového vícesloupcového atributu. |
Cz.marbes.eos4.module.ws.v5.rights.wo.types.WOAttributeType | Typ atributu aplikace. |
EosApplication | Object reprezentuje aplikaci. |
EosApplicationIds | Objekt obsahující seznam identifikátorů aplikací. |
EosApplicationRespFilter | Objekt definuje rozsah dat, které se budou u aplikací plnit. |
EosApplications | Objekt obsahující seznam aplikací. |
EosAttribute | Objekt reprezentuje atribut aplikace. |
EosAttributes | Objekt obsahující seznam atributů. |
EosEnvironment | Prostředí do kterého je přiřazena aplikace. |
EosEnvironments | Obsahuje seznam prostředí v kterých se nachází aplikace. |
EosIds | Objekt obsahující seznam id. |
EosPaging | Objekt obsahující informace pro stránkování. |
EosPerson | Osobu. |
EosPersonRoleActProfile | WOObjekt obsahující detail osoby spolu s přiřazenými profily a agendami. |
EosPersonRoleActProfiles | WO objekt obsahující seznam osob s jejich agendami a profily. |
EosRoleActivities | WO objekt obsahující seznam agend. |
EosRoleActivity | WO objekt agendy. |
EosRoleIdType | Typ role. |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
filter | String | Ne | filtr na aplikace, pokud není uveden, vrací se všechny aplikace |
respFilters | EosApplicationRespFilter | Ne | response filtr |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
applicationIds | EosApplicationIds | Ano | seznam id aplikací |
respFilters | EosApplicationRespFilter | Ne | response filtr |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
filter | String | Ne | textový filtr osob, kterým můžeme omezit vrácený seznam osob |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
respFilters | EosApplicationRespFilter | Ne | response filtr |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
environmentId | String | Ano | id prostředí |
respFilters | EosApplicationRespFilter | Ne | response filtr |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
lid | String | Ano | list id |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
lid | String | Ano | list id |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
personId | String | Ano | id osoby |
roleId | String | Ne | id entity organizační struktury, musí se jednat o id role |
roleIdType | EosRoleIdType | Ne | typ entity, na které odkazuje roleId |
onlyPrimAss | boolean | Ne | pokud je true, uvažuje se pouze primární zařazení osoby |
respFilter | EosApplicationRespFilter | Ne | response filtr |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
personId | String | Ano | id osoby |
applicationId | String | Ano | id aplikace |
attributeName | String | Ano | název atributu |
attributeValue | Cz.marbes.eos4.module.ws.v5.rights.wo.WOAttributeValue | Ano | hodnota |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
personId | String | Ano | id osoby |
applicationId | String | Ano | id aplikace |
attributeName | String | Ano | název atributu |
attributeValues | Cz.marbes.eos4.module.ws.v5.rights.wo.WOAttributeValues | Ano | hodnoty |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
personId | String | Ano | id osoby |
applicationId | String | Ano | id aplikace |
attributeName | String | Ano | název vícesloupcového atributu |
multiColumnAttributeValues | Cz.marbes.eos4.module.ws.v5.rights.wo.WOMultiColumnAttributeValues | Ano | hodnoty jednotlivých atributů |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
personId | String | Ano | id osoby |
applicationId | String | Ano | id aplikace |
attributeName | String | Ano | název vícesloupcového atributu |
multiValueMultiColumnAttributeValues | Cz.marbes.eos4.module.ws.v5.rights.wo.WOMultiValueMultiColumnAttributeValues | Ano | hodnoty |
Parametr | Typ | Povinný | Popis |
---|---|---|---|
sid | String | Ne | session id |
personId | String | Ano | id osoby |
applicationId | String | Ano | id aplikace |
attributeName | String | Ano | název atributu |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
id | String | Ne | Id hodnoty atributu. |
value | String | Ne | Hodnota atributu (oprávnění). |
description | String | Ne | Popis hodnoty. |
externId | String | Ne | Odkaz na id hodnoty, pouze pokud se jedná o SQL, WS nebo výčtový atribut. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
attributeValues | List<Cz.marbes.eos4.module.ws.v5.rights.wo.WOAttributeValue> | Ne | Seznam hodnot atributů aplikace. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
attributeName | String | Ne | |
id | String | Ne | Id hodnoty atributu. |
value | String | Ne | Hodnota atributu (oprávnění). |
description | String | Ne | Popis hodnoty. |
externId | String | Ne | Odkaz na id hodnoty, pouze pokud se jedná o SQL, WS nebo výčtový atribut. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
multiColumnAttributeValues | List<Cz.marbes.eos4.module.ws.v5.rights.wo.WOMultiColumnAttributeValue> | Ne |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
multiColumnAttributeValuesList | List<Cz.marbes.eos4.module.ws.v5.rights.wo.WOMultiColumnAttributeValues> | Ne |
Hodnota | Popis |
---|---|
SELECT | SQL atribut, výčet možných hodnot je definován pomocí SQL a databázového připojení. Hodnoty mohou být definovány jako plochý seznam nebo jako strom. |
TEXT | Textový atribut, hodnota je zadávána ručně jako řetězec. |
BOOLEAN | Pravdivostní atribut, hodnoty mohou obsahovat true nebo false. |
WS | Web service atribut, výčet možných hodnot je definován pomocí volání webové služby. Hodnoty mohou být definovány jako plochý seznam nebo jako strom. |
ENUM | Výčtový atribut. Hodnota se vybírá z oboru hodnot atributu. |
INNER | Vnitřní atribut aplikace EOS. Hodnoty se berou z dat aplikace EOS. |
MULTICOLUMN | Vícesloupcový atribut. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
id | String | Ne | Id aplikace. |
name | String | Ne | Název aplikace. |
parameters | String | Ne | Parametry příkazové řádky. |
author | String | Ne | Autor aplikace. |
description | String | Ne | Popis aplikace. |
path | String | Ne | Cesta k aplikaci. Kde je fyzicky spustitelný soubor na síti - v případě webové URL. |
icon | String | Ne | Kde je uložena na disku nebo v síti ikona aplikace. |
appServerName | String | Ne | Jméno aplikačního serveru. |
manageStarting | Boolean | Ne | Atribut určující, zda se u aplikace má řešit spouštění. V případě true hodnoty aplikace dostane nový atribut, který bude obsahovat hodnoty spouštění. |
appCode | String | Ne | Kód. |
serverUrl | String | Ne | URL aplikačního serveru pro webové služby. |
version | String | Ne | Verze aplikace. |
attributes | EosAttributes | Ne | Atributy aplikace. |
environments | EosEnvironments | Ne | Obsahuje seznam prostředí, do kterých je aplikace přiřazena. |
formattedDescription | String | Ne | Podrobný naformátovaný popis aplikace, jedná se o xhtml kód. |
central | Boolean | Ne | Příznak zda je aplikace centrální. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
applicationids | List<String> | Ne | Seznam identifikátorů aplikací. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
attributes | Boolean | Ne | Mají se u aplikace vracet atributy? |
environments | Boolean | Ne | Příznak, jestli se mají vracet i prostředí k aplikace. True - mají se vracet i prostředí, false - nemají. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
applications | List<EosApplication> | Ne | Seznam aplikací. |
paging | EosPaging | Ne | Stránkování seznamu. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
id | String | Ne | Id atributu. |
name | String | Ne | Název atributu. |
type | Cz.marbes.eos4.module.ws.v5.rights.wo.types.WOAttributeType | Ne | Typ atributu. |
appId | String | Ne | Id aplikace, ke které daný atribut patří. |
singleValue | boolean | Ne | Příznak zda je atributu jednohodnotový (true) nebo vícehodnotový (false). |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
attributes | List<EosAttribute> | Ne | Seznam atributů. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
id | String | Ne | Id prostředí. |
name | String | Ne | Název prostředí. |
description | String | Ne | Popis prostředí. |
code | String | Ne | Kód prostředí. |
testing | Boolean | Ne | Příznak jestli je prostředí testovací, nebo produktivní. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
environments | List<EosEnvironment> | Ne | Seznam prostředí pro aplikaci. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
ids | List<String> | Ne | Seznam identifikátorů. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
lid | String | Ne | List id nebo null, pokud stránkování není vyžadováno. |
start | int | Ne | Index prvního záznamu, který byl aktuálně vrácen. |
totalCount | int | Ne | Celkový počáteční záznamů. |
hasNext | boolean | Ne | Příznak, zda jsou k dispozici ještě další záznamy. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
id | String | Ne | Id osoby. |
degreeBefore | String | Ne | Titul před jménem. |
firstname1 | String | Ne | Jméno. |
firstname2 | String | Ne | Druhéí jméno. |
surname1 | String | Ne | Příjmení. |
surname2 | String | Ne | Další příjmení. |
degreeAfter | String | Ne | Titul za jménem. |
signature | String | Ne | Iniciály. |
abbrev | String | Ne | Zkratka. |
userName | String | Ne | Uživatelské jméno. |
displayName | String | Ne | Zorazované jméno. |
personalNumber | String | Ne | Osobní číslo. |
entranceDate | Date | Ne | Datum nástupu. |
terminationDate | Date | Ne | Datum ukončení. |
String | Ne | E-mail. | |
locked | Boolean | Ne | Je účet uzamčen pro přihlášení? |
disabled | Boolean | Ne | Je osoba zakázaná? V případě zakázání nemá osoba žádná oprávnění ani aplikace. |
publicable | Boolean | Ne | Publikovat osobu ve veřejné (internetové) verzi zobrazení? |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
person | EosPerson | Ne | Detail osoby. |
profileIds | EosIds | Ne | Seznam id profilů osoby. |
roleActivities | EosRoleActivities | Ne | Seznam přiřazených agend. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
personRoleActProfile | List<EosPersonRoleActProfile> | Ne | Seznam osob s agendami a profily. |
paging | EosPaging | Ne | Stránkování. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
roleActivity | List<EosRoleActivity> | Ne | Seznam agend/činností. |
Jméno atributu | Datový typ | Povinné | Popis |
---|---|---|---|
id | String | Ne | Id agendy. |
code | String | Ne | Kód agendy. Pokud nemá agenda nastaven codeRPP, obsahuje pouze kod agendy. |
Hodnota | Popis |
---|---|
OR | Organizační role. |
GR | Organizační skupinová role. |