======= MandatoryDocumentHandler =======
==== Beschreibung ====
Prüft, ob ein oder mehrere Dokument(e) mit einem oder mehreren bestimmten Dateinamen vorhanden sind oder ob überhaupt Dokumente vorhanden sind.\\
Ergibt die Prüfung keine Treffer erscheint eine Fehlermeldung und die Prozessinstanz kann erst weitergehen wenn Dokument(e) welche die Bedingungen erfüllen anhängen.

------
==== Klasse ====
<code>
com.dooris.bpm.actionhandler.MandatoryDocumentHandler
</code>
\\
----
==== Event Type ==== 
beliebig
==== Action Name ==== 
beliebig
==== Mandatory Fields ==== 
leer
----
==== Parameter ====

== Parameter 1 ==

**pattern** \\
Zeichenkette welche im Dokumentennamen oder Beschreibung des Dokuments vorhanden sein muss. Es können ein oder mehrere Pattern kommasepariert übergeben werden.\\
z.B.:

  * pattern=Rufnummernliste;
  * pattern=Rufnummernliste,docx,Reisekosten;

>> **Achtung!**  Wird kein Pattern übergeben, wird geprüft ob mindestens 1 Dokument (egal wie es benannt ist) angehängt ist!  (siehe [[#beispiel|Beispiel]])

== Parameter 2 ==

**description** \\ Gibt an ob Beschreibung des Dokuments nach dem übergebenen Pattern überprüft werden soll. \\ Mögliche Werte sind hier true (mit einbeziehen) oder false (nicht mit einbeziehen). Standardmäßig steht der Parameter auf true. \\ z.B.:

  * description=false;

Erklärung (siehe [[#beispiel|Beispiel]])

== Parameter 3 ==

**caseSensitive** \\ Gibt an ob Groß- und Kleinschreibung beachtet werden soll. Dieser Parameter wirkt sich nur in Zusammenhang mit einem pattern aus! \\ Mögliche Werte sind hier true (Groß- und Kleinschreibung beachten) oder false (ignorieren). Standardmäßig steht der Parameter auf false. \\ z.B.:

  * caseSensitive=false;

(siehe [[#beispiel|Beispiel]])

== Parameter 4 ==

**fileType** \\ Angabe von kommagetrennten Dateiendungen. Überprüfung ob alle Dokumente den Dateiendungen entsprechen, dabei spielt die Groß- und Kleinschreibung keine Rolle (Beispiel: bei fileType=pdf ist sowohl .pdf als auch .PDF gültig). Wenn nur dieser Parameter angegeben wird, ist der Upload von Dokumenten keine Pflicht. Falls diese aber angehängt sind, müssen sie diesen Dateiendungen entsprechen. \\ z.B.:

  * fileType=pdf,docx,pptx

== Parameter 5 ==

**enforcePattern** \\ Wenn "true", müssen alle angehängten Dateien dem oben (Parameter 1) angegeben Pattern entsprechen. Bei "false" muss nur eine Datei dem Pattern entsprechen. Angabe entweder "true" oder "false" \\ z.B.:

  * enforcePattern=true

== Parameter 6 ==

**checkCurrentNode** \\ Ist standardmäßig auf "false" gesetzt. Wenn der Parameter auf "true" gesetzt wurde, wird geprüft, ob in der aktuellen Aktivität Dokumente hochgeladen wurden, die den anderen Parametern entsprechen. Wenn dies nicht der Fall ist, kann die Aktivität nicht beendet werden und eine entsprechende Fehlermeldung wird generiert.

  * checkCurrentNode=true

----


==== Beispiel ====

{{  :software:tim:actionhandler:mandatorydocumenthandler_1.png  }}

>> **Achtung!** Soll lediglich geprüft werden ob ein Dokument angehängt ist, wird der Actionhandler ohne Parameter ausgeführt!

----


==== Abhängigkeiten ====
Ab TIM-Version [[software:tim:changelog:tim38|3.8]]