Zobrazení zdroje stránky Reorg

==Funkcionalita==
Reorg je nezávislá aplikace sloužící pro hromadné operace s databází aplikace enTeam. S ohledem na časovou náročnost hromadných operací je obvykle spouštěna v nočních hodinách pomocí plánovače úloh MS Windows. <br>

Používá se zejména pro:
* Mazání nadbytečných procesů a jejich export do souborového systému
* Archivace procesů do DMS
* Migrace procesů
* Oprava kriterií

==Spuštění aplikace== 
Aplikace ke svému běhu potřebuje konfigurační INI soubor. Spuštění aplikace Reorg se obvykle provádí pomocí .bat souboru, který obsahuje odkaz na vytvořený konfigurační soubor.
Je obvyklé vytvořit více konfiguračních INI souborů pro odlišné chování aplikace Reorg. V takovém případě je vhodné vytvořit více .bat souboru pro každou konfiguraci.
Pro pravidelné vykonávání programu je nutné zajistit jeho opakované spouštění, např. v plánovači úloh MS Windows.

===Parametry příkazové řádky:===

<code>/s</code><br>
Parametr určuje, zda je Reorg spuštěn automaticky. Je-li nastaven, Reorg proběhne v příkazové řádce. V opačném případě se spustí grafické rozhraní, ve kterém je nutné spuštění uživatelsky potvrdit.<br>

<code>/g</code><br>
Určuje, zda bude spuštěno grafické rozhraní. Parametr koresponduje s prvním parametrem. Pokud jsou tedy nastaveny oba parametry, bude spuštěno grafické rozhraní pro zobrazení průběhu, spuštění ale není nutné uživatelsky potvrdit.<br>

<code>/c:file</code><br>
Určuje cestu a název konfiguračního INI souboru. Tento parametr je povinný. Například: <code>/c:"c:\enTeam\Ini\Reorg.ini"</code><br>

<code>/np</code><br>
Určuje, zda budou procesy z Workflow Manager fyzicky odstraněny. Pokud je parametr specifikován, proběhne Reorg standardně, včetně zápisu do logovacího souboru, ale neprovede žádné změny. To je využíváno zejména při konfiguraci programu a nastavování správné funkčnosti.<br>

<code>/nr</code><br>
Určuje, zda budou na procesy aplikovány operace oprav. Stejně jako u předchozího parametru proběhne Reorg standardně, ale neprovede žádné změny. <br><br>

Příklad .bat souboru spouštějící Reorg:
<pre>MtbReorg.exe /c:"c:\enTeam\Ini\Reorg.ini" /s /np</pre>

==Určení množiny procesů, kterých se bude export/archivace týkat==
<font color="red">Pochopení tohoto odstavce, je klíčové pro správné nastavení aplikace Reorg a udržování databáze v odpovídající velikosti.</font>

===Filtr===
Před aplikací exportu je nejdříve nutné určit množinu procesů, které bude Reorg procházet. Určuje se pomocí klíče <code>DocumentFilter=<Filtr></code>, kde se specifikuje filtr ve stejné syntaxi jako v programu Workflow Manager. S takto vyfiltrovanou množinou procesů bude Reorg nadále pracovat a na dané procesy aplikovat všechny mechanismy exportu/archivace, jako např. Export, DeleteActive, apod. Pokud není filtr specifikován, jsou procházeny všechny procesy, což je ve většině případu zbytečné a může způsobit značné zpomalení.


Příklady filtrů:
<pre>DocumentFilter=($$GenTimeQuery($DOC_CREATED;less;14;day))</pre>

<pre>DocumentFilter=($DOC_WORKFLOW='*Úkol*') AND ($DOC_PROCESS_STATUS=RUNNING)</pre>

=== Mechanismy exportu/archivace===
<pre>DeleteWasteBasket=<Počet dní></pre>
Specifikuje, kolik dní musí být procesy v koši, aby se exportovaly a vymazaly. Pokud klíč není uveden, nebo je jako počet dní uvedena hodnota <code>-1</code>, procesy se z koše nebudou exportovat a mazat. V případě uvedení nuly v počtu dní se vymažou všechny procesy v koši.<br>

<pre>DeleteFinishedWkf=<Počet dní></pre>
Specifikuje, kolik dní musí být procesy s workflow ukončeny nebo zrušeny, aby se exportovaly a vymazaly. Pokud klíč není uveden, nebo je jako počet dní uvedena hodnota <code>-1</code>, procesy s workflow se nebudou exportovat a mazat. V případě uvedení nuly v počtu dní se vymažou všechny procesy s workflow.<br>

<pre>DeleteActive=<Počet dní></pre>
Specifikuje kolik dní musí být procesy staré, aby byly exportovány a vymazány. Týká se to všech procesů, vyjma běžících workflow. Dokončená workflow budou také odstraněna. Pokud klíč není uveden, nebo je jako počet dní uvedena hodnota <code>-1</code>, procesy se nebudou exportovat a mazat. V případě uvedení nuly v počtu dní se vymažou všechny procesy.<br>

<pre>Export=True</pre>
Všechny procesy odpovídající zadanému filtry budou exportovány dle parametrů uvedených níže.<br>

==Konfigurační INI soubor==
INI soubor obsahující konfiguraci k Reorg. Cesta k souboru musí být popsána parametrem v .bat souboru. Nastavení se vkládá jako INI klíče do sekce:
<pre>[mtbReorg]</pre>

===LogFileDir===
Specifikuje složku, do které se budou ukládat logovací soubory.
<pre>LogFileDir=<Cesta></pre>

===ArchivingMethod===
Specifikuje metodu exportu dat před smazáním procesů. Při hodnotě <code>Export</code> se procesy exportují do souborového systému. Pokud není klíč uveden, je jako výchozí hodnotou <code>DMS</code> v případě, že je enTeam DMS nainstalován. V opačném případě je nastavena hodnota <code>Export</code>.
<pre>ArchivingMethod={DMS|Export}</pre>

===ExportDir===
Specifikuje cestu, kam se budou ukládat exportované procesy. Pro každý proces se ukládají se dva typy souborů: <code>.hdr</code> a <code>.001</code>. Tento klíč je povinný.
<pre>ExportDir=<Cesta></pre>

===ExportNameFormat===
Specifikuje název pro exportované soubory. Výchozí hodnota je <code>DMS</code>.

* <code>DMS</code> - jako název vkládá osmimístné číslo, které se s každým uloženým procesem navýší
* <code>KEY</code> - jako název vkládá unikátní identifikátor procesu
* <code>MASK</code> - název souboru definuje maska, která musí být definována v klíči [[#ExportNameMask|<code>ExportNameMask</code>]]

<pre>ExportNameFormat={DMS|KEY|MASK}</pre>

===DocumentFilter===
Určuje množinu procesů, kterou bude Reorg procházet. Filtr používá stejnou syntaxi jako program Workflow Manager. Je vhodné tento klíč využívat a specifikovat tak procesy, kterých se Reorg může týkat. Značně se tím zvýší rychlost, viz kategorie [[#Filtr|<code>Filtr</code>]]. 
<pre>DocumentFilter=<Filtr></pre>

===DeleteWasteBasket===
Specifikuje, kolik dní musí být procesy v koši, aby se exportovaly a vymazaly. Více v odstavci [[#Mechanismy exportu/archivace]].
<pre>DeleteWasteBasket=<Počet dní></pre>

===DeleteActive===
Specifikuje, kolik dní musí být staré procesy, aby byly exportovány a vymazány. Více v odstavci [[#Mechanismy exportu/archivace]].
<pre>DeleteActive=<Počet dní></pre>

===DeleteFinishedWkf===
Specifikuje, kolik dní musí být procesy s workflow ukončeny nebo zrušeny, aby se exportovaly a vymazaly. Více v odstavci [[#Mechanismy exportu/archivace]].
<pre>DeleteFinishedWkf=<Počet dní></pre>

===DeleteTBLog===
Klíč vymazává logovací záznamy (tabulka TB_LOGS) programu Workflow Manager starší než zadaný <code>Počet dní</code>. V případě uvedení nuly, se vymažou všechny záznamy.
<pre>DeleteTBLog=<Počet dní></pre>

===DeleteDanglingBlobs===
Klíč zapíná mazání příloh, které nikam neodkazují (nemají data). Výchozí hodnota je <code>False</code>.
<pre>DeleteDanglingBlobs={True|False}</pre>

===RepairCriterions===
Klíč zapíná sychronizaci kriterií, které jsou uložené v procesech, se slovníkem dat. S výhodou lze využít např. pokud jsou kritéria definována až po založení procesů, lze je tímto klíčem přidat. Tato funkce je časově náročná, je tedy doporučeno aplikovat [[#Filtr|Filtr]] a přesně určit množinu, například jen na procesy s daným workflow:
<pre>DocumentFilter=($DOC_WORKFLOW='*Úkol*')
RepairCriterions=True</pre>
<pre>RepairCriterions={True|False}</pre>

===RepairUserData===
Klíč opravuje uživatelské údaje uložené v procesech, pokud nekorespondují s údaji v aplikaci User. Jako <code>Opravy uživatelských dat</code> lze využít následující parametry:
* <code>Address</code> - Aktualizuje adresu uživatele.
* <code>PName</code> - Aktualizuje zobrazovanou zkratku uživatele.
* <code>State</code> - Aktualizuje stav uživatele, tedy je-li aktivní nebo neaktivní.

Lze aplikovat více než jeden parametr. V takovém případě jsou parametry oddělené čárkami.
<pre>RepairUserData=<Opravy uživatelských dat></pre>

===RepairVariableType===
Klíč opravuje datové typy proměnných v procesech tak, aby odpovídaly proměnným ve slovníku dat. Lze opravovat jen datové typy z prostých na mnohonásobné typy. Tedy např. ze <code>String</code> na <code>StringList</code> nebo <code>Date</code> na <code>DateList</code>. Do parametrů název proměnné se zadává název proměnné, kterou chceme opravit. Název je závislý na velikosti písmen. Lze aplikovat více než jeden parametr, v takovém případě jsou parametry oddělené čárkami.

<pre>RepairVariableType=<Název proměnné></pre>

===RepairUserState===
Klíč mění specifikovaným uživatelům jejich stav v procesech.
* <code>Active</code> - Stav uživatele je změněn na aktivní. 
* <code>Inactive</code> - Stav uživatele je změněn na neaktivní, procesy s uživatelem jsou tedy vloženy do koše. 
* <code>Delete</code> - Stav uživatele je změněn na smazaný.

<code>Adresa uživatele</code> je definovaná v aplikaci enTeam User ve formátu loginId@oddělení@společnost. Pokud obsahuje mezery, je nutné adresu obalit dvojitými uvozovkami.

Lze aplikovat na více uživatelů. V takovém případě se uživatelé oddělují čárkami.

<pre>RepairUserState=<Stav>,<Adresa uživatele></pre>

===IgnoreLocks===
Klíč definuje, zda budou aplikovány na změny i na zamčené procesy. Tato funkčnost by měla být použita pouze v případě, že se zamknuté procesy očekávají.
<pre>IgnoreLocks={True|False}</pre>

===Export===
Klíč definuje, zda budou procesy exportovány do složky definované klíčem [[#ExportDir|<code>ExportDir</code>]]. Export je aplikován na všechny procesy odpovídající filtru dle klíče [[#DocumentFilter|<code>DocumentFilter</code>]] bez ohledu na další podmínky, jako např. DeleteFinishedWkf, DeleteActive apod. Název exportovaných dokumentů je definován klíčem [[#ExportNameFormat|<code>ExportNameFormat</code>]]
<pre>Export={True|False}</pre>

===DeleteExported===
Pokud je klíč nastaven na <code>True</code>, všechny procesy exportované pomocí parametru [[#Export|<code>Export</code>]], budou po exportu ve Workflow Manager vymazány. 
<pre>DeleteExported={True|False}</pre>

===PrintStatistics===
Pokud je klíč nastavený na <code>True</code>, jsou do logovacího souboru vypsány podrobnosti o každém procesu.
<pre>PrintStatistics={True|False}</pre>

===DateFormat===
Klíč určuje formát data, který se zapíše do hlavičky exportovaného (.hdr) souboru.

<code>Formát data</code> lze specifikovat jako: <code>{DD.MM.YYYY | DD/MM/YYYY | YYYY.MM.DD | YYYY/MM/DD | MM.DD.YYYY | MM/DD/YYYY}</code> 

<pre>DateFormat=<Formát data></pre>

===Import===
Nastavením klíče na <code>True</code> je Reorg přepínán do režimu, ve kterém je prováděn pouze import. Importují se všechny soubory s příponou <code>.mtb</code>, které jsou uložené ve složce pro import. Složka pro import se specifikuje klíčem [[#ImportDir|ImportDir]].
<pre>Import={True|False}</pre>

===ImportDir===
Klíč v parametru <code>Cesta</code> specifikuje složku pro import procesů. Pro import procesů je taktéž nutné nastavit klíč [[#Import|Import]].
<pre>ImportDir=<Cesta></pre>

===PurgeExistingDocs===
Pokud je klíč nastaven na <code>True</code>, je proces při importu dokumentů, který již v databázi existuje nejdříve vymazán a až poté naimportován. Pokud je hodnota nastavena na <code>False</code> proces není naimportován, pokud již v databázi existuje.
<pre>PurgeExistingDocs={True|False}</pre>

===PurgeOldAttVersions===
Pokud je klíč nastaven na <code>True</code>, dokumenty s přílohou, jejíž číslo verze je větší než hodnota <code>AttachVersMaintainedCnt</code> v systémovém nastavení aplikace enTeam User (nebo není označená pro mazání), jsou zpracovány a starší verze vymazány z úložiště. Pokud je nastaven na <code>False</code>, není provedeno žádné explicitní mazání.
<pre>PurgeOldAttVersions={True|False}</pre>

===ExportBlobExt===
Specifikuje příponu, jakou budou mít exportované dokumenty. Výchozí přípona je <code>001</code>.

Například:
<pre>ExportBlobExt=mtb</pre>
<pre>ExportBlobExt=<Přípona></pre>

===ExportNameMask===
Klíč definuje masku, která se použije pro pojmenování exportovaných souborů. Pro využití masky musí být nastavený klíč [[#ExportNameFormat|ExportNameFormat]].

Do výrazu lze zapsat buď prostý text nebo proměnnou, která musí být obalena znakem <code>$</code>.

Například:
<pre>ExportNameMask=DZP-$DX_ID$
ExportNameMask=DZO-$DX_ID$-$MTBTitle$</pre>

<pre>ExportNameMask=<Výraz></pre>