You are here: Section Rules References > Section Rules Summary > AddMultiPageBitmap
AddMultiPageBitmap
Use this section level rule to import PDF or TIFF files as bitmap images. If the file consists of multiple pages, the system inserts the first page on the triggering form or section. For each subsequent page in the file, the system generates additional pages and appends them to the form after the triggering section.
See Using the Type Option for information on importing specific file types.
Syntax
;AddMultiPageBitmap;Options;;
For the Options parameter, this table describes your choices:
Option |
Description |
---|---|
Opt |
(Optional) Enter Yes to indicate this rule is optional and you do not want error messages generated if the file naming parameters fail to produce a valid name. The default is No. This option lets you use multiple named parameters. The first parameter that provides a usable file name is used. Make this option the first rule parameter. |
Crop(height[in|mm],width[in|mm]) |
(Optional) Use this option to remove all parts of the graphic that extend beyond the specified distances from the top left corner. If you omit one of the arguments, the graphic is not modified in that dimension. See Using the Crop Option for more information. |
Use one of the following options (DAL, File, GVM or SRCH) to specify the filename.
DAL (script name) | Enter the name of the DAL script you want to execute to return the name of the file you want to import. You must enter the name of a script file or DAL library routine. Do not include DAL statements. |
File (file name) | Enter the name and path of the file you want to import. |
GVM (variable name) | Enter the GVM variable name that contains the name and path of the file you want to import. The GVM variable is mapped by some other means before this rule is executed. |
SRCH (search criteria name data) | The name and the path of the file you want to import is contained in a record in the file specified by the ExtrFile option in the Data control group. The search criteria is one or more comma-delimited data pairs, offsets and character strings, used as the search mask to find the record in the specified file. The name data is a comma-delimited data pair that defines the offset and length of the file name in the record defined by the search criteria. Separate the search criteria and name data by a space. |
Embed |
(Optional) Include Embed to add the image data in the NA file. This is necessary when the file that contains the scanned images is temporary and you need to archive the NA/POL in formation. Upon retrieval, if you have not embedded the bitmap information directly into the form set, you will not be able to view or reprint the original images. The default is No. Keep in mind that embedding bitmap data can make the resulting NA file much larger and also affects the size of the archives generated. Beginning with release 12.2.1, the Embed option is automatically set by default for PDF files. See the BitmapLoaders INI options UseImageExportOnly and PDFImportColorDepth. Information on the BitmapLoaders INI group and options can be found in Studio Settings. |
Only (Odd or Even) |
(Optional) By default, all images in the file are included. Only include this option to specify that you want only the odd or even numbered images. You can use this option to reduce the size of the output when you know blank pages are included in the scanned images on every other page. Choose Odd when you know that the first image is not blank. This includes images 1, 3, 5, and so on. Choose Even to start with the second image. This includes images 2, 4, 6, and so on. If you include both Only (Odd) and Only (Even), you exclude all images. |
IN (top, left) |
(Optional) Specifies the coordinate for the top-left corner of the bitmaps, in inches. The default is position 0,0 within the image |
MM (top, left) |
(Optional) Specifies the coordinate for the top-left corner of the bitmaps, in millimeters. The default is position 0,0 within the image. |
Top (top, left) |
(Optional) Specifies the coordinate for the top-left corner of the bitmaps, in FAP units (2400 per inch). The default is position 0,0 within the image |
Type |
(Optional) Enter T (TIFF) or P (PDF). If you omit this option, the system first looks for TIFF files. If it cannot find a TIFF file, it looks for a PDF file. Including this option will speed processing. You can also include this option if the target directory contains both TIFF and PDF files. For instance, if the directory contains import1.tif and import1.pdf, the TIFF file is included by default. If you want to include the PDF file, use the Type option, |
Scale(height[in | mm]. width[in | mm]) |
(Optional) Use this option to resize the loaded graphics while maintaining the aspect ratio (height to width), so the graphic fits within the provided height and width dimensions. If you only provide the height or width, the system sizes the graphic to fit that dimension and automatically calculates the other dimension to preserve the aspect ratio. |
Keep in mind:
- You can specify several AddMultiPageBitmap rules, but realize that each subsequent rule reuses the document pages added by previous rules.
For instance, suppose you have declared two rules. The first has a 4-page file. The second has a 5-page file.
After executing the two rules, there will be five pages in the form. The first four pages will have two images each (one from the first rule and one from the second) and the final page will contain the last image from the 5-page file.
Be aware that the placement of those bitmap images on the page can make them overlap.
Note | This rule supports long file names on 32-bit Windows operating systems. |
The system supports these types of TIFF images:
Type |
Description |
---|---|
Type 1 |
Uncompressed |
Type 2 |
Huffman |
Type 3 |
CCITT group 3 FAX |
Type 4 |
CCITT group 4 FAX |
Type 5 |
LZW |
Type 32773 |
Packbits |
● | When importing TIFF or PDF files, keep in mind you can only include one of the image positioning parameters, Top, In, or MM. The value specified is relative to the FAP file's origin as specified by a SetOrigin rule. If there are more than one positioning parameters, subsequent definitions override prior ones. If you omit the positioning parameters, the default top/left coordinate is taken from the margin defined for the FAP file. If the FAP file is not loaded and the margins are unknown, the default is 0,0 (aligned with the top of the image). |
● | For TIFF and PDF files, if either the LoadFAPBitmap option or the Embed parameter are set to Yes, the bitmap is loaded into memory. If neither are enabled, the system opens the file to get the bitmap size, resolution, and number or pages, but the bitmap data is not loaded. The system then assumes all of the bitmap images are the same size as the first image in the file. For single step mode, set LoadFAPBitmap option to Yes. |
● | You can use the PDFImportDPI option to set the resolutions at which files are imported. |
< BitmapLoaders >
PDFImportDPI =
Option | Description |
PDFImportDPI | Enter the resolution in dots per inch (DPI) at which you want to import PDF files. The default is 100 DPI. A higher DPI gives you better fidelity, but the import process will take longer and the output files will be larger. |
Note | : For information related to PDFImportColorDepth, please refer 'BitmapLoaders' section in INI help. |
Example
These examples show how you can define the file to import when you use this rule. Assume that your MRL has these sub-directories which contain these PDF files:
Directory |
File name |
---|---|
PDF_DAL |
A_DAL.PDF |
PDF_File |
A_FILE.PDF |
PDF_GVM |
A_GVM.PDF |
PDF_SRCH |
A_SRCH.PDF |
© Copyright 2020, Oracle and/or its affiliates. All rights reserved. Legal notices.