1 RICOH Web Enablement Solutions Suite
1.1 AFP2PDF Plus
The following publications are available for AFP2PDF Plus. Click the PDF link after the book title to open a PDF version of the book in a new tab. Click the HTML link to open the HTML version of the book in this tab.
1.1.1 RICOH Web Enablement Solutions Suite: Summary of Updates 1.3
The main updates for Web Enablement Solutions Suite, version 1.3, are summarized in the table below.
Date |
Release number |
Summary of changes |
2020.03.10 | 1.300.00 | Web Enablement Solutions Suite 1.3 Release |
2020.03.20 | 1.300.01 | DE38227 - Fixed the processing issue for the Set Intercharacter Adjustment, when Set Variable Space Character Increment is also used. |
2020.03.30 | 1.300.02 | DE38243 - Fixed the missing characters issue when using Type1 Japanese fonts. |
2020.04.03 | 1.300.03 | DE38246 - Fixed the issue regarding the GOCA pattern change from the options file. The change also extends to another GOCA pattern. |
2020.04.07 | 1.300.04 | DE38243 - Fixed customer issue related to incorrect width for some characters and a glyph that did not appear as expected. This new fix addresses both the original 1.300.02 fix and the new issue. |
2020.04.15 | 1.300.05 | DE38408 - Created a special case for code page 300 to use a custom charset instead of the default Java one, because of inconsistent output when decoding arrays that contain unmappable code points. The custom charset has the same mapping as the standard Java charset for code page 300, but the decoding algorithm is different. |
2020.05.05 | 1.300.06 | DE38530 - Fixed client code to handle the End of File marker properly. |
2020.05.07 | 1.300.07 | DE38612 - Fixed alignment when Set Intercharacter Adjustment is used with horizontal scaling
( width override) from csdef.fnt or when the character rotation is used. |
2020.05.19 | 1.300.08 | US53549 - Added page-piece dictionary to PDF when the odload option is used with the ArchiveLoad_afp2pdf command for loading CMOD. |
2020.05.29 | 1.300.09 | DE38788 - Changed TLE processing for an AVE compatibility issue. |
2020.06.18 | 1.300.10 | DE38664 - Added the option to select the legacy processing for:
|
2020.07.01 | 1.300.11 | US53650 & US53667 - Ricoh internal fixes. |
2020.07.02 | 1.300.12 | DE39005 - Fixed issue with additional invalid characters added by the transform, when a UDC section is missing. |
2020.07.04 | 1.300.13 | DE39004 - Use an IBM Shift-JIS encoding when creating strings from a SHIFT-JIS code page mapping file. |
2020.07.21 | 1.300.14 | DE39131:
DE39192 - Fixed an error causing the last character of mixed UDC and non-UDC TRN text to be lost. |
2020.08.07 | 1.300.15 | DE39293 - Fixed various font issues. |
2020.08.13 | 1.300.16 | US54779 - When text characters cannot be mapped in the requested mapped font, use the AFP Font to convert those characters to image. |
2020.08.28 | 1.300.17 | DE39460 - Moved horizontal scale calculation to avoid being used twice when SIA is applied.
DE39476 - Used vertical encoding for Chinese, Japanese, and Korean (CJK) fonts, when the character rotation is 90 or 270. |
2020.09.08 | 1.300.18 | US55110 - Added support for double values in the image map configuration file. |
2020.09.14 | 1.300.19 | DE39520 - Added handling for an iText exception thrown for inputs with incorrect or unmatching AFP font resources. |
2020.10.08 | 1.300.20 | DE39735:
|
2020.10.15 | 1.300.21 | DE39821 - When SBCS text converts to contain either unicode replacement character u+fffd or u+001a, replace with a blank character, when no font is available for imaging. |
2020.10.20 | 1.300.22 | DE39883 - Fixed IOCA mask processing for double-dotted images. |
2020.10.22 | 1.300.23 | DE39860 - When using image mapping, place static images and shaded areas ahead of medium overlays. |
2020.10.30 | 1.300.24 | US55365 - Added new option to allow TrueType Font processing to search for .ucm files prior to search for .cp files. |
2020.11.03 | 1.300.25 | DE39960:
|
2020.11.13 | 1.300.26 | DE40046 - Remove white space from each line while processing various *.fnt files.
DE40047 - Remove double quotes while reading passwords from the options file. |
2020.11.17 | 1.300.27 | DE40049 - Fixed clipping and rounding issues for rotated RGB images. |
2020.11.18 | 1.300.28 | DE40112:
|
2020.11.23 | 1.300.29 | US53704:
US55966:
|
2020.12.01 | 1.300.30 | DE40153 - Allowed user offset to apply to image map files. |
2020.12.08 | 1.300.31 | DE40272 - Saved clipping size in cached page segments so it can be restored on each use and across job boundaries. |
2020.12.14 | 1.300.32 | US40491 - Added support for non MODCA images placed directly on page/overlay. |
2021.01.07 | 1.300.33 | DE40441 - Ignored empty option file entries. |
2021.01.12 | 1.300.34 | DE40485 - Converted single byte section number to integer by ANDing it with 0xff to keep the value as a positive number; section numbers are never negative. |
2021.01.13 | 1.300.35 | DE40508 - Set Intercharacter Adjustment needs to be ignored for blank characters. |
2021.01.22 | 1.300.36 | DE40533 - Improved memory usage for image mapping jobs that use only static type entries; only by adding, not by replacing. |
2021.01.28 | 1.300.37 | DE40571:
|
2021.02.02 | 1.300.38 | US57162 - Added support for multi-page TIFF images. |
2021.02.08 | 1.300.39 | US57387:
|
2021.02.09 | 1.300.40 | US57217 - Upgraded the Bouncy Castle libraries to version 1.68. |
2021.02.15 | 1.300.41 | US57319:
|
2021.02.18 | 1.300.42 | US57443 - Added the a2pxopts configuration option for PDF Producer. |
2021.03.03 | 1.300.43 | DE40679 - Replaced code point 0 with an empty character when mapping fonts. |
2021.03.10 | 1.300.44 | DE40869 - Corrected the code point for the hyphen character within Type 1 fonts. |
2021.03.18 | 1.300.45 | US58161 - Added support for external resource groups and external form definitions for all AFP Visual Environment filters. |
2021.04.01 | 1.300.46 | DE41031 - For no name on Font Descriptor, use character set name. |
2021.04.12 | 1.300.47 | US55382:
|
2021.04.28 | 1.300.48 | US58692 - Improved font bounding box calculations. |
2021.05.05 | 1.300.49 | DE41186- Fixed the TrueType font mapping to allow mapping for horizontal and vertical writing modes. |
2021.05.14 | 1.300.50 | DE41301 - Set default character as blank when marked as invalid. |
2021.05.19 | 1.300.51 | DE41358 - Use default code point or blank character for undefined code points when converting to Type 3 fonts. |
2021.05.27 | 1.300.52 | DE41380 - Ignore the IOCA Subsampling parameter when the total amount of image data indicates no subsampling. |
2021.06.03 | 1.300.53 | US42265 - Added the Capture_Files_for_Debug parameter to the options file to capture all debugging files within a zip file. |
2021.06.28 | 1.300.54 | DE41544 - Fixed the Constant Forms processing for basic N-UP/no N-UP using default page placement. |
2021.07.07 | 1.300.55 | DE41650 - Added processing of Horizontal Scale Factor for Data Object fonts (TTF, OTF). |
2021.07.13 | 1.300.56 | DE41699 & DE41663:
|
2021.07.23 | 1.300.57 | DE41749 - Updated internal codepage 837 with newer .ucm file. |
2021.07.26 | 1.300.58 | DE41669, DE41741 & DE41749.2:
|
2021.07.30 | 1.300.59 | DE41716 & DE41663.2:
|
2021.08.13 | 1.300.60 | DE41870:
|
2021.08.23 | 1.300.61 | DE54098 - Ignore the -host parameter. The use of this parameter is allowed only for backward compatibility purposes. |
2021.08.24 | 1.300.62 | Internal use only |
2021.09.02 | 1.300.63 | DE42037 & US42518:
|
2021.09.13 | 1.300.64 |
DE42061 - Fixed font caching to allow font with same name but different content. DE42067 - Fixed TIFF processing to allow different type of TIFF image. US61289 - If AFP codepage does not contain Unicode values, try using the mapped codepage info to obtain Unicode value. US56252 - Added new parameter to allow for PDF output pages to be resized to contain offsets from form definition and options file. |
2021.09.21 | 1.300.65 | DE42158 - Fixed G4 Decompression error on IOCA image. |
2021.09.28 | 1.300.66 | US54098.2 - Fixed the client code for z/OS USS and Linux on z broken by 1.300.61. |
2021.10.13 | 1.300.67 | DE42239 & DE42240 - Processed an empty TRN properly. Processed font with incorrect default character. |
2021.10.15 | 1.300.68 | US61887 - Added the option to install AFP2PDF Plus server as a service on supported platforms (Windows, Aix , Linux and zLinux). |
2021.10.20 | 1.300.69 | DE42341 - Fixed log files ignoring size limit from logging.properties |
2021.11.04 | 1.300.70 | US61628 - Added support for vertical text when using TTF fonts and when using mapped TTF fonts. |
2021.11.15 | 1.300.71 | DE42504 - Make sure the start/stop server scripts have the shebang entry (#!/bin/sh) when upgrading from an older version of Plus. |
2021.12.08 | 1.300.72 | DE42645 & DE42646:
|
2021.12.15 | 1.300.73 | DE42654 & DE42655 & DE42656:
|
2021.12.22 | 1.300.74 | DE42654 continued - When searching for external non-MODCA resources (tif, jpg,gif, pdf), we are also
using file type specific extensions.
US61976 - Updated Apache Santuario (xmlsec) library to version 2.2.3 to fix security vulnerability. |
2022.01.13 | 1.300.75 | WE3-459:
|
2022.01.21 | 1.300.76 | WE3-454 (DE42655.2) - Fixed char rotation 90 positioning. |
2022.01.21 | 1.300.77 | WE3-473 - Fixed split_afp2pdf external resource issue caused by misused static member in multithreaded environment. |
2022.02.04 | 1.300.78 | WE3-475 - Fixed Archive_load sometimes not showing content from page segment resources. |
2022.02.08 | 1.300.79 | WE3-478 - Fixed an iText issue that was causing an exception with non-pdf output when using pfb resources that did not have a certain format. |
2022.02.15 | 1.300.80 | WE3-454 - Additional fix for positioning of rotated characters. |
2022.02.25 | 1.300.81 | Removed a smallportion of logging information that could cause crashes on Java versions starting with 9 |
2022.03.10 | 1.300.82 | WE3-486 Improve handling of badly formatted jpeg images: instead of terminating the entire processing without any pdf ouput, just skip the bad image, log it and continue processing. |
2022.03.28 | 1.300.83 | WESS-3413 Improve accuracy of relative and absolute movement in PTOCA. WESS-901 Improving caching of non MODCA image resources and PDF objects by adding a configurable size limit. |
2022.05.04 | 1.300.84 | WE3-492 Modified the way TrueType fonts are subsetted so that they work with custom code-page (1038 - symbol cp). |
2022.05.23 | 1.300.85 | WE3-497 Fixed a crash caused by missing IOCA resources. |
2022.06.07 | 1.300.86 | WE3-499 Fixed an issue that was causing external resources groups passed as parameters to be in use even after their respective job was done, making it so they could not be deleted while the server was running. |
2022.06.07 | 1.300.87 | WE3-500 Fixed processing of default character flags for AFP code page/charset resources. |
2022.06.10 | 1.300.88 | WESS-3553 Fixed split_afp2pdf XML output when using the -tle option: escaped special XML characters in the tle name and value. |
2022.08.11 | 1.300.89 | WESS-3634 Add support in the installer for Windows 11 and Windows Server 2022. |
2022.09.09 | 1.300.90 | WE3-508 Fixed a multithread related issue that could cause caching of page segments in server
mode to lose content, due to it being clipped out by a 0 bounding box.
WE3-506 Update User Guide description of the -tle parameter for split_afp2pdf. |
2022.10.10 | 1.300.91 | RPD3-5200 AFPParser issue from VWB - fixed PTX issue related to chained control sequences. |
2022.10.20 | 1.300.92 | WE3-504 Ensured that the font-path is consistent, so that it is processed only in the first thread. |
2022.11.07 | 1.300.93 | WE3-504 Synchronized setting the decoder for TrueType fonts. This prevents potential errors when running multiple threads in split or server mode. |
2022.11.17 | 1.300.94 | WESS-3658 Updated the communication with PDF2PDFUA;
WESS-3718 Added the Disable_TTF_Subsetting config option. |
2023.01.10 | 1.300.95 | WE3-521 Commit changes for adding imagemap support for AFP2PDF Split. |
2023.02.06 | 1.300.96 | WESS-702 Add support for rotated IPO; WESS-218 - Add support for SEC CIELab and Highlight color space. |
2023.02.12 | 1.300.97 | WE3-520 Improve support for JPEG compressed images using Apache Commons Imaging when our regular image processing fails. |
2023.02.13 | 1.300.98 | WE3-527 Added a limitation to the size of the glyph bounding box for Type3 fonts to remove Acrobat Reader error. |
2023.02.15 | 1.300.99 | WE3-528 Updated ImageGenerators.jar to support RGBs with alpha-channel. |
2023.02.23 | 1.301.01 | WE3-529 Added default basline increment value. |
2023.02.24 | 1.301.02 | WE3-530 Fixed a PGP repeating group index that was adding a PMC overlay on a blank page. |
2023.03.13 | 1.301.03 | WESS-3929 Added new config file option to output the number of transfomed pages. |
2023.03.27 | 1.301.04 | WESS-4085 Improve image mapping to allow the addition of an alternate text for images. This is only relevant when using Afp2pdf Plus in conjuction with the PDFUA tool. |
2023.04.03 | 1.301.05 | WESS-3929 Add OpenTypoe and TrueType font mapping support. |
2023.04.12 | 1.301.06 | WESS-4064 Updated copyright in source-code. |
2023.04.27 | 1.301.07 | WESS-3605 Fix Extended Bilevel Image Color in IOCA. |
2023.05.26 | 1.301.08 | WE3-535 Remove redundant clipping from GOCA objects that was causing unwanted behavior (missing content) when page offsets were specified in the options file.A89 |
2023.05.30 | 1.301.09 | WE3-533 Added new command line option (-c) to AFP2PDF Split to specify the size of the cache. WESS-4300 - Fix a rare issue that could cause flag parameters (like -m for example) to be ignored in server mode if they were the last one. WESS-4301 - Fix a null pointer exception when using some unsupported but tolerated parameters (-l, -g, -s). |
2023.06.09 | 1.301.10 | WE3-536 Fixed a typg o that was preventing mapping to Helvetica-Narrow type fonts; Fixed a font mapping issue that in certain situations would cause mappinto Adobe base fonts to be ignored. |
2023.06.19 | 1.301.11 | WESS-4362 Fixed a crash when calling the transform with an option file without any valid options
inside. WESS-4307 Integarated ImageGenerator code into afp2pdf plus projects. WE3-538 Fixed some scripts not correctly passing arguments with spaces inside. |
2023.07.03 | 1.301.12 | WESS-4377 Fixed the fordef parameter that was not working for split_afp2pdf when image mapping was not used. Removed JAXB dependency from Afp2pdfplit so it works with newer versions of the JVM that no longer ship this package. |
2023.07.10 | 1.301.13 | WESS-4236 Implemented native DASH_PATTERN_style configuration file option in AFP2PDF Plus. |
2023.07.23 | 1.301.14 | WE3-540 Added additional check for DBCS Raster code-pages when matching code-pages from icoded with the ones from cpdef . |
2023.08.03 | 1.301.15 | WESS-4431 Improved processing of AVE control files to allow "pretty print" formatted XMLs. |
2023.08.21 | 1.301.16 | WESS-4442 Improved support for running AFP2PDF Plus as a service on Windows. Added a sleep equivalent during uninstall to prevent IA from stalling. |
2023.08.30 | 1.301.17 | WESS-4236 Fix for handling configuration entries while processing dash line patterns when some entries are commented out. |
2023.10.03 | 1.301.18 |
WE3-551 Fix TTF processing to tolerate fonts that use the Unicode Supplementary Private Use Areas without having an alternate code in a non private use area. WE3-550 Page content is using page position when processing a 3-UP file, although it should
not. Added |
2023.10.05 | 1.301.19 | WESS-4586 Update default encryption for password protected pdfs to AES256. Update Datalogics PDF Java Toolkit to 5.0.7. WESS-4616 Update Bouncy Castle libraries to 1.76 to fix security vulnerabilities. |
2023.10.12 | 1.301.20 | WE3-552 Fix an unhandeled exception that could occur in very niche cases involving input files with PDF417 barcodes. |
2023.11.03 | 1.301.21 | WESS-4639 Made a change that makes the order some GOCA objects are written more consistent across different OSs and/or JVMs. The change has no impact on output size or appearance, it was just needed for our regression tests. WESS-4656 Added support for GS1 AI encodable character set 39 and 82. |
2023.12.11 | 1.301.22 | WESS-4313 Add global scale command line option. Fixed a split_afp2pdf issue that could prevent outputs to be generated if the output names were based on TLE information containing special characters (backslash). |
2024.01.23 | 1.301.23 | WESS-4828 Updated Apache xmlsec library to version 2.2.6. WESS-4827 Migrated build process to use Install Anywhere 2022 when creating the final installation package. |
2024.01.29 | 1.301.24 | WE3-557 Updated the GOCA Set current defaults instruction to take in account the default bit in byte 5. |
2024.01.31 | 1.301.25 | WE3-556 Fixed performance issue in server and API mode caused by unnecessary overhead in the caching mechanism for page segment and overlay resources. |
2024.03.21 | 1.301.26 | WE3-564 Made changes so that the logging option specified via API overrides the configuration file option. |
2024.04.03 | 1.301.27 | WE3-564 Added flushing of the logging handler so that only warnings work. WESS-4924 Fixed null pointer in ImageGenerators found while test IOB rotation for AFP Visual Environment. |
2024.04.15 | 1.301.28 | WE3-567 Fixed a crash when processing True Type fonts without a glyph substitution map. |
2024.04.16 | 1.301.29 | RPD3-5775 Made changes to the AFPParser to make it more thread-safe, removing a potential deadlock during AFPSf initialization. |
2024.04.24 | 1.301.30 | WESS-4521 RICOH internal changes. |
2024.05.10 | 1.301.31 | WE3-569 Memory usage improvements related to image caching including a new options file entry:
PER_JOB_IMAGE_CACHE . |
2024.05.24 | 1.301.31 | WESS-5157 Mitigate vulnerability CVE-2017-9096 in iText. |
2024.06.07 | 1.301.33 | WESS-5215 Added support for inflate/deflate compression in TIFF images. |
2024.08.06 | 1.301.34 | WESS-5342 Updated Bouncy Castle to v1.78.1. WESS-5366 Improved image mapping config file parsing to tolerate some niche cases. |
2024.08.09 | 1.301.35 | WE3-575 Adjusted Type3 glyph bounding box to solve printing issues on some 3rd party printers. |
2024.08.14 | 1.301.36 | WESS-5272 Added support for USE_AFP_METRICS config file option that allows to use the AFP fonts metrics on mapped fonts. |
2024.09.03 | 1.301.37 | WESS-4705 Fixed a crash when using Capture_Files_For_Debug option file entry in API mode. Added input and output to the debug capture. WESS-5394 Improved error logging in API mode. |
2024.09.13 | 1.301.38 | WE3-586 Fixed alternate text not being added for images when Preserve_CMYK was set to false. WE3-583 Fixed missing resource log entries not showing for certain types of resources. |
2024.09.19 | 1.301.39 | WE3-587 Fixed a bug that was causing 0 size output in niche scenarios where an external formdef was used. |
2024.09.26 | 1.301.40 | WE3-590 Adjusted the fill GOCA patterns for patterns 9 to 13 (filling using vertical, horizontal or diagonal lines). |
2024.10.07 | 1.301.41 | WE3-588 Added new config file option GOCA_COLOR_OF_MEDIUM to specify the color of medium. |
2024.10.22 | 1.301.42 | WE3-581 Changed logging when running through API to allocate each thread to its own logger, thus removing OOM error for large number of threads. |
2024.10.31 | 1.301.43 | WE3-594 Fixed Type3 glyph positioning. Recalculations made the Type3Glyph_Position_Legacy options file entry useless. |
1.1.2 Quick Start Guide for AFP2PDF Plus, Version 1.301
1.1.2.1 Overview
This quick start guide helps you cover the basic instructions on using the AFP2PDF Plus Transform. The document is available from the installer or from the RICOH Software Information Center.
Use these instructions when running the transform on a Windows/AIX/Linux/zOS USS/zLinux operating system. For more information regarding the transform, see the AFP2PDF Plus Transform User's Guide, also available in the install directory.
1.1.2.2 AFP2PDF Plus Version
To identify the transform version, use:
- For Windows:
afp2pdf.bat -version
- For Unix:
afp2pdf.sh -version
AFP2PDF: Version 1.200.04
Trial version
To run the trial version of the AFP2PDF Plus Transform:
- Use the following certificate files:
AFP2PDF.cer
AFP2PDF.pk
AFP2PDF.sig
- Copy the certificate files in the installation directory.
To request the trial version and the certificate files, contact Advanced Technical Support at ATS@ricoh-usa.com.
1.1.2.3 Initial Setup
No installation process is required when using the AFP2PDF Plus Transform for the first time.
- Create a directory of your choice, such as:
C:\afp2pdf
- For Windows.
/afp2pdf
- For Unix.
- Copy and unzip
afp2pdf_plus_vxxx_WIN.ZIP
(for Windows) or uncompress and unpackafp2pdf_plus_vxxx_yyy.tar.gz
(for Unix) into the new directory.- Note:
- If you are on a Unix system, use
gzip -d afp2pdf_plus_vxxx_yyy.tar.gz
to create anafp2pdf_plus_vxxx_yyy.tar
file, then unpack the file.
- If you are on a Unix system, use
See the chapter Installing AFP2PDF Plus Transform on a Windows Server or Installing AFP2PDF Plus Transform on a UNIX Server from the AFP2PDF Plus Transform User's Guide, for more details.
1.1.2.4 AFP2PDF Plus Transform Command
To run the AFP2PDF Plus Transform, you can use 2 options:
- Command line process
For Windows:
afp2pdf.bat
For Unix:
afp2pdf.sh
- Server process
For Windows:
afp2pdf.exe
For Unix:
afp2pdf
- Note:
- This option must be used for the server version of the transform. Make sure that the server is running.
To start the server process from command line, use:
- For Windows:
StartAFP2PDFServer.bat
- For Unix:
StartAFP2PDFServer.sh
- Note:
- To start a background process, use
nohup StartAFP2PDFServer.sh &
for Unix orstart /b StartAFP2PDFServer.bat
for Windows. - If you do not start the server as a background process, do not close the command prompt window. To submit jobs to the server, open another command prompt window.
- If you see this error message, the server process may not be running:
Error: cannot connect to host localhost on port number 6512
For more information, see the chapter Using the AFP2PDF Plus Transform from the AFP2PDF Plus Transform User's Guide.
1.1.2.5 Testing the AFP2PDF Plus Transform
- Testing with the command line version
- To create an output file with the same name and a .pdf file extension, use a separate
window to run the following:
- For Windows:
afp2pdf.bat insure.afp
- For Unix:
afp2pdf.sh insure.afp
- For Windows:
- Testing with the server version
-
- For Windows:
StartAFP2PDFServer.bat
- For Unix:
StartAFP2PDFServer.sh
- For Windows:
- To test the server version:
- Start the server process. Keep the window open.
- Create an output file with the same name and a .pdf file extension:
- For Windows:
afp2pdf.exe insure.afp
- For Unix:
afp2pdf insure.afp
1.1.2.6 Upgrading from C/C++ AFP2PDF transform to AFP2PDF Plus
To upgrade from the C/C++ AFP2PDF transform to AFP2PDF Plus, you can choose either of these methods:
- Using the
upgrade.jar
fileUpgrade.jar
creates a backup of the C/C++ AFP2PDF transform and replaces it with AFP2PDF Plus.For more information on how to use this option, see the chapter Upgrading from AFP2PDF to AFP2PDF Plus Transform from the AFP2PDF Plus Transform User's Guide.
- Installing the AFP2PDF Plus on the same physical server or on a separate new physical
server
Leaves the C/C++ AFP2PDF transform intact and installs AFP2PDF Plus to run in parallel with the C/C++ version.
In this case, to upgrade to AFP2PDF Plus, follow these steps:
- Unpack the AFP2PDF Plus into a new directory, separate from the current C/C++ AFP2PDF transform installation.
- Rename the font directory in the AFP2PDF Plus installation directory.
- Copy the font directory from the C/C++ AFP2PDF transform installation to the new AFP2PDF
Plus install directory.
- Note:
- This may contain font mapping, previously used with the C/C++ AFP2PDF transform.
- AFP2PDF Plus can be installed:
- On the same physical server:
- On the same physical server:
- The current resource locations of C/C++ AFP2PDF transform can be referenced directly
from
a2pxopts.cfg
.- Copy the resource locations from the C/C++ AFP2PDF transform
.cfg
or.ini
file. - Add them to the AFP2PDF Plus
a2pxopts.cfg
file.
- Copy the resource locations from the C/C++ AFP2PDF transform
- On a separate new physical server:
-
- Copy all resources to the new server: AFP resources, Type1 fonts, Truetype fonts.
- Keep a note of the new resource locations from the C/C++ AFP2PDF transform
.cfg
or.ini
file. - Add them to the AFP2PDF Plus
a2pxopts.cfg
file.
1.1.2.7 AFP2PDF Plus Transform Option Parameters
Parameters to control settings for the AFP2PDF Plus Transform are specified in a a2pxopts.cfg
options file. The most important parameters are:
Auto_Rotate= | Rotates landscape pages. |
Font_Path= | Specifies the location of the font mapping file. |
Logging=Append,C:\temp,WARNING | Creates a log file. |
PfmPfb_Directory= | Indicates the location of Type1 fonts. |
ResourceDataPath= | Specifies the AFP resource directories.
|
TrueType_Directory= | Indicates the location of TrueType fonts. |
1.1.2.8 Setting the Java classpath parameter
When running the transform from another directory, you can customize the batch file or shell script to set the classpath Java parameter.
If you installed AFP2PDF Plus following the steps from the Initial Setup, use these commands to set to install directory:
- For Unix:
-classpath "/afp2pdf/*:"
- For Windows:
-classpath "C:\afp2pdf\*;"
1.1.3 AFP2PDF Plus Setup Guide
1.1.3.1 Introduction
1.1.3.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the machine. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
Do not remove or insert any disk while operating this application.
1.1.3.1.2 Cautions Regarding This Guide
- Some illustrations or explanations in this guide may differ from your application due to improvement or change in the application.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified or quoted without prior consent of the manufacturer.
1.1.3.1.3 Guides for This Application
Instruction Manuals
These instruction manuals are included:
- AFP2PDF Plus Transform Setup Guide
This guide explains the setup and startup procedures, and the settings required before you can use this application.
- AFP2PDF Plus Transform User’s Guide
This guide explains the functions and basic operations of this application.
1.1.3.1.4 How to Read the Documentation
1.1.3.1.4.1 Before Using This Application
1.1.3.1.4.2 How to Use the Manuals and Help
- To learn how to install and start this application
- See the Setup Guide.
- To learn about the functions and basic operations of this application
- See the User’s Guide.
1.1.3.1.4.2.1 Displaying the Instruction Manuals (Setup Guide and User's Guide)
- Displaying the Setup Guide and User's Guide in PDF Format
-
- Displaying the User’s Guide
- Displaying the Setup Guide
- Displaying the User’s Guide
1.1.3.1.4.2.2 Symbols
Important:
|
This symbol indicates points to pay attention to when using the application. Be sure to read these explanations. |
Note:
|
This symbol indicates supplementary information that you may find helpful, but not essential to completing a task. |
[ ] | This symbol indicates the names of screens, menus, settings, and buttons. |
1.1.3.1.5 Trademarks
These terms are trademarks or registered trademarks of Ricoh Co., Ltd., in the United States, other countries, or both:
- Advanced Function Presentation
- AFP
- Bar Code Object Content Architecture
- BCOCA
- Ricoh
Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Other company, product, or service names may be trademarks or service marks of others.
1.1.3.2 Before Setting Up
Read this chapter thoroughly before setting up this application.
1.1.3.2.1 Requirements
These are the transform client and server requirements and end-user client requirements for the AFP2PDF Plus Transform:
-
Transform requirements:
- IBM AIX 7.1 or later
- IBM z/OS UNIX System Services V1.13 or later
- Microsoft Windows 10 Pro, Enterprise or later
- Microsoft Windows Server 2016 Std or later
- Linux Kernel 2.6.18 or later (x86), with "fontconfig" package installed.
- Linux Kernel 2.6.09 or later (IBM System z), with "fontconfig" package installed.
-
Transform server requirements: JAVA V1.8 or later
-
End-user client requirements: Adobe Acrobat, Acrobat Reader, or Acrobat Plug-In 9.0 or later
-
To run the installer, you need to have at least 350 MB of free space in the operating system temporary directory.
1.1.3.3 Installing the AFP2PDF Plus Transform using the graphic user interface
To run the transform, perform these steps:
- Use the following commands:
- Full Version
java -jar setupafp2pdfPlus_<version>.jar
- Trial Version
java -jar setupafp2pdfPlus_<version>_Trial.jar
- Note:
- Make sure to copy the following certificate files into the installation directory:
- AFP2PDF.cer
- AFP2PDF.pk
- AFP2PDF.sig
- Make sure to copy the following certificate files into the installation directory:
- On the Welcome screen, click Next to continue the installation process of the transform.
- Note:
- To stop the installation process of the transform, click Cancel.
- In the License Agreement dialog box:
- Read the license agreement.
- Click I accept the terms of the license agreement.
- Click Next.
- Note:
- If you do not accept the terms of the license agreement, you cannot continue the installation.
- Check the prerequisites list.
- Note:
- This step applies only when you install the transform on a UNIX based operating system.
- Choose the installation type dialog box.
- New Install
-
- Select New Install for a clean installation of the transform.
- Click Next to continue the installation process and browse the destination folder for the installation of the transform.
- If the product is already installed in the selected folder, choose another destination folder.
- Upgrade
-
- Select Upgrade to upgrade to the latest version of the transform.
- Click Next to continue the installation process and browse the path for the update of the transform.
- If the product is not installed in the selected folder, choose another destination folder.
- The pre-installation summary panel appears just before the installation can begin.
This shows what you have chosen to install and the location.To complete the installation process, click Install.
The installing dialog is displayed to show the installation status.
- Click Done to close the installer.
1.1.3.4 Deploying a license key using the AFP2PDF Plus License key Installer
To run the transform on Linux, Windows, AIX, perform these licensing steps:
- In the RICOH AFP2PDF Plus Transform folder, run the executable
afp2pdf_plus_license_key_installer.jar
located in thelicense_installer
folder. - On the Introduction screen, click Next to continue the installation process of the license key.
- Note:
- To stop the installation process of the transform, click Cancel.
- On the Choose Install Folder, select the path where the RICOH AFP2PDF Plus Transform is installed.
- You will receive a machine fingerprint that will allow you to generate a new license.
- Enter the location of your license file.
- Check the pre-installation summary.
- To complete the installation process, click Install.
- Click Done to close the installer.
1.1.3.5 Installing AFP2PDF Plus Transform from command line
- Open a command prompt.
- Run the following command:
java -jar setupafp2pdfPlus_<version>.jar
to start the graphic user interface installation.- Note:
- You can force the command line installation of the transform by adding the
-i console
parameter:java -jar setupafp2pdfPlus_<version>.jar -i console
.
- You can force the command line installation of the transform by adding the
- Follow the installation instructions. The steps are similar as in the graphical installer.
See the AFP2PDF Plus Transform Command chapter from the AFP2PDF Plus Transform User’s Guide, Version 1.300 for more information.
1.1.3.6 Deploying a license key using the AFP2PDF Plus License key Installer from command line
- Open a command prompt.
- Run the following command:
java -jar afp2pdf_plus_license_key_installer.jar
to start the graphic user interface installation.- Note:
- You can force the command line installation of the transform by adding the
-i console
parameter:java -jar afp2pdf_plus_license_key_installer.jar -i console
.
- You can force the command line installation of the transform by adding the
- Follow the installation instructions. The steps are similar as in the graphical installer.
1.1.4 AFP2PDF Plus User's Guide
1.1.4.1 Introduction
1.1.4.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
1.1.4.1.2 Cautions regarding this guide
- Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
1.1.4.1.3 Symbols
- Important:
- This symbol indicates points to pay attention to when using the product. Be sure to read these explanations.
- Note:
- This symbol indicates helpful supplementary information that is not essential to completing a task.
Bold |
Bold type indicates the names of commands and parameters. |
Bold underline |
Underlined bold type indicates the default value. |
Italic | Italic type indicates variables that you must replace with your own information. |
Monospace |
Monospace type indicates computer input and output and file names. |
[] | Square brackets indicate that a value is optional. |
| | A vertical bar indicates a choice between values. |
... | An ellipsis indicates that a series can continue. |
1.1.4.1.4 Abbreviations
- ACIF
- AFP Conversion and Indexing Facility
- AES
- Advanced Encryption Standard
- AFM
- Adobe Font Metric
- AFP
- Advanced Function Presentation
- API
- Application programming interface
- AVE
- AFP Visual Environment
- BCOCA
- Bar Code Object Content Architecture
- CMOD
- Content Manager OnDemand
- CMR
- Color management resource
- CPGID
- Code Page Global Identifier
- DBCS
- Double-Byte Character Set
- ECM
- Enterprise Content Management
- FIFO
- First In First Out
- GIF
- Graphical Interchange Format
- IANA
- Internet Assigned Numbers Authority
- ICN
- IBM Content Navigator
- ICU
- International Components for Unicode
- IP
- Internet Protocol
- JFIF
- JPEG File Interchange Format
- JPEG
- Joint Photographic Experts Group
- JVM
- JAVA Virtual Machine
- NIST
- National Institute of Standards and Technology
- PCL
- Printer Command Language
- Portable Document Format
- PTOCA
- Presentation Text Object Content Architecture
- RAT
- Resource Access Table
- STC
- Set Text Color
- TCP/IP
- Transmission Control Protocol/Internet Protocol
- TIFF
- Tagged Image File Format
- TLE
- Tag Logical Element
- UT
- Universal Time
1.1.4.1.5 Trademarks
These terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both:
- AIX
- IBM
- z/OS
Adobe and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Java is a registered trademark of Oracle and/or its affiliates.
The proper names of the Windows operating systems are as follows:
- Windows 10:
Microsoft Windows 10 Pro
Microsoft Windows 10 Enterprise
- Windows Server 2016:
Microsoft Windows Server 2016 Standard
1.1.4.2 Overview
The AFP2PDF Plus Transform lets you:
-
Operate on any system that supports JAVA Version 1.8 or later.
-
View documents with the same fidelity as if they were printed. If the Adobe Acrobat plug-in is installed with a Web browser, you can view and print these documents within the browser application.
-
Use configuration files to customize how AFP documents are transformed.
-
Fully integrate with the IBM Content Manager OnDemand Web Enablement Kit and the IBM Content Navigator.
1.1.4.2.1 Benefits
-
Support for all types of bar code objects from the Bar Code Object Content Architecture (BCOCA).
-
Client/Server implementation.
-
Greatly improved transformation speed over AFP2PDF (5876-W01).
-
Larger than 2–GB input and output file support.
-
Reduce costs associated with printing and mailing by delivering documents electronically.
-
Quickly retrieve your information within multi-page documents using Adobe Acrobat search and navigation features.
-
Print AFP2PDF Plus Transform documents on any local printer using the print function in Adobe Acrobat.
-
Increase control over your information with an added layer of security and encryption. To control modification, copying, and printing, define an owner password; define an end-user password to control document access; and add a digital signature to provide more security.
1.1.4.2.2 Limitations
-
When AFP data formatted for N-up portioning is encountered, the multiple partitions that make up the physical AFP page are converted to separate pages in the PDF file.
-
Only limited support is available for object containers with TIFF and JFIF image formats.
-
Color management resource (CMR) information contained in AFP resources is ignored.
-
Unicode Complex Text, such as bidirectional layout processing and glyph processing, is not supported.
-
TrueType font collections, linked TrueType fonts, and the use of a Resource Access Table (RAT) are not supported.
1.1.4.3 Installing AFP2PDF Plus Transform
AFP2PDF Plus Transform Architecture
Since the new AFP2PDF Plus for JAVA Transform is designed to integrate with existing AFP2PDF installations, it has both client and server functions.
The transform client is a C/C++ command-line program that has parameters identical to the current AFP2PDF Transform.
The transform server is JAVA-based and performs various functions:
- Accepts requests from the transform client for document conversion
- Keeps the JAVA Virtual Machine (JVM) active without starting and stopping after each conversion
- Spawns a thread for each document to be converted, taking advantage of multi-core processors
Software requirements for the AFP2PDF Plus Transform:
-
Transform requirements:
- IBM AIX 7.1 or later
- IBM z/OS UNIX System Services V1.13 or later
- Microsoft Windows 10 Pro, Enterprise or later
- Microsoft Windows Server 2016 Standard or later
- Linux Kernel 2.6.18 or later (x86) with Fontconfig package installed.
- Linux Kernel 2.6.09 or later (IBM Z system) with Fontconfig package installed.
-
Transform server requirements: JAVA V1.8 or later.
-
End-user client requirements: Adobe Acrobat, Acrobat Reader, or Acrobat Plug-In 9.0 or later.
-
To run the installer, you need to have at least 350 MB of free space in the operating system temporary directory.
Hardware requirements for the AFP2PDF Plus Transform:
- AFP2PDF Plus does not have any additional CPU requirements in addition to what is
already required to run a supported operating system.
For optimal performance, the number of CPU threads should at least match the number of jobs expected to run simultaneously. Each job is run in a single threaded fashion. Thus, having a higher thread count CPU does not help if running one job at a time, but it helps when running multiple jobs at the same time.
- Minimum of 2 GB available RAM is required.
Depending on the workload, the performance can be improved by using more memory. The maximum amount of memory used by AFP2PDF Plus is configurable through the Java parameter
-Xmx
in the afp2pdf.bat and StartAFP2PDFServer.bat files on Windows and afp2pdf.sh and StartAFP2PDFServer.sh on AIX and Linux. For optimal performance, we recommend setting the maximum memory to at least twice the size of the combined inputs of jobs expected to run at any given time, including external resources. So for example, if in the server mode, the maximum load is 10 jobs running concomitantly with an average size of 200 MB of inputs per job, the recommended value is 4 GB. - Minimum 450 MB available space for installation:
- 100 MB available hard disk space.
- 350 MB available for the operating system temporary file.
The data consisted of resources, inputs, and outputs used by AFP2PDF Plus takes more hard disk space than the AFP2PDF Plus application itself.
The AFP2PDF Plus transform works with computers configured with any network configuration (IPv4 or IPv6).
1.1.4.3.1 Upgrading from AFP2PDF to AFP2PDF Plus Transform
Upgrade.jar
, is an executable program that upgrades C/C++ AFP2PDF transform to AFP2PDF plus.Upgrade.jar
performs these steps to upgrade from AFP2PDF transform to AFP2PDF Plus:
-
Backs up executable modules in C/C++ AFP2PDF transform:
-
Creates a native backup folder in the C/C++ AFP2PDF install directory. If the
native_backup\
folder exists, the backup folder name appends “-1”, that is,native_backup-1\
. The maximal iteration of appending is 9 times of ”-1”. -
Moves all existing license\folder and java_api\folder in C/C++ install directory to the backup folder.
-
Moves all AFP2PDF* and split_afp2pdf* to the backup directory.
-
-
Copies AFP2PDF plus modules, documents, server configuration file and property files to the C/C++ AFP2PDF install directory:
-
Copies AFP2PDF or AFP2PDF.exe to the C/C++ AFP2PDF install directory.
-
Copies *. jar files to the C/C++ AFP2PDF install directory.
-
Copies LICENSE/* to the C/C++ AFP2PDF install directory.
-
Copies *.sh or *.bat to the C/C++ AFP2PDF install directory.
-
Copies *.properties to the C/C++ AFP2PDF install directory.
-
Copies Server.cfg to the C/C++ AFP2PDF install directory.
-
Copies AFP2PDF_Plus_UG.pdf to the C/C++AFP2PDF install directory.
-
Copies a2pxopts.cfg to the C/C++ AFP2PDF install directory.
-
Copies a2pclient.cfg to the C/C++AFP2PDF install directory.
-
- Usage
- The jar file
Upgrade.jar
must be in the AFP2PDF plus directory. From the AFP2PDF plus directory, run the command:java –jar Upgrade.jar <C/C++ afp2pdf install directory>. If no parameter is given, this message is displayed: Upgrade the C/C++ AFP2PDF transform to Java transform (AFP2PDF Plus).Important: You need to run the jar fileUpgrade.jar
in the AFP2PDF Plus installed directory.
1.1.4.3.2 Installing AFP2PDF Plus Transform using the installer
setupafp2pdfPlus
, from the ISO file.
To run the transform, perform these steps:
- Use the following command:
java -jar setupafp2pdfPlus_1.xxx.xx.jar
, where xxx.xx is the transform version; for example,java -jar setupafp2pdfPlus_1.300.00.jar
for the 1300.00 AFP2PDF Plus version.Depending on the capabilities of your operating system, the AFP2PDF Plus transform opens either using a graphical user interface or a command line.- Note:
- To install the transform, you need Java 1.8 or later.
- Follow the installation steps and select either a new install or an upgrade.
- Note:
- If you select the Upgrade option, you install AFP2PDF Plus in a directory where a previous transform exists. During an upgrade, the configuration files are not modified, only the binaries are updated.
- You can install the AFP2PDF Plus service as an additional option. The AFP2PDF Plus
service is supported on Windows, AIX, and Linux operating systems. When installed,
this service starts the AFP2PDF server at boot time and can be managed with the standard
service tools and commands specific to each operating system. To install the service,
you must have root or administrator privileges.
- On Windows, the AFP2PDF Plus installer looks for a Java installation based on the PATH environment variable and uses that installation as a startup point for the service. The service continues to work as long as the path for the Java installation does not change.
- On Linux, the AFP2PDF Plus service requires the system service manager.
- When the installer upgrades a previous installation of AFP2PDF Plus where the service option was enabled, the new installation overrides the service. The old service might still be active until a machine reboot or a restart of the service manager.
split_afp2pdf
and archiveload_afp2pdf
programs are delivered as a part of the AFP2PDF Plus Transform. The operating system
prerequisites are the same as for the AFP2PDF Plus Transform.1.1.4.3.3 Configuring CMOD to work with AFP2PDF Plus Transform
-
IBM Content Manager OnDemand for Multiplatforms, V8.5: Web Enablement Kit Implementation Guide, SC19-2941
-
IBM Content Manager OnDemand for Multiplatforms & z/OS, V9.0 / V9.5: Web Enablement Kit Implementation Guide, SC19-3353
-
IBM Content Manager OnDemand for z/OS, V8.5: Web Enablement Kit Implementation Guide, SC19-1215
Specifically, you must modify the arswww.ini
file to call the AFP2PDF Plus Transform when processing an AFP file. At a minimum,
you must make these configuration changes:
- The
AFPViewing
option must bepdf
in the browser sections. - The
InstallDir
option in theafp2pdf
section must point to the directory on the server that contains the AFP2PDF Plus Transform client program.
1.1.4.3.4 Configuring IBM Content Navigator to work with AFP2PDF Plus Transform
- Open the web browser where the ICN plug-ins have been installed and log in to the ICN Administrator plug-in.
- To configure the installation directory:
- On the left-hand side of the browser screen, select Settings.
- In the main panel, select the Content Manager OnDemand tab.
- In the AFP2PDF installation directory field, enter the fully qualified path name for the directory where the AFP2PDF Plus transform is installed.
- Select Save and Close.
- To configure the viewer map:
- On the left-hand side of the browser screen, select Default Viewer Map.
- Make sure that the Repository Type is set to
Content Manager OnDemand
, Viewer is set toAFP2PDF Conversion
, and MIME Type is set toapplication/afp
.If any of the values are incorrect, refer to the Planning, installing, and configuring IBM Content Navigator manual for more details on how to change these values.
- Start the AFP2PDF Plus server.
1.1.4.4 Architecture and Configuration
1.1.4.4.1 Architecture
The transform is also designed to integrate easily with existing installations of
IBM Content Manager OnDemand by using the AFP2PDF Plus Transform client programs.
These client programs are C/C++ based and unique to each operating system supported
by Content Manager OnDemand. They mimic the previous AFP2PDF.exe
command syntax and are designed to less integrate into existing AFP2PDF installations
with minimal migration effort. OnDemand Web Enablement and AFP2PDF Plus shows details of the OnDemand Web Enablement and AFP2PDF Plus architecture.
OnDemand Web Enablement and AFP2PDF Plus
When the OnDemand Web Enablement Kit retrieves an AFP document, it issues a conversion
request via the AFP2PDF.exe
command-line interface. The AFP2PDF client passes the file to be converted, along
with the transform parameters to the AFP2PDF Plus Server (via a TCP/IP socket port),
where the file is converted. The AFP2PDF Plus Server writes the results directly back
to the specified file system directory. Input requests are handled on a First In First
Out (FIFO) basis. The maximum number of client requests handled at any given time
depends on the thread count setting in the Server.cfg
file.
1.1.4.4.2 Configuration
Server.cfg
, logging.properties
, and a2pclient.cfg
.\font\maps
in Windows is /font/maps
in a UNIX environment, or the input AFP file c:\documents\afpdon.afp
in Windows would be /documents/afpdoc.afp
in a UNIX environment.1.1.4.4.2.1 Configuring the Server.cfg
File
Server.cfg
file controls the overall server operation of the AFP2PDF Plus Transform.The Server.cfg
file consists of these entries:
- port:n
- Indicates the TCP/IP port number that the AFP2PDF Plus client and server use to communication
with one another. It comes preset to
6512
, which is currently unassigned in the Service Name and Transport Protocol Port Number Registry, which is administered by the Internet Assigned Numbers Authority (IANA). You can change this port number to one of your own choosing, but be careful that it does not conflict with any others in use in your organization. - socketTimeout:n
- Indicates that the sleep time on socket accept in milliseconds. It comes preset to
3000
(3 seconds). - stopFile:filename
- Specifies the fully qualified name of the stop server file indicator. As a part
of the server shutdown process,
StopAFP2PDFServer.bat
orStopAFP2PDFServer.sh
reads theServer.cfg
file for the stopFile name and creates it. When the stopFileTimeout expires, the server checks for the stop server file indicator and if present, stops the server. The default value isC:\temp\stopServer.txt
. - stopFileTimeout:n
- Indicates the sleep time between stopFile checks in milliseconds. It comes preset to
10000
(10 seconds). - threadCount:n
- Indicates the maximum number of AFP2PDF Plus server threads. It comes preset to
3
. It can be changed to improve performance, but should not exceed the number of processor cores in your server hardware. - transformHandler:classname
- Indicates the name of the AFP2PDF Plus Transform client handler class. This comes
preset to
com.ricoh.ips.transform.fromAFP.server.AFPPDFClienthandler
. The end user should not change this value. - initializationHandler:classname
- Indicates the name of the transform initialization class, called once the server starts
up. This comes preset to:
com.ricoh.ips.transform.fromAFP.server.AFP2PDFInitializationHandler
. The end user should not change this value.
1.1.4.4.2.2 Configuring the logging.properties
File
logging.properties
file specifies the type of error logging that is turned on for program debugging.
logging.properties
File Structure shows its structure, which is designed to allow more transforms to be added in the
future.
logging.properties
File Structure
The logging.properties
file configures the operation of the AFP2PDF Plus logging facility. It consists
of these three sections:
Global logging properties
- handlers=classname[,classname]
- Specifies the set of global logging handlers to be loaded upon startup. This comes
preset to
java.util.logging.FileHandler,java.util.logging.ConsoleHandler
. The end user should not change this value.
Package loggers
- com.ricoh.ips.transform=INFO | WARNING | SEVERE | ALL | OFF
- Specifies the logging level for the AFP2PDF Plus transform. The default is ALL. The end user should not change this value.
Console and file handlers
The console and file handlers operate independently of each other. For example, critical messages could go directly to the console, while other messages are written to the log file.
The console handler has these entries:
- java.util.logging.ConsoleHandler.level=INFO | WARNING | SEVERE | ALL | OFF
- Indicates the global logging message override setting. The default is SEVERE. Change this setting to the level of detail you want to appear on the console.
This value overrides the global logging level, whose default is INFO
- java.util.logging.ConsoleHandler.formatter=classname
- This comes preset to
java.util.logging.SimpleFormatter
. The end user should not change this value.
The file handler has these entries:
- java.util.logging.FileHandler.level=INFO | WARNING | SEVERE | ALL | OFF
- Indicates the global logging message override setting. The default is WARNING. Change this setting to the level of detail you want to appear in the log file.
This value overrides the global logging level, whose default is INFO
- java.util.logging.FileHandler.append=true | false
- Indicates whether trace information is appended to the end of the log file. The default is true.
- java.util.logging.FileHandler.formatter=classname
- This comes preset to
java.util.logging.SimpleFormatter
. The end user should not change this value. - java.util.logging.FileHandler.pattern=filename
- Specifies the fully qualified AFP2PDF Plus log file name. It comes preset to
./Afp2Pdf.log
. You can change this value. - java.util.logging.FileHandler.limit=n
- Indicates the maximum size of the log file. When the log file reaches this size, it wraps.
- java.util.logging.FileHandler.count=n
- Indicates the number of log files to cycle through by appending an integer to the base file name.
1.1.4.4.2.3 Configuring the a2pclient.cfg
File
a2pclient.cfg
specifies the port number for the client to server communication.The a2pclient.cfg
file consists of:
- port:n
- Specifies the TCP/IP port number that the client uses to communicate with the server.
The default port is 6512. This can be changed, but has to match the server port number in the
Server.cfg
file.
- Note:
- This client configuration file is optional.
1.1.4.4.3 AFP2PDF Plus Transform Security
1.1.4.4.3.1 Encryption
A PDF document can have these levels of password protection:
-
A document open password (also known as a user password) controls read access to the PDF document.
-
A permissions password (also known as an owner or master password) controls the use of restricted functions. See Parameters for information about using the –a and –e parameters to restrict display functions.
Note: Only Adobe software fully supports and respects these settings. Users of third-party PDF-enabled programs might be able to bypass some of these restrictions.
Both types of passwords can be set for a document. If the PDF document has both types of passwords, it can be opened with either password.
AFP2PDF Plus supports the following encryption algorithms:
- RC4 40-bit
- RC4-128-bit
- AES 128-bit
- AES 256-bit (Default)
RC4 (originally developed by RSA Security) is a symmetric stream cipher: the same
algorithm is used for both encryption and decryption, and the algorithm does not change
the length of the data. 40-bit and 128-bit refer to the length of the encryption
key. 40-bit keys in general are susceptible to brute force
attacks, which try all possible passwords. The design of the RC4 encryption algorithm
does have some vulnerabilities, which tend to make it less secure than AES; but both
RC4 40-bit and 128-bit are still used extensively around the world.
The Advanced Encryption Standard (AES) is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology (NIST). The algorithm described by AES is also a symmetric stream cipher. These ciphers each have a block size of 128 bits, but two different key lengths: 128 bit and 256 bit, hence the terms: AES 128-bit and AES 256-bit. AES is considered more secure because of weaknesses in RC4 keys.
1.1.4.4.3.2 Certificate Signatures
A digital signature can be used to authenticate the identity of a user and the document’s content. It stores information about the signer and the state of the document when it was signed. Any subsequent changes to a signed PDF file invalidate the signature.
The AFP2PDF Plus Transform requires a digital certificate in the PKCS#12 format. PKCS stands for Public Key Cryptography Standard, originally developed by RSA Security, Inc. PKCS#12 defines a file format used to store private keys with accompanying public key certificates, protected with a password-based symmetric key.
The AFP2PDF Plus Transform makes use of a digital certificate through the use of one
of these options in the a2pxopts.cfg
file:
-
Certificate requires both the name of the PKCS#12 file and its password to read the PKCS#12 file.
-
Certificate2 requires the name of the PKCS#12 file, but lets you point to a file that contains the needed password.
Once the file has been signed, the validity can be checked by opening the file with Adobe Acrobat.
1.1.4.5 Using the AFP2PDF Plus Transform
1.1.4.5.1 Starting and Stopping the AFP2PDF Plus Server on a Windows Server
StartAFP2PDFServer.bat
StopAFP2PDFServer.bat
They contain the necessary commands to properly start and stop the JAVA environment, along with the AFP2PDF Plus Server.
1.1.4.5.2 Starting and Stopping the AFP2PDF Plus Server on a UNIX Server
StartAFP2PDFServer.sh
StopAFP2PDFServer.sh
They contain the necessary commands to properly start and stop the JAVA environment, along with the AFP2PDF Plus Server.
1.1.4.5.3 AFP2PDF Plus Transform Command
afp2pdf
client command is plug-compatible with the previous afp2pdf
command (5876-W01). It transforms AFP files and resources into PDF files that you
can distribute over the Internet and view with a Web browser installed with the Adobe
Acrobat plug-in. If the plug-in is not installed on your Web browser, you can view
the PDF files with Adobe Acrobat Reader.1.1.4.5.3.1 Syntax
Only some of the parameters needed to control the AFP2PDF Plus Transform are available
with the client command. The other options are specified in an options file. By default,
this file is named a2pxopts.cfg
. It must reside in the same directory as the client program module. See AFP2PDF Plus Transform Options File for more information about the options file.
The syntax for the afp2pdf client command is:
afp2pdf [-host host] [-port port] [-a functions -e password] [-f fdeffile] [-g ( timestamp)] [-i optfile] [-l] [-m] [-n fontpath] [-o outputfile] [–p page_no] [-r resfile] [-s (timestamp)] [-t rotation] [-u password] [-v mapfile] inputfile
1.1.4.5.3.2 Parameters
- -hosthost
-
- Note:
- The use of -host is only allowed for backwards compatibility purposes. However, when used, the transform ignores the host value and replaces it with the localhost value.
- -port port
- Specifies the TCP/IP port number that the client uses to communicate with the server.
The default port is 6512. This can be changed, but has to match the server port number in the
Server.cfg
file.- Note:
- This parameter overrides any existing port:n specified in the optional
a2pclient.cfg
file.
- This parameter overrides any existing port:n specified in the optional
- -afunctions
- When used with an owner password (-epassword), specifies which PDF display functions are restricted. The codes for the display
functions, which can be used in any order, are:
- a
- Add or modify text annotations and interactive form fields.
- c
- Modify the document contents.
- d
- Assemble the document by using options such as inserting, rotating, or deleting pages. You can also create bookmarks or thumbnail images.
- i
- Fill in existing interactive form fields.
- p
- Print the document.
- q
- Print the document using low quality settings.
- s
- Copy text and graphics from the document.
- -epassword
- Specifies an alphanumeric password that gives permission to change document security
settings (also known as a master, owner, or document open password). For example, if the printing function in the PDF display is restricted
(
-a p
), you must supply a password to override the setting. - -ffdeffile
-
Specifies the fully qualified file name of the form definition resource that is used when transforming an AFP file. For example,
afp2pdf –f c:\mydirectory\myformdef.fde afpfile.afp
. - -g (timestamp)
- Sets a time stamp for when the document was created.
Note: This command can be specified, but is not supported in the current implementation. It exists for compatibility purposes only.
The format of the time stamp is:
YYYMMDDHHmmSSOHH'mm'
where:- YYYY is the year.
- MM is the month.
- DD is the day (01-31).
- HH is the hour (00-23).
- mm is the minute (00-59).
- SS is the second (00-59).
- O is the relationship of local time to Universal Time (UT), denoted by one of the characters
+
,-
, orZ
. - HH is the absolute value of the offset from UT in hours (00-23).
- mm is the absolute value of the offset from UT in minutes (00-59).
For example, December 23, 1998, at 7:52 PM, U.S. Pacific Standard Time, is represented by the string
19981223195200-08’08’
. - -ioptfile
- Specifies the location and name of the transform options file. The default is
a2pxopts.cfg
in the same directory as the program module. This file name must not use relative paths and must be fully qualified. See AFP2PDF Plus Transform Options File for more information about the options file. - -l
- Turns off all the generated error and informational console messages and sends them
to the
afp2web.err
log file.Note: This command can be specified, but it is not supported in the current implementation. It exists for compatibility purposes only.AFP2PDF Plus error logging is controlled by the
logging.properties
file. For information about this file, see Configuring thelogging.properties
File. - -m
- Generates a linearized PDF (or Fast Web View PDF) that reorganizes the data for more
efficient processing in a network environment. When specifying this parameter, large
PDF files are displayed without long download delays.
Note: To use this parameter, verify that the Web server or Web application sending the PDF data over the network provides the page-by-page or "byte-serving" downloading function.
- -nfontpath
- Specifies the location of the font definition files needed by the transform. The default
is the
\font
subdirectory of the directory where the transform modules are installed. - -ooutputfile
- Specifies the location and file name of the output PDF file. The default has the same
location and name as the input file, but with a file extension of
.pdf
. For example, when the PDF is generated from an AFP file namedafpdoc.afp
, a file namedafpdoc.pdf
is created. - –ppage_no
- Specifies the page number that is to be transformed in the AFP document.
- -rresfile
-
Specifies the fully qualified file name of the AFP resource group to be used when transforming the AFP file. For example,
afp2pdf –r c:\mydirectory\afpresfile.res afpfile.afp
. - -s (timestamp)
- Sets a time stamp for when the document was signed.
Note: This command can be specified, but is not supported in the current implementation. It exists for compatibility purposes only.
The format of the time stamp is:
YYYMMDDHHmmSSOHH'mm'
where:- YYYY is the year.
- MM is the month.
- DD is the day (01-31).
- HH is the hour (00-23).
- mm is the minute (00-59).
- SS is the second (00-59).
- O is the relationship of local time to Universal Time (UT), denoted by one of the characters +, -, or Z.
- HH is the absolute value of the offset from UT in hours (00-23).
- mm is the absolute value of the offset from UT in minutes (00-59).
For example, December 23, 1998, at 7:52 PM, U.S. Pacific Standard Time, is represented by the string
19981223195200-08’08’
. - -trotation
- Specifies the rotation value to use when transforming the file. Valid values are 0, 90, 180, and 270. The default is 0.
Some AFP files might have already been formatted with a rotated orientation. In this case, use this parameter to align the text in an upright position.
- Note:
- The transform applies the rotation to the entire page, including new images added with image mapping.
- -upassword
- Specifies an alphanumeric password that gives permission to open the PDF document (also known as a user or document open password).
- -vmapfile
- Specifies the location and the name of the image map configuration. This file name does not use relative paths and is fully qualified. See Parameters, for more information about the image map configuration file.
- inputfile
- Specifies the AFP input file that is to be transformed to PDF. This parameter is required.
1.1.4.5.3.3 Return Codes
The afp2pdf
client command returns one of these values:
- 0
- The transform completed successfully.
- Nonzero
- An error occurred.
1.1.4.5.4 AFP2PDF Plus Transform Options File
a2pxopts.cfg
. When running the transform function with the afp2pdf
client command-line program, the options file must reside in the same directory as
the program module.If running the transform function from the API, you can locate the options file in any directory on the system and you can use any file name. By setting the szOptionsFile option in the structure passed to the transform function, you can specify different option files for different types of documents.
- Note:
- The format of the
a2pxopts.cfg
file has changed. All available options are listed in the file, along with an explanation of each option. Uncomment the option you wish to use and add any required parameters. Where appropriate, you can manually specify multiple options of the same type. See Comparison with AFP2PDF Transform for a comparison list of AFP2PDF vs. AFP2PDF Plus transform options. - Parameters in the options file must be specified on separate lines and have the format
parameter=value
. For example:Disable_Compression=True Auto_Rotate=True
- Variable text should be enclosed in double quotes if the value contains blanks. For
example,
Subject=”Advance Function Presentation”
. - Parameters and values are not case-sensitive.
- Lines starting with a semicolon (;) or a pound (#) character are comments.
- Previous versions of the options file work with AFP2PDF Plus.
The AFP2PDF Plus Transform option parameters are:
- Append_PDF_File=file,n[,”[tm1 tm2 tm3 tm4 tm5 tm6]”]
- Indicates where or how the first page of the specified PDF file is appended to the
generated PDF file, where:
- file
- Specifies the name and location of the PDF file that is to be appended to the generated PDF file.
- n
- Specifies where the PDF is appended or if the PDF is used as a background form or
overlay. Values are:
- 0
- Appended to the beginning of the generated file.
- 1
- Appended to the end of the generated file.
- 2
- Used as a preprinted form on all pages of the generated file.
- 3
- Used as a preprinted form on even pages of the generated file.
- 4
- Used as a preprinted form on odd pages of the generated file.
- 5
- Used as a preprinted form on the first page of the generated file.
- 6
- Used as a preprinted form on all pages of the generated file, except for the first page.
- 7
- Used on top of the content from all pages of the generated file.
- 8
- Used on top of the content from the even pages of the generated file.
- 9
- Used on top of the content from the odd pages of the generated file.
- 10
- Used on top of the content from the first page of the generated file.
- 11
- Used on top of the content from all pages of the generated file, except for the first page.
- tm1 tm2 tm3 tm4 tm5 tm6
- Specifies the linear transformation matrix values that define the origin, rotation,
or scale of the appended PDF file. For example:
1 0 0 1 ox oy
- Specifies origin changes, where:
- ox
- Specifies the distance to translate the horizontal dimension.
- oy
- Specifies the distance to translate the vertical dimension.
sx 0 0 sy 0 0
- Specifies scaling changes, where:
- sx
- Specifies the scale factor (1.0-100%) for the horizontal direction.
- sy
- Specifies the scale factor (1.0-100%) for the vertical direction.
cos θ sin θ –sin θ cos θ 0 0
- Specifies rotation changes by an angle θ counterclockwise.
The origin for this operation is the bottom left-hand corner of the page.
For example,
Append_PDF_File=C:\term.pdf,0
appends thec:\term.pdf
file to the beginning of the generated PDF file, whileAppend_PDF_File=C:\term.pdf,1
appends thec:\term.pdf
file to the end of the generated PDF file. - Append_PDF_File2=file,n[,”[tm1 tm2 tm3 tm4 tm5 tm6]”]
- Indicates where or how the first page of the specified PDF file is appended to the generated PDF file. This parameter is the same as Append_PDF_File except that the origin is the top left-hand corner of the page
- Author=name
- Specifies 1–62 characters for the author name in the Info Dictionary of the output PDF file. This information is displayed to the user if the function is selected in Adobe Acrobat.
- Auto_Rotate=True | False
- Indicates whether the transform determines the orientation of each page and rotates it so that the text appears right-side up. By default, the AFP document is converted as is, so if the AFP page is formatted in a rotated orientation, the output PDF is also rotated. Setting this parameter to True is useful when pages in a document are rotated with different orientations.
- Auto_Rotate_CountBlanks=True | False
- Indicates whether blanks are counted in the auto-rotate algorithm. This parameter is used only with Auto_Rotate=True.
- Auto_Rotate_ParseOverlays=True | False
- Indicates whether page overlays are parsed in the auto-rotate algorithm. This parameter is used only with Auto_Rotate=True.
- Auto_Rotate_UseCharacterRotation=True | False
- Indicates whether character rotation is used along with the text orientation in the auto-rotate algorithm. This parameter is used only with Auto_Rotate=True.
- AVE_Control_File=file
- Specifies the fully qualified name of the AFP Visual Environment control file. This control file contains the names and parameters of the Pipeline Manager filter programs to be run on the AFP before conversion to PDF. See AFP2PDF Plus Transform Options File for information about their use.
- Bookmarks_Csname=font character set name[,font character set name...]
- Specifies that bookmarks are created from strings of text that use the font character sets listed.
- You can include multiple values, but they must be separated by commas. For example,
Bookmarks_Csname="C0FONT01","C0FONT02"
. - When Bookmarks_Csname is specified and a match is found, Show_Pageids is ignored.
- For more information on bookmarks, see the description of Disable_Bookmark_Generation.
- Cache_AFP_Overlay=True | False
- Indicates whether AFP overlays are saved during transformation. The default setting this parameter is True, which can result in a smaller PDF file and a faster conversion.
- Capture_Files_For_Debug=directory
- Specifies the directory where an archive file can be created that contains the captured
job information, such as:
- the input and the output files;
- the debugging log file specified in the AFP2PDF Plus Transform Options FileLogging parameter;
- the contents of the font directory;
- the AFP2PDF Plus options file;
- the contents of the directories specified in the AFP2PDF Plus Transform Options FilePfmPfb_Directory parameter, the AFP2PDF Plus Transform Options FileTrueType_Directory parameter, and the Locale_PathAFP2PDF Plus Transform Options File parameter;
- the files specified in the AFP2PDF Plus Transform Options FileAppend_PDF_File parameter, AFP2PDF Plus Transform Options FileAppend_PDF_File2 parameter, and the AFP2PDF Plus Transform Options FileConcatenate_PDF_File parameter;
- the imagemap file from the
-V
command line parameter or thesetImageMapFile
API;For more information on AFP2PDF Plus Transform APIs, see JAVA Application Programming Interfaces.
- the images specified in the
imagemap
file; - the external form definition from the
-f
command line parameter or thesetFormDef
API; - the external AFP resource group file from the
-r
command line parameter orA2PDocStart2
API; - any AFP resources used in the conversion of the input file.
- In the directory specified on this parameter, a new subdirectory is created for the job, that contains an archive file, both using a name derived from the input file name.
- Certificate=pkcs12_file,pkcs12_password[,cache_directory]
- Specifies the PKCS#12 certificate file used to sign the document, where:
- pkcs12_file
- Specifies the fully qualified path name of the PKCS#12 certificate file.
- pkcs12_password
- Specifies the password needed to read the PKCS#12 file.
- cache_directory
- Specifies the fully qualified path to a directory that is used for certificate storage. This is an optional value that can be used to improve the performance of the conversion.
- Certificate2=pkcs12_file,pwd_file[,cache_directory]
- Specifies the PKCS#12 certificate file used to sign the document.
- pkcs12_file
- Specifies the fully qualified path name of the PKCS#12 certificate file.
- pwd_file
- Specifies the fully qualified path name of a file that contains the password needed to read the PKCS#12 certificate file.
- cache_directory
- Specifies the fully qualified path to a directory that is used for certificate storage. This is an optional value that can be used to improve the performance of the conversion.
- Color=afpname,red,green,blue
- Specifies the RGB value color setting that overrides the display of named color values
in the AFP OCA (graphics objects), where:
- afpname
- Specifies one of the colors defined in AFP: BLUE, BROWN, CYAN, DARKBLUE, DARKCYAN, DARKGREEN, GREEN, GREY, HIGHLIGHT0, HIGHLIGHT1, HIGHLIGHT2, HIGHLIGHT3, MAGENTA, MUSTARD, ORANGE, PURPLE, RED, WHITE, YELLOW.
- red
- green
- blue
- Specifies the RGB value settings in the range of 0 to 255.
- For example, the AFP named color BLUE changes to a light gray color with these values: Color=BLUE, 220, 220, 220.
To override text (PTOCA) named color values, include Modify_Text_Colors. For more information, see the Modify_Text_Colors parameter.
To override bar code objects (BCOCA) named color values, include Modify_BCOCA_Colors. For more information, see the Modify_ BCOCA_Colors parameter.
- Concatenate_PDF_File=file
- Indicates that the entire specified PDF file is appended to the end of the generated
PDF file, where:
- file
- Specifies the name and location of the PDF file that is to be appended to the generated PDF file.
- Convert_Text_CMYK=True | False | Legacy
- Indicates whether all AFP text defined with the CMYK color space are converted to
the RGB color space in the PDF output, when the Preserve_CMYK parameter is not specified or set to false. Valid values for this parameter:
- False: for no conversion.
- True: converts color space values from CMYK to RGB.
- Legacy: uses the CMYK to RGB formula from the legacy AFP2PDF transform.
- See Preserve_CMYK for more information on the APF image conversion to RGB.
- Creator=name
- Specifies 0–62 characters for the creator name in the Info Dictionary of the output
PDF file. This information is displayed to the user if the
- Note:
- If the Creator parameter is included into the options file, but contains an empty value, then the Creator property in the output PDF file is also empty.
- If no Creator parameter is included into the options file, the output PDF document uses the name and the version of the AFP2PDF Plus transform, by default.
function is selected in Adobe Acrobat.
- DASH_PATTERN_style="[on off...] phase"
- When using GOCA lines, adjusts the dash pattern used. The values are:
- style
- Indicates the dash pattern that is used. The values are:
- DASH Specifies a dash pattern ( ------- ).
- DASHDOT Specifies a dash dot pattern ( -.-.-.-. ).
- DASHDOTDOT Specifies a dash dot dot pattern ( -..-..-.. ).
- DBLDOT Specifies a double dot pattern ( .. .. .. .. ).
- DOT Specifies a dot pattern ( ......... ).
- LONGDASH Specifies a long dash pattern ( _ _ _ _ ).
- SOLID Specifies a solid line pattern ( _____ ).
- on
- Specifies the dash pattern length in 1/72 units per inch.
- off
- Specifies the spacing length between the dash pattern.
- phase
- Specifies the distance to start in the dash pattern.
- The on and off values are optional. When used, the pair can be specified multiple times. For example:
- "[] 0" specifies a solid line.
- "[0.2 0.4] 0.4" specifies a dash pattern length of 0.2 units, a spacing length between the dash pattern of 0.4 units, and a start pattern at 0.4 units from the beginning of the pattern.
- "[0.5 1 0.5 2] 0" specifies a dash pattern length of 0.5 units, a spacing length between the dash pattern of 1 unit, a dash pattern length of 0.5 units, a spacing length between the dash pattern of 2 units, and a start pattern at the beginning of the pattern.
- DASH_PATTERN_ENDCAP=[BUTT, ROUND, SQUARE]
- Specifies the mode that is used at the end of the line patterns. The values are:
- BUTT
- Specifies a line that is squared off at the endpoints
- ROUND
- Specifies a line that has semicircular arcs (with a diameter equal to the line width) drawn around the endpoints. This is the default.
- SQUARE
- Specifies a line that is extended beyond the endpoints for half of the line width and then squared off.
- Default_Encryption_Permissions=[Acrobat_functions[ ,n [ ,encryption_functions ]]]
- Sets one or more default encryption permissions to be used when encrypting the PDF
output. The permission codes are:
- Acrobat_functions
-
- a
- Adding or changing annotations or form fields in Acrobat is denied.
- c
- Changing the document in Acrobat is denied.
- p
- Printing the document in Acrobat is denied.
- s
- Selecting and copy text and graphics in Acrobat is denied.
- n
- Specifies the level of encryption:
- 5
- RC4 128-bit encryption
- 6
- AES 128-bit encryption
- 7
- AES 256-bit encryption
- encryption_functions
- You can set one or more of these codes with 128-bit and 256-bit encryption:
- e
- Extracting text and graphics in Acrobat is denied.
- d
- Assembling text and graphics in Acrobat is denied.
- i
- Editing form fields in Acrobat is denied.
- q
- Printing high quality in Acrobat is denied.
- Note:
- Using RC4 128-bit encryption produces a file that can only be opened with Acrobat 5.0 or later.
- Using AES 128-bit encryption produces a file that can only be opened with Acrobat 7.0 or later.
- Using AES 256-bit encryption produces a file that can only be opened with Acrobat 10.0 or later.
- Codes 5, 6, and 7 can be used in combination with one of the a, c, p, or s codes to force 128-bit or 256-bit encryption without setting the i, e, d, or q codes.
- Default_Linearization=True | False
- Indicates whether the PDF output file is linearized (or enabled for Fast Web Viewing).
- See the -m parameter from Parameters for more information about linearization.
- Default_Owner_Password=password
- Specifies a default alphanumeric owner encryption password.
- Default_User_Password=password
- Specifies a default alphanumeric user encryption password.
- Disable_Bookmark_Generation=True | False
- Indicates whether PDF bookmarks are created. If page level indexing information is available in the input AFP document, PDF bookmarks are automatically generated. If you do not want bookmarks created, set this parameter to True.
- Disable_Compression=True | False
- Indicates whether the transform compresses PDF data. Setting this parameter to True to turn off compression can be useful when trying to determine problems that might exist in the PDF output file.
- Disable_TTF_subsetting=True | False
- Indicates whether TrueType fonts are subsetted.
- DotDensity,patternid,afpcolorname=red,green,blue
- Specifies the RGB value color setting for the AFP GOCA pattern that is used to fill
the interior of an area, where:
- patternid
- Specifies the GOCA pattern identifier, which defines various dot fill patterns of varying density. Pattern ID supports values from 1 to 8.
- afpcolorname
- Specifies one of the pattern foreground colors defined in AFP: BLACK, BLUE, BROWN, CYAN, DARKBLUE, DARKGREEN, DARKTURQUOISE, DEFAULT, GREEN, GREY, MAGENTA, MUSTARD, ORANGE, PURPLE, RED, WHITE, YELLOW.
- red
- Specifies the red value settings in the range of 0 to 255.
- green
- Specifies the green value settings in the range of 0 to 255.
- blue
- Specifies the blue value settings in the range of 0 to 255.
For example: DotDensity,5,GREY=220,220,220 specifies the RGB value of 220, 220, 220 for GOCA pattern 5 with a grey foreground color.
- Enable_Auto_Font_Image=True | False
- Indicates whether a font is mapped automatically. Setting this parameter to True causes the font to be converted to image data if the font resources exist and a font mapping does not exist.
- Enable_Auto_Image_Cache=True | False
- Indicates whether images are saved.
- FIPS_Mode=True | False
- Indicates whether the transform functions in an environment that is compliant with the Federal Information Processing Standard (FIPS). When set to True, encryption options and digital certificate options are disabled. For example, any request to add user passwords or owner passwords to the PDF file and any attempt to digitally sign a PDF file are ignored.
- Flate_Compression_Level=n
- Specifies the level of the Flate compression used in the PDF file, where n is 0 to 9. The larger the number the longer the conversion takes, but a smaller PDF file should be created. The default is 6.
- FontExt=*.extension
- Specifies the file extension that the transform uses to search for font resources
in resource directories. For example, if FontExt=*.EXT and the AFP document reference a font named C0FONTCS, the transform searches for
a file named C0FONTCS.EXT in the resource directories.
- Note:
- The extension value is case-sensitive on most operating systems.
- If you add this parameter to the configuration file, the transform starts the search with the customized extension. If not set or not found, AFP2PDF Plus searches for the file extension by default, using this search order: no extension, .OLN, .FONTOLN, .240, .FONT3820, .FONT38PP, .CFT, .CDP, .300, .FONT300.
- Font_Path=directory
- Specifies the base directory that the transform users to search for the font configuration
files. By default, this base directory is the
\font
subdirectory where the transform modules were installed. If the parameter is used when the font configuration files have been moved to a different location, the same directory structure of the font configuration files must be preserved. For example, if this entry was given:Font_Path=c:\fontfils
, the code page map files must reside in thec:\fontfils\maps
directory. - Generate_Type3=True | False
- Indicates whether Type 3 fonts are generated in the PDF output instead of the raster
images of font characters. Type 3 fonts are raster fonts that can be used to display
the exact AFP raster font characters. For more information, see AFP2PDF Plus Transform Options File.
- Note:
- If the AFP font was generated with the standard AFP Graphic Character Global Identifiers (GCGIDs), the Type 3 font uses the searchable text. You can use the text search function in a PDF to find any text that uses a Type 3 font and standard IDs.
- Global_Scale= n.n
- Applies a scaling factor to all the data on the page relative to the paper or media represented in the PDF. For example, a scale of 50.0 reduces the data in half relative to the page. The accepted values are between 0 and 6400. The default value is 100.0.
- GOCA_Color_Of_Medium=White | Transparent
- Specifies how to treat the color of medium color in AFP Graphics Object Content Architecture (GOCA). The options are White and Transparent. The default value is White.
- GOCA_Pattern=patternid,var1,var2
- Specifies the characteristics for the AFP Graphics Object Content Architecture (GOCA)
pattern that is used to fill the interior of an area, where:
- patternid
- Specifies the GOCA pattern identifier, which defines various line fill patterns. Pattern ID supports values from 9 to 14.
- var1
- Defines the line width.
- var2
- Defines the line spacing.
For example: GOCA_Pattern=9,10,250 specifies GOCA pattern 9 with a line width of 10 and a line spacing of 250.
- GOCA_Use_Circles=True | False
- Indicates whether the transform uses circles or dots for GOCA patterns 1 through 8,
instead of shaded areas. Setting this parameter to True increases the PDF file size.
- Note:
- DotDensity overrides the GOCA_Use_Circles setting, for the DotDensity specific pattern.
- Honor_Constant_Forms=True | False
- Indicates whether the transform generates extra pages created from the constant forms control function, which is a function in AFP architecture that produces one or more static overlays on a page without variable data from the print file.
- Honor_Medium_Orientation=True | False
- Indicates whether the transform applies the medium orientation specified in the form definition to created PDF pages.
- Horizontal_Offset=n
- Applies a horizontal offset to all the data on the page relative to the paper or media represented in the PDF. The units of this setting are 1440 units per inch.
- Ignore_Bar_Code_Object_Area_Size=True | False
- Indicates whether the object area size of a bar code object is ignored when checking
if the generated bar code symbol fits within a specified area. By default, the object
area size of the bar code is used to check if the generated bar code symbol is larger
than the specified area to fit.
- Note:
- Setting this parameter to True ignores the area size of the bar code object and increases the size of the bar code symbol.
- Ignore_Data_Font_Height=True | False
- Indicates whether the transform ignores the font height. By default, the transform
uses the font height value specified in the AFP data. If this parameter is set to
True, the font height setting in the AFP data is ignored and the font size specified in
the font configuration file
csdef.fnt
is used. - Ignore_PTOCA_STC=True | False
- Indicates whether the color specified with the Set Text Color (STC) control to display text in Presentation Text Object Content Architecture (PTOCA) is honored. When True is specified, the STC-specified color is ignored and black is used.
- ImageMapEntries_File=file,[True | False]
- Specifies the file that the transform uses to output the image information from the AFP file. The information in this file can then be modified and passed as input back into the transform function to change the conversion method for individual AFP images. The optional flag after the file specifies whether MD5 checksums for images are generated. The checksums can also be used as matching criteria with image mapping. See Mapping AFP images for more information about the mapping images.
- JPEG_Quality_Level=n
- Specifies the JPEG quality level, where 0.0 is the least quality and maximum compression and 1.0 is the best quality with no compression. The default is 0.95. This parameter only affects RGB images.
- Keywords=text
- Specifies 1 to 120 characters for the Keywords entry in the Info Dictionary of the output PDF file. This information is displayed to the user if the function is selected in Adobe Acrobat.
- Layer=n
-
- n
- Specifies the default layer where Shaded_Area is placed, in relation to the text of the enclosing AFP object. Values are:
-
- 1
- Bottom: Place Shaded_Area under the entire text.
- 2
- In-place: Place Shaded_Area in the same position as the image that it is replacing.
- 3
- Top: Place Shaded_Area on top of the entire text.
For more information about shaded areas, see AFP2PDF Plus Transform Options File.
- Legacy_Font_Map=True | False
- If you specify True, AFP2PDF Plus uses the font mapping process from the legacy AFP2PDF transform.
- Locale_Path=path
- Specifies the path location of the locale-specific information files needed during the transform process. Only use this parameter when converting multiple-byte language files (Traditional Chinese, Simplified Chinese, Japanese, Korean, or Unicode).
- Logging=[ True | Append | Jobname], logDir, lvl
- Specifies the type of tracing that is turned on for program debugging and where the log file is located.
- Parameter options:
- When set to True, logging traces on a document boundary and overwrites the trace data from a previous
document in the log file. For True and Append options, the log file name is
Afp2Pdf.log
. - When set to Append, the logging process appends data to the end of the log file.
- When set to Jobname, the logging process creates a new log file for each job processed. The new log file
name concatenates the input file name and
-Afp2Pdf.log
together. For example, for theTestLog.afp
input file, the resulting log file isTestLog.afp-Afp2Pdf.log
. - The logDir setting specifies the fully qualified directory where the log file is saved. The
log file name is
Afp2Pdf.log
. - The lvl setting specifies the log level: SEVERE, WARNING, or INFO. The default is WARNING. This command overrides the settings in the
logging.properties
file.
- When set to True, logging traces on a document boundary and overwrites the trace data from a previous
document in the log file. For True and Append options, the log file name is
- Modify_BCOCA_Colors=True | False
- Indicates whether RGB value color settings override the display of named color values in the AFP Bar code objects (BCOCA). For more information, see the Color parameter.
- Modify_Text_Colors=True | False
- Indicates whether RGB value color settings override the display of named color values in the AFP text (PTOCA). For more information, see the Color parameter.
- Output_IndexInfo=True | False
- Indicates whether the group level index information of the document is placed as a
bookmark with this format:
index attribute : index value
- Other applications processing the PDF file can search for the bookmark text.
- Note:
- If the parameter is set to True on password protected files, the bookmark text becomes encrypted.
- Output_IndexInfo2=True | False
- Indicates whether the group level index information of the document is placed as a
bookmark with this format:
index attribute index value1 index value2
- Other applications processing the PDF file can search for the bookmark text.
- Note:
- If the parameter is set to True on password protected files, the bookmark text becomes encrypted.
- This parameter overrides Output_IndexInfo, if both Output_IndexInfo and Output_IndexInfo2 are specified.
- OverlayExt=*.extension
- Specifies the file extension that the transform uses to search for overlay resources
in resource directories. For example, if OverlayExt=*.OVE and the AFP document reference an overlay named O1OVERLY, the transform searches
for a file named O1OVERLY.OVE in the resource directories.
- Note:
- The extension value is case-sensitive on most operating systems.
- If you add this parameter to the configuration file, the transform starts the search with the customized extension. If not set or not found, AFP2PDF Plus searches for the file extension by default, using this search order: no extension, .OVLY3820, .OVLY38PP, .OVL, .OLY.
- Page_rotation=0 | 90 | 180 | 270
- Specifies the rotation value to use when transforming the file. Some AFP files might have already been formatted with a rotated orientation. In this case, you must use this parameter to align the text in an upright position.
- Page_Count_Output=file
- Specifies the location of the output file that stores the number of pages transformed
for each job. The output file contains the values in a comma-separated value (CSV)
format. By default, the transformed page numbers are not saved.
Note: To create the output file, the transform must have write permissions on the specified location.
- PageSegExt=*.extension
- Specifies the file extension that the transform uses to search for page segment resources
in resource directories. For example, if PageSegExt=*.SEG and the AFP document reference a page segment named S1PAGSEG, the transform searches
for a file named S1PAGSEG.SEG in the resource directories.
- Note:
- The extension value is case-sensitive on most operating systems.
- If you add this parameter to the configuration file, the transform starts the search with the customized extension. If not set or not found, AFP2PDF Plus searches for the file extension by default, using this search order: no extension, .PSEG3820, .PSEG38PP, .PSG, .PSE.
- PDF/A=True | False [,conformance level]
- Indicates whether the transform generates output that conforms to the PDF/A-1b, PDF/A-2b,
or PDF/A-3b specification. The accepted values for the optional parameter [conformance level] are 1b, 2b, or 3b.
Note: The default conformance level is 1b when the value is missing or the value specified after True is not accepted.
When this parameter is set to True, these conditions must be met for the transform to generate output that conforms to the specification:
-
All fonts must be embedded for PDF/A-1b, PDF/A-2b, or PDF/A-3b compliance. See AFP2PDF Plus Transform Options File for information about embedding fonts; see AFP2PDF Plus Transform Options File
-
The PDF file must not contain any passwords or encryption; therefore, none of the functions described in AFP2PDF Plus Transform Options File should be used when this parameter is set.
-
- PER_JOB_IMAGE_CACHE=True | False
- Indicates if images are cached at job level. Depending on the job content, if this option is set to true, the performance is improved, but it also uses extra memory.
- PfmPfb_Directory=directory
- Specifies the directory that the transform uses to search for PFB and PFM (or AFM) files when mapping AFP fonts to Type1 fonts. If not set, the default directory is “Font_Path/Type1”.
- Preserve_CMYK=True | False | Legacy
- Indicates if all AFP images are converted to the RGB color space in the PDF output.
Valid values for this parameter:
- False: for no AFP image conversion.
- True: preserves AFP images defined with the CMYK color space so that they are not converted
to RGB.
This parameter uses a compression in the PDF that does not cause any loss of color quality.
- Legacy: uses the CMYK to RGB formula from the legacy AFP2PDF transform.
- Producer=name
- Specifies 0-62 characters for the producer name in the Info Dictionary of the output
PDF file. The information is displayed when the Properties function under File is selected in Adobe Acrobat.
- Note:
- If the Producer parameter is included into the options file, but contains an empty value, then the Producer property in the output PDF file is also empty.
- If no Producer parameter is included into the options file, the output PDF document uses the name and the version of the AFP2PDF Plus transform, by default.
- PTX_Drawrule_Use_Line=True | False
- Indicates whether the transform uses line operators in the generated output for PTX draw rules (DIR and DBR). When this parameter is set to False, the system uses rectangle operators. For some PDF viewers this can impact the way the thin lines are rendered at different zoom levels. The default value is False.
- Resize_Page_with_Offsets=True | False
- This parameter affects only the AFP page size values used for the output PDF page.
When set to True, any offsets specified in the form definition and in the Horizontal_Offset and Vertical_Offset parameters are added to the AFP page width and AFP page length.
The sizes of the output PDF page are determined by the values from the Medium overlay size, the AFP page size or the Static_Paper_Width and Static_Paper_Length parameters:
- The width of the output PDF page
- If the Static_Paper_Width parameter is specified, the output PDF page width is set by that value. If Static_Paper_Width is not specified, the larger of the Medium overlay width and AFP page width determines the output PDF page width.
- The length of the output PDF page
- If the Static_Paper_Length parameter is specified, the output PDF page length is set by that value. If Static_Paper_Length is not specified, the larger of the Medium overlay length and AFP page length determines the output PDF page length.
- Resource_Cache_Size=n
- Specifies the maximum number of non MODCA image resources and PDF resources each to be cached for the duration of a transform job. Values bellow 1 will result in constant cache misses that can negatively affect performance.
- ResourceDataPath=directory[;directory]
- Specifies the directories that the transform uses to search for AFP resources. You can specify multiple directories, but they must be separated with a semicolon (;). See AFP2PDF Plus Transform Options File for more information.
- Shade_RGB=red, green, blue
- Specifies the intensity of the red, green, and blue colors when generating the color
of shaded areas. The color values are in the range of 0.0 to 1.0, with 0.0 for black
and 1.0 for white. For example: Shade_RGB=0.5, 0.5, 0.5.
See AFP2PDF Plus Transform Options File for more information about shaded areas.
- Show_Outline=True | False
- Indicates whether the outline window is displayed. If an AFP document contains index data, the transform converts this index information into PDF outline and bookmark functions. If the output PDF file contains any bookmark information, the outline window is always displayed when viewed with Adobe Acrobat. This parameter can be set to False so the outline window is not displayed.
- Show_Pageids=True | False
- Indicates whether the Page Identifier values are displayed in the bookmark pane.
- Static_Paper_Length=n
- Overrides the AFP logical page size used by the default for the page or media dimensions represented in the PDF. Using 72 units per inch, you can set a specific paper length for the entire document.
- Static_Paper_Width=n
- Overrides the AFP logical page size used by the default for the page or media dimensions represented in the PDF. Using 72 units per inch, you can set a specific paper width for the entire document.
- Subject=text
- Specifies 1–62 characters for the Subject entry in the Info Dictionary of the output PDF file. This information is displayed to the user if the function is selected in Adobe Acrobat.
- Substitute_Default_Medium_Map_Allowed=True | False
- Allows the use of the default Medium Map when processing the AFP pages, if the Medium Map requested with the Invoke Medium Map (IMM) or Begin Page (BPG) structured field is not found in the active form definition.
- Title=text
- Specifies 1–62 characters for the Title entry in the Info Dictionary of the output PDF file. This information is displayed to the user if the function is selected in Adobe Acrobat.
- Transform_All_Subgroups=True | False
- Specifies whether the transform converts all of the subgroup formatting from the AFP form definition resource. By default, the transform processes the first subgroup.
- TrueType_Directory=directory
- Specifies the directory that the transform uses to search for TrueType font files when mapping AFP fonts to TrueType fonts. If not set, the default directory is "Font_Path/TrueType".
- Type3Glyph_Position_Legacy=True | False
- Specifies whether the glyph is positioned using the formula from the legacy AFP2PDF transform, when positioning Type3 font glyphs.
- When set to True, the transform uses the legacy glyph positioning formula.
- UDC_Range=low1,high1[,low2,high2][,low3,high3][,low4,high4]
- Specifies one to four section ranges that the transform can search when processing
user-defined characters for double-byte character set (DBCS) text. The ranges restrict
which DBCS sections are searched, which causes the transform to run more efficiently.
For example, if the user-defined characters are present in sections 129, 130, and 131, the parameter can specify these low and high sections: UDC_Range=129,131.
- Use_AFP_Metrics=n
-
Specifies a number that tells the transform to use the AFP font metrics instead of the mapped font metrics. For example, Use_AFP_Metrics=255. With this option the transform uses the AFP font metrics instead of the metrics of the mapped font.
See Using AFP metrics in mapped font for more information.
- Use_Default_Hash_Code=True | False
-
Specifies whether the transform uses a default method to determine if two page segments or overlays are identical, based on the resource name and content. The alternative is an optimized method where two overlays are equal when they have the same content, even if they are named differently. Setting this to True can improve performance in some cases.
- Vertical_Offset=n
- Applies a vertical offset to all the data on the page relative to the paper or media represented in the PDF. The units of this setting are in 1440 units per inch.
1.1.4.5.5 Working with AFP Visual Environment Control Files
AVE and AFP2PDF Plus shows how AVE works with the AFP2PDF Plus transform.
AVE and AFP2PDF Plus
The AFP Input Parser works with AVE to run AFP filter programs. AFP filter programs are small JAVA programs, designed to do one thing and do it well. AFP filter programs can perform such operations as redacting text, deleting blank pages, or creating watermarks. Everything works together in a stream environment for optimum performance. Data is streamed from one program to the next and then sent to the PDF Output Driver.
1.1.4.5.6 Running AFP2PDF Plus in a private Azure Cloud
Requirements to support a private cloud:
AFP2PDF Plus requires these packages to run properly on Unix-based Virtual Machines:
- SystemD Package
- The System D is necessary to be able to run AFP2PDF Plus as a service.
- Fontconfig package
- The Fontconfig package is a requirement for Java that is needed by AFP2PDF Plus for writing the PDF file.
To start automatically, the AFP2PDF Plus Server must be installed as a service.
1.1.4.6 Using the AFP2PDF Plus Utility Programs
1.1.4.6.1 split_afp2pdf Command
split_afp2pdf
command takes an indexed AFP print file, splits it up into separate statements, and
invokes the AFP2PDF Plus transform. The input AFP data must be divided into separate
page groups (statements) and contain AFP index values for each group. This type of
data is created either by the AFP Conversion and Indexing Facility (ACIF), the AFP
Visual Environment (AVE) or an equivalent function.The split_afp2pdf
command creates a separate PDF output file for each statement. The name of the output
file corresponds to at least a single associated index value. For example, if the
index field ACCOUNT is selected, each output file is named with the actual account ID (such as 123456.pdf
).
A Windows batch file, split_afp2pdf.bat
, or a UNIX executable script, split_afp2pdf
, invokes the JAVA application to split the AFP file. The command invokes the AFP2PDF
Plus Transform for each statement so the same configuration and setup for the transform
program applies. The split_afp2pdf
module must be placed in the same directory where the AFP2PDF Plus Transform files
are installed.
1.1.4.6.1.1 Syntax
split_afp2pdf [-c size] [-d outputpath] [-e password] [-f fdeffile] [-g codepageid][-h fontdefpath] [[-i index1 [-i2 index2 [-i# index# [... [-i10 index10]]]]]|[-ix hexindex1 [-ix2 hexindex2 [-ix# hexindex# [... [-ix10 hexindex10]]]]]] [-indexafporder] [-k path] [-legacylog ] [-m imagemapfile] [-n ] [-nt nThreads][-o optfile] [-p functions] [-r resfile] [-t rotation] [-temp] [-tle xmlfile] [-u password] inputfile
1.1.4.6.1.2 Parameters
- -csize
- Specifies the size in bytes of the cache used for resources. You can add k or m at the end of the specified value to indicate that kilobytes or megabytes are used instead. Values that are greater or equal to 2 gigabytes are not allowed. You can use only integer values. By default, the cache size is set to 0. Using a non-zero cache size might increase the resulting output size.
- -doutputpath
- Specifies the directory for all the output files. If this parameter is not specified, the output files are placed in the current directory.
- -epassword
- Specifies an alphanumeric password that gives permission to change document security
settings (also known as a master, owner, or permissions password). For example, if the printing function in the PDF display has been restricted
(
-p p
), you must supply a password to override the setting. The same password is applied for each output file. - -ffdeffile
- Specifies the fully qualified name of the form definition resource that is used on each statement when transforming the AFP document.
- -gcodepageid
- Specifies the code page global identifier
CPGID
to be used when interpreting the values for the -ix and -ix2 to -ix10 parameters. If no -ix type parameter is used, this parameter has no effect. The default value is 500. - -hfontdefpath
- Specifies the location of the font definition files when a code page ID is specified
with the -g parameter. Use the -h parameter if the font definition files are not located in the
\font
subdirectory of the current directory. - -iindex1
- Specifies the index field used for generating the output file names. For example,
if
-i RouteID
is specified and if a statement has a routing ID ofABC
, the output file nameABC
is generated.The user must know which index fields are available for the AFP data and must pick a field that is unique for each statement. For example, a single index field, such as ZIPCODE, might not be have unique values for all statements. In that case, statements with the same ZIP Code would have the same file name, causing an overwrite of the output file.
If this parameter is not given, the first index field found in the AFP data is used. If an index field name not available in the AFP data is given, no corresponding PDF file is generated.
- -i2index2 to -i10index10
- Specifies the index field number used for generating the output file names. The index
attributes range from 2 to 10.
- Note:
- You can specify either all -i or -ix type parameters.
- -ixhexindex1
- Specifies the index field used for generating the output file names. This parameter is the same as the -i parameter except that is used when the index name is specified in hexadecimal notation.
- -ix2hexindex2 to -ix10hexindex10
- Specifies the index field number used for generating the output file names. The index attributes range from 2 to 10.
- -indexafporder
- Organizes the entries from the index file in the same document order as the input AFP file.
- inputfile
- Specifies the AFP input file that is to be split and transformed to PDF. This parameter is required.
- -k path
- Specifies a fully qualified path of an alternate location for the log files generated during the transformation. Each corresponding PDF output file comes with an associated log file if errors occur during transformation. The log file name is output _PDF_file_ name.pdf.log. The corresponding log file will not be generated if there are errors generated on the associated statement.
- -legacylog
- Indicates that the log file format for
split_afp2pdf
andlegacy split_afp2pdf
should match. - -mimagemapfile
- Specifies the location and name of the image map configuration file that is used by the transform.
- -n
- Generates a different PDF output file name if the file already exists. For example,
the PDF output file
ABCD__2.pdf
is generated if the output file nameABCD.pdf
already exists. - -ntnThreads
- Specifies the number of threads for the transform to run. The default is 4.
- -ooptfile
- Specifies the location and name of the transform options file. The default is
a2pxopts.cfg
in the same directory as the program module. This file name must not use relative paths and must be fully qualified. See AFP2PDF Plus Transform Options File for more information about the options file. - -pfunctions
- When used with an owner password (-epassword), specifies which PDF display functions are restricted. The codes for the display
functions, which can be used in any order, are:
- a
- Add or modify text annotations and interactive form fields.
- c
- Modify the document contents.
- d
- Assemble the document by using options such as inserting, rotating, or deleting pages. You can also create bookmarks or thumbnail images.
- i
- Fill in existing interactive form fields.
- p
- Print the document.
- q
- Print the document using low quality settings.
- s
- Copy text and graphics from the document.
- -rresfile
-
Specifies the fully qualified file name of the AFP resource group to be used when transforming the AFP file. For example,
split_afp2pdf –r c:\mydirectory\afpresfile.res afpfile.afp
. - -trotation
- Specifies the rotation value to use when transforming the file. Valid values are 0, 90, 180, and 270. The default is 0.
Some AFP files might have already been formatted with a rotated orientation. In this case, use this parameter to align the text in an upright position.
- -temp
- Specifies the use of a temporary file to hold the statement for transformation. In certain circumstances, the input statement may exceed the available JAVA memory space. The temporary file is created in the directory specified by –d and is deleted when the transform is finished, whether successful or not. The number of concurrent temporary files created is twice the number of threads. Use this parameter only when Support tells you to do so.
- -tle xmlfile
- Specifies the location and name for the xml formatted output file that contains the
index information for each PDF file output from the split_afp2pdf program. If this
parameter is omitted, the output file will be:
\output_dir\input_afp_file_name.xml
. - -upassword
- Specifies an alphanumeric password that gives permission to open the PDF document (also known as a user or document open password).
1.1.4.6.1.3 The XML Format of Output TLE Information when -tle is Specified
<?xml version="1.0" encoding="UTF-8"?> <Split_afp2pdf_plus> <Document> <Filename> output pdf file name</Filename> <TLE> <Name>name of the TLE pair</Name> <Value>value of TLE pair</Value> </TLE> … more <TLE> </TLE> clauses … </Document> … more <Documents> </Document> clauses … </Split_afp2pdf_plus>
1.1.4.6.1.4 Return Codes
The split_afp2pdf
command returns one of these values:
- 0
- The transform completed successfully.
- Nonzero
- An error occurred.
split_afp2pdf
generates a summary log file containing the list of the output files generated. The
log file is placed either in the current directory or the directory specified by –d. This log also contains any warning messages created during the conversion. For
example, if an output file was overwritten, it would be indicated by a warning message
in this log file. The log also contains the total number of statements processed,
along with an overall error return code for the split_afp2pdf process.
Additionally, an individual error log is generated for each AFP statement that encounters an error during transform processing.
1.1.4.6.2 ArchiveLoad_afp2pdf Command
The Archiveload_afp2pdf
command is designed to convert AFP into PDF for efficient loading into Enterprise
Content Management (ECM) systems, including IBM's Content Manager OnDemand. It uses
page group level Tag Logical Elements (TLEs) to determine document boundaries and
then converts each document to PDF. The resulting documents are concatenated into
one PDF object. An output index file is created that contains the byte level offset
and extent, along with the TLE index information for each document in the PDF object.
This index file is available in an XML format or an IBM's CMOD Generic Indexer format.
A Windows batch file, Archiveload_afp2pdf.bat
, or a UNIX executable script, Archiveload_afp2pdf.sh
, invokes the JAVA application to create the PDF object and the output index file.
The command invokes the AFP2PDF Plus Transform for each statement so the same configuration
and setup for the transform program applies. The Archiveload_afp2pdf.bat
module must be placed in the same directory where the AFP2PDF Plus Transform files
are installed.
1.1.4.6.2.1 Syntax
archiveload_afp2pdf
[-d outDir path][-c opt file name]
[-I ind file name] [-o pdf file name][-t rotation [-r res file]
[-temp temp dir [-nt nThreads [-h font directory] [-utf8] [-z ind
config file [-log log file] [-odload] [afpfile]
1.1.4.6.2.2 Parameters
- -copt file name
- Specifies the fully qualified or relative path of the option file name for the afp2pdf transform. This parameter is optional.
- -doutDir path
- Specifies the directory for the output files. If this parameter is not specified, the output files are placed in the current directory. This parameter is optional.
- -hfont directory
- Specifies the location of the font directory. This parameter is optional.
- -log<path>
- Specifies the log file name. The default log file name is
<outDir path>/afp
with extension ".log" without ".afp". This parameter is optional. - -iind file name
- Specifies the index field used for generating the output file names. The default file
name is
<outDir path>/afp
with extension ".xml" without ".afp".AFP2PDF ignores this flag if -odload is specified. This parameter is optional.
- -nt<nThreads>
- Specifies the number of threads that run concurrently for the transform. The default number of threads is 8. This parameter is optional.
- -ooutput name
- Specifies the output archive data file name. The default file name is
<outDir path>/afp
with extension ".pdf" without ".afp". If -odload is specified, the default output archive data file name is <outDir path>/<afpfile>.ARD.out. This parameter is optional. - -rresfile
-
Specifies the fully qualified or relative path of the external resource file for the afp2pdf transform. This parameter is optional.
- -trotation
- Specifies the rotation value to use when transforming the file. Valid values are 0, 90, 180, and 270.
The default value is 0. This parameter is optional.
- -zind config file
- Specifies the fully qualified or relative path of the index manipulation configuration
file for the afp2pdf transform. This parameter is optional.
The configuration file contains this list:
- Index_AFPOrder
- Arranges the entries from the index file in the same document order as the input AFP file.
- Index_Remove, indexFieldName
- Index_Remove removes the index that matches the value specified as the indexFieldName.
- Index_Rename, indexFieldName, NewIndexFieldName
- Index_Rename renames the index that matches the value specified for indexFieldName to the value specified for NewIndexFieldName.
- -afpfile
- Specifies the fully qualified or relative path name of the input afp file. For example,
ArchiveLoad_afp2pdf -c opt.cfg -o sample_out.pdf -i sample_index.xml sample.afp
. This parameter is required. - -odload
- Generates -odload output files and formats. This parameter is optional. The default -odload output files are:
- output data file
<outDir path>/<afpfile>.ARD.out
- index file
<outDir path>/<afpfile>.ARD.ind
- trigger file
<outDir path>/<afpfile>.ARD
- output data file
- -temp
- Specifies the use of a temporary space for each statement instead of memory buffer.
It is used to avoid from using up memory heap for huge statement. If -temp is specified, the default temporary file is
<output directory>/temp
. This parameter is optional. - -utf8
- Use UTF-8(code page 1208) as the text encoding for output index file. The default is to use JVM "file.encoding" property. This parameter is optional.
1.1.4.7 Working with AFP Resources
- Page segments
- Overlays
- Form definitions
- Character set raster and outline font files.
The page segment, overlay, form definition and font file resources can be passed to the transform from these locations:
- Inline resource group
- The AFP resources needed by the AFP data file are combined into a logical resource library for the document. This resource group is contained in the AFP file along with the AFP document.
- External resource group
- The AFP resources needed by the AFP data file are combined into a logical resource
library for the document and are passed to the transform as a separate file.
The
afp2pdf
command specifies this resource file with the –r parameter. See Working with AFP Resources for more information. - Resource directories
- AFP resource files can be placed in specific directories that the transform program
searches for when converting a document. The user can specify multiple directories
and the directories are searched in the order that they are given.
By default, resources are placed in a
\resource
subdirectory where the transform code modules were installed. You can specify other directories with the ResourceDataPath parameter in the transform options file. See Working with AFP Resources for more information.
\font\maps
in Windows is /font/maps
in a UNIX environment, or the input AFP file c:\documents\afpdoc.afp
in Windows would be /documents/afpdoc.afp
in a UNIX environment.The AFP2PDF Plus Transform must process the AFP fonts your document was created with to fonts that can be displayed with Adobe Acrobat. This means either mapping an AFP font to one of the Base 14 fonts that Acrobat has internally defined or embedding a True Type or Adobe Type 1/Type 3 font. Font Processing Options shows the available ways to process fonts.
Font Processing Options
1.1.4.7.1 Files Supplied for Mapping Fonts
Font Files and Subdirectories lists the AFP2PDF Plus Transform font support files and the subdirectories of the installation directory in which they are installed.
Font Files and Subdirectories
File | File Name | Subdirectory | Description |
---|---|---|---|
Alias file | Alias.fnt |
\font |
Maps the font type families to PDF font name and optionally specifies the font metric file to use during the transform. |
Character set definition file | csdef.fnt |
\font |
Defines AFP character set attributes, such as point size. It also maps the font character set to the font global identifier. |
FND name defaults file | csdef.def |
\font |
Provides default processing for FND names. |
Coded font files | icoded.fnt , coded.fnt |
\font |
Specify which AFP code page and AFP font character set make up the coded font. |
Code page definition file | cpdef.fnt |
\font |
Maps each AFP code page to indicate which code page map file to use for the AFP2PDF Plus Transform. |
Code page map file | cpgid.cp |
\font\maps |
Defines character identifier mappings. It matches the AFP code page character identifiers and their hexadecimal code points with a corresponding character identifier and ASCII code point available in the PDF environment. The default is Code Page 1252. |
Font mapping file | afpfont.fnt |
\font |
Defines the fonts where the raster character images for the AFP font files are extracted and placed as images in the output PDF. |
Custom font metric files | Custom-metrics-xx.met |
\font\Type1 |
The default location for metric information for custom fonts (optional). |
1.1.4.7.1.1 Using the country.cfg
configuration file
afpfont.fnt
, alias.fnt
, cpdef.fnt
, csdef.fnt
, icoded.fnt
, and coded.fnt
font configuration files can be renamed using a different extension by adding a country.cfg
configuration file in the font directory. The font directory path is specified either
by the -n flag or the Font_path entry in the a2pxopts.cfg
file.The contents of the country.cfg
file is Country=zzz, where zzz can be one of these values: cht, chs, jpn, kor, fnt, matching the file name extension. The default extension is .fnt
.
1.1.4.7.1.2 Coded Font Files
coded.fnt
and icoded.fnt
) map AFP coded fonts to their AFP character sets and code pages. Coded Font Files
Coded Font File Name | Description |
---|---|
coded.fnt |
Contains user-defined coded fonts. This file is optional, but if it exists must be
placed in the \font subdirectory. |
icoded.fnt |
Contains standard definitions for approximately 2500 coded fonts supplied by Ricoh. |
If a coded.fnt
file exists in the \font
subdirectory, the AFP2PDF Plus Transform searches it first for the coded fonts used
in an AFP file. Example of a coded.fnt
File shows an example of the contents of the coded.fnt
file.
Example of a coded.fnt
File
X?A155N2=C?A155N1,T1DCDCFS X?AE10=C?S0AE10,T1S0AE10 X?GT10=C?D0GT10,T1D0BASE X?ST15=C?D0ST15,T1D0BASE X?A0770C=C?A07700,T1GI0361 X0T0550C=C0T05500,T1DCDCFS
Syntax rules
-
A question mark (?) can be used only as the wildcard character for the second character in the coded font name and the character set name. This allows all the character rotations of the coded fonts to be handled with one entry while searching.
Note: A sequential search is performed for the coded font, and the first match (including the wildcard character) is used. -
After the coded font name, the character set name must be listed first, followed by the code page name.
-
The character set and code page must be separated by a comma.
1.1.4.7.1.3 Character Set Definition File
csdef.fnt
) specifies the character set attributes and font global identifier of the font.
It is split into two sections, one for character sets (CHARSET) and one for font global identifiers (FGID).The CHARSET section lists each AFP font character set and its corresponding attributes.
CHARSET Section of the csdef.fnt
File shows an example of the CHARSET section in the csdef.fnt
file.
CHARSET Section of the csdef.fnt
File
[CHARSET] ;charset = fgid, height, width, strikeover, underline C?H200A0=2304,110,73,0,0 C?H200D0=2304,140,93,0,0 C?N200B0=2308,120,80,0,0 C?4200B0=416,120,144,0,0 C?D0GT15=230,80,96,0,0 C?A155A0=33207,110,73,0,0 C?A175A0=33227,110,73,0,0 C?T055D0=4407,140,93,0,0 C?T17500=4555,100,67,0,0 C?T17560=4555,60,40,0,0 DEFAULT=2308,80,0,0
Attribute Values for CHARSET describes the attributes and values for CHARSET.
Attribute Values for CHARSET
Attribute | Values | Shipped Default | Description |
---|---|---|---|
fgid | An FGID in one of these ranges:
|
2308 | A unique font global identifier (FGID) value, which identifies the type family, typeface, and sometimes the point size of the character set. This can be a predefined FGID or your own FGID. |
height | 1 to 990 | 80 | The vertical size of the character set (minimal baseline-to-baseline value) expressed
in tenths of a point. For example, a 9-point font would have a height of 90 . |
width | 0 to 99 (currently ignored) | 0 | The average horizontal size of the characters in 1440th of an inch. Currently, 0 is always used because an appropriate font width is based on the height of the font. |
strikeover | 1 = YES0 = NO | 0 | A font whose characters all have a line, parallel to the character baseline, placed over the middle of the character. |
underline | 1 = YES0 = NO | 0 | A font whose characters all have a line underneath the character. |
The FGID section lists each font global identifier and its corresponding attributes.
FGID Section of the csdef.fnt
File shows an example of the FGID section in the csdef.fnt
file.
FGID Section of the csdef.fnt
File
[FGID] ;fgid = familyname, style, weight, italic 230=Gothic, MODERN,MED,0 416=Courier,MODERN,MED,0 2304=Helvetica,SWISS,MED,0 2308=TimesNewRoman,ROMAN,MED,0 4407=SonoranSerif,ROMAN,MED,0 4555=SonoranSerif,ROMAN,BOLD,1 33207=SonoranSansSerif,SWISS,MED,1 33227=SonoranSansSerif,SWISS,BOLD,1
Attributes and Values for FGID describes the attributes and values for FGID.
Attributes and Values for FGID
Attribute | Values | Shipped Default | Description |
---|---|---|---|
familyname | Font family name reference | Times New Roman | An outline font family name or an AFP family name. Family nameis the same as type familyin AFP fonts and typeface namein the PDF environment. |
style | SWISS, ROMAN, SCRIPT, MODERN, DISPLAY | ROMAN | A type of character face or specific characteristics of the font.
|
weight | LIGHT, MED, BOLD | MED | The degree of boldness of a typeface caused by different thickness of the strokes that form a graphic character. |
italic | 1 = YES0 = NO | 0 | A font with right-slanting characters. |
Syntax rules
-
A comma must separate attributes
-
A question mark (?) can be used only as the wildcard character for the second character in the character set name. This allows all the character rotations of the coded fonts to be handled with one entry while searching.
Note: A sequential search is performed for the character set, and the first match (including the wildcard character) is used. -
The CHARSET section must come before the FGID section in the file.
-
In the CHARSET section of the file, only the fgid and height attributes are required.
-
In the FGID section of the file, only the familyname and style attributes are required.
-
If you define a default character set in the file, it must be the last entry in the CHARSET section.
-
If you add your own AFP font character set to the CHARSET section, you must assign it a font global identifier. If the new character set has the same familyname, style, weight, and italic attributes as an existing character set, you can use the same font global identifier; otherwise, you must add a unique font global identifier to the FGID section.
1.1.4.7.1.4 Code Page Definition File
cpdef.fnt
) maps the AFP code page name to its code page global identifier (CPGID) and, optionally,
to an encoding classification and an encoding type for Asian languages.The section header, CODEPG, is followed by a list of AFP code pages and their attributes. The first attribute in each line is the AFP code page global identifier that maps to a code page map file. The second attribute is the encoding classification that you decide is the best match for your AFP code page. The last line gives the default attribute values to be used when a default is required.
CODEPG Section of cpdef.fnt
File shows an example of the contents of the cpdef.fnt
file.
CODEPG Section of cpdef.fnt
File
[CODEPG] ;codepage = cpgid,wincp T1DCDCFS=1003,ANSI T1DEBASE=2058,ANSI T1D0BASE=2063,ANSI T1D0GP12=2085,ANSI T1GI0395=2079,ANSI T1GPI363=2066,SYMBOL T1V10037=37,ANSI T1V10273=273,ANSI T1000290=290,ANSI T1000310=310,ANSI T1000423=423,ANSI T1000905=905,ANSI DEFAULT=361,ANSI
Attribute Values for CODEPG
Attribute | Value | Shipped Default | Description |
---|---|---|---|
cpgid |
A CPGID in the range of 65280 to 65534 |
361 | An AFP-defined code page global identifier (CPGID), your own defined CPGID, or any other CPGID not already used in the file. |
wincp |
ANSI, SYMBOL, OEM, or NONSTD KYUJIS (Japanese) BIG5 (Traditional Chinese) GB (Simplified Chinese) KSC (Korean) IDENTITY (Unicode) |
ANSI | PDF encoding |
entype |
SBCS or DBCS |
SBCS or DBCS encoding type for Asian language definitions |
Syntax rules
-
A comma must separate attributes
-
Only the first attribute, cpgid, is required.
-
If you create your own code page, you must assign it a unique code page identifier. Leading zeros are not valid. (You can use a predefined code page global identifier, but only if the character-to-hexadecimal code mapping is the same for your code page.)
-
If you define a default code page in the file, it must be the last entry in the file.
1.1.4.7.1.5 Code Page File Map
\font\maps
subdirectory..cp
(for example, if 2063.cp
is the file name for the T1D0BASE code page map; its CPGID is 2063). Each file contains
the character identifiers (and associated EBCDIC hexadecimal code points) for an AFP
code page and maps them to character identifiers (and associated ASCII code points)
for an ANSI or SYMBOL PDF encoding.
Code page map file example shows an example of the contents of the code page map file 395.cp
for the T1000395 code page mapped to the ANSI encoding.
Code page map file example
;T1000395 to ANSI SP010000 40 SP010000 20 LA150000 42 LA150000 E2 LA170000 43 LA170000 E4 LA130000 44 LA130000 E0 SP180000 8B SP180000 BB SM560000 8C SM560000 89 SA000000 8D SP100000 2D LI510000 8E NOMATCH 00 LF570000 8F NOMATCH 00 SM190000 90 SM190000 B0 LJ010000 91 LJ010000 6A LF510000 A0 NOMATCH 00 ;;;;;;;; ; SD150000 5E ;;;;;;;; ; SD130000 60 ;;;;;;;; ; LT630000 FE /*
Syntax rules
-
Blanks must separate character identifiers.
-
NOMATCH means there is not a matching character in the output character set.
-
The NOMATCH hexadecimal code of 00 is mapped to the undefined code point. When a document contains a character that does not exist in the output character set, that character cannot be displayed. If the character has not been remapped in the code page map file or the alias file, the undefined code point character is displayed as a substitute.
-
The string of semicolons (
;;;;;;;;;
) means this line is ignored as a comment. It also indicates that the output code page contains a character that does not exist in the AFP code page. The code point for a character not found in the AFP code page can be used for replacing NOMATCH characters. -
-
If the input code point maps to
NOMATCH 00
, and the corresponding AFP code page and character set resources are available (inline or in a resource directory), the transform extracts the raster character from the AFP font and places it as an image in the PDF output.
-
1.1.4.7.1.6 Alias File
alias.fnt
) lists the font metric file name and the font family name aliases in the FONT section. Font family name aliases let you change all of the requested instances of
a font family name (as defined in the character set definition file) to another font
family name.alias.fnt
file is used with the AFP2PDF Transform to change all requests for the SonoranSerif
font to requests for the Times font, which is one of the base fonts available in the
Adobe Acrobat Viewer.Alias File Example
[FONT] ; ***** Requested font = font name,Font metric/AFM filename (or 'NULL' for not used); SonoranSerif=Times, NULL
Syntax rules
-
If multiple mappings are listed in the file for the same family name, only the first match is used.
-
The alias file is processed sequentially. Items within the alias file are not chained. That is, if
Century Schoolbook
is set equal toTimes
, andTimes
is set equal toTimes New Roman
, thenCentury Schoolbook
is not set equal toTimes New Roman
. -
Blanks in family names are treated as characters. For example,
New Century Schlbk
is not the same font asNewCenturySchlbk
.
1.1.4.7.1.7 Font Mapping File
afpfont.fnt
file specifies the AFP font objects (coded fonts, code pages, and character sets)
that should be explicitly processed by the AFP2PDF Plus Transform. AFP raster fonts
can be converted to Adobe Type 3 fonts and embedded in the output PDF file. AFP outline
fonts can be converted to Adobe Type 1 fonts and embedded in the output PDF file.Font Mapping File Example shows examples of specifying AFP font objects in this file. The ?
wildcard in the second character of character set names (C?RAST01
) and coded font names (X?RAST01
) can be used to handle efficiently different rotations of raster fonts. The *
wildcard used in typical file name matching can also be used to specify multiple
resource names (C?MRAS*
) with a single entry.
If the AFP font is a raster font, it is also possible to map it to a PDF environment
font but have the transform process only specific characters from the AFP font object.
For example, C?H00040 84,98,C1
uses AFP raster fonts for code points X’84’, x’98’, and X’C1’ and the information
defined in the font definition files for all
other characters.
AFP fonts consist of multiple parts, including the coded font, code page, and character set objects. All the necessary object names must be listed in the appropriate section. Otherwise, the AFP font is not explicitly processed.
Font Mapping File Example
[CODEDFNT] ;Coded Font ;X?*X?RAST01 [CODEPG] ;Code Page T1RAST01;T?* [CHARSET] ;Character Set C?RAST01 C?MRAS* C?H00040 84,98,C1 C?* 0
1.1.4.7.2 Process for Mapping Fonts
For example:
-
If you created a new coded font (or renamed one), you need to define the coded font in the coded font file (
icoded.fnt
orcoded.fnt
). -
If you created a new character set, you must define it in the character set definition file (
csdef.fnt
). -
If you created a new code page, you must define it in the code page definition file (
cpdef.fnt
). -
If you created a new code page or modified a code page by moving characters, you need to create a new code page map file (
cpgid.cp
).
If you modified an existing font component, for example, by deleting code points in the code page, you might not need to edit some of the definition files.
After determining which font files you need to modify, follow these steps to map your fonts:
- Gather the information needed to define the fonts in the font definition files.
- Make backup copies of any of these font definition files that you plan to modify:
afpfont.fnt
alias.fnt
coded.fnt
cpdef.fnt
csdef.fnt
- Assign substitutes for nonmatching characters in the code page map file.See Process for Mapping Fonts for information about code page map files.
- Edit the
cpdef.fnt
file and add your code page name, code page identifier, and the best matching encoding classification for the fonts you are using. - If you created a new character set, edit the
csdef.fnt
file.- Add your character set name in the CHARSET section.
- Specify the correct attributes for your font.
- Add the appropriate information in the FGID section of the file if you are naming a new font global identifier.
- If you have created a coded font, create or edit the
coded.fnt
file and add your coded font. - If you use AFP raster fonts, list the corresponding AFP coded fonts, code pages, and
character sets in the
afpfont.fnt
file.
1.1.4.7.3 Using Custom AFP Raster Font Files
csdef.fnt
and cpdef.fnt
are considered custom. If the custom font consists of raster characters, the AFP2PDF Plus Transform can be
configured to process the AFP font data for high fidelity output. To do this, the
transform first looks for the AFP coded fonts, code pages, and character sets entries
in the afpfont.fnt
file. If the font objects are listed, the transform looks for the necessary AFP font
resource data, using this search order:
- Resources that are inline with the document data
- The resource group file specified on the
afp2pdf
command - Resource directories
Processing AFP raster font characters provides higher-fidelity output than AFP printed output; but when these small raster characters are presented on the screen, the display may not be optimal because image data is dynamically scaled.
1.1.4.7.4 Using Custom Font Metric Files
Font metric files should be set up to use the default PDF WinANSI encoding (code page
1252). They cannot be used for double-byte text (Asian languages). The files are located
in the \font\Type1
subdirectory and are named Custom-Metrics-xx.met
, where xx is 1 to 99.
To configure the transform, specify the name of the font metric file as the first
parameter in the alias.fnt
file. Set the second parameter, specifying the Adobe Font Metric (AFM) file name,
to NULL.
Custom Font Metric files Defined in the alias.fnt
File shows an example of the alias.fnt
file with entries that define custom font metric files to the transform.
Custom Font Metric files Defined in the alias.fnt
File
;**** Requested font=font name,Font metric/AFM file name (or 'NULL' for not used) ***** Font1=Custom-Metrics-1,NULL Font2=Custom-Metrics-2,NULL ;******* End User-defined/Custom names *******
The format of custom font metric files follows the AFM specification, including these additional parameters that describe the font used for the display:
- Flags
- Specifies various characteristics of the font. Values for the Flags Parameter shows the allowable values.
Values for the Flags Parameter
Typeface Flag Courier—Serif Fixed Pitch 35
Courier Bold 262179
Courier Italic 99
Courier Bold Italic 262243
Helvetica (Arial)—Sans Serif Proportional 32
Helvetica Bold 262176
Helvetica Italic 96
Helvetica Bold Italic 262240
Sans Serif Fixed Pitch 33
Sans Serif Bold Fixed Pitch 262177
Sans Serif Italic Fixed Pitch 97
Sans Serif Bold Italic Fixed Pitch 262241
Times New Roman—Serif Proportional 34
Times New Roman Bold 262178
Times New Roman Italic 98
Times New Roman Bold Italic 262242
- StemV
- Specifies the width, measured in the x direction, of the dominant vertical stems of
characters in the font.
In practical terms, StemV represents the weight or boldness of the font. A typical medium weight font has a value of 80. For a light font, the value might be in the 65–70 range. A bold font might have a value of 120. In all cases, use these values as a starting point. Adjust the StemV value to get the output PDF file to look like the original printed output.
- ItalicAngle
- Specifies the angle, in degrees counterclockwise from the vertical, of the dominant vertical strokes of the font. Typically, this value is in the range of -10 to -15. Adjust as necessary to get the output PDF file to look like the original printed output.
Example of a Custom Font Metric File shows an example of a custom metric file called Custom-Metrics-1.met
.
Example of a Custom Font Metric File
FontName C0CUSTOM ; Description - 'Custom Font 1' Ascender 924 CapHeight 720 Descender -216 Flags 32 FontBBox -47 -204 996 924 ItalicAngle 0 StemV 90 XHeight 720 StartCharMetrics C 32 ; WX 240 ; N space ; C 33 ; WX 252 ; N exclam ; C 34 ; WX 408 ; N quotedbl ; C 35 ; WX 480 ; N numbersign ; C 36 ; WX 480 ; N dollar ; C 37 ; WX 756 ; N percent ; C 38 ; WX 552 ; N ampersand ; C 39 ; WX 240 ; N quotesingle ; . . . EndCharMetrics
1.1.4.7.5 Using AFP metrics in mapped font
You can map AFP fonts by specifying to use the AFP metrics instead of the metrics of the mapped font. Specify the Use_AFP_metrics config file entry together with changes in the fontfile. The value specified by the Use_AFP_metrics must be in the 0-255 range. The fontfile must contain an entry for each font that uses AFP Metrics where it is specified the name (Character Set name) and the same value in hexadecimal notation that was specified in the Use_AFP_metrics config file entry. For example, if Use_AFP_metrics=255, the afpfont file is C0RAST01 FF.
1.1.4.7.6 Mapping AFP Fonts to Type 1 Fonts
For the mapping to work, AFP2PDF Plus searches the PFB-Font-Name-1.pfb
Printer Binary file in the PFBPFMDirectory font directory. Also, a font matrix has
to exist in the PFBPFMDirectory. Therefore, in the figure below either PFB-Font-Name-1.pfm
or PFB-Font-Name-1.afm
must be specified. If the PFB-Font-Name-1.afm
files exists, the AFP2PDF Plus transform uses it, if it does not exist, it searches
for the PFB-Font-Name-1.pfm
file. You can specify the PFBPFMDirectory in the configuration file as stated in
the Mapping AFP Fonts to Type 1 Fonts. If the PFB-Font-Name-1.pfb
file is missing from the PFBPFMDirectory path, AFP2PDF Plus uses the default Times
New Roman font.
AFP font to Type 1 font mapping in the alias.fnt file
;**** Requested font=font name,Font metric/AFM file name (or 'NULL' for not used) ***** Font1=PFB-Font-Name-1,NULL Font2=PFB-Font-Name-2,NULL ;******* End User-defined/Custom names ******* EndCharMetrics
1.1.4.7.7 Mapping AFP Fonts to TrueType Fonts, OpenType Fonts, or TrueType Collection Fonts
The extension is specified to differentiate from a mapping to a Type1 font. The extensions
that can be used are .ttf
for mapping to TrueType fonts, .otf
for mapping to OpenType fonts, and .ttc
for mapping to TrueType font collections.
For the mapping to work, AFP2PDF Plus searches for the exact name specified in the
alias.fnt file, such as TrueTypeFont-Name.ttf
, OpenTypeFont-Name.otf
, or FontName@TrueTypeCollection-Name.ttc
, in the folder specified by the TrueType_Directory configuration file. You can specify
the TrueType_Directory in the configuration file as stated in the Mapping AFP Fonts to TrueType Fonts, OpenType Fonts, or TrueType Collection Fonts. If the specified font file is missing from the TrueType_Directory path or the font
name is not valid, AFP2PDF Plus uses the default Times New Roman font.
When mapping using TrueType font collections, you must specify what font from the collection is used. To specify the font, add the name or the 0-based index of the font, followed by the @ character, in front of the file name of the TrueType font collection.
Any code page defined in the Code Page Definition File (cpdef.fnt) can be used when mapping AFP Fonts to TrueType Fonts. Remember that the code page characters must be within the TrueType character set. To use custom character encoding, the mapping must be placed in the Code Page Definition File and the .ucm file must contain the code page identification in the name structure and must be in the Locale Directory.
AFP font to TrueType font mapping in the alias.fnt file
;**** Requested font=font name,Font metric/AFM file name (or 'NULL' for not used) ***** Font1=TrueTypeFont-Name.ttf,NULL Font2=OpenTypeFont-Name.otf,NULL Font3=FontName@TrueTypeCollection.ttc,NULL Font4=2@TrueTypeCollection.ttc,NULL ;******* End User-defined/Custom names ******* EndCharMetrics
1.1.4.7.8 Using AFP TrueType Fonts
TrueType font collections, linked TrueType fonts, and the Resource Access Table (RAT) are not supported.
- Note:
- Truetype fonts specified in the AFP file, but not embedded in it, are searched within the path specified in the TrueType_Directory configuration file entry. If this entry is missing, the default path is "Font_path/TrueType".
1.1.4.7.9 Using User Defined Characters within a DBCS Font
1.1.4.7.10 Character encoding
The locale
subdirectory is the default location for the ICU converter files (*.ucm
). You can use the Locale_Path parameter in the transform options file to define a
directory that is different from the default. For more information, see Character encoding.
The files must have a .ucm
extension and contain the code page ID. For example: ibm-500.ucm
.
The code page ID is the numerical CPGID defined in the cpdef.fnt
code page definition file. See Character encoding for more information.
1.1.4.8 Working with AFP Images
1.1.4.8.1 Adding background image from a PDF file
The two commands that you can use are described in AFP2PDF Plus Transform Options File:
-
Append_PDF_File
specifies the page origin as the bottom left-hand corner. -
Append_PDF_File2
specifies the page origin as the top left-hand corner.
You can specify various different options with this command, such as logo placement and scaling. Logo placement and scaling are controlled by specifying a set of linear transformation matrix values.
For more information on these values, see AFP2PDF Plus Transform Options File or the Adobe PDF Reference V1.7, Section 4.2.2, Common Transformations
, and Section 4.2.3 Transformation Matrices
.
1.1.4.8.2 Mapping AFP images
When an AFP file is converted, images are identified using parameters that specify the name, the position, and the size of each image. If an AFP page contains images, AFP2PDF Plus Transform creates image information entries in an output file. The output file entries can be copied into an image map configuration file to define and map a particular image.
Mapping images lets you handle AFP images in different ways during the conversion process, such as:
- Identifying individual images in your converted files.
- Removing all or some of the images from your converted output.
- Substituting all or some of the images with previously generated images in the PDF output with JPEG images.
- Substituting all or some of the images with a solid-colored rectangle. This is especially useful for improving the look of the shaded areas, defined as images in the AFP data stream.
- Adding an image, which is not part of the AFP data, to the PDF display that models the use of a preprinted form used during printing.
- Storing frequently used images to reduce the size of a PDF file.
The configuration file handles all the image conversion processing. For example, when the transform program is run against an AFP document and an image is encountered, the program searches for a matching image entry in the configuration file. If an entry that matches the name, position, size, or a combination of the three is defined, the information from the configuration file is used to convert the image. If a matching image entry in the configuration file contains an empty entry, the image is not generated in the PDF output file.
- Note:
- The file examples in this chapter are specified for the Windows environment. To use
these examples in a UNIX environment, use the UNIX file naming convention for any
file name. For example, the input AFP file
c:\documents\afpdoc.afp
in Windows is/documents/afpdoc.afp
in a UNIX environment.
1.1.4.8.2.1 Creating the image map configuration file
To map images for the AFP files perform these steps:
- Create an image map configuration file, transforming a sample AFP document that contains all documents with images.
- Identify the image entries and define them in the configuration file.
The image information in the configuration file is used to identify the images in the AFP file and map them during the conversion process.
Image information in the image map configuration file
<IMAGE position: (5.250in, 0.613in) size: (0.667in, 0.800in)> <IMAGE_END> <IMAGE position: (0.863in, 8.483in) size: (2.400in, 0.667in)> <IMAGE_END> <IMAGE position: (3.596in, 8.550in) size: (2.633in, 0.700in)> <IMAGE_END> <IMAGE name: (S1PSEG01) position (6.162in, 8.483in) size: (2.067in, 0.604in)> <IMAGE_END>
Each IMAGE tag along with its corresponding < IMAGE_END> tag defines a single image information entry in the configuration file. The first value for position and size is the horizontal dimension and the second value is the vertical dimension. The position measurements are for the upper, left-hand corner of the image relative to the upper, left-hand corner of the page.
By default, the image map configuration file is named imagemap.cfg
. AFP2PDF Plus Transform searches for the file in the same directory where the program
was installed. However, you can specify a different location and name for the file.
To create the image map configuration file:
- Create or modify the AFP2PDF Plus Transform options file with the entry ImageMapEntries_File=outputfile, where outputfile is the location and name of the file for the AFP file image information. For example,
ImageMapEntries_File=c:\imagemap.out
. Optionally, you can specify a true or false flag after the output file to specify whether you want MD5 checksums for images.See AFP2PDF Plus Transform Options File for more information on the AFP2PDF Plus Transform option parameters.
- Enter afp2pdfafpfile to run the AFP2PDF Plus Transform, where afpfile is the directory and file name of the AFP document to convert. For example,
afp2pdf c:\documents\afpdoc.afp
.The system generates an output file with image information for the AFP file and a PDF file for the AFP file For example:
c:\imagemap.out
c:\documents\afpdoc.pdf
- Copy the image lines in the output file (such as
imagemap.out
) into the image map configuration file (imagemap.cfg
by default). - Add image information between the starting <IMAGE> and ending <IMAGE_END> lines for the images you want to generate in the PDF output file.
The image information in the configuration file is used to identify the images in the AFP file. When AFP2PDF Plus Transform matches an image from the AFP file with the image information from the configuration file, it generates the image in the PDF output file.
1.1.4.8.2.2 Identifying AFP images in the image map configuration file
You can identify the images from the configuration file from the name, position, and size information, or you can work with the afp2pdf transform command to visually identify individual images. By creating empty image entries and then commenting out a single entry in the file, you can identify the image when you rerun the transform and the image is generated in the output PDF file.
To identify individual images:
- Define empty image information entries for all images in the image map configuration
file. Empty entries do not include any image information between the starting <IMAGE>
and ending <IMAGE_END> lines. For example:
<IMAGE position:(0.863in,8.483in) size:(2.400in,0.667in)><IMAGE_END>
- Comment out the first image in the configuration file by adding slashes before the
entry. For example:
//<IMAGE position:(5.250in,0.613in) size:(0.667in,0.800in)> //<IMAGE_END> <IMAGE position:(0.863in,8.483in) size:(2.400in,0.667in)> <IMAGE_END> <IMAGE position:(3.596in,8.550in) size:(2.633in,0.700in)> <IMAGE_END> <IMAGE name:(S1PSEG01) position:(6.162in,8.483in) size:(2.067in,0.604in)> <IMAGE_END>
- Run afp2pdf to generate a PDF file that contains only the image that you commented out. For example:
afp2pdf c:\documents\afpdoc.afp
, wherec:\documents\afpdoc.afp
is the directory and file name of the converted AFP document .
1.1.4.8.2.3 Removing images using the image map configuration file
The image information in the configuration file is used to identify the images in the AFP document and map them to the PDF file during the conversion process. If a matching image entry in the configuration file contains an empty entry, the image is not generated in the PDF output file. Empty entries do not include any image information between the starting <IMAGE> and ending <IMAGE_END> lines. For example:
Empty entries in the image map configuration file
<IMAGE position: (0.863in, 8.483in) size: (2.400in, 0.667in)><!-- IMAGE_END -->
To remove AFP file images, so they are not generated in the output PDF, create empty image entries in the configuration file.
To remove images:
- Define empty image information entries in the image map configuration file for the images you do not want to generate in the PDF file.
- Run afp2pdf on the AFP file (for example,
afp2pdf c:\documents\afpdoc.afp
). A PDF file is generated (such asc:\documents\afpdoc.pdf
) that does not contain any images with empty entries in the configuration file.
1.1.4.8.2.4 Substituting existing images with AFP2PDF Transform
During the AFP2PDF PlusTransform process, you can use the image map configuration file to substitute an AFP image with a previously generated image. The only type of image to substitute is the JPEG format.
To use an existing image, add IMAGE definition parameters between the starting <IMAGE> and ending <IMAGE_END> lines of an image information entry in the image map configuration file.
The image definition parameters are:
- XPos=n
- Defines the position of the left edge of the image relative to the left edge of the page. The units of this parameter are 1440 units per inch.
- YPos=n
- Defines the position of the top edge of the image relative to the top edge of the page. The units of this parameter are 1440 units per inch.
- XSize=n
- Defines the target area width to match the size of the image. The units of this parameter are 1440 units per inch.
- YSize=n
- Defines the target area height to match the size of the image. The units of this parameter are 1440 units per inch.
- Filename=path
- Specifies the fully qualified location and file name for the image.
- Note:
- When you use a blank within the value, the text is enclosed in double quotes.
- ColorFlag=0 | 1
- Specifies the type of image to substitute. This is an optional parameter; if specified, the value is set to 1.
Example of existing images in the image map configuration file
<IMAGE position:(5.250in, 0.613in) size:(0.667in, 0.800in)> IMAGE XPos=0 YPos=0 XSize=900 YSize=200 Filename="c:\images\logo1.jpg" <IMAGE_END> <IMAGE position:(0.863in, 8.483in) size:(2.400in, 0.667in)> IMAGE XPos=0 YPos=0 XSize=500 YSize=300 Filename="c:\images\logo2.jpg" <IMAGE_END> <IMAGE position:(3.596in, 8.550in) size:(2.633in, 0.700in)> <IMAGE_END> <IMAGE name:(S1PSEG01) position:(6.162in, 8.483in) size:(2.067in, 0.604in)> <IMAGE_END>
The first image is replaced by logo1.jpg
and the second image by logo2.jpg
.
You can define abbreviated versions of the image entries to expand the matching capabilities of incoming AFP images. This can simplify and reduce the number of image entries defined in the configuration file. To define abbreviated versions, edit the image entry and specify any combination of name, position, or size. If the incoming AFP image matches all the characteristics listed for the image entry, the image is substituted.
Example of abbreviated image entries in the image map configuration file
<!-- IMAGE name: (S1PSERG01)> IMAGE XPos=0 YPos=0 XSize=500 YSize=300 Filename="c:\images\logo2. jpg" <!-- IMAGE_END -->
When an incoming AFP image matches the name, the substituted image is added to the output.
1.1.4.8.2.5 Substituting AFP shaded images with colored areas
Many AFP documents contain page areas shaded with a gray box. The AFP data stream defines an image with pels laid out in a regular checker pattern to create a gray shading effect. When trying to display this type of image, however, it often becomes distorted because of the scale factor and resolution of the display hardware.
- Note:
- To avoid this problem, you can use a colored area instead of the shaded image.
To substitute a shaded image with a color area, add SHADED_AREA definition parameters between the starting <IMAGE>and ending <IMAGE_END> lines of an image information entry in the image map configuration file.
The shaded area definition parameters are:
- XPos=n
- Specifies the position, in inches, of the left edge of the colored area relative to
the left edge of the page.
This parameter is optional because the horizontal position of the incoming AFP image is used if XPos is not specified.
- YPos=n
- Specifies the position, in inches, of the top edge of the colored area relative to
the top edge of the page.
This parameter is optional because the vertical position of the incoming AFP image is used if YPos is not specified.
- XSize=n
- Specifies the colored area width, in inches.
This parameter is optional because the transform uses the width of the incoming AFP image if XSize is not specified.
- YSize=n
- Specifies the colored area height, in inches.
This parameter is optional because the transform uses the height of the incoming AFP image if YSize is not specified.
- Shade_R=n
- Shade_G=n
- Shade_B=n
- Specifies the intensity of the red, green, and blue colors used when generating the
color of the area. The values given must be in the range 0.0 to 1.0.
When all three values are set to 1.0, white is generated. When all three values are set to 0.0, black is generated.
- If these parameters are not specified, the transform uses the color described by the Shade_RGB parameter in the AFP2PDF Transform options file (see Substituting AFP shaded images with colored areas). By default, Shade_R=0.8, Shade_G=0.8, and Shade_B=0.8 creates a light gray color that is used if no other color specification is found.
- Radius=n
- Indicates the radius of all corners of the shaded area. If specified, the value applies to all four corners that become equally rounded.
- The radius value, measured in inches, should be smaller than half the width or half the height of the shaded area.
- You can specify individual values for each corner of the shaded area:
- Radius_UL=n
- Specifies the radius of the upper left corner. If specified, this value overrides the initial Radius=n value, for this corner only.
- Radius_UR=n
- Specifies the radius of the upper right corner. If specified, this value overrides the initial Radius=n value, for this corner only.
- Radius_LL=n
- Specifies the radius of the lower left corner. If specified, this value overrides the initial Radius=n value, for this corner only.
- Radius_LR=n
- Specifies the radius of the lower right corner. If specified, this value overrides the initial Radius=n value, for this corner only.
- Layer=n
- When the parameter is not specified, the transform uses the Layer parameter from the options file.
For more information on the Layer option parameter, see Substituting AFP shaded images with colored areas.
- Note:
- If no Layer specification is found, the default value is Layer=2.
Example of colored areas in the image map configuration file
<IMAGE position:(5.250in,0.613in) size:(0.667in,0.800in)> SHADED_AREA XPos=5.250 YPos=0.613 XSize=0.667 YSize=0.800 Shade_R=1.0 Shade_G=0.0 Shade_B=0.0 <IMAGE_END> <IMAGE position:(0.863in,8.483in) size:(2.400in,0.667in)> <IMAGE_END> <IMAGE position:(3.596in,8.550in) size:(2.633in,0.700in> <IMAGE_END> <IMAGE position:(6.162in,8.483in) size:(2.067in,0.604in)> <IMAGE_END>
When the first image is encountered, it is substituted with a red, 0.667 x 0.8 inch area positioned at 5.25 x 0.613 inches.
You can define abbreviated versions of the image entries to expand the matching capabilities of incoming AFP images. This can simplify and reduce the number of image entries defined in the configuration file.
To define abbreviated versions:
- Edit the image entry
- Specify any combination of name, position, and size.
If the incoming AFP image matches all the characteristics listed for the image entry, the shaded area is substituted.
Example of abbreviated colored areas in the image map configuration file
<IMAGE size:(0.667in,0.800in)> SHADED_AREA <IMAGE_END>
When an incoming AFP image matches the image size information, a colored area with the default color is created.
1.1.4.8.2.6 Adding an image to the transform output
The preprinted forms used during the printing process might have a company logo, a table, or grid that is filled in with the print data. To add an image which emulates the preprinted form to the transform output, AFP2PDF Transform performs these steps:
- Opens the specified image file, which currently can only have JPEG format.
- Processed the image data.
- Converts the data into an image for the PDF output.
The image can be in color and you can specify which pages it is included on.
To include an image that emulates a preprinted form, add one or more of these static image definitions between the starting <IMAGE> and ending <IMAGE_END> lines of the image information entry in the image map configuration file:
- STATICIMG_PAGE
- Same image is included on the pages with Type parameter.
- STATICIMG_FRONT
- Image on the front sheet of AFP data is placed on pages with Type parameter, in the output PDF.
- STATICIMG_BACK
- Image on the back sheet of AFP data is placed on pages with Type parameter, in the output PDF.
-
Note: If running the image map option from the afp2pdf_split tool, the STATICIMG_FRONT and STATICIMG_BACK refer to the front and back of the document that results after the splitting.
- STATIC_IMG
- Same image is included on the pages with the Type parameter. Using 72 units per inch, you can set specific image position and size dimensions.
These parameters are used with the static image definitions:
- XPos=n
- Specifies the left edge position of the image relative to the left edge of the page. The units of this parameter are 1440 units per inch.
- YPos=n
- Specifies the top edge position of the image relative to the top edge of the page. The units of this parameter are 1440 units per inch.
- XSize=n
- Specifies the target area width where the image is placed. The units of this parameter are 1440 units per inch.
- YSize=n
- Specifies the target area height where the image is placed. The units of this parameter are 1440 units per inch.
- Filename=path
- Specifies the fully qualified path and name for the image.
- Note:
- If a blank is used as part of the value, you must enclose the value in double quotes.
- Type=All | First | Second | All-First
- Specifies the sheets where the image is placed. The values include:
- All
- The image is included on all sheets.
- First (default value)
- The image is included on the first sheet only.
- Second
- The image is included on the second sheet only.
- All-First
- The image is included on all sheets except for the first page.
Usage note:
- If the Type parameter is not specified, the default value is First.
If the page orientation switches between portrait and landscape, these parameters can also be specified to control the position and sizing for the landscape orientation:
- XPos_Wide=n
- Specifies the position of the left edge of the image relative to the left edge of the page. The units of this parameter are 1440 units per inch.
- YPos_Wide=n
- Specifies the position of the top edge of the image relative to the top edge of the page. The units of this parameter are 1440 units per inch.
- XSize_Wide=n
- Specifies the width of the target area where the image is placed. The units of this parameter are 1440 units per inch.
- YSize_Wide=n
- Specifies the height of the target area where the image is placed. The units of this parameter are 1440 units per inch.
Example of an image added to PDF output
<IMAGE>STATICIMG_PAGE XPOS=0 YPOS=0 XSIZE=12240 YSIZE=15840 FILENAME ="C:\afp2pdf\form1.jpg" TYPE=ALL<IMAGE>
- Note:
- The image definitions do not include position or size information. You must manually add the starting and ending lines to the image map configuration file, in addition to the static image definitions.
- You can define multiple images on a page. You must verify that the size and position do not cause the images to overlap.
1.1.4.8.2.7 Adding a shaded area to the transform output
To include a shaded area, add one or more of the static shaded area definition parameters between the starting <IMAGE> and ending <IMAGE_END> lines of an image information entry in the image map configuration file:
- STATIC_SHADED_AREA
- Same shaded area is included on the pages with Type parameter.
- STATIC_SHADED_AREA_FRONT
- Shaded area on the front sheet of AFP data is placed on pages with Type parameter.
- STATIC_SHADED_AREA_BACK
- Shaded area on the back sheet of AFP data is placed on pages with Type parameter.
- Note:
- You can also use the list of SHADED_AREA definition parameters. For more information, see Adding a shaded area to the transform output .
- If running the image map option from the afp2pdf_split tool, the STATIC_SHADED_AREA_FRONT and STATIC_SHADED_AREA_BACK refer to the front and back of the document that results after the splitting.
1.1.4.8.2.8 Adding an image or shaded area to the transform output based on a TLE key-value pair
Adding images or shaded areas to the output PDF file based on a TLE key-value pair is similar to the method of adding images or shaded areas using the STATICIMG or STATIC_SHADED_AREA . The difference is the ability to specify a key-value pair used as a match mechanism. If the specified key-value pair is found in a TLE structure field on page level or on the group page level, the pair is added to the static image.
To include an image that emulates a preprinted form using the key-value pair condition, add one or more of these static image definitions between the starting <IMAGE>and ending <IMAGE_END> lines of the image information entry in the image map configuration file:
- INDEX_STATICIMG
- Same image is included on the pages with Type parameter, if the Index condition is met.
- You can use the same parameters as STATICIMG_PAGE. For more information, see Adding an image to the transform output.
- INDEX_FRONT_STATICIMG
- Image on the front sheet of AFP data is placed on pages with Type parameter, in the output PDF, if the Index condition is met.
- You can use same parameters as STATICIMG_FRONT. For more information, see Adding an image to the transform output.
- INDEX_BACK_STATICIMG
- Image on the back sheet of AFP data is placed on pages with Type parameter, in the output PDF, if the Index condition is met.
- You can use the same parameters as STATICIMG_BACK. For more information, see Adding an image to the transform output.
- INDEX_STATICSHDAREA
- Same shaded area is included on the pages with Type parameter, if the Index condition is met.
- You can use same parameters as STATIC_SHADED_AREA. For more information, see Adding an image to the transform output.
- INDEX_FRONT_STATICSHDAREA
- Shaded area on the front sheet of AFP data is placed on pages with Type parameter, in the output PDF, if the Index condition is met.
- You can use same parameters as STATIC_SHADED_AREA_FRONT. For more information, see Adding an image to the transform output.
- INDEX_BACK_STATICSHDAREA
- Shaded area on the back sheet of AFP data is placed on pages with Type parameter, in the output PDF, if the Index condition is met.
- You can use same parameters as STATIC_SHADED_AREA_BACK. For more information, see Adding an image to the transform output.
To use the index type definitions, add the following parameter:
- INDEX="key : value"
- Specifies the key-value pair to be matched. If the page contains a TLE with the same
key-value pair, the image or shaded area is added as specified by the Type parameter.
- Note:
- You can have several INDEX parameters. The condition is that all the key-values pairs from all the INDEX parameters are encountered in the TLE of the page.
If there is no match for the key-value pair index, a default value can be specified using the following entries:
- INDEX_DEFAULT_STATICIMG
- Same image is included on the pages with Type parameter, if no key-value pair match is found in this <IMAGE><IMAGE_END> group.
- You can use the same parameters as STATICIMG_PAGE.
- INDEX_DEFAULT_FRONT_STATICIMG
- Image on the front sheet of AFP data is placed on pages with Type parameter, in the output PDF if no key-value pair match is found in this <IMAGE><IMAGE_END> group.
- You can use same parameters as STATICIMG_FRONT.
- INDEX_DEFAULT_BACK_STATICIMG
- Image on the back sheet of AFP data is placed on pages with Type parameter, in the output PDF if no key-value pair match is found in this <IMAGE><IMAGE_END> group.
- You can use the same parameters as STATICIMG_BACK.
1.1.4.9 JAVA Application Programming Interfaces
The AFP2PDF Plus Transform APIs use data buffers for input and output to the transform. Many times the AFP data is retrieved from a database in a byte array in memory. The reference to this byte array is then passed directly to the conversion code for processing. The output from the API program also uses a reference to a byte array that contains the transformed output. Therefore, the overhead of opening, reading, and closing files is eliminated. Because system performance degrades if very large byte arrays are allocated, this approach assumes that the input and output byte arrays are not extremely large. The command–line interface, which uses files for input and output to the transform, might need to be used for very large byte arrays.
This chapter contains information about the programming functions available for the
AFP2PDF Plus Transform API. They mimic the previous AFP2PDF JAVA APIs and are designed
to integrate into existing AFP2PDF installations with minimal migration
effort. For more detailed information, see the Javadoc
information in the api
subdirectory.
- A2PBufferMessages (boolean flag)
- Sets up the logging to buffer messages, which are returned via A2PGetMessageBuffer() method. The default message level is WARNING.
- A2PBufferMessages (boolean flag, java.lang.String level)
- Sets up the logging to buffer messages, which are returned via A2PGetMessageBuffer() method.
- Message levels: INFO, WARNING, SEVERE, ALL.
- A2PDocEnd ()
- Terminates the processing for the last AFP document transform.
- A2PDocStart2 (byte[ ] ResIn, byte[ ] DataIn, java.lang.String InstallDir)
- Initializes the transform processing for an AFP document and resource group file contained in the input byte array. The resulting output PDF must be obtained through the method getPDFOutBuf().
- A2PDocStart2 (byte[ ] DataIn, java.lang.String InstallDir)
- Initializes the transform processing for an AFP document contained in the input byte array. The resulting output PDF must be obtained through the method getPDFOutBuf ().
- A2PDocStart2 (java.lang.String inAFPFileName, java.lang.String outPDFFileName, java.lang.String resGrpFileName)
- Initializes the transform processing for an AFP document, resource group and output
file using the input file names. The resulting output PDF is written to the output
PDF file name, whether supplied or derived. A call to the method getPDFOutBuf () l returns null, as the method is only useful when other A2PDocStart2 () methods are used.
Note: You must call setFormDef () and setOptionsFile () before calling A2PDocStart2 ().
- A2PGenerateMessages (boolean fGen)
- This command can be specified, but it is not supported in the current implementation. It exists for compatibility purposes only.
- A2PGetMessageBuffer ()
- Returns the string of log messages since the last XFormDoc.
- A2PGetPageCount ()
- Returns the number of pages in a specific AFP document. A value greater than 0 indicates a successful completion. A zero value or negative number indicates that an error has occurred.
- A2PXFormDoc ()
- Transforms the entire AFP document using the given values already set.
- A2PXFormPage ()
- Transforms one or more pages in an AFP document using the given values already set. The setPageNumber method must be used before this method to choose which page to convert. If the last page number is also set, the range of pages is transformed.
- A2PXFormPage (int n)
- Transforms a specific page in an AFP document using the given values already set.
- A2PXFormPage (int StartPageNumber, int EndPageNumber, boolean LastPage)
- Transforms a range of pages in an AFP document using the given values already set. Both StartPageNumber and EndPageNumber must be less than or equal to the number of pages in the document. StartPageNumber must be less than or equal to EndPageNumber.
- GetCachedFontMapInfo ()
- Returns a string of all font directories currently cached.
- getCodeVersion ()
- This command can be specified, but it is not supported in the current implementation. It exists for compatibility purposes only.
- getCreateTimeStamp ()
- This command can be specified, but it is not supported in the current implementation. It exists for compatibility purposes only.
- getFontPath ()
- Gets the value of the Font Path variable.
- getFormDef ()
- Gets the value of the FormDef variable and returns the fully qualified path name of the form definition file. This value can be null.
- getImageMapFile ()
- Retrieves the location of the name of the image map configuration file.
- getLastPageNumber ()
- Returns the last page number (1-based) to transform.
- getLinearize ()
- Returns True when the linearized option is set.
- For more information, see setLinearize (boolean n).
- getOptionsFile ()
- Gets the value of the OptionsFile variable and returns the fully qualified file path of the
a2pxopts.cfg
file. This value can be null. - getOwnerPassWord ()
- Gets the value of the OwnerPW variable and returns the owner password. This value can be null.
- getPageNumber ()
- Returns the first page number (1-based) to transform.
- getPDFOutBuf ()
- Gets the PDF output byte array. This value can be null if an error occurred or files were used for IO.
- getPermissions ()
- Gets the value of the Permissions variable.
- getRotation ()
- Gets the value of the Rotation variable and returns the rotation setting (0 | 90 | 180 | 270).
- getSignTimeStamp ()
- This command can be specified, but it is not supported in the current implementation. It exists for compatibility purposes only.
- getUserPassWord ()
- Gets the value of the UserPW variable and returns the user password. This value can be null.
- getXFormDocParameters ()
- Returns a list of parameters and their current values.
- InitFontMaps (String fontDir)
- Initializes the font mapping information for the input font directory. This command can be called multiple times and is used to eliminate the initial costs of reading font mapping data when the first file is transformed. The fontDir variable is the fully qualified path name of the font map directory.
- setCachingSize (int size)
- Sets the maximum size of the resource cache used across all transforms within a Java Virtual Machine.
- setCreateTimeStamp (java.lang.String n)
- This command can be specified, but it is not supported in the current implementation. It exists for compatibility purposes only.
- setFontPath ()
- Sets the value of the Font Path variable.
- setFormDef (java.lang.String n)
- Sets the fully qualified form definition file name.
Note: This value must be set before calling A2PDocStart2 ().
- setImageMapFile (java.lang.String n)
- Specifies the location and the name of the image map configuration file, different
from the default file,
imagemap.cfg
. The file name does not use relative paths and is fully qualified. See JAVA Application Programming Interfaces for more information about the image map configuration file. - setLastPageNumber (int n)
- Sets the last page number (1-based) to transform. If the first page number is not
already set using setPageNumber(), it is set here to the first page. For example, you can transform the first 33 pages
by just setting the last page number to
33
. - setLinearize (boolean n)
- Specifies that the output PDF file is created linearized (or optimized for Fast web viewing).
- setOptionsFile (java.lang.String n)
- Sets the OptionsFile variable.
Note: This value must be set before calling A2PDocStart2 ().
- setOwnerPassWord (java.lang.String n)
- Sets the OwnerPW variable.
- setPageNumber (int n)
- Sets the first page number (1-based) to transform.
- setPermissions (java.lang.String n)
- Sets the Permissions variable.
- setRotation (int n)
- Sets the Rotation variable (0 | 90 | 180 | 270).
- setSignTimeStamp (java.lang.String n)
- This command can be specified, but it is not supported in the current implementation. It exists for compatibility purposes only.
- setUserPassWord (java.lang.String n)
- Sets the UserPW variable.
- writeDataBuf (java.lang.String fName)
- Writes the current AFP data bytes to the output file name. This value cannot be null.
1.1.4.10 Comparison with AFP2PDF Transform
AFP2PDF and AFP2PDF Plus Options and Defaults compares the options that you can specify in the a2pxopts.cfg
for both products. Abbreviations in this table are:
- Y = Yes
- N = No
- D = Deprecated
- R= Reserved
- T= True
- F= False
AFP2PDF and AFP2PDF Plus Options and Defaults
Transform Options | AFP2PDF (5876–W01) | AFP2PDF Defaults | AFP2PDF Plus (5876-W11) | AFP2PDF Plus Defaults |
---|---|---|---|---|
Append_Log_to_PDF | Y | F | N | |
Append_PDF_File | Y | Y | ||
Append_PDF_File2 | N | Y | ||
Author | Y | Y | ||
Auto_Rotate | Y | F | Y | F |
Auto_Rotate_CountBlanks | N | Y | T | |
Auto_Rotate_ParseOverlays | N | Y | F | |
Auto_Rotate_UseCharacterRotation | N | Y | F | |
AVE_Control_File | N | Y | ||
Bilevel_Image_Cnvt | Y | F | N | |
Bypass_White_GOCA_Lines | Y | F | N | |
Cache_AFP_Overlay | Y | F | Y | T |
Cache_Font_Image | Y | T | N | |
Certificate | Y | Y | ||
Certificate2 | Y | Y | ||
Color | Y | Y | ||
Compression_Level | Y | N | ||
Convert_Text_CMYK | N | Y | F | |
Creator | Y | Y | ||
Dash_Pattern_Style | Y | Y | ||
Dash_Pattern_END_CAP | Y | Y | ||
Default_Encryption_Permissions | Y | Y | ||
Default_Linearization | Y | F | F | |
Default_Owner_Password | Y | Y | ||
Default_User_Password | Y | Y | ||
Disable_Bookmark_Generation | Y | F | Y | F |
Disable_Compression | Y | F | Y | F |
DotDensity | Y | Y | ||
Enable_Auto_Font_Image | Y | F | Y | F |
Enable_Auto_Image_Cache | Y | F | Y | T |
Enable_One_Pass | Y | F | N | |
Enable_UDC | Y | F | N | |
Expand_Index_Values | Y | F | N | |
FIPS_Mode | Y | F | Y | F |
Flate_Compression_Level | N | Y | 6 | |
FontExt | Y | Y | ||
Font_Image_Pad_Height | Y | N | ||
Font_Image_Pad_Width | Y | N | ||
Font_Path | Y | Y | ||
Force_GOCA_Area_Boundary | Y | F | N | |
Generate_Type3 | Y | F | Y | T |
Global_Scale | Y | 50 | Y | |
GOCA_Color_Of_Medium | N | Y | ||
GOCA_Pass1 | Y | N | ||
GOCA_Pass2 | Y | N | ||
GOCA_Pattern | Y | Y | ||
GOCA_Use_Circles | Y | F | Y | F |
Honor_Constant_Forms | Y | F | Y | F |
Honor_Medium_Orientation | N | Y | F | |
Honor_Media_Eject_Control | Y | F | N | |
Honor_Medium_Colored_Rules | Y | F | N | |
Horizontal_Offset | Y | Y | ||
Ignore_Bar_Code_Object_Area_Size | N | Y | F | |
Ignore_Data_Font_Height | Y | F | Y | F |
Ignore_PTOCA_STC | Y | F | Y | F |
Ignore_Transform_Warnings | Y | F | N | |
ImageMapEntries_File | Y | Y | ||
JPEG_Compress_CMYK_Image | Y | F | N | |
JPEG_Quality_Level | N | Y | 0.95 | |
Keywords | Y | Y | ||
Layer | N | Y | 2 | |
Launch_Preview | Y | F | N | |
Legacy_Font_Map | N | Y | F | |
Locale_Path | Y | Y | ||
Logging | Y | Y | ||
Max_Annotes | D | N | ||
Max_Fonts | D | N | ||
Max_Images | D | N | ||
Max_Leaves | D | N | ||
Max_Objects | D | N | ||
Max_Overlays | D | N | ||
Max_Pages | D | N | ||
Modify_Text_Colors | Y | F | Y | F |
Old_Static_Paper | Y | F | N | |
Output_IndexInfo | Y | F | Y | F |
Output_IndexInfo2 | N | Y | F | |
OverlayExt | Y | Y | ||
Page_Data_Order_Flags | Y | 0 | N | |
Page_Rotation | Y | 0 | Y | 0 |
PageSegExt | Y | Y | ||
PDF/A | Y | F | Y | F |
Pdf_extGState_Blend | Y | N | ||
PfmPfb_Directory | Y | Y | ||
Preserve_CMYK | Y | F | Y | F |
Printer_Resolution | Y | N | ||
PTX_Drawrule_Use_Line | N | Y | F | |
Resize_Page_with_Offsets | N | Y | F | |
Resource_Cache_Size | N | |||
ResourceDataPath | Y | Y | ||
Set_BC_GS1_128_Widths | Y | N | ||
Shade_RGB | Y | Y | ||
Show_Outline | Y | T | Y | T |
Show_Pageids | Y | T | Y | T |
Static_Paper_Center | Y | F | N | |
Static_Paper_Length | Y | Y | ||
Static_Paper_Width | Y | Y | ||
Subject | Y | Y | ||
Substitute_Default_Medium_Map_Allowed | N | Y | F | |
Title | Y | Y | ||
Trace_Level | Y | N | ||
Transform_All_Subgroups | Y | F | Y | F |
TrueType_Directory | Y | Y | ||
Type3Glyph_Position_Legacy | N | Y | F | |
UDC_File | R | Y | ||
UDC_Range | Y | N | ||
Use_AFP_Metrics | Y | F | Y | |
Use_ICU | Y | F | N | |
Use_Intermediate_File | Y | F | N | |
Use_Unicode | Y | F | N | |
Vertical_Offset | Y | Y |
1.2 AFPMerge
The following publications are available for AFPMerge. Click the PDF link after the book title to open a PDF version of the book in a new tab. Click the HTML link to open the HTML version of the book in this tab.
1.2.1 AFPMerge User’s Guide
1.2.1.1 Introduction
1.2.1.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
1.2.1.1.2 Cautions regarding this guide
- Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
1.2.1.1.3 Publications for the Web Enablement Solutions Suite
This section provides a list of all the publications for the Web Enablement Solutions Suite transforms.
Instruction manuals
- AFP2PDF PLUS
For information about AFP2PDF PLUS, see these documents:
- AFP2PDF Plus User Guide - 1.300
- AFP2PDF Plus Quick Start Guide
- AFP2PDF Plus Setup Guide 1.300
- AFP2PDF Plus Release Notes 1.300
- AFP2PDF Plus - Summary of Updates
- AFP Visual Environment
For information about AFP Visual Environment, see these documents:
- AFP Visual Environment User Guide 6.6
- AFP Visual Environment Release Notes 6.6
- AFP Visual Environment 6.6 Limitations List
- AFPMerge
For information about AFPMerge, see these documents:
- AFPMerge User Guide 3.3
- AFPMerge Release Notes 3.3
- AFPMerge 3.3 Limitations List
- Line2PDF Plus
For information about Line2PDF Plus, see these documents:
- Line2PDF Plus User’s Guide 1.3
- Line2PDF Release Notes 1.3
- Line2PDF Plus 1.3 Limitations List
- PCL2PDF
For information about PCL2PDF, see these documents:
- PCL2PDF 1.3 User’s Guide
- PCL2PDF 1.3 Release Notes
- PCL2PDF 1.3 Limitations List
- PS2PDF
For information about PS2PDF, see these documents:
- PS2PDF 1.3 User’s Guide
- PS2PDF 1.3 Release Notes
- PS2PDF 1.3 Limitations List
- Tiff2PDF
For information about Tiff2PDF, see these documents:
- Tiff2PDF Plus User Guide 1.3
- Tiff2PDF Plus Release Notes 1.3
- Tiff2PDF Plus 1.3 Limitations List
1.2.1.1.4 Symbols
- Important:
- This symbol indicates points to pay attention to when using the product. Be sure to read these explanations.
- Note:
- This symbol indicates helpful supplementary information that is not essential to completing a task.
Bold |
Bold type indicates the names of commands and parameters. |
Bold underline |
Underlined bold type indicates the default value. |
Italic | Italic type indicates variables that you must replace with your own information. |
Monospace |
Monospace type indicates computer input and output and file names. |
[] | Square brackets indicate that a value is optional. |
| | A vertical bar indicates a choice between values. |
... | An ellipsis indicates that a series can continue. |
1.2.1.1.5 Abbreviations
- AFP
- Advanced Function Presentation
- BDT
- Begin Document
- EDT
- End Document
- IMM
- Invoke Medium Map
- IPO
- Include Page Overlay
- MCF
- Map Coded Font
1.2.1.1.6 Trademarks
These terms are trademarks or registered trademarks of Ricoh Co., Ltd., in the United States, other countries, or both:
- RICOH InfoPrint Manager
These terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both:
- AIX
- DB2
- IBM
- POWER
- Print Services Facility
- WebSphere
- z/OS
Adobe and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.
Oracle, Java are registered trademarks of Oracle Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
1.2.1.2 Overview
1.2.1.2.1 Description
1.2.1.2.2 Limitations
-
IOCA FS45
-
Include Page Structured Field
-
Page Resources
-
The Resource Environment Group
-
TMap Data Resource
-
Cut Sheet Emulation
- Note:
-
External resources are treated as warnings and the code exits without generating a merged AFP file.
-
The output of AFPMerge is intended for print only. Using the output of AFPMerge with other programs is not supported.
-
AFPMerge has only been tested with RICOH InfoPrint Manager™ on AIX.
-
InfoPrint Manager needs to be configured to not use printer-resident fonts when using AFPMerge.
1.2.1.3 Working with AFPMerge
1.2.1.3.1 Creating the Output AFP Inline Resource Group
- The resource section (inline resource group) of each input AFP file is merged into a single inline resource group in the output AFP file.
- Each resource name in the input AFP file is mapped to a new name. However, several files may share resources.
- If two resources from different input AFP files have the same resource name, type, and length, an MD5 hash is compared. If the hash is the same, both files share the resource in the output AFP file. Otherwise, AFPMerge creates a new resource name and object.
1.2.1.3.2 Creating the Output AFP Print Document
- The print data section (BDT to EDT) is written from each input AFP file. If there are BDT/EDT pairs in the input file, they are written to the output AFP file.
- As the print data section of each input AFP file is processed, resource reference names are mapped to the new names generated in the first step. This includes structured fields such as Map Coded Font (MCF) and Include Page Overlay (IPO).
- Explicit Invoke Medium Map (IMM) structured fields are placed in the output stream in the absence of an IMM before the first page of the input AFP file.
- Warnings are generated for external resource references, missing inline resource groups, and other items.
The resulting file contains all resources across the list of input AFP files combined into a single resource group. Each print document section of each input AFP file is written to the output file with appropriately-updated resource reference names.
1.2.1.4 Command Line Syntax
1.2.1.4.1 Parameters
The syntax for the afpmerge client command is:
java –jar AfpMerge.jar
The AfpMerge includes a set of required parameters and a set of optional parameters.
The following parameters are required:
- -l
- The input files list. Specifies the fully qualified list of AFP files to be merged. A semi-colon ‘;’ in the first column means the entire line is a comment.
- -o
- The output file name. Denotes the fully-qualified name of the merged AFP file.
The following parameters are optional:
- noexit
- No exit on warnings. Use of this parameter instructs the program to not exit on warning
conditions. Warnings are still displayed to stderr.
- Note:
- Only an AFP expert should use this option.
- —tra(ce)
- Trace file. Create a trace file named AfpMerge.trace.0 and AfpMerge.trace.1. The program alternates between these two file names so that only two traces exist on the system at any time.
- -verb(ose)
- Verbose mode. Write merge information to stdout. Use this information to determine how internal resources were combined.
- -vers(ion)
- Version information. Display version information to stdout.
Example:
-l <input file list>, required -o <output file name>, required -noexit, do not exit on warnings, optional -tra(ce), create trace file (AfpMerge.trace.(0|1)), optional -verb(ose), verbose mode, optional -vers(ion), version information, optional
One of the following return codes displays upon completion:
- 0
- For no errors or warnings in the conversion.
- 4
- No warnings in the conversion.
- 8
- No errors in the conversion.
1.2.1.5 Configuration Options
The AFP files require extensive memory allocation on the system hosting the AFPMerge program. Exact memory allocation is dependent on the number and composition of the AFP merged files. For example, you can enter the following command:
java –Xmx1024M –Xms1024M –jar AfpMerg.jar –l in.txt –o out.afp
The –Xmxset maximum Java heap size and –Xmsset initial Java heap size parameters ensure that the Java virtual machine does not run out of memory. Both –Xmx and –Xms should be set to the same value.
The AFP resources in AFPMerge are in-line. If an AFP resource has an external reference, this is considered a warning condition.
1.2.1.6 Errors and Warnings
1.2.1.6.1 Errors
- Error: Invalid Inline Resource nnn at offset xxxx in file
yyy
. - A resource with the name nnn has been found at offset xxxx in file
yyy
that is invalid. If the user chooses to continue using the –noexit option, this resource becomes an external resource. - Error: Opening output file
xxx
- The output file specified by the –o parameter can not be opened. Some other program may have the file open.
- Error: No input file list –l, required
- No input list has been specified using the –l option. The –l option is a required option.
- Error: No output file –o, required
- No output file has been specified using the –o option. The –o option is a required option.
- Error in <file name> :
xyz
- Where
xyz
can be a AfpParserException or IOException text. - AfpParserExceptions are AFP syntax or semantic errors. The source AFP has been improperly generated.
- IOExceptions are system IO errors.
- Error: Unsupported MDR Repeating Group: name=<name>, FQN type=<type>, Object Classification=<class>
- An unsupported MDR has been encountered in the AFP file. This structured field is not currently supported by AfpMerge.
1.2.1.6.2 Warnings
- Warning: Missing Inline Resource Group for file
xxx
- A resource group is referenced in the AFP that is not in line in the file
xxx
. - Warning: Missing resource references (external) for file
xxx
: <list of resources names> - An external resource reference has been found. The resources with external references are names in the list.
1.3 AFP Visual Environment
The following publications are available for AFP Visual Environment. Click the PDF link after the book title to open a PDF version of the book in a new tab. Click the HTML link to open the HTML version of the book in this tab.
1.3.1 AFP Visual Environment User's Guide
1.3.1.1 Introduction
1.3.1.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
1.3.1.1.2 Cautions regarding this guide
- Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
1.3.1.1.3 Publications for the Web Enablement Solutions Suite
This section provides a list of all the publications for the Web Enablement Solutions Suite transforms.
Instruction manuals
- AFP2PDF PLUS
For information about AFP2PDF PLUS, see these documents:
- AFP2PDF Plus User Guide - 1.300
- AFP2PDF Plus Quick Start Guide
- AFP2PDF Plus Setup Guide 1.300
- AFP2PDF Plus Release Notes 1.300
- AFP2PDF Plus - Summary of Updates
- AFP Visual Environment
For information about AFP Visual Environment, see these documents:
- AFP Visual Environment User Guide 6.6
- AFP Visual Environment Release Notes 6.6
- AFP Visual Environment 6.6 Limitations List
- AFPMerge
For information about AFPMerge, see these documents:
- AFPMerge User Guide 3.3
- AFPMerge Release Notes 3.3
- AFPMerge 3.3 Limitations List
- Line2PDF Plus
For information about Line2PDF Plus, see these documents:
- Line2PDF Plus User’s Guide 1.3
- Line2PDF Release Notes 1.3
- Line2PDF Plus 1.3 Limitations List
- PCL2PDF
For information about PCL2PDF, see these documents:
- PCL2PDF 1.3 User’s Guide
- PCL2PDF 1.3 Release Notes
- PCL2PDF 1.3 Limitations List
- PS2PDF
For information about PS2PDF, see these documents:
- PS2PDF 1.3 User’s Guide
- PS2PDF 1.3 Release Notes
- PS2PDF 1.3 Limitations List
- Tiff2PDF
For information about Tiff2PDF, see these documents:
- Tiff2PDF Plus User Guide 1.3
- Tiff2PDF Plus Release Notes 1.3
- Tiff2PDF Plus 1.3 Limitations List
1.3.1.1.4 Symbols
- Important:
- This symbol indicates points to pay attention to when using the product. Be sure to read these explanations.
- Note:
- This symbol indicates helpful supplementary information that is not essential to completing a task.
Bold |
Bold type indicates the names of commands and parameters. |
Bold underline |
Underlined bold type indicates the default value. |
Italic | Italic type indicates variables that you must replace with your own information. |
Monospace |
Monospace type indicates computer input and output and file names. |
[] | Square brackets indicate that a value is optional. |
| | A vertical bar indicates a choice between values. |
... | An ellipsis indicates that a series can continue. |
1.3.1.1.5 Abbreviations
- AFP
- Advanced Function Presentation
- GIF
- Graphical Interchange Format
- IP
- Internet Protocol
- JPEG
- Joint Photographic Experts Group
- PCL
- Printer Command Language
- Portable Document Format
- TIFF
- Tagged Image File Format
1.3.1.1.6 Trademarks
These terms are trademarks or registered trademarks of Ricoh Co., Ltd., in the United States, other countries, or both:
- RICOH InfoPrint Manager
- RICOH ProcessDirector
These terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both:
- AIX
- IBM
- Print Services Facility
- z/OS
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Intelligent Mail is a registered trademark of the United States Postal Service.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Other company, product, or service names may be trademarks or service marks of others.
1.3.1.2 Overview
You can enhance AFP files that contain MO:DCA-P data in different ways depending on which components of AFP Visual Environment are installed:
- The AFP Indexer component lets you create AFP page groups and indexes, and define supplemental pages.
- The AFP Editor component lets you create bar codes and text, and hide areas that contain unwanted content, such as obsolete bar codes.
- The Whitespace Manager component lets you define available areas of white space in AFP files and then fill the white space with content, such as images and text, during the print production process.
- The Pipeline Manager component lets you configure and run a set of filters, in a specific order, to process large AFP files quickly and efficiently.
AFP Visual Environment can make the same enhancements on the same pages in all page groups in the AFP file. Page groups are AFP structures that organize AFP files into smaller, uniquely identifiable units. For example, if an AFP file contains several bank statements that all have the same format, each statement can be a page group.
1.3.1.2.1 System overview
- Preparation phase: During this phase, you use the AFP Visual Environment user interface to define the enhancements you want to make using a sample AFP file. A sample AFP file is a file that is representative of your production AFP files. The user interface can run on IBM AIX, Linux, or Microsoft Windows systems.
- Production phase: During this phase, you run an AFP Visual Environment command to enhance your production AFP files in the same way that you enhanced the sample AFP file. The AFP Visual Environment commands can run on IBM AIX, IBM z/OS, or Microsoft Windows systems.
The preparation and production phases can run on the same system, or you can complete the preparation phase on one system and then run the production phase on another system.
AFP Visual Environment system overview provides an overview of how AFP Visual Environment works.
AFP Visual Environment system overview
AFP Visual Environment system overview shows this process:
- The administrator selects a sample AFP file that is representative of the production
AFP files that you want to enhance. The AFP resources that the AFP file references
(fonts, page segments, and overlays) can be inline or in resource directories accessible
to the user interface.
If the sample file contains line-mode or mixed-mode data, the administrator must first use the AFP Conversion and Indexing Facility (ACIF) program to convert data to MO:DCA-P format.
- The AFP Visual Environment user interface displays the sample AFP file. The administrator uses the user interface to visually enhance the sample AFP file. For example, the administrator can select the text to use as a trigger to create page groups, select the text to index, draw a box to cover an unwanted bar code, and create a new bar code.
- AFP Visual Environment creates a control file that contains definitions for all the enhancements made to the sample AFP file.
As an option, AFP Visual Environment can create an AFP file that contains the data in the sample file and the enhancements defined in the control file. The administrator can print the enhanced sample AFP file on the production printer to check the enhancements before applying them to production AFP files.
- Optional: If the production system is different from the preparation system, the administrator sends a copy of the control file to the production system.
- On the production system, an AFP Visual Environment command makes the same enhancements to production AFP files using the definitions
in the control file. AFP resources can be inline or in resource directories accessible
to the command.
You can run the AFP Visual Environment command from the AIX, Windows, or z/OS UNIX command line, or you can use a script or procedure to call the command.
- An AFP Visual Environment command creates AFP files that contain the enhancements. You can print these files
using IBM Print Services Facility (PSF) for z/OS or RICOH InfoPrint Manager™ for AIX and Windows. Or, you can archive the AFP files using IBM Content Manager
OnDemand for Multiplatforms.
As an option, AFP Visual Environment can create these files:
- Document index file: This file contains the index tags (Tag Logical Element structured fields) in the output AFP file. This file is useful if you want to archive an AFP file and use the index file to retrieve information from it.
- Resource group file: This file contains all the AFP resources that the output AFP file references. This file is useful if any AFP resources are not inline and you want to view or print the file on another system that does not contain the AFP resources, or if you want to archive the AFP file so that you can print it later using the original resources.
1.3.1.2.2 System requirements
The AFP Visual Environment user interface can run on any of these operating systems with a browser:
- IBM AIX
- Linux
- Microsoft Windows
The AFP Visual Environment commands can run on any of these operating systems:
- IBM AIX
- IBM z/OS with UNIX System Services
- Microsoft Windows
- Linux
The AFP Visual Environment user interface and commands require Java Runtime Environment 1.8 or later with multi-language support.
AFP Visual Environment does not require any network communication. As a consequence, it works with computers configured with any network configuration (IPv4 or IPv6).
1.3.1.2.3 User interface
The AFP Visual Environment user interface can display one AFP file at a time–up to 1,000 pages. It can display:
- Bar Code Object Content Architecture (BCOCA) objects: POSTNET barcodes, Intelligent Mail barcodes (IMBs), Interleaved 2of5, Code39, and QR Code
- Graphics Object Content Architecture (GOCA) objects
- IM1 and Image Object Content Architecture (IOCA) images
- Index tags (also called Tag Logical Elements or TLEs)
- Joint Photographic Experts Group (JPEG) images
- Medium map information in a form definition, including overlay, page, and sheet information
- Overlays
- Page segments
- Text, including outline fonts, double-byte character set (DBCS) fonts, and text barcodes (text barcodes use barcode fonts)
The user interface cannot display all AFP objects, and it might not display some text and AFP objects with complete fidelity. These are the limitations:
- BCOCA objects: The user interface can only display POSTNET, IMB, Interleaved 2of5, Code39, and QR Code BCOCA objects. For other types of BCOCA objects, it displays a box the size of the barcode area. It cannot display any human-readable interpretation (HRI) text.
- Form definitions: The user interface does not apply any modifications in the form definition (such as print direction, page position, constant back, and N_UP page positioning).
- Images: Images might differ from printed images because of color differences and resolution differences between monitors and printers.
- Text: The user interface cannot display user-defined characters in DBCS fonts.
The user interface has several modes. The modes that are available depend on the components that are installed. Each mode lets you make different enhancements. The AFP Indexer mode lets you create page groups and index tags. The AFP Editor mode lets you create barcodes, text, and hidden areas. Whitespace Manager lets you create definitions for white space and fill the white space with content. .
This diagram shows the major parts of the user interface. It shows the title bar, menu bar, toolbar, AFP file, file-structure pane, index pane, and status bar.
- Title Bar
- Menu bar
- Tool bar
- AFP file
- Page pane
- Index pane
- Status bar
Title bar
The title bar at the top of the window identifies the mode that is active, the AFP file that is open, and any control file that is open.Menu bar and toolbar
The menu bar is below the title bar. Below the menu bar is the toolbar, which contains icons for the most common functions available on the menu bar. The options on the menu bar and toolbar vary depending on whether an AFP file is open. If an AFP file is not open, you see only the File and Help options. If an AFP file is open and a mode is selected, you see all options.The menu bar options, with the keyboard shortcuts and toolbar icons, are:
- File
- The File menu options are:
- Open AFP File (Ctrl+O)
- Opens the AFP file that you want to enhance. If another AFP file is already open, it is automatically closed. If you have not saved the control file for the AFP file that is already open, AFP Visual Environment lets you save the control file before it opens the new AFP file.
- Open Control File
- Opens an existing control file that you created previously.
- Reset
- Closes the current AFP file and clears cached resources from memory.
- Save Control File (Ctrl+S)
- Saves the control file for the open AFP file. A control file with the same name is overwritten.
- Save Control File As
- Saves the control file for the open AFP file. You can specify a name and directory for the control file.
- Save Plug-in Output
- Saves the sample AFP file with any enhancements that were made. After you save the file, you can print and verify the enhancements. You can specify a name and directory for the output file.
- Exit
- Stops AFP Visual Environment. If you have not saved the control file for the AFP file that is open, AFP Visual Environment lets you save it.
- View
- The View menu options are:
- File View
- Displays the inline resource group and the page structure of the AFP file in the left pane. You can double-click a page to display it.
- Index View
- Displays the index tags and the index tag values for the AFP file in the bottom pane. You can double-click a page group to display the first page of the page group.
- Rotate by 90o (Ctrl+R)
- Rotates the AFP file clockwise in increments of 90 degrees so that you can view it more easily.
- Units
- Displays measurement units in inches (USA default) or millimeters (non-USA default).
- Zoom
- Changes the display size of the AFP file by the percentage you select.
- Resources
- The Resources menu options are:
- Change Form Definition Settings
- Lets you specify whether form definitions and medium maps are used. If so, you can specify that an inline form definition is used or specify a directory for a default form definition.
- Enable Object Selection
- Indicates which objects you can select in the AFP file for the active mode. The selectable objects change when you select a new mode or open a new AFP file.
- Modify Default Encoding
- Lets you specify the default code page encoding.
- Modify Font Mapping
- Lets you modify defined character set, coded font, and code page font mappings.
- Show Page Information
- Shows the AFP resources that the page refers to and whether they were found and where.
- Specify Resource Directories
- Lets you specify the directories that contain AFP resources, such as fonts.
- Tools
- The Tools menu options vary depending on which mode is active. If no mode is active, no options
are available. Tool menu options shows the tools menu options that are available for each active mode.
Tool menu options
Mode Option Description AFP Editor Modify Definitions Lets you modify or delete definitions for barcodes, text, operators, hidden areas, and text masks.
Import user exit Lets you work with exits. AFP Indexer Header and Trailer Pages Lets you define the number of header and trailer pages and indicate whether the pages are contained in the final output. Index Tools Lets you create indexes from page group NOP records – on a page or outside a page, relocate page indexes to page groups, or edit existing indexes. Modify Definitions Lets you modify or delete definitions for page groups and index tags. Other Page Groups Lets you use existing page groups or create fixed-length page groups. Manage Comments Import user exit Lets you work with exits. Whitespace Manager Manage Campaigns Lets you assign image and text content to defined white space areas. Modify Definitions Lets you modify or delete definitions for white space areas. Pipeline Manager Manage Pipeline Lets you configure and run a set of filters, in a specific order, to quickly and efficiently process large AFP files.
- Mode
-
The Mode menu options vary depending on which components are installed.
You must select a mode before you can enhance an AFP file. The possible modes are:
- AFP Editor
- Creates definitions for barcodes, hidden areas, text strings, and text masks in the control file.
- AFP Indexer
- Creates definitions for page groups and index tags in the control file.
- Whitespace Manager
- Creates definitions for white space in the control file and fills the white space with content.
- Pipeline Manager
- Orders and runs a set of filters.
- Help
- The Help menu options are:
- AFP Editor Help
- In AFP Editor mode, opens the help topics for AFP Editor.
- AFP Indexer Help
- In AFP Indexer mode, opens the help topics for AFP Indexer.
- Whitespace Manager Help
- In Whitespace Manager mode, opens the help topics for Whitespace Manager.
- Pipeline Manager
- In Pipeline Manager mode, opens help topics for Pipeline Manager.
- Help Contents (F1)
- Opens the help topics for the AFP Visual Environment user interface.
- About
- Displays the version number of AFP Visual Environment and the contact information for obtaining assistance.
AFP file
The main pane displays the AFP file. You can see text (including text barcodes that use fonts), images, overlays, page segments, GOCA objects, and some types of BCOCA barcode objects.File-structure pane
The left pane displays the page structure of the AFP file. You can double-click a page to display it. If the AFP file contains page groups, this pane also shows the page groups. You might also see a resource group entry at the top of the page structure if the file contains inline AFP resources, such as overlays and page segments.Index pane
The Indexes tab in the bottom pane displays the index tags that exist in the AFP file and that are defined in the control file. For each index tag, you see the value of the index tag in each page group. You can double-click a page group to display the first page of the page group.Status bar
The status bar at the bottom of the window displays the number of the current page in the AFP file. If text is selected in the AFP file, it also displays the origin of the text block (X and Y position in inches or millimeters).1.3.1.2.4 Control files
When you enhance a sample AFP file, AFP Visual Environment creates a control file that contains information about how to make the enhancements. The enhancements are not made in the sample AFP file. To see the enhancements when you open the sample AFP file in a subsequent session, you must also open the control file that was used to enhance the sample file.
If you enhance the same sample AFP file (or a similar AFP file) again in another session, AFP Visual Environment can use the same control file. All enhancements for the sample AFP file must be defined in the same control file. AFP Visual Environment can add all enhancements to the same control file regardless of which component you use to make the enhancements.
Unless you change the name of the control file and its directory path, the control
file has the same name as the sample AFP file with a .ctl
extension and is saved in the same directory as the sample file. If you want to use
a different naming scheme, use one that associates the sample AFP file with its control
file.
1.3.1.2.5 Commands
The AFP Visual Environment commands are:
- EditAFP: This command applies the definitions in the control file to hide areas, create bar codes, and mask text in a production AFP file. It is available only if AFP Editor is installed.
- IndexAFP: This command applies the definitions in the control file to create page groups and index tags in a production AFP file. It is available only if AFP Indexer is installed. The IndexAFP command can also create a document index file and a resource group file.
- PluginMgr: This command can run EditAFP, IndexAFP, or both. It can apply all the definitions in the control file to a production AFP file. If you want to apply all the definitions in a control file to production AFP files, it is more efficient to use PluginMgr than to run the EditAFP and IndexAFP commands separately.
1.3.1.2.6 Document index files
The document index file lets you use an archival and retrieval application, such as IBM Content Manager on Demand, to retrieve a page group within the AFP file based on its index values.
For example, if the account number in an AFP file is indexed, or if the data encoded in the Intelligent Mail™ bar codes (IMBs) is indexed, you can use an account number or IMB data to retrieve the relevant page group.
1.3.1.2.7 AFP Indexer
AFP Indexer can also create a resource group file for each production AFP file. This file can help you print the archived AFP file at a later date with the original resources.
1.3.1.2.7.1 Page groups
You can create page groups in these ways:
- You can create page groups that have a fixed number of pages. For example, each page group can be three pages long. You can also exclude a certain number of pages at the beginning of the AFP file from the page groups. For example, if the AFP file contains two pages of introductory information, AFP Indexer can skip the first two pages and create the first page group on the third page.
- You can use triggers to define the page groups. A trigger is a block of text in the AFP file that occurs
in a consistent location on the first page of all page groups and can contain the
same text. As an option, you can also use triggers to indicate the end of page groups.
For example, the block of text that indicates the start of the page group might contain
the text
Page 1
and the block of text that indicates the end of the page group might contain the textPage 3
. If necessary, you can use multiple triggers to uniquely identify a new page group.
For example, a bank-statement application produces a file with hundreds of individual
customer statements. Each statement has the same general format, although statements
might vary in size or number of pages. Each statement contains the page number, an
account number, a date, and the customer's address. With AFP Indexer, you create triggers that define the group boundaries in the file; in this example,
one trigger could be the text Page 1
that occurs on the first page of every statement and another trigger could be the
text Account Summary
that occurs on the last page of every statement.
If you create page groups using triggers or if you create page groups of fixed length, all existing page groups and index tags that are defined in the AFP file itself are ignored.
You can define which pages are used for header and trailer pages. AFP Indexer creates the first page group after the defined number of header pages. It creates the final page group before the defined number of trailer pages.
To create more types of triggers than the control file allows, you can use exits. You can import a trigger exit to override the trigger definitions in the control file if you need more options for creating page group boundaries in the AFP file.
1.3.1.2.7.2 Supplemental pages
Pages in an AFP file that are defined as supplemental pages can be indexed.
You can define supplemental pages in these ways:
- You can use a trigger to define a block of text that occurs in a consistent location and uniquely identifies a page. If necessary, you can use multiple triggers to identify supplemental pages. For example, you can create a trigger for a block of text that exists on the third page in a page group. The supplemental page is removed from each page group.
- You can use an index tag to define a block of text that occurs in a consistent location on a page that is outside a page group. For example, you can create an index tag for a block of text that exists on the header and trailer pages. You can edit the text value to remove unwanted text such as blanks or special characters.
page definitionin AFP Indexer refers to a supplemental page definition, a page-level trigger, or a page-level index, not the AFP page definition resource.
For example, a bank-statement application produces a file with hundreds of individual customer statements. The file contains a header page before the customer statements and a trailer page at the end of the customer statements. Each statement ends with a page that separates it from the next statement. With AFP Indexer, you create triggers that define the header, trailer, and separator pages as supplemental pages with page definition names of Header, Trailer, and Separator. You can then create index tags on the supplemental pages.
1.3.1.2.7.3 Index tags
You can create index tags in these ways:
- You can create an index tag for a block of text that occurs in a consistent location on the same page in every page group, on a supplemental page, or on an individual page in a page group. For example, you can create an index tag for a block of text that contains a customer name or an account number. You can edit the text value to remove unwanted text such as blanks or special characters.
- You can create an index area that occurs in a consistent location on the same page in every page group or supplemental page and create index tags within the area. Within an index area, you can create index tags that span multiple text blocks on the same line. For example, if one text block on a line contains the first half of an account number and the next text block on the line contains the second half of the account number, you can concatenate the values in the text blocks and create one index tag that spans both blocks of text.
- You can create index tags for an address area in a page group or supplemental page. An address area is useful when you want to index mailing addresses that can contain a different number of lines in each page group. For example, the address in one page group might contain four lines, while the address in another page group might contain five lines. Within an address area, you can do specialized functions that apply to addresses. For example, you can create an index tag for a ZIP Code in the U.S. Postal Service format (nnnnn or nnnnn-nnnn) that occurs on the last line of the address area (or on a line relative to the last line).
- You can create index tags for No Operation (NOP) records. A NOP record causes an application to move to the next instruction for processing without taking any other action. NOP records can be found anywhere in a page group–either on a page in the page group or outside the logical AFP pages. NOP records in the AFP file are not viewable or printable, but you can create index tags from the data contained in them. You can create index tags for NOP records that are in the same position in all page groups, but outside a page, or you can create index tags for specific NOP records that are in any location in the page groups–on a page or outside a page.
For example, a bank-statement application produces a file with hundreds of individual customer statements. Each statement has the same general format, although statements might vary in size or number of pages. Each statement contains the page number, an account number, a date, and the customer's address. After you use AFP Indexer mode to create page groups and define supplemental pages, you create an index tag for the account number and another index tag for the date so that when you view production AFP files, you can display a particular statement based on the account number or date. You might create additional index tags for values in the customer address, such as the ZIP Code, so that you can sort statements (documents) according to ZIP Code before printing. You can use AFP Editor mode to create barcodes that contain the ZIP Code.
If the AFP file is already indexed, you can add new index tags to use with the existing page groups and supplemental pages. You can also update an existing control file for an AFP file and add new index tags to the existing ones.
To create more types of index tags than the control file allows, you can use exits. You can import a user exit to modify existing index tags or to add new index tags. For example, you might want to change the index tag of the customer number to include a 3-character prefix. Or, you might need custom code to create an index tag for information that is not at a consistent location in the page group.
1.3.1.2.7.4 Resource group files
The resource group file lets you print an AFP file on another system where the AFP resources are not present. It also lets you reprint an archived AFP file using the original resources.
For example, suppose that a page segment contains a company officer's signature and is included in the print data. When someone else replaces the officer, current print files must contain the new officer's signature, but archived files must contain the former officer's signature. To print an archived file with the original resources, you use the resource group file.
1.3.1.2.8 AFP Editor
Barcodes and text are used for a variety of purposes, such as routing and tracking mail and adding page numbers to documents. If you hide areas in documents, no one using an AFP viewer sees the data in the area, and the data does not print.AFP Editor also lets you mask sensitive text that you do not want anyone to view or print.
1.3.1.2.8.1 Barcodes
The way the elements of a barcode are arranged is called the barcode type, or symbology. AFP Editor lets you create these types of barcodes:
- Code 39 (3-of-9 Code): A low-density barcode that can encode uppercase letters, numbers, and some special characters.
- Data Matrix: A two-dimensional (2D) barcode that consists of black and white square modules arranged in either a square or rectangular pattern. This barcode uses the Solomon-Reed error correction algorithm (ECC 200) to ensure data reliability.
- Intelligent Mail: A 4-state barcode that the United States Postal Service (USPS) defines to track and direct mail. Intelligent Mail barcodes (IMBs) combine the capabilities of POSTNET and PLANET barcodes in one barcode.
- Interleaved 2-of-5: A high-density barcode that can encode numbers.
- Portable Data File 417 (PDF417): A two-dimensional (2D) barcode that consists of several rows, each of which is like a small linear barcode. The barcode can detect and correct errors.
- POSTal Numeric Encoding Technique (POSTNET): A barcode that the USPS defines to direct mail.
- Quick Response Code (QR Code): A two-dimensional (2D) matrix barcode that consists of black and white square modules arranged in a square pattern. The contents of this barcode can be decoded at high speed. This barcode uses the Solomon-Reed error correction algorithm (ECC 200) to ensure data reliability.
When you use the AFP Visual Environment user interface to create a barcode in a sample AFP file, you define a barcode area. You specify the origin of the area, the size (height and width) of the area, and
the location of the area in each page group. The area can be a horizontal rectangle
(for a picket-fence
barcode), a vertical rectangle (for a ladder
barcode), or a square.
You can place barcodes on:
- A specified page (for example, page 1) of each page group
- All pages in each page group
- The even pages in each page group (pages 2, 4, 6,...)
- The odd pages in each page group (pages 1, 3, 5,...)
In addition, you can specify one of these orientations for the barcode symbol within the barcode area: 0 degrees, 90 degrees, 180 degrees, or 270 degrees. Orientations of Barcodes shows the possible orientations for a barcode symbol with the human-readable interpretation (HRI) text placed above the barcode symbol:
Orientations of Barcodes
Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcodes
AFP Editor can create Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcode objects that follow the AFP Bar Code Content Object Architecture (BCOCA). AFP Editor uses the default values for all BCOCA properties and displays the default properties you can change. For information about the default values, see Bar Code Object Content Architecture Reference, S544-3766.
Barcode type | Properties |
Code 39 (3 of 9 Code) |
|
Data Matrix |
|
QR Code |
|
Interleaved 2-of-5 |
|
PDF417 |
|
POSTNET |
|
Specifying Module Width
As an advanced feature, you can specify the module width of a barcode that is written as a BCOCA object. By specifying this property, you can better control the size of the resulting barcode. The module width specifies the width in mils of the smallest defined barcode element (bar, space, or 2D module). For more information, see Bar Code Object Content Architecture Reference.
The default value is applied if you leave this option unchanged. The default values for each barcode are as follows:
Barcode type | Recommended module width default values (in mils) |
Code 39 (3 of 9 Code) | 13 |
Data Matrix | 21 |
QR Code | 12 |
Interleaved 2-of-5 | 13 |
PDF417 | 14 |
- Note:
- Valid module width values range between 7 and 254. Values outside this range are ignored.
- AFP Visual Environment does not verify whether the resulting barcode fits the defined object area.
- As specified in the BCOCA reference, the barcode types: POSTNET and Intelligent Mail Barcode have a fixed module width. You cannot specify a module width for them.
Specifying Barcode Data
You can specify this data to encode in the barcode symbol, in any combination, if the data is allowed in the barcode type:
- The value of one or more index tags. (For example, if the routing ZIP Code in an AFP file is an index tag, you can include the ZIP Code in the barcode data.) If the index tag value is different in every page group, the barcode data for the index tag is different in every page group.
- The value of one or more job properties (such as job number). The barcode data for a job property is the same in every page group.
- Text strings. The barcode data for a text string is the same in every page group.
- Human-readable interpretation (HRI).
- Code page encoding.
You can also adjust position values for the barcode, including changing the origin and size of the barcode area, selecting the orientation of the barcode symbol, and selecting which pages to place the barcode on.
Intelligent Mail bar codes
AFP Editor can create Intelligent Mail bar codes (IMBs) in one of these representations:
- BCOCA objects: Bar code objects follow the Bar Code Content Object Architecture (BCOCA). AFP Editor can create standard height IMB symbols.
- Text barcodes:AFP Editor uses the 300 dpi AFP IMB font (US23) that the USPS provides. This barcode font creates standard height IMB symbols.
In general, BCOCA objects are preferred to text barcodes. However, some older printers, such as IBM 3900 printers, cannot process BCOCA IMBs. To print on these printers, you must create text IMBs.
IMBs have two basic formats, depending on the length of the mailer ID assigned by the USPS. Fields in IMBs with a 9-digit mailer ID and a 6-digit serial number and Fields in IMBs with a 6-digit mailer ID and a 9-digit serial number show the formats of IMBs:
- In Fields in IMBs with a 9-digit mailer ID and a 6-digit serial number, the mailer ID contains 9 digits and the serial number contains 6 digits.
- In Fields in IMBs with a 6-digit mailer ID and a 9-digit serial number, the mailer ID contains 6 digits and the serial number contains 9 digits.
Fields in IMBs with a 9-digit mailer ID and a 6-digit serial number
Fields in IMBs with a 6-digit mailer ID and a 9-digit serial number
AFP Editor lets you specify these fields:
- Barcode ID
- A 2-digit number that identifies Optional Endorsement Line (OEL) information. The USPS defines the barcode IDs. This field is required.
- Service type ID
- A 3-digit number that identifies the mail class and the postal services. For example,
080
is first-class mail with Address Service requested. The USPS defines the service types and service type IDs. This field is required. - Mailer ID
- A 6- or 9-digit number that identifies the mailer. The USPS assigns the mailer ID.
Note: You can use the Mailer ID field for other purposes in an IMB that is used for reply mail.
- Serial number
- A 6- or 9-digit number that the mailer assigns to identify the mailpiece. If the mailer
ID contains 6 digits, the serial number contains 9 digits. If the mailer ID contains
9 digits, the serial number contains 6 digits. This field is required; however, if
you use only USPS
Basic Services
, the serial number can be zeroes. - Routing ZIP Code
- The 5-, 9-, or 11-digit routing ZIP Code of the mail recipient, also called the
Delivery Point Code
. This field is not required.
IMB serial numbers
The serial number in an Intelligent Mail barcode (IMB) identifies the mailpiece. If
you use the USPS Full service
option, the serial number must not repeat in another barcode for a 45-day period.
A serial number can consist of 6 or 9 digits, depending on the length of the mailer ID. Because 6 or 9 digits might not be long enough to completely identify a mailpiece (for example: the recipient, the type of mailing, the date of mailing), you can use a sequential number as the serial number and save the serial number in an index tag in the mailpiece or in a separate index file. If the USPS returns electronic Address Change Service (ACS) information, you can then use the serial number to retrieve the actual mailpiece or information about the mailpiece.
AFP Editor lets you specify the serial number in these ways:
- Index tag: You can specify an index tag that contains the value to encode as the serial number.
The index tag can contain a different value in each page group (mailpiece). For example,
if the customer ID is indexed, the serial number can be the customer ID. If the customer
ID is shorter than the 6 or 9 digits required for a serial number, AFP Editor automatically adds zeroes to the beginning of the customer ID. Keep in mind that
if you use the USPS
Full service
option, the serial number must not repeat in another barcode for a 45-day period. - Serial number file: For each barcode, you can specify a file that contains the number to use as the serial number in the first IMB in the AFP file. AFP Editor automatically increments the number in the file by 1 in each subsequent barcode that it creates to make the serial number unique. For example, if the serial number file contains a starting serial number of 000000, the serial numbers in the barcodes are 000000, 000001, 0000002, 0000003, and so on.
When AFP Editor creates IMBs in production AFP files:
- In the first IMB in the AFP file, it encodes the serial number that is in the serial number file.
- In each subsequent IMB created, it increments the serial number by 1. This ensures that the serial number is unique in each barcode.
- When the serial number reaches the maximum number of digits specified in the serial number file (6 or 9 digits), the number wraps to 000001 or 000000001.
- When it finishes creating IMBs in the AFP file, it updates the serial number file so that the file contains the starting serial number for the first IMB in the next AFP file that AFP Editor processes.
For example, if the serial number file contains the 6-digit serial number 000001, and AFP Editor creates four IMBs in two AFP files (each AFP file uses the same serial number file), the barcodes contain these serial numbers:
- First AFP file: 000001, 000002, 000003, and 000004
- Second AFP file: 000005, 000006, 000007, and 000008
AFP Editor can save the actual barcode data that it encoded in each IMB in an index tag. This is especially useful when you use a serial number file because each index tag in the AFP file contains the actual serial number that was encoded in the barcode.
You specify the name of the serial number file when you create an IMB in the sample AFP file. However, you can use a different serial number file for production AFP files. You can specify the name of the serial number file to use in the EditAFP and PluginMgr commands.
-threads 1
option), or use the PluginMgr command to run EditAFP. PluginMgr is single-threaded,
so IMB serial numbers are always in sequential order by page group.POSTNET to IMB replacement
Intelligent Mail barcodes (IMBs) can replace both POSTNET and PLANET barcodes, as well as the alphanumeric characters that contain the participant code and keyline information for the USPS Address Change Service (ACS).
AFP Editor provides a replace function that can delete POSTNET barcodes and create IMBs that contain the same routing code as in the replaced POSTNET barcodes (minus the check digit). POSTNET barcodes and IMBs can be text barcodes or BCOCA objects.
The replace function automatically places IMBs in the same position as the POSTNET barcodes they replace. However, you can change the position of the IMBs. For example, if the POSTNET barcode is below the name and address, you can put the IMB above the name and address.
The replace function does not delete any PLANET barcodes or the Address Change Service (ACS) information that typically prints above the name and address. However, you can first use AFP Editor to hide the area that contains the PLANET barcode and any ACS information.
PLANET and POSTNET barcodes shows an address with ACS data, a PLANET barcode, and a POSTNET barcode. POSTNET barcode shows the same address after you create a hidden area to cover the ACS data and the PLANET barcode.
POSTNET barcode shows the address with the POSTNET barcode. IMB replacement shows the address after you replace the POSTNET barcode with an IMB.
1.3.1.2.8.2 Hidden areas
You can hide areas that contain text, barcodes, or other types of optical mark recognition (OMR) data that you want to replace or that are no longer needed. For example, if you want to replace POSTNET and PLANET barcodes with Intelligent Mail barcodes (IMBs), you can hide the PLANET barcodes. (AFP Editor can automatically replace PLANET barcodes with IMBs, but you must hide the PLANET barcodes and any ACS data.)
AFP Editor creates a hidden area by creating an AFP graphics object that contains no data and that prints in the color of the medium or another color. Although you cannot use an AFP viewer to see the existing data in the hidden area, the data still exists in the AFP file.
You can specify the location and size of the hidden area. You can place a hidden area on:
- A specified page (for example, page 1) of each page group
- All pages in each page group
- The even pages in each page group (pages 2, 4, 6,...)
- The odd pages in each page group (pages 1, 3, 5,...)
1.3.1.2.8.3 Text masks
xcharacter. Text masks are useful if you do not want anyone to view or print sensitive information, such as customer names and social security numbers.
You can block out, or mask, text that is consistently present in the same location in each page group. You define a text mask by selecting a block of text that occurs in a consistent location on every page group in the file; for example, a customer's social security number. You can define multiple text masks so you can mask different information in a page group, such as a customer name, an address, and an account number.
You can use the default character x
for the mask value or select a different character. The selected text is replaced
in the AFP file. For example, when you use an AFP viewer, instead of displaying social
security number 213-87-2967
, the text mask xxxxxxxxxxx
is displayed. When you print the AFP file, instead of printing the social security
number, the text mask prints.
Tip: To make sensitive data completely inaccessible, mask the text instead of hiding the area that contains the data. When you mask text data, the original data is no longer in the AFP file. However, when you hide an area, the original data remains in the AFP file. In both cases, an AFP viewer does not display the data and the data does not print.
1.3.1.2.9 Whitespace Manager
The content that is placed in a white space area is based on rules you define to target the content for specific customers or for the best use of available space.
1.3.1.2.9.1 White space
When Whitespace Manager searches for white space on a page, it looks on the logical page for areas without text blocks. Areas with overlays, page segments, barcodes, and images are considered available white space.
When you create a white space definition, you use these options to select the pages in the page group where you want the white space defined:
- This page
- This and following pages
- Last page
For known white space definitions, you can create one area of known white space for each page in a page group using This page or Last page. This equates to a total of n definitions, where n is the number of pages in a page group. For white space definitions from a search, you can create one area of white space for each page in a page group using This page, one area of white space using This and following pages, and one area of white space using Last page. This equates to a total of n + 2 definitions. Therefore, the maximum number of white space definitions that Whitespace Manager lets you create is:
2n + 2For example, if a page group has three pages, you can create 3 definitions for known white space and 3 + 2 definitions for white space definitions from a search. Therefore, the maximum number of white space definitions allowed is:
(2 x 3) + 2 = 8If you try to create more than the allowed number of white space definitions on a page, you see the message "No more white space definitions are allowed for this page."
When you create a white space definition, you also choose the origin and size of the area for the white space. If you are searching for available white space on a page, you decide on a minimum width and height for the white space area that you want Whitespace Manager to look for (at least 0.5 inches or 12.7 millimeters). Whitespace Manager searches for the largest white space area on a page that meets the minimum dimensions specified. When Whitespace Manager finds white space that meets the specifications on that page, it stops the search.
White space definition results shows how Whitespace Manager creates white space definitions based on the page options that you select.
White space definition results
White space definition | Page option | Result |
---|---|---|
Known white space | This page | Whitespace Manager creates a white space definition on the current page of the page group and displays the white space as a colored box. If a white space definition was previously found on the page from a search, the known white space definition takes precedence and is displayed in the user interface. This option is only available if a known white space area has not been defined on the current page. |
Last page | Whitespace Manager creates a white space definition on the last page of the page group and displays
the white space as a colored box. If a white space definition was previously found
on the page from a search, the known white space definition takes precedence and is
displayed in the user interface.
You might want to create a Last page definition instead of This page when the page groups contain a variable number of pages and you want the white space to always be on the last page. This option is only available if the current page is the last page in the page group and a known white space area has not been defined on the page. |
|
White space from a search | This page | Whitespace Manager creates a white space definition on the current page of the page group and displays
the white space as a colored box unless:
|
This and following pages | Whitespace Manager searches the current page and all pages that follow in the page group, creates a
definition on the first page where it finds white space, and then displays the white
space as a colored box. It does not display a white space box if:
Notes:
|
|
Last page | Whitespace Manager creates a white space definition on the last page of the page group and then displays
the white space as a colored box unless:
You might want to create a Last page definition instead of This page when the page groups contain a variable number of pages and you want the white space to always be on the last page. This option is only available if the current page is the last page in the page group and if white space from a search has not already been defined using Last page. |
Keep in mind that not all the white space definitions that you create are displayed in the user interface because Whitespace Manager follows these rules for determining which white space definition is displayed on a page:
- Only one white space definition is displayed per page.
- A known white space definition is displayed before white space that was defined from a search.
If you delete a known white space definition, white space defined from a search can be displayed on a page.
1.3.1.2.9.2 Content
The Manage Campaigns window lets you determine what content is placed in defined white space by defining rules with conditions. Conditions are expressions that are used to evaluate whether index tags in a page group are true or false. You can use AFP Indexer to create index tags. In addition to text, these types of images can be displayed as content:
- GIF
- JPEG
- Page segment (PSEG)
You decide what content is placed in a defined white space (text, image, or both) and then decide whether the content is always placed or placed according to rules that you create. The rules are a string of conditions separated by "and" or "or" operators. If the condition is "true", you can specify that one type of content is assigned to the white space. If the condition is "false", you can specify that another type of content is assigned or no content is assigned.
You can also change the font and position of text and the position of images. When you define an image, you can enter the location of the file where the image resides. Then, if you need to periodically change the image placed in the white space, you can change the image in the file instead of changing the content definition.
1.3.1.2.10 Pipeline Manager
The AFP Indexer, AFP Editor, and Whitespace Manager components have filters. By using the filters for components, you can pre-process your AFP files. For example, you can generate page groups and indexes, add bar codes, and write the resulting AFP file, all in 1 process. The input AFP is read once, and the output AFP is written once.
1.3.1.2.10.1 Standard filters
AFP Visual Environment contains these standard filters:
1. Count Objects
Counts the number of AFP Objects in the file. Select Object Identifier from the list. The value is returned to the console output.
Parameters:
- Object Identifier
- Mandatory parameter. You must select one object type from the Supported Objects table.
2. Count Structure fields
Counts the number of AFP structure fields in the file. Select Structure field Identifier from the list. The value is returned to the console output.
Parameters:
- Structure field Identifier
- Mandatory parameter. You must select one structure field type from the Supported structure fields table.
3. Create Document Index File
Creates an AFP Document Index File. The output file is offset based. This filter should go at the end of the filter chain list.
Parameters:
- Document Index file name
- Mandatory parameter. Save location of the output document index.
- Form Definition file name
- Optional parameter. Path to an input form definition.
4. Create External Resource Group
Creates and External Resource Group from the in-line resource group and external resource directories. It requires a fully qualified Resource Group file name. It also allows you to specify an optional external resource directory and form definition file name.
Parameters:
- Resource group file name
- Mandatory parameter. Path to the output resource group.
- External resource directory
- Optional parameter. Path to an external resource directory.
- Form Definition file name
- Optional parameter. Path to an input form definition.
- Additional External resource directory
- Optional parameter. Can be added using the Create another instance of this parameter button.
5. Create Page Sheet Map
Creates an ACIF style Page or Sheet map. It requires a Page or Sheet Map file name. It also allows you to specify an optional form definition file name. An error message is displayed if the specified form definition is not found.
Parameters:
- Page sheet map file name
- Mandatory parameter. Path to the output.
- Form Definition file name
- Optional parameter. Path to an input form definition.
6. Cut AFP Objects
Removes AFP Objects from the file. Select the Object Identifier from the list. It allows you to specify an optional Object name with matching parameters.
Parameters:
- Object Identifier
- Mandatory parameter. You must select one object type from the Supported Objects table.
- Object Name
- Optional parameter. If we want to delete only with the specified object name.
- Range
- Optional parameter. You can use it to specify how many elements we should cut. This parameter is in the form of “first:last” where the first value starts at zero (0). An ‘e’ stands for “end”. For example, 0:7 means the first eight objects. 0:e means from the beginning to the end of the file.
7. Cut AFP Structured Fields
Removes AFP Structure fields from the file. Select a type structure field from the list that should be removed. You can specify how many using the Range option.
Parameters:
- Structure field Identifier
- Mandatory parameter. You must select one structure field type from the Supported structure fields table.
- Range
- Optional parameter. You can use it to specify how many elements should be cut. This parameter is in the form of “first:last” where the first value starts at zero (0). An ‘e’ stands for “end”. For example, 0:7 means the first eight objects. 0:e means from the beginning to the end of the file.
8. Ensure Even Number Pages in Page Group
Adds a blank page to groups with odd number of pages. Does not require any parameters.
9. In-Line Resource
Adds resources to the in-line resource group. You must supply the fully qualified resource file name and the actual resource name itself.
Parameters:
- Resource file name
- Mandatory parameter. Name and path of the resource on the disk.
- Resource name
- Mandatory parameter. Name of the resource that should be written in AFP.
10. Remove Incomplete Pages
Removes incomplete pages, where a new page begins before the previous one is ended.
11. Remove Page Groups
Removes all Page Groups and Page Group TLEs, but not any other data within the Page Group. There is also an optional Range parameter.
Parameters:
- Range
- Optional parameter. You can use it to specify how many elements should be cut. This parameter is in the form of “first:last” where the first value starts at zero (0). An ‘e’ stands for “end”. For example, 0:7 means the first eight objects. 0:e means from the beginning to the end of the file.
12. Validate AFP Structured Fields
Validates the order and context of structured fields. Missing Begin Document (BDT) and End Document (EDT) Structured Fields are allowed.
Parameters:
- Exit on Error
- Optional parameter. The customer can specify with a Boolean input parameter whether the validation should stop after the first error occurs or continue until the end.
13. Write AFP Structured Fields
Dumps AFP Structured Field information. Information can be written to an external file. You can also write the output in Hexadecimal format with the optional Show Hex selection.
Parameters:
- Output file name
- Optional parameter. The name and path of the output file.
- Show Hex values
- Optional parameter. Use the Boolean values to show or hide the hexadecimal values of the AFP structure fields.
1.3.1.2.10.2 Supported Objects
AFP Object | ActiveEnvironmentGroup |
BarCode | CharacterSet |
CodePage | CodePage |
Document | DocumentEnvironmentGroup |
DocumentIndex | FormEnvironmentGroup |
FormMap | Graphics |
Image | IOCA |
MediumMap | MediumOverlay |
ObjectContainer | ObjectEnvirmentGroup |
Page | PageGroup |
PageSegment | Resource |
ResourceEnvirmentGroup | ResourceGroup |
Text |
1.3.1.2.10.3 Supported structure fields
BAG | BBC | BCF | BCP |
BDA | BDD | BDG | BDI |
BDM | BDT | BFG | BFM |
BFN | BGR | BII | BIM |
BMG | BMM | BMO | BNG |
BOC | BOG | BPF | BPG |
BPM | BPS | BPT | BR |
BRG | BSG | BTS | CDD |
CFC | CFI | CPC | CPD |
CPI | CTC | CTD | EAG |
EBC | ECF | ECP | EDG |
EDI | EDM | EDT | EFG |
EFM | EFN | EGR | EII |
EIM | EMG | EMM | EMO |
ENG | EOC | EOF | EOG |
EPF | EPG | EPM | EPS |
EPT | ER | ERG | ESG |
ETS | FGD | FNC | FND |
FNG | FNI | FNM | FNN |
FNO | FNP | GAD | GDD |
ICP | IDD | IEL | IID |
IMM | IOB | IOC | IPD |
IPG | IPO | IPS | IRD |
LLE | MBC | MCC | MCD |
MCF1 | MCF2 | MDD | MDR |
MFC | MGO | MIO | MMC |
MMO | MMT | MPG | MPO |
MPS | MSU | NOP | OBD |
OBP | OCD | PEC | PFC |
PGD | PGP1 | PGP2 | PMC |
PPO | PTD | PTX | TLE |
1.3.1.3 Installing AFP Visual Environment
- Download
AVEInstaller_6.6.x.jar
. - To start the installation:
- On a Windows operating system, log in as an administrator and double-click
AVEInstaller_6.6.x.jar
. - On an AIX or Linux operating system, open the command line and enter
java -jar AVEInstaller_6.6.x.jar
.You can also run the installation program in the console mode.
- On a Windows operating system, log in as an administrator and double-click
- The installer starts and displays the Introduction window. Click Next.
- Review and accept the license agreement. Click Next.
- Select the installation type. Click Next.
- Choose a directory to install AFP Visual Environment in. The default installation
directory is
C:\Program Files\RICOH\AFP Visual Environment
on Windows andopt/RICOH/ave
on Linux and AIX. - Review the pre-installation summary and click Install to start installing.
1.3.1.4 Working with sample AFP files
The sample AFP file should be representative of production AFP files.You can then run an AFP Visual Environment command to make the same enhancements to production AFP files.
To enhance a sample AFP file, first you convert any line data to Mixed Object Document Content Architecture for Presentation (MO:DCA-P) format. Then you start the user interface and open the sample AFP file. You can choose to create a new AFP Visual Environment control file or update an existing control file. If necessary, you must specify the AFP resource directories to AFP Visual Environment, and create custom font-mapping files.
1.3.1.4.1 Converting line data to MO:DCA-P in sample AFP files
If the sample AFP file is on a z/OS system, you must then send the AFP file and any AFP resources that are not inline to the preparation system.
To convert line data to MO:DCA-P data in a sample AFP file:
- Use the AFP Conversion and Indexing Facility (ACIF) program to convert the data stream to MO:DCA-P format. As an option, request that ACIF create a resource group file that contains the AFP resources that the file references.
- If the sample AFP file is on another system, use the File Transfer Protocol (
ftp
) on the preparation system to get the AFP file and the ACIF resource group file. Use theftp
binary option. - Concatenate the resource group file and the AFP file that ACIF created.
1.3.1.4.2 Installing AFP Visual Environment
RICOH ProcessDirector applies those enhancements to print jobs during processing.
You can install AFP Visual Environment on systems running Java 1.8 or higher and any of these operating systems:
- Windows 10 Pro or Enterprise 64-bit
- Windows 11 Pro
- Windows Server 2016 64-bit
- Windows Server 2019 64-bit
- Windows Server 2022 64-bit
- CentOS Linux 7.7 through latest 7.X for x86_64
- Red Hat 7.6 through latest 7.X
- Red Hat 8.1 through latest 8.X
- SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
- SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64
To install AFP Visual Environment:
- Log in to RICOH ProcessDirector.
- Open
- Click AFP Visual Environment to download the VisualWorkbench.zip file.
- Find the ZIP file on your system and unzip it into the location where you want to
install AFP Visual Environment.A collection of folders and files are stored in the location you specify. The installation is complete.
- To start AFP Visual Environment:
1.3.1.4.3 Displaying sample AFP files
For example, if the AFP file contains text that you want to use in an index tag or in barcode data, choose a sample file that contains that text in the same position on the page as the production AFP files.
You can open one AFP file in AFP Visual Environment at a time. If an AFP file is already open, AFP Visual Environment automatically closes it and prompts you to save its control file if you have not already done so. After you open an AFP file, you can rotate the view, display selected pages, display different views, and increase the display size.
You can display the properties of page groups, pages, text, and AFP objects (such as page segments and overlays) in the AFP file. Page-group properties include the index tag values. Page properties include the type of AFP objects that are on the page, including page-level indexes. Text properties include font information and the location (in inches or millimeters) of the text.
- Note:
- If some text does not display correctly, you might need to identify the directory that contains the font resources to AFP Visual Environment, or you might need to modify AFP Visual Environment font mapping.
- Click . You see the Open window.
- Select the AFP file that you want to open and click Open.You see the AFP file in the right pane of the user interface. You also see the Open Control File window with the message: Do you want to use an existing control file for this AFP file?
- Do one of these:
- To create a control file, click No. If the AFP file contains index tags, you see the index tags in the bottom pane; otherwise, the bottom pane is blank.
- To display the file using an existing control file, click Yes. This is recommended if you have previously created a control file for this sample
AFP file. You see the Open window:
- Select the control file that you want to use.
- Click Open. If the control file contains definitions for index tags, or if the AFP file contains index tags, you see the index tags in the bottom pane; otherwise, the bottom pane is blank.
To the left of the AFP file, you see the page structure of the file, which can contain page groups and pages. You might also see a resource group entry at the top of the page structure if the file contains inline AFP resources, such as overlays and page segments. - To rotate the AFP file clockwise by 90 degrees, click o. Click again to rotate another 90 degrees.
- To navigate in the AFP file, do one of these:
- Click anywhere in the AFP file and press the Page Up or Page Down key on your keyboard.
- Double-click to select a page from the left pane.
- Double-click to select a page group from the bottom pane.
- To hide or display the page structure in the left pane, click .
- To hide or display the indexes in the bottom pane, click .
- To increase or decrease the display size of the AFP file, click (nnn is one of these percentages: 200, 175, 150, 125, 100, 75, 50.)The display size of the AFP file is increased or decreased by the percentage you select.
- To change units of measurement, do one of these:
- For inches, click .
- For millimeters, click .
- To display properties:
- Do one of these:
- In the left pane, click a resource, page group, or page. Right-click and click Properties.
- Click Mode and a feature. Then:
- Click text or an object in the AFP file. You see a red box around the text or object
you selected.
- Note:
- If you cannot select an object, it is not enabled for selection. See Enabling object selection in sample AFP files.
- Right-click and then click Properties.
- Click text or an object in the AFP file. You see a red box around the text or object
you selected.
- To see the complete text for a value:
- Double-click the green box.
- Click OK.
- To close the Properties window, click X in the upper right corner.
- Do one of these:
- If text does not display correctly:
- If the AFP file contains data that displays incorrectly, change the default code page to another code page (IBM850(GID=850) and an EBCDIC code page is IBM500(GID=500). ). For example, an ASCII code page is
- If the AFP file refers to AFP fonts that are not inline, identify the directories that contain font resources to AFP Visual Environment ( ).
- If the AFP file refers to custom AFP fonts, create custom font-mappings in AFP Visual Environment.
- If an error occurs when opening or working with a file, click , which closes the file and clears the cached resources from memory. Open the file again.
1.3.1.4.4 Creating and updating control files
- In AFP Visual Environment, open a sample AFP file.You see the Open Control File window with the message
Do you want to use an existing control file for this AFP file?
- Do one of these:
- To create a control file, click No.
- To update a control file, click Yes. You see the Open window:
- Select the control file.
- Click Open.
- If you opened the wrong control file, click and select the correct control file. If you see message
Your unsaved changes will be lost if you open a new control file. Do you want to continue?
, it means that you have already enhanced the AFP file in this session and you will lose those changes. Do one of these:- To open another control file, click Yes.
- To save the open control file first so that you do not lose the definitions you created in this session, click No. Then save the control file.
- Enhance the sample AFP file.For example, create page groups, index tags, bar codes, text, and white space.
- Do one of these:
- To save a new control file or to rename an updated control file:
- Click .
- Type the full path name of the control file in the File name field.
- Click Save.
.ctl
. - To save an updated control file with the same name, click .
- To save a new control file or to rename an updated control file:
1.3.1.4.5 Identifying AFP resource directories
You can specify as many resource directories to AFP Visual Environment as necessary.
- Note:
- If you plan to create text Intelligent Mail bar codes (IMBs), which refer to an IMB font, identify the resource directory that contains the AFP IMB font to AFP Visual Environment so that AFP Visual Environment can display the bar code symbol. The AFP IMB font (character set C0XMUS23) is installed in the resources directory. If you plan to create BCOCA IMBs, this is not necessary.
AFP Visual Environment looks for AFP fonts, page segments, and overlays in these resource directories, in the order shown:
- Inline in the AFP file
- Resource directories specified to AFP Visual Environment, in the order the directories are specified
The resource directories that you specify are used until you specify different resource directories. However, when you open an AFP file again using an existing control file, AFP Visual Environment uses the resource directories that you had specified, if any, the last time you worked with that AFP file using the same control file.
- In AFP Visual Environment, open a sample AFP file. Then click .
- Click Add.
- Type a directory name in the Directory name field, or click Browse to select a directory.
- Click OK.
- To specify another resource directory, click Add again.
- To change the order of a directory in the list, select the directory and click Up or Down.The directories are searched in the order they are listed.
- Click OK.
1.3.1.4.6 Mapping fonts for AFP files
You can also change the default code page that AFP Visual Environment uses to another encoding.
When you are creating or editing index tags and you cannot read the text, you can change the code page mapping so the index value is readable. When you want to change the way the text is displayed in AFP Visual Environment, you can change the character set mapping.
AFP font mappings can be located in multiple places. AFP Visual Environment looks for font mappings in this order:
- Job font mappings in the AFP Visual Environment control file
- Installation font mappings in font-mapping files
- System font mappings
You cannot change system font mappings, but you can create job font mappings for an AFP file that are saved in the control file, and you can edit installation font mappings in one or more of these font-mapping files that are shipped with AFP Visual Environment:
- CharacterSets.properties: Maps an AFP character set to corresponding font attributes or a AFP font global identifier (FGID) to a corresponding Java font name and style.
- CodedFonts.properties: Maps an AFP coded font to an AFP character set and AFP code page.
- CodePages.properties: Maps an AFP code page or a Java charset encoding to an AFP code page global identifier (CPGID).
- SampleCodePointMap.cp: Maps a code point to a Unicode code point. Use this file to create a code point map file for each AFP code page that does not use standard Unicode code-point mapping. The name of the file must contain the name of the AFP code page.
You can change the default Java font that AFP Visual Environment uses by defining the font in the control file or in the font-mapping files. The default Java font, unless you change it, is an 11-point font with an EBCDIC code page.
1.3.1.4.6.1 Using font-mapping files to map fonts
The mappings in the font-mapping files are used to display all AFP files in AFP Visual Environment unless an AFP font is mapped to a Java font in the AFP Visual Environment control file.
- Navigate to the directory where you installed AFP Visual Environment.
- Open the sample font-mapping files in a file editor, edit them, and save them.All font-mapping files that you want to use must be in the same directory.
- If you edited sample file
SampleCodePointMap.cp
, rename it to the name of the AFP code page.For example, if the name of the code page is T1000259, name the fileT1000259.cp
.
1.3.1.4.6.2 Creating font mappings from text blocks
The font mapping can be for a character set, code page, or coded font. You can map an AFP character set to a Java font, an AFP code page to a Java character set, or an AFP coded font to an AFP character set and AFP code page.
- In AFP Visual Environment, open a sample AFP file.
- Click Mode and a feature.
- Click a text block.You see a red box around the text you selected.
The text blocks you can select are defined in the AFP file, from one character to the entire line of text. For example, the text
Account Summary
might be defined as two text blocks. You can click either theAccount
orSummary
text block. - Right-click anywhere on the page and click Create Font Mapping.You see the Create Font Mapping window.
- Click one of these for the font mapping type:
- Character Set (default)
- Coded Font (only available if the text block references a coded font)
- Code Page
The fields and buttons on the window change depending on which font mapping type you select. Font mapping fields and buttons describes the fields and buttons that are displayed for font mapping.Font mapping fields and buttons
Field or button Font Mapping Type Description Add Character Set The action for adding a new global identifier to the drop-down list for the character set. Character Set Name Character Set Code Page Coded Font
Identifies one of these: - The name of a defined set of characters for AFP. The name usually begins with "C".
The second character in standard AFP character set names indicates the character rotation.
A question mark (?) is used as a wildcard character for the second character of the character set name
and means that the identifier applies to all rotations.
Note:
DEFAULT
is used for the identifier of the AFP character set when AFP Visual Environment cannot locate the resource for a coded font. - The name of a defined Java character set encoding.
Coded Font Name Coded Font The name of the AFP coded font that associates an AFP code page and an AFP character set. For double-byte fonts, a coded font associates multiple pairs of code pages and font character sets. Code Page Name Code Page Coded Font
The name of the AFP code page that assigns code points to graphic characters. The name usually begins with T1
.Note:DEFAULT
is used for the identifier of the AFP code page when AFP Visual Environment cannot locate the resource for a coded font.DBCS Code Page The code page is a double-byte character set in which each character is represented by two bytes. You cannot change this field. Text Example Character Set Code Page
The text block you selected in the AFP file. Family Name Character Set The name of the Java font family. Global Identifier Character Set Code Page
A 1- to 5-digit decimal global character set graphic identifier (GCSGID) or code page global identifier (CPGID). The values are 00001 to 65534. Point Size Character Set The height of the characters in a font. One tenth of the value is the point size. For example, a value of 90 represents a 9-point font. Valid values are whole numbers from 1 to 990. SBCS Code Page The code page is a single-byte character set in which each character is represented by a 1-byte code point. You cannot change this field. Show CharSets Character Set The action for viewing which character sets currently use the global identifier displayed in the Global Identifier field. Show Common Character Set Code Page
The action for viewing which character sets or code pages currently use the global identifier displayed in the Global Identifier field. Style Character Set The style of the Java font. Valid values are: BOLD
,BOLD|ITALIC
,ITALIC
, andPLAIN
. - Do one of these, depending on which font mapping type you selected:
- For Character Set, do one of these:
- Select a different global identifier from the drop-down list. You can click Show Common to view which character sets currently use the selected global identifier and then click X in the upper right corner to close the window.
- Click Add to create a new global identifier:
- Type a 1- to 5- digit identifer in the Global Identifier field.
- Click Show CharSets to view which character sets currently use the selected global identifier. Click X in the upper right corner to close the window.
- Type a point size.
- Select a family name and style for the Java font from the drop-down lists.
- Click OK.
- For Coded Font:
- Type an AFP character set name. The name usually begins with "C".
- Type an AFP code page name. The name usually begins with "T1".
- For Code Page:
- Select a different global identifier from the drop-down list.
- Click Show Common to view which code pages currently use the selected global identifier. Click X in the upper right corner to close the window.
- For Character Set, do one of these:
- Click OK.The font mapping is created in the control file. To keep the font mappings, be sure to save the control file before exiting the AFP file.
1.3.1.4.6.3 Modifying font mappings from text blocks
- In AFP Visual Environment, open a sample AFP file.
- Click .
- Select the name of a font mapping.
- Do one of these:
- Click Modify or double-click. You see the Modify Font Mapping window. Do one of these, depending
on which font mapping type you selected:
- For Character Set, do one of these:
- Select a different global identifier from the drop-down list. You can click Show Common to view which character sets currently use the selected global identifier and then click X in the upper right corner to close the window.
- Click Add to create a new global identifier:
- Type a 1- to 5- digit identifer in the Global Identifier field.
- Click Show CharSets to view which character sets currently use the selected global identifier. Click X in the upper right corner to close the window.
- Modify the point size.
- Select a family name and style for the Java font from the drop-down lists.
- Click OK.
- For Coded Font, edit the AFP character set name, AFP code page name, or both.
- For Code Page:
- Select a different global identifier from the drop-down list.
- Click Show Common to view which code pages currently use the selected global identifier. Click X in the upper right corner to close the window.
- For Character Set, do one of these:
- Click Delete or press the Delete key on your keyboard. The font mapping is removed.
- Click Modify or double-click. You see the Modify Font Mapping window. Do one of these, depending
on which font mapping type you selected:
- To close the Modify Font Mappings window, click X in the upper right corner.The font mapping is updated in the control file. To keep the font mapping changes, save the control file before exiting the AFP file.
1.3.1.4.6.4 Changing the default code page encoding
If text is unreadable, you can change the default code page to another encoding without modifying the font-mapping files.
The default code page that you specify is in effect until you tell AFP Visual Environment to use a different default code page. However, when you use an existing control file, AFP Visual Environment uses the default code page that was in effect the last time you used the same control file.
- In AFP Visual Environment, open a sample AFP file.
- Click .
- Select a code page encoding from the drop-down list.Note: If you have specified a default code page in the
CodePages.properties
file, the code page specified in that file overrides the code page encoding you select. - Click OK.
1.3.1.4.7 Enabling object selection in sample AFP files
When you click an object that is selectable in the sample AFP file, you see a red box around it. Then you can see the properties of the object and, depending on the mode you selected, act on it.
By default, each mode lets you select only the types of objects that you can act on. For example, the AFP Indexer mode lets you select text objects, but not overlays, page segments, barcodes, or images. The default for each mode is suitable for most purposes. However, you might want to temporarily make other types of AFP objects selectable so that you can see the properties of other AFP objects in the AFP file. In that case, you should use the enabling object selection function.
- Note:
- If you change the mode or open a new sample AFP file after you change the types of object you can select, your changes are lost and the default selections for the current mode are used.
- You cannot select AFP objects that are defined in a form definition, even if the objects are listed as a resource in the file-structure pane or you have enabled their selection.
- In AFP Visual Environment, open a sample AFP file.
- Click Mode and a feature.
- Click .
- Indicate which objects you want to select in this AFP file:
- Click individual objects you want to select:
- Text to select text blocks and to select barcodes that were created using fonts.
- Barcodes (BCOCA) and images (IOCA) to select barcodes that were created using Bar Code Object Content Architecture (BCOCA) and to select images created using Image Object Content Architecture (IOCA).
- Page segments to select page segments.
- Overlays to select overlays.
- Click All objects to select all objects.
- Click No objects to clear all objects.
- Click individual objects you want to select:
- Click OK.
- In the AFP file, you can now select an object that you made selectable and see its
properties:
- Click an object.If you select an area that contains overlapping selectable AFP objects (for example, an area might contain both a BCOCA barcode and text), you see the Select an Object window so you can indicate which object you want to select.
- Right-click anywhere in the AFP file to see the properties of the object.
- Click an object.
- Optional: To revert to the default object-selection settings for the current mode, click Mode and then click the current mode.
1.3.1.4.8 Showing page information in sample AFP files
The sheet information includes page placement and the medium map used on the page. (The medium map specifies formatting options, such as duplex options and overlays.)
If a resource, such as a font, is missing, identify the resource directory that contains the resource to AFP Visual Environment so that AFP Visual Environment can display the data correctly.
To see sheet information, you must specify form definition processing (
).- In AFP Visual Environment, open a sample AFP file. Then click .
- Click the Resources tab.You see a table with these columns:
- Reference Name: Name of the resource in the AFP file.
- Type: Type of resource.
- Resource name: Name of the resource that was found. If the resource was not found, the resource name is Unknown.
- Location: Location of the resource: inline in the AFP document or in a resource directory. If the resource was not found, the resource name is Not found.
Note: This table does not show form definitions, color management resources, and data object resources. - Optional: To limit the number of resources shown in the table, do one of these:
- To see only resources that were found, click Found.
- To show only resources that were not found, click Missing.
- Click the Sheet tab.If form definition processing is specified, you see:
- Active Medium Map: Name of the medium map used for the currently displayed AFP page.
- Constant Back: Whether the constant back is
Yes
orNo
. - Constant Front: Whether the constant front is
Yes
orNo
. - N_Up: Number of equal partitions on the side of a sheet.
- Page name: Identifier for the currently displayed AFP page.
- Page number: Number of the currently displayed AFP page.
- Partition: Number of equal-sized areas on the currently displayed AFP page.
- Plex: Whether printing is done on only one side of the sheet (Simplex) or both sides (Normal Duplex or Tumble Duplex).
- Sheet copies: Number of copies of this sheet to be printed.
- Sheet count: Number of this sheet in the total number of sheets to be printed.
- Sheet side: Front or Back.
Otherwise, you see the message "Form definition and medium map processing is disabled."
- Click OK.
1.3.1.4.9 Specifying a form definition
When a form definition is selected, the defined overlays are used to display information in the AFP file and the medium map information is displayed on the Page Information window.
To specify whether a form definition is displayed:
- In AFP Visual Environment, open a sample AFP file. Then click .
- Do one of these:
- Click Use Inline Form Definition to override the default form definition.
- In the Default field, type the full path name of the directory that contains the form definition you want to use.
- Click Browse, select the form definition you want to use from a list in the window, and then click OK.
If you specify a form definition other than the default, it is not saved in the control file. Therefore, each time you open the AFP file, you must specify the form definition if you want to see the medium map information. - Click OK.If you specified a form definition, you can now view the form definition's medium map information in the Page Information window on the Sheet tab. Otherwise, the medium map information is not displayed.
1.3.1.4.10 Checking enhancements to sample AFP files
You can view the enhanced sample AFP file with an AFP viewer or print it on the production printer.
AFP Visual Environment saves the entire sample AFP file even if you did not open the entire file in the user interface. The save process might take a while if the sample AFP file is large.
- In AFP Visual Environment, open a sample AFP file and enhance it.
- Click .
- Type the full path name of the file you want to create in the File name field.
- Optional: Click View user log if you want to view the log that can contain error messages.
- Click Save.When the output file has been saved, you see a message that says the save has been completed.
- To check page groups and index tags, open the AFP file in an AFP viewer. To check the hidden areas and the bar codes, print the output AFP file on the production printer.
1.3.1.4.11 Configuring and running a set of filters
- In AFP Visual Environment, open a sample AFP file.
- If the file does not contain page groups, use AFP Indexer to create page groups.
- Click .
- Click .
The Current Pipeline Definition list shows the filters currently in the pipeline.
The Available Pipeline Elements list shows all the filters. You can add some filters to the Current Pipeline Definition list multiple times.
- To add a filter to the pipeline definition:
- Select the filter on the Available Pipeline Elements list.AFP Visual Environment displays a brief description of the filter.
- Click Add.
- If the filter has parameters, enter values for them.
If 2 or more parameters have a Group Parameter label, you must configure them as a group.
- Click OK.
- Edit the name of the filter.
- Click OK.The filter appears at the bottom of the list.
- To move the filter to another position on the list, click Up.Note: The order of the filters is important. Running filters such as Indexer and Remove Page Groups in a different order can give different results.AFP Visual Environment runs the filters in order, from top to bottom.
- Select the filter on the Available Pipeline Elements list.
- To save your changes, click Apply.
1.3.1.5 Indexing AFP files
1.3.1.5.1 Creating page groups
The sample AFP file must contain page groups before you can define header and trailer pages, create index tags for a page group, or make any other enhancements. If page groups are defined in the AFP file itself, you can use these page groups or you can create new page groups.
1.3.1.5.1.1 Creating page groups of fixed length
When you create fixed-length page groups, AFP Indexer can skip a certain number of pages at the beginning of the AFP file before creating the first page group.
Notes:
- Some AFP files are formatted so that two pages print side-by-side on the same physical sheet and are later cut into two separate stacks. You cannot use AFP Indexer to define page groups in files such as these because a single sheet can belong to only one page group.
- You cannot define supplemental pages for pages in a page group that is created as a fixed-length page group.
- In AFP Visual Environment, open a sample AFP file. Then click .
- Click .You might see a message that says the page groups and indexes might change or be invalid and asks if you want to continue. Click Yes. You see the Create Fixed-Length Page Groups window.
- Select the number of pages in each page group in the Pages in each page group field.
- Click Header/Trailer Definition to specify which pages are header and trailer pages and then click OK.
- Click OK. In the left pane and in the bottom pane, you see the page groups that have been defined based on the number of pages you specified. You also see the pages that are included in each page group.
If you defined header and trailer pages and decided to keep the pages in the output, you see header pages preceding the page groups in the left pane and trailer pages following the page groups. If you decided not to keep the header and trailer pages in the output, you do not see those pages in the left pane.
- Verify that the correct page groups have been created:
- Check that the number of pages is correct in each page group.
- Select page groups in the left pane to see the first page in a few of the page groups and verify that the correct boundaries were created.
- If the page groups are incorrect, either repeat the steps to recreate the fixed-length
page groups, or use triggers to create page groups of variable length.When you create page groups using triggers, the page groups of fixed length are removed.
1.3.1.5.1.2 Creating page groups with triggers
You define the start of each page group with a trigger. As an option, you can also define the last page of a page group with a trigger.
Look through the sample AFP file to determine what text you want to use as the trigger to define page groups. The text must be in the same location on each page that you want to identify as a boundary for the page groups. The text can also have the same value on each page. For example, you might select the customer's name, which appears in the same location on the first page of all customer statements. The name can be used as a trigger to define the boundary of the page group if the next pages of the customer statements do not contain any text in the selected text block location. Keep in mind that the boundary is defined only when the text block cannot be found in the selected location, or the exact text block string cannot be found in the selected location.
You can create one or more triggers. AFP Indexer creates a page group if it finds all the triggers.
- Note:
- Some AFP files might be formatted so that two pages print side-by-side on the same physical sheet and are later cut into two separate stacks. You cannot use AFP Indexer to define page groups in files such as these because a single sheet can belong to only one page group. You cannot define two triggers that cause the left and right sides of the sheet to belong to different page groups.
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file. Then click .
- Click the text that you want to use to mark the page group boundaries in the file.You see a red box around the text you selected.
The text blocks you can select are defined in the AFP file, from one character to the entire line of text. For example, the text
Account Summary
might be defined as two text blocks. You can click either theAccount
orSummary
text block to create a trigger. - Right-click the text and click Create Trigger.You might see a message that says the page groups might change or the index tags might be invalid and asks if you want to continue. Click Yes.You see the Create Trigger window with the selected text in the Edited trigger field.
- Note:
- You might need to use the scroll arrows to see the text in the Edited trigger field.
- Decide whether you want to use the entire text value as the page-group trigger or
only part of the text. You can edit the text value to reduce the number of characters
you use for the trigger value. To select part of the text as the trigger:
- Click Edit trigger.
- Edit the trigger value in the Edit Value window.For example, if the page number is one text block, Page 1 of 4, you can create a trigger with the part of the page number that occurs on the first page of each page group, such as Page 1. You would not use of 4 because not all page groups are 4 pages long–the first page of some page groups might contain text Page 1 of 2 or Page 1 of 3.
- Click OK.
- Select a trigger type:
- Start page group
- The text block marks the start of the page group boundaries in the file. This trigger type is required.
- End page group
- The text block marks the end of the page group boundaries in the file. This trigger type is optional.
You might see these trigger types; however, they are not used to create page groups:
- Page
- The text block marks an individual page in a page group. See Creating page-level triggers.
- Supplemental page
- The text block marks an individual page as a supplemental page. See Creating triggers for supplemental pages.
- Click the Advanced tab to change the text threshold, the method for matching the trigger, or both:
- Select a range from 1/100 to 1 inch or from 1 to 25 millimeters for the text threshold. Although text might appear to be present in the same location, slight position variations can occur in the AFP file. You can change the threshold to look for trigger text that is in slightly different positions on some pages. The threshold defines how far the text can be from the original location and be considered a trigger. For example, a threshold value of 12 indicates that the trigger can be located within .12 of an inch or 12 millimeters, either vertically or horizontally. Usually the default threshold value is sufficient (10 for inches or 2 for millimeters).
- Select the method used to match the trigger–on the trigger string value and the text
block position, or on the position only:
- On string and X,Y position
- The trigger string value and horizontal and vertical position of the text block are matched. This is the default.
- On string and X position
- The trigger string value and horizontal position of the text block are matched.
- On string and Y position
- The trigger string value and vertical position of the text block are matched.
- On X,Y position only
- The horizontal and vertical position of the text block is matched.
- Select Trigger on string value changing to activate the trigger when the value changes from the value in the field where the trigger was first defined.
- After you select Trigger on string value changing, select Trigger on any change in string to activate the trigger when the value changes from any previous value in the field.
- Click OK.In the left pane and in the bottom pane, you see the page groups that have been defined based on the trigger value. You also see the pages that are included in each page group.
- Verify that the correct page groups have been created:
- Check that the number of pages is correct in each page group.
- Select page groups in the left pane to see the first page in a few of the page groups and verify that the correct boundaries were created.
- If the page groups are incorrect, click to modify or delete the trigger.The trigger is listed as a Page Group Definition under Start Page Group Triggers or End Page Group Triggers.
- Optional: To create an additional trigger, repeat the steps.Make sure you select the text for the trigger from the same page group as the initial trigger.
1.3.1.5.1.3 Creating page groups when white space is found
A white space trigger is white space that occurs in a consistent location on the first page of all page groups. You define the start of each page group with the trigger.
If you create page groups using triggers, all existing page groups that are defined in the AFP file itself are ignored.
- In AFP Visual Environment, open a sample AFP file that contains the white space that you want to use to trigger page groups. Then click .
- To create the area, position your cursor at a corner of the area that contains the white space that you want to use to trigger page groups. While pressing the left mouse button, draw a box that includes the white space.
- Right-click anywhere on the page and click Create White Space Trigger..
You see the Trigger on White Space window.
- Type a descriptive name for the white space trigger in the WS Trigger definition name field.
- Choose when to start a page group:
-
The pels found option starts a new page group when the bounded area contains IOCA image data.
-
The pels not found option starts a new page group when the bounded area does not contain IOCA image data.
Note: Text is not IOCA image data.
-
- Optional: Change the origin (top-left corner) and size of the bounded area in these fields.
Decimal values (such as 2.5) are allowed. Specify the origin and size in inches or
millimeters.
- X position
- The horizontal distance of the left side of the area measured from the left side of the logical page (not the physical sheet of paper).
- Y position
- The vertical distance of the top of the area measured from the top of the logical page (not the physical sheet of paper).
- Width
- The horizontal width of the area.
- Height
- The vertical height of the area.
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the logical page in the unrotated view. - Click OK.
In the left pane and in the bottom pane, you see the page groups that have been defined based on the trigger. You also see the pages that are included in each page group.
- Verify that the correct page groups have been created:
- Check that the number of pages is correct in each page group.
- Select page groups in the left pane to see the first page in a few of the page groups and verify that the correct boundaries were created.
- If the page groups are incorrect, click to modify or delete the trigger.The trigger is listed as a Page Group Definition under Start Page Group Triggers .
1.3.1.5.1.4 Defining header and trailer pages
When you define header pages, AFP Indexer skips the defined number of header pages at the beginning of the AFP file before creating the first page group.
- In AFP Visual Environment, open a sample AFP file. Then click .
- If the AFP file does not contain page groups, create page groups.
- Click .You see the Header and Trailer Pages window.
- If the page groups are created with triggers, do one of these:
- Click All pages before the first page group to define all pages before the first page group as header pages.
- Click Fixed length header to define a certain number of pages as header pages.
- If displayed, select the number of header pages in Pages in header.
- If displayed, select the number of trailer pages in Pages in trailer.
- Clear the boxes if you do not want to keep the header or trailer pages in the output. The pages will not be viewable or printable.
- Click OK.If you defined header and trailer pages and decided to keep the pages in the output, you see header pages preceding the page groups in the left pane and trailer pages following the page groups; if you want, you can create index tags on those pages. If you decided not to keep the header and trailer pages in the output, you do not see those pages in the left pane.
1.3.1.5.2 Defining supplemental pages
page definitionin AFP Indexer refers to a supplemental page definition, a page-level trigger, or a page-level index, not the AFP page definition resource.
1.3.1.5.2.1 Creating triggers for supplemental pages
If you create a supplemental page trigger on a page that is in a page group, the supplemental page is removed from the page groups in the control file, unless the page group is an existing page group or created as a fixed-length page group.
Look through the sample AFP file to determine what pages should be supplemental pages
and not included in a page group. You select one or more triggers to define a supplemental
page with a page definition name. For example, a banner page that is defined with
a supplemental page trigger can have a page definition name of Banner
. AFP Indexer creates a supplemental page if it finds all the triggers.
Notes:
- Some AFP files might be formatted so that two pages print side-by-side on the same physical sheet and are later cut into two separate stacks. You cannot use AFP Indexer to define supplemental pages in files such as these because a single sheet cannot belong to a page group and a supplemental page. You cannot create two triggers that cause the left side of the sheet to belong to a page group and the right side to belong to a supplemental page.
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file. Then click .
- Click the text that you want to use to mark the supplemental page in the file.You see a red box around the text you selected.
The text blocks you can select are defined in the AFP file, from one character to the entire line of text. For example, the text
Banner Page
might be defined as two text blocks. You can click either theBanner
orPage
text block to create a trigger. - Right-click the text and click Create Trigger.You might see a message that says the page groups might change or the index tags might be invalid and asks if you want to continue. Click Yes.You see the Create Trigger window with the selected text in the Edited trigger field.Note: You might need to use the scroll arrows to see the text in the Edited trigger field.
- Decide whether you want to use the entire text value as the supplemental page trigger
or only part of the text. You can edit the text value to reduce the number of characters
you use for the trigger value. To select part of the text as the trigger:
- Click Edit trigger.
- Edit the trigger value in the Edit Value window.
- Click OK.
- Click Supplemental page for the trigger type.You see the Select supplemental page definition field.
- Type a name to identify the supplemental page or select a name from the drop-down list.
- Click the Advanced tab to change the text threshold, the method for matching the trigger, or both:
- Select a range from 1/100 to 1 inch for the text threshold. Although text might appear to be present in the same location, slight position variations can occur in the AFP file. You can change the threshold to look for trigger text that is in slightly different positions on some pages. The threshold defines how far the text can be from the original location and be considered a trigger. For example, a threshold value of 12 indicates that the trigger can be located within .12 of an inch either vertically or horizontally. Usually the default threshold value of 10 is sufficient.
- Select the method used to match the trigger–on the trigger string value and the text
block position, or on the position only:
- On string and X,Y position
- The trigger string value and horizontal and vertical position of the text block are matched. This is the default.
- On string and X position
- The trigger string value and horizontal position of the text block are matched.
- On string and Y position
- The trigger string value and vertical position of the text block are matched.
- On X,Y position only
- The horizontal and vertical position of the text block is matched.
- Click OK.If you created a supplemental page trigger on a page that was in a page group (unless the page group is an existing page group or created as a fixed-length page group), the supplemental page is removed from the page group.
- To modify or delete the supplemental page trigger, click .The trigger is listed as a Supplemental Page Definition under Page Triggers.
- Optional: To create an additional trigger for the supplemental page or to define a different supplemental page, repeat the steps.
1.3.1.5.2.2 Creating index tags on supplemental pages
- In AFP Visual Environment, open a sample AFP file. Then click .
- Select a page that is outside a page group.
- Click a text block or draw a box around a text area or address area that you want to index. The text blocks you can select are defined in the AFP file, from one character to the entire line of text. You see a red box around the data you selected.
- Right-click anywhere on the page and then click Create Index Tag or Create Index Tags for an Address.You see the Create Supplemental Page Index Tag window, Create Index Tags in an Area window, or Create Index Tags in an Address Area window.
- Follow the procedure in Creating index tags for text blocks, Creating index tags in areas, or Creating index tags in address areas and select an existing supplemental page definition from the drop-down list or type a new supplemental page definition name.
- Click OK when you are done creating the index tag.
- Verify that the correct index tag has been created:
- Right-click on the page in the left pane and click Properties.The name of the index tag and its value are listed in the TLE field.
- To close the Properties window, click X in the upper right corner.
- If the index tag is incorrect, click to modify or delete the tag.The index tag is listed as a Supplemental Page Definition under Page Indexes, Index areas, or Address Indexes.
- Right-click on the page in the left pane and click Properties.
- Optional: To create an additional index tag on the supplemental page or to define an index tag on a different supplemental page, repeat the steps.
1.3.1.5.3 Creating index tags
1.3.1.5.3.1 Creating index tags for text blocks
- If the AFP file does not contain page groups, create page groups. Otherwise, to create an index tag on a page outside a page group, see Creating index tags on supplemental pages.
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file that contains the text you want to index. Then click .
- Click the text that you want to use to mark specific data in each page group. The text blocks you can select are defined in the AFP file, from one character to the entire line of text. You see a red box around the text you selected.
- Right-click anywhere on the page and click Create Index Tag. You see the Create Index Tag window with the text to index in the Edited index value field.
- Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
- Type a descriptive name for the index tag in the Index tag name field. For example, if you select
Joe Smith
for the index tag, the name could beCustomer name
. - Decide whether you want to use the entire text value to create the index tag or specify
part of the text. You can edit the text block to reduce the number of characters you
use for the index value (you cannot increase the characters in a text block). To select
part of the text as the index tag:
- Click Edit index value.
- Edit the index value in the Edit Value window.For example, if the account number is one text block, 01-345678, you can create an index value with part of the account number, such as 345678.
- Click OK.
- Make sure Page group is selected as the index type.You also see the index type Page within page group, which is used to create an index tag on an individual page in a page group. See Creating page-level indexes.
- Click the Advanced tab to change the threshold to look for a text value that is in slightly different
positions on some pages. You can select a range from 1/100 to 1 inch or from 1 to
25 millimeters.Although text might appear to be present in the same location on each statement, slight position variations can occur in the AFP file. The threshold defines how far the text can be from the original location and be considered an index tag. For example, a threshold value of 12 indicates that the index tag can be located within .12 of an inch or 12 millimeters, either vertically or horizontally. Usually the default threshold value of 10 is sufficient (10 for inches or 2 for millimeters).
Keep in mind that if you increase the threshold above the default value, you might create an index tag you did not expect because the match is only done on location, so the first text block found in the threshold range is used as the index tag.
- Click OK. You see the index tags listed in the bottom pane for each page group.
- Verify that the correct index tag has been created:
- Double-click the index tag in the bottom pane and verify that the correct page in the page group is displayed.
- If the index tag is incorrect, click to modify or delete the tag.The index tag is listed as a Page Group Definition under Page Group Indexes.
1.3.1.5.3.2 Creating index tags in areas
The area must occur in a consistent location in each page group; however, it can consist of a variable number of lines. In the index area, you can create an index tag with text from more than one AFP text block on a line. You can concatenate the text in the text blocks, or separate the text with a blank or any other character. You can also edit the text to remove unwanted characters.
For example, a customer account number might occur on the first page of each page
group in three separate AFP text blocks on the same line. To create an index tag that
contains the entire account number, first you identify the account number area by
drawing a box around all three text blocks. Then you create one index tag with text
from all three text blocks, and you specify the character to use to separate the text
in each text block. If the text blocks contain account number 123
, 45
, and 678
, the index tag can contain: 12345678
, 123 45 678
, or 123-45-678
.
Notes:
- If the AFP file does not contain page groups, create page groups. Otherwise, to create an index tag for an area on a page outside a page group, see Creating index tags on supplemental pages.
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file that contains the text you want to index. Then click .
- To create the index area, position your cursor at a corner of the area that contains
text you want to index. While pressing the left mouse button, draw a box that includes
the text you want to index.The index area must include the first character in each AFP text block that you want to index; however, the area does not need to include all the characters in the AFP text blocks.
- Right-click anywhere on the page and click Create Index Tags.You see the Create Index Tags in an Area window.
- Check that the text you want to index is shown in the Lines in the area field. If the text is not shown, click Cancel and redraw the area on the page, or click the Position tab to adjust the origin and size of the index area.Note: If the text displays correctly in the AFP file but incorrectly in the Lines in the area field, try changing the default code page ( ). If the text still does not display correctly, this usually indicates that the code page does not use standard Unicode mapping. In this case, use the
SampleCodePointMap.cp
font-mapping file to create a code point map file before proceeding. - Optional: On the Position tab, change the origin (top-left corner) and size of the index area in these fields.
Decimal values (such as 2.5) are allowed. Specify the origin and size in inches or
millimeters.
- X position
- The horizontal distance of the left side of the area measured from the left side of the logical page (not the physical sheet of paper).
- Y position
- The vertical distance of the top of the area measured from the top of the logical page (not the physical sheet of paper).
- Width
- The horizontal width of the area.
- Height
- The vertical height of the area.
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the logical page in the unrotated view. - On the Index Tags tab, type a descriptive name for the area in the Index area name field.For example, if the area contains an account number, the name could be
Account number area
. - Specify the character or characters that you want to use to separate text blocks in
the Character between text blocks field.The default character that separates text blocks is one blank. If you want to concatenate the text in multiple text blocks, delete the blank from the field.In the Lines in the area field you see the text with the character that you specified (if any) shown between the text blocks.
- To create an index tag for the text shown in a line in the area:
- Click Add.
- Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
- Type a descriptive name for the index tag.For example, if the index tag contains an account number, the name could be
Account number
. - Select the line that contains the text you want to index:
- To select the first line or a line relative to the first line, click First line. Then use the drop-down list for this field to select a relative line. For example, select First line plus 1.
- To select the last line or a line relative to the last line, click Last line. Then use the drop-down list for this field to select a relative line. For example, select Last line minus 1.
You see the value of the index tag in the Edited value field. - Decide whether you want to use the entire text value to create the index tag or only part of the text. To select part of the text as the index tag, click Edit index value. Edit the index value in the Edit Value window and click OK.
- Clear the Create tag for an empty value field if you do not want AFP Indexer to create index tags with null values. Otherwise, an index tag contains the value
null
if the text that you indexed does not exist in a particular page group. For example, if a page group has an address that does not contain a country name, the index tag for country name isnull
for that page group. - Click OK.You see the index tag and the index tag value in the Index tags for specific lines field.
- Optional: To create another index tag with text on the same line or on a different
line, click Add again.You can create as many index tags as you want in the area.
- Click OK.You see the index tags listed in the bottom pane for each page group.
- Verify that the correct index tags have been created:
- Double-click the index tags in the bottom pane and verify that the correct pages in the page groups are displayed.
- If an index tag is incorrect, click to modify or delete the tag.The index tag is listed under.
1.3.1.5.3.3 Creating index tags in address areas
The area must occur in a consistent location in each page group; however, it can consist of a variable number of lines. In the area, you can create an index tag for a ZIP Code that is in the U.S. Postal Service format.
For example, a customer address might consist of either 3 or 4 lines, with the ZIP Code always on the last line. First you identify the location and size of the address area by drawing a box around an address that contains the maximum lines in the address: in this example, 4 lines. If the sample AFP file does not have an address with the maximum number of lines, draw a box large enough to include all possible lines in the address area. If you know the exact position and size of the address area, you can adjust the size of the box you drew by specifying the exact X offset, Y offset, height, and width of the address area. (X and Y offsets are from the origin of the logical page, not the physical sheet of paper.)
Notes:- If the AFP file does not contain page groups, create page groups. Otherwise, to create an index tag for an address area on a page outside a page group, see Creating index tags on supplemental pages.
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
Next you can create index tags for text on specific lines: the customer name on the first line, the city on the last line, and the state on the last line. Then you can create multiple index tags for the intermediate lines that contain the street address. Intermediate lines are the lines between the specific lines that you indexed. The address area can contain a variable number of intermediate lines, as shown:
JOHN SMITH <-- first line 123 MAIN STREET <-- intermediate line 1 SUITE 100 <-- intermediate line 2 (optional line) DENVER, CO 12345-6789 <-- last line
If the ZIP Code is in the U.S. Postal Service format (nnnnn or nnnnn-nnnn), AFP Indexer can automatically extract the ZIP Code on a line and create an index tag for it.
- In AFP Visual Environment, open a sample AFP file that contains the addresses that you want to index in the format that you want to index. Then click .
- Navigate to an address that contains the maximum number of lines.If you cannot find an address with the maximum number of lines, in the next steps either draw a larger area or specify the exact size of the address area on the Position tab to include the maximum number of lines.
- To create the address area, position your cursor at a corner of the area that contains
the entire address. While pressing the left mouse button, draw a box that includes
all the lines in the address.The address area must include the first character in the AFP text blocks that you want to index; however, it does not need to include all the text because text blocks can contain text of variable length in different page groups. For example, a text block that contains a customer name might contain a short name in one page group and a long name in another page group.
- Right-click anywhere on the page and click Create Index Tags for an Address.You see the Create Index Tags in an Address Area window.
- Check that the text you want to index is shown in the Index tags for intermediate lines field. If the text is not shown, click Cancel and redraw the area on the page, or click the Position tab to adjust the origin and size of the address area.Note: If the text displays correctly in the AFP file but incorrectly in the Index tags for intermediate lines field, try changing the default code page ( ). If the text still does not display correctly, this usually indicates that the code page does not use standard Unicode mapping. In this case, use the
SampleCodePointMap.cp
font-mapping file to create a code point map file before proceeding. - Optional: On the Position tab, change the origin (top-left corner) and size of the address area in these fields.
Decimal values (such as 2.5) are allowed. Specify the values in inches or millimeters.
- X position
- The horizontal distance of the left side of the area measured from the left side of the logical page (not the physical sheet of paper).
- Y position
- The vertical distance of the top of the area measured from the top of the logical page (not the physical sheet of paper).
- Width
- The horizontal width of the area.
- Height
- The vertical height of the area.
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the logical page in the unrotated view. - On the Index Tags tab, type a descriptive name for the area in the Index area name field.For example, if the area contains the customer's address, the name could be
Customer address area
. - Specify the character or characters that you want to use to separate text blocks in
the Character between text blocks field.The default character that separates text blocks is one blank. If you want to concatenate the text in multiple text blocks, delete the blank from the field.In the Index tags for intermediate lines field you see the text with the character that you specified, if any, shown between the text blocks.
- Optional: To create an index tag for a specific line in the area:
- Click Add.
- Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
- Type a descriptive name for the index tag.For example, if the line contains the customer name, the name could be
Customer
. - Select the line that contains the text you want to index:
- To select the first line or a line relative to the first line, click First line. Then use the drop-down list for this field to select a relative line. For example, select First line plus 1.
- To select the last line or a line relative to the last line, click Last line. Then use the drop-down list for this field to select a relative line. For example, select Last line minus 1.
- Decide whether you want to use the entire text value to create the index tag or only
part of the text. To select part of the text as the index tag, click Edit index value. Edit the index value in the Edit Value window and click OK.You see the value of the index tag in the Edited value field.
- Clear the Create tag for an empty value field if you do not want AFP Indexer to create index tags with null values.Otherwise, an index tag contains the value
null
if the text that you indexed does not exist in a particular page group. For example, if a page group has an address that does not contain a country name, the index tag for country name isnull
for that page group. - Click OK.You see the index tag and the index tag value in the Index tags for specific lines field.
- Optional: To create another index tag with text on the same line or on a different
line, click Add again.You can create as many index tags for specific lines as you want in the area.
- Optional: To create index tags for the lines that are shown in the Index tags for intermediate lines field:
- Click Index intermediate lines.
- Specify the name for the index tags in the Index tag name field. For example, the name could be
Street
. - Use the drop-down box next to the Index tag name field to select the number to append to the index tag for the first intermediate line.
- Use the default code page encoding or select an encoding from the drop-down list.
AFP Indexer creates index tags for each intermediate line in the area; for example:Street1
andStreet2
. AFP Indexer does not create index tags for intermediate lines that do not exist in a page group. For example, if the address in a particular page group does not contain the second intermediate line in the street address, AFP Indexer only creates index tagStreet1
. - Optional: To create an index tag for a ZIP Code in the U.S. Postal Service format
(nnnnn or nnnnn-nnnn):
- Click the ZIP Code tab.You see the ZIP Code in the ZIP Code field.
- Type a descriptive name for the index tag.For example, the name could be
ZIP Code
. - Use the default code page encoding or select an encoding from the drop-down list.
- Clear the Create tag for an empty value field if you do not want AFP Indexer to create an index tag with a
null
value. Otherwise, if the ZIP Code does not exist in a particular page group, the index tag for that page group contains the valuenull
.
- Click the ZIP Code tab.
- Click OK. You see the index tags listed in the bottom pane for each page group.
- Verify that the correct index tags have been created:
- Double-click the index tags in the bottom pane and verify that the correct pages in the page groups are displayed.
- If an index tag is incorrect, click to modify or delete the tag.The index tag is listed under.
1.3.1.5.3.4 Creating index tags from NOP records
NOP records can be found anywhere in a page group–either on a page in the page group or outside the logical AFP pages. You can create index tags for NOP records that are in the same position in all page groups, but outside a page, or you can create index tags for specific NOP records that are in any location in the page groups–on a page or outside a page.
A NOP record causes an application to move to the next instruction for processing without taking any other action. Some applications put information about individual documents in NOP records so that the information is not printed, but it can be worked with. Though NOP records in the AFP file are not viewable or printable, you can create index tags from them as long as they are associated with a page group or a page in a page group.
- In AFP Visual Environment, open a sample AFP file. Then click .
- If the AFP file does not contain page groups, create page groups.
- Click .
You see the Select NOP by String window. This option lets you use selection criteria to search for NOP records in any location in the page groups and create index tags from the specified NOP record. Do these:
- Optional: If the text in the NOP record does not look correct, click ASCII to change the NOP encoding; EBCDIC is the default.
- From the drop-down list, view the NOPs available for selection.
- Type a string in the Search String field to identify the NOP you want to use to create an index tag. The field is case-sensitive. For example, if you want to index a NOP record that contains an account number, specify a string of characters that uniquely identify the NOP record.
- Select a number in the Select first character position field until the NOP record you want is displayed in the Matching NOP field.
- Click OK. You see the Create Index Tag window with the NOP text to index in the Edited value field.
- Create the index tag:
- Type a descriptive name for the index tag in the Index tag name field.
- Optional: To edit the text value and select part of the text as the index tag, click Edit index value. Edit the index value in the Edit Value window and click OK.
- Click OK.In the bottom pane, you see the index tag listed if the NOP record is on a page in the page group.
- Optional: To create additional index tags, repeat the steps.
- If an index tag is incorrect, click to modify or delete the tag.The NOP index tag is listed under.
1.3.1.5.4 Working with page-level indexes
page definitionin AFP Indexer refers to a page-level trigger, a page-level index, or a supplemental page definition, not the AFP page definition resource.
1.3.1.5.4.1 Creating page-level triggers
You can create one or more triggers on an individual page, with the same or different page definition names. AFP Indexer defines a page if it finds all the triggers with the same page definition name.
- In AFP Visual Environment, open a sample AFP file. Then click .
- Select a page in a page group.
- Click the text that you want to use as a trigger.You see a red box around the text you selected.
The text blocks you can select are defined in the AFP file, from one character to the entire line of text. For example, the text
Account Summary
might be defined as two text blocks. You can click either theAccount
orSummary
text block to create a trigger. - Right-click the text and click Create Trigger.You might see a message that says the page groups might change or the index tags might be invalid and asks if you want to continue. Click Yes.You see the Create Trigger window with the selected text in the Edited trigger field.Note: You might need to use the scroll arrows to see the text in the Edited trigger field.
- Decide whether you want to use the entire text value as the page-level trigger or
only part of the text. You can edit the text value to reduce the number of characters
you use for the trigger value. To select part of the text as the trigger:
- Click Edit trigger.
- Edit the trigger value in the Edit Value window.
- Click OK.
- Click Page for the trigger type.You see the Select page definition field.
- Type a name to identify the page or select a name from the drop-down list.
- Click the Advanced tab to change the text threshold, the method for matching the trigger, or both:
- Select a range from 1/100 to 1 inch for the text threshold. Although text might appear to be present in the same location, slight position variations can occur in the AFP file. You can change the threshold to look for trigger text that is in slightly different positions on some pages. The threshold defines how far the text can be from the original location and be considered a trigger. For example, a threshold value of 12 indicates that the trigger can be located within .12 of an inch either vertically or horizontally. Usually the default threshold value of 10 is sufficient.
- Select the method used to match the trigger–on the trigger string value and the text
block position, or on the position only:
- On string and X,Y position
- The trigger string value and horizontal and vertical position of the text block are matched. This is the default.
- On string and X position
- The trigger string value and horizontal position of the text block are matched.
- On string and Y position
- The trigger string value and vertical position of the text block are matched.
- On X,Y position only
- The horizontal and vertical position of the text block is matched.
- Click OK.
- Click to modify or delete the trigger.The trigger is listed under.
- Optional: To create an additional trigger, repeat the steps.
1.3.1.5.4.2 Creating page-level indexes
- In AFP Visual Environment, open a sample AFP file. Then click .
- If the AFP file does not contain page definitions in page groups, create one or more page-level triggers.
- Select a page in a page group.
- Click the text that you want to index. The text blocks you can select are defined in the AFP file, from one character to the entire line of text. You see a red box around the text you selected.
- Right-click the text and click Create Index Tag. You see the Create Index Tag window with the text to index in the Edited index value field.
- Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
- Type a descriptive name for the index tag in the Index tag name field. For example, if you select
Joe Smith
for the index tag, the name could beCustomer name
. - Click Page within page group for the index type.You see the Select index value type and Select page definition fields.
- Select the index value type:
- AFP file
- The index value is displayed in the Edited index value field. Decide whether you want to use the entire text value as the page-level index
or only part of the text. You can edit the text block to reduce the number of characters
you use for the index value (you cannot increase the characters in a text block).
To select part of the text as the index tag:
- Click Edit index value.
- Edit the index value in the Edit Value window. For example, if the account number
is one text block,
01-345678
, you can create an index value with part of the account number, such as345678
. - Click OK.
- User defined
- The User defined value field is displayed. Type the text you want for the index tag.
- Select an existing page definition from the drop-down list.
- Click the Advanced tab to change the threshold to look for a text value that is in slightly different
positions on some pages. You can select a range from 1/100 to 1 inch or from 1 to
25 millimeters. Although text might appear to be present in the same location on each
page, slight position variations can occur in the AFP file. The threshold defines
how far the text can be from the original location and be considered an index tag.
For example, a threshold value of 12 indicates that the index tag can be located within
.12 of an inch or 12 millimeters, either vertically or horizontally. Usually the default
threshold value is sufficient (10 for inches or 2 for millimeters).
Keep in mind that if you increase the threshold above the default value, you might create an index tag you did not expect because the match is only done on location, so the first text block found in the threshold range is used as the index tag.
- Click OK.
- Verify that the correct index tag has been created:
- Right-click on the page in the left pane and click Properties.The name of the index tag and its value are listed in the TLE field.
- To close the Properties window, click X in the upper right corner.
- If the index tag is incorrect, click to modify or delete the tag. Page-level indexes are listed under .
- Right-click on the page in the left pane and click Properties.
1.3.1.5.4.3 Copying or moving page-level indexes to page groups
- In AFP Visual Environment, open a sample AFP file. Then click .
- Select a page that is within a page group.
- Click .You see the Copy Page Indexes to Page Group window. The Current Page field displays the page you selected in the page group.
- From the drop-down list, select which page-level index tags you want to add to the
page group:
- This page
- Adds all the page-level index tags from the current page to the page group. For example, if "5" is the current page, adds all the index tags from page 5 to the page group for each page group in the file that contains a page 5.
- This and following pages
- Adds all the page-level index tags from the current page, and all pages that follow the current page, to the page group. For example, if "3" is the current page and "5" is the last page in the page group, all the index tags on page 3, page 4, and page 5 are added to the page group for each page group in the file that contains those pages.
- Last page
- Adds all the page-level index tags from the last page to the page group.
- To move the page-level index tags to the page group, clear the Keep indexes in page field. Otherwise, the page-level index tags are copied to the page group.
- Click OK.In the bottom pane, you see the index tags that have been added to the page groups.
- Optional: To remove the index tags that you added to a page group:
- Click .You see the Copy Page Indexes to Page Group window with the selections you previously made.
- Click Delete.The index tags are removed from the page group.
- Click .
1.3.1.5.5 Modifying or deleting AFP Indexer definitions
1.3.1.5.5.1 Modifying triggers
- Note:
- Be careful modifying triggers if you have made other enhancements to the sample AFP file. For example, if you have created index tags and you modify the page group triggers, the index tags might become invalid. In addition, other types of definitions in the control file (for example, barcodes created with AFP Editor) might not work properly if they are based on the page groups or index tags created with AFP Indexer.
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
To modify a trigger definition:
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the triggers. Then click .
- Click .You see the Modify and Delete Definitions window.
- Select the name of the trigger that you want to modify.
- Click Modify, or double-click.You see the Modify Trigger window.
- To edit the trigger value, click Edit trigger. Edit the trigger value in the Edit Value window and click OK.
- Click the Advanced tab to change the text threshold, the method for matching the trigger, or both:
- Select a range from 1/100 to 1 inch or from 1 to 25 millimeters for the text threshold.
- Select the method used to match the trigger–on the trigger string value and the text block position, or on the position only.
- Click OK. In the left pane and in the bottom pane, you see the page groups that have been defined based on the trigger value. You also see the pages that are included in each page group.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.5.5.2 Deleting triggers
To delete a trigger definition:
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the triggers. Then click .
- Click .You see the Modify and Delete Definitions window with trigger and index tag definitions.Note: You can only delete trigger definitions that exist in the control file. If page groups are displayed in the left pane but no trigger definitions are listed in the Modify and Delete Definitions window, the page groups are defined in the AFP file itself. To remove page groups that are defined in the AFP file, create a new page-group trigger or create fixed-length page groups. This automatically removes any page groups defined in the AFP file. To remove nested page groups that are defined in the AFP file, click.
- Select the trigger that you want to delete.
- Click Delete, or press the Delete key on your keyboard.You see a message that asks if you want to continue.
- Click Yes.The trigger is removed from the definitions list.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.5.5.3 Modifying index tags for text blocks
To modify an index tag for a text block:
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click .
- Click .You see the Modify and Delete Definitions window with index tags.Note: You can only modify index tags that exist in the control file. If index tags are displayed in the bottom pane but not in the Modify and Delete Definitions window, the index tags exist in the AFP file itself and you cannot modify them.
- Select the index tag that you want to modify.
- Click Modify, or double-click.You see the Modify Index Tag window, Modify Page Index Tag window, or Modify Supplemental Page Index Tag window, depending on which type of index tag you are modifying.
- To change the name of the index tag, type a new name in the Index tag name field.
- To change the code page encoding, select an encoding from the drop-down list.This field is not displayed for NOP index tags.
- To edit the index value, click Edit index value. Edit the index value in the Edit Value window and click OK.
- Click the Advanced tab, if present, to change the text threshold to look for a text value that is in
slightly different positions on some pages.You can select a range from 1/100 to 1 inch or from 1 to 25 millimeters.
Keep in mind that if you increase the threshold above the default value, you might create an index tag you did not expect because the match is only done on location, so the first text block found in the threshold range is used as the index tag.
- Click OK. You see the index tags listed in the bottom pane for each page group.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.5.5.4 Modifying index tags in areas
To modify index tags in an area:
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click .
- Click .You see the Modify and Delete Definitions window with index areas.
- Select the index area that you want to modify.
- Click Modify, or double-click.You see the Modify Index Tags in an Area window.
- To change the characters that separate the text blocks, specify the new character
or characters in the Character between text blocks field.The default character that separates text blocks is one blank. If you want to concatenate the text in multiple text blocks, delete the blank from the field.In the Lines in the area field you see the text with the character that you specified (if any) shown between the text blocks.
- To add an index tag for a specific line in the area:
- Click Add.You see the Create Index Tag window.
- Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
- Type a descriptive name for the index tag.
- Select the line that contains the text you want to index:
- To select the first line or a line relative to the first line, click First line. Then use the drop-down list for this field to select a relative line. For example, select First line plus 1.
- To select the last line or a line relative to the last line, click Last line. Then use the drop-down list for this field to select a relative line. For example, select Last line minus 1.
You see the value of the index tag in the Edited value field. - Decide whether you want to use the entire text value to create the index tag or only part of the text. To select part of the text as the index tag, click Edit index value. Edit the index value in the Edit Value window and click OK.
- Clear the Create tag for an empty value field if you do not want AFP Indexer to create index tags with null values. Otherwise, an index tag contains the value
null
if the text that you indexed does not exist in a particular page group or supplemental page. For example, if a page group has an address that does not contain a country name, the index tag for country name isnull
for that page group. - Click OK.You see the index tag and the index tag value in the Index tags for specific lines field.
- Click Add.
- To change or delete an existing index tag for a specific line in the area, click the
index tag in the Index tags for specific lines section (use the CTRL key to select more than one index tag) and do one of these:
- Click Modify. Make changes to the index tag in the Modify Index Tag window and then click OK.
- Click Delete to remove all index tags you selected.
- To adjust the origin and size of the address area, click the Position tab.Decimal values (such as 2.5) are allowed.Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the logical page in the unrotated view.
- Click OK. You see the index tags listed in the bottom pane for each page group.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.5.5.5 Modifying index tags in address areas
To modify index tags in an address area:
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click .
- Click .You see the Modify and Delete Definitions window with address indexes.
- Select the address index that you want to modify.
- Click Modify, or double-click.You see the Modify Index Tags in an Address Area window.
- To change the characters that separate the text blocks, specify the new character
or characters in the Character between text blocks field.The default character that separates text blocks is one blank. If you want to concatenate the text in multiple text blocks, delete the blank from the field.In the Index tags for intermediate lines field you see the text with the character that you specified (if any) shown between the text blocks.
- To add an index tag for a specific line in the address area:
- Click Add.You see the Create Index Tag window.
- Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
- Type a descriptive name for the index tag.
- Select the line that contains the text you want to index:
- To select the first line or a line relative to the first line, click First line. Then use the drop-down list for this field to select a relative line. For example, select First line plus 1.
- To select the last line or a line relative to the last line, click Last line. Then use the drop-down list for this field to select a relative line. For example, select Last line minus 1.
- Decide whether you want to use the entire text value to create the index tag or only
part of the text. To select part of the text as the index tag, click Edit index value. Edit the index value in the Edit Value window and click OK.You see the value of the index tag in the Edited value field.
- Clear the Create tag for an empty value field if you do not want AFP Indexer to create index tags with null values. Otherwise, an index tag contains the value
null
if the text that you indexed does not exist in a particular page group or supplemental page. For example, if a page group has an address that does not contain a country name, the index tag for country name isnull
for that page group. - Click OK.You see the index tag and the index tag value in the Index tags for specific lines field.
- Click Add.
- To change or delete an existing index tag for a specific line in the address area,
click the index tag in the Index tags for specific lines section (use the CTRL key to select more than one index tag) and do one of these:
- Click Modify. Make changes to the index tag on the Modify Index Tag window and then click OK.
- Click Delete to remove all index tags you selected.
- Do one of these to specify whether lines in the Index tags for intermediate lines field are indexed:
- Click Index intermediate lines and specify an index tag name to create index tags for intermediate lines.
- Clear Index intermediate lines to delete the index tags for intermediate lines.
- To specify whether an index tag is created for a ZIP Code in the U.S. Postal Service
format (nnnnn or nnnnn-nnnn), click the ZIP Code tab and do one of these:
- Type an index tag name or update the existing name to create an index for the ZIP
Code. Clear the Create tag for an empty value field if you do not want AFP Indexer to create an index tag with a
null
value. - Delete the name of the index tag in the Name field to delete the ZIP Code index.
- Type an index tag name or update the existing name to create an index for the ZIP
Code. Clear the Create tag for an empty value field if you do not want AFP Indexer to create an index tag with a
- Click the Position tab to adjust the origin and size of the address area. Decimal values (such as 2.5)
are allowed. Specify the values in inches or millimeters.Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the logical page in the unrotated view.
- Click OK. You see the index tags listed in the bottom pane for each page group.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.5.5.6 Deleting index tags
To delete an index tag:
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click .
- Click .You see the Modify and Delete Definitions window with index tags.Note: You can only delete an index tag that is defined in the control file. If index tags are displayed in the bottom pane but not in the Modify and Delete Definitions window, the index tags are defined in the AFP file itself. To delete all the index tags that are defined in the AFP file, click.
- To delete an index tag that was created for a line in an index area or address area,
or a ZIP Code in an address area:
- Select the index name for an index area or address area, and then click Modify.You see the Modify Index Tags in an Area window or Modify Index Tags in an Address Area window. Do one or more of these:
- To delete the index tags for specific lines, select the index tag in the Index tags for specific lines section (use the CTRL key to select more than one index tag) and click Delete. The index tag is removed from the list.
- To delete the index tags for intermediate lines in an address area, clear the Index intermediate lines field.
- To delete the index tag for a ZIP Code in an address area, click the ZIP Code tab and remove the name of the index tag in the Name field.
- Click OK.The index tags are removed from the list in the bottom pane.
- Select the index name for an index area or address area, and then click Modify.
- To delete an index tag definition, including all index tags created for an index area
or address area:
- Select the index definition you want to delete.
- Click Delete or press the Delete key on your keyboard.The index tag definition is removed from the definitions list and, if it was a page group index, from the bottom pane.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.5.6 Using existing page groups and index tags
You can also choose whether to use the existing index tags. If you do not tell AFP Indexer whether to use existing page groups and index tags, all existing page groups and index tags are used unless you create new page groups.
In most cases, if an AFP file contains page groups, you should use them. If you use the existing page groups, you cannot change the page group boundaries. However, you can create additional index tags and modify existing tag values.
To use existing page groups and index tags:
- In AFP Visual Environment, open a sample AFP file. Then click .
- Click .You might see a message that says the page groups and indexes might change or be invalid and asks if you want to continue. Click Yes. You see the Use Existing Page Groups window.
- In the Use page group level field, select a number, 0 to 20, for the levels in the page group structure that
you want to keep.Note: To keep all page groups, select 0. Select a number greater than 0 only if you have nested page groups.
For example, the first figure shows a page group structure with two levels. To keep the page groups in all of the levels, select 0. However, to keep only the page groups in the second level (and any levels below it), select 1. The second figure shows the new page structure after you select 1.
- To remove the index tags that are defined in the AFP file, clear the Use index tags box.
- Click OK.You see the page groups and index tags that you chose to use in the AFP file.
1.3.1.5.7 Editing text for triggers and index tags
- In AFP Visual Environment, open a sample AFP file. Then click .
- Do one of these to open the Edit Value window:
- Click Edit. . Select an index tag from the drop-down list and click
- When creating or modifying a trigger or index tag, click one of these: Edit index value, Edit trigger, or Edit value.
- Select On for one or more of these options:
Edit by stripping characters Type one character or a blank that you want to remove from the value. Remember that the character is case-sensitive. Then, select one of these buttons: - Strip leading characters
- The specified character is removed from the beginning of the value. For example, if you type a blank character, all blanks are removed from the beginning of the value.
- Strip trailing characters
- The specified character is removed from the end of the value. For example, if you type a blank character, all blanks are removed from the end of the value.
- Strip leading and trailing characters
- The specified character is removed from the beginning and end of the value. For example, if you type a blank character, all blanks are removed from the beginning and end of the value.
- Strip all characters
- The specified character is removed from all positions in the value. For example, an account number is: 324-1443255-11. You can type a - to strip all - characters from the value.
Edit on delimiter Type a text string of one or more characters or blanks in the Specify delimiter string field to indicate where the text value is split into separate strings. Remember that the text is case-sensitive. Then select numbers for Select first string and Select number of strings to mark the beginning and end of the edited text. For example, an account number is: 324-1443255-11. You can use - as the delimiter to split the value into these three strings: 324, 1443255, and 11. To select the second and third strings, 1443255-11, select 2 for both Select first string and Select number of strings.
Edit on character Select numbers for Select first character position and Select number of characters to indicate the first character in the text value and how many characters are included. When you select the options in the window, the text value for the current page group, page in a page group, or supplemental page is edited based on your selections and the new value is displayed in the Edited text field.Note: The edit options are done in this order:- Edit by stripping characters
- Edit on delimiter
- Edit on character
- Click OK.You see one of these:
- If you are creating or modifying a trigger or index tag, the new value is displayed in one of these fields: Edited index value, Edited trigger, or Edited value.
- If you are editing an existing index tag, you see an asterisk (*) next to the index
tag that you edited. You also see that Delete is now displayed in the window.
Do this:
- Optional: To undo the edit you did to the index tag, click Delete. The index tag reverts to the original text and the asterisk (*) is removed from the drop-down list. Delete is not displayed in the window if the drop-down list does not have any asterisks.
- Click OK.
1.3.1.5.8 Managing comments
- In AFP Visual Environment, open a sample AFP file.
- Click .
- Click .
You see a list of comments, if any, in the AFP Indexer portion of the AFP Visual Environment control file.
- To add a comment:
- Click Add Comment.
- Type the text of the comment.
- Click OK.
- To delete a comment:
- Click the text of the comment.
- Press the Delete key on your keyboard.
- When you finish managing comments, click OK.
- Save the control file.
AFP Visual Environment puts each comment inside <Comment></Comment> tags near the top of the AFP Indexer portion of the control file.
1.3.1.6 Editing AFP files
1.3.1.6.1 Creating barcodes
The barcode must be in a consistent position on every page and must be a consistent size. If text, an image, or another barcode already exists in the area where you want to create a barcode, first hide the area so that the existing text, image, or barcode does not print.
To determine the exact origin and size of the barcode area, work from a copy of the sample AFP file printed on the production printer. Measure where you want to place the top-left corner of the barcode area (X and Y positions) on the printed page from the top-left corner of the logical page. For BCOCA barcode objects, also measure the width and height of the area.
- In AFP Visual Environment, open a sample AFP file.
- If the file does not contain page groups or index tags for variable values (such as ZIP Codes) that you want to use in barcode data, use AFP Indexer to create page groups and index tags.
- Click .
- Navigate to the page where you want to create the barcode:
- To place a barcode on the same page in every page group, navigate to that page in any page group.
- To place a barcode on multiple pages (for example, on even pages in every page group), navigate to one of the pages in any page group.
- Position your cursor at a corner of the barcode area. While pressing the left mouse
button, draw a box the approximate size of the barcode area. You can draw a horizontal,
vertical, or square box.
In a later step, you can specify the exact position and size of the barcode area.
- Right-click anywhere in the AFP file and click Create barcode.
You see the Create Barcode window.
- On the Type tab, type a name for the area, select the type, and specify other properties.
For a description of the fields, see the information center topic about the Type tab.
- On the Data tab, specify the data to be encoded in the barcode symbol.
For a description of the fields, see the information center topic about:
-
Data tab for Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcodes
-
Data tab for IMBs
-
- On the Position tab, specify the exact origin and size of the barcode area, the orientation of the
barcode symbol within the area, and on which pages to place the barcode in each page
group.
For a description of the fields, see the information center topic about the Position tab.
- Click OK.
If you have more than one barcode defined, you might see the Create Conditions between Definitions window. Click Yes if you want to create a condition for determining which barcode is used, and then click OK.
If you created an Intelligent Mail barcode (IMB), POSTNET, or QR Code barcode, you see the barcode symbol in the AFP file. If you created a Code 39, Data Matrix, Interleaved 2-of-5, or PDF417 barcode, you see a box surrounding the barcode area with the title of the barcode area in the orientation that you selected for the barcode symbol.
Note: If you created a text IMB but do not see the barcode symbol, identify the resource directory that contains the AFP IMB font to AFP Visual Environment ( ). The AFP IMB font (character set C0XMUS23) is installed in theinstall_directory/resources
directory. - If you see an error message, the barcode is not created in any page group. In addition,
no other barcodes, hidden areas, or text masks are created. If the Create Barcode window is open, correct the barcode properties.
If the Create Barcode window is already closed, click to correct the properties.
(In the Modify and Delete Definitions window, identifies the barcode with the error.)
If you included index tag values in the barcode data and the error message indicates that barcode data is too long or contains characters that are not valid, you might need to modify the index tag to correct the problem.
1.3.1.6.1.1 Type tab
Fields on the Type tab
Field | Value | Description |
---|---|---|
Barcode name | Any combination of a-z, A-Z, 0–9, special characters, and blanks. | The name of the barcode area. For example, if the barcode is an Intelligent Mail barcode
(IMB), you could name the barcode IMB. |
Barcode type | Code 39 (3-of-9 Code) | A low-density barcode that can encode uppercase letters, numbers, and some special characters. |
Data Matrix | A two-dimensional (2D) barcode consisting of black and white square modules arranged in either a square or rectangular pattern. This barcode uses the Solomon-Reed error correction algorithm (ECC 200) to ensure data reliability. | |
Intelligent Mail (IMB) | A barcode defined by the United States Postal Service (USPS) that is used to direct and track mail. This barcode was previously called a USPS Four-State barcode. | |
Interleaved 2-of-5 | A high-density barcode that can encode numbers. | |
PDF417 | A two-dimensional (2D) barcode that consists of several rows, each of which is like a small linear barcode. The barcode can detect and correct errors. | |
POSTNET | A barcode defined by the USPS that is used to direct mail. | |
QR Code | A two-dimensional (2D) matrix barcode that consists of black and white square modules
arranged in a square pattern. The contents of this Quick Responsecode can be decoded at high speed. This barcode uses the Solomon-Reed error correction algorithm (ECC 200) to ensure data reliability. |
|
Barcode representation | Output type | |
BCOCA object | AFP Editor creates barcode objects using Bar Code Object Content Architecture (BCOCA) structured
fields. In general, BCOCA barcodes are preferred to text barcodes. However, some older
printers cannot process newer barcode types. For example, IBM 3900 printers cannot
process IMBs. In this case, text barcodes are required.
This is the default. |
|
Text barcode | AFP Editor creates text barcodes that use the AFP barcode font.
Notes:
|
|
Output size | ||
Optimal Size | AFP Editor creates BCOCA barcodes so they are displayed in the best size for viewing and printing.
This is the default.
Note: This option is currently available only for IMBs.
|
|
Compact Size | AFP Editor creates BCOCA barcodes so they are displayed in a compact size.
Note: This option is currently available only for IMBs.
|
This table describes the fields on the Type tab that let you specify barcode properties. The fields differ for each barcode type.
Fields on the Type tab for barcode properties
Barcode type | Field | Description |
---|---|---|
Code 39 (3-of-9 Code) | Include check digit | A check digit ensures data integrity during the bar coding reading process. If you select Yes, a check digit is included in the barcode symbol. |
Data Matrix | Number of rows | The number of rows in the barcode including the finder pattern. If you select Auto, an appropriate number of rows is used for the amount of data in the barcode symbol. |
Row size | The number of modules in each row including the finder pattern. The row sizes you can select depend on the number of rows. If you select Auto, an appropriate row size is used for the amount of data in the barcode symbol. | |
Intelligent Mail (IMB) | None | None |
Interleaved 2-of-5 | Include check digit | A check digit ensures data integrity during the bar coding reading process. If you select Yes, check digit is included in the barcode symbol. |
PDF417 | Row size | The number of data symbol characters in each row. The printer creates the minimum number of rows necessary for the amount of data in the barcode symbol. |
POSTNET | ZIP Code barcode | The barcode symbol consists of a leading frame bar, the encoded ZIP Code data, a correction digit, and a trailing frame bar. The ZIP Code data is a 5-digit number. |
ZIP Code+4 barcode | The barcode symbol consists of a leading frame bar, the encoded ZIP+4 data, a correction digit, and a trailing frame bar. The ZIP+4 data is a 9-digit number. | |
Advanced Bar Code (ABC) | The barcode symbol consists of a leading frame bar, the encoded ABC data, a correction digit, and a trailing frame bar. The ABC data is an 11-digit number. | |
Variable-length barcode | The barcode symbol consists of a leading frame bar, the encoded data, a correction digit, and a trailing frame bar. The encoded data is variable length. | |
QR Code | Size | The size of the barcode symbol, represented by the number of modules in each row and
column. The values are 21x21 to 177x177, or smallest, which indicates the smallest size that can include all data. |
1.3.1.6.1.2 Data tab for Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcodes
Fields on Data tab
Field | Value | Description |
---|---|---|
Text | Any valid characters for the barcode type (see next table) | The text that you want to encode in the barcode symbol. For example, you could use a blank character to separate multiple index tags. (A blank is not a valid character in all barcode types.) This value is the same in all page groups. |
Index tag | An index tag name | The index tag whose value you want to encode in the barcode. For example, you might want to encode a routing code that you previously indexed. The barcodes will contain the value of the index tag in the page group. This value can be different in each page group, but is the same for all pages in a page group. |
Property | A property name |
The property you want to encode in the barcode. The barcodes will contain the value of the property. This value is the same in all page groups. |
Include HRI | Above barcode symbol | Indicates that human-readable interpretation (HRI) is to be printed above the barcode symbol. This field is visible only for barcode types that support HRI: Code 39 and Interleaved 2-of-5. |
Below barcode symbol | Indicates that human-readable interpretation (HRI) is to be printed below the barcode symbol. This field is visible only for barcode types that support HRI: Code 39 and Interleaved 2-of-5. | |
Code page encoding | A defined code page encoding | The code page used to encode the barcode. You can only select an encoding from the drop-down list for QR Code barcodes. |
This table shows the characters that are valid for each type of barcode.
Valid characters for barcodes
Barcode type | Valid characters | Total number of characters |
---|---|---|
Code 39 (3-of-9 Code) |
0123456789 ABCDEFGHIJKLM NOPQRSTUVWXYZ - . $ / + % space character |
0 to 50 characters |
Data Matrix | Any one-byte character, or binary data | 0 to 3116 characters |
Interleaved 2-of-5 | 0123456789 | 0 to 50 characters |
PDF417 | Any one-byte character, or binary data | 0 to 2710 characters |
POSTNET | 0123456789 | The number of digits depends on the barcode property selected on the Type tab:
|
QR Code | Any one-byte character, or binary data | 0 to 3116 characters |
1.3.1.6.1.3 Data tab for IMBs
Fields on the Data tab for IMBs
Field | Value | Description |
---|---|---|
Barcode ID* | 00 - 50 | Optional Endorsement Line (OEL) sort level and exception handling. |
Service type ID* | 040 - 782 | Type of mail and any mail services requested. |
Mailer ID* | 0, 6, or 9 digits | A 6 or 9-digit mailer ID obtained from the United States Postal Service (USPS).
Note: You can use the Mailer ID field for other purposes in an IMB used for reply mail.
|
Serial number* | A 6 or 9-digit serial number that identifies the mailpiece. The length depends on
the number of digits specified for mailer ID. The mailer ID and serial number together
can contain 15 digits.
Note: AFP Editor adds leading zeroes to the value in this field so that the value in the Mailer ID and Serial number fields together contain 15 digits.
|
|
Zeroes | AFP Editor creates a serial number that contains zeroes. Mailers who use only the USPS Basic servicesoption can use serial numbers with zeroes. |
|
Index tag | The name of an index tag that contains the serial number. | |
File name | The full path name of an IMB serial number file that contains the serial number to be encoded in the first barcode in the AFP file. AFP Editor increments the serial number in the file by 1 for each barcode. | |
Routing code* | The routing code (also called routing ZIP Code and delivery point ZIP Code) of the recipient of the mailpiece. The routing code, if one is specified, can contain 5, 9, or 11 digits. | |
Index tag | The name of an index tag that contains the routing code. If blank, AFP Editor does not include a routing code in the barcode.
Note: AFP Editor removes any non-numeric characters from the value in the index tag before encoding
it in the barcode symbol. For example, if the value of the index tag in a page group
is
12345–6789, the value in the barcode symbol is 123456789. |
|
Create index tag | Save | Indicates that AFP Editor is to create an index tag that contains the data encoded in the IMB in the page group. This option provides a record of the IMB data that you can use to retrieve a mailpiece if, for example, the USPS reports an address change for the mailpiece. |
Index tag name | The name to assign to the index tag that contains the IMB data. Any combination of a-z, A-Z, 0–9, special characters, and blanks. | |
*For more information about the values for these fields, see the Intelligent Mail® Barcode Technical Resource Guide. |
1.3.1.6.1.4 Position tab
This figure shows four barcode areas with different orientations (0, 90, 180, 270 degrees) of the barcode symbol. It also shows the barcode area origin, width, and height that you specify on the Position tab for each area.
Barcode areas with four orientations of barcode symbol
In the figure, the asterisk (*) indicates the origin of the barcode symbol. AFP Editor automatically determines the origin of the barcode symbol. The barcode symbol origin is different for each orientation:
Orientation of symbol | Origin of symbol |
---|---|
0 degrees | Top-left corner of barcode area |
90 degrees | Top-right corner of barcode area |
180 degrees | Bottom-right corner of barcode area |
270 degrees | Bottom-left corner of barcode area |
Fields on the Position tab
Field | Value | Description |
---|---|---|
Origin of area: X position | Any decimal value, such as 2.5. The X position cannot be greater than the width of the page. | The horizontal distance (in inches or millimeters) of the left side of the barcode
area measured from the left side of the logical page (not the physical sheet of paper).
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the X position from the top-left corner of the logical page in the
unrotated view.
|
Origin of area: Y position | Any decimal value, such as 2.5. The Y position cannot be greater than the height of the page. | The vertical distance (in inches or millimeters) of the top of the barcode area measured
from the top of the logical page (not the physical sheet of paper).
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the Y position from the top-left corner of the logical page in the
unrotated view.
|
Size of area: Width | Any decimal value, such as 2.5. The width of the area cannot be greater than the width of the page. | The horizontal width (in inches or millimeters) of the barcode area measured in the
unrotated view.
Note: This field applies only to BCOCA objects. It is ignored for text barcodes.
|
Size of area: Height | Any decimal value, such as 2.5. The height of the area cannot be greater than the height of the page. | The vertical height (in inches or millimeters) of the barcode area measured in the
unrotated view.
Note: This field applies only to BCOCA objects. It is ignored for text barcodes.
|
Orientation | 0 degrees | The barcode symbol is not rotated in the barcode area. |
90 degrees | The barcode symbol is rotated 90 degrees in the barcode area. | |
180 degrees | The barcode symbol is rotated 180 degrees in the barcode area. | |
270 degrees | The barcode symbol is rotated 270 degrees in the barcode area. | |
Origin of barcode symbol: X position | A decimal value. | The horizontal distance (in inches or millimeters) of the origin of the barcode symbol measured from the left side of the logical page (not the physical sheet of paper). AFP Editor automatically calculates this value. |
Origin of barcode symbol: Y position | A decimal value. | The vertical distance (in inches or millimeters) of the origin of the barcode symbol measured from the top of the page. AFP Editor automatically calculates this value. |
Placement of area | Page n | The barcode is placed on page n of each page group. n is the number of the page where you drew the barcode area. |
Multiple pages: All pages | The barcode is placed on all pages in each page group. | |
Multiple pages: Even pages | The barcode is placed on the even pages in each page group (pages 2, 4, 6,...). | |
Multiple pages: Odd pages | The barcode is placed on the odd pages in each page group (pages 1, 3, 5,...). |
1.3.1.6.2 Replacing POSTNET barcodes with IMBs
POSTNET barcodes can be in a fixed location in the AFP file or, in the case of a multiple line address, they might float between lines. You can select the actual location of the POSTNET barcode that you want replaced, or you can select an area in which you think the barcode is located.
AFP Editor can automatically place the IMBs in exactly the same position as the POSTNET barcodes they replace. The position of the POSTNET barcodes can vary slightly in different page groups. The position of any POSTNET barcode can be up to .4 inches or 10 millimeters higher or lower than the position of the particular POSTNET barcode that you replaced in the sample AFP file. (This allows for variations in the position of the POSTNET barcode in different page groups because of variable length addresses.)
If you do not want to place the IMBs in the same position as the POSTNET barcodes they replace, you can specify a new position for the IMBs. If you specify a new position, AFP Editor places all IMBs in the exact position that you specify.
To determine the new position of the IMBs, work from a copy of the sample AFP file printed on the production printer. Measure where you want to place the top-left corner of the barcode area (X and Y positions) on the printed page from the top-left corner of the logical page.
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
To place the IMB in the same position as the Address Change Service (ACS) data and PLANET barcode, use AFP Editor to create a hidden area to cover the ACS data and PLANET barcode before you replace the POSTNET barcode.
- Note:
- You can replace POSTNET barcodes that are on logical pages in the AFP file. However, you cannot replace POSTNET barcodes that are part of page segments or overlays.
- In AFP Visual Environment, open a sample AFP file.
- If the file does not contain page groups, use AFP Indexer to create page groups.
- Click .
- Navigate to the page that contains one of the POSTNET barcodes.
- Optional: To place the IMB in the same position as a PLANET barcode, create a hidden area that covers the PLANET barcode and any other data that you do not want to print, such as ACS data.
- Do one of these:
- Select the POSTNET barcode.
- Position your cursor at a corner of the area that contains the POSTNET barcode. While pressing the left mouse button, draw a box that includes the barcode.
- Right-click anywhere in the AFP file and then click Replace POSTNET with IMB.
- Note:
-
If you do not see the Replace POSTNET with IMB option and the POSTNET barcode is a text barcode, identify the directory that contains the POSTNET font to AFP Visual Environment ( ). If you still do not see the Replace POSTNET with IMB option, try changing the default code page to another code page ( ).
-
If you see an error message instead of the Replace Barcode window, AFP Editor could not find any POSTNET data in the area you selected.
-
- On the Type tab, type a descriptive name for the IMB and specify the representation of the IMB.See Type tab for IMBs for a description of the fields.
- On the Data tab, specify the data to be encoded in the IMB symbol.See Data tab for IMBs for a description of the fields.
- Optional: On the Position tab, change the origin of the barcode area or the orientation of the barcode symbol
within the area. You can also change on which pages to place the barcode in each page
group.See Position tab for IMBs for a description of the fields.
- Click OK. If you have more than one barcode defined, you might see the Create Conditions between Definitions window. Click Yes if you want to create a condition for determining which barcode is used, and then click OK.
You see the IMB in the AFP file.
- Note:
- If the IMB is a text barcode and you do not see the barcode symbol, identify the
resource directory that contains the AFP IMB font to AFP Visual Environment ( ). The AFP IMB font (character set C0XMUS23) is installed in the
install_directory/resources
directory.
- If the IMB is a text barcode and you do not see the barcode symbol, identify the
resource directory that contains the AFP IMB font to AFP Visual Environment ( ). The AFP IMB font (character set C0XMUS23) is installed in the
- If you see an error message, the barcode is not created in any page group. In addition, no other barcodes, hidden areas, or text masks are created. If the Replace Barcode window is open, correct the barcode properties. If the Replace
Barcode window is already closed, click to correct the properties. (In the Modify and Delete Definitions window, identifies the barcode with the error.)If you included index tag values in the barcode data and the error message indicates that barcode data is too long or contains characters that are not valid, you might need to modify the index tag to correct the problem.
1.3.1.6.2.1 Type tab for IMBs
Fields on the Type tab
Field | Value | Description |
---|---|---|
Barcode name | Any combination of a-z, A-Z, 0–9, special characters, and blanks. | The name of the barcode area. For example, you could name the barcode IMB. |
Barcode representation | Output type | |
BCOCA object | AFP Editor creates barcode objects using Bar Code Object Content Architecture (BCOCA) structured
fields. In general, BCOCA barcodes are preferred to text barcodes. However, some older
printers cannot process newer barcode types. For example, IBM 3900 printers cannot
process IMBs. In this case, text barcodes are required.
This is the default. |
|
Text barcode | AFP Editor creates text barcodes that use the AFP barcode font.
Note: AFP Editor uses the 300 dpi AFP IMB font (US23), which produces a standard height barcode: character
set C0XMUS23 and code page T100USPS. If you create text barcodes, you must install the IMB font in the AFP resource directories
that AFP Visual Environment uses. Otherwise, AFP Visual Environment cannot display the barcode symbol.
|
|
Output size | ||
Optimal Size | AFP Editor creates BCOCA barcodes so they are displayed in the best size for viewing and printing. This is the default. | |
Compact Size | AFP Editor creates BCOCA barcodes so they are displayed in a compact size. |
1.3.1.6.2.2 Data tab for IMBs
Fields on the Data tab for IMBs
Field | Value | Description |
---|---|---|
Barcode ID* | 00 - 50 | Optional Endorsement Line (OEL) sort level and exception handling. |
Service type ID* | 040 - 782 | Type of mail and any mail services requested. |
Mailer ID* | 0, 6, or 9 digits | A 6 or 9-digit mailer ID obtained from the United States Postal Service (USPS).
Note: You can use the Mailer ID field for other purposes in an IMB used for reply mail.
|
Serial number* | A 6- or 9-digit serial number that identifies the mailpiece. The length depends on
the number of digits specified for mailer ID. The mailer ID and serial number together
can contain 15 digits.
Note: AFP Editor adds leading zeroes to the value in this field so that the value in the Mailer ID and Serial number fields together contain 15 digits.
|
|
Zeroes | AFP Editor creates a serial number that contains zeroes. Mailers who use only the USPS Basic servicesoption can use serial numbers with zeroes. |
|
Index tag | The name of an index tag that contains the serial number. | |
File name | The full path name of an IMB serial number file that contains the serial number to be encoded in the first barcode in the AFP file. AFP Editor increments the serial number in the file by 1 for each barcode. | |
Routing code* | The routing code (also called routing ZIP Code and delivery point ZIP Code) of the recipient. The routing code, if one is specified, can contain 5, 9, or 11 digits. | |
Index tag | The name of an index tag that contains the routing code. If no index tag name is specified,
AFP Editor does not encode a routing code in the IMB.
Note: AFP Editor removes any non-numeric characters from the value in the index tag before encoding
it in the barcode symbol. For example, if the value of the index tag in a page group
is
12345–6789, the value in the barcode symbol is 123456789. |
|
POSTNET data | AFP Editor includes the same routing code as in the POSTNET barcode. The routing code in the POSTNET barcode on the current page in the AFP file is displayed. | |
Create index tag | Save | Indicates that AFP Editor is to create an index tag that contains the data encoded in the IMB in the page group. This option provides a record of the IMB data that you can use to retrieve a mailpiece if, for example, the USPS reports an address change for the mailpiece. |
Index tag name | The name to assign to the index tag that contains the IMB data. Any combination of a-z, A-Z, 0–9, special characters, and blanks. | |
*For more information about the values for these fields, see the Intelligent Mail® Barcode Technical Resource Guide. |
1.3.1.6.2.3 Position tab for IMBs
When you create BCOCA IMBs, the barcode area must be large enough to contain the largest barcode symbol in each page group. If any part of the barcode symbol extends outside of the barcode area, the printer reports an exception and does not print the barcode correctly.
AFP Editor automatically creates IMBs with the same orientation as the POSTNET barcodes. However, you can select a different orientation for the barcode symbol (0, 90, 180, 270 degrees).
Fields on the Position tab
Field | Value | Description |
---|---|---|
Origin of area: X position | Any decimal value, such as 2.5. The X position cannot be greater than the width of the page. | The horizontal distance (in inches or millimeters) of the left side of the barcode
area measured from the left side of the logical page (not the physical sheet of paper).
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the X position from the top-left corner of the page in the unrotated
view.
|
Origin of area: Y position | Any decimal value, such as 2.5. The Y position cannot be greater than the height of the page. | The vertical distance (in inches or millimeters) of the top of the barcode area measured
from the top of the logical page (not the physical sheet of paper).
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the Y position from the top-left corner of the page in the unrotated
view.
|
Size of area: Width | Any decimal value, such as 2.5. The width of the area cannot be greater than the width of the page. | The horizontal width (in inches or millimeters) of the barcode area measured in the
unrotated view. If the POSTNET barcode is a BCOCA object, the initial width is the
width of the POSTNET barcode area. If the POSTNET barcode is a text barcode, the initial
width is the maximum width for IMBs.
Note: This field applies only to BCOCA barcodes. It is ignored for text barcodes.
|
Size of area: Height | Any decimal value, such as 2.5. The height of the area cannot be greater than the height of the page. | The vertical height (in inches or millimeters) of the barcode area measured in the
unrotated view. If the POSTNET barcode is a BCOCA object, the initial height is the
height of the POSTNET barcode area. If the POSTNET barcode is a text barcode, the
initial height is the maximum height for IMBs.
Note: This field applies only to BCOCA barcodes. It is ignored for text barcodes.
|
Orientation | 0 degrees | The barcode symbol is not rotated in the barcode area. |
90 degrees | The barcode symbol is rotated 90 degrees in the barcode area. | |
180 degrees | The barcode symbol is rotated 180 degrees in the barcode area. | |
270 degrees | The barcode symbol is rotated 270 degrees in the barcode area. | |
Origin of barcode symbol: X position | A decimal value. | The horizontal distance (in inches or millimeters) of the origin of the barcode symbol measured from the left side of the logical page (not the physical sheet of paper). AFP Editor automatically calculates this value. |
Origin of barcode symbol: Y position | A decimal value. | The vertical distance (in inches or millimeters) of the origin of the barcode symbol measured from the top of the logical page (not the physical sheet of paper). AFP Editor automatically calculates this value. |
Placement of area | Page n | The barcode is placed on page n of each page group. n is the number of the page where you drew the barcode area. |
Multiple pages: All pages | The barcode is placed on all pages in each page group. | |
Multiple pages: Even pages | The barcode is placed on the even pages in each page group (pages 2, 4, 6,...). | |
Multiple pages: Odd pages | The barcode is placed on the odd pages in each page group (pages 1, 3, 5,...). |
1.3.1.6.3 Creating IMB serial number files
The IMB serial number file contains the serial number that you want to encode in the first IMB that AFP Editor creates in a production AFP file. AFP Editor increments the serial number by 1 in each subsequent IMB so that the serial number is unique.
You can use different IMB serial number files when you create IMBs in a sample AFP
file and when you run the EditAFP
command to create the IMBs in production AFP files. To use a different serial number
file for the production AFP files, you specify the name of the serial number file
to use for the IMB definition in the -snf option of the EditAFP
command.
You can create a different IMB serial number file for each barcode that has a unique barcode definition name. For example, if one IMB contains the customer's routing ZIP Code and another IMB contains your company's routing ZIP Code (in a reply address), you can create a separate IMB serial number file for each barcode definition.
- On the preparation system, create an IMB serial number file.
- Identify the serial number file with a name of the barcode that the file applies to.
For example, if the barcode contains the customer's routing code, you might name the
barcode
to-imb
and the serial number fileto-imb-serial
. - If the production system is different than the preparation system, use the File Transfer
Protocol (
ftp
) to send the serial number file to the production system. Use theftp
binary option.
1.3.1.6.4 Creating conditions between barcode definitions
- In AFP Visual Environment, open a sample AFP file.
- Click .
- Create two barcodes if you do not already have two defined.
- Do one of these:
- After the second barcode is defined, click Yes when you are asked if you want to create a condition for this definition.
- Click Conditions on the Modify and Delete Definitions window. and then click
You see the Create Conditions between Definitions window. - From the drop-down list, select a barcode in the Select Definition 1 field.
- From the drop-down list, select one of these conditions in the Select Condition field:
- fails, run: If the first barcode definition cannot be created, use the second definition.
- succeeds, run: If the first barcode definition can be created, use the second definition.
- From the drop-down list, select a barcode in the Select Definition 2 field.
- Click OK. The condition is created and is listed on the Modify and Delete Definitions window, if it is open. If the Modify and Delete Definitions window is closed, clickto see the condition you just defined.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.5 Creating hidden areas
The hidden area must be in a consistent position on every page and must be a consistent size. To determine the exact position and size of the hidden area, first print the sample AFP file on the production printer and measure where you want to place the top-left corner of the hidden area on the printed page.
- In AFP Visual Environment, open a sample AFP file.
- If the sample AFP file does not contain page groups, use AFP Indexer to create page groups.
- Click .
- Navigate to the page where you want to create the hidden area:
- To place a hidden area on the same page in every page group, navigate to that page in any page group.
- To place a hidden area on multiple pages, navigate to one of the pages in any page group.
- Position your cursor at a corner of the hidden area. While pressing the left mouse
button, draw a box the approximate size of the hidden area.In a later step, you can specify the exact position and size of the hidden area.
- Right-click anywhere in the AFP file and click Hide area.
- Type a descriptive name for the area in the Hidden area name field.For example, if the hidden area contains a barcode for a ZIP Code, the name could be
ZIP Code
. - Select the color of the area in the Color field.
- Specify the exact origin (top-left corner) of the hidden area in these fields. Specify
the values in inches or millimeters.
- X position
- The horizontal distance of the left side of the hidden area measured from the left side of the logical page (not the physical sheet of paper). Decimal values (such as 2.5) are allowed. The X position cannot be greater than the width of the page.
- Y position
- The vertical distance of the top of the hidden area measured from the top of the logical page (not the physical sheet of paper). Decimal values (such as 2.5) are allowed. The Y position cannot be greater than the height of the page.
The initial values of these fields are the X and Y positions of the top-left corner of the box that you drew.
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the page in the unrotated view. - Specify the exact size of the hidden area in these fields. Specify the values in inches
or millimeters.
- Width
- The horizontal width of the hidden area. Decimal values (such as 2.5) are allowed. The width of the area cannot be greater than the width of the page.
- Height
- The vertical height of the hidden area. Decimal values (such as 2.5) are allowed. The height of the area cannot be greater than the height of the page.
The initial values for these fields are the width and height of the box that you drew.
Note: Measure the width and height from the origin of the hidden area in the unrotated view. - Select one of these options to place the hidden area:
- Page n: Place the hidden area on page n of each page group (n is the page where you drew the box for the hidden area). You cannot change this page number. If the page number is incorrect, click Cancel and draw the box for the hidden area on the correct page.
- Multiple pages: Place the hidden area on:
- All pages
- All pages in each page group
- Even pages
- The even pages in each page group (pages 2, 4, 6,...)
- Odd pages
- The odd pages in each page group (pages 1, 3, 5,...)
- Click OK.You do not see any text or image data in the hidden area in each page group.
1.3.1.6.6 Creating text with AFP Editor
For example, you can add page numbers or you can add text so that the information in a barcode is also printed as readable text.
You can create text in an AFP file from:
- Text you enter from the keyboard
- Index tags defined in each page group
- Page number or page count property values
To determine the position of the new text, work from a copy of the sample AFP file printed on the production printer. Measure where you want to place the top-left corner of the text area (X and Y positions) on the printed page from the top-left corner of the logical page.
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file.
- If the file does not contain page groups, use AFP Indexer to create page groups.
- Click .
- To create an area for the text, position your cursor at a corner of the area you want to create. While pressing the left mouse button, draw a box the size you want.
- Right-click anywhere in the AFP file and then click Create Text.You see the Create Text String window.
- On the Text tab, type a descriptive name for the text area in the Text definition name field.
- In the Text string data section, create a text string.For example, to add the page number, such as "Page 1 of 10", to the first page of each page group:
- Type Page in the Text field and click Add.
- Select Page in Page Group from the Property drop-down list and click Add. Page in Page Group is the number of the page in the page group.
- Type of in the Text field and click Add.
- Select Page Group Page Count from the Property drop-down list and click Add. Page Group Page Count is the total number of pages in the page group.
You see the text string value in the field below the data fields. - Optional: To edit the text string, select a line of data and use Up or Down to change the order of the line or Remove to delete the line.Remember to add blank characters between words if you need to.
- Optional: Select a color for the text from the Color drop-down list.
- Optional: On the Font tab, select one of these:
- Core Fonts
- From the drop-down lists, select the character set and code page, and, if the font is an outline font, the point size in the Font Information section.
- External Fonts
- Type a character set and code page pair, a coded font name, or all three. For double-byte
character set (DBCS) fonts, use the coded font name only.
- Note:
- If you enter a code page that is part of a DBCS-coded font, you see an error message that suggests you use the coded font name instead.
- Note:
- On your workstation, if the font size does not exist for the color you selected, your display defaults to 12 black, even though the final AFP file will have the correct font and color.
- Optional: On the Position tab, change the origin (top-left corner), size, and orientation of the text area.
Specify the origin and size in inches or millimeters. Decimal values (such as 2.5)
are allowed. The fields are:
- X position
- The horizontal distance of the left side of the area measured from the left side of the logical page (not the physical sheet of paper).
- Y position
- The vertical distance of the top of the area measured from the top of the logical page (not the physical sheet of paper).
- Width
- The horizontal width of the area.
- Height
- The vertical height of the area.
- Orientation
- The number of degrees the text is rotated in the defined area: 0o, 90o, 180o, 270o
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the logical page in the unrotated view. - Click OK. You see the text in the AFP file.
- Repeat steps 4 to 12 to add text to another page in each page group. For example, select the second page to add "Page 2 of 10" to the second page of each page group.
1.3.1.6.7 Defining text masks
- In AFP Visual Environment, open a sample AFP file that contains the text you want to mask.
- If the sample AFP file does not contain page groups, use AFP Indexer to create page groups.
- Click .
- Click the text you want to mask.The text blocks you can select are defined in the AFP file, from one character to the entire line of text.You see a red box around the text you selected.
- Right-click the text and select Create text mask.You see the Create Text Mask window with the default character
x
in the Mask character field. In the Masked value field, you also see how the selected text is masked with the mask character. - Type another mask character if you do not want to use the default character. The value in the Masked value field changes to the character you selected.
- Decide whether you want to mask the entire text value or part of the text. You can edit the text to reduce the number of characters you mask. For example, if the account number is one text block, 01-345678, you can mask part of the account number, such as 345678.
To edit the text mask value, click Edit mask value. Edit the value in the Edit Value window and click OK.
- Although text might appear to be present in the same location on each statement, slight
position variations can occur in the AFP file. To change the threshold to look for
a text value that is in slightly different positions on some pages, click the Advanced tab. You can select a range from 1/100 to 1 inch.
The threshold defines how far the text can be from the original location and be considered a mask value. For example, a threshold value of 12 indicates that the mask value can be located within .12 of an inch either vertically or horizontally. Usually the default threshold value of 10 is sufficient.
Keep in mind that if you increase the threshold above the default value, you might mask text you did not expect because the match is only done on location, so the first text block found in the threshold range is used as the text mask.
- Click OK.
- Verify that the correct text has been masked in all page groups:
- Double-click the page groups in the bottom pane and verify that the correct text has been marked.
- If the text mask is incorrect, modify or delete the text mask ( ).
1.3.1.6.8 Modifying or deleting AFP Editor definitions
1.3.1.6.8.1 Modifying barcodes
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the barcodes. Then click .
- Click .
- Do one of these:
- Select the barcode that you want to modify and then click Modify.
- Double-click the barcode that you want to modify.
You see the Modify Barcode window.Note: identifies barcodes that were not created because of an error. To see the error message, click Modify and then click OK on the Modify Barcode window. - Optional: On the Type tab, type a new name or change the type of barcode.See Type tab for a description of the fields.
- Optional: On the Data tab, change the data to be encoded in the barcode symbol.See Data tab for Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcodes or Data tab for IMBs for a description of the fields.
- Optional: On the Position tab, change the exact origin and size of the barcode area, the orientation of the
barcode symbol within the area, and on which pages to place the barcode in each page
group.See Position tab for a description of the fields.
- Click OK.If the barcode is an IMB, POSTNET, or QR Code barcode, you see the barcode symbol in the AFP file. If the barcode is a Code 39, Data Matrix, Interleaved 2-of-5, or PDF417 barcode, you see a box surrounding the barcode area with the title of the barcode area in the orientation that you selected for the barcode symbol.
Note: If the IMB is a text IMB and you do not see the barcode symbol, identify the resource directory that contains the AFP IMB font to AFP Visual Environment ( ).
- The AFP IMB font (character set C0XMUS23) is installed in the
plugins/EditAFP
directory.
- The AFP IMB font (character set C0XMUS23) is installed in the
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.1.1 Type tab
Fields on the Type tab
Field | Value | Description |
---|---|---|
Barcode name | Any combination of a-z, A-Z, 0–9, special characters, and blanks. | The name of the barcode area. For example, if the barcode is an Intelligent Mail barcode
(IMB), you could name the barcode IMB. |
Barcode type | Code 39 (3-of-9 Code) | A low-density barcode that can encode uppercase letters, numbers, and some special characters. |
Data Matrix | A two-dimensional (2D) barcode consisting of black and white square modules arranged in either a square or rectangular pattern. This barcode uses the Solomon-Reed error correction algorithm (ECC 200) to ensure data reliability. | |
Intelligent Mail (IMB) | A barcode defined by the United States Postal Service (USPS) that is used to direct and track mail. This barcode was previously called a USPS Four-State barcode. | |
Interleaved 2-of-5 | A high-density barcode that can encode numbers. | |
PDF417 | A two-dimensional (2D) barcode that consists of several rows, each of which is like a small linear barcode. The barcode can detect and correct errors. | |
POSTNET | A barcode defined by the USPS that is used to direct mail. | |
QR Code | A two-dimensional (2D) matrix barcode that consists of black and white square modules
arranged in a square pattern. The contents of this Quick Responsecode can be decoded at high speed. This barcode uses the Solomon-Reed error correction algorithm (ECC 200) to ensure data reliability. |
|
Barcode representation | Output type | |
BCOCA object | AFP Editor creates barcode objects using Bar Code Object Content Architecture (BCOCA) structured
fields. In general, BCOCA barcodes are preferred to text barcodes. However, some older
printers cannot process newer barcode types. For example, IBM 3900 printers cannot
process IMBs. In this case, text barcodes are required.
This is the default. |
|
Text barcode | AFP Editor creates text barcodes that use the AFP barcode font.
Notes:
|
|
Output size | ||
Optimal Size | AFP Editor creates BCOCA barcodes so they are displayed in the best size for viewing and printing.
This is the default.
Note: This option is currently available only for IMBs.
|
|
Compact Size | AFP Editor creates BCOCA barcodes so they are displayed in a compact size.
Note: This option is currently available only for IMBs.
|
This table describes the fields on the Type tab that let you specify barcode properties. The fields differ for each barcode type.
Fields on the Type tab for barcode properties
Barcode type | Field | Description |
---|---|---|
Code 39 (3-of-9 Code) | Include check digit | A check digit ensures data integrity during the bar coding reading process. If you select Yes, a check digit is included in the barcode symbol. |
Data Matrix | Number of rows | The number of rows in the barcode including the finder pattern. If you select Auto, an appropriate number of rows is used for the amount of data in the barcode symbol. |
Row size | The number of modules in each row including the finder pattern. The row sizes you can select depend on the number of rows. If you select Auto, an appropriate row size is used for the amount of data in the barcode symbol. | |
Intelligent Mail (IMB) | None | None |
Interleaved 2-of-5 | Include check digit | A check digit ensures data integrity during the bar coding reading process. If you select Yes, check digit is included in the barcode symbol. |
PDF417 | Row size | The number of data symbol characters in each row. The printer creates the minimum number of rows necessary for the amount of data in the barcode symbol. |
POSTNET | ZIP Code barcode | The barcode symbol consists of a leading frame bar, the encoded ZIP Code data, a correction digit, and a trailing frame bar. The ZIP Code data is a 5-digit number. |
ZIP Code+4 barcode | The barcode symbol consists of a leading frame bar, the encoded ZIP+4 data, a correction digit, and a trailing frame bar. The ZIP+4 data is a 9-digit number. | |
Advanced Bar Code (ABC) | The barcode symbol consists of a leading frame bar, the encoded ABC data, a correction digit, and a trailing frame bar. The ABC data is an 11-digit number. | |
Variable-length barcode | The barcode symbol consists of a leading frame bar, the encoded data, a correction digit, and a trailing frame bar. The encoded data is variable length. | |
QR Code | Size | The size of the barcode symbol, represented by the number of modules in each row and
column. The values are 21x21 to 177x177, or smallest, which indicates the smallest size that can include all data. |
1.3.1.6.8.1.2 Data tab for Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcodes
Fields on Data tab
Field | Value | Description |
---|---|---|
Text | Any valid characters for the barcode type (see next table) | The text that you want to encode in the barcode symbol. For example, you could use a blank character to separate multiple index tags. (A blank is not a valid character in all barcode types.) This value is the same in all page groups. |
Index tag | An index tag name | The index tag whose value you want to encode in the barcode. For example, you might want to encode a routing code that you previously indexed. The barcodes will contain the value of the index tag in the page group. This value can be different in each page group, but is the same for all pages in a page group. |
Property | A property name |
The property you want to encode in the barcode. The barcodes will contain the value of the property. This value is the same in all page groups. |
Include HRI | Above barcode symbol | Indicates that human-readable interpretation (HRI) is to be printed above the barcode symbol. This field is visible only for barcode types that support HRI: Code 39 and Interleaved 2-of-5. |
Below barcode symbol | Indicates that human-readable interpretation (HRI) is to be printed below the barcode symbol. This field is visible only for barcode types that support HRI: Code 39 and Interleaved 2-of-5. | |
Code page encoding | A defined code page encoding | The code page used to encode the barcode. You can only select an encoding from the drop-down list for QR Code barcodes. |
This table shows the characters that are valid for each type of barcode.
Valid characters for barcodes
Barcode type | Valid characters | Total number of characters |
---|---|---|
Code 39 (3-of-9 Code) |
0123456789 ABCDEFGHIJKLM NOPQRSTUVWXYZ - . $ / + % space character |
0 to 50 characters |
Data Matrix | Any one-byte character, or binary data | 0 to 3116 characters |
Interleaved 2-of-5 | 0123456789 | 0 to 50 characters |
PDF417 | Any one-byte character, or binary data | 0 to 2710 characters |
POSTNET | 0123456789 | The number of digits depends on the barcode property selected on the Type tab:
|
QR Code | Any one-byte character, or binary data | 0 to 3116 characters |
1.3.1.6.8.1.3 Data tab for IMBs
Fields on the Data tab for IMBs
Field | Value | Description |
---|---|---|
Barcode ID* | 00 - 50 | Optional Endorsement Line (OEL) sort level and exception handling. |
Service type ID* | 040 - 782 | Type of mail and any mail services requested. |
Mailer ID* | 0, 6, or 9 digits | A 6 or 9-digit mailer ID obtained from the United States Postal Service (USPS).
Note: You can use the Mailer ID field for other purposes in an IMB used for reply mail.
|
Serial number* | A 6 or 9-digit serial number that identifies the mailpiece. The length depends on
the number of digits specified for mailer ID. The mailer ID and serial number together
can contain 15 digits.
Note: AFP Editor adds leading zeroes to the value in this field so that the value in the Mailer ID and Serial number fields together contain 15 digits.
|
|
Zeroes | AFP Editor creates a serial number that contains zeroes. Mailers who use only the USPS Basic servicesoption can use serial numbers with zeroes. |
|
Index tag | The name of an index tag that contains the serial number. | |
File name | The full path name of an IMB serial number file that contains the serial number to be encoded in the first barcode in the AFP file. AFP Editor increments the serial number in the file by 1 for each barcode. | |
Routing code* | The routing code (also called routing ZIP Code and delivery point ZIP Code) of the recipient of the mailpiece. The routing code, if one is specified, can contain 5, 9, or 11 digits. | |
Index tag | The name of an index tag that contains the routing code. If blank, AFP Editor does not include a routing code in the barcode.
Note: AFP Editor removes any non-numeric characters from the value in the index tag before encoding
it in the barcode symbol. For example, if the value of the index tag in a page group
is
12345–6789, the value in the barcode symbol is 123456789. |
|
Create index tag | Save | Indicates that AFP Editor is to create an index tag that contains the data encoded in the IMB in the page group. This option provides a record of the IMB data that you can use to retrieve a mailpiece if, for example, the USPS reports an address change for the mailpiece. |
Index tag name | The name to assign to the index tag that contains the IMB data. Any combination of a-z, A-Z, 0–9, special characters, and blanks. | |
*For more information about the values for these fields, see the Intelligent Mail® Barcode Technical Resource Guide. |
1.3.1.6.8.1.4 Position tab
This figure shows four barcode areas with different orientations (0, 90, 180, 270 degrees) of the barcode symbol. It also shows the barcode area origin, width, and height that you specify on the Position tab for each area.
Barcode areas with four orientations of barcode symbol
In the figure, the asterisk (*) indicates the origin of the barcode symbol. AFP Editor automatically determines the origin of the barcode symbol. The barcode symbol origin is different for each orientation:
Orientation of symbol | Origin of symbol |
---|---|
0 degrees | Top-left corner of barcode area |
90 degrees | Top-right corner of barcode area |
180 degrees | Bottom-right corner of barcode area |
270 degrees | Bottom-left corner of barcode area |
Fields on the Position tab
Field | Value | Description |
---|---|---|
Origin of area: X position | Any decimal value, such as 2.5. The X position cannot be greater than the width of the page. | The horizontal distance (in inches or millimeters) of the left side of the barcode
area measured from the left side of the logical page (not the physical sheet of paper).
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the X position from the top-left corner of the logical page in the
unrotated view.
|
Origin of area: Y position | Any decimal value, such as 2.5. The Y position cannot be greater than the height of the page. | The vertical distance (in inches or millimeters) of the top of the barcode area measured
from the top of the logical page (not the physical sheet of paper).
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the Y position from the top-left corner of the logical page in the
unrotated view.
|
Size of area: Width | Any decimal value, such as 2.5. The width of the area cannot be greater than the width of the page. | The horizontal width (in inches or millimeters) of the barcode area measured in the
unrotated view.
Note: This field applies only to BCOCA objects. It is ignored for text barcodes.
|
Size of area: Height | Any decimal value, such as 2.5. The height of the area cannot be greater than the height of the page. | The vertical height (in inches or millimeters) of the barcode area measured in the
unrotated view.
Note: This field applies only to BCOCA objects. It is ignored for text barcodes.
|
Orientation | 0 degrees | The barcode symbol is not rotated in the barcode area. |
90 degrees | The barcode symbol is rotated 90 degrees in the barcode area. | |
180 degrees | The barcode symbol is rotated 180 degrees in the barcode area. | |
270 degrees | The barcode symbol is rotated 270 degrees in the barcode area. | |
Origin of barcode symbol: X position | A decimal value. | The horizontal distance (in inches or millimeters) of the origin of the barcode symbol measured from the left side of the logical page (not the physical sheet of paper). AFP Editor automatically calculates this value. |
Origin of barcode symbol: Y position | A decimal value. | The vertical distance (in inches or millimeters) of the origin of the barcode symbol measured from the top of the page. AFP Editor automatically calculates this value. |
Placement of area | Page n | The barcode is placed on page n of each page group. n is the number of the page where you drew the barcode area. |
Multiple pages: All pages | The barcode is placed on all pages in each page group. | |
Multiple pages: Even pages | The barcode is placed on the even pages in each page group (pages 2, 4, 6,...). | |
Multiple pages: Odd pages | The barcode is placed on the odd pages in each page group (pages 1, 3, 5,...). |
1.3.1.6.8.2 Deleting barcodes
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the barcodes. Then click .
- Click .You see the Modify and Delete Definitions window with a list of the barcodes.
- Select the barcode that you want to delete.
- Click Delete, or press the Delete key on your keyboard.The barcode is removed from the list. Any conditions that are defined for that barcode are also deleted.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.3 Modifying conditions between barcode definitions
- In AFP Visual Environment, open a sample AFP file and the control file that contains the condition definitions for the barcodes. Then click .
- Click .
- Do one of these:
- Select the definition condition that you want to modify and then click Modify.
- Double-click the definition condition that you want to modify.
You see the Modify Conditions between Definitions window. - Select the Definition 1, Condition, and Definition 2 that you want to change.
- Click OK. The condition is modified in the list.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.4 Deleting conditions between barcode definitions
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for conditions. Then click .
- Click .You see the Modify and Delete Definitions window with a list of the definition conditions.
- Select the definition condition that you want to delete.
- Click Delete, or press the Delete key on your keyboard.The definition condition is removed from the list.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.5 Modifying hidden areas
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the hidden areas. Then click .
- Click .
- Do one of these:
- Select the hidden area that you want to modify and then click Modify.
- Double-click the hidden area that you want to modify.
You see the Modify Hidden Area window.Note: identifies barcodes that were not created because of an error. To see the error message, click Modify and then click OK on the Modify Barcode window. - To change the descriptive name of the hidden area, type the new name in the Hidden area name field.
- To change the origin (top-left corner) of the hidden area, type new values in these
fields.
- X position
- The horizontal distance of the left side of the hidden area measured from the left side of the logical page (not the physical sheet of paper). Decimal values (such as 2.5) are allowed. The X position cannot be greater than the width of the page.
- Y position
- The vertical distance of the top of the hidden area measured from the top of the logical page (not the physical sheet of paper). Decimal values (such as 2.5) are allowed. The Y position cannot be greater than the height of the page.
Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the page in the unrotated view. - To change the size of the hidden area, type new values in these fields.
- Width
- The horizontal width of the hidden area. Decimal values (such as 2.5) are allowed. The width of the area cannot be greater than the width of the page.
- Height
- The vertical height of the hidden area. Decimal values (such as 2.5) are allowed. The height of the area cannot be greater than the height of the page.
Note: Measure the width and height from the origin of the hidden area in the unrotated view. - To change the placement of the hidden area, select one of these options:
- Page n: Place the hidden area on page n of each page group (n is the page where you drew the box for the hidden area). You cannot change this page number. If the page number is incorrect, click Cancel and draw the box for the hidden area on the correct page.
- Multiple pages: Place the hidden area on:
- All pages
- All pages in each page group
- Even pages
- The even pages in each page group (pages 2, 4, 6,...)
- Odd pages
- The odd pages in each page group (pages 1, 3, 5,...)
- Click OK.You do not see any text or image data in the hidden area in each page group.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.6 Deleting hidden areas
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the hidden areas. Then click .
- Click .You see the Modify and Delete Definitions window with a list of the hidden areas.
- Select the hidden area that you want to delete.
- Click Delete, or press the Delete key on your keyboard.The hidden area is removed from the list. You see any data that the hidden area covered in the AFP file.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.7 Modifying text strings
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for text strings.
- Click .
- Click .
- Do one of these:
- Select the text definition that you want to modify and then click Modify.
- Double-click the text definition that you want to modify.
You see the Modify Text String window. - Optional: On the Text tab, type a new name for the text area in the Text definition name field, change data in the Text string data section, or change the color in the Color drop-down list.To edit the text string, select a line of data and use Up or Down to change the order of the line or Remove to delete the line. You can also add new values. Remember to add blank characters between words if you need to. For example, to change the text string from "Page 1 of 10" to "Page 1 for John Doe":
- Press and hold the CTRL key, and then select of and Page Count.
- Click Remove.
- Type for in the Text field and click Add.
- Select a customer index tag from the Index tag drop-down list and click Add.
You see the edited text string value in the field below the data fields. - Optional: On the Font tab, select one of these:
- Core Fonts
- From the drop-down lists, select the character set and code page, and, if the font is an outline font, the point size in the Font Information section.
- External Fonts
- Type a character set and code page pair, a coded font name, or all three. For double-byte
character set (DBCS) fonts, use the coded font name only.
- Note:
- If you enter a code page that is part of a DBCS-coded font, you see an error message that suggests you use the coded font name instead.
- Note:
- On your workstation, if the font size does not exist for the color you selected, your display defaults to 12 black, even though the final AFP file will have the correct font and color.
- Optional: On the Position tab, change the origin (top-left corner), size, and orientation of the text area.
Specify the origin and size in inches or millimeters. Decimal values (such as 2.5)
are allowed.
- Note:
- If you rotated the AFP file using the Rotate by 90o option on the View menu, measure the X and Y positions from the top-left corner of the logical page in the unrotated view.
- Click OK. You see the edited text in the AFP file.
1.3.1.6.8.8 Deleting text strings
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for text strings.
- Click .
- Click .You see the Modify and Delete Definitions window with a list of text strings.
- Select the text string that you want to delete.
- Click Delete, or press the Delete key on your keyboard.The text string is removed from the list.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.9 Modifying text masks
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the text masks. Then click .
- Click .
- Select the text mask that you want to modify.
- Click Modify, or double-click.You see the Modify Text Mask window.
- Optional: Type another mask character if you do not want to use the default character. The value in the Masked value field changes to the character you selected.
- Optional: To edit the text mask value, click Edit text mask. Edit the value in the Edit Value window and click OK.
- Optional: Although text might appear to be present in the same location on each statement,
slight position variations can occur in the AFP file. To change the threshold to look
for a text value that is in slightly different positions on some pages, click the
Advanced tab. You can select a range from 1/100 to 1 inch.
The threshold defines how far the text can be from the original location and be considered a mask value. For example, a threshold value of 12 indicates that the mask value can be located within .12 of an inch either vertically or horizontally. Usually the default threshold value of 10 is sufficient.
Keep in mind that if you increase the threshold above the default value, you might mask text you did not expect because the match is only done on location, so the first text block found in the threshold range is used as the text mask.
- Click OK.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.10 Deleting text masks
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the text masks. Then click .
- Click .You see the Modify and Delete Definitions window with a list of the text masks.
- Select the text mask that you want to delete.
- Click Delete, or press the Delete key on your keyboard.The text mask is removed from the list.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.6.8.11 Editing text for text masks
- On the Edit Value window, select On for one or more of these options:
Edit by stripping characters Type one character or a blank that you want to remove from the value. Remember that the character is case-sensitive. Then, select one of these buttons: - Strip leading characters
- The specified character is removed from the beginning of the value. For example, if you type a blank character, all blanks are removed from the beginning of the value.
- Strip trailing characters
- The specified character is removed from the end of the value. For example, if you type a blank character, all blanks are removed from the end of the value.
- Strip leading and trailing characters
- The specified character is removed from the beginning and end of the value. For example, if you type a blank character, all blanks are removed from the beginning and end of the value.
- Strip all characters
- The specified character is removed from all positions in the value. For example, an account number is: 324-1443255-11. You can type a - to strip all - characters from the value.
Edit on delimiter Type a text string of one or more characters or blanks in the Specify delimiter string field to indicate where the text value is split into separate strings. Remember that the text is case-sensitive. Then select numbers for Select first string and Select number of strings to mark the beginning and end of the edited text. For example, an account number is: 324-1443255-11. You can use - as the delimiter to split the value into these three strings: 324, 1443255, and 11. To select the second and third strings, 1443255-11, select 2 for both Select first string and Select number of strings.
Edit on character Select numbers for Select first character position and Select number of characters to indicate the first character in the text value and how many characters are included. When you select the options in the window, the text value for the current page group is edited based on your selections and the new value is displayed in the Edited text field. - Click OK.
1.3.1.7 Adding content to white space in AFP files
You can define white space in AFP files by choosing known white space on a page or by searching for the first available white space in a page group. You can also modify or delete any white space definitions you have created. After white space is defined, you can assign image and text content to the white space areas by creating rules that determine what content is assigned and under what conditions it is assigned.
1.3.1.7.1 Creating definitions for known white space
Areas with overlays, page segments, barcodes, and images are considered available white space and you can create a white space definition over them. However, this is not recommended unless you want the content to merge with the existing content.
The white space area is only defined on the current page of the page group.
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file.
- If the file does not contain page groups, use AFP Indexer to create page groups.
- Click .
- Select the page in the page group where you want to define white space.
- Position your cursor at a corner of the area where you want to define white space.
While pressing the left mouse button, draw a box the approximate size of the white
space area. You can draw a horizontal, vertical, or square box.In a later step, you can specify the exact position and size of the white space area.
- Right-click anywhere on the page and click Using known white space.If a white space area is already defined on the page, you see an error message. Otherwise, you see the White space tab in the Using known white space window with the page you selected displayed in the Current Page field.
- Type a name for the white space definition.Give the definition a descriptive name to distinguish it from other definitions.
- From the drop-down list, select which page you want the white space area added to:
- This page
- Adds the white space area to the current page.
- Last page
- Adds the white space area to the last page. You can only select this option if the current page is the last page in the page group. You might want to create a Last page definition instead of This page when the page groups contain a variable number of pages and you want the white space to always be on the last page.
- Optional: On the Position tab, change the origin (top-left corner) and size (width and height) of the white
space area in inches or millimeters. Decimal values (such as 2.5) are allowed.Fields on the Position tab shows the fields on the Position tab.
Fields on the Position tab
Field Value Description Origin of area: X position Any decimal value, such as 2.5. The X position cannot be greater than the width of the page. The horizontal distance (in inches or millimeters) of the left side of the white space area measured from the left side of the logical page (not the physical sheet of paper). Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the X position from the top-left corner of the logical page in the unrotated view.Origin of area: Y position Any decimal value, such as 2.5. The Y position cannot be greater than the height of the page. The vertical distance (in inches or millimeters) of the top of the white space area measured from the top of the logical page (not the physical sheet of paper). Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the Y position from the top-left corner of the logical page in the unrotated view.Size of area: Width Any decimal value, such as 2.5. The width of the area cannot be greater than the width of the page. The horizontal width (in inches or millimeters) of the white space area measured in the unrotated view. Size of area: Height Any decimal value, such as 2.5. The height of the area cannot be greater than the height of the page. The vertical height (in inches or millimeters) of the white space area measured in the unrotated view. - Click OK. You see the defined white space area displayed as a colored box.
- Verify that the correct white space area has been defined:
- In the bottom pane, click the White spaces tab.
- Expand a page group and double-click the white space definition.You see a rectangle box highlighting the white space area on the page you selected.
- If the white space area is incorrect, modify or delete it ( ).
- Optional: To create another white space definition, go to step 4 and repeat the steps.
1.3.1.7.2 Creating definitions by searching for white space
When Whitespace Manager finds white space that meets the specifications on that page, it stops the search.
Areas with overlays, page segments, barcodes, and images are considered available white space and you can create a white space definition over them. However, this is not recommended unless you want the content to merge with the existing content.
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file.
- If the file does not contain page groups, use AFP Indexer to create page groups.
- Click .
- Select a page in the page group.
- Position your cursor at a corner of the area where you want to define white space.
While pressing the left mouse button, draw a box the approximate size of the white
space area. You can draw a horizontal, vertical, or square box.In a later step, you can specify the exact position and size of the white space area.
- Right-click anywhere on the page and click Searching for white space.If the maximum number of white space areas are defined, you see an error message. Otherwise, you see the White space tab in the Searching for white space window with the page you selected displayed in the Current Page field.
- Type a name for the white space definition.Make sure you give the definition a descriptive name to distinguish it from other definitions.
- Specify the minimum width and height for the white space area.Whitespace Manager searches for the first available white space that meets the minimum specified dimensions. The fields are:
- Width
- Any decimal value, such as 0.75, for the horizontal width (in inches or millimeters) of the white space area. The minimum width of the area can be equal to or greater than 0.5 inches or 12.7 millimeters.
- Height
- Any decimal value, such as 0.75, for the vertical height (in inches or millimeters) of the white space area. The minimum height of the area can be equal to or greater than 0.5 inches or 12.7 millimeters.
- From the drop-down list in the Select Pages in the Page Group section, select which
page or pages you want the white space area added to:
- This page
- Adds the white space area to the current page unless a known white space area is defined or no white space area meets the specified dimensions.
- This and following pages
- Searches the current page and all pages that follow in the page group and adds the white space area on the first page where it finds white space that meets the specified dimensions.
- Last page
- Adds the white space area to the last page unless a known white space area is defined or no white space area meets the specified dimensions. You can only select this option if the current page is the last page in the page group. You might want to create a Last page definition instead of This page when the page groups contain a variable number of pages and you want the white space to always be on the last page.
- Optional: On the Position tab, change the origin (top-left corner) and size (width and height) of the white
space area.Fields on the Position tab shows the fields on the Position tab.
Fields on the Position tab
Field Value Description Origin of area: X position Any decimal value, such as 2.5. The X position cannot be greater than the width of the page. The horizontal distance (in inches or millimeters) of the left side of the white space area measured from the left side of the logical page (not the physical sheet of paper). Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the X position from the top-left corner of the logical page in the unrotated view.Origin of area: Y position Any decimal value, such as 2.5. The Y position cannot be greater than the height of the page. The vertical distance (in inches or millimeters) of the top of the white space area measured from the top of the logical page (not the physical sheet of paper). Note: If you rotated the AFP file using the Rotate by 90o option on the View menu, specify the Y position from the top-left corner of the logical page in the unrotated view.Size of area: Width Any decimal value, such as 2.5. The width of the area cannot be greater than the width of the page. The horizontal width (in inches or millimeters) of the white space area measured in the unrotated view. Size of area: Height Any decimal value, such as 2.5. The height of the area cannot be greater than the height of the page. The vertical height (in inches or millimeters) of the white space area measured in the unrotated view. - Click OK. You see the defined white space area displayed as a colored box.
- Verify that the correct white space area has been defined:
- In the bottom pane, click the White spaces tab.
- Expand a page group and double-click the white space definition.You see a rectangle box highlighting the white space area on the page you selected.
- If the white space area is incorrect, modify or delete it ( ).
- Optional: Optional: To create another white space definition, go to Step 4 and repeat the steps.
1.3.1.7.3 Modifying or deleting white space definitions
1.3.1.7.3.1 Modifying known white space definitions
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for white space.
- Click .
- Click .
- Do one of these:
- Select a known white space definition and then click Modify.
- Double-click the known white space definition that you want to modify.
You see the Using known white space window. The Current Page field displays the page in the page group where the white space was created. If the Which Page field is grayed-out, you cannot change it. - Optional: On the White space tab, type a new name for the white space area in the Definition name field and select a page option from the Which Page drop-down list if it is available.
- Optional: On the Position tab, change the origin (top-left corner) and size (width and height) of the white space area.
- Click OK.
1.3.1.7.3.2 Modifying white space defined from a search
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for white space.
- Click .
- Click .
- Do one of these:
- Select a white space definition created from a search and then click Modify.
- Double-click the white space definition from a search that you want to modify.
You see the Searching for white space window. The Current Page field displays the page in the page group where the white space was created. If the Which Page field is grayed-out, you cannot change it. - Optional: On the White space tab:
- Type a new name for the white space area in the Definition name field.
- Change the minimum width and height for the white space area. Whitespace Manager searches for the first available white space that meets the minimum specified dimensions.
- Select a page option from the Which Page drop-down list if it is available.
- Optional: On the Position tab, change the origin (top-left corner) and size (width and height) of the white space area.
- Click OK.
1.3.1.7.3.3 Deleting white space definitions
- In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the white space.
- Click .
- Click .You see the Modify and Delete Definitions window with definitions of white space from a search and known white space.
- Select the white space definition that you want to delete.
- Click Delete, or press the Delete key on your keyboard.The white space definition is removed from the list. Any rules created for the white space definition are also deleted.
- To close the Modify and Delete Definitions window, click X in the upper right corner.
1.3.1.7.4 Assigning content to white space
1.3.1.7.4.1 Creating rules for assigning content
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file and the control file that contains white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Select a white space definition from the list in the top pane of the window.
- Click Create rules/content.The default rule Always is displayed and highlighted below the white space definition. Always means that the content is assigned to the white space with no restrictions.
- Optional: Specify one or more conditions if you want a rule other than Always:
- Click Create in the Conditions section.You see the Create Condition window.
- Select an index tag and operator from the drop-down lists, type a value, and then
click OK.The Always rule is replaced with the condition you created.
- Optional: Click Create to create another condition for the rule.You see the Create Condition window.
- Select an index tag and operator from the drop-down lists, type a value, and then click OK. The condition you created is added to the rule with the And operator between conditions.
- Optional: Click Or in the Combine conditions section to change the operator from the default And. The rule is displayed with Or as the operator between conditions.
- Click Create in the Conditions section.
- Specify the content that is assigned when the rule is true:
- Click Insert text to assign text. You see the Insert Text window.
- Define the text string data and the text color on the Text tab.
- Optional: Change the text font on the Font tab.
- Optional: Adjust the text position in the white space area on the Position tab.
- Click OK.
- Optional: Repeat the steps to add more text.
- Click Insert image to assign an image. You see the Insert Image window.
- On the Image tab, specify the image type, file name, and whether the image is added inline. If the file type is JPEG or GIF, specify the width and height of the image.
- Optional: Adjust the image position in the white space area on the Position tab.
- Click OK.
- Optional: Repeat the steps to add another image.
- Click Preview to view how the text and images you created are displayed in the defined white space.You see the If Content Preview window. To close the window, click the X in the upper right corner.
- Click Insert text to assign text. You see the Insert Text window.
- Optional: Specify the content that is assigned when the rule is false.This section is not available when the rule is Always.
- Click Insert text to assign text. You see the Insert Text window.
- Define the text string data and the text color on the Text tab.
- Optional: Change the text font on the Font tab.
- Optional: Adjust the text position in the white space area on the Position tab.
- Click OK.
- Optional: Repeat the steps to add more text.
- Click Insert image to assign an image. You see the Insert Image window.
- On the Image tab, specify the image type, file name, and whether the image is added inline. If the file type is JPEG or GIF, specify the width and height of the image.
- Optional: Adjust the image position in the white space area on the Position tab.
- Click OK.
- Optional: Repeat the steps to add another image.
- Click Preview to view how the text and images you specified are displayed in the defined white
space.You see the Else Content Preview window. To close the window, click the X in the upper right corner.
- Click Insert text to assign text. You see the Insert Text window.
- Optional: To create another rule, go to Step 4 and repeat the steps.
- Click OK.
1.3.1.7.4.2 Inserting content text
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Do one of these:
- Select an existing rule from the list in the top pane of the window.
- Select a white space definition from the list in the top pane of the window and then click Create rules/content to create a new rule.
- Click Insert text in the Content section.You see the Insert Text window.
- On the Text tab, create a text string.Remember to add blank characters between words if you need to. For example, to add the page number, such as "Page 1 of 10", to the first page of each page group:
- Type Page and a space in the Text field and click Add.
- Select Page in Page Group from the Property drop-down list and click Add. Page in Page Group is the number of the page in the page group.
- Type a space, of, and another space in the Text field and click Add.
- Select Page Group Page Count from the Property drop-down list and click Add. Page Group Page Count is the total number of pages in the page group.
You see the text string value in the field below the data fields. - Optional: To edit the text string, select a line of data and use Up or Down to change the order of the line or Remove to delete the line.Remember to add blank characters between words if you need to.
- Optional: Select a color for the text from the Color drop-down list.
- Optional: On the Font tab, select one of these:
- Core Fonts
- From the drop-down lists, select the character set and code page, and, if the font is an outline font, the point size in the Font Information section.
- External Fonts
- Type a character set and code page pair, a coded font name, or all three. For double-byte
character set (DBCS) fonts, use the coded font name only.
- Note:
- If you enter a code page that is part of a DBCS-coded font, you see an error message that suggests you use the coded font name instead.
- Note:
- On your workstation, if the font size does not exist for the color you selected, your display defaults to 12 black, even though the final AFP file will have the correct font and color.
- Optional: On the Position tab, change the origin (top-left corner) of the text area. Specify the origin in
inches or millimeters. Decimal values (such as 2.5) are allowed. The fields are:
- X position
- The horizontal distance of the left side of the area measured from the left side of the text area.
- Y position
- The vertical distance of the top of the area measured from the top of the text area.
- Click OK. The text is added to the rule and the list in the drop-down box.
- Optional: Click Preview to view how the text you specified is displayed in the defined white space.To close the window, click the X in the upper right corner.
1.3.1.7.4.3 Inserting content images
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Do one of these:
- Select an existing rule from the list in the top pane of the window.
- Select a white space definition from the list in the top pane of the window and then click Create rules/content to create a new rule.
- Click Insert image in the Content section.You see the Insert Image window.
- On the Image tab, do these:
- Select the file type in the Type drop-down list. If the file type is JPEG or GIF, you must specify the size of the
image in these fields:
- Width
- Any positive decimal value, such as 0.75, for the horizontal width (in inches or millimeters) of the image. The default width is 0.5 inches or 12.7 millimeters.
- Height
- Any positive decimal value, such as 0.75, for the vertical height (in inches or millimeters) of the image. The default height is 0.5 inches or 12.7 millimeters.
- Type a file name in the Image file name field, or click Browse to select a file.
- Optional: Click Add image inline to add the image to the resource group in the AFP file.
- Select the file type in the Type drop-down list. If the file type is JPEG or GIF, you must specify the size of the
image in these fields:
- Optional: On the Position tab, change the origin (top-left corner) of the image area. Specify the origin in
inches or millimeters. Decimal values (such as 2.5) are allowed. The fields are:
- X position
- The horizontal distance of the left side of the area measured from the left side of the image area.
- Y position
- The vertical distance of the top of the area measured from the top of the image area.
- Click OK. The image is added to the rule and the list in the drop-down box.
- Optional: Click Preview to view how the image you specified is displayed in the defined white space.To close the window, click the X in the upper right corner.
- Click OK.If you added the image inline, you see the image listed in the inline resource group in the left pane.
1.3.1.7.4.4 Modifying content text
- In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Select a rule from the list in the top pane of the window.
- Select text content from the drop-down list.
- Click Edit in the Content section.You see the Modify Text window.
- Optional: On the Text tab, change data in the Text string data section, change the color in the Color drop-down list, or both.To edit the text string, select a line of data and use Up or Down to change the order of the line or Remove to delete the line. You can also add new values. Remember to add blank characters between words if you need to. For example, to change the text string from "Page 1 of 10" to "Page 1 for John Doe":
- Press and hold the CTRL key, and then select of and Page Count.
- Click Remove.
- Type for in the Text field and click Add.
- Select an index tag that contains the customer name (such as John Doe) from the Index tag drop-down list and click Add.
You see the edited text string value in the field below the data fields. - Optional: On the Font tab, select one of these:
- Core Fonts
- From the drop-down lists, select the character set and code page, and, if the font is an outline font, the point size in the Font Information section.
- External Fonts
- Type a character set and code page pair, a coded font name, or all three. For double-byte
character set (DBCS) fonts, use the coded font name only.
- Note:
- If you enter a code page that is part of a DBCS-coded font, you see an error message that suggests you use the coded font name instead.
- Note:
- On your workstation, if the font size does not exist for the color you selected, your display defaults to 12 black, even though the final AFP file will have the correct font and color.
- Optional: On the Position tab, change the origin (top-left corner) of the text area. Specify the origin in inches or millimeters. Decimal values (such as 2.5) are allowed.
- Click OK. You see the edited text.
- Optional: Click Preview to view how the text you specified is displayed in the defined white space.To close the window, click the X in the upper right corner.
1.3.1.7.4.5 Modifying content images
- Note:
- In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click .
- In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Select a rule from the list in the top pane of the window.
- Select image content from the drop-down list.
- Click Edit in the Content section.You see the Modify Image window.
- Optional: On the Image tab, you can do these:
- Change the file type in the Type drop-down list. If the file type is JPEG or GIF, you must specify the size of the
image in these fields:
- Width
- Any positive decimal value, such as 0.75, for the horizontal width (in inches or millimeters) of the image. The default width is 0.5 inches or 12.7 millimeters.
- Height
- Any positive decimal value, such as 0.75, for the vertical height (in inches or millimeters) of the image. The default height is 0.5 inches or 12.7 millimeters.
- Type a file name in the Image file name field, or click Browse to select a file.
- Click Add image inline to add the image to the resource group in the AFP file.
- Change the file type in the Type drop-down list. If the file type is JPEG or GIF, you must specify the size of the
image in these fields:
- Optional: On the Position tab, change the origin (top-left corner) of the image. Specify the origin in inches or millimeters. Decimal values (such as 2.5) are allowed.
- Click OK.
- Optional: Click Preview to view how the image you specified is displayed in the defined white space.To close the window, click the X in the upper right corner.
1.3.1.7.4.6 Creating rule conditions for content
- In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Do one of these:
- Select an existing rule from the list in the top pane of the window.
- Select a white space definition from the list in the top pane of the window and then click Create rules/content to create a new rule.
- Click Create in the Conditions section.You see the Create Condition window.
- Use the drop-down list to select an index tag in the Index tags field.
- Use the drop-down list to select one of these in the Operator field:
- greater than
- less than
- equals
- contains
- Type a value in the Value field.
- Click OK. The condition you created is added to the rule.
- Optional: Click Create to create another condition for the rule.The condition you created is added to the rule with the And operator between conditions.
- Optional: Click Or in the Combine conditions section to change the operator from the default And. The rule is displayed with Or as the operator between conditions.
- Click OK.
1.3.1.7.4.7 Modifying rule conditions for content
- In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Select an existing rule from the list in the top pane of the window.
- Click Edit in the Conditions section.You see the Edit Condition window.
- Optional: Use the drop-down list to change the index tag in the Index tags field.
- Optional: Use the drop-down list to change to one of these in the Operator field:
- greater than
- less than
- equals
- contains
- Optional: Change the value in the Value field.
- Click OK.The condition you edited is modified in the rule.
- Optional: Click Or or And in the Combine conditions section to change the operator between conditions. The rule is displayed with the operator you selected.
- Click OK.
1.3.1.7.4.8 Deleting content from white space
- In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
- Click .
- Click .You see the Manage Campaigns window.
- Select a rule from the list in the top pane of the window.
- Optional: To delete conditions:
- Select a condition from the drop-down list.
- Click Delete in the Conditions section.You see that the condition has been removed from the rule.
- Repeat the steps to delete another condition in the rule.If you delete all the conditions, the rule defaults to Always.
- Optional: To delete content:
- Select content from the drop-down list.
- Click Delete in the Content section.You see that the content has been removed from the rule.
- Repeat the steps to delete more content from the rule.
- Optional: To delete a rule and all its conditions and content, click Delete in the top pane.You see that the rule has been removed from the list.
- Optional: To delete another rule or the conditions or content for a rule, go to Step 4 and repeat the steps.
- Click OK.
1.3.1.8 Enhancing production AFP files
The AFP Visual Environment commands use the control file that the AFP Visual Environment user interface created when you enhanced the sample AFP file. If the commands run on a different system than the preparation system, you must first send the control file and other optional AFP Visual Environment files to the production system.
1.3.1.8.1 Sending AFP Visual Environment files to the production system
- On the preparation system, use the File Transfer Protocol (
ftp
) to send the AFP Visual Environment control files to the production system. Use theftp
binary option. - Optional: If you created AFP Visual Environment font-mapping files, on the preparation system use
ftp
to send the font-mapping files to a directory on the production system. Use theftp
binary option. - Optional: If you created IMB serial number files, use
ftp
to send the serial number files to the production system. Use theftp
binary option.
1.3.1.8.2 Creating page groups and indexes in production AFP files
IndexAFP applies the definitions that create page groups and index tags to an AFP file that contains MO:DCA-P data and writes the result to another AFP file. You can run IndexAFP directly, or you can use the PluginMgr command to run IndexAFP. If the control file also contains definitions to create hidden areas and bar codes, it is more efficient to run PluginMgr because it can run IndexAFP and EditAFP at the same time.
- Do one of these:
- Run the IndexAFP command. For example:
- AIX:
java -jar /install_directory/plugins/IndexAFP/IndexAFP.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- Windows:
java -jar C:\install_directory\plugins\IndexAFP\IndexAFP.jar -i C:\directory\infile.afp -o C:\directory\outfile.afp -c C:\directory\infile.ctl
- z/OS UNIX:
java -jar /install_directory/plugins/IndexAFP/IndexAFP.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- AIX:
- Run the PluginMgr command. For example:
- AIX:
java -jar /install_directory/PluginMgr.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- Windows:
java -jar C:\install_directory\PluginMgr.jar -i C:\directory\infile.afp -o C:\directory\outfile.afp -c C:\directory\infile.ctl
- z/OS UNIX:
java -jar /install_directory/PluginMgr.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- AIX:
For install_directory, use the directory where you installed AFP Visual Environment.For directory, use the directory where the file is located.
- Run the IndexAFP command. For example:
- If the return code from IndexAFP or PluginMgr is <0, look in stderr or the log for error messages.
- Repeat the command for each production AFP file.
1.3.1.8.3 Creating hidden areas, bar codes, and text masks in production AFP files
EditAFP applies the definitions for hidden areas, bar code, and text masks to an AFP file and writes the result to another AFP file. You can run EditAFP directly, or you can use the PluginMgr command to run EditAFP. If the control file also contains definitions to create page groups and index tags, it is more efficient to run PluginMgr because it can run IndexAFP and EditAFP at the same time.
- Optional: If the production system is different from the preparation system, use the
File Transfer Protocol (
ftp
) to send the control file, font-mapping files (if any), and IMB serial number file (if any) to the production system.Use theftp
binary option. - Do one of these:
- Run the EditAFP command. For example:
- AIX:
java -jar /install_directory/plugins/EditAFP/EditAFP.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- Windows:
java -jar \install_directory\plugins\EditAFP\EditAFP.jar -i \directory\infile.afp -o \directory\outfile.afp -c \directory\infile.ctl
- z/OS UNIX:
java -jar /install_directory/plugins/EditAFP/EditAFP.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- AIX:
- Run the PluginMgr command. For example:
- AIX:
java -jar /install_directory/PluginMgr.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- Windows:
java -jar \install_directory\PluginMgr.jar -i \directory\infile.afp -o \directory\outfile.afp -c \directory\infile.ctl
- z/OS UNIX:
java -jar /install_directory/PluginMgr.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
- AIX:
For install_directory, use the directory where you installed AFP Visual Environment.For directory, use the directory where the file is located.
- Run the EditAFP command. For example:
- If the return code from EditAFP or PluginMgr is <0, look in stderr or the log for error messages.
- Run the command again for each production AFP file.
1.3.1.9 AFP Visual Environment commands
1.3.1.9.1 EditAFP command
Format
EditAFP
-c controlfile [-cp codepage] [-fontMapDir fontmapdirectory]
-i inputfile [-log] -o outputfile [-resDir resourcedirectories]
[-snf serialfile[:barcodedefinition] [-threads nn][-tracetracefile]
[-trclvl level][-ue userexit] [-version]
Options
- -ccontrolfile
- The full path name of the AFP Visual Environment control file that contains the page group and index tag definitions. This option is required.
- -cpcodepage
- The default code page. This option is not required.
Values for codepage are:
- IBM500
- An EBCDIC code page (default).
- IBM850
- An ASCII code page.
- -fontMapDirfontmapdirectory
- The full path name of the directory that contains customized font-mapping files, which override the default font-mapping files. This option is not required. If it is not specified, only the default font-mapping files are used.
- -iinputfile
- The full path name of the input AFP file that you want to process. The input file
must contain MO:DCA-P data with no line data. This option is required.
To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with
//
. When you specify a fully qualified name, two sets of quotation marks are required. For example,"//'USERID.PDS(MYDOC)'"
or"//'USERID.SEQDS'"
. When you specify a partially qualified name, you only need one set of quotation marks. For example,"//PDS(MYDOC)"
or"//SEQDS"
. - -log
- EditAFP writes messages to the
edit.log
file in the directory where theEditAFP.jar
file is located. If the file exists, EditAFP appends messages to it. This option is not required. If it is not specified, EditAFP writes messages only to the terminal. - -ooutputfile
- The full path name of the file where the output AFP file is written. Any existing
data in the file is overwritten. This option is required.
To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with
//
. When you specify a fully qualified name, two sets of quotation marks are required. For example,"//'USERID.PDS(MYDOC)'"
or"//'USERID.SEQDS'"
. When you specify a partially qualified name, you only need one set of quotation marks. For example,"//PDS(MYDOC)"
or"//SEQDS"
. - -resDirresourcedirectory;...
- The full path names of one or more AFP resource directories that contain AFP resources.
EditAFP looks for AFP resources in these resource directories before the resource
directories identified to AFP Visual Environment when the control file was created. This option is not required.
Specify this option if AFP resources are not inline and are not in the same directories that you identified to AFP Visual Environment when the control file was created.
Separate multiple directories with a semicolon. If a resource directory path name contains a blank, enclose the path name in double quotation marks.
- -snfserialfile[:barcodedefinition];...
- The name of the Intelligent Mail bar code (IMB) serial number file and the name of
the bar code definition in the control file that the serial number file applies to.
This option is not required. If it is not specified, EditAFP uses the serial number
file that was specified in the bar code definition when the control file was created.
If you specify more than one serial number file and bar code definition name, separate
them with a semicolon as shown in
Examples
.- serialfile
- The full path name of the serial number file.
- barcodedefinition
- The name of the bar code definition. This name is optional. If no bar code definition name is specified, the serial number file is used for all IMBs in the AFP file. If the bar code definition name contains blanks or other special characters, enclose the name in double quotation marks.
Examples:
AIX or Linux:
-snf /directory/serialfile
-snf /directory/tofile:"to IMB"
-snf /directory/tofile:"to IMB";/directory/replyfile:"reply IMB"
Windows:-snf C:\directory\serialfile
-snf C:\directory\tofile:"to IMB"
-snf C:\directory\tofile:"to IMB";\directory\replyfile:"reply IMB"
- -threadsnn
- The number of threads that EditAFP starts. This option is not required. The default
is five threads.
Note: If the control file contains bar code definitions for IMBs that use a serial number file and you want the serial numbers in the IMBs to be in sequential order by page group (for example, the serial number in the first page group is 000001, the serial number in the second page group is 000002, and so on) specify one thread. If you specify more than one thread, the serial numbers might not be in sequential order by page group. No matter how many threads you specify, the serial number in each IMB is unique.
Example:
-threads 1
- -tracetracefile
- The full path name of the file where EditAFP writes trace information. If the file already exists, EditAFP appends to it. Otherwise, EditAFP creates the file. Use this option for diagnostic purposes only. This option is not required.
- -trclvllevel
- The level of tracing. This option is not required.
Values for level are:
- debug
- Trace at a higher level.
- normal
- Trace at a lower level (default).
- -ueuserexit
- The user exit class name. This option is not required.
- -version
- Displays the version number of EditAFP. This option is not required.
Examples–EditAFP
AIX: This example creates the hidden areas and bar codes defined in theinfile.ctl
control file and writes the output to the outfile.afp
file:
java -jar /install_directory/plugins/EditAFP/EditAFP.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
Windows: This example creates the hidden areas and bar codes defined in the infile.ctl
control file and writes the output to the outfile.afp
file:
java -jar \install_directory\plugins\EditAFP\EditAFP.jar -i \directory\infile.afp -o \directory\outfile.afp -c \directory\infile.ctl
z/OS: This example creates the hidden areas and bar codes defined in the infile.ctl
control file and writes the output to the outfile.afp
file. Enter this command on the z/OS UNIX command line:
java -jar /install_directory/plugins/EditAFP/EditAFP.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
directory/infile.ctland writes the output to MVS data set
USERID.OUTPUT.AFP(OUTFILE). (The output MVS data set must be cataloged.) On the z/OS UNIX command line, enter:
java -jar /directory/plugins/EditAFP/EditAFP.jar -i//'USERID.INPUT.AFP(INFILE)-o//'USERID.OUTPUT.AFP(OUTFILE)-c /directory/infile.ctl;
/directory/infile.ctland writes the output to MVS data set
USERID.OUTPUT.AFP(OUTFILE). (The output MVS data set must be cataloged.) The IMB serial number files are
/directory/toserialand
/directory/replyserial. On the z/OS UNIX command line, enter:
java -jar /directory/plugins/EditAFP/EditAFP.jar -i//'USERID.INPUT.AFP(INFILE)-o//'USERID.OUTPUT.AFP(OUTFILE)-c /directory/infile.ctl -rd /directory/plugins/EditAFP -snf /directory/toserial:"to IMB";/directory/replyserial:"reply IMB";
For install_directory, use the directory where you installed AFP Visual Environment.
For directory, use the directory where the file is located.
Exit codes
- 0
- EditAFP was successful.
- <0
- EditAFP was not successful. No output file was created, or the output file is incomplete. EditAFP writes error messages to stderr and in the log file.
1.3.1.9.2 IndexAFP command
Format
IndexAFP -c controlfile [ -cp codepage] [ -docIdx indexfile][ -fontMapDir fontmapdirectory] [ -formDef formdefinition] -i inputfile [ -log] -o outputfile [ -resDir resourcedirectories] [ -resGrp resourcegroupfile] [ -stats][ -te triggerexit] [ -threads nn] [ -trace tracefile] [ -trclvl level] [ -ue userexit][ -version]
- Note:
- Brackets indicate that the option is not required. Do not type any brackets when you enter the command.
Options
- -c controlfile
- The full path name of the AFP Visual Environment control file that contains the page group and index tag definitions. This option is required unless the -te option is specified.
- -cp codepage
- The default code page. This option is not required.
- Values for codepage are:
- IBM500
- An EBCDIC code page (default).
- IBM850
- An ASCII code page.
- -docIdx indexfile
- The full path name of the document index file that you want AFP Visual Environment to create. Any existing data in the file is overwritten.
- This option is not required. If it is not specified, the document index file is not created.
- -fontMapDir fontmapdirectory
- The full path name of the directory that contains customized font-mapping files, which override the default font-mapping files.
- This option is not required. If it is not specified, only the default font-mapping files are used.
- -formDef formdefinition
- The full path name of the form definition that contains the active medium map for the first page in each page group. IndexAFP writes the name of the active medium map in the document index file, and IndexAFP includes the form definition in the resource group file.
- This option is not required. If this option is not specified, IndexAFP uses the medium map name in the first inline form definition or, if no inline form definitions exist, in the first Invoke Medium Map (IMM) structured field. If no inline form definitions or IMM structured fields exist, IndexAFP uses a null name to indicate that the first medium map in the form definition is the active medium map for the first page.
- Example:
-formDef F1USER10
- -i inputfile
- The full path name of the input AFP file that you want to process. The input file must contain MO:DCA-P data with no line data.
- This option is required.
- -log
- IndexAFP writes messages to the index.log file in the directory where the IndexAFP.jar file is located. If the file exists, IndexAFP appends messages to it.
- This option is not required. If it is not specified, IndexAFP writes messages only to the terminal.
- -o outputfile
- The full path name of the file where the output AFP file is written. Any existing data in the file is overwritten.
- This option is required.
- -resDir resourcedirectory;...
- The full path names of one or more AFP resource directories that contain AFP resources. IndexAFP looks for AFP resources in these resource directories before the resource directories identified to AFP Visual Environment when the control file was created. This option is not required.
- Specify this option if AFP resources are not inline and are not in the same directories that you identified to AFP Visual Environment when the control file was created.
- Separate multiple directories with a semicolon. If a resource directory path name contains a blank, enclose the path name in double quotation marks.
- -resGrp resourcegroupfile
- The full path name of the resource group file that you want IndexAFP to create. Any existing data in the file is overwritten. This option is not required. If it is not specified, IndexAFP does not create a resource group file.
- If IndexAFP cannot find a resource, it creates the resource file without the missing resource and writes a message identifying the missing resource to stderr and in the log file.
- -stats
- IndexAFP writes statistics to the terminal.
- This option is not required.
- -te triggerexit
- The trigger exit class name.
- This option is not required.
- -threads nn
- The number of threads that IndexAFP starts. The default is 5 threads.
- This option is not required.
- -trace tracefile
- The full path name of the file where IndexAFP writes trace information. If the file already exists, IndexAFP appends to it. Otherwise, IndexAFP creates the file. Use this option for diagnostic purposes only.
- -trclvl level
- The level of tracing. This option is not required.
- Values for level are:
- debug
- Trace at a higher level.
- normal
- Trace at a lower level (default).
- -ue userexit
- The user exit class name.
- This option is not required.
- -version
- Displays the version number of IndexAFP.
- This option is not required.
Examples–IndexAFP
AIX: This example creates page groups and index tags defined in the infile.ctl
control file and writes the output to the outfile.afp
file:
java -jar /install_directory/plugins/IndexAFP/IndexAFP.jar-i /directory/infile.afp -o /directory/outfile.afp-c /directory/infile.ctl
Windows: This example creates page groups and index tags defined in the infile.ctl
control file and writes the output to the outfile.afp
file:
java -jar \install_directory\plugins\IndexAFP\IndexAFP.jar-i \directory\infile.afp -o \directory\outfile.afp-c \directory\infile.ctl
z/OS: This example creates page groups and index tags defined in the infile.ctl
control file and writes the output to the outfile.afp
file. Enter this command on the z/OS UNIX command
line:
java -jar /install_directory/plugins/IndexAFP/IndexAFP.jar-i /directory/infile.afp -o /directory/outfile.afp-c /directory/infile.ctl
For install_directory, use the directory where you installed AFP Visual Environment.
For directory, use the directory where the file is located.
Exit codes
- 0
- IndexAFP was successful.
- <0
- IndexAFP was not successful. No output file was created, or the output file is incomplete. IndexAFP writes error messages to stderr and in the log file.
1.3.1.9.3 PluginMgr command
It is more efficient to use PluginMgr to run the EditAFP and IndexAFP commands at the same time than to run them separately. However, if you want IndexAFP to create a resource group file, you must run the IndexAFP command.
Format
PluginMgr
-c controlfile [ -docIdx indexfile ] [-edit [:options;]]
[-fontMapDir fontmapdirectory] [-formDef formdefinition]
-i inputfile [ -index [: options; ] ] -o outputfile[-pluginDir plugindirectory ] [ -resDir resourcedirectories ] [-trace tracefile] [ -trclvl level ] [ -version ]
Options
- -ccontrolfile
- The full path name of the AFP Visual Environment control file that contains the page group and index tag definitions. This option is required.
- -docIdxindexfile
- The full path name of the document index file that you want AFP Visual Environment to create. Any existing data in the file is overwritten. This option is not required. If it is not specified, the document index file is not created.
- -edit[:options;]
- Indicates that PluginMgr is to run the EditAFP command, and specifies EditAFP options.
Valid EditAFP options are:
- -snfserialfile[:barcodedefinition];...
- The name of the Intelligent Mail bar code (IMB) serial number file and the name of
the bar code definition in the control file that the serial number file applies to.
If -snf is not specified, EditAFP uses the serial number file that was specified in the bar
code definition when the control file was created. If you specify more than one serial
number file and bar code definition name, separate them with a semicolon as shown
in
Examples
.- serialfile
- The full path name of the serial number file.
- barcodedefinition
- The name of the bar code definition. If no bar code definition name is specified, the serial number file is used for all IMBs in the AFP file. If the bar code definition name contains blanks or other special characters, enclose the name in double quotation marks.
- -ue
- The user exit class name.
- If you specify EditAFP options, type a colon before the options and a semi-colon after
the options, as shown in
Examples
. If you do not specify any EditAFP options, do not type the colon and semi-colon.Note: The -edit and -index options interract in this way:- If neither -edit nor -index is specified, PluginMgr can run both IndexAFP and EditAFP, depending on which definitions are in the control file. If the control file contains definitions that AFP Indexer created, PluginMgr runs AFPIndex first because definitions that AFP Editor created might depend on page groups and index tags that AFP Indexer created.
- If -edit is specified but not -index, PluginMgr runs only EditAFP.
- If -index is specified but not -edit, PluginMgr runs only IndexAFP.
Examples:
-edit
-edit:-snf /directory/serialfile
;-edit:-snf /directory/tofile:"to IMB";/directory/replyfile:"reply IMB";
- -fontMapDirfontmapdirectory
- The full path name of the directory that contains customized font-mapping files, which override the default font-mapping files. This option is not required. If it is not specified, only the default font-mapping files are used.
- -formDefformdefinition
- The full path name of the form definition that contains the active medium map for
the first page in each page group. PluginMgr writes the name of the active medium
map in the document index file and includes the form definition in the resource group
file.
This option is not required. If this option is not specified, PluginMgr uses the medium map name in the first inline form definition or, if no inline form definitions exist, in the first Invoke Medium Map (IMM) structured field. If no inline form definitions or IMM structured fields exist, PluginMgr uses a null name to indicate that the first medium map in the form definition is the active medium map for the first page.
Example:
-formDef F1USER10
- -iinputfile
- The full path name of the input AFP file that you want to process. The input file
must contain MO:DCA-P data with no line data. This option is required.
To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with
//
. When you specify a fully qualified name, two sets of quotation marks are required. For example,"//'USERID.PDS(MYDOC)'"
or"//'USERID.SEQDS'"
. When you specify a partially qualified name, you only need one set of quotation marks. For example,"//PDS(MYDOC)"
or"//SEQDS"
. - -index[:options;]
- Indicates that PluginMgr is to run the IndexAFP command, and specifies IndexAFP options.
Valid IndexAFP options are:
- -te
- The trigger exit class name.
- -ue
- The user exit class name.
If you specify IndexAFP options, type a colon before the options and a semi-colon after the options, as shown in
Examples
. If you do not specify any IndexAFP options, do not type the colon and semi-colon.Note: The -edit and -index options interract in this way:- If neither -edit nor -index is specified, PluginMgr can run both IndexAFP and EditAFP, depending on the definitions in the control file. If the control file contains definitions that AFP Indexer created, PluginMgr runs AFPIndex first because definitions that AFP Editor created might depend on page groups and index tags that AFP Indexer created.
- If -edit is specified but not -index, PluginMgr runs only EditAFP.
- If -index is specified but not -edit, PluginMgr runs only IndexAFP.
Examples:
-index
-index:-ue /directory/userexit;
-index:-ue /directory/userexit; -edit
- -ooutputfile
- The full path name of the file where the output AFP file is written. Any existing
data in the file is overwritten. This option is required.
To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with
//
. When you specify a fully qualified name, two sets of quotation marks are required. For example,"//'USERID.PDS(MYDOC)'"
or"//'USERID.SEQDS'"
. When you specify a partially qualified name, you only need one set of quotation marks. For example,"//PDS(MYDOC)"
or"//SEQDS"
.If you specify an MVS data set, allocate and catalog the data set before you run PluginMgr. Allocate the output data set with these characteristics:- Record format: VBM
- Record length: 8K (8192) bytes or larger
- -pluginDirplugindirectory
- The full path name of the directory that contains the IndexAFP and EditAFP directories.
Specify this option only if you moved the IndexAFP and EditAFP directories to a different
directory after installation. This option is not required. If it is not specified,
the default directory is
./plugins
. - -resDirresourcedirectory;...
- The full path names of one or more AFP resource directories that contain AFP resources.
PluginMgr looks for AFP resources in these resource directories before the resource
directories identified to AFP Visual Environment when the control file was created. This option is not required.
Specify this option if AFP resources are not inline and are not in the same directories that you identified to AFP Visual Environment when the control file was created.
Separate multiple directories with a semicolon. If a resource directory path name contains a blank, enclose the path name in double quotation marks.
- -tracetracefile
- The full path name of the file where PluginMgr writes trace information. If the file already exists, PluginMgr appends to it. Otherwise, PluginMgr creates the file. Use this option for diagnostic purposes only.
- -trclvllevel
- The level of tracing. This option is not required.
Values for level are:
- debug
- Trace at a higher level.
- normal
- Trace at a lower level (default).
- -version
- Displays the version number of PluginMgr. This option is not required.
Examples–PluginMgr
AIX: This example applies all the definitions in the infile.ctl
control file and writes the output to file outfile.afp
:
java -jar /install_directory/PluginMgr.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
Windows: This example applies all the definitions in the infile.ctl
control file and writes the output to file outfile.afp
:
java -jar \install_directory\PluginMgr.jar -i \directory\infile.afp -o \directory\outfile.afp -c \directory\infile.ctl
z/OS: This example applies all the definitions in the infile.ctl
control file and writes the output to file outfile.afp
. Enter this command on the z/OS UNIX command line:
java -jar /install_directory/PluginMgr.jar -i /directory/infile.afp -o /directory/outfile.afp -c /directory/infile.ctl
For install_directory, use the directory where you installed AFP Visual Environment.
For directory, use the directory where the file is located.
Exit codes
- 0
- PluginMgr was successful.
- <0
- PluginMgr was not successful. No output file was created, or the output file is incomplete. Error messages are written to stderr.
1.3.1.10 Configuration files
1.3.1.10.1 Font mapping files
AFP Visual Environment provides sample installation font-mapping files that you can edit.
1.3.1.10.1.1 CharacterSets.properties file
CharacterSets.properties
file maps an AFP character set to corresponding font attributes or an AFP font global
identifier (FGID) to a corresponding Java font name and style. You can add custom
AFP character sets to this file.The sample file that you can edit is CharacterSets.properties
.
Purpose
TheCharacterSets.properties
file lets you specify which font attributes to use for custom AFP font character
sets or which FGIDs to use for Java fonts.Format
Each line in the file has one of these formats:
-
characterset=fgid,height,width,strikeover,underline
For example:C?H200A0=2304,110,73,0,0
-
fgid=name,style
For example:2304=Lucinda Sans Regular,PLAIN
- characterset
- The 8-character identifier for the AFP character set. The second character in standard
AFP character set names indicates the character rotation. You can use a question mark
(?) as a wildcard character for the second character of the character set name. The
? means that the identifier applies to all rotations.
Note: To change which Java font is used when an AFP character set is not mapped to a Java font, specify
DEFAULT
for the identifier of the AFP character set. IfDEFAULT
is specified for more than one entry in the file, the last entry is used. - fgid
- A unique value in this range, 3840 to 4095 or 65260 to 65534, for the AFP font global identifier, which indicates the type family, typeface, and sometimes the point size of the character set.
- height
- The vertical size of the character expressed in tenths of a point. For example, a 9-point font has a height of 90. Valid values are whole numbers from 1 to 990.
- name
- The name of the corresponding Java font, such as:
Lucida Bright
,Lucida Sans Regular
, orLucida Sans Typewriter
. - strikeover
- A font whose characters all have a line, parallel to the character baseline, placed over the middle of the character. The values are 0=No and 1=Yes.
- style
- The style of the Java font. Valid values are:
BOLD
,BOLD|ITALIC
,ITALIC
, andPLAIN
. - underline
- A font whose characters all have a line, parallel to the character baseline, placed under the character. The values are 0=No and 1=Yes.
- width
- The average horizontal size of the characters in 1440th of an inch. Valid values are whole numbers from 1 to 99; however, the value is currently ignored.
Syntax rules
- Start each line in column one.
- A pound sign (#) in column one indicates the line is a comment.
- All values are case-sensitive.
- All parameters are positional.
- Blanks are not allowed unless the font name contains a blank (for example, Lucida Bright).
1.3.1.10.1.2 CodedFonts.properties file
CodedFonts.properties
file maps an AFP coded font to its AFP character set and AFP code page.You can edit this file if you created or modified a code page or a character set and
linked them in a coded font or if you have a different code page and character set
pair that you linked in a coded font. The sample file that you can copy and edit is
CodedFonts.properties
.
Purpose
TheCodedFonts.properties
file lets you specify the AFP coded font for custom AFP code pages and character
sets.Format
Each line in the file has this format:codedfont=characterset,codepageFor example:
X?H210AC=C?H200A0,T1V10500
- codedfont
- The identifier for the AFP coded font, which joins the character set and the code
page. The second character in standard AFP coded font names indicates the character
rotation. You can use a question mark (?) as a wildcard character for the second character of the coded font name. The ? means that the identifier applies to all rotations.
Note: To change which AFP character set and code page is used when an AFP coded font is not mapped to an AFP character set and code page, specify
DEFAULT
for the identifier of the AFP coded font. IfDEFAULT
is specified for more than one entry in the file, the last entry is used. - characterset
- The 8-character identifier for the AFP character set. The second character in standard AFP character set names indicates the character rotation. You can use a question mark (?) as a wildcard character for the second character of the character set name. The ? means that the identifier applies to all rotations.
- codepage
- The AFP code page name.
Syntax rules
- Start each line in column one.
- A pound sign (#) in column one indicates the line is a comment.
- All values are case-sensitive.
- All parameters are positional.
- Blanks are not allowed.
1.3.1.10.1.3 CodePages.properties file
CodePages.properties
file maps an AFP code page or a Java character set encoding to an AFP code page global
identifier (CPGID). You can add custom code pages to this file. The sample file that
you can edit is CodePages.properties
.Purpose
TheCodePages.properties
file lets you specify which AFP code page global identifier (CPGID) to use for custom
AFP code pages or Java character sets.Format
Each line in the file has this format:name=cpgid,[DBCS|SBCS]For example:
T1000259=259,SBCSor
IBM500=259,DBCS
- cpgid
- The code page global identifier (CPGID) for the AFP code page or Java character set.
- DBCS|SBCS
- Optional indicator for double-byte character set (DBCS) or single-byte character set (SBCS). The default is SBCS.
- name
- The AFP code page name or the Java character set name.
Syntax rules
- Start each line in column one.
- A pound sign (#) in column one indicates the line is a comment.
- All values are case-sensitive.
- All parameters are positional.
- Blanks are not allowed.
1.3.1.10.1.4 SampleCodePointMap.cp file
SampleCodePointMap.cp
file maps code points in a custom AFP code page to Unicode code points. You can use
this file to create a code point map file for each AFP code page that does not use
standard Unicode code points.The name of the file must contain the name of the code page. For example, if the code
page name is T1000259, name the file T1000259.cp
. The sample file that you can edit and rename is SampleCodePointMap.cp
.
Purpose
TheSampleCodePointMap.cp
file lets you map code points in a custom AFP code page to Unicode code points so
that AFP Visual Environment can display the text correctly. For example, the Unicode code point for a space is
hexadecimal 0020. If the AFP code page uses a code point for a space, such as hexadecimal
0040, map code point
0040to code point
0020.
For charts showing Unicode code points, see http://unicode.org/charts/.
Format
Each line in the file has this format:AFPcodepoint=UnicodecodepointFor example:
0040 0020
- AFPcodepoint
- The hexadecimal code point in the custom AFP font.
- Unicodecodepoint
- The corresponding hexadecimal Unicode code point.
Syntax rules
- Start each line in column one.
- A pound sign (#) in column one indicates the line is a comment.
- Blanks are allowed.
1.3.1.10.2 IMB serial number file
Purpose
The IMB serial number file lets you create barcodes that contain sequential serial numbers.Format
The file contains these lines:digits=6|9 serial numberFor example:
digits=9 000000001
- digits=6|9
- The number of digits in the serial number. Valid values are:
- 6
- The serial number contains 6 digits. When the serial number reaches 999999, the serial number wraps to 000001. This is the default if digits is not specified.
- 9
- The serial number contains 9 digits. When the serial number reaches 999999999, the serial number wraps to 000000001.
- serial_number
- The serial number to encode in the first IMB in an AFP file.
Syntax rules
- Start each line in column one.
- The file can contain only 2 lines. The lines can be in any order.
- No comments are allowed.
1.3.1.10.3 Document index file
Purpose
The document index file lets you use archival and retrieval applications to retrieve a page group within the AFP file based on its index values.Format
The format of this file is similar to the document index file that the AFP Conversion and Indexing Facility (ACIF) program creates. However, the resource group file that AFP Visual Environment creates contains only group-level Index Element (IEL) structured fields; it does not contain page-level IELs. The format is:BDI IEL TLE EDI
- BDI
- Begin Document Index (BDI) structured field.
- IEL
- Index Element (IEL) structured field. The IEL structured field associates the index tags with a page group in the output AFP file.
- TLE
- Tag Logical Element (TLE) structured field. The TLE structured fields in the document index file are the same as those in the AFP file.
- EDI
- End Document Index (EDI) structured field.
1.3.1.10.4 Resource group file
Purpose
The resource group file lets you print a file on a system that does not contain the AFP resources by concatenating the AFP file and its resource group file.Format
The format of this file is similar to the resource group file that the AFP Conversion and Indexing Facility (ACIF) program creates. However, the resource group file that AFP Visual Environment creates does not contain the name of the AFP file. The format is:BRG
BRS
AFP resource
ERS
ERG
- BRG
- Begin Resource Group (BRG) structured field
- BRS
- Begin Resource (BRS) structured field
- AFP resource
- The AFP resource
- ERS
- End Resource (ERS) structured field
- ERG
- End Resource Group (ERG) structured field
1.3.1.11 Accessibility
The accessibility features in AFP Visual Environment let users:
- Operate some features using only the keyboard.
- Customize some display attributes, such as font size.
AFP Visual Environment documentation is accessible using screen readers on the RICOH Software Information Center at https://help.ricohsoftware.com/swinfocenter/.
1.4 Line2PDF Plus
The following publications are available for Line2PDF. Click the PDF link after the book title to open a PDF version of the book in a new tab. Click the HTML link to open the HTML version of the book in this tab.
1.4.1 Line2PDF Plus User’s Guide
1.4.1.1 Introduction
1.4.1.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
1.4.1.1.2 Cautions regarding this guide
- Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
1.4.1.1.3 Publications for the Web Enablement Solutions Suite
This section provides a list of all the publications for the Web Enablement Solutions Suite transforms.
Instruction manuals
- AFP2PDF PLUS
For information about AFP2PDF PLUS, see these documents:
- AFP2PDF Plus User Guide - 1.300
- AFP2PDF Plus Quick Start Guide
- AFP2PDF Plus Setup Guide 1.300
- AFP2PDF Plus Release Notes 1.300
- AFP2PDF Plus - Summary of Updates
- AFP Visual Environment
For information about AFP Visual Environment, see these documents:
- AFP Visual Environment User Guide 6.6
- AFP Visual Environment Release Notes 6.6
- AFP Visual Environment 6.6 Limitations List
- AFPMerge
For information about AFPMerge, see these documents:
- AFPMerge User Guide 3.3
- AFPMerge Release Notes 3.3
- AFPMerge 3.3 Limitations List
- Line2PDF Plus
For information about Line2PDF Plus, see these documents:
- Line2PDF Plus User’s Guide 1.3
- Line2PDF Release Notes 1.3
- Line2PDF Plus 1.3 Limitations List
- PCL2PDF
For information about PCL2PDF, see these documents:
- PCL2PDF 1.3 User’s Guide
- PCL2PDF 1.3 Release Notes
- PCL2PDF 1.3 Limitations List
- PS2PDF
For information about PS2PDF, see these documents:
- PS2PDF 1.3 User’s Guide
- PS2PDF 1.3 Release Notes
- PS2PDF 1.3 Limitations List
- Tiff2PDF
For information about Tiff2PDF, see these documents:
- Tiff2PDF Plus User Guide 1.3
- Tiff2PDF Plus Release Notes 1.3
- Tiff2PDF Plus 1.3 Limitations List
1.4.1.1.4 Symbols
- Important:
- This symbol indicates points to pay attention to when using the product. Be sure to read these explanations.
- Note:
- This symbol indicates helpful supplementary information that is not essential to completing a task.
Bold |
Bold type indicates the names of commands and parameters. |
Bold underline |
Underlined bold type indicates the default value. |
Italic | Italic type indicates variables that you must replace with your own information. |
Monospace |
Monospace type indicates computer input and output and file names. |
[] | Square brackets indicate that a value is optional. |
| | A vertical bar indicates a choice between values. |
... | An ellipsis indicates that a series can continue. |
1.4.1.1.5 Abbreviations
- ANSI
- American National Standards Institute
- API
- Application Programming Interface
- ASCII
- American Standard Code For Information Interchange
- CC
- Carriage Control
- CMOD
- Content Manager OnDemand
- DBCS
- Double Byte Character Set
- EBCDIC
- Extended binary-coded decimal interchange code
- Portable Document Format
- TRC
- Table Reference Character
1.4.1.1.6 Trademarks
These terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both:
- AIX
- IBM
- z/OS
Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.
Oracle, Java are registered trademarks of Oracle Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
The proper names of the Windows operating systems are as follows:
- Windows 10:
Microsoft Windows 10 Pro
Microsoft Windows 10 Enterprise
- Windows Server 2016:
Microsoft Windows Server 2016 Standard
1.4.1.2 Overview
The Line2PDF Plus Transform converts simple line data into Adobe Acrobat Portable Document Format (PDF) files. The text is quickly transformed and displayed on the screen.
It handles both ASCII and EBCDIC and ANSI and machine carriage control. You interact with Line2PDF Plus through a command line or JAVA API interface.
The Line2PDF Plus transform lets you:
- Operate on any system that supports JAVA Version 1.8 or later.
- Integrate multiple servers with little or no client workstation modification. The Line2PDF Plus transform runs on your Web server or other back-end application server.
- View documents with the same fidelity as if they were printed. If the Adobe Acrobat plug-in is installed with a Web browser, you can view and print these documents within the browser application.
- Fully integrate with the IBM Content Manager OnDemand (CMOD) Web Enablement Kit and IBM Content Navigator.
1.4.1.2.1 Benefits
The Line2PDF Plus Transform gives you these added benefits:
- Client / Server implementation.
- Greatly improved transformation speed over Line2PDF .
- Larger than 2 GB input and output file support.
- Reduce costs associated with printing and mailing by delivering documents electronically.
- Quickly retrieve your information within multi-page documents using Adobe Acrobat search and navigation features.
- Print Line2PDF Plus Transform documents on any local printer using the print function in Adobe Acrobat.
1.4.1.2.2 Requirements
- Transform client requirements:
- IBM AIX 7.1 or later
- IBM z/OS UNIX System Services V1.13 or later
- Microsoft Windows 10 Pro, Enterprise or later
- Microsoft Windows Server 2016 Std or later
- Linux Kernel 2.6.18 or later (x86)
- Linux Kernel 2.6.09 or later (IBM System z)
- Transform server requirements:
- JAVA V1.8 or later
- End-user client requirements:
- Adobe Acrobat, Acrobat Reader, or Acrobat Plug-In 9.0 or later
1.4.1.2.3 Limitations
The current limitations with the Line2PDF PlusTransform include:
- Input text data stream must be mappable to code page 1252. Double Byte Character Set (DBCS) is not supported.
- TRC characters are not supported.
1.4.1.3 Running Java Version of Line2PDF Plus
To run Java on Line2PDF Plus use one of these options:
- Java command line.
- Client/Server Model.
1.4.1.3.1 Java Command Line
- Run Java command. This requires a
javaline2pdf.jar
file. - Set
CLASSPATH
to include the full path of the jar file.- For Windows:
set CLASSPATH=<directory>\javaline2pdf.jar;%CLASSPATH%
For example:
set CLASSPATH=C:\Line2pdf\javaline2pdf.jar;%CLASSPATH%
- For other operating systems:
export CLASSPATH=<directory>/javaline2pdf.jar;$CLASSPATH
For example:
export CLASSPATH=/Line2pdf/javaline2pdf.jar;$CLASSPATH
- Note:
- Setting CLASSPATH should be on a single line.
- For Windows:
1.4.1.3.1.1 Line2PDF Plus Command Notation
Command syntax notation uses symbols to show specific conditions:
- Bar
- |
- Brackets
- [ ]
- Underlining
- _
- Ellipsis
- ...
These symbols have the following meanings when used in the publications and in the online information:
- A vertical bar, |, between values means that you can only enter one of the values with the command.
- Brackets, [ ], around values indicate that they are optional.
- An ellipsis, ... , means that you can supply more than one occurrence of a keyword or value with the command.
- Underlined text identifies the default fixed value the transform uses if you do not specify a value.
1.4.1.3.1.2 Java Line2PDF Plus Command Options
- Command line syntax
-
java line2pdf [options] input-file output-file
For example:
- For Windows: java line2pdf c:\linedata.txt c:\linedata.pdf
- For other operating systems: java line2pdf /linedata.txt /linedata.pdf
java line2pdf [options] output-file < input-file
For example:
- For Windows: java line2pdf c:\linedata.pdf < c:\linedata.txt
- For other operating systems: java line2pdf /linedata.pdf < /linedata.txt
Options:
- —g
- Specifies an input configuration file that defines channels.
- Usage note:
- The first line of the channel control file is
[CHANNEL INFO]
, followed by 12 entries consisting of numbers that specify the landing line number where “Skip to channel n" should print. Default values:[CHANNEL INFO] 1 7 13 19 25 31 37 43 63 49 61
- The first line of the channel control file is
- —r
- Replaces existing output file.
- Note:
- The Line2PDF Plus Transform does not overwrite an existing output file by default.
To determine the outlook of the PDF file:
- —wNNN
- Specifies the width of the page to NNN. The units of this parameter are 72 units per inch.
- Default value: 612.
- —hNNN
- Specifies the height of the page to NNN. The units of this parameter are 72 units per inch.
- Default value: 792.
- —n nnn
- Specifies the lines per page to nnn.
- —s n.n
- Specifies the line spacing.
- Default value: 1.0.
- —p nn
- Specifies the font size.
- Default value: 12.
- —f fn
- Specifies a font from the following list:
- Courier
- Courier-Bold
- Courier-Oblique
- Courier-BoldOblique
- Helvetica
- Helvetica-Bold
- Helvetica-Oblique
- Helvetica-BoldOblique
- Symbol
- Times-Roman
- Times-Bold
- Times-Italic
- Times-BoldItalic
- ZapfDingbats
- Default value: Courier.
- —b nn
- Specifies the border size. The units of this parameter are 72 units per inch.
- Default value: 20.
- —m lm tm bm
- Specifies the page margins: lm for left margin, tm for top margin and bm for bottom margin. The units of this parameter are 72 units per inch.
To determine the type, format and line break for the line data:
- —x nnn
- Selects the type of carriage control.
- 0: no carriage control character
- 2: ANSI
- 3: ANSI with TRC
- 4: Machine CC
- 5: Machine CC with TRC
- —l nnn
- Specifies a fix line length, in characters or bytes, where nnn=one of [ 0 | positive
number[,[char|byte]] | record ]
- If nnn=0 (default), new line characters is applied as line break.
- If nnn>0, each line has nnn chars or bytes. Default value is specified in chars.
For example:
- —1 80,char
- —1 80,byte
- If nnn=[record | record+ | record-], variable length record apply:
The first 2 bytes of the record indicate the record length.
- If nnn specifies the record or record+, the record length includes the length of the first 2 bytes.
- If nnn specifies the record-, the record length excludes the length of the first 2 bytes.
- —a nnn
- Selects a code page or data format, where nnn=one of [ASCII|EBDIC|UTF8|UTF16|codepage number].
- Default: ASCII.
- If ASCII is specified, 437 is used for the code page.
- If EBCDEC is specified, 500 is used for the code page.
- —lm nnn
- Specifies the maximum line length to convert.
Other options:
- —user pass
- Specifies the user password.
-
- Note:
- For an encrypted output, —user pass and —pw:psca pass options must be used together with
bcprov-jarfileversion.jar
. Make sure to add the full path of the jar file to CLASSPATH. See Java Command Line for more information on setting CLASSPATH.
- For an encrypted output, —user pass and —pw:psca pass options must be used together with
- —pw:psca pass
- Protects data with password and security flags.
- a
- Adds or modifies text annotations and interactive form fields.
- c
- Modifies the document contents.
- p
- Prints the document.
- s
- Copies the text and graphics from the document.
- —bglogo fn
- Applies the logo/preprint form, where fn is the PDF file name.
- Note:
- If Client and Server are running on different machines, the fn used with the -bglogo option must be a path or a file name, or both, located on the Server machine, not on the Client machine.
- —bglogo +''matrix'' fn
- Applies matrix to logo/preprint form (6 numbers).
- tm1 tm2 tm3 tm4 tm5 tm6
Specifies the linear transformation matrix values that define the origin, rotation, or scale of the appended PDF file. For example:
1 0 0 1 ox oy
- Specifies origin changes, where:
- ox
- Specifies the distance to translate the horizontal dimension.
- oy
- Specifies the distance to translate the vertical dimension.
sx 0 0 sy 0 0
- Specifies scaling changes, where:
- sx
- Specifies the scale factor (1.0-100%) for the horizontal direction.
- sy
- Specifies the scale factor (1.0-100%) for the vertical direction.
cos θ sin θ –sin θ cos θ 0 0
- Specifies rotation changes by an angle θ counterclockwise.
The origin for this operation is the bottom left-hand corner of the page.
- —bglogo: range fn
- Specifies individual pages or a range of pages to apply the logo/preprint form.
- The range value can include individual page numbers or a range of pages.
- To separate pages and page ranges, use commas.
- To specify a range of pages, use a hyphen between the first and last page.
For example: 1,150,212-240,332.
- —bglogo: range +''matrix'' fn
- Specifies individual pages or a range of pages to apply the matrix to logo/preprint form.
- For more information, see —bglogo +''matrix'' fn and —bglogo: range fn.
- Return code
- 0: if no error.
- Other numbers: if any error occurs.
1.4.1.3.2 Running Java Line2PDF Plus Server
Set CLASSPATH
to include javaline2pdf.jar
.
Command line syntax
java Line2PdfServer [-start] | [-stop] [-p socket_port] [-r rmi_port] [-t temp_dir]
For example:
- For Windows:
- java Line2PdfServer -start
- or
- java Line2PdfServer -start -p 8500 -t c:\temp
- For other operating systems:
- java Line2PdfServer -start
- or
- java Line2PdfServer -start -p 8500 -t /temp
Values:
- —start
- Starts the server.
- —stop
- Stops the server.
- —p socket_port (optional)
- Specifies the socket port number for local client.
- Default value:8500.
- —r rmi_port (optional)
- Specifies the RMI port number for remote Line2PdfServer.
- Default value: 8501.
- —t temp_dir (optional)
- Specifies the temporary directory name.
- Default: <currentDir>/temp.
Examples for running Server
Example 1
- To start Line2PdfServer set these values:
- Client port:
- Default 8500.
- RMI port:
- Default 8501.
- Enter the command line: java Line2PdfServer —start.
- To stop Line2PdfServer enter: java Line2PdfServer —stop.
Example 2
- To start Line2Pdf Server set these values:
- Client port: 7200.
- RMI port: 7201.
- Tempdir: /mydir/tmp.
- Enter the command line: java Line2PdfServer —start —p 7200 —r 7201 —t /mydir/tmp.
- To stop Line2PdfServer enter: java Line2PdfServer —stop —p 7200.
1.4.1.3.3 Running Java Agent on Client Machine
Set CLASSPATH
to include:
javaline2pdf.jar
Command line syntax
- To start Line2PdfAgent:
-
Java Line2PdfAgent -s server_host_name [-p client_port] [-sp server_rmi_port]
- To stop Line2PdfAgent:
-
Java Line2PdfAgent -stop [-p client_port]
For example: java Line2PdfAgent -p 8500 -s C7YZV32.us.ricoh.ds -sp 8501
Values:
- —p client_port optional
- The port number line2pdf is connected to.
- Default value: 8500.
- —s server_host_name
- The server host name where Line2PdfServer is running.
- —sp server_rmi_port (optional)
- The server port number Line2PdfAgent is connected to.
- Default value: 8501.
- —stop
- Stop the Line2PdfAgent.
Examples for running Agent on client machine
Example 1
- To start Line2Pdf Agent set these values:
- Client port:
- Default 8500 for C/C++ client.
- Remote host where Line2PdfServer is running: server1.
- RMI port:
- Default 8501.
- Enter the command line: java Line2PdfAgent —s server1.
- To stop Line2PdfAgent enter: java Line2PdfAgent —stop.
Example 2
- To start Line2PdfAgent set these values:
- Client port: 9500.
- For C/C++ client.
- Remote host where Line2PdfServer is running: server1.
- RMI port: 7201.
- Enter the command line: java Line2PdfAgent —p 9500 —s server1—sp 7201.
- To stop Line2PdfAgent enter: java Line2PdfAgent —p 9500 —stop.
1.4.1.4 Client/Server Model
Client is C++ native code, while Server is Java code.
Client supports:
- Windows
- Linux
- AIX
- Sun
- zOS/USS
- zLinux
Client/Server Model topology has 2 options:
- Client and Server on the same machine.
- Client and Server on different machines.
1.4.1.4.1 Client Native C/C++ Program
- Executable Program
- Windows:
line2pdf.exe
. - Other operating systems:
line2pdf
. - Syntax
-
line2pdf [port number] <line2pdf arguments>
Options:
- port number (optional)
- Socket port number. Default value: 8500.
- <line2pdf argument options>
- Same as Java command line.
- Return code
- 0: if no error.
- other numbers: if error occurs.
1.4.1.4.2 Client and Server on the Same Machine
- Client sends the command line arguments to server through socket communication.
- Server sends a thread to transform line data to pdf and then sends the messages back to client to indicate if completed or failed.
1.4.1.4.3 Client and Server on Different Machines
The Client and Agent use the socket for communication, while Agent and Server use Java RMI.
The Agent redirects the client requests to remote server. The LinePdfAgent receives the messages from remote server and then redirects the received messages to the client.
The Agent uploads the input line data to the server and downloads the output PDF file from the server, if transform is completed.
1.4.1.4.4 Enabling Debug Mode for Server and Agent
To turn on the debug mode on Line2PdfServer and Line2PdfAgent use a hidden flag.
Flag —debug must be on the first argument. When debug mode is On debug information is printed on the console.
Example of Line2PdfServer on debug mode:
java Line2PdfServer —debug —start —p 7200 —r 7201
1.5 PCL2PDF
The following publications are available for PCL2PDF. Click the PDF link after the book title to open a PDF version of the book in a new tab. Click the HTML link to open the HTML version of the book in this tab.
1.5.1 PCL2PDF User’s Guide
1.5.1.1 Introduction
1.5.1.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
1.5.1.1.2 Cautions regarding this guide
- Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
1.5.1.1.3 Publications for the Web Enablement Solutions Suite
This section provides a list of all the publications for the Web Enablement Solutions Suite transforms.
Instruction manuals
- AFP2PDF PLUS
For information about AFP2PDF PLUS, see these documents:
- AFP2PDF Plus User Guide - 1.300
- AFP2PDF Plus Quick Start Guide
- AFP2PDF Plus Setup Guide 1.300
- AFP2PDF Plus Release Notes 1.300
- AFP2PDF Plus - Summary of Updates
- AFP Visual Environment
For information about AFP Visual Environment, see these documents:
- AFP Visual Environment User Guide 6.6
- AFP Visual Environment Release Notes 6.6
- AFP Visual Environment 6.6 Limitations List
- AFPMerge
For information about AFPMerge, see these documents:
- AFPMerge User Guide 3.3
- AFPMerge Release Notes 3.3
- AFPMerge 3.3 Limitations List
- Line2PDF Plus
For information about Line2PDF Plus, see these documents:
- Line2PDF Plus User’s Guide 1.3
- Line2PDF Release Notes 1.3
- Line2PDF Plus 1.3 Limitations List
- PCL2PDF
For information about PCL2PDF, see these documents:
- PCL2PDF 1.3 User’s Guide
- PCL2PDF 1.3 Release Notes
- PCL2PDF 1.3 Limitations List
- PS2PDF
For information about PS2PDF, see these documents:
- PS2PDF 1.3 User’s Guide
- PS2PDF 1.3 Release Notes
- PS2PDF 1.3 Limitations List
- Tiff2PDF
For information about Tiff2PDF, see these documents:
- Tiff2PDF Plus User Guide 1.3
- Tiff2PDF Plus Release Notes 1.3
- Tiff2PDF Plus 1.3 Limitations List
1.5.1.1.4 Symbols
- Important:
- This symbol indicates points to pay attention to when using the product. Be sure to read these explanations.
- Note:
- This symbol indicates helpful supplementary information that is not essential to completing a task.
Bold |
Bold type indicates the names of commands and parameters. |
Bold underline |
Underlined bold type indicates the default value. |
Italic | Italic type indicates variables that you must replace with your own information. |
Monospace |
Monospace type indicates computer input and output and file names. |
[] | Square brackets indicate that a value is optional. |
| | A vertical bar indicates a choice between values. |
... | An ellipsis indicates that a series can continue. |
1.5.1.1.5 Abbreviations
- Portable Document Format
- PCL
- Printer Command Language
1.5.1.1.6 Trademarks
These terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both:
- AIX
- IBM
Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Oracle is a registered trademark of Oracle Corporation in the United States, other countries, or both.
PCL is a registered trademark of Hewlett-Packard Company.
UNIX is a registered trademark of The Open Group in the United States and other countries.
The proper names of the Windows operating systems are as follows:
- Windows 10:
Microsoft Windows 10 Pro
Microsoft Windows 10 Enterprise
- Windows Server 2016:
Microsoft Windows Server 2016 Standard
1.5.1.2 Overview
The PCL2PDF transform converts Printer Command Language PCL5e, PCL5c and PCL XL data stream files into Adobe Acrobat Portable Document Format (PDF) files.
1.5.1.2.1 Benefits
The PCL2PDF transform gives you these benefits:
- The product is available on a wide selection of supported operating systems, like Windows and AIX.
- The client has the option to set encryption on resulted PDF that limits user’s ability to print, modify or copy content using Adobe Acrobat or Adobe Reader.
1.5.1.2.2 Requirements
Transform client requirements:
- Microsoft Windows Server 2016 Std. or later
- Windows 10 Pro, Enterprise or later
- IBM AIX 7.1 or later
- Linux Kernel 2.6.18 or later (x86)
End-user client requirements:
- Adobe Acrobat
- Acrobat Reader
1.5.1.2.3 Limitations
The current limitations with the PCL2PDF transform include:
- Encryption method revision number is V2 from PDF reference documentation.
- Permissions apply correctly when both owner and user passwords are specified.
- Paper size is affected only when paper size value is not specified in the PCL input stream.
1.5.1.3 Using the PCL2PDF Transform
The PCL2PDF transform consists of a command-line interface and multiple configurable parameters.
1.5.1.3.1 Command syntax
The syntax for the pcl2pdf client command is::
pcl2pdf [-a perms] [-o password] [-u password] [-p size] input_fn [output_fn]
1.5.1.3.2 Parameters
The following parameters are required:
- -aperms
- Encryption permissions pcsa (p: no printing, c: no changes, s: no selection, a: no adding notations).
- -opassword
- Encryption PDF Owner Password.
- Note:
- This parameter is used only with the -u parameter.
- -upassword
- Encryption PDF User Password.
- Note:
- This parameter is used only with the -o parameter; otherwise, a permissions are not applied.
- -psize
- Paper size.
-
- Note:
- Paper size is affected by this parameter when the paper size value is not specified
in the PCL input stream.
Paper type Paper size letter 8.5in x 11in (default) ledger 11in x 17in legal 8.5in x 14in a4 8.27in x 11.69in a3 11.69in x 16.53in executive 7.25in x 10.5in monarch 3.87in x 7.5in com_10 4.12in x 9.5in dl 4.33in x 8.66in c5 6.38in x 9.01in b5 6.93in x 9.84in
- Paper size is affected by this parameter when the paper size value is not specified
in the PCL input stream.
1.6 PS2PDF
The following publications are available for PS2PDF. Click the PDF link after the book title to open a PDF version of the book in a new tab. Click the HTML link to open the HTML version of the book in this tab.
1.6.1 PS2PDF User’s Guide
1.6.1.1 Introduction
1.6.1.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
1.6.1.1.2 Cautions regarding this guide
- Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
1.6.1.1.3 Publications for the Web Enablement Solutions Suite
This section provides a list of all the publications for the Web Enablement Solutions Suite transforms.
Instruction manuals
- AFP2PDF PLUS
For information about AFP2PDF PLUS, see these documents:
- AFP2PDF Plus User Guide - 1.300
- AFP2PDF Plus Quick Start Guide
- AFP2PDF Plus Setup Guide 1.300
- AFP2PDF Plus Release Notes 1.300
- AFP2PDF Plus - Summary of Updates
- AFP Visual Environment
For information about AFP Visual Environment, see these documents:
- AFP Visual Environment User Guide 6.6
- AFP Visual Environment Release Notes 6.6
- AFP Visual Environment 6.6 Limitations List
- AFPMerge
For information about AFPMerge, see these documents:
- AFPMerge User Guide 3.3
- AFPMerge Release Notes 3.3
- AFPMerge 3.3 Limitations List
- Line2PDF Plus
For information about Line2PDF Plus, see these documents:
- Line2PDF Plus User’s Guide 1.3
- Line2PDF Release Notes 1.3
- Line2PDF Plus 1.3 Limitations List
- PCL2PDF
For information about PCL2PDF, see these documents:
- PCL2PDF 1.3 User’s Guide
- PCL2PDF 1.3 Release Notes
- PCL2PDF 1.3 Limitations List
- PS2PDF
For information about PS2PDF, see these documents:
- PS2PDF 1.3 User’s Guide
- PS2PDF 1.3 Release Notes
- PS2PDF 1.3 Limitations List
- Tiff2PDF
For information about Tiff2PDF, see these documents:
- Tiff2PDF Plus User Guide 1.3
- Tiff2PDF Plus Release Notes 1.3
- Tiff2PDF Plus 1.3 Limitations List
1.6.1.1.4 Symbols
- Important:
- This symbol indicates points to pay attention to when using the product. Be sure to read these explanations.
- Note:
- This symbol indicates helpful supplementary information that is not essential to completing a task.
Bold |
Bold type indicates the names of commands and parameters. |
Bold underline |
Underlined bold type indicates the default value. |
Italic | Italic type indicates variables that you must replace with your own information. |
Monospace |
Monospace type indicates computer input and output and file names. |
[] | Square brackets indicate that a value is optional. |
| | A vertical bar indicates a choice between values. |
... | An ellipsis indicates that a series can continue. |
1.6.1.1.5 Abbreviations
- EPS
- Encapsulated Postscript
- Portable Document Format
- PS
- PostScript
1.6.1.1.6 Trademarks
These terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both:
- AIX
- IBM
Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Oracle is a registered trademark of Oracle Corporation in the United States, other countries, or both.
PCL is a registered trademark of Hewlett-Packard Company.
UNIX is a registered trademark of The Open Group in the United States and other countries.
The proper names of the Windows operating systems are as follows:
- Windows 10:
Microsoft Windows 10 Pro
Microsoft Windows 10 Enterprise
- Windows Server 2016:
Microsoft Windows Server 2016 Standard
1.6.1.2 Overview
The PS2PDF transform converts PostScript and Encapsulated Postscript(EPS) files into Adobe Acrobat Portable Document Format (PDF) files.
1.6.1.2.1 Benefits
The PS2PDF transform gives you these benefits:
- The product is available on a wide selection of supported operating systems, like Windows and AIX.
- The client has the option to set encryption on resulted PDF that limits user’s ability to print, modify or copy content using Adobe Acrobat or Adobe Reader.
- The client has the option to set linearization for the output PDF file.
1.6.1.2.2 Requirements
Transform client requirements:
- Microsoft Windows Server 2016 Std. or later
- Windows 10 Pro, Enterprise or later
- IBM AIX 7.1 or later
- Linux Kernel 2.6.18 or later (x86)
End-user client requirements:
- Adobe Acrobat
- Acrobat Reader
1.6.1.2.3 Limitations
The current limitations with the PS2PDF transform include:
- Encryption method revision number is V2 from PDF reference documentation.
- Permissions apply correctly when both owner and user passwords are specified.
- Linearization is incompatible with producing an encrypted (password protected) PDF file. Linearization is ignored when used together with encryption.
1.6.1.3 Using the PS2PDF Transform
The PS2PDF transform consists of a command-line interface and multiple configurable parameters.
1.6.1.3.1 Command syntax
The syntax for the ps2pdf client command is::
ps2pdf.exe <-a perms> <-l> <-o pw> <-p size> <-u pw>input_fn <output_fn>
1.6.1.3.2 Parameters
The following parameters are required:
- -aperms
- Encryption permissions pcsa (p: no printing, c: no changes, s: no selection, a: no adding notations).
- -l
- Linearize PDF.
- Note:
- This parameter is used without any encryption parameters.
- The Acrobat user interface refers to this as 'Optimised for Fast Web Viewing'.
- -opassword
- Encryption PDF Owner Password.
- Note:
- This parameter is used only with the -u parameter.
- -psize
- Paper size.
-
- Note:
- Paper size is affected by this parameter when the paper size value is not specified
in the PS input stream.
Paper type Paper size letter 8.5in x 11in (default) ledger 17in x 11in legal 8.5in x 14in a4 8.26in x 11.69in archA 9in x 12in archB 12in x 18in archC 18in x 24in archD 24in x 36in archE 36in x 48in a0 33.11in x46.81in a1 23.39in x 33.11in a2 16.54in x 23.39in a3 11.69in x 16.53in a4 8.26in x 11.69in a4small 8.26in x 11.69in a5 5.83in x 8.26in a6 4.13in x 5.83in a7 2.92in x 4.13in a8 2.06in x 2.92in a9 1.46in x 2.06in a10 1.01in x 1.46in isob0 39.38in x 55.67in isob1 27.83in x 39.38in isob2 19.68in x 27.83in isob3 13,90in x 19.68in isob4 9.85in x 13,90in isob5 6.93in x 9.85in c0 36.10in x 51.07in c1 25.51in x 36.10in c2 18.03in x 25.51in c3 12.75in x 18.03in c4 9.01in x 12.75in c5 6.38in x 9.01in c6 4.49in x 6.38in jisb0 40.56in x 57.32in jisb1 28.67in x 40.56in jisb2 20.28in x 28.67in jisb3 14.33in x 20.28in jisb4 10.13in x 14.33in jisb5 7.17in x 10.13in jisb6 5.04in x 7.17in
- Paper size is affected by this parameter when the paper size value is not specified
in the PS input stream.
- -upassword
- Encryption PDF User Password.
- Note:
- This parameter is used only with the -o parameter; otherwise, a permissions are not applied.
1.7 TIFF2PDF Plus
The following publications are available for TIFF2PDF Plus. Click the PDF link after the book title to open a PDF version of the book in a new tab. Click the HTML link to open the HTML version of the book in this tab.
1.7.1 Tiff2PDF User’s Guide
1.7.1.1 Introduction
1.7.1.1.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
1.7.1.1.2 Cautions regarding this guide
- Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
1.7.1.1.3 Publications for the Web Enablement Solutions Suite
This section provides a list of all the publications for the Web Enablement Solutions Suite transforms.
Instruction manuals
- AFP2PDF PLUS
For information about AFP2PDF PLUS, see these documents:
- AFP2PDF Plus User Guide - 1.300
- AFP2PDF Plus Quick Start Guide
- AFP2PDF Plus Setup Guide 1.300
- AFP2PDF Plus Release Notes 1.300
- AFP2PDF Plus - Summary of Updates
- AFP Visual Environment
For information about AFP Visual Environment, see these documents:
- AFP Visual Environment User Guide 6.6
- AFP Visual Environment Release Notes 6.6
- AFP Visual Environment 6.6 Limitations List
- AFPMerge
For information about AFPMerge, see these documents:
- AFPMerge User Guide 3.3
- AFPMerge Release Notes 3.3
- AFPMerge 3.3 Limitations List
- Line2PDF Plus
For information about Line2PDF Plus, see these documents:
- Line2PDF Plus User’s Guide 1.3
- Line2PDF Release Notes 1.3
- Line2PDF Plus 1.3 Limitations List
- PCL2PDF
For information about PCL2PDF, see these documents:
- PCL2PDF 1.3 User’s Guide
- PCL2PDF 1.3 Release Notes
- PCL2PDF 1.3 Limitations List
- PS2PDF
For information about PS2PDF, see these documents:
- PS2PDF 1.3 User’s Guide
- PS2PDF 1.3 Release Notes
- PS2PDF 1.3 Limitations List
- Tiff2PDF
For information about Tiff2PDF, see these documents:
- Tiff2PDF Plus User Guide 1.3
- Tiff2PDF Plus Release Notes 1.3
- Tiff2PDF Plus 1.3 Limitations List
1.7.1.1.4 Symbols
- Important:
- This symbol indicates points to pay attention to when using the product. Be sure to read these explanations.
- Note:
- This symbol indicates helpful supplementary information that is not essential to completing a task.
Bold |
Bold type indicates the names of commands and parameters. |
Bold underline |
Underlined bold type indicates the default value. |
Italic | Italic type indicates variables that you must replace with your own information. |
Monospace |
Monospace type indicates computer input and output and file names. |
[] | Square brackets indicate that a value is optional. |
| | A vertical bar indicates a choice between values. |
... | An ellipsis indicates that a series can continue. |
1.7.1.1.5 Abbreviations
- Portable Document Format
- RMI
- Remote Method Invocation
- TIFF
- Tagged Image File Format
1.7.1.1.6 Trademarks
These terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both:
- AIX
Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Oracle, Sun and Java are registered trademarks of Oracle Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
1.7.1.2 Overview
1.7.1.2.1 Description
1.7.1.2.2 Specifications
- Supported Platforms
- Microsoft®Windows® Server 2003 or later
- AIX 5.3 or later
- Red Hat Enterprise Linux® (RHEL) V5 or later
- SUSE Linux® Enterprise Server (SLES) 10 or later
- Transform server requirements:
- JAVA V1.8 or later
- Client Software Requirements
- Adobe® Acrobat Reader 5.0 or later
- Adobe Acrobat Reader 7.0.5 or later
- Language Support
- Single Byte Character Sets
- Double Byte Character Sets: Simplified and Traditional
- Chinese, Japanese and Korean
1.7.1.3 Running Java version of Tiff2PDF
tiff2pdf.jar
is the only jar file required to run the tiff2pdf application. The main class name
to start Tiff2PDF is tiff2pdf.class
.Environment Variable Settings
- Windows Platform
set CLASSPATH=tiff2pdf.jar;%CLASSPATH%
- Non-Windows Platform
export CLASSPATH=tiff2pdf.jar;$CLASSPATH
To run Java Tiff2PDF you can use one of these options:
- Java command line.
- Client/Server model.
1.7.1.3.1 Java Command Line
- Run Java command. This requires a
tiff2pdf.jar
file. - Set
CLASSPATH
to include the full path of the jar file.- For Windows:
set CLASSPATH=<directory>\tiff2pdf.jar;%CLASSPATH%
- For other operating systems:
export CLASSPATH=<directory>/tiff2pdf.jar:$CLASSPATH
- Note:
- Setting CLASSPATH should be on a single line.
- For Windows:
1.7.1.3.2 Java Tiff2PDF Command Options
- Command line syntax
-
java tiff2pdf [Options] < input tiff file name> <output pdf file name>
Options:
- —w image fit width (Optional)
- Specifies the image width to fit.
- Default value: 612.
- —h image fit height (Optional)
- Specifies the page height to fit.
- Default value: 792.
- —c creator (Optional)
- Specifies the creator of the document.
- —a author (Optional)
- Specifies the author of the document.
- —t title (Optional)
- Specifies the title of document.
- —s subject (Optional)
- Specifies the subject of the document.
- —k keywords (Optional)
- Species the keywords included in the document
For example: java tiff2pdf —c "Mark Johnson" test.tiff
test.pdf
1.7.1.3.3 Running Java Tiff2PDF Server
Set CLASSPATH
to include:
tiff2pdf.jar
Command line syntax
java Tiff2PdfServer [-start] | [-stop] [-p socket_port] [-r rmi_port] [-t temp_dir]Values:
- —start
- Start the server.
- —stop
- Stop the server.
- —p socket_port
- Socket port number for local client.
- Default value: 8800.
- This flag is optional.
- —r rmi_port
- RMI port number for remote Tiff2PdfServer.
- Default value: 8801.
- This flag is optional.
- —t temp_dir
- Temporary directory name.
- Default: <currentDir>/temp.
- This flag is optional.
Examples for running Server
Example 1
- To start Tiff2Pdf Server set these values:
- Client port:
- Default 8800.
- RMI port:
- Default 8801.
- Enter the command line: java Tiff2PdfServer —start.
- To stop Tiff2Pdf Server enter: java Tiff2PdfServer —stop.
Example 2
- To start Tiff2Pdf Server set these values:
- Client port: 7200.
- RMI port: 7201.
- Tempdir: /mydir/tmp.
- Enter the command line: java Tiff2PdfServer —start —p 7200 —r 7201 —t /mydir/tmp.
- To stop Tiff2Pdf Server enter: java Tiff2PdfServer —stop —p 7200.
1.7.1.3.4 Running Java Agent on Client Machine
Set CLASSPATH
to include:
tiff2pdf.jar
Command line syntax
java Tiff2PdfAgent [-p client_port] [-s server_host_name] [-sp server_rmi_port] [-stop]
Values:
- —p client_port (optional)
- The port number C/C++ tiff2pdf is connected to.
- Default value: 8800.
- —s server_host_name
- The server host name where Tiff2PdfServer is running.
- —sp server_rmi_port (optional)
- The server port number Tiff2PdfAgent is connected to.
- Default value: 8801.
- —stop
- Stop the Tiff2PdfAgent.
Examples for running Agent on client machine
Example 1
- To start Tiff2Pdf Agent set these values:
- Client port:
- Default 8800 for C/C++ client.
- Remote host where Tiff2PdfServer is running: server1.
- RMI port:
- Default 8801.
- Enter the command line: java Tiff2PdfAgent —s server1.
- To stop Tiff2PdfAgent enter: java Tiff2PdfAgent —s server1 —stop.
Example 2
- To start Tiff2PdfAgent set these values:
- Client port: 9500.
- For C/C++ client.
- Remote host where Tiff2PdfServer is running: server1.
- RMI port: 7201.
- Enter the command line: java Tiff2PdfAgent —p 9500 —s server1—sp 7201.
- To stop Tiff2PdfAgent enter: java Tiff2PdfAgent —s server1 —p 9500 —stop.
1.7.1.4 Client/Server Model
Client is C++ native code, while Server is Java code.
Client supports:
- Windows
- Linux
- AIX
- Sun
- zOS/USS
- zLinux
Client/Server Model topology has 2 options:
- Client and Server on the same machine.
- Client and Server on different machines.
Typical Client/Server Model using default ports
- Client Machine
- Tiff2PdfAgent uses:
- Socket port for local C/C++ tiff2pdf: 8800.
- RMI port to connect to Tiff2PdfServer on Server Machine: 8801.
- To start Tiff2PdfAgent on Client Machine, enter java Tiff2PdfAgent —s <Server Machine name>.
- To submit the job, run client C/C++tiff2pdf on Client Machine and enter tiff2pdf <input tiff file> <output pdf file>.
- Server Machine
- Tiff2PdfServer uses:
- Socket port for local C/C++ tiff2pdf: 8800.
- RMI port to connect to Tiff2PdfAgent on Agent Machine: 8801.
- To start server on Server Machine, enter java Tiff2PdfServer —start.
- Run client C/C++ tiff2pdf on Server Machine and enter tiff2pdf <input tiff file> <output pdf file>.
1.7.1.4.1 Client Native C/C++ Program
- Executable Programs
- Windows:
tiff2pdf.exe
. - Other operating systems:
tiff2pdf
. - Syntax
-
tiff2pdf [port number] < java tiff2pdf arguments>
Options:
- port number (optional)
- Socket port number. Default value: 8800.
- <java tiff2pdf argument options>
- Same as Java command line.
- Return code
- 0: if no error.
- Other numbers: if error occurs.
1.7.1.4.2 Client and Server on the Same Machine
- Client sends the command line arguments to server through socket communication.
- Server sends a thread to transform tiff data to pdf and then sends the messages back to client to indicate if completed or failed.
1.7.1.4.3 Client and Server on Different Machines
The Client and Agent use the socket for communication, while Agent and Server use Java RMI.
The Agent redirects the client requests to remote server. The Tiff2PdfAgent receives the messages from remote server and then redirects the received messages to the client.
The Agent uploads the input tiff file to the server and downloads the output PDF file from the server, if transform is completed.
1.7.1.4.4 Enabling Debug Mode for Server and Agent
To turn on the debug mode on Tiff2PdfServer and Tiff2PdfAgent use a hidden flag.
Flag —debug must be on the first argument. When debug mode is On debug information is printed on the console.
Example of Tiff2PdfServer on debug mode:
java Tiff2PdfServer —debug —start —p 7200 —r 7201