TiffMultipageMerge actions

This action library combines images associated with a DCO page to a multiple page TIFF image. The source images do not need to be TIFF images, the resulting file is a TIFF image that contains multiple images within it. The action MergeToMultiplePageTIFFImage creates a multiple page TIFF image in a single step. Pages can be optionally included by page type. Additionally, pages can be included or excluded by page status or by the status of the parent document object.

The action AddCurrentpageImageToMultiplePageTIFFImage adds the current page object as the last page of a TIFF image. This action does not run as fast as the MergeToMultiplePageTIFFImage action.

A multi-page TIFF file has a maximum file size of 4GB. It is possible that files between 2GB and 4GB will not work with some applications. Images that have very large X or Y pixel dimensions may fail to be added to the TIFF.

Action Summary

AddCurrentPageImageToMultiplePageTIFFImage: Adds the current page as a new image of a multiple image TIFF.

MergeToMultiplePageTIFFImage: Merges all pages under a document or batch object into a single multi-page TIFF.

SetMergeFileName: The name of the multiple page TIFF to create.

SetMergeOutputDirectory: Allows specification of the output diretory. If not called, defaults to the batch directory.

SetPreserveCompression: If the same compression should be used in the final file.

SetStatusToIncludeOrExclude: Optionally allows inclusion or exclusion of images by document or page status.

Refer ApplicationObjects actions library for more information regarding the Datacap Object Hierarchy (DCO).

Smart Parameters

Parameters that use an "@" notation, such as "@X.xxxx", "@P.xxxx", "@STRING()", "@PILOT()", etc., are known as "smart parameters". The data passed as a parameter to an action is evaluated at runtime. For example, "@X" is notation for accessing the current object. "@P" accesses the page object, which could be the current object, or a parent object. Being evaluated at runtime, allows recognized data or other batch specific data to be passed to actions or stored as metadata. A smart parameter such as @DATE could be used to name export files based on the current date. Similar smart parameters retrieve the current batch ID, current batch directory, current operator ID, and more. Smart parameters are a very powerful mechanism of getting data from other areas of the application and copying it into a new location or passing it as a parameter to an action. It is recommended that the smart parameter documentation is reviewed to understand the full capabilities available. The top-level help of the ValidationAndTextAdjustments action library also has information about smart parameters. Some characters such as +, \ and . also have special smart parameter meaning and may be interpreted as a smart parameter. This can be controlled using smart parameter syntax.