Binder Dialog Box

Use options in this dialog box to activate and configure the Binder component in a workflow.

Note: You can use RRTs to configure all of the options of this dialog box.
Option Description
Activate Activate the component according to a condition. The condition is evaluated at run time. For more information, see Conditional activation.
Pass through Select this check box to pass the documents to subsequent components in the workflow. If this check box is selected and the release condition is evaluated to be FALSE, the document is added to the specified volume and passed for additional processing.
Working directory Enter the path to the working directory that the component uses to keep temporary files into which the input documents are added until the release condition is satisfied.
Add to volume Enter the identifier of the document which will accumulate the pages of the input documents. When the component starts to process input documents, it creates a temporary directory named by the specified ID within the working directory. In this directory, the component creates the AsBinder.tif file, which binds all the pages of the input documents. Input documents are added to this file as long as the release condition remains FALSE. The invalid symbols (\ / " : < > | * ?) will be replaced by the underscore symbol (_).
Output file name Enter the name of the file that will be passed to subsequent components in the workflow for further processing. Invalid symbols (\ / " : < > |* ?) will be replaced by the underscore symbol (_).
Release condition Enter the condition that determines when the component releases documents into the process. As long as the condition is evaluated to be FALSE, the component accumulates input documents and adds them to a temporary file. When the value of the condition changes to TRUE, the resultant document is passed to the further processing and the temporary directory is deleted. You can use an RRT to obtain a condition value from this or previous components. For example, when the RRT scheme is ~BND::TotalCount~>=10, the document will be released when the number of pages in the document reaches or exceeds 10. If the value of the condition is TRUE and the component receives a document, it will be simply passed to the next component rather than being bound to subsequent documents. The syntax of the release condition is the same as for activation (see Conditional activation). You can initially set the condition to FALSE and then change it manually to TRUE after all documents are accumulated.
Check after adding each page The component will add the document page by page and check the condition after adding each page. Otherwise, the condition will be evaluated after the whole input document is added to the temporary file. For example, if you have input documents with different number of pages and want the output documents to have the same number of pages, you can select this option and set the release condition like this ~BND::TotalCount~=10.
Note: If you do not select this option, the release condition might never be satisfied.
Limits on volume This group contains additional restrictions on the output file. This is a preventive measure to avoid the situation of an incorrect release condition (which cannot be satisfied, for example, or which is too specific), in which the output file will grow indefinitely. If these options are used the document will be released when one of the limits is reached regardless of whether the release condition is met or not.
  • Release file if limit is exceeded — Select this check box to turn on additional restrictions.
  • Max page count — The maximum page count.
  • Max file size — The limit on the file size.
Note: The minimum value for Max page count and Max file size is 1, and the maximum value is 2147483646.
Output file options This group defines whether to save and where to save processed and rejected files.
  • Keep processed — Select this check box to save successfully processed files into a specified directory.
  • Keep rejected — Select this check box to save rejected documents into a specified directory.
Note: If you process several documents with condition value FALSE and then stop the process, the AsBinder.tif file stays in the temporary directory. If you start the process again and send several documents with condition value FALSE, the component continues to accumulate documents pages in this file.

Release Condition Examples

Release the document when its size exceeds 1MB
The condition should be "greater or equal" and not simply "equal", because file size is rarely equal to a specified number. In this case, you could use the condition ~BND::FileSize~>=1073741824.
Release the document when its number of pages reaches 10
Make sure that the number of pages can be reached. For instance, if you add only 2-page documents, every 5 files will amount to one 10-page document. If you have only 3-page documents, then they will never attain 10 pages.
  • To split documents by pages, you can use the condition ~BND::TotalCount~=10 and select the Check after adding each page option.
  • To avoid splitting documents, you can use the condition ~BND::TotalCount~>=10 to assure that documents do not get stuck.
Release the document on a specific date
To release a document on Christmas day, you could use the condition (~BND::%m~=12) & (~BND::%d~=25).
Use RRTs of preceding components
When the FTP Poll component captures files from an FTP location, you can use the condition ~FTP::FileName~=="last.tiff" to release a captured file.