MandatoryDocumentHandler

Description

The ActionHandler MandatoryDocumentHandler 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.


Class

com.dooris.bpm.actionhandler.MandatoryDocumentHandler

Parameter

Parameter

Default value

Description

Valid examples

Parameter

Default value

Description

Valid examples

pattern

 

A Character string, which must be present in the document name or description. One or multiple patterns may be entered (multiple terms being separated by commas).

If no pattern is given, a check is run to make sure that at least one document (regardless of how it is named) is attached!

  • PhoneNumberList

  • PhoneNumberList,docx,TravelCosts

description

true

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).

false

caseSensetive

false

Denotes if upper-and lowercase 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).

false

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 documents are attached, they must conform to the file endings.

pdf, docx, pptx

enforcePattern

false

If set to “true”, all of the attached documents must conform to the pattern specified above (Parameter 1). If “false”, only one file must conform to the pattern. Possible values for this are “true” or “false”

true

checkCurrentNode

false

If set to “true”, a routine will check for added documents on the node.

true

 


Valid examples

If the check should only determine if a document is attached, the action handler will be executed without the parameter!