======= MandatoryDocumentHandler =======
==== Description ====
Checks if one or more document(s) with one or multiple supplied file names exist, or alternatively, if any documents exist.\\
If the search yields no results, an error message appears and the process instance can only continue once the required document(s) are attached.

------
==== Action Class ====
<code>
com.dooris.bpm.actionhandler.MandatoryDocumentHandler
</code>
\\
----
==== Event Type ==== 
any
==== Action Name ==== 
any
==== Mandatory Fields ==== 
none
----
==== Parameter ==== 
== Parameter 1 ==
**pattern** \\
A character string, in which the document name or description must be present. One or multiple patterns may be entered (multiple terms being separated by commas). \\
i.e.:
  *pattern=PhoneNumberList;
  *pattern=PhoneNumberList,docx,TravelCosts;
>> **Attention!** If a pattern is not given, a check is run to make sure that at least one document (regardless of how it is named) is attached!\\
(see [[#example]])

\\ == Parameter 2 ==
**description**\\
Denotes if a description of the document should be checked according to the supplied pattern.\\
Possible values for this are true (include) or false (do not include). This is set to true by default.\\
i.e.:
  *description=false;
Explanation (see [[#example]])

\\ == Parameter 3 ==
**caseSensitive**\\
Denotes if upper- and lower-case formatting should be considered. This parameter is only taken into account if there is a pattern specified!\\
Possible values for this are true (pay attention to upper- and lower-case formatting) or false (ignore). This is set to false by default.\\
i.e.: 
  *caseSensitive=false;
(see [[#example]])

\\ == Parameter 4 ==
**fileType**\\
Declaration of file endings (separated by commas). Checks if all documents conform to the file ending, no matter if upper- or lower-case (example: given fileType=pdf both .pdf and .PDF are valid). If only this parameter is supplied, the uploading of documents is not mandatory. However, if these are attached, they must conform to the file endings. \\
i.e.: 
  *fileType=pdf,docx,pptx


\\ == Parameter 5 ==
**enforcePattern**\\
If set to "true", all of the attached documents must conform to the aforementioned pattern (Parameter 1). If "false", only one file must conform to the pattern. Possible values for this are "true" or "false"\\
i.e.: 
  *enforcePattern=true



----

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

>> **Attention!**  If the check should only determine if a document is attached, the action handler will be executed without the parameter!
----
==== Dependencies ====
Available from TIM-Version [[software:tim:changelog:tim38|3.8]] on.