flexideo

Požadavek get-scan-files

Zobrazení analýzy příloh

Požadavek slouží k zobrazení výsledků analýzy, případně výmazu souborů.

Uzel obsahující požadavek na plán úlohy.

Základní typ(y) uzlu(ů): do-task;

syntax 
<request>
<get-scan-files
validity="{string}"
repeat="{string}"
sched-from-end="{boolean}"
when-off="{boolean}"
failsafe="{string}"
sched-from-end="{boolean}"
verbose="{boolean}"
/>
</request>

Atributy

validity - Určuje platnost úlohy. Spec. povinná syntaxe: [once]|today|still|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}] (typ: string) TYP HODNOTY: string;

repeat - Určuje případné opakování úlohy. Spec. povinná syntaxe: [none]|hourly|daily|weekly|monthly|yearly|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}][;each-nn-(minutes|hours|days|weeks|months)[[-xx]...]][;at-{#hh:mm}] (typ: string) TYP HODNOTY: string;

sched-from-end - Říká, zda je interval opakování úlohy počítán od jejího ukončení. Umožňuje přesnější návaznost.(typ: boolean) TYP HODNOTY: boolean;

when-off - Zapíná ošetření při vypnutí. Je-li úloha zadána s when-off=true a vyjde-li její provedení na dobu, kdy je server mimo provoz, dojde ke spuštění úlohy po obnovení činnosti serveru.(typ: boolean) TYP HODNOTY: boolean;

failsafe - Určuje případné opakování úlohy vyskytne-li se při jejím provádění chyba. Syntaxe shodná s nastavením repeat: [none]|hourly|daily|weekly|monthly|yearly|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}][;each-nn-(minutes|hours|days|weeks|months)[[-xx]...]][;at-{#hh:mm}] (typ: string) TYP HODNOTY: string;

sched-from-end - Časování od konce úlohy.(typ: boolean) TYP HODNOTY: boolean;

verbose - Určuje, zda zobrazit pouze souhrnné informace (false) nebo i výpis jednotlivých souborů (true).(typ: boolean) TYP HODNOTY: boolean;


Potomci

Požadavek get-scan-files neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.


Poznámka k request

Atributy validity, repeat, when-off, failsafe - viz též nastavení plánovače úloh.


Odpověď

Struktura odpovědi na požadavek get-scan-files vrácená v obálce response:

syntax 
<response>
<do-scan-files
status="error|in-progress|not-complete|none|scanned|deleted"
detail="{string}"
lost="{string}"
to-del="{string}"
deleted="{string}"
temp-to-del="{string}"
temp-deleted="{string}"
detail="{string}"
>
<lost-files ... /> ?
<to-del-files ... /> ?
<deleted-files ... /> ?
<temp-to-del-files ... /> ?
<temp-deleted-files ... /> ?
</do-scan-files>
</response>

Atributy

status - popis neuveden

Možnosti obsahu:

» error ~ při provádění požadavku došlo k chybě

» in-progress ~ úloha scan-files pravě probíhá

» not-complete ~ předchozí úloha scan-files nebyla kompletně dokončena (například zastavením serveru)

» none ~ neexistují žádné výsledky úlohy scan-files

» scanned ~ úloha doběhla, proběhla pouze analýza souborů

» deleted ~ úloha doběhla, proběhl výmaz souborů

detail - Upřesnění - Bližší popis vzniklé chyby. Je k dispozici při odpovědi typu 'error'.(typ: string)

lost - počet ztracených souborů (soubory, které jsou odkazované v databázi, ale nejsou ve filesystému - chyba k níž by nemělo dojít)

to-del - počet souborů neodkazovaných v databázi určených k výmazu (významný pokud je status scanned)

deleted - počet smazaných souborů neodkazovaných v databázi (významný pokud je status deleted)

temp-to-del - počet dočasných souborů určených k výmazu (významný pokud je status scanned)

temp-deleted - počet smazaných dočasných souborů (významný pokud je status deleted)

detail - bližší popis v případě chyby


Potomci


Uzel lost-files

Výčet ztracených souborů.

Daný uzel ...-files je uveden pouze při volbě verbose='true' a počet jeho potomků file odpovídá počtu uvedeném v odpovídajícím celočíselném atributu v hlavním uzlu odpovědi.

Základní typ(y) uzlu(ů): scan-file-info;

syntax 
<lost-files>
<file ... /> ?
</lost-files>

Popis obsahu elementu lost-files viz. popis typu scan-file-info.


Uzel to-del-files

Výčet určených k výmazu.

Daný uzel ...-files je uveden pouze při volbě verbose='true' a počet jeho potomků file odpovídá počtu uvedeném v odpovídajícím celočíselném atributu v hlavním uzlu odpovědi.

Základní typ(y) uzlu(ů): scan-file-info;

syntax 
<to-del-files>
<file ... /> ?
</to-del-files>

Popis obsahu elementu to-del-files viz. popis typu scan-file-info.


Uzel deleted-files

Výčet smazaných souborů.

Daný uzel ...-files je uveden pouze při volbě verbose='true' a počet jeho potomků file odpovídá počtu uvedeném v odpovídajícím celočíselném atributu v hlavním uzlu odpovědi.

Základní typ(y) uzlu(ů): scan-file-info;

syntax 
<deleted-files>
<file ... /> ?
</deleted-files>

Popis obsahu elementu deleted-files viz. popis typu scan-file-info.


Uzel temp-to-del-files

Výčet dočasných souborů k výmazu.

Daný uzel ...-files je uveden pouze při volbě verbose='true' a počet jeho potomků file odpovídá počtu uvedeném v odpovídajícím celočíselném atributu v hlavním uzlu odpovědi.

Základní typ(y) uzlu(ů): scan-file-info;

syntax 
<temp-to-del-files>
<file ... /> ?
</temp-to-del-files>

Popis obsahu elementu temp-to-del-files viz. popis typu scan-file-info.


Uzel temp-deleted-files

Výčet smazaných dočasných souborů.

Daný uzel ...-files je uveden pouze při volbě verbose='true' a počet jeho potomků file odpovídá počtu uvedeném v odpovídajícím celočíselném atributu v hlavním uzlu odpovědi.

Základní typ(y) uzlu(ů): scan-file-info;

syntax 
<temp-deleted-files>
<file ... /> ?
</temp-deleted-files>

Popis obsahu elementu temp-deleted-files viz. popis typu scan-file-info.

Výraz pro identifikaci chyb v odpovědi serveru: do-scan-files[@status='error'] (odkaz na popis detailu: @detail).


Poznámka k response

Tělo (obsah) tagu get-scan-files se nachází v odpovědi pouze, je-li požadavek volán s atributem verbose=true. Význam jednotlivých synovských uzlů odpovídá výnamem atributům tagu get-scan-files. Každý tento synovský uzel obsahuje tolik uzlů typu file, kolik je uvedeno v atributech.


Další info

Odstraňování úloh, které jsou nastaveny pomocí atributu validity jako trvalé (opakovatelné) bude prováděno prostřednictvím požadavku:

<undo-scan=files id="{#numb}"/>

Atribut id je jednoznačný identifikátor úlohy přidělený serverem.

Požadavky pro get-scan-files může zadávat pouze uživatel s administrátorským oprávněním. Aby uživatel mohl tento požadavek používat, musí mít ve vlastnostech uživatele aktivováno oprávnění p_admin.

Požadavek admin-unlockPožadavek cache-boostPožadavek do-managePožadavek do-optimize-filesPožadavek do-scan-filesPožadavek get-scan-filesPožadavek mimesPožadavek servicePožadavek soap-servicesPožadavek test-performancePožadavek unload-soapPožadavek unload-pseudoPožadavek update-dadPožadavek update-files