xxnullxx - 5f5fb01032c87800014847e1

RICOH Transforms Suite

RICOH Transforms Suite

1 RICOH Transforms Suite

RICOH Transforms Suite includes the following products.

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.

  • Quick Start Guide for AFP2PDF Plus PDF HTML

  • AFP2PDF Plus Setup Guide PDF HTML

  • AFP2PDF Plus User's Guide PDF HTML

  • Known limitations, problems, and workarounds for AFP2PDF Plus PDF

  • Release Notes for AFP2PDF Plus 1.5 PDF

  • AFP2PDF Plus - Summary of Updates 1.5 PDF HTML

  • AFP2PDF Plus - Summary of Updates PDF HTML

1.1.1 RICOH AFP2PDF Plus: Summary of Updates (March 2020-September 2025)

Date

Release number

Summary of changes

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:
  • The formula to convert from CMYK to RGB for images.
  • Font map processing.
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:
  • Modified position calculation for Type3 glyphs.
  • Added Type3Glyph_Position_Legacy, a new options file parameter.

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:
  • Form definition pointer not to be used if on internal medium map.
  • ASCII space not to be used as substitute for code point 0 for type3 fonts.
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:
  • Fixed underscore processing to allow an underscore control to remain active across multiple TRN text controls.
  • Added support for overstrike text controls.
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:
  • Fixed IOCA single tile with tile offset issue.
  • Fixed image mapping issue with page extent.
2020.11.23 1.300.29 US53704:
  • Redesign the processing of object containers with non MODCA images.
  • Fixed object area size not being correctly inherited from parent when it was not present in either IOB or container OEG.
  • Added TIFF images to cache similar to how JPEGs were handled.
  • Added unit base processing (cm vs inch) where missing.

US55966:

  • Added support for image resolution, with and without triplet 9A for non MODCA images.
  • Fixed CDD triplet parsing.

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:
  • Print check digit in HRI when bar code symbology/modifier specifies it is to be printed.
  • Use the correct font mapping files for the HRI font.
  • Use the correct value for the check digit in the bar code symbol generated.
2021.02.02 1.300.38 US57162 - Added support for multi-page TIFF images.
2021.02.08 1.300.39 US57387:
  • Added support for Windows Server 2019.
  • Enhanced server start/stop capabilities.
2021.02.09 1.300.40 US57217 - Upgraded the Bouncy Castle libraries to version 1.68.
2021.02.15 1.300.41 US57319:
  • Added a new filter to set the wide-to-narrow ratio for Code39 and Int. 2 of 5 bar code objects to match AFP2PDF native.
  • Mapped HRI fonts to use the same font as the text.
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:
  • Added the functionality of logging to separate files in server and API mode.
  • Increased default cache size for resources to 100M.
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:
  • Fixed processing of external form definition in filters for non-existing inline resource group.
  • Fixed split_afp2pdf to issue a warning message for duplicated file names when using the legacylog flag.
  • Fixed the ignore_bar_code_object_area parameter to be ignored when checking if the image exceeds the page size.
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:
  • Revised the processing of PDF objects.
  • Converted EBCDIC QR Code data to codepage 897 with the use of internal tables.
  • Fixed DE41749 to also work with the IBM J9 Virtual Machine (JVM).
2021.07.30 1.300.59 DE41716 & DE41663.2:
  • Changed the Codabar minimum module width to match the legacy AFP2PDF and corrected the symbol width calculation.
  • Changed split_afp2pdf to only issue duplicated file warning messages from one thread.
2021.08.13 1.300.60 DE41870:
  • Fixed non-MODCA image objects processing of the position mapping option to not convert when the image exceeds the object area.
  • Fixed processing of TIFF to allow random access instead of sequential.
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:
  • Fixed high memory usage when processing PDF resources.
  • Increased maximum heap size in start server script.
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:
  • Fixed the EAN8 barcode: incorrect middle guard character drawing.
  • Fixed the Codabar (NW7) barcode: incorrect checkdigit position and special case for 0.
  • Fixed the PDF417 barcode: element height not using the correct BCOCA unit.
  • Fixed the Code39 barcode: symbol width calculation not taking into account intercharacter gaps.
2021.12.15 1.300.73 DE42654 & DE42655 & DE42656:
  • Fixed nullpointerexception when TIFF resource not found AND fixed TIFF decompression error.
  • Fixed char rotation 90 positioning. Use AFP codepage when specified for barcode HRI.
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:
  • Fixed inconsistent error codes when having memory usage issues with split_afp2pdf.
  • Added page segment caching for page segments using the LDOPM triplet.
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 STATIC_PAGE_LENGTH configuration file option to specify the logical page size.

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.
2025.01.31 1.301.45 WESS-5743 Improved Disable_Compression option.
2025.02.03 1.301.46 WE3-603 Fixed XXE (XML External Entity) vulnerability.
2025.02.11 1.301.47 WE3-606 Fixed clipping issue with page segments when page offsets are specified in the options file. WE3-608 Fixed missing content in output when image mapping INDEX_STATICIMG_... type options were used with page segment or overlay resources.
2025.02.25 1.301.48 WESS-5659 Fixed the Capture_Debug option not capturing the log file in server mode.
2025.03.26 1.301.49 WE3-615 Fixed character space increment not being picked up from character set resources that were not named exactly as they were referenced, such as C0M24F41 vs. C1M24F41.
2025.04.10 1.301.50 WESS-5927 Extend the -p parameter functionality to allow specifying a page range (previously only a single page was allowed).
2025.04.22 1.301.51 WESS-5929 Added a default font configuration choice (mapping vs. embedding fonts) when installing AFP2PDF Plus.
2025.05.22 1.301.52 WESS-6218 Added more specific logging to errors coming from the ua plugin. Fixed potential version out of sync error with the ua plugin.
2025.07.07 1.301.53 WESS-6293 Improved debug capture feature.
2025.07.23 1.301.54 WESS-6445 Moved imageProperties class to the common code, no functional change.
2025.07.25 1.301.55 WESS-6160 Added support for the text that is using TrueTypeCollection fonts.

1.1.2 RICOH AFP2PDF Plus: Summary of Updates 1.5.0 (October 2025-present)

Date

Release number

Summary of changes

2026.09.22 1.5.0 Updated documents and version number for release 1.5.0.
2026.08.24 1.4.3.2 Internal change. Update Font API to better work for coded font.
2028.08.05 1.4.3.1 Update Bouncy Castle to version 1.85 to address security vulnerabilities.
2026.07.17 1.4.3 Updated the User Guide, copyright year, and version number.
2026.06.10 1.4.2.3 WE3-645 Fixed issue where missing code points in TrueType fonts were skipped instead of using the default glyph.
2026.05.28 1.4.2.2 Internal changes.
2026.05.05 1.4.2.2 Upgrade to Bouncy Castle 1.8.4.
2026.04.01 1.4.2 Updated the User Guide, copyright year, and version number.
2026.02.20 1.4.1.2 WE3-641 Fixed issue of inputs being locked in API mode when certain exceptions occur. WE3-642 Fixed TTF/TTC recognition issue.
2026.02.16 1.4.1.1 Upgrade to Bouncy Castle 1.83.
2026.01.21 1.4.1 Updated the User Guide, copyright year, version number.
2026.01.13 1.4.0.2 WESS-7061 Fixed crash when attempting to grab a debug capture in file input/output api mode.
2025.12.07 1.4.0.1 WE3-637 Fixed NPE discovered while investigating customer missing resource issue. Updated build number for consistency: 1.400.01 becomes 1.4.0.1 and we will keep this format moving forward. Updated user guide with note for installation when /tmp has exec limitations.
2025.10.08 1.400.00 WESS-4521 Added license key checks.

1.1.3 Quick Start Guide for AFP2PDF Plus, Version 1.5

1.1.3.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.3.2 AFP2PDF Plus Version

To identify the transform version, use:

For Windows: afp2pdf.bat -version
For Unix: afp2pdf.sh -version
For example:
AFP2PDF: Version 1.200.04

Trial version

The AFP2PDF Plus installer will automatically install a 60-day trial license.

1.1.3.3 Installing AFP2PDF Plus using the installer

The AFP2PDF Plus transform has a installer that guides you through the installation process.

See the chapter Installing AFP2PDF Plus Transform using the installer from the AFP2PDF Plus Transform User's Guide, for more details.

1.1.3.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 or start /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.3.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
Testing with the server version
  • For Windows: StartAFP2PDFServer.bat
  • For Unix: StartAFP2PDFServer.sh
To test the server version:
  1. Start the server process. Keep the window open.
  2. 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.3.6 Upgrading from C/C++ AFP2PDF transform to AFP2PDF Plus

AFP2PDF Plus Transform was designed to be plug-in compatible with the previous version of the transform, C/C++ AFP2PDF transform.

To upgrade from the C/C++ AFP2PDF transform to AFP2PDF Plus, you can choose either of these methods:

  • Using the upgrade.jar file

    Upgrade.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:

    1. Unpack the AFP2PDF Plus into a new directory, separate from the current C/C++ AFP2PDF transform installation.
    2. Rename the font directory in the AFP2PDF Plus installation directory.
    3. 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.
    4. 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.
      1. Copy the resource locations from the C/C++ AFP2PDF transform .cfg or .ini file.
      2. Add them to the AFP2PDF Plus a2pxopts.cfg file.
      On a separate new physical server:
      1. Copy all resources to the new server: AFP resources, Type1 fonts, Truetype fonts.
      2. Keep a note of the new resource locations from the C/C++ AFP2PDF transform .cfg or .ini file.
      3. Add them to the AFP2PDF Plus a2pxopts.cfg file.

1.1.3.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.
    Note:
  • Each path is delimited by a semicolon (;).
TrueType_Directory= Indicates the location of TrueType fonts.

1.1.3.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.4 AFP2PDF Plus Setup 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 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.4.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.4.1.3 Guides for This Application

The following guides are available 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.4.1.4 How to Read the Documentation

1.1.4.1.4.1 Before Using This Application

This manual contains detailed instructions and notes on the operation and use of this application. To ensure correct operation, read this manual carefully and completely before using this application. Keep this manual in a handy place for quick reference.

1.1.4.1.4.2 How to Use the Manuals and Help

Use the instruction manuals and field help according to your needs.
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.4.1.4.2.1 Displaying the Instruction Manuals (Setup Guide and User's Guide)

Use this procedure to view the instruction manuals.
Displaying the Setup Guide and User's Guide in PDF Format
  • Displaying the User’s Guide

    User's Guide

  • Displaying the Setup Guide

    Setup Guide

1.1.4.1.4.2.2 Symbols

The following symbols are used in this manual to help you to identify content quickly.
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.4.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 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.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

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.4.2 Before Setting Up

This chapter explains the setup flow and computer requirements of this application.

Read this chapter thoroughly before setting up this application.

1.1.4.2.1 Requirements

To run this installer, your computer must meet the following requirements. Before setup, check that all the requirements are met.

These are the transform client and server requirements and end-user client requirements for the AFP2PDF Plus Transform:

  • Transform requirements:

    • IBM AIX 7.2 or later
    • IBM z/OS UNIX System Services V1.13 or later
    • Microsoft Windows 10 Pro, Enterprise
    • Microsoft Windows 11 Pro
    • Microsoft Windows Server 2016 Standard
    • Microsoft Windows Server 2019 Standard
    • Microsoft Windows Server 2022 Standard
    • Microsoft Windows Server 2025 Standard
    • 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: 64 bit version Java v 1.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 administrative rights on the machine you are installing.

  • To run the installer, you need to have at least 350 MB of free space in the operating system temporary directory.

    Note:
  • Running AFP2PDF Plus requires IBM Semeru Runtimes 17 or later, or a Java distribution from an alternative provider. Legacy IBM SDK, Java Technology Edition is not supported.

1.1.4.3 Installing the AFP2PDF Plus Transform

This chapter explains how to install the transform for the first time.

1.1.4.3.1 Installing the AFP2PDF Plus Transform using the graphic user interface

The AFP2PDF Plus installer is available in two versions based on your Java environment:

Installer file Java version
RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Java8.jar Java 8
RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Java11.jar Java 11 and later
where 1.X.X represents the transform version number.

To start the installer program, perform these steps:

  1. Use the following command: java -jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar, where 1.X.X is the transform version and n is the Java version..

    Note: On some Java versions, due to a bug, the above java -jar command might not start the installer. Use this additional parameter: java -Djdk.util.zip.disableZip64ExtraFieldValidation=true -jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar

    Depending on the capabilities of your operating system, the AFP2PDF Plus transform opens either using a graphical user interface or a command line.
  2. 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.

  3. In the License Agreement dialog box:
    1. Read the license agreement.
    2. Click I accept the terms of the license agreement.
    3. Click Next.

      Note:
    • If you do not accept the terms of the license agreement, you cannot continue the installation.

  4. Check the prerequisites list.
      Note:
    • This step applies only when you install the transform on a UNIX based operating system.
  5. Choose the installation type dialog box.

    New Install
    1. Select New Install for a clean installation of the transform.
    2. Click Next to continue the installation process and browse the destination folder for the installation of the transform.
    3. If the product is already installed in the selected folder, choose another destination folder.
    Upgrade
    1. Select Upgrade to upgrade to the latest version of the transform.
    2. Click Next to continue the installation process and browse the path for the update of the transform.
    3. If the product is not installed in the selected folder, choose another destination folder.

      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.
    • When you perform a fresh installation of the AFP2PDF Plus transform you can specify the default font handling behavior. These are the two options:
      1. Fonts are mapped by default. This option ensures smaller output PDF files size. However, the AFP files that contain fonts that do not have a font mapping will not be displayed correctly.
      2. Fonts are processed and embedded in the resulting PDF files. By using this option, the output PDF files will look more like the input AFP files.
    • On non-Windows operating environments the installer uses the /tmp directory to unpack files and run certain scripts. If there are limitations on the /tmp folder of the system, such as non-exec flag or limited space, a different temporary file directory can be specified using the -Dlax.nl.env.iatempdir= parameter. Example: java -Dlax.nl.env.iatempdir=/custom_temp_dir/ -jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar, where 1.X.X is the transform version and n is the Java version.
  6. 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.

  7. Click Done to close the installer.

Note: On non-Windows operating environments the installer uses the /tmp directory to unpack files and run certain scripts. If there are limitations on the /tmp folder of the system, such as non-exec flag or limited space, a different temporary file directory can be specified using the -Dlax.nl.env.iatempdir= parameter.

1.1.4.3.2 Deploying a license key using the AFP2PDF Plus License key management tool

To run the transform on Linux, Windows, AIX, perform these licensing steps:

  1. In the RICOH AFP2PDF Plus Transform folder, run the executable AFP2PDFLicenseManager.jar located in the license_installer folder.
  2. 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.

  3. On the Choose Install Folder, select the path where the RICOH AFP2PDF Plus Transform is installed.
  4. Select one of the 2 available options:
  5. Install License
    See Installing a Permanent License for more information.
    Revoke License
    See Revoking the License Key for more information.

  6. If you select Install License, you will receive a machine fingerprint that will allow you to generate a new license.
  7. Enter the location of your license file.
  8. Check the pre-installation summary.
  9. To complete the installation process, click Install.
  10. Click Done to close the installer.

    Note: On non-Windows operating environments the installer uses the /tmp directory to unpack files and run certain scripts. If there are limitations on the /tmp folder of the system, such as non-exec flag or limited space, a different temporary file directory can be specified using the -Dlax.nl.env.iatempdir= parameter. Example: java -Dlax.nl.env.iatempdir=/custom_temp_dir/ -jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar where 1.X.X is the transform version and n is the Java version.

1.1.4.3.3 Installing AFP2PDF Plus Transform from command line

To start the command line installer, perform these steps:
  1. Open a command prompt.
  2. Run the following command: java - jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar, where 1.X.X is the transform version and n is the Java version, 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 RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar -i console.
  3. Follow the installation instructions. The steps are similar as in the graphical installer.

1.1.4.3.4 Installing a Permanent License

To continue using AFP2PDF Plus after the trial license expires, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for AFP2PDF Plus on Windows, Linux, AIX:
  1. Run the license management tool AFP2PDFLicenseManager.jar located in the license_installer folder where AFP2PDF Plus is installed, and follow the installation steps.
  2. When prompted You can either install a new license or revoke the currently installed one., select Install License - Upload and apply a new license file.
  3. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  4. If the computer where AFP2PDF Plus is installed does not have Internet access:
    1. Do not close the license application on the computer where AFP2PDF Plus is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where AFP2PDF Plus is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  5. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  6. Click Software Activation on the right side of the screen.
  7. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management application on the computer where AFP2PDF Plus is installed. Copy your machine fingerprint. This action copies the 16-character system fingerprint that uniquely identifies the computer where AFP2PDF Plus is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  8. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  9. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  10. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  11. If you are finished, close the browser tab. To restart the process, click Start Over.
  12. If you accessed the Internet from a different computer than the one where AFP2PDF Plus is installed, copy the license file to the computer where AFP2PDF Plus is installed.
  13. In the license management application on the system where AFP2PDF Plus is installed, enter the path where your license file is installed and click Choose....
  14. Locate the license file and click Select.
  15. Then, click Next and select Install License - Upload and apply a new license file. and follow the installation steps.
  16. Review the installation summary and click Install.
    You see a message that the license was installed successfully.
  17. Click Done.
  18. Restart AFP2PDF Plus if you are using it as a service.

1.1.4.3.5 Revoking the License Key

The Self-service License Key Revoke System (SSR) is designed to permit Ricoh customers a method to move license keys between systems and recover from system failures. If you must revoke more than 2 keys from the same EID, contact your local Ricoh Support team for assistance.
To revoke the license key:
  1. Run the license management tool AFP2PDFLicenseManager.jar located in the license_installer folder where AFP2PDF Plus is installed, and follow the installation steps.
  2. Select the path where your transform is installed.
  3. Then, select Revoke License - Remove the current license file from the system. and click Install.
  4. Select the location that you want to use for your current license, then click Next.
  5. You are instructed to visit https://dl.ricohsoftware.com/?revoke to revoke your license.
  6. Click the Self-Service Revoke button.
  7. Select one of the 3 available revoke methods from the Revoke By list:
    Entitlement ID (EID)
    The EID that you must revoke for the software reporting a license violation condition.
    Activation ID (AID)
    The AID is necessary when you only must revoke a single set of keys for 1 EID. For example, if you accidentally activated using the wrong system fingerprint and have the AID string available.
    License Key File Upload (license.key file)
    Best general-purpose option for resetting all EIDs installed for a specific product on a given server. You can select a license.key file.
  8. Depending on your selection from the Revoke By list, enter the EID, AID, or upload the key file in the Enter your EID, Enter your AID, or Upload Your License File (Max file size, 150 KB) fields.
  9. Enter your company name in the Company Name field. Make sure to use the same the company name used in the original EID email.
  10. To receive the revoke details, enter your valid business email address in the Business Email Address field.
  11. Click Submit.
    After 30 seconds, you receive a notification on the website. If your request could not be approved automatically and requires review, you receive an email from the reviewer within the next few business days.
      Note:
    • Depending on the network speed or processing time, it may last up to 90 seconds until you receive the notification.
  12. Return to the license management application and click Next.
  13. Review the summary and click Install.
    You will see a message that the license was successfully revoked.
  14. Click Done.

1.1.5 AFP2PDF Plus User's Guide

1.1.5.1 Introduction

1.1.5.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.5.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.5.1.3 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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.5.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
PDF
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.5.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 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.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

The proper names of the Windows operating systems are as follows:

  • Windows 10:

    Microsoft Windows 10 Pro

    Microsoft Windows 10 Enterprise

  • Windows 11:

    Microsoft Windows 11 Pro

    Microsoft Windows 11 Enterprise

  • Windows Server 2016:

    Microsoft Windows Server 2016 Standard

  • Windows Server 2019:

    Microsoft Windows Server 2019 Standard

  • Windows Server 2022:

    Microsoft Windows Server 2022 Standard

1.1.5.2 Overview

The AFP2PDF Plus Transform converts AFP documents into Adobe Acrobat PDF files by exactly mapping AFP format to PDF format.

The AFP2PDF Plus Transform lets you:

  • 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.5.2.1 Benefits

The AFP2PDF Plus Transform gives you these added 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.5.2.2 Limitations

The current limitations of the AFP2PDF Plus Transform include:
  • 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.

  • Linked TrueType fonts and the use of a Resource Access Table (RAT) are not supported.

  • Running AFP2PDF Plus requires IBM Semeru Runtimes 17 or later, or a Java distribution from an alternative provider. Legacy IBM SDK, Java Technology Edition is not supported.

1.1.5.3 Installing AFP2PDF Plus Transform using the installer

The AFP2PDF Plus Transform can now be installed using an executable jar file from the ISO file or downloaded from https://dl.ricohsoftware.com.

The AFP2PDF Plus installer is available in two versions based on your Java environment:

Installer file Java version
RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Java8.jar Java 8
RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Java11.jar Java 11 and later
where 1.X.X represents the transform version number.

To run the installer, perform these steps:

  1. Use the following command: java -jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar, where 1.X.X is the transform version and n is the Java version.

    Note: On some Java versions, due to a bug, the above java -jar command might not start the installer. Use this additional parameter: java -Djdk.util.zip.disableZip64ExtraFieldValidation=true -jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar where 1.X.X is the transform version and n is the Java 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 64 bit Java 1.8 or later and administrative rights.
  2. 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.
    • When you perform a fresh installation of the AFP2PDF Plus transform you can specify the default font handling behavior. These are the two options:
      1. Fonts are mapped by default. This option ensures smaller output PDF files size. However, the AFP files that contain fonts that do not have a font mapping will not be displayed correctly.
      2. Fonts are processed and embedded in the resulting PDF files. By using this option, the output PDF files will look more like the input AFP files.
    • On non-Windows operating environments the installer uses the /tmp directory to unpack files and run certain scripts. If there are limitations on the /tmp folder of the system, such as non-exec flag or limited space, a different temporary file directory can be specified using the -Dlax.nl.env.iatempdir= parameter. Example: java -Dlax.nl.env.iatempdir=/custom_temp_dir/ -jar RTS--setupafp2pdfplus-1.X.X--afp2pdfplus_Javan.jar, where 1.X.X is the transform version and n is the Java version.

The 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.5.4 Installing a Permanent License

To continue using AFP2PDF Plus after the trial license expires, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for AFP2PDF Plus on Windows, Linux, AIX:
  1. Run the license management tool AFP2PDFLicenseManager.jar located in the license_installer folder where AFP2PDF Plus is installed, and follow the installation steps.
  2. When prompted You can either install a new license or revoke the currently installed one., select Install License - Upload and apply a new license file.
  3. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  4. If the computer where AFP2PDF Plus is installed does not have Internet access:
    1. Do not close the license application on the computer where AFP2PDF Plus is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where AFP2PDF Plus is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  5. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  6. Click Software Activation on the right side of the screen.
  7. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management application on the computer where AFP2PDF Plus is installed. Copy your machine fingerprint. This action copies the 16-character system fingerprint that uniquely identifies the computer where AFP2PDF Plus is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  8. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  9. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  10. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  11. If you are finished, close the browser tab. To restart the process, click Start Over.
  12. If you accessed the Internet from a different computer than the one where AFP2PDF Plus is installed, copy the license file to the computer where AFP2PDF Plus is installed.
  13. In the license management application on the system where AFP2PDF Plus is installed, enter the path where your license file is installed and click Choose....
  14. Locate the license file and click Select.
  15. Then, click Next and select Install License - Upload and apply a new license file. and follow the installation steps.
  16. Review the installation summary and click Install.
    You see a message that the license was installed successfully.
  17. Click Done.
  18. Restart AFP2PDF Plus if you are using it as a service.

1.1.5.5 Revoking the License Key

The Self-service License Key Revoke System (SSR) is designed to permit Ricoh customers a method to move license keys between systems and recover from system failures. If you must revoke more than 2 keys from the same EID, contact your local Ricoh Support team for assistance.
To revoke the license key:
  1. Run the license management tool AFP2PDFLicenseManager.jar located in the license_installer folder where AFP2PDF Plus is installed, and follow the installation steps.
  2. Select the path where your transform is installed.
  3. Then, select Revoke License - Remove the current license file from the system. and click Install.
  4. Select the location that you want to use for your current license, then click Next.
  5. You are instructed to visit https://dl.ricohsoftware.com/?revoke to revoke your license.
  6. Click the Self-Service Revoke button.
  7. Select one of the 3 available revoke methods from the Revoke By list:
    Entitlement ID (EID)
    The EID that you must revoke for the software reporting a license violation condition.
    Activation ID (AID)
    The AID is necessary when you only must revoke a single set of keys for 1 EID. For example, if you accidentally activated using the wrong system fingerprint and have the AID string available.
    License Key File Upload (license.key file)
    Best general-purpose option for resetting all EIDs installed for a specific product on a given server. You can select a license.key file.
  8. Depending on your selection from the Revoke By list, enter the EID, AID, or upload the key file in the Enter your EID, Enter your AID, or Upload Your License File (Max file size, 150 KB) fields.
  9. Enter your company name in the Company Name field. Make sure to use the same the company name used in the original EID email.
  10. To receive the revoke details, enter your valid business email address in the Business Email Address field.
  11. Click Submit.
    After 30 seconds, you receive a notification on the website. If your request could not be approved automatically and requires review, you receive an email from the reviewer within the next few business days.
      Note:
    • Depending on the network speed or processing time, it may last up to 90 seconds until you receive the notification.
  12. Return to the license management application and click Next.
  13. Review the summary and click Install.
    You will see a message that the license was successfully revoked.
  14. Click Done.

1.1.5.6 Configuring CMOD to work with AFP2PDF Plus Transform

Since the new AFP2PDF Plus Transform is designed to integrate seamlessly with existing Content Manager OnDemand Web Enablement Kit / AFP2PDF Transform installations, see the appropriate IBM documentation for more details about configuring the programs to operate together:
  • 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 be pdf in the browser sections.
  • The InstallDir option in the afp2pdf section must point to the directory on the server that contains the AFP2PDF Plus Transform client program.

1.1.5.7 Configuring IBM Content Navigator to work with AFP2PDF Plus Transform

To use the AFP2PDF Plus Transform with IBM Content Navigator (ICN), you must configure the ICN Administrator plug-in.
  1. Open the web browser where the ICN plug-ins have been installed and log in to the ICN Administrator plug-in.
  2. To configure the installation directory:
    1. On the left-hand side of the browser screen, select Settings.
    2. In the main panel, select the Content Manager OnDemand tab.
    3. In the AFP2PDF installation directory field, enter the fully qualified path name for the directory where the AFP2PDF Plus transform is installed.
    4. Select Save and Close.
  3. To configure the viewer map:
    1. On the left-hand side of the browser screen, select Default Viewer Map.
    2. Make sure that the Repository Type is set to Content Manager OnDemand, Viewer is set to AFP2PDF Conversion, and MIME Type is set to application/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.
  4. Start the AFP2PDF Plus server.

1.1.5.8 Architecture and Configuration

This chapter describes the overall architecture of the AFP2PDF Plus Client/Server implementation and the files used during the configuration process. It also describes security for the transform.

1.1.5.8.1 Architecture

The transform is written in JAVA to take advantage of multi-threaded client/server technology and platform independence. Both a JAVA command line and Application Programming Interface (API) are available.

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.5.8.2 Configuration

This section describes the commands and files used during the initial configuration process. The basic operation of the AFP2PDF Plus client and server are controlled by three configuration files: Server.cfg, logging.properties, and a2pclient.cfg.
Note: The directory and 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, \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.5.8.2.1 Configuring the Server.cfg File

The 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 or StopAFP2PDFServer.sh reads the Server.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 is C:\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.5.8.2.2 Configuring the logging.properties File

The 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.5.8.2.3 Configuring the a2pclient.cfg File

The 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.5.8.3 AFP2PDF Plus Transform Security

The AFP2PDF Plus Transform Encryption supports these Adobe Acrobat security features: encryption and certificate signatures.

1.1.5.8.3.1 Encryption

Encryption protects the contents of the PDF document and lets you restrict certain Adobe Actobat display functions. The Adobe Acrobat password features let users access protected documents and restricted functions.

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.5.8.3.2 Certificate Signatures

Adobe Acrobat supports the use of certificate signatures (also known as digital signatures), which let you sign PDF files with a certificate-based digital ID. This certificate ID is issued by a trusted third-part certificate authority, such as CAcert.org or VeriSign.

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.5.9 Using the AFP2PDF Plus Transform

This chapter describes how to start and stop the AFP2PDF Plus Server and how to run the AFP2PDF Plus Transform client.

1.1.5.9.1 Starting and Stopping the AFP2PDF Plus Server on a Windows Server

For Windows operating systems, two programs are supplied:
  • 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.5.9.2 Starting and Stopping the AFP2PDF Plus Server on a UNIX Server

For UNIX operating systems, two programs are supplied:
  • 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.5.9.3 AFP2PDF Plus Transform Command

The new 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.5.9.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.5.9.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.
-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 +, -, 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’.

-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 the logging.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 in the current working directory of the running application. When using the server mode, the running application is the server and not the client.
-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 named afpdoc.afp, a file named afpdoc.pdf is created.
–ppage_no (-page_no2)
Specifies a page number or a page range 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.5.9.3.3 Return Codes

The afp2pdf client command returns one of these values:

0
The transform completed successfully.
Nonzero
An error occurred.

1.1.5.9.4 AFP2PDF Plus Transform Options File

Parameters to control settings for the AFP2PDF Plus Transform are specified in an options file. By default, the name of this file is 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 the c:\term.pdf file to the beginning of the generated PDF file, while Append_PDF_File=C:\term.pdf,1 appends the c:\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 File ⇒ Properties 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:
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 AFP 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 File ⇒ Properties function is selected in Adobe Acrobat.
    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.
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 uses to search for the font configuration files. By default, this base directory is the \font subdirectory in the current working directory of the running application. When using the server mode, the running application is the server and not the client. 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 the c:\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. The default value is False. 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 File ⇒ Properties 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 the TestLog.afp input file, the resulting log file is TestLog.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. This command overrides the settings in the logging.properties file.
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:

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 File ⇒ Properties 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 File ⇒ Properties 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.5.9.5 Working with AFP Visual Environment Control Files

The AFP2PDF Plus transform uses the AFP Visual Environment (AVE) program to manipulate the AFP before it is converted to PDF. AVE is a JAVA-based program that allows you to manipulate AFP files in a variety of ways.

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.5.9.6 Running AFP2PDF Plus in a private Azure Cloud

Microsoft Azure provides a wide variety of virtual machines with configurable operating systems like Windows, Linux SUSE, CentOS, and configurable resources, for example: memory, CPUs, storage space, storage type HDD/SDD.

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.

Note: To provide support, the support team needs access to information regarding the configuration files or trace information that can be found on the private cloud virtual machines. You must access your virtual machine to retrieve the information we need to provide support in setting up your environment.

1.1.5.10 Using the AFP2PDF Plus Utility Programs

The following utilities for working with AFP files are included with the AFP2PDF Transform Plus program. The jar file a2psplit.jar contains two utilities: split_afp2pdf and Archiveload_afp2pdf.

1.1.5.10.1 split_afp2pdf Command

The 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.5.10.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.5.10.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 of ABC, the output file name ABC 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 and legacy 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 name ABCD.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.5.10.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.5.10.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.5.10.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.5.10.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.5.10.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:
  1. output data file<outDir path>/<afpfile>.ARD.out
  2. index file<outDir path>/<afpfile>.ARD.ind
  3. trigger file<outDir path>/<afpfile>.ARD
-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.5.11 Working with AFP Resources

The AFP resources used by the AFP2PDF Plus Transform include:
  • 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.

Note: The directory and 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, \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.5.11.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.5.11.1.1 Using the country.cfg configuration file

The 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.5.11.1.2 Coded Font Files

The 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.5.11.1.3 Character Set Definition File

The 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:
  • 3840 to 4096
  • 65260 to 65534
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 name is the same as type family in AFP fonts and typeface name in the PDF environment.
style SWISS, ROMAN, SCRIPT, MODERN, DISPLAY ROMAN A type of character face or specific characteristics of the font.
    Note:
  • SWISS is a proportionally spaced, sans serif font.

  • ROMAN is a proportionally spaced, serif font.

  • SCRIPT is a fixed-pitch font designed to look like handwriting.

  • MODERN is a fixed-pitch, sans serif or serif 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.5.11.1.4 Code Page Definition File

The 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.5.11.1.5 Code Page File Map

AFP2PDF Transform provides one code page map file for each AFP code page supplied with Print Services Facility (PSF) and the Data1 and Sonoran licensed programs. These files are installed in the \font\maps subdirectory.
The file is named for its code page global identifier (CPGID) and has a file extension of .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.5.11.1.6 Alias File

The 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 File Example shows an example of how the 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 to Times, and Times is set equal to Times New Roman, then Century Schoolbook is not set equal to Times New Roman.

  • Blanks in family names are treated as characters. For example, New Century Schlbk is not the same font as NewCenturySchlbk.

1.1.5.11.1.7 Font Mapping File

The 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.5.11.2 Process for Mapping Fonts

If your document uses an AFP font that is not listed in the font definition file, if you have modified the AFP fonts, or if you have created your own AFP fonts, you must edit the font definition files to add the fonts so that documents using those fonts display correctly with the AFP2PDF Plus Transform.

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 or coded.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:

  1. Gather the information needed to define the fonts in the font definition files.
  2. 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
    Backup copies let you restore the original file if the modified copy becomes corrupted.
  3. Assign substitutes for nonmatching characters in the code page map file.
    See Process for Mapping Fonts for information about code page map files.
  4. 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.
  5. If you created a new character set, edit the csdef.fnt file.
    1. Add your character set name in the CHARSET section.
    2. Specify the correct attributes for your font.
    3. Add the appropriate information in the FGID section of the file if you are naming a new font global identifier.
  6. If you have created a coded font, create or edit the coded.fnt file and add your coded font.
  7. If you use AFP raster fonts, list the corresponding AFP coded fonts, code pages, and character sets in the afpfont.fnt file.

1.1.5.11.3 Using Custom AFP Raster Font Files

AFP font objects whose names are not listed in the font definition files like 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:

  1. Resources that are inline with the document data
  2. The resource group file specified on the afp2pdf command
  3. 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.5.11.4 Using Custom Font Metric Files

The AFP2PDF Plus Transform can be configured with custom font metric files to control the placement of individual characters and to aid in text alignment. The transform uses the default fonts available in the PDF display application (for example, Adobe Acrobat) and applies special character widths as specified in the font metric file.

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.5.11.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.5.11.6 Mapping AFP Fonts to Type 1 Fonts

You can map an AFP Font file to a Type 1 font by specifying the font name in the Alias file (alias.fnt). The figure below shows an example of the 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.

Note: You can only map single byte fonts to Type1 fonts.
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.5.11.7 Mapping AFP Fonts to TrueType Fonts, OpenType Fonts, or TrueType Collection Fonts

You can map an AFP font file to a TrueType font, OpenType font, or a font included in a TrueType Collection by specifying the TrueType font name in the Alias file (alias.fnt) file. The figure below shows an example of mapping AFP fonts to TrueType fonts, OpenType fonts, or fonts that are included in a TrueType Collection.

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.5.11.8 Using AFP TrueType Fonts

When TrueType fonts and fonts in TrueType font collection are specified in an AFP object container, the AFP2PDF Plus Transform automatically extracts, converts and embeds a TrueType subset into the output PDF file.

Linked TrueType fonts and the use of a 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".
  • Similar to the Truetype fonts, fonts in TrueType font collection that are specified in AFP file, but are not embedded in it are searched within the path specified in the TrueType_Directory configuration file entry. You need an additional config file entry if the font name differs from the font collection name. You need an entry in alias.fnt font config file entry that looks similar to what we have for the mapping AFP fonts to TrueType font collections. For more information about Font3 and Font4, go to: Mapping AFP Fonts to TrueType Fonts, OpenType Fonts, or TrueType Collection Fonts.

1.1.5.11.9 Using User Defined Characters within a DBCS Font

You can configure the AFP2PDF Plus to process a double-byte character set (DBCS). AFP font characters from certain sections are converted, while the rest are mapped. The sections to convert are specified in the UDC_Range configuration entry. The Font resources containing User Defined Characters (Character Set and Code page) need to be placed in the path specified by the ResourceDataPath transform option.

1.1.5.11.10 Character encoding

The AFP2PDF Transform uses the Unicode character encoding standard to reference characters in TrueType fonts. If the AFP text is encoded in a format other than a standard Unicode encoding (UTF-8 or UTF-16), the text must be converted to Unicode during the transformation process. You may require new conversion tables that use the International Components for Unicode (ICU) function.

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.5.12 Working with AFP Images

1.1.5.12.1 Adding background image from a PDF file

AFP2PDF Plus can add a background image or logo to the PDF output file by using commands in the AFP2PDF trransform options 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.5.12.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.5.12.2.1 Creating the image map configuration file

To map images for the AFP files perform these steps:

  1. Create an image map configuration file, transforming a sample AFP document that contains all documents with images.
  2. 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:

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

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

  3. Copy the image lines in the output file (such as imagemap.out) into the image map configuration file (imagemap.cfg by default).
  4. 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.5.12.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:

  1. 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>
  2. 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>
  3. Run afp2pdf to generate a PDF file that contains only the image that you commented out. For example: afp2pdf c:\documents\afpdoc.afp, where c:\documents\afpdoc.afp is the directory and file name of the converted AFP document .

1.1.5.12.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:

  1. Define empty image information entries in the image map configuration file for the images you do not want to generate in the PDF file.
  2. Run afp2pdf on the AFP file (for example, afp2pdf c:\documents\afpdoc.afp). A PDF file is generated (such as c:\documents\afpdoc.pdf) that does not contain any images with empty entries in the configuration file.

1.1.5.12.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.5.12.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:

  1. Edit the image entry
  2. 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.5.12.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:

  1. Opens the specified image file, which currently can only have JPEG format.
  2. Processed the image data.
  3. 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.
Note: If running the image map option from the afp2pdf_split tool, the Type options refer to the sheet option (All, First, Second, All-first) from the document that results after the splitting.

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_END>
    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.5.12.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.5.12.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.

Note: If running the image map option from the afp2pdf_split tool, the INDEX_FRONT_STATICIMG, INDEX_BACK_STATICIMG, INDEX_FRONT_STATICSHDAREA, INDEX_BACK_STATICSHDAREA, INDEX_DEFAULT_FRONT_STATICIMG and INDEX_DEFAULT_BACK_STATICIMG refer to the front and back of the document that results after the splitting.

1.1.5.13 JAVA Application Programming Interfaces

The AFP2PDF Plus Transform application programming interfaces (APIs) convert AFP documents and resources into files that can be viewed with Adobe Acrobat. These APIs are written to interface with a JAVA application.

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.5.14 Comparison with AFP2PDF Transform

The AFP2PDF Plus Transform has many of the same options as the AFP2PDF Transform. Some options have been added or deleted and some have had the default values changed.

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 AFP2PDF Plus Config UI

The following publications are available for RICOH AFP2PDF Plus Config UI. 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.

  • RICOH AFP2PDF Plus Config UI User Guide PDF HTML

1.2.1 AFP2PDF Plus Config UI

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 RICOH Transforms Suite

This section provides a list of all the publications for RICOH Transforms Suite.

Instruction manuals

  • AFP2PDF PLUS

    For information about AFP2PDF PLUS, see these documents:

    • AFP2PDF Plus User Guide
    • AFP2PDF Plus Quick Start Guide
    • AFP2PDF Plus Setup Guide
    • AFP2PDF Plus Release Notes
    • AFP2PDF Plus - Summary of Updates
    • AFP2PDF Plus Config UI User Guide
  • AFP Visual Environment

    For information about AFP Visual Environment, see these documents:

    • AFP Visual Environment User Guide
    • AFP Visual Environment Release Notes
  • AFPMerge

    For information about AFPMerge, see these documents:

    • AFPMerge User Guide
    • AFPMerge Release Notes
  • Line2PDF Plus

    For information about Line2PDF Plus, see these documents:

    • Line2PDF Plus User’s Guide
    • Line2PDF Plus Release Notes
  • PCL2PDF

    For information about PCL2PDF, see these documents:

    • PCL2PDF User’s Guide
    • PCL2PDF Release Notes
  • PS2PDF

    For information about PS2PDF, see these documents:

    • PS2PDF User’s Guide
    • PS2PDF Release Notes
  • TIFF2PDF Plus

    For information about TIFF2PDF Plus, see these documents:

    • TIFF2PDF Plus User Guide
    • TIFF2PDF Plus Release Notes

1.2.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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

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
PDF
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.2.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 and PostScript are either registered trademarks or trademarks of Adobe 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.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

The proper names of the Windows operating systems are as follows:

  • Windows 10:

    Microsoft Windows 10 Pro

    Microsoft Windows 10 Enterprise

  • Windows 11:

    Microsoft Windows 11 Pro

    Microsoft Windows 11 Enterprise

  • Windows Server 2016:

    Microsoft Windows Server 2016 Standard

  • Windows Server 2019:

    Microsoft Windows Server 2019 Standard

  • Windows Server 2022:

    Microsoft Windows Server 2022 Standard

1.2.1.2 AFP2PDF Plus Config UI overview

AFP2PDF Plus Config UI is a graphical tool that lets you create and modify font mapping configuration files for AFP2PDF Plus.

1.2.1.2.1 Overview

AFP2PDF Plus uses font mapping configuration files to give you the ability to customize the output fonts in the resulting PDF file. These configuration files control how AFP raster fonts and AFP outline fonts are mapped to Adobe Base14 fonts, Adobe Type 1 fonts, TrueType fonts, or OpenType fonts.

Editing these configuration files manually is complex and error-prone. AFP2PDF Plus Config UI simplifies font mapping by providing a visual interface where you can:

  • Load AFP files and view the fonts they contain, organized by font type (coded fonts and character set/code page fonts).
  • Select target fonts from categorized lists including Adobe Base14, CJK, Modified Base14, Sonoran, Adobe Type 1, and TrueType fonts.
  • Configure encoding settings for each font mapping, including code page and encoding classification.
  • Preview the document before and after applying font mappings to verify the results.
  • Export ready-to-use configuration files for AFP2PDF Plus.

AFP2PDF Plus Config UI runs as a standalone desktop application. You can use it independently to prepare configuration files, then deploy those files to your AFP2PDF Plus environment.

Font support files

AFP2PDF Plus Config UI creates and modifies these font support files:

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.
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.
Supported font types

You can map AFP fonts to these target font types:

Adobe Base14 fonts
Standard PDF fonts (Courier, Helvetica, Times) that do not require embedding. These fonts are available in all PDF viewers.
Default CJK fonts
Asian language fonts for Chinese, Japanese, and Korean text. These fonts are available when the appropriate language pack is installed in the PDF viewer.
Modified Base14 fonts
Fonts based on Base14 with different character metrics, such as AvantGarde, Bookman, and Helvetica-Narrow.
Sonoran fonts
Fonts that emulate IBM Sonoran fonts using Base14 fonts with custom metrics.
External Type 1 fonts
Adobe Type 1 fonts (.pfb files) with optional custom metrics (.afm or .pfm files). These fonts are embedded in the output PDF.
External TrueType/OpenType fonts
TrueType (.ttf), OpenType (.otf), or TrueType Collection (.ttc) fonts. These fonts are embedded in the output PDF.

1.2.1.2.1.1 User interface

The AFP2PDF Plus Config UI window contains file and font panels, mapping options, and a preview area.
Files panel

Lists the AFP files loaded in the current project.

Click a file name to select it. The Document AFP Fonts panel updates to show the fonts from the selected file, and the preview panel displays the document.

Document AFP fonts panel

Lists the fonts found in the selected AFP file. Fonts are organized into two categories, based on how they are referenced in the AFP file either as coded fonts or as a character set and code page pair. For the coded fonts case we have the coded fonts panel:

Coded fonts
Fonts referenced by coded font names (based on the IBM naming convention, they start with the letter X). These fonts require you to specify the character set and code page they represent.

For the character set and code page pair we have two panels.

Character sets
Fonts specified as character set. The character set page is already defined in the AFP file.
Code pages
Fonts specified as code page. The character code page is already defined in the AFP file.

If the AFP file or the resource folder contains the font resource, each font entry shows this information:

  • Font name
  • Current mapped font (for example, "Verdana")
  • Font size in pixels
  • Font style (Regular, Bold, Italic)
    • Note:
    • If the font resource is missing, the information specified is not displayed.

Mapping options panel

Displays configuration options for the selected font. Use these options to configure the fonts you want to use in the output PDF file.

The panel header shows the selected font name, current mapping, and font category.

Preview panel

Displays a preview of the AFP document with font mappings applied. Text using the currently selected font is highlighted.

The preview toolbar provides the following controls:

Zoom in / Zoom out
Increases or decreases the zoom level.
Zoom percentage
Shows the current zoom level. Type a value or select from the list.
Fit width / Fit page
Adjusts zoom to fit the page width or the entire page in the preview area.
Previous page / Next page
Navigates between pages in the document.
Page number
Shows the current page number and total page count. Type a page number to navigate directly.
Preview
Enables or disables the preview of changes.
Help button

The help button (?) in the title bar opens the online help system.

1.2.1.2.1.2 Menu bar

The AFP2PDF Plus Config UI menus provide access to project, file, and help functions.
File menu
New
Creates a new font mapping project. Clears all current settings and starts with an empty project.
Open
Opens an existing project file. Project files store your AFP files, font mappings, and configuration settings.
Save
Saves the current project. If the project has not been saved before, prompts for a file name and location.
Close
Closes the current project. Prompts to save if there are unsaved changes.
Project menu
Import
Imports existing font configuration files from a folder. Loads mappings from icoded.fnt, csdef.fnt, cpdef.fnt, and alias.fnt files.
Add AFP
Adds an AFP file to the project. The tool reads fonts from the file and displays them in the Document AFP Fonts panel.
Export
Exports font configuration files to a folder. Creates the configuration files used by AFP2PDF Plus for font mapping.
Project settings
Opens the Project settings dialog to configure the project name, project destination path, and paths to Type 1 fonts, TrueType fonts, and AFP resource files.
Help menu
Help
Opens the help system in a web browser.
About
Displays version information and copyright details for AFP2PDF Plus Config UI.

1.2.1.2.2 Limitations

AFP2PDF Plus Config UI is still under development. Some planned features are not yet implemented. Here is a list of current limitations:

  • If the font resources for an AFP font are not available, not included in the AFP file, not provided in an external resource group file, and not found in a configured resource folder, the preview does not display with the default mapping and does not match the appearance of the printed output.
  • The current version of AFP2PDF Plus Config UI does not fully import existing customer configuration files.
  • You cannot create a mapping for an entire DBCS raster font. A DBCS raster font is created from several SBCS raster fonts. You can map only the individual SBCS fonts that it contains.
  • Mapping to TrueType fonts, OpenType fonts, and fonts in TrueType collections is not yet supported.
  • Custom metrics mappings are not yet supported for Type 1 fonts or for Base 14 fonts.


                              

1.2.1.2.3 Requirements

To run this program, your computer must meet the following requirements. Before setup, check that all the requirements are met.

These are the software requirements for AFP2PDF Plus Config UI:

  • Operating systems:
    • Microsoft Windows 10 Pro, Enterprise
    • Microsoft Windows 11 Pro
  • 64 bit version of Java Development Kit (JDK) 17 or later. You must install the JDK, not the Java Runtime Environment (JRE).

    Note:
  • Running AFP2PDF Plus Config UI requires IBM Semeru Runtimes 17 or later, or a Java distribution from an alternative provider. Legacy IBM SDK, Java Technology Edition is not supported.

1.2.1.2.4 Getting started

Use these topics to learn about the AFP2PDF Plus Config UI interface and complete your first font mapping project.

To begin using AFP2PDF Plus Config UI:

  1. Create a new project and add your AFP files. See Creating a project and Adding AFP files.
  2. If you have existing font configuration files, import them. See Importing existing configuration files.
  3. Select fonts in the Document AFP Fonts panel and configure their mappings. See Mapping coded fonts and Mapping character set and code page fonts.
  4. Export the configuration files to use with AFP2PDF Plus. See Exporting configuration files.

1.2.1.3 Creating a font mapping project

Create a new project to start defining font mappings for your AFP files.

A project stores your AFP files, font mappings, and configuration settings. You can save and reopen projects to continue working on font mappings.

To create a project:

  1. Select File ⇒ New.
    The New font mapping project dialog opens.
  2. In the Project name field, type a name for the project.
  3. In the Project destination field, specify the folder where you want to save the project file.
    Click the browse button to select a folder.
  4. Select whether to use Embedded fonts or Mapped fonts.
    Embedded fonts
    Fonts are processed and embedded in the resulting PDF files. By using this option, the output PDF files will look more like the input AFP files.
    Mapped fonts
    Fonts are mapped by default. This option ensures smaller output PDF files size. However, the AFP files that contain fonts that do not have a font mapping will not be displayed correctly.
  5. Optional: Configure font and resource paths.

    Select a path type from the list on the left:

    Resource path
    Path to AFP resource files
    Type 1 font path
    Folder path to Adobe Type 1 font files (.pfb)
    TrueType font path
    Path to TrueType and OpenType font files (.ttf, .otf, .ttc)

    1. Select the path type you want to configure.
    2. In the Select path field, specify the folder path or click the browse button to select a folder.
    3. Click + Add to add another path.
    4. Repeat for each path type you want to configure.
  6. Click OK.
    The project is created. The project name appears in the title bar.

The project is ready. You can now add AFP files and configure font mappings.

To reopen a saved project, click Open and select the project file.

1.2.1.3.1 Adding AFP files

Add an AFP file to your project to view the fonts it contains and configure font mappings.
  • Create or open a project. See Creating a font mapping project.
  • If the AFP file references external resources, configure the resource paths in Set font locations before adding the file.

When you add an AFP file, the tool reads the font information from the file and displays the fonts in the Document AFP Fonts panel. Fonts are categorized as either coded fonts or character set and code page fonts, depending on how they are specified in the AFP file.

To add an AFP file:

  1. Select Project ⇒ Add AFP.
    The Open dialog appears.
  2. Browse and select the AFP file you want to add.
  3. Click Open.
    The file appears in the FILES panel. The DOCUMENT AFP FONTS panel lists the fonts found in the file:
    Coded fonts
    Based on the IBM font naming convention, coded font names start with the letter X, for example X0GT12.
    Character sets
    The character sets names usually start with letter C followed by either a digit for raster fonts or the letter Z for outline fonts.
    Code pages
    The code pages names start with T1.
    The preview panel displays the first page of the document.

The AFP file is added to the project. You can now select fonts in the DOCUMENT AFP FONTS panel and configure their mappings.

    Note:
  • If you move or rename an AFP file after adding it to a project, AFP2PDF Plus Config UI cannot locate the file the next time you open the project. To locate the file, right-click the file in the FILES panel and select Relink, then browse to and select the file at its new location. Your existing font mappings for that file are preserved.

1.2.1.3.2 Importing existing configuration files

Import existing font configuration files to view or modify font mappings.

You can import existing font configuration files from an AFP2PDF Plus installation, so you can view current mappings, modify them, and export updated configuration files.

To import existing configuration files:

  1. Select Project ⇒ Import.
    The browse folder dialog appears.
  2. Browse and select the folder containing the configuration files.

    The folder should contain one or more of these files:

    alias.fnt
    External font aliases.
    a2pxopts.cfg
    Specifies the settings that control the AFP2PDF Plus Transform. Lists all available options as commented-out entries. Clear the comments to use and add any required parameters.
    coded.fnt
    Contains user-defined coded fonts. This file is optional. If it exists, AFP2PDF Plus Transform searches it first for the coded fonts used in an AFP file.
    icoded.fnt
    Coded font definitions.
    cpdef.fnt
    Code page definitions.
    csdef.fnt
    Character set definitions.

  3. Click OK.
    The tool reads the configuration files and loads the font mappings into the project.

The font mappings from the configuration files are loaded into the project. You can now view and modify the mappings. Add an AFP file to preview the imported mappings. See Adding AFP files.

After modifying the mappings, export the updated configuration files. See Exporting configuration files.

1.2.1.3.3 Exporting configuration files

Export the font configuration files from your project for use with AFP2PDF Plus.

Make sure you have configured at least one font mapping in your project.

When you export, the tool creates the configuration files that AFP2PDF Plus uses for font mapping. Copy these files to your AFP2PDF Plus installation or specify this folder as the font configuration path.

To export configuration files:

  1. Select Project ⇒ Export.
    The browse folder dialog appears.
  2. Browse and select the destination folder for the configuration files.
    You can select an existing AFP2PDF Plus font configuration folder or create a new folder.
  3. Click OK.
    The tool exports these files to the selected folder:
    • afpfont.fnt
    • alias.fnt
    • a2pxopts.cfg
    • csdef.fnt
    • coded.fnt
    • cpdef.fnt
    • icoded.fnt

The configuration files are exported. You can now use these files with AFP2PDF Plus.

To use the exported configuration with AFP2PDF Plus, either:

  • Copy the files to the AFP2PDF Plus font configuration folder, or
  • Configure AFP2PDF Plus to use the export folder as the font configuration path

1.2.1.3.4 Setting font locations

Configure the paths to external font folders and AFP resource files.

Before using external Type 1 or TrueType fonts, you must specify the folders where these fonts are located. You can also configure paths to AFP resource files if your AFP documents reference external resources.

To set the font locations:

  1. Select Project ⇒ Project settings.
  2. In the Resource path field, specify a file that contains AFP resources.
    A resource group file is a single file containing multiple AFP resources.
  3. In the AFP font field, specify the path to your AFP fonts.
  4. In the Type 1 font path field, specify the path to your Adobe Type 1 fonts.
    This folder should contain .pfb files and their associated metrics files (.afm or .pfm).
  5. In the TrueType font path field, specify the path to your TrueType and OpenType fonts.
    This folder should contain .ttf, .otf, or .ttc files.
  6. Click SAVE.
    The font locations are saved to the project.

The font locations are configured. When you select an external font category in the Mapping Options panel, the tool displays fonts from the configured folders.

The font location paths are included in the exported a2pxopts.cfg file. Make sure the paths are accessible from the system where AFP2PDF Plus runs, or update the paths after deployment.

1.2.1.4 Creating font mappings

1.2.1.4.1 Mapping fonts specified as coded fonts

Configure a font mapping for a coded font by specifying its character set and code page components.

Make sure you have added an AFP file to your project.

Coded fonts are listed under the Coded fonts section in the DOCUMENT AFP FONTS panel. Each entry shows the font name and size in points. To create a mapping, you specify the character set and code page that the coded font represents, then select a target font for PDF output.

  1. Select Project ⇒ Add AFP to add the AFP file that contains the font you want to map.
  2. In the DOCUMENT AFP FONTS panel, under Coded fonts, select the font you want to map.
    The Mapping Options panel displays the font name, size, and "Coded fonts" label in the header. The preview panel highlights text that uses this font.
  3. Make sure Enable mapping is selected.
    When this option is cleared, the font mapping is disabled and the font uses default conversion behavior.
  4. In the Character set list, select or type the character set name for this coded font.
    Character set names typically start with C0, C1, or CZ (for example, C0S0LB12, C0GT12).
  5. In the Code page list, select or type the code page name.
    Code page names typically start with T1 (for example, T1V10037, T1V10281).
  6. In the Encoding type list, select the character encoding size.
    • Single byte. For Western languages and standard code pages
    • Double byte. For Asian languages (Chinese, Japanese, Korean)
  7. In the Encoding classification list, select the encoding standard.
    For single byte encoding, select ANSI, Symbol, KSC, or KYUJIS. For double byte encoding, select the appropriate Asian encoding: SHINJIS, KYUJIS, KSC, BIG5, GB, PC_MIXED, or IDENTITY.
  8. Optional: In the Code page ID list, select a specific code page identifier if needed.
    Common values include 37 (EBCDIC US/Canada), 500 (EBCDIC International), 1252 (Windows Latin 1), and 850 (DOS Latin 1).
  9. Optional: In the Font size field, adjust the target font size if needed. The value is expressed in points.
    Increase or decrease this value to scale the target font relative to the original AFP font size.
  10. In the Target font type list, select the category of font to use for the mapping.
    • Base 14. Standard PDF fonts (Courier, Helvetica, Times New Roman)
    • CJK.Asian language fonts
    • Modified Base 14. Fonts with different metrics (AvantGarde, Bookman, etc.)
    • Sonoran. IBM Sonoran font emulation
    • External Type 1. Adobe Type 1 fonts from your font folder
    • External TrueType. TrueType/OpenType fonts from your font folder
  11. In the Target font list, select the specific font to use.
    The available fonts depend on the target font type you selected. For Base 14, options include Courier, Helvetica, and Times New Roman.
  12. Optional: Select Bold or Italic to apply font styles.
    These options are not available for Sonoran fonts.

The coded font mapping is configured. The preview panel updates to show the document with the new font mapping applied. The mapping is stored in the configuration files when you export the project.

To discard your changes and restore the original values, click Reset to Default.

1.2.1.4.2 Mapping fonts specified as character set and code page pairs

Configure font mappings for fonts specified as character set and code page pairs.

Make sure you have added an AFP file to your project. See Adding AFP files.

The Document AFP Fonts panel shows separate Character sets and Code pages sections for fonts that are defined with explicit character set and code page references. Unlike coded fonts, these fonts do not require you to specify the character set and code page pairing—that information is already defined in the AFP file.

  1. Select Project ⇒ Add AFP to add the AFP file that contains the character set and code page you want to map.
  2. Expand the DOCUMENT AFP FONTS panel.
    The Mapping Options panel displays the configuration options for the selected font. The preview panel highlights text that uses this font.
  3. To create a mapping for the character set:
    1. Make sure Enable mapping is selected.
      When this option is cleared, the font mapping is disabled and the font uses default conversion behavior.
    2. In the Font size field, adjust the font size if needed.
      Increase or decrease this value to scale the target font relative to the original AFP font size.
    3. In the Target font type list, select the category of font to use for the mapping.
    4. In the Target font list, select the specific font to use.
      The available fonts depend on the target font type you selected.
    5. Select Bold or Italic to apply font styles.
      These options are not available for Sonoran and Modified Base 14 fonts.
  4. To create a mapping for the code page:
    1. Make sure Enable mapping is selected.
      When this option is cleared, the font mapping is disabled and the font uses default conversion behavior.
    2. In the Encoding type list, select the character encoding size.
    3. In the Encoding classification list, select the encoding standard.
    4. In the Code page ID list, select a specific code page identifier if needed.

The font mapping is configured. The mapping is stored in the csdef.fnt and cpdef.fnt files when you export the configuration.

1.2.1.4.3 Selecting Base14 fonts

Map an AFP font to a Base14 font for maximum compatibility without font embedding.

Base14 fonts are standard PDF fonts available in all PDF viewers without embedding. They include Courier, Helvetica, and Times families. Using Base14 fonts results in smaller PDF files because the fonts do not need to be embedded.

  1. Go to Target font type list and select Base14 fonts from the list.
    The font selection options appear.
  2. Go to Target font and select the target font from the list:
    • Courier - Monospaced font
    • Helvetica - Sans-serif font
    • TimesNewRoman - Serif font
  3. Optional: Select Bold to apply bold style.
  4. Optional: Select Italic to apply italic style.
    The preview panel updates to show the document with the Base14 font applied.
Base14 font combinations

The following combinations are available:

Font Regular Bold Italic Bold Italic
Courier Courier Courier-Bold Courier-Oblique Courier-BoldOblique
Helvetica Helvetica Helvetica-Bold Helvetica-Oblique Helvetica-BoldOblique
Times Times-Roman Times-Bold Times-Italic Times-BoldItalic

1.2.1.4.4 Selecting CJK fonts

Map an AFP font to a default CJK font for Asian language text.

Make sure the encoding type is set to DBCS and the encoding classification matches your target language.

Default CJK (Chinese, Japanese, Korean) fonts are standard fonts available in PDF viewers when the appropriate language pack is installed. Use these fonts for documents containing Asian language text.

  1. Go to Target font type and select CJK from the list.
    The font selection options appear.
  2. Go to Target font list and select the target font from the list:
    • Chinese Simplified
    • Chinese Traditional (sans serif)
    • Chinese Traditional (serif)
    • Japanese Gothic (sans serif)
    • Japanese Mincho (serif)
    • Korean Gothic (sans serif)
    • Korean MyeongoJo (serif)
  3. Optional: Select Bold to apply bold style.
  4. Optional: Select Italic to apply italic style.
The preview panel updates to show the document with the CJK font applied.

1.2.1.4.5 Selecting Modified Base14 fonts

Map an AFP font to a Modified Base14 font with different character metrics.

Modified Base14 fonts are based on the standard Base14 fonts but have different character metrics. By changing the metrics of the Adobe Base 14 fonts, you can create additional fonts without embedding. The result is a smaller size PDF. Some of these fonts are: AvantGarde, Bookman, and Helvetica-Narrow.

  1. Go to Target font type and select Modified Base14 fonts from the list.
    The font selection options appear.
  2. Go to Target font and select the target font from the list:
    • AvantGarde-Book
    • Bookman-Light
    • Helvetica-Narrow
    • NewCenturySchlbk
    • Palatino-Roman
    • Helvetica-Condensed
      Note:
    • There is no separate option to specify weight of the font or if the font is italic. Instead, some of the fonts from the Modified Base 14 category have suffixes that specify these options, such as Bold, Demi (half bold), Italic, Oblique (similar to Italic), Light (thinner than the regular font).
The preview panel updates to show the document with the Modified Base14 font applied.

1.2.1.4.6 Selecting Sonoran fonts

Map an AFP font to a Sonoran font to emulate IBM Sonoran fonts.

Sonoran fonts emulate the IBM Sonoran font family using Base14 fonts with custom metrics. These fonts provide compatibility with documents originally created using IBM Sonoran fonts.

  1. Go to Target font type and select Sonoran from the list.
    The font selection options appear.
  2. Go to Target font and select the target Sonoran font from the list.
    The list contains fonts that emulate specific IBM Sonoran fonts. Select the font that best matches your original AFP font characteristics.
The preview panel updates to show the document with the Sonoran font applied.
Note: Bold and Italic options are not available for Sonoran fonts. The style is built into the font definition.

1.2.1.4.7 Selecting external Type 1 fonts

Map an AFP font to an Adobe Type 1 font for precise font matching.

Make sure you have configured the Type 1 font folder location. See Setting font locations.

Adobe Type 1 fonts provide precise font matching when you need to preserve the exact appearance of the original document. Type 1 fonts are embedded in the output PDF file.

  1. Go to Target font type and select External Type 1 from the list.
    The font selection options appear.
  2. Go to Type1 font and select or type the font name.
    The list displays Type 1 fonts found in your configured font folder. Type the font name without the file extension (for example, type MyFont for MyFont.pfb).
The preview panel updates to show the document with the Type 1 font applied.

The font mapping is configured. The font file name is stored in the alias.fnt file when you export the configuration.

1.2.1.4.8 Selecting external TrueType fonts

Map an AFP font to a TrueType, OpenType, or TrueType Collection font.

Make sure you have configured the TrueType font folder location. See Setting font locations.

TrueType and OpenType fonts provide high-quality font rendering and are widely available. These fonts are embedded in the output PDF file.

  1. Go to Target font type and select External TrueType font from the list.
    The font selection options appear.
  2. Go to TrueType font and select or type the font name.

    The list displays fonts found in your configured font folder. Specify the font name with the file extension:

    • For TrueType fonts: arial.ttf
    • For OpenType fonts: arial.otf
    • For fonts in a TrueType Collection: FontName@collection.ttc
    The preview panel updates to show the document with the TrueType font applied.

The font mapping is configured. The font file name is stored in the alias.fnt file when you export the configuration.

TrueType Collection example

To use a font from a TrueType Collection file, specify the font name followed by @ and the collection file name. For example, to use the Arial font from fonts.ttc, type:

Arial@fonts.ttc

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

  • AFPMerge User's Guide PDF HTML

  • Release Notes for AFPMerge 1.5 PDF

1.3.1 AFPMerge 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 RICOH Transforms Suite

This section provides a list of all the publications for RICOH Transforms Suite.

Instruction manuals

  • AFP2PDF PLUS

    For information about AFP2PDF PLUS, see these documents:

    • AFP2PDF Plus User Guide
    • AFP2PDF Plus Quick Start Guide
    • AFP2PDF Plus Setup Guide
    • AFP2PDF Plus Release Notes
    • AFP2PDF Plus - Summary of Updates
    • AFP2PDF Plus Config UI User Guide
  • AFP Visual Environment

    For information about AFP Visual Environment, see these documents:

    • AFP Visual Environment User Guide
    • AFP Visual Environment Release Notes
  • AFPMerge

    For information about AFPMerge, see these documents:

    • AFPMerge User Guide
    • AFPMerge Release Notes
  • Line2PDF Plus

    For information about Line2PDF Plus, see these documents:

    • Line2PDF Plus User’s Guide
    • Line2PDF Plus Release Notes
  • PCL2PDF

    For information about PCL2PDF, see these documents:

    • PCL2PDF User’s Guide
    • PCL2PDF Release Notes
  • PS2PDF

    For information about PS2PDF, see these documents:

    • PS2PDF User’s Guide
    • PS2PDF Release Notes
  • TIFF2PDF Plus

    For information about TIFF2PDF Plus, see these documents:

    • TIFF2PDF Plus User Guide
    • TIFF2PDF Plus Release Notes

1.3.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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
BDT
Begin Document
EDT
End Document
IMM
Invoke Medium Map
IPO
Include Page Overlay
MCF
Map Coded Font

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

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

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

UNIX is a registered trademark of The Open Group in the United States and other countries.

1.3.1.2 Overview

1.3.1.2.1 Description

AFP Merge combines multiple AFP input files into a single AFP output file with a combined resource group suitable for printing. It contains sophisticated resource comparison capability that allows it to determine when resources are identical. All AFP resources are renamed and only one version of the resource is added to the AFP resource group. The appropriate AFP file resource references are also changed.

1.3.1.2.2 Limitations

AFPMerge does not support:
  • 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.
  • AFP Merge does not handle input resources with missing or empty names, causing an error. Make sure every resource referenced in the input AFP files has a valid name before running AFP Merge.
  • 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.
  • Running AFPMerge using IBM Semeru Java on Windows and Linux is not supported.
  • Although the AFP Merge program runs with Java 21 or later, the installer does not run with Java 21 or later. Use a Java version earlier than Java 21 to install AFP Merge.

1.3.1.3 Installing the AFPMerge Transform

1.3.1.3.1 Requirements

Software requirements for the AFPMerge.

AFP merge requires:

  • 64bit JAVA V1.8 or later
  • IBM AIX 7.2 or later
  • IBM z/OS UNIX System Services V1.13 or later
  • Microsoft Windows 10 Pro, Enterprise
  • Microsoft Windows 11 Pro
  • Microsoft Windows Server 2016 Standard
  • Microsoft Windows Server 2019 Standard
  • Microsoft Windows Server 2022 Standard
  • Linux Kernel 2.6.18 or later (x86) with fontconfig package installed.
  • To run the installer you need to have administrative rights on the machine you are installing.

1.3.1.3.2 Installing a Permanent License

To continue using AFP Merge after the trial license expires, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for AFP Merge :
  1. Run the license management tool AfpMergeLicenseManager.jar located in the license_installer folder where AFP Merge is installed, and follow the installation steps.
  2. When prompted You can either install a new license or revoke the currently installed one., select Install License - Upload and apply a new license file.
  3. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  4. If the computer where AFP Merge is installed does not have Internet access:
    1. Do not close the license application on the computer where AFP Merge is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where AFP Merge is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  5. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  6. Click Software Activation on the right side of the screen.
  7. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management application on the computer where AFP Merge is installed. Copy your machine fingerprint field. This action copies the 16-character system fingerprint that uniquely identifies the computer where AFP Merge is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  8. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  9. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  10. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  11. If you are finished, close the browser tab. To restart the process, click Start Over.
  12. If you accessed the Internet from a different computer than the one where AFP Merge is installed, copy the license file to the computer where AFP Merge is installed.
  13. Run the license management tool on the system where AFP Merge is installed, follow the installation steps and select Install License - Upload and apply a new license file. ⇒ Install.
  14. After the license management tool displays your machine fingerprint, click Next.
  15. Locate the license file and click Open.
  16. Select Next.
  17. Review the installation summary and click Install.
    You see a message that the license was installed successfully.
  18. You can start using the AFP Merge transform.

1.3.1.3.3 Installing a Permanent License

To continue using AFP Merge after the trial license expires, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for AFP Merge :
  1. Run the license management tool AfpMergeLicenseManager.jar located in the license_installer folder where AFP Merge is installed, and follow the installation steps.
  2. When prompted You can either install a new license or revoke the currently installed one., select Install License - Upload and apply a new license file.
  3. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  4. If the computer where AFP Merge is installed does not have Internet access:
    1. Do not close the license application on the computer where AFP Merge is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where AFP Merge is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  5. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  6. Click Software Activation on the right side of the screen.
  7. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management application on the computer where AFP Merge is installed. Copy your machine fingerprint field. This action copies the 16-character system fingerprint that uniquely identifies the computer where AFP Merge is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  8. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  9. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  10. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  11. If you are finished, close the browser tab. To restart the process, click Start Over.
  12. If you accessed the Internet from a different computer than the one where AFP Merge is installed, copy the license file to the computer where AFP Merge is installed.
  13. Run the license management tool on the system where AFP Merge is installed, follow the installation steps and select Install License - Upload and apply a new license file. ⇒ Install.
  14. After the license management tool displays your machine fingerprint, click Next.
  15. Locate the license file and click Open.
  16. Select Next.
  17. Review the installation summary and click Install.
    You see a message that the license was installed successfully.
  18. You can start using the AFP Merge transform.

1.3.1.3.4 Revoking the License Key

The Self-service License Key Revoke System (SSR) is designed to permit Ricoh customers a method to move license keys between systems and recover from system failures. If you must revoke more than 2 keys from the same EID, contact your local Ricoh Support team for assistance.
To revoke the license key:
  1. Run the license management tool AfpMergeLicenseManager.jar located in the license_installer folder where AFP Merge is installed, and follow the installation steps.
  2. Select the path where your transform is installed.
  3. Then, select Revoke License - Remove the current license file from the system. and click Install.
  4. Select the location that you want to use for your current license, then click Next.
  5. You are instructed to visit https://dl.ricohsoftware.com/?revoke to revoke your license.
  6. Click the Self-Service Revoke button.
  7. Select one of the 3 available revoke methods from the Revoke By list:
    Entitlement ID (EID)
    The EID that you must revoke for the software reporting a license violation condition.
    Activation ID (AID)
    The AID is necessary when you only must revoke a single set of keys for 1 EID. For example, if you accidentally activated using the wrong system fingerprint and have the AID string available.
    License Key File Upload (license.key file)
    Best general-purpose option for resetting all EIDs installed for a specific product on a given server. You can select a license.key file.
  8. Depending on your selection from the Revoke By list, enter the EID, AID, or upload the key file in the Enter your EID, Enter your AID, or Upload Your License File (Max file size, 150 KB) fields.
  9. Enter your company name in the Company Name field. Make sure to use the same the company name used in the original EID email.
  10. To receive the revoke details, enter your valid business email address in the Business Email Address field.
  11. Click Submit.
    After 30 seconds, you receive a notification on the website. If your request could not be approved automatically and requires review, you receive an email from the reviewer within the next few business days.
      Note:
    • Depending on the network speed or processing time, it may last up to 90 seconds until you receive the notification.
  12. Return to the license management application and click Next.
  13. Review the summary and click Install.
    You will see a message that the license was successfully revoked.
  14. Click Done.

1.3.1.4 Working with AFPMerge

1.3.1.4.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.3.1.4.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.3.1.5 Command Line Syntax

1.3.1.5.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.3.1.6 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 AfpMerge.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.3.1.7 Errors and Warnings

This section defines errors and warnings most frequently encountered during normal operations.

1.3.1.7.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.3.1.7.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.4 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.

  • AFP Visual Environment User's Guide PDF HTML

  • Release Notes for AFP Visual Environment 1.5 PDF

1.4.1 AFP Visual Environment 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 RICOH Transforms Suite

This section provides a list of all the publications for RICOH Transforms Suite.

Instruction manuals

  • AFP2PDF PLUS

    For information about AFP2PDF PLUS, see these documents:

    • AFP2PDF Plus User Guide
    • AFP2PDF Plus Quick Start Guide
    • AFP2PDF Plus Setup Guide
    • AFP2PDF Plus Release Notes
    • AFP2PDF Plus - Summary of Updates
    • AFP2PDF Plus Config UI User Guide
  • AFP Visual Environment

    For information about AFP Visual Environment, see these documents:

    • AFP Visual Environment User Guide
    • AFP Visual Environment Release Notes
  • AFPMerge

    For information about AFPMerge, see these documents:

    • AFPMerge User Guide
    • AFPMerge Release Notes
  • Line2PDF Plus

    For information about Line2PDF Plus, see these documents:

    • Line2PDF Plus User’s Guide
    • Line2PDF Plus Release Notes
  • PCL2PDF

    For information about PCL2PDF, see these documents:

    • PCL2PDF User’s Guide
    • PCL2PDF Release Notes
  • PS2PDF

    For information about PS2PDF, see these documents:

    • PS2PDF User’s Guide
    • PS2PDF Release Notes
  • TIFF2PDF Plus

    For information about TIFF2PDF Plus, see these documents:

    • TIFF2PDF Plus User Guide
    • TIFF2PDF Plus Release Notes

1.4.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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

AFP
Advanced Function Presentation
GIF
Graphical Interchange Format
IP
Internet Protocol
JPEG
Joint Photographic Experts Group
PCL
Printer Command Language
PDF
Portable Document Format
TIFF
Tagged Image File Format

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

Sentinel® is a registered trademark of Thales DIS CPL USA, Inc.

1.4.1.2 Overview

AFP Visual Environment lets you enhance AFP files without changing the applications that create the AFP files. For example, you can use AFP Visual Environment to index AFP files and to add bar codes in AFP files. The AFP files that you enhance must contain data in Mixed Object Document Content Architecture for Presentation (MO:DCA-P) format.

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.4.1.2.1 System overview

AFP Visual Environment has a preparation phase and a production phase.

  • 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
Preparation phase and production phase. Process is explained below.

AFP Visual Environment system overview shows this process:

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

  2. 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.
  3. 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.

  4. Optional: If the production system is different from the preparation system, the administrator sends a copy of the control file to the production system.
  5. 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.

  6. 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.4.1.2.2 System requirements

The AFP Visual Environment user interface and the AFP Visual Environment commands can run on the same system or on different systems.

The AFP Visual Environment user interface can run on any of these operating systems with a browser:

  • IBM AIX 7.2 or later
  • Linux Kernel 2.6.18 or later (x86) with fontconfig package installed.
  • Microsoft Windows Server 2016 Standard
  • Microsoft Windows Server 2019 Standard
  • Microsoft Windows Server 2022 Standard
  • Microsoft Windows 10 Pro
  • Microsoft Windows 10 Enterprise
  • Microsoft Windows 11 Pro

The AFP Visual Environment commands can run on any of these operating systems:

  • IBM AIX 7.2 or later
  • Microsoft Windows Server 2016 Standard
  • Microsoft Windows Server 2019 Standard
  • Microsoft Windows Server 2022 Standard
  • Microsoft Windows 10 Pro
  • Microsoft Windows 10 Enterprise
  • Microsoft Windows 11 Pro
  • Linux Kernel 2.6.18 or later (x86) with fontconfig package installed.

The AFP Visual Environment user interface and commands require Java Runtime Environment 64bit version 1.8 or later with multi-language support and administrator rights to be installed.

Although AFP Visual Environment runs with Java 21 or later, the installer does not run with Java 21 or later. Use a Java version earlier than Java 21 to install AFP Visual Environment.

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.4.1.2.3 User interface

You use the AFP Visual Environment user interface to display and enhance sample AFP files.

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.

RICOH Visual Environment user interface

  1. Title Bar
  2. Menu bar
  3. Tool bar
  4. AFP file
  5. Page pane
  6. Index pane
  7. 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) Open AFP file
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) Save control file
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 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 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)Rotate by 90
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 AFP Editor mode
Creates definitions for barcodes, hidden areas, text strings, and text masks in the control file.
AFP Indexer AFP Indexer mode
Creates definitions for page groups and index tags in the control file.
Whitespace ManagerWhitespace Manager mode
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.4.1.2.4 Control files

AFP Visual Environment control files contain information about the enhancements made to sample AFP files. AFP Visual Environment commands use control files to make the same enhancements to production AFP 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.4.1.2.5 Commands

The AFP Visual Environment commands use the information in the control file to make the same enhancements to a production AFP file that the administrator made to the sample AFP file. The commands create new AFP files with the enhancements; they do not update the production AFP files.

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.4.1.2.6 Document index files

The IndexAFP command and the PluginMgr command can create a document index file that contains all the index tags in a production AFP file. The index tags can be defined in the AFP file itself or in the AFP Visual Environment control file.

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.4.1.2.7 AFP Indexer

AFP Indexer lets you create page groups, define supplemental pages, and create indexes in AFP files. When you view an AFP file that contains page groups and indexes, you can navigate in the file to find pages containing specific index values.

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.4.1.2.7.1 Page groups

AFP Indexer lets you organize a large AFP file into smaller, uniquely identifiable units, called 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 text Page 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.4.1.2.7.2 Supplemental pages

AFP Indexer lets you define pages in an AFP file as supplemental pages. Supplemental pages are those pages that you do not want included in page groups, such as header and trailer pages, separator pages, or any page that should be excluded from a customer statement.

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.
When you define a supplemental page, you give it a page definition name. You can assign multiple index tags and triggers to the same supplemental page definition.
Note: The term page definition in 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.4.1.2.7.3 Index tags

The AFP Indexer mode of AFP Visual Environment lets you index data values that are consistently present in the same location in each page group or on a supplemental page. Index tags define the data values on a page. (Index tags are called Tag Logical Elements (TLEs) in the AFP architecture.)

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.4.1.2.7.4 Resource group files

The IndexAFP command can create a resource group file that contains all the AFP resources that a production AFP file references.

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.4.1.2.8 AFP Editor

AFP Editor lets you create barcodes, text, and hidden areas in documents.

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.4.1.2.8.1 Barcodes

A barcode is a pattern of elements (such as bars, spaces, and two-dimensional modules) that represent numeric or alphanumeric information in a machine-readable form.

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

Note: The barcode that you define in a page group contains the same data on each page.

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
Four orientations of a barcode

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.

Table 1. Bar code properties for Code 39, Data Matrix, Interleaved 2-of-5, PDF417, and POSTNET bar codes
Barcode type Properties
Code 39 (3 of 9 Code)
  • Whether to generate and include a check digit in the bar code symbol; a check digit ensures data integrity during the bar coding reading process;
  • Whether to include human-readable interpretation (HRI).
Data Matrix
  • Number of rows;
  • Number of modules in each row.
QR Code
  • Desired Symbol Size
Interleaved 2-of-5
  • Whether to generate and include a check digit in the bar code symbol; a check digit ensures data integrity during the bar coding reading process;
  • Whether to include human-readable interpretation (HRI).
PDF417
  • Number of data symbol characters in each row; the printer creates the minimum number of rows necessary for the amount of data in the bar code symbol.
POSTNET
  • Length of the routing ZIP Code;
  • Whether to include human-readable interpretation (HRI).
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.
Note: If you want to include the value of document properties in barcode data, contact the Professional Services department of Ricoh Production Print.

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:

The Mailer ID and the Serial number fields together contain 15 digits.

Fields in IMBs with a 9-digit mailer ID and a 6-digit serial number
Format of IMBs with a 9-digit serial number
Fields in IMBs with a 6-digit mailer ID and a 9-digit serial number
Format of IMBs with a 6-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:

  1. In the first IMB in the AFP file, it encodes the serial number that is in the serial number file.
  2. In each subsequent IMB created, it increments the serial number by 1. This ensures that the serial number is unique in each barcode.
  3. 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.
  4. 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.

Note: The EditAFP command starts multiple threads so that it can process multiple page groups concurrently. Therefore, the serial numbers in the IMBs are not always in sequential order by page group. For example, EditAFP might create the IMB in the third page group (using serial number 000002) before it creates the IMB in the second page group (using serial number 000003). Even though the serial numbers might not be in sequential order by page group, the serial number in each IMB is unique. If it is important for the IMB serial numbers to be in sequential order by page group, request that EditAFP start only one thread (-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.

PLANET and POSTNET barcodes
POSTNET and PLANET Code barcodes in an address block
POSTNET barcode
Address block with ACS data and PLANET barcode hidden

POSTNET barcode shows the address with the POSTNET barcode. IMB replacement shows the address after you replace the POSTNET barcode with an IMB.

POSTNET barcode
Address block with POSTNET barcode
IMB replacement
Address block with IMB

1.4.1.2.8.2 Hidden areas

A hidden area is an area in each page group that no one using an AFP viewer can see and that does not print.

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.4.1.2.8.3 Text masks

A text mask replaces text in an AFP file with another character, for example the x character. 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.4.1.2.9 Whitespace Manager

With Whitespace Manager, you can add marketing or educational messages to documents without recomposing them. Whitespace Manager 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 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.4.1.2.9.1 White space

White space is the area on a page that does not contain any text. 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.

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 + 2
For 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 = 8
If 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:
  • A known white space area is already defined on the page.
  • No white space area meets the specified dimensions.
This option is only available if white space from a search has not already been defined using This page.
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:
  • A known white space area is already defined on a page.
  • No white space area meets the specified dimensions.

Notes:

  1. This option is only available if white space from a search has not already been defined using This and following pages.
  2. You must display each page in the page group to see if a white space box is created on a page.

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:
  • A known white space area is already defined on the page.
  • No white space area meets the specified dimensions.

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.4.1.2.9.2 Content

Content, such as images or text, is assigned to a white space area based on rules you define to place the content for specific customers, marketing campaigns, or the best use of available space.

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)
Images must use an RGB colorspace; they cannot use a CMYK colorspace. You cannot include other image types, such as TIFF or PNG.

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.

For example, you have defined white space across the top of the first page of a statement. You want the text "Vacation Time!" always displayed in the white space, a sunny beach scene displayed to all customers in Colorado and Kansas, and an image of a snow-capped mountain scene displayed to all other customers. If an index tag named "Address" contains the state where the customer lives, the conditions you create would look like this:
Example of conditions for assigning content

1.4.1.2.10 Pipeline Manager

Pipeline Manager mode of AFP Visual Environment lets you configure and run a set of filters, in a specific order, to process large AFP files quickly and efficiently.

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.4.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.
Note: It extracts only form definitions, code-pages character sets, and coded fonts. Other resource types (for example: overlay, page segments) are not included.

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.
    Note:
  • An asterisk (*) in front specifies “ends with”.
  • An asterisk (*) in at the end specifies “starts with”.
  • An asterisk (*) on both sides specifies “contains”.
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.4.1.2.10.2 Supported Objects

This table contains the list of all supported objects when using the filters.

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.4.1.2.10.3 Supported structure fields

This table contains the list of all 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.4.1.3 Installing AFP Visual Environment using the installer

The AFP Visual Environment can now be installed using an executable jar file.

To run the installer, perform these steps:

  • Use the following command: java -jar RTS--AVEInstaller-1.X.X--ave.jar, where 1.X.X is the product version.
      Note:
    • To install the AFP Visual Environment, you need 64 bit Java 1.8 or later and Administrative rights.
    • On some Java versions, due to a bug, the above java -jar command might not start the installer. Use this additional parameter: java -Djdk.util.zip.disableZip64ExtraFieldValidation=true -jar RTS--AVEInstaller-1.X.X--ave.jar.
  • Depending on the capabilities of your operating system, the AFP Visual Environment installer opens either using a graphical user interface or a command line.

  • On non-Windows operating environments the installer uses the /tmp directory to unpack files and run certain scripts. If there are limitations on the /tmp folder of the system, such as non-exec flag or limited space, a different temporary file directory can be specified using the -Dlax.nl.env.iatempdir= parameter. Example: java -Dlax.nl.env.iatempdir=/custom_temp_dir/ -jar RTS--AVEInstaller-1.X.X--ave.jar, where 1.X.X is the product version.
  • Follow the installation steps of the installer. You will be asked to install the AFP Visual Environment user interface or the AFP Visual Environment commands. During the installation process, you must specify the installation location.

Note: If you install AFP Visual Environment on Windows in the Program Files folder of the computer, you must run the program with Administrator rights.

1.4.1.4 Installing a Permanent License

To use AFP Visual Environment, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for AFP Visual Environment:
  1. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  2. If the computer where AFP Visual Environment is installed does not have Internet access:
    1. Do not close the license application on the computer where AFP Visual Environment is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where AFP Visual Environment is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  3. On the computer that has Internet access, go to this website: https://dl.ricohsoftware.com.
  4. Click Software Activation on the right side of the screen.
  5. In the Software Activation dialog, insert the EID and the system fingerprint.
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. On the Software Activation page, enter your EID and system fingerprint.

      To get your system fingerprint, go to Help ⇒ License manager ⇒ License info/deployment. Your system fingerprint is displayed on the panel.

    3. Click Confirm Content.
  6. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  7. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  8. To email the license key file to someone else, click Email License Key.
    1. Type the e-mail address.
    2. Click Send.
  9. If you are finished, close the browser tab. To restart the process, click Start Over.
  10. If you accessed the Internet from a different computer than the one where AFP Visual Environment is installed, copy the license file to the computer where AFP Visual Environment is installed.
  11. Access your AFP Visual Environment application, click Help ⇒ License manager ⇒ License info/deployment ⇒ Install license and select your license. Then, click OK.

1.4.1.5 Revoking the License Key

The Self-service License Key Revoke System (SSR) is designed to permit Ricoh customers a method to move license keys between systems and recover from system failures. If you must revoke more than 2 keys from the same EID, contact your local Ricoh Support team for assistance.
To revoke the license key:
  1. Go to https://dl.ricohsoftware.com/.
  2. Click the Self-Service Revoke button.
  3. Select one of the 3 available revoke methods from the Revoke By list:
    Entitlement ID (EID)
    The EID that you must revoke for the software reporting a license violation condition.
    Activation ID (AID)
    The AID is necessary when you only must revoke a single set of keys for 1 EID. For example, if you accidentally activated using the wrong system fingerprint and have the AID string available.
    License Key File Upload (license.key file)
    Best general-purpose option for resetting all EIDs installed for a specific product on a given server. You can select a license.key file.
  4. Depending on your selection from the Revoke By list, enter the EID, AID, or upload the key file in the Enter your EID, Enter your AID, or Upload Your License File (Max file size, 150 KB) fields.
  5. Enter your company name in the Company Name field. Make sure to use the same the company name used in the original EID email.
  6. To receive the revoke details, enter your valid business email address in the Business Email Address field.
  7. Click Submit.
After 30 seconds, you receive a notification on the website. If your request could not be approved automatically and requires review, you receive an email from the reviewer within the next few business days.
    Note:
  • Depending on the network speed or processing time, it may last up to 90 seconds until you receive the notification.

You can also revoke your license directly from AFP Visual Environment following these steps:

  1. Access your AFP Visual Environment application, click Help ⇒ License manager ⇒ Revoke license ⇒ Revoke.
  2. Select the location that you want to use for your current license, then click Open.
  3. You are instructed to visit https://dl.ricohsoftware.com/?revoke to revoke your license.
  4. Click Exit.

1.4.1.6 Working with sample AFP files

You can use AFP Visual Environment to enhance a sample AFP file.

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.4.1.6.1 Converting line data to MO:DCA-P in sample AFP files

If the sample AFP file contains line data, you must convert the data stream to Mixed Object Document Content Architecture for Presentation (MO:DCA-P) format.

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:

  1. 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.
  2. 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 the ftpbinary option.
  3. Concatenate the resource group file and the AFP file that ACIF created.

1.4.1.6.2 Installing AFP Visual Environment

Install AFP Visual Environment to display and define enhancements for sample AFP files that represent your production AFP files.
Examples of enhancements include creating page groups, indexes, barcodes, and text; assigning values to document properties; and adding content to white-space areas.

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 11 Pro
  • Windows Server 2022 64-bit
  • Windows Server 2025 64-bit
  • Red Hat 9.2 through latest 9.X
  • Red Hat 10.0 through latest 10.X
  • Rocky Linux 9.0 through latest 9.X
  • Rocky Linux 10.0 through latest 10.X
  • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64
  • SUSE Linux Enterprise Server (SLES) 16.0 or above for x86_64

To install AFP Visual Environment:

  1. Log in to RICOH ProcessDirector.
  2. Open Administration ⇒ Utilities ⇒ Visual Workbench
  3. Click AFP Visual Environment to download the VisualWorkbench.zip file.
  4. 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.
  5. To start AFP Visual Environment:
    • On a Windows system, double-click AVE.bat.
    • On a Linux system, double-click AVE.jar.
    Note:
  • If you add features or extensions to your system, delete the VisualWorkbench.zip file and all of the unzipped files, then download the VisualWorkbench.zip file again.

1.4.1.6.3 Displaying sample AFP files

You can open a sample AFP file in AFP Visual Environment. The sample AFP file must be representative of production AFP files that you want to enhance in the same way as the sample file.

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.
To display a sample AFP file:
  1. Click File ⇒ Open AFP file. You see the Open window.
  2. 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?
  3. 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:
      1. Select the control file that you want to use.
      2. 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.
  4. To rotate the AFP file clockwise by 90 degrees, click View ⇒ Rotate by 90o. Click again to rotate another 90 degrees.
  5. 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.
  6. To hide or display the page structure in the left pane, click View ⇒ File View.
  7. To hide or display the indexes in the bottom pane, click View ⇒ Index View.
  8. To increase or decrease the display size of the AFP file, click View ⇒ Zoom ⇒ nnn (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.
  9. To change units of measurement, do one of these:
    • For inches, click View ⇒ Units ⇒ Inches.
    • For millimeters, click View ⇒ Units ⇒ Millimeters.
  10. To display properties:
    1. 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:
        1. Click text or an object in the AFP file. You see a red box around the text or object you selected.
        2. Right-click and then click Properties.
      A green box around a property value indicates that there is more text than what is displayed.
    2. To see the complete text for a value:
      1. Double-click the green box.
      2. Click OK.
    3. To close the Properties window, click X in the upper right corner.
  11. If text does not display correctly:
    • If the AFP file contains data that displays incorrectly, change the default code page to another code page (Resources ⇒ Modify Default Encoding). For example, an ASCII code page is IBM850(GID=850) and an EBCDIC code page is IBM500(GID=500).
    • If the AFP file refers to AFP fonts that are not inline, identify the directories that contain font resources to AFP Visual Environment (Resources ⇒ Specify Resource Directories).
    • If the AFP file refers to custom AFP fonts, create custom font-mappings in AFP Visual Environment.
  12. If an error occurs when opening or working with a file, click File ⇒ Reset, which closes the file and clears the cached resources from memory. Open the file again.

1.4.1.6.4 Creating and updating control files

When you open a sample AFP file to enhance it, AFP Visual Environment can either create a control file or update a control file that you created previously. The control file contains definitions that tell how to enhance production AFP files that are similar to the sample AFP file.
If a control file already exists for a sample AFP file and you need to enhance the AFP file again, update the existing control file instead of creating a new control file. All the definitions that apply to the sample AFP file must be in the same control file.
To create or update a AFP Visual Environment control file:
  1. 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?
  2. Do one of these:
    • To create a control file, click No.
    • To update a control file, click Yes. You see the Open window:
      1. Select the control file.
      2. Click Open.
  3. If you opened the wrong control file, click File ⇒ Open Control File 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.
  4. Enhance the sample AFP file.
    For example, create page groups, index tags, bar codes, text, and white space.
  5. Do one of these:
    • To save a new control file or to rename an updated control file:
      1. Click File ⇒ Save control file as.
      2. Type the full path name of the control file in the File name field.
      3. Click Save.
      Use a name for the control file that helps you associate the AFP file with its control file. The default extension for control files is .ctl.
    • To save an updated control file with the same name, click File ⇒ Save control file.

1.4.1.6.5 Identifying AFP resource directories

If the sample AFP file refers to AFP resources (fonts, page segments, and overlays) that are not located inline, identify the resource directories that contain the resources so that AFP Visual Environment can display the sample AFP file correctly.

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:

  1. Inline in the AFP file
  2. Resource directories specified to AFP Visual Environment, in the order the directories are specified
If you have mapped an AFP font to a Java font in a customized font-mapping file, AFP Visual Environment does not look for the AFP font inline or in the resource directories. It uses the Java font.

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.

To identify AFP resource directories:
  1. In AFP Visual Environment, open a sample AFP file. Then click Resources ⇒ Specify Resource Directories.
  2. Click Add.
  3. Type a directory name in the Directory name field, or click Browse to select a directory.
  4. Click OK.
  5. To specify another resource directory, click Add again.
  6. 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.
  7. Click OK.

1.4.1.6.6 Mapping fonts for AFP files

If AFP Visual Environment does not display a custom AFP font correctly in the sample AFP file, you can map the font to a comparable Java font of the same point size and style, and you can change how particular code points map to Unicode code points.

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:

  1. Job font mappings in the AFP Visual Environment control file
  2. Installation font mappings in font-mapping files
  3. 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.4.1.6.6.1 Using font-mapping files to map fonts

To map a custom AFP font to a Java font, edit one or more of the sample font-mapping files that AFP Visual Environment provides.

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.

Note: The font-mapping files must exist on both the preparation system and the production system.

To use font-mapping files to map an AFP font to a Java font:
  1. Navigate to the directory where you installed AFP Visual Environment.
  2. 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.
  3. 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 file T1000259.cp.

1.4.1.6.6.2 Creating font mappings from text blocks

When AFP Visual Environment cannot display text in an AFP file correctly, you can use text blocks in the file to create font mappings.

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.

Note:
Code page mappings make text readable, while character set mappings change how text is displayed in AFP Visual Environment.

To create a font mapping from a text block:
  1. In AFP Visual Environment, open a sample AFP file.
  2. Click Mode and a feature.
  3. 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 the Account or Summary text block.

  4. Right-click anywhere on the page and click Create Font Mapping.
    You see the Create Font Mapping window.
  5. 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, and PLAIN.
  6. 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:
        1. Type a 1- to 5- digit identifer in the Global Identifier field.
        2. 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.
        3. Type a point size.
        4. Select a family name and style for the Java font from the drop-down lists.
        5. Click OK.
      The family name and style for the Java font are updated. The example of the text block you selected in the AFP file is also updated.
    • For Coded Font:
      1. Type an AFP character set name. The name usually begins with "C".
      2. Type an AFP code page name. The name usually begins with "T1".
    • For Code Page:
      1. Select a different global identifier from the drop-down list.
      2. 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.
      The Java character set name is updated. The example of the text block you selected in the AFP file is also updated.
  7. 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.4.1.6.6.3 Modifying font mappings from text blocks

After you create character set, coded font, or code page mappings from text blocks in an AFP file, you can modify or delete the font mappings.
To modify or delete a font mapping:
  1. In AFP Visual Environment, open a sample AFP file.
  2. Click Resources ⇒ Modify Font Mapping.
  3. Select the name of a font mapping.
  4. 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:
          1. Type a 1- to 5- digit identifer in the Global Identifier field.
          2. 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.
          3. Modify the point size.
          4. Select a family name and style for the Java font from the drop-down lists.
          5. Click OK.
        The family name and style for the Java font are updated.
      • For Coded Font, edit the AFP character set name, AFP code page name, or both.
      • For Code Page:
        1. Select a different global identifier from the drop-down list.
        2. 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.
        The Java character set name is updated.
      Click OK. The font mapping is modified.
    • Click Delete or press the Delete key on your keyboard. The font mapping is removed.
  5. 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.4.1.6.6.4 Changing the default code page encoding

If the sample AFP file refers to AFP fonts that are based on a code page that is different from the default code page and you have not mapped the fonts to Java fonts, the default code page can cause the text to be unreadable.

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.

To change the default code page to another encoding:
  1. In AFP Visual Environment, open a sample AFP file.
  2. Click Resources ⇒ Modify Default Encoding.
  3. 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.
  4. Click OK.

1.4.1.6.7 Enabling object selection in sample AFP files

You can change which AFP objects (text, overlays, page segments, barcodes, images) are selectable in the sample AFP file that is currently open.

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:
  1. 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.
  2. 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.

To choose which objects are selectable in this AFP file:
  1. In AFP Visual Environment, open a sample AFP file.
  2. Click Mode and a feature.
  3. Click Resources ⇒ Enable Object Selection.
  4. 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.
  5. Click OK.
  6. In the AFP file, you can now select an object that you made selectable and see its properties:
    1. 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.
    2. Right-click anywhere in the AFP file to see the properties of the object.
  7. Optional: To revert to the default object-selection settings for the current mode, click Mode and then click the current mode.

1.4.1.6.8 Showing page information in sample AFP files

You can show the names of AFP resources (fonts, page segments, and overlays) that the current page in the AFP file refers to and sheet information for the currently displayed AFP page. For each resource, you can see whether AFP Visual Environment found the resource and where the resource was found.

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 (Resources ⇒ Change Form Definition Settings).

To show page information:
  1. In AFP Visual Environment, open a sample AFP file. Then click Resources ⇒ Show Page Information.
  2. 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.
  3. 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.
  4. 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 or No.
    • Constant Front: Whether the constant front is Yes or No.
    • 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."

  5. Click OK.

1.4.1.6.9 Specifying a form definition

You can specify whether AFP Visual Environment displays the AFP file with a form definition. You can use an inline form definition or a default form definition from a specified directory.

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:

  1. In AFP Visual Environment, open a sample AFP file. Then click Resources ⇒ Change Form Definition Settings.
  2. 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.
  3. 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.4.1.6.10 Checking enhancements to sample AFP files

You can save an output AFP file that contains the enhancements you made to the sample AFP file. This is useful if you want to check that the enhancements were made properly before making the same enhancements to production 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.

To check enhancements made to the sample AFP file:
  1. In AFP Visual Environment, open a sample AFP file and enhance it.
  2. Click File ⇒ Save Output File.
  3. Type the full path name of the file you want to create in the File name field.
  4. Optional: Click View user log if you want to view the log that can contain error messages.
  5. Click Save.
    When the output file has been saved, you see a message that says the save has been completed.
  6. 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.4.1.6.11 Configuring and running a set of filters

You can configure and run a set of filters, in a specific order, to process large AFP files quickly and efficiently.
To configure and run a set of filters:
  1. In AFP Visual Environment, open a sample AFP file.
  2. If the file does not contain page groups, use AFP Indexer to create page groups.
  3. Click Mode ⇒ Pipeline Manager.
  4. Click Tools ⇒ Manage Pipeline.

    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.

  5. To add a filter to the pipeline definition:
    1. Select the filter on the Available Pipeline Elements list.
      AFP Visual Environment displays a brief description of the filter.
    2. Click Add.
    3. 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.

    4. Click OK.
    5. Edit the name of the filter.
    6. Click OK.
      The filter appears at the bottom of the list.
    7. 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.
  6. To save your changes, click Apply.

1.4.1.7 Indexing AFP files

AFP Indexer can create page groups, define supplemental pages, and create indexes in AFP files so that the information can be used to navigate to indexed pages in the file and exclude non-customer information from mailpieces.

1.4.1.7.1 Creating page groups

You can create page groups in AFP files. Page groups organize AFP files into smaller, uniquely identifiable units. When you create page groups, any existing page groups defined in the AFP file itself are not used.
You can create page groups that are a fixed number of pages long, or you can create page groups of variable length by defining triggers. You can also 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.

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.4.1.7.1.1 Creating page groups of fixed length

You can create page groups that are of fixed length. This is useful if all page groups in the AFP file always consist of the same number of pages.

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:

  1. 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.
  2. You cannot define supplemental pages for pages in a page group that is created as a fixed-length page group.

To create page groups of fixed length:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Other Page Groups ⇒ Create Fixed-Length Page Groups.
    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.
  3. Select the number of pages in each page group in the Pages in each page group field.
  4. Click Header/Trailer Definition to specify which pages are header and trailer pages and then click OK.
  5. 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.

  6. Verify that the correct page groups have been created:
    1. Check that the number of pages is correct in each page group.
    2. 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.
    3. 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.4.1.7.1.2 Creating page groups with triggers

You can create page groups by defining one or more triggers. A trigger is a block of text that occurs in a consistent location on the first or last page of all page groups.

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:
  1. 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.
  2. In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.

To create page groups with triggers:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. 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 the Account or Summary text block to create a trigger.

  3. 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.
  4. 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:
    1. Click Edit trigger.
    2. 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.
    3. Click OK.
  5. 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.
  6. 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.
    1. 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.
    2. 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.
  7. 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.
  8. Verify that the correct page groups have been created:
    1. Check that the number of pages is correct in each page group.
    2. 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.
    3. If the page groups are incorrect, click Tools ⇒ Modify Definitions 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.
  9. 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.4.1.7.1.3 Creating page groups when white space is found

You can create page groups when white space is found in an area. White space does not contain IOCA (Image Object Content Architecture) image data. As an alternative, you can create page groups when IOCA image data is found in an area.

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.

To create page groups when white space is found:
  1. 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 Mode ⇒ AFP Indexer.
  2. 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.
  3. Right-click anywhere on the page and click Create White Space Trigger..

    You see the Trigger on White Space window.

  4. Type a descriptive name for the white space trigger in the WS Trigger definition name field.
  5. 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.

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

  8. Verify that the correct page groups have been created:
    1. Check that the number of pages is correct in each page group.
    2. 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.
    3. If the page groups are incorrect, click Tools ⇒ Modify Definitions to modify or delete the trigger.
      The trigger is listed as a Page Group Definition under Start Page Group Triggers .

1.4.1.7.1.4 Defining header and trailer pages

After you create fixed-length page groups or page groups with triggers, you can define header and trailer pages and decide if the pages are kept in the final output for viewing and printing.

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.

Note: The header and trailer pages are supplemental pages, so you can index any text in those pages.
To define header and trailer pages:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. If the AFP file does not contain page groups, create page groups.
  3. Click Tools ⇒ Header and Trailer Pages.
    You see the Header and Trailer Pages window.
  4. 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.
  5. If displayed, select the number of header pages in Pages in header.
  6. If displayed, select the number of trailer pages in Pages in trailer.
  7. 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.
  8. 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.4.1.7.2 Defining supplemental pages

You can define pages in an AFP file as supplemental pages when you do not want to include them in page groups. For example, header and trailer pages, separator pages, and any page that should be excluded from a customer statement can be defined as supplemental pages.
You can define supplemental pages with one or more triggers or index tags to uniquely identify a page that is outside a page group. When you define a supplemental page, you give it a page definition name. This lets you define multiple supplemental pages.
Note: The term page definition in AFP Indexer refers to a supplemental page definition, a page-level trigger, or a page-level index, not the AFP page definition resource.

1.4.1.7.2.1 Creating triggers for supplemental pages

You can define supplemental pages by creating one or more triggers. A trigger is a block of text that occurs in a consistent location and uniquely identifies a page.

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:

  1. 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.
  2. In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.

To create triggers that define supplemental pages:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. 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 the Banner or Page text block to create a trigger.

  3. 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.
  4. 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:
    1. Click Edit trigger.
    2. Edit the trigger value in the Edit Value window.
    3. Click OK.
  5. Click Supplemental page for the trigger type.
    You see the Select supplemental page definition field.
  6. Type a name to identify the supplemental page or select a name from the drop-down list.
  7. 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.
  8. 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.
  9. To modify or delete the supplemental page trigger, click Tools ⇒ Modify Definitions.
    The trigger is listed as a Supplemental Page Definition under Page Triggers.
  10. Optional: To create an additional trigger for the supplemental page or to define a different supplemental page, repeat the steps.

1.4.1.7.2.2 Creating index tags on supplemental pages

You can create one or more index tags on pages that are not included in page groups.
To create an index tag on a supplemental page:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. Select a page that is outside a page group.
  3. 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.
  4. 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.
  5. 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.
  6. Click OK when you are done creating the index tag.
  7. Verify that the correct index tag has been created:
    1. 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.
    2. To close the Properties window, click X in the upper right corner.
    3. If the index tag is incorrect, click Tools ⇒ Modify Definitions to modify or delete the tag.
      The index tag is listed as a Supplemental Page Definition under Page Indexes, Index areas, or Address Indexes.
  8. 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.4.1.7.3 Creating index tags

You can create index tags in AFP files. When a file contains index tags, you can use an AFP viewer to navigate in the file to find specific data viewer to navigate in the file to find specific data. You can also use the index tag values in barcode data.

1.4.1.7.3.1 Creating index tags for text blocks

You can create an index tag for text in an AFP text block. You can edit the text in the block to remove unwanted characters, such as blanks or special characters.
Notes:
  1. 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.
  2. In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To create an index tag for a text block:
  1. In AFP Visual Environment, open a sample AFP file that contains the text you want to index. Then click Mode ⇒ AFP Indexer.
  2. 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.
  3. 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.
  4. Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
  5. 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 be Customer name.
  6. 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:
    1. Click Edit index value.
    2. 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.
    3. Click OK.
  7. 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.
  8. 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.

  9. Click OK. You see the index tags listed in the bottom pane for each page group.
  10. Verify that the correct index tag has been created:
    1. Double-click the index tag in the bottom pane and verify that the correct page in the page group is displayed.
    2. If the index tag is incorrect, click Tools ⇒ Modify Definitions to modify or delete the tag.
      The index tag is listed as a Page Group Definition under Page Group Indexes.

1.4.1.7.3.2 Creating index tags in areas

You can create index tags for text in an area.

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:

  1. 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.
  2. In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.

To create index tags in an area:
  1. In AFP Visual Environment, open a sample AFP file that contains the text you want to index. Then click Mode ⇒ AFP Indexer.
  2. 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.
  3. Right-click anywhere on the page and click Create Index Tags.
    You see the Create Index Tags in an Area window.
  4. 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 (Resources ⇒ Modify Default Encoding). 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.

  5. 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.
  6. 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.
  7. 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.
  8. To create an index tag for the text shown in a line in the area:
    1. Click Add.
    2. Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
    3. Type a descriptive name for the index tag.
      For example, if the index tag contains an account number, the name could be Account number.
    4. 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.
    5. 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.
    6. 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 is null for that page group.
    7. Click OK.
      You see the index tag and the index tag value in the Index tags for specific lines field.
  9. 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.
  10. Click OK.
    You see the index tags listed in the bottom pane for each page group.
  11. Verify that the correct index tags have been created:
    1. Double-click the index tags in the bottom pane and verify that the correct pages in the page groups are displayed.
    2. If an index tag is incorrect, click Tools ⇒ Modify Definitions to modify or delete the tag.
      The index tag is listed under Page Group Definition ⇒ Page Group Indexes ⇒ Index areas.

1.4.1.7.3.3 Creating index tags in address areas

You can create index tags for mailing addresses in an address area.

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:
  1. 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.
  2. In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.

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.

Note: In an address area, you can create one or more index tags. For example, you can create an index tag for the ZIP Code without creating index tags for any other text in the address area.
To create index tags in an address area:
  1. 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 Mode ⇒ AFP Indexer.
  2. 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.
  3. 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.
  4. 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.
  5. 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 (Resources ⇒ Modify Default Encoding). 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.

  6. 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.
  7. 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.
  8. 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.
  9. Optional: To create an index tag for a specific line in the area:
    1. Click Add.
    2. Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
    3. Type a descriptive name for the index tag.
      For example, if the line contains the customer name, the name could be Customer.
    4. 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.
    5. 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.
    6. 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 is null for that page group.
    7. Click OK.
      You see the index tag and the index tag value in the Index tags for specific lines field.
  10. 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.
  11. Optional: To create index tags for the lines that are shown in the Index tags for intermediate lines field:
    1. Click Index intermediate lines.
    2. Specify the name for the index tags in the Index tag name field. For example, the name could be Street.
    3. 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.
    4. 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 and Street2. 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 tag Street1.
  12. Optional: To create an index tag for a ZIP Code in the U.S. Postal Service format (nnnnn or nnnnn-nnnn):
    1. Click the ZIP Code tab.
      You see the ZIP Code in the ZIP Code field.
    2. Type a descriptive name for the index tag.
      For example, the name could be ZIP Code.
    3. Use the default code page encoding or select an encoding from the drop-down list.
    4. 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 value null.
  13. Click OK.
    You see the index tags listed in the bottom pane for each page group.
  14. Verify that the correct index tags have been created:
    1. Double-click the index tags in the bottom pane and verify that the correct pages in the page groups are displayed.
    2. If an index tag is incorrect, click Tools ⇒ Modify Definitions to modify or delete the tag.
      The index tag is listed under Page Group Definition ⇒ Page Group Indexes ⇒ Address Indexes.

1.4.1.7.3.4 Creating index tags from NOP records

You can create index tags from No Operation (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.

To create index tags from page group NOPs:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. If the AFP file does not contain page groups, create page groups.
  3. Click Tools ⇒ Index Tools ⇒ Create Indexes from NOPs.

    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:

    1. Optional: If the text in the NOP record does not look correct, click ASCII to change the NOP encoding; EBCDIC is the default.
    2. From the drop-down list, view the NOPs available for selection.
    3. 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.
    4. Select a number in the Select first character position field until the NOP record you want is displayed in the Matching NOP field.
    5. Click OK. You see the Create Index Tag window with the NOP text to index in the Edited value field.

  4. Create the index tag:
    1. Type a descriptive name for the index tag in the Index tag name field.
    2. 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.
  5. Click OK.
    In the bottom pane, you see the index tag listed if the NOP record is on a page in the page group.
  6. Optional: To create additional index tags, repeat the steps.
  7. If an index tag is incorrect, click Tools ⇒ Modify Definitions to modify or delete the tag.
    The NOP index tag is listed under Page Group Definition ⇒ Page Group Indexes ⇒ NOP Index tags.

1.4.1.7.4 Working with page-level indexes

Page-level index tags are defined on individual pages in a page group rather than within the page group.
To create page-level indexes, you first create triggers that define individual pages in a page group. Then you create indexes on the defined pages. AFP Indexer also lets you copy or move page-level index tags to a page group.
Note: The term page definition in AFP Indexer refers to a page-level trigger, a page-level index, or a supplemental page definition, not the AFP page definition resource.

1.4.1.7.4.1 Creating page-level triggers

In an AFP file with existing page groups or after you create page groups in a file, you can create triggers to define individual pages in page groups.

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.

Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To create page-level triggers:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. Select a page in a page group.
  3. 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 the Account or Summary text block to create a trigger.

  4. 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.
  5. 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:
    1. Click Edit trigger.
    2. Edit the trigger value in the Edit Value window.
    3. Click OK.
  6. Click Page for the trigger type.
    You see the Select page definition field.
  7. Type a name to identify the page or select a name from the drop-down list.
  8. 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.
  9. Click OK.
  10. Click Tools ⇒ Modify Definitions to modify or delete the trigger.
    The trigger is listed under Page Group Definition ⇒ Page Definition ⇒ Page Triggers.
  11. Optional: To create an additional trigger, repeat the steps.

1.4.1.7.4.2 Creating page-level indexes

After you create triggers to define individual pages in page groups, you can create index tags on the individual pages.
Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To create an index tag for a text block:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. If the AFP file does not contain page definitions in page groups, create one or more page-level triggers.
  3. Select a page in a page group.
  4. 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.
  5. 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.
  6. Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
  7. 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 be Customer name.
  8. Click Page within page group for the index type.
    You see the Select index value type and Select page definition fields.
  9. 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:
    1. Click Edit index value.
    2. 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.
    3. Click OK.
    User defined
    The User defined value field is displayed. Type the text you want for the index tag.
  10. Select an existing page definition from the drop-down list.
  11. 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.

  12. Click OK.
  13. Verify that the correct index tag has been created:
    1. 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.
    2. To close the Properties window, click X in the upper right corner.
    3. If the index tag is incorrect, click Tools ⇒ Modify Definitions to modify or delete the tag. Page-level indexes are listed under Page Group Definition ⇒ Page Definition ⇒ Page Indexes.

1.4.1.7.4.3 Copying or moving page-level indexes to page groups

You can copy or move all page-level index tags to a page group. Page-level index tags are found on a page in the AFP file, but at the page level instead of the page-group level.
You can see what index tags are on a page by displaying the properties for the page. The name of an index tag and its value are listed in the TLE field.
To copy or move page-level index tags so they are added to the page group:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. Select a page that is within a page group.
  3. Click Tools ⇒ Index Tools ⇒ Relocate Page Indexes to Page Groups.
    You see the Copy Page Indexes to Page Group window. The Current Page field displays the page you selected in the page group.
  4. 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.
  5. 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.
  6. Click OK.
    In the bottom pane, you see the index tags that have been added to the page groups.
  7. Optional: To remove the index tags that you added to a page group:
    1. Click Tools ⇒ Index Tools ⇒ Relocate Page Indexes to Page Groups.
      You see the Copy Page Indexes to Page Group window with the selections you previously made.
    2. Click Delete.
      The index tags are removed from the page group.

1.4.1.7.5 Modifying or deleting AFP Indexer definitions

After you create triggers and index tags for page groups, pages in page groups, and supplemental pages, you can modify or delete any of them.

1.4.1.7.5.1 Modifying triggers

You can modify page group, supplemental page, and page-level trigger definitions. When you modify a trigger, the boundaries of the page groups might change.
    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 View ⇒ Units.

To modify a trigger definition:

  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the triggers. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window.
  3. Select the name of the trigger that you want to modify.
  4. Click Modify, or double-click.
    You see the Modify Trigger window.
  5. To edit the trigger value, click Edit trigger. Edit the trigger value in the Edit Value window and click OK.
  6. 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.
  7. 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.
  8. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.7.5.2 Deleting triggers

You can delete page group, supplemental page, and page-level trigger definitions. When you delete a trigger, the boundaries of the page groups might change.
Note: Be careful deleting triggers if you have made other enhancements to the sample AFP file. For example, if you have created index tags and you delete 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. If you delete the last trigger defined in the control file, any page groups that are defined in the AFP file itself are displayed in the left pane.

To delete a trigger definition:

  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the triggers. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Modify Definitions.
    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 Tools ⇒ Other Page Groups ⇒ Use Existing Page Groups.
  3. Select the trigger that you want to delete.
  4. Click Delete, or press the Delete key on your keyboard.
    You see a message that asks if you want to continue.
  5. Click Yes.
    The trigger is removed from the definitions list.
  6. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.7.5.3 Modifying index tags for text blocks

You can modify the index tags for AFP text blocks that were created with AFP Indexer, including page group indexes, page-level indexes, NOP indexes, and supplemental page indexes.
Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.

To modify an index tag for a text block:

  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Modify Definitions.
    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.
  3. Select the index tag that you want to modify.
  4. 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.
  5. To change the name of the index tag, type a new name in the Index tag name field.
  6. To change the code page encoding, select an encoding from the drop-down list.
    This field is not displayed for NOP index tags.
  7. To edit the index value, click Edit index value. Edit the index value in the Edit Value window and click OK.
  8. 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.

  9. Click OK. You see the index tags listed in the bottom pane for each page group.
  10. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.7.5.4 Modifying index tags in areas

You can modify the index tags that you created for page group or supplemental page areas.
Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.

To modify index tags in an area:

  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window with index areas.
  3. Select the index area that you want to modify.
  4. Click Modify, or double-click.
    You see the Modify Index Tags in an Area window.
  5. 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.
  6. To add an index tag for a specific line in the area:
    1. Click Add.
      You see the Create Index Tag window.
    2. Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
    3. Type a descriptive name for the index tag.
    4. 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.
    5. 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.
    6. 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 is null for that page group.
    7. Click OK.
      You see the index tag and the index tag value in the Index tags for specific lines field.
  7. 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.
  8. 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.
  9. Click OK. You see the index tags listed in the bottom pane for each page group.
  10. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.7.5.5 Modifying index tags in address areas

You can modify the index tags that you created for page group or supplemental page address areas.
Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.

To modify index tags in an address area:

  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window with address indexes.
  3. Select the address index that you want to modify.
  4. Click Modify, or double-click.
    You see the Modify Index Tags in an Address Area window.
  5. 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.
  6. To add an index tag for a specific line in the address area:
    1. Click Add.
      You see the Create Index Tag window.
    2. Use the default code page encoding or select an encoding from the drop-down list if the text displays incorrectly.
    3. Type a descriptive name for the index tag.
    4. 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.
    5. 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.
    6. 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 is null for that page group.
    7. Click OK.
      You see the index tag and the index tag value in the Index tags for specific lines field.
  7. 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.
  8. 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.
  9. 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.
  10. 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.
  11. Click OK. You see the index tags listed in the bottom pane for each page group.
  12. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.7.5.6 Deleting index tags

You can delete all index tags that were created with AFP Indexer, including page group, supplemental page, page-level, and NOP index definitions. You can also delete index tags that were created for specific lines in index areas and address areas, and intermediate lines and ZIP Codes in address areas.
Note: Be careful deleting index tags if you have made other enhancements to the sample AFP file that depend on the index tags. For example, do not delete an index tag if you used AFP Editor to create a barcode that contains the index tag value.

To delete an index tag:

  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the index tags. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Modify Definitions.
    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 Tools ⇒ Other Page Groups ⇒ Use Existing Page Groups.
  3. 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:
    1. 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.
    2. Click OK.
      The index tags are removed from the list in the bottom pane.
  4. To delete an index tag definition, including all index tags created for an index area or address area:
    1. Select the index definition you want to delete.
    2. 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.
  5. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.7.6 Using existing page groups and index tags

If page groups and index tags are defined in the AFP file instead of a AFP Visual Environment control file, you can choose whether to use the existing page groups in the AFP file and, if the page groups are nested, which level of page groups to use.

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.

Note: Be cautious about changing which level of existing page groups to use if you have made enhancements to the sample AFP file. For example, if you have created page groups or index tags, the page groups might change or the index tags might be 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.

To use existing page groups and index tags:

  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. Click Tools ⇒ Other Page Groups ⇒ Use Existing Page Groups.
    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.
  3. 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.

    An example of the page group structure with two levels: page groups and pages
    An example of the structure when definitions for the page level are imported.

  4. To remove the index tags that are defined in the AFP file, clear the Use index tags box.
  5. Click OK.
    You see the page groups and index tags that you chose to use in the AFP file.

1.4.1.7.7 Editing text for triggers and index tags

When you create or modify a trigger or an index tag, you can edit the text value. You can also edit the text value for existing index tags that are defined in the AFP file or the AFP Visual Environment control file.
You might want to edit the text value to remove any leading or trailing blanks, or to remove unwanted special characters. When you edit a text value, make sure that you edit it so that it is appropriate for all page groups because the text values can be different in each page group.
To edit the text for a trigger or index tag:
  1. In AFP Visual Environment, open a sample AFP file. Then click Mode ⇒ AFP Indexer.
  2. Do one of these to open the Edit Value window:
    • Click Tools ⇒ Index Tools ⇒ Edit Existing Indexes. Select an index tag from the drop-down list and click Edit.
    • When creating or modifying a trigger or index tag, click one of these: Edit index value, Edit trigger, or Edit value.
  3. 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:
    1. Edit by stripping characters
    2. Edit on delimiter
    3. Edit on character
  4. 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:

      1. 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.
      2. Click OK.

1.4.1.7.8 Managing comments

You can manage comments in the AFP Indexer portion of the AFP Visual Environment control file.
To manage comments:
  1. In AFP Visual Environment, open a sample AFP file.
  2. Click Mode ⇒ AFP Indexer.
  3. Click Tools ⇒ Manage Comments.

    You see a list of comments, if any, in the AFP Indexer portion of the AFP Visual Environment control file.

  4. To add a comment:
    1. Click Add Comment.
    2. Type the text of the comment.
    3. Click OK.
  5. To delete a comment:
    1. Click the text of the comment.
    2. Press the Delete key on your keyboard.
  6. When you finish managing comments, click OK.
  7. 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.4.1.8 Editing AFP files

AFP Editor can create barcodes and text, hide areas, and mask text in AFP files. In addition, AFP Editor can replace existing POSTNET barcodes with Intelligent Mail barcodes (IMBs). If you want AFP Editor to use sequential serial numbers in IMBs, you must create an IMB serial number file.

1.4.1.8.1 Creating barcodes

AFP Editor lets you create barcodes in AFP files.

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.

Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To create a barcode:
  1. In AFP Visual Environment, open a sample AFP file.
  2. 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.
  3. Click Mode ⇒ AFP Editor.
  4. 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.
  5. 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.

  6. Right-click anywhere in the AFP file and click Create barcode.

    You see the Create Barcode window.

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

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

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

  10. 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 (Resources ⇒ Specify Resource Directories). The AFP IMB font (character set C0XMUS23) is installed in the install_directory/resources directory.
  11. 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 Tools ⇒ Modify Definitions to correct the properties.

    (In the Modify and Delete Definitions window, Red x image 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.4.1.8.1.1 Type tab

On the Type tab, you specify the name of the barcode area, the type of barcode that you want to create, and the properties of the barcode.
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 Response code 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:

  1. This option is currently available only for IMBs.
  2. 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.
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.4.1.8.1.2 Data tab for Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcodes

On the Data tab, you specify the data that AFP Editor encodes in the barcode symbol 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:
  • ZIP Code: 5 digits
  • ZIP Code + 4: 9 digits
  • Advanced Bar Code (ABC): 11 digits
  • Variable-length barcode: 0 to n digits (barcode receivers support at least 50 digits)
QR Code Any one-byte character, or binary data 0 to 3116 characters

1.4.1.8.1.3 Data tab for IMBs

On the Data tab, you specify the data that AFP Editor encodes in the barcode symbol for Intelligent Mail barcodes (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 services option 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.4.1.8.1.4 Position tab

On the Position tab, you specify the exact origin (top-left corner) and size (width and height) of the barcode area, and the orientation of the barcode symbol within the barcode area. You can also specify on which pages in each page group to place the barcode.

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
Image showing 4 barcodes with symbols in different orientations

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

Note: When you create BCOCA objects, the barcode area must be large enough to contain the largest barcode symbol and human-readable interpretation (HRI), if any, in each page group. If any part of the barcode symbol or HRI extends outside of the barcode area, the printer reports an exception and does not print the barcode correctly. When you create text IMBs, the size of the barcode area is ignored.
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.4.1.8.2 Replacing POSTNET barcodes with IMBs

You can replace POSTNET barcodes in AFP files with Intelligent Mail barcodes (IMBs). When you replace POSTNET barcodes, AFP Editor deletes the POSTNET barcodes and creates IMBs that contain the same routing codes as the POSTNET barcodes.

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 View ⇒ Units.

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.

To replace a POSTNET barcode with an IMB:
  1. In AFP Visual Environment, open a sample AFP file.
  2. If the file does not contain page groups, use AFP Indexer to create page groups.
  3. Click Mode ⇒ AFP Editor.
  4. Navigate to the page that contains one of the POSTNET barcodes.
  5. 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.
  6. 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.
  7. 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 (Resources ⇒ Specify Resource Directories). If you still do not see the Replace POSTNET with IMB option, try changing the default code page to another code page (Resources ⇒ Modify Default Encoding).

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

  8. 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.
  9. 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.
  10. 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.
  11. 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 (Resources ⇒ Specify Resource Directories). The AFP IMB font (character set C0XMUS23) is installed in the install_directory/resources directory.
  12. 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 Tools ⇒ Modify Definitions to correct the properties. (In the Modify and Delete Definitions window, Red x image 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.4.1.8.2.1 Type tab for IMBs

On the Type tab, you specify the name of the Intelligent Mail barcode (IMB) area and whether to create a BCOCA or text barcode.
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.4.1.8.2.2 Data tab for IMBs

On the Data tab, you specify the data that AFP Editor encodes in the barcode symbol for Intelligent Mail barcodes (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 services option 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.4.1.8.2.3 Position tab for IMBs

On the Position tab, you can change the origin (top-left corner) of the Intelligent Mail barcode (IMB), the size of the barcode area, and the orientation of the barcode symbol.

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.4.1.8.3 Creating IMB serial number files

If you want Intelligent Mail barcodes (IMBs) to contain a sequential serial number that identifies each mailpiece, you must create a serial number file.

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.

To create an IMB serial number file:
  1. On the preparation system, create an IMB serial number file.
  2. 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 file to-imb-serial.
  3. 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 the ftpbinary option.

1.4.1.8.4 Creating conditions between barcode definitions

When you define more than one barcode, you can create a condition between two barcodes that AFP Editor uses to determine which barcode is created in the AFP file.
You can use conditions to control when a barcode is added to a page group. For example, if some page groups contain POSTNET barcodes and some page groups do not, you might want to add a new barcode to the page groups that do not have one. You can define a new barcode and create a condition so that whenever the POSTNET barcode is not found, the new barcode is added to the page group. Similarly, if you want to replace an existing barcode in all page groups with a new barcode, you can define a condition so that whenever the old barcode is found, it is replaced with the new barcode.
To create a condition between barcode definitions:
  1. In AFP Visual Environment, open a sample AFP file.
  2. Click Mode ⇒ AFP Editor.
  3. Create two barcodes if you do not already have two defined.
  4. 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 Tools ⇒ Modify Definitions and then click Conditions on the Modify and Delete Definitions window.
    You see the Create Conditions between Definitions window.
  5. From the drop-down list, select a barcode in the Select Definition 1 field.
  6. 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.
  7. From the drop-down list, select a barcode in the Select Definition 2 field.
  8. 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, click Tools ⇒ Modify Definitions to see the condition you just defined.
  9. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.5 Creating hidden areas

You can hide areas in AFP files that you do not want to print and that you do not want an AFP viewer to display. For example, you might hide an area that contains a barcode before you create a new barcode in the same place.

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.

Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To create a hidden area:
  1. In AFP Visual Environment, open a sample AFP file.
  2. If the sample AFP file does not contain page groups, use AFP Indexer to create page groups.
  3. Click Mode ⇒ AFP Editor.
  4. 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.
  5. 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.
  6. Right-click anywhere in the AFP file and click Hide area.
  7. 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.
  8. Select the color of the area in the Color field.
  9. 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.
  10. 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.
  11. 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,...)
  12. Click OK.
    You do not see any text or image data in the hidden area in each page group.

1.4.1.8.6 Creating text with AFP Editor

You can create a string of text on a specified page of each page group in an AFP file and specify its color, font, and size.

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 View ⇒ Units.
To create text in an AFP file:
  1. In AFP Visual Environment, open a sample AFP file.
  2. If the file does not contain page groups, use AFP Indexer to create page groups.
  3. Click Mode ⇒ AFP Editor.
  4. 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.
  5. Right-click anywhere in the AFP file and then click Create Text.
    You see the Create Text String window.
  6. On the Text tab, type a descriptive name for the text area in the Text definition name field.
  7. 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:
    1. Type Page in the Text field and click Add.
    2. 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.
    3. Type of in the Text field and click Add.
    4. 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.
  8. 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.
  9. Optional: Select a color for the text from the Color drop-down list.
  10. 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.
    You see the Character Set Description and Font Resource fields change for the font you selected. Font Resource is "Outline" for core fonts and "Raster" for external fonts.
      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.
  11. 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.
  12. Click OK.
    You see the text in the AFP file.
  13. 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.4.1.8.7 Defining text masks

You can define text masks to replace specific data with another character. For example, you might need to block out (or mask) sensitive information, such as customer names and social security numbers.
The text you want to mask must occur in a consistent location on every page group in the file.
To define a text mask:
  1. In AFP Visual Environment, open a sample AFP file that contains the text you want to mask.
  2. If the sample AFP file does not contain page groups, use AFP Indexer to create page groups.
  3. Click Mode ⇒ AFP Editor.
  4. 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.
  5. 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.
  6. 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.
  7. 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.

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

  9. Click OK.
  10. Verify that the correct text has been masked in all page groups:
    1. Double-click the page groups in the bottom pane and verify that the correct text has been marked.
    2. If the text mask is incorrect, modify or delete the text mask (Tools ⇒ Definitions ⇒ Modify and Delete).

1.4.1.8.8 Modifying or deleting AFP Editor definitions

After you create barcodes, text, hidden areas, definition conditions, or text masks, you can modify or delete any of them. You can also create and modify conditions if you have defined at least two barcodes.

1.4.1.8.8.1 Modifying barcodes

You can modify the barcodes that were created with AFP Editor. You cannot modify barcodes that are defined in the AFP file itself.
Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To modify a barcode:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the barcodes. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Modify Definitions.
  3. 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: Red x image 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.
  4. Optional: On the Type tab, type a new name or change the type of barcode.
    See Type tab for a description of the fields.
  5. Optional: On the Data tab, change the data to be encoded in the barcode symbol.
  6. 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.
  7. 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 (Resources ⇒ Specify Resource Directories).

    • The AFP IMB font (character set C0XMUS23) is installed in the plugins/EditAFP directory.
  8. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.1.1 Type tab

On the Type tab, you specify the name of the barcode area, the type of barcode that you want to create, and the properties of the barcode.
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 Response code 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:

  1. This option is currently available only for IMBs.
  2. 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.
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.4.1.8.8.1.2 Data tab for Code 39, Data Matrix, Interleaved 2-of-5, PDF417, POSTNET, and QR Code barcodes

On the Data tab, you specify the data that AFP Editor encodes in the barcode symbol 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:
  • ZIP Code: 5 digits
  • ZIP Code + 4: 9 digits
  • Advanced Bar Code (ABC): 11 digits
  • Variable-length barcode: 0 to n digits (barcode receivers support at least 50 digits)
QR Code Any one-byte character, or binary data 0 to 3116 characters

1.4.1.8.8.1.3 Data tab for IMBs

On the Data tab, you specify the data that AFP Editor encodes in the barcode symbol for Intelligent Mail barcodes (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 services option 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.4.1.8.8.1.4 Position tab

On the Position tab, you specify the exact origin (top-left corner) and size (width and height) of the barcode area, and the orientation of the barcode symbol within the barcode area. You can also specify on which pages in each page group to place the barcode.

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
Image showing 4 barcodes with symbols in different orientations

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

Note: When you create BCOCA objects, the barcode area must be large enough to contain the largest barcode symbol and human-readable interpretation (HRI), if any, in each page group. If any part of the barcode symbol or HRI extends outside of the barcode area, the printer reports an exception and does not print the barcode correctly. When you create text IMBs, the size of the barcode area is ignored.
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.4.1.8.8.2 Deleting barcodes

You can delete the barcodes that were created with AFP Editor. You cannot delete barcodes that are defined in the AFP file itself (instead, you can create areas to hide barcodes).
To delete a barcode:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the barcodes. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window with a list of the barcodes.
  3. Select the barcode that you want to delete.
  4. 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.
  5. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.3 Modifying conditions between barcode definitions

You can modify the conditions that AFP Editor uses to determine which barcode is used.
To modify a definition condition:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the condition definitions for the barcodes. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Modify Definitions.
  3. 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.
  4. Select the Definition 1, Condition, and Definition 2 that you want to change.
  5. Click OK.
    The condition is modified in the list.
  6. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.4 Deleting conditions between barcode definitions

You can delete the conditions that AFP Editor uses to determine which barcode is used.
To delete a definition condition:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for conditions. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window with a list of the definition conditions.
  3. Select the definition condition that you want to delete.
  4. Click Delete, or press the Delete key on your keyboard.
    The definition condition is removed from the list.
  5. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.5 Modifying hidden areas

You can modify the hidden areas that were created with AFP Editor.
Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To modify a hidden area:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the hidden areas. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Modify Definitions.
  3. 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: Red x image 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.
  4. To change the descriptive name of the hidden area, type the new name in the Hidden area name field.
  5. 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.
  6. 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.
  7. 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,...)
  8. Click OK.
    You do not see any text or image data in the hidden area in each page group.
  9. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.6 Deleting hidden areas

You can delete the hidden areas that were created with AFP Editor.
To delete a hidden area:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the hidden areas. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window with a list of the hidden areas.
  3. Select the hidden area that you want to delete.
  4. 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.
  5. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.7 Modifying text strings

You can modify a string of text that was created with AFP Editor. You cannot modify text in the AFP file itself.
    Note:
  • In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To modify a text string:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for text strings.
  2. Click Mode ⇒ AFP Editor.
  3. Click Tools ⇒ Modify Definitions.
  4. 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.
  5. 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":
    1. Press and hold the CTRL key, and then select of and Page Count.
    2. Click Remove.
    3. Type for in the Text field and click Add.
    4. 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.
  6. 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.
    You see the Character Set Description and Font Resource fields change for the font you selected. Font Resource is "Outline" for core fonts and "Raster" for external fonts.
      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.
  7. 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.
  8. Click OK.
    You see the edited text in the AFP file.

1.4.1.8.8.8 Deleting text strings

You can delete a string of text that was created with AFP Editor. You cannot delete text in the AFP file itself (instead, you can create areas to hide text).
To delete a text string:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for text strings.
  2. Click Mode ⇒ AFP Editor.
  3. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window with a list of text strings.
  4. Select the text string that you want to delete.
  5. Click Delete, or press the Delete key on your keyboard.
    The text string is removed from the list.
  6. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.9 Modifying text masks

You can modify any of the text mask definitions that were created with AFP Editor.
To modify a text mask:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the text masks. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Definitions ⇒ Modify and Delete.
  3. Select the text mask that you want to modify.
  4. Click Modify, or double-click.
    You see the Modify Text Mask window.
  5. 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.
  6. Optional: To edit the text mask value, click Edit text mask. Edit the value in the Edit Value window and click OK.
  7. 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.

  8. Click OK.
  9. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.10 Deleting text masks

You can delete the text masks that were created with AFP Editor.
To delete a text mask:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the text masks. Then click Mode ⇒ AFP Editor.
  2. Click Tools ⇒ Definitions.
    You see the Modify and Delete Definitions window with a list of the text masks.
  3. Select the text mask that you want to delete.
  4. Click Delete, or press the Delete key on your keyboard.
    The text mask is removed from the list.
  5. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.8.8.11 Editing text for text masks

When you create or modify a text mask, you can edit the text value.
When you edit a text value, make sure that you edit it so that it is appropriate for all page groups because the text values can be different in each page group.
To edit the text for a text mask:
  1. 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.
  2. Click OK.

1.4.1.9 Adding content to white space in AFP files

Whitespace Manager can find areas of available white space in AFP files and then fill the white space with content, such as images or text.

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.4.1.9.1 Creating definitions for known white space

You can create a definition for white space that you know exists on the same page in all page groups.

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 View ⇒ Units.

To create a known white space definition:
  1. In AFP Visual Environment, open a sample AFP file.
  2. If the file does not contain page groups, use AFP Indexer to create page groups.
  3. Click Mode ⇒ Whitespace Manager.
  4. Select the page in the page group where you want to define white space.
  5. 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.
  6. 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.
  7. Type a name for the white space definition.
    Give the definition a descriptive name to distinguish it from other definitions.
  8. 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.
    If a selection is grayed-out, it is the only one available.
  9. 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.
  10. Click OK.
    You see the defined white space area displayed as a colored box.
  11. Verify that the correct white space area has been defined:
    1. In the bottom pane, click the White spaces tab.
    2. 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.
    3. If the white space area is incorrect, modify or delete it (Tools ⇒ Modify Definitions).
  12. Optional: To create another white space definition, go to step 4 and repeat the steps.

1.4.1.9.2 Creating definitions by searching for white space

When you do not know where white space exists, you can search for the first available white space in a page group and create a definition. 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.

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 View ⇒ Units.

To create a definition for the first available white space in a page group:
  1. In AFP Visual Environment, open a sample AFP file.
  2. If the file does not contain page groups, use AFP Indexer to create page groups.
  3. Click Mode ⇒ Whitespace Manager.
  4. Select a page in the page group.
  5. 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.
  6. 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.
  7. Type a name for the white space definition.
    Make sure you give the definition a descriptive name to distinguish it from other definitions.
  8. 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.
  9. 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.
    If a selection is grayed-out, it is the only one available.
  10. 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.
  11. Click OK.
    You see the defined white space area displayed as a colored box.
  12. Verify that the correct white space area has been defined:
    1. In the bottom pane, click the White spaces tab.
    2. 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.
    3. If the white space area is incorrect, modify or delete it (Tools ⇒ Modify Definitions).
  13. Optional: Optional: To create another white space definition, go to Step 4 and repeat the steps.

1.4.1.9.3 Modifying or deleting white space definitions

After you define white space areas in an AFP file, you can modify or delete any of the definitions.

1.4.1.9.3.1 Modifying known white space definitions

You can modify a definition for white space that you know exists on a page.
    Note:
  • In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To modify a known white space definition:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for white space.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Modify Definitions.
  4. 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.
  5. 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.
  6. Optional: On the Position tab, change the origin (top-left corner) and size (width and height) of the white space area.
  7. Click OK.

1.4.1.9.3.2 Modifying white space defined from a search

You can modify white space that you defined from a search.
    Note:
  • In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To modify white space defined from a search:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for white space.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Modify Definitions.
  4. 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.
  5. 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.
  6. Optional: On the Position tab, change the origin (top-left corner) and size (width and height) of the white space area.
  7. Click OK.

1.4.1.9.3.3 Deleting white space definitions

You can delete the white space definitions that were created with Whitespace Manager.
Deleting a white space definition also deletes any rules created for the definition in the Manage Campaigns window. Make sure you no longer need the rules before deleting a white space definition.
To delete a white space definition:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the definitions for the white space.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Modify Definitions.
    You see the Modify and Delete Definitions window with definitions of white space from a search and known white space.
  4. Select the white space definition that you want to delete.
  5. 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.
  6. To close the Modify and Delete Definitions window, click X in the upper right corner.

1.4.1.9.4 Assigning content to white space

You can assign image and text content to defined white space areas by creating rules that determine what content is assigned and under what conditions it is assigned.
You must create one or more white space definitions before you can assign content.

1.4.1.9.4.1 Creating rules for assigning content

You create one or more rules for assigning content to white space so you can target the content for specific customers or for the best use of available space.
You must create one or more white space definitions before you can assign content. Also, index tags you want to use as conditions in rules must exist in page groups. You can use AFP Indexer to create index tags.
    Note:
  • In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To create rules for assigning content to white space:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. Select a white space definition from the list in the top pane of the window.
  5. 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.
  6. Optional: Specify one or more conditions if you want a rule other than Always:
    1. Click Create in the Conditions section.
      You see the Create Condition window.
    2. 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.
    3. Optional: Click Create to create another condition for the rule.
      You see the Create Condition window.
      1. 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.
      2. 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.
  7. Specify the content that is assigned when the rule is true:
    1. Click Insert text to assign text. You see the Insert Text window.
      1. Define the text string data and the text color on the Text tab.
      2. Optional: Change the text font on the Font tab.
      3. Optional: Adjust the text position in the white space area on the Position tab.
      4. Click OK.
      5. Optional: Repeat the steps to add more text.
    2. Click Insert image to assign an image. You see the Insert Image window.
      1. 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.
      2. Optional: Adjust the image position in the white space area on the Position tab.
      3. Click OK.
      4. Optional: Repeat the steps to add another image.
    3. 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.
  8. Optional: Specify the content that is assigned when the rule is false.
    This section is not available when the rule is Always.
    1. Click Insert text to assign text. You see the Insert Text window.
      1. Define the text string data and the text color on the Text tab.
      2. Optional: Change the text font on the Font tab.
      3. Optional: Adjust the text position in the white space area on the Position tab.
      4. Click OK.
      5. Optional: Repeat the steps to add more text.
    2. Click Insert image to assign an image. You see the Insert Image window.
      1. 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.
      2. Optional: Adjust the image position in the white space area on the Position tab.
      3. Click OK.
      4. Optional: Repeat the steps to add another image.
    3. 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.
  9. Optional: To create another rule, go to Step 4 and repeat the steps.
  10. Click OK.

1.4.1.9.4.2 Inserting content text

You can define the text you want inserted as white space content.
    Note:
  • In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To define the text you want inserted as content:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. 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.
  5. Click Insert text in the Content section.
    You see the Insert Text window.
  6. 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:
    1. Type Page and a space in the Text field and click Add.
    2. 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.
    3. Type a space, of, and another space in the Text field and click Add.
    4. 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.
  7. 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.
  8. Optional: Select a color for the text from the Color drop-down list.
  9. 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.
    You see the Character Set Description and Font Resource fields change for the font you selected. Font Resource is "Outline" for core fonts and "Raster" for external fonts.
      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.
  10. 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.
  11. Click OK.
    The text is added to the rule and the list in the drop-down box.
  12. 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.4.1.9.4.3 Inserting content images

You can define the images you want inserted as white space content.
    Note:
  • In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To define the images you want inserted as content:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. 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.
  5. Click Insert image in the Content section.
    You see the Insert Image window.
  6. 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.
  7. 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.
  8. Click OK.
    The image is added to the rule and the list in the drop-down box.
  9. 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.
  10. Click OK.
    If you added the image inline, you see the image listed in the inline resource group in the left pane.

1.4.1.9.4.4 Modifying content text

You can modify the text you have defined for white space content.
Note: In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To modify text you have defined in content:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. Select a rule from the list in the top pane of the window.
  5. Select text content from the drop-down list.
  6. Click Edit in the Content section.
    You see the Modify Text window.
  7. 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":
    1. Press and hold the CTRL key, and then select of and Page Count.
    2. Click Remove.
    3. Type for in the Text field and click Add.
    4. 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.
  8. 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.
    You see the Character Set Description and Font Resource fields change for the font you selected. Font Resource is "Outline" for core fonts and "Raster" for external fonts.
      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.
  9. 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.
  10. Click OK.
    You see the edited text.
  11. 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.4.1.9.4.5 Modifying content images

You can modify the images you have defined for white space content.
    Note:
  • In AFP Visual Environment you can display measurement units in inches or millimeters. To change the measurement unit, click View ⇒ Units.
To modify images you have defined in content:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. Select a rule from the list in the top pane of the window.
  5. Select image content from the drop-down list.
  6. Click Edit in the Content section.
    You see the Modify Image window.
  7. 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.
  8. 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.
  9. Click OK.
  10. 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.4.1.9.4.6 Creating rule conditions for content

You can create rule conditions that determine when content is assigned to white space.
To create a rule condition:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. 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.
  5. Click Create in the Conditions section.
    You see the Create Condition window.
  6. Use the drop-down list to select an index tag in the Index tags field.
  7. Use the drop-down list to select one of these in the Operator field:
    • greater than
    • less than
    • equals
    • contains
  8. Type a value in the Value field.
  9. Click OK.
    The condition you created is added to the rule.
  10. 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.
  11. 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.
  12. Click OK.

1.4.1.9.4.7 Modifying rule conditions for content

You can modify rule conditions that determine when content is assigned to white space.
To modify a rule condition:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. Select an existing rule from the list in the top pane of the window.
  5. Click Edit in the Conditions section.
    You see the Edit Condition window.
  6. Optional: Use the drop-down list to change the index tag in the Index tags field.
  7. Optional: Use the drop-down list to change to one of these in the Operator field:
    • greater than
    • less than
    • equals
    • contains
  8. Optional: Change the value in the Value field.
  9. Click OK.
    The condition you edited is modified in the rule.
  10. 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.
  11. Click OK.

1.4.1.9.4.8 Deleting content from white space

You can delete rules, conditions, and content that you have assigned to white space definitions.
To delete rules, conditions, or content:
  1. In AFP Visual Environment, open a sample AFP file and the control file that contains the white space definitions.
  2. Click Mode ⇒ Whitespace Manager.
  3. Click Tools ⇒ Manage Campaigns.
    You see the Manage Campaigns window.
  4. Select a rule from the list in the top pane of the window.
  5. Optional: To delete conditions:
    1. Select a condition from the drop-down list.
    2. Click Delete in the Conditions section.
      You see that the condition has been removed from the rule.
    3. Repeat the steps to delete another condition in the rule.
      If you delete all the conditions, the rule defaults to Always.
  6. Optional: To delete content:
    1. Select content from the drop-down list.
    2. Click Delete in the Content section.
      You see that the content has been removed from the rule.
    3. Repeat the steps to delete more content from the rule.
  7. 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.
  8. Optional: To delete another rule or the conditions or content for a rule, go to Step 4 and repeat the steps.
  9. Click OK.

1.4.1.10 Enhancing production AFP files

After you enhance a sample AFP file, run an AFP Visual Environment command to enhance production AFP files in the same way.

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.4.1.10.1 Sending AFP Visual Environment files to the production system

If the production AFP files are on a different system from the preparation system, send the AFP Visual Environment control file and other optional AFP Visual Environment files to the production system.
To send AFP Visual Environment files to the production system:
  1. On the preparation system, use the File Transfer Protocol (ftp) to send the AFP Visual Environment control files to the production system. Use the ftpbinary option.
  2. 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 the ftpbinary option.
  3. Optional: If you created IMB serial number files, use ftp to send the serial number files to the production system. Use the ftpbinary option.

1.4.1.10.2 Creating page groups and indexes in production AFP files

The IndexAFP command creates page groups and index tags in production AFP files. It uses the AFP Visual Environment control file that contains the definitions for the page groups and index tags.

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.

You can configure InfoPrint Manager to automatically run IndexAFP or PluginMgr before printing.

To create page groups and indexes in production AFP files:
  1. 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
    • 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
    For install_directory, use the directory where you installed AFP Visual Environment.

    For directory, use the directory where the file is located.

  2. If the return code from IndexAFP or PluginMgr is <0, look in stderr or the log for error messages.
  3. Repeat the command for each production AFP file.

1.4.1.10.3 Creating hidden areas, bar codes, and text masks in production AFP files

The EditAFP command hides areas, creates bar codes, and masks text in production AFP files. It uses the AFP Visual Environment control file that contains definitions for the hidden areas, bar codes, and text masks.

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.

You can configure InfoPrint Manager to automatically run EditAFP or PluginMgr before printing.

To create hidden areas and bar codes in production AFP files:
  1. 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 the ftpbinary option.
  2. 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
    • 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
    For install_directory, use the directory where you installed AFP Visual Environment.

    For directory, use the directory where the file is located.

  3. If the return code from EditAFP or PluginMgr is <0, look in stderr or the log for error messages.
  4. Run the command again for each production AFP file.

1.4.1.11 AFP Visual Environment commands

AFP Visual Environment commands apply the definitions in an AFP Visual Environment control file to production AFP files. These commands can run on IBM AIX, IBM z/OS, and Microsoft Windows systems.

1.4.1.11.1 EditAFP command

EditAFP hides areas, creates bar codes, and masks text in a production AFP file and writes the output to another file. The bar codes, hidden areas, and text masks must be defined in an AFP Visual Environment control file. This command is available only if AFP Editor is installed.
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]
Note: Brackets indicate that the option is not required. Do not type any brackets when you enter the command.
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 the EditAFP.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 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

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

z/OS system: This example creates the hidden areas and bar codes defined in control file directory/infile.ctl and 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;

z/OS system: This example creates the hidden areas and IMBs defined in control file /directory/infile.ctl and 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/toserial and /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.4.1.11.2 IndexAFP command

IndexAFP creates page groups and index tags in a production AFP file and writes the output to another file. The page groups and index tags must be defined in an AFP Visual Environment control file. This command is available only if AFP Indexer is installed.
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.4.1.11.3 PluginMgr command

PluginMgr can run both the EditAFP and IndexAFP commands and write the output to an AFP file. Or, PluginMgr can run only the command that you specify.

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 ]
Note: Brackets indicate that the option is not required. Do not type any brackets when you enter the command.
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.4.1.12 Configuration files

AFP Visual Environment configuration files let you customize font-mapping and specify the starting serial number for Intelligent Mail bar codes (IMBs).

1.4.1.12.1 Font mapping files

AFP Visual Environment lets you customize installation font-mapping files to map custom AFP fonts to Java fonts. In the font-mapping files, you can also specify the default Java font that is used when an AFP font is not mapped to a Java font.

AFP Visual Environment provides sample installation font-mapping files that you can edit.

1.4.1.12.1.1 CharacterSets.properties file

The 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
The CharacterSets.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. If DEFAULT 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, or Lucida 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, and PLAIN.
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.4.1.12.1.2 CodedFonts.properties file

The 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
The CodedFonts.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,codepage
For 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. If DEFAULT 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.4.1.12.1.3 CodePages.properties file

The 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
The CodePages.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,SBCS
or
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.4.1.12.1.4 SampleCodePointMap.cp file

The 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
The SampleCodePointMap.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 0040 to code point 0020.

For charts showing Unicode code points, see http://unicode.org/charts/.

Format
Each line in the file has this format:
AFPcodepoint=Unicodecodepoint
For 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.4.1.12.2 IMB serial number file

The Intelligent Mail barcode (IMB) serial number file contains the serial number that you want AFP Editor to encode in the first IMB that it creates in an AFP 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 number
For 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.4.1.12.3 Document index file

The document index file contains the index tags that are in an AFP file. AFP Visual Environment can create this file when it processes a production AFP 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.4.1.12.4 Resource group file

The resource group file contains all the resources that an AFP file references and that AFP Visual Environment found inline or in an AFP resource directory. AFP Visual Environment can create this file when it processes a production AFP 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.4.1.13 Accessibility

Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, use information technology products successfully.

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

  • Line2PDF Plus User's Guide PDF HTML

  • Release Notes for Line2PDF Plus 1.5 PDF

1.5.1 Line2PDF Plus 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 RICOH Transforms Suite

This section provides a list of all the publications for RICOH Transforms Suite.

Instruction manuals

  • AFP2PDF PLUS

    For information about AFP2PDF PLUS, see these documents:

    • AFP2PDF Plus User Guide
    • AFP2PDF Plus Quick Start Guide
    • AFP2PDF Plus Setup Guide
    • AFP2PDF Plus Release Notes
    • AFP2PDF Plus - Summary of Updates
    • AFP2PDF Plus Config UI User Guide
  • AFP Visual Environment

    For information about AFP Visual Environment, see these documents:

    • AFP Visual Environment User Guide
    • AFP Visual Environment Release Notes
  • AFPMerge

    For information about AFPMerge, see these documents:

    • AFPMerge User Guide
    • AFPMerge Release Notes
  • Line2PDF Plus

    For information about Line2PDF Plus, see these documents:

    • Line2PDF Plus User’s Guide
    • Line2PDF Plus Release Notes
  • PCL2PDF

    For information about PCL2PDF, see these documents:

    • PCL2PDF User’s Guide
    • PCL2PDF Release Notes
  • PS2PDF

    For information about PS2PDF, see these documents:

    • PS2PDF User’s Guide
    • PS2PDF Release Notes
  • TIFF2PDF Plus

    For information about TIFF2PDF Plus, see these documents:

    • TIFF2PDF Plus User Guide
    • TIFF2PDF Plus Release Notes

1.5.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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

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
PDF
Portable Document Format
TRC
Table Reference Character

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
  • z/OS

Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe 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.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

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 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:

  • 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.5.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.5.1.2.2 Requirements

Transform client requirements:
IBM AIX 7.2 or later
IBM z/OS UNIX System Services V1.13 or later
Microsoft Windows 10 Pro, Enterprise
Microsoft Windows 11 Pro
Microsoft Windows Server 2016 Standard
Microsoft Windows Server 2019 Standard
Microsoft Windows Server 2022 Standard
Linux Kernel 2.6.18 or later (x86)
Linux Kernel 2.6.09 or later (IBM System z)
Transform server requirements:
JAVA 64bit V1.8 or later
End-user client requirements:
Adobe Acrobat, Acrobat Reader, or Acrobat Plug-In 9.0 or later
When you install Line2PDF Plus you must have administrative rights.

1.5.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.
  • Running Line2PDF Plus using IBM Semeru Java on Windows and Linux is not supported.
  • Although the Line2PDF Plus program runs with Java 21 or later, the installer does not run with Java 21 or later. Use a Java version earlier than Java 21 to install Line2PDF Plus.

1.5.1.3 Installing the Line2PDF Plus Transform

1.5.1.3.1 Installing Line2PDF Plus using the installer

The Line2PDF Plus transforms can now be installed using an executable jar file.

To run the installer, perform these steps:

  • Use the following command: java -jar RTS--setupLine2pdfPlus-1.X.X--line2pdfplus.jar, where 1.X.X is the transform version.
      Note:
    • To install the Line2PDF Plus transform, you need 64 bit Java 1.8 or later and administrative rights.
    • On some Java versions, due to a bug, the above java -jar command might not start the installer. Use this additional parameter: java -Djdk.util.zip.disableZip64ExtraFieldValidation=true -jar RTS--setupLine2pdfPlus-1.X.X--line2pdfplus.jar.
  • Depending on the capabilities of your operating system, the Line2PDF Plus transform installer opens either using a graphical user interface or a command line.
  • On non-Windows operating environments the installer uses the /tmp directory to unpack files and run certain scripts. If there are limitations on the /tmp folder of the system, such as non-exec flag or limited space, a different temporary file directory can be specified using the -Dlax.nl.env.iatempdir= parameter. Example: java -Dlax.nl.env.iatempdir=/custom_temp_dir/ -jar RTS--setupLine2pdfPlus-1.X.X--line2pdfplus.jar.
  • Follow the installation steps of the installer. During the installation process, you must specify the installation location.

1.5.1.3.2 Installing a Permanent License

To continue using Line2PDF Plus after the trial license expires, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for Line2PDF Plus:
  1. Run the license management tool Line2PdfPlusLicenseManager.jar located in the license_installer folder where Line2PDF Plus is installed, and follow the installation steps.
  2. When prompted You can either install a new license or revoke the currently installed one., select Install License - Upload and apply a new license file.
  3. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  4. If the computer where Line2PDF Plus is installed does not have Internet access:
    1. Do not close the license application on the computer where Line2PDF Plus is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where Line2PDF Plus is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  5. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  6. Click Software Activation on the right side of the screen.
  7. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management tool on the computer where Line2PDF Plus is installed. Copy your machine fingerprint field. This action copies the 16-character system fingerprint that uniquely identifies the computer where Line2PDF Plus is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  8. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  9. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  10. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  11. If you are finished, close the browser tab. To restart the process, click Start Over.
  12. If you accessed the Internet from a different computer than the one where Line2PDF Plus is installed, copy the license file to the computer where Line2PDF Plus is installed.
  13. Run the license management tool on the system where Line2PDF Plus is installed, follow the installation steps and select Install License - Upload and apply a new license file. ⇒ Install.
  14. After the license management tool displays your machine fingerprint, click Next.
  15. Locate the license file and click Open.
  16. Select Next.
  17. Review the installation summary and click Install.
    You see a message that the license was installed successfully.
  18. You can start using the Line2PDF transform.

1.5.1.3.3 Revoking the License Key

The Self-service License Key Revoke System (SSR) is designed to permit Ricoh customers a method to move license keys between systems and recover from system failures. If you must revoke more than 2 keys from the same EID, contact your local Ricoh Support team for assistance.
To revoke the license key:
  1. Run the license management tool Line2PdfPlusLicenseManager.jar located in the license_installer folder where Line2Pdf Plus is installed, and follow the installation steps.
  2. Select the path where your transform is installed.
  3. Then, select Revoke License - Remove the current license file from the system. and click Install.
  4. Select the location that you want to use for your current license, then click Next.
  5. You are instructed to visit https://dl.ricohsoftware.com/?revoke to revoke your license.
  6. Click the Self-Service Revoke button.
  7. Select one of the 3 available revoke methods from the Revoke By list:
    Entitlement ID (EID)
    The EID that you must revoke for the software reporting a license violation condition.
    Activation ID (AID)
    The AID is necessary when you only must revoke a single set of keys for 1 EID. For example, if you accidentally activated using the wrong system fingerprint and have the AID string available.
    License Key File Upload (license.key file)
    Best general-purpose option for resetting all EIDs installed for a specific product on a given server. You can select a license.key file.
  8. Depending on your selection from the Revoke By list, enter the EID, AID, or upload the key file in the Enter your EID, Enter your AID, or Upload Your License File (Max file size, 150 KB) fields.
  9. Enter your company name in the Company Name field. Make sure to use the same the company name used in the original EID email.
  10. To receive the revoke details, enter your valid business email address in the Business Email Address field.
  11. Click Submit.
    After 30 seconds, you receive a notification on the website. If your request could not be approved automatically and requires review, you receive an email from the reviewer within the next few business days.
      Note:
    • Depending on the network speed or processing time, it may last up to 90 seconds until you receive the notification.
  12. Return to the license management application and click Next.
  13. Review the summary and click Install.
    You will see a message that the license was successfully revoked.
  14. Click Done.

1.5.1.4 Running Java Version of Line2PDF Plus

To run Java on Line2PDF Plus use one of these options:

  • Java command line.
  • Client/Server Model.

1.5.1.4.1 Java Command Line

To transform a Line data into a PDF, run this command:

  • For Windows:
    line2pdf.bat [options] input-file output-file
  • For other operating systems:
    line2pdf.sh [options] input-file output-file

1.5.1.4.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.5.1.4.1.2 Java Line2PDF Plus Command Options

Command line syntax
line2pdf.bat [options] input-file output-file
line2pdf.sh [options] input-file output-file

For example:

  • For Windows: line2pdf.bat c:\linedata.txt c:\linedata.pdf
  • For other operating systems: line2pdf.sh /linedata.txt /linedata.pdf

or
line2pdf.bat [options] output-file < input-file 
line2pdf.sh [options] output-file < input-file 

For example:

  • For Windows: line2pdf.bat c:\linedata.pdf < c:\linedata.txt
  • For other operating systems: line2pdf.sh /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
—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 ]

  1. If nnn=0 (default), new line characters is applied as line break.
  2. If nnn>0, each line has nnn chars or bytes. Default value is specified in chars.

    For example:

    —1 80,char
    —1 80,byte

  3. 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.
—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.5.1.4.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

  1. To start Line2PdfServer set these values:
    Client port:
    Default 8500.
    RMI port:
    Default 8501.
  2. Enter the command line: java Line2PdfServer —start.
  3. To stop Line2PdfServer enter: java Line2PdfServer —stop.

Example 2

  1. To start Line2Pdf Server set these values:
    Client port: 7200.
    RMI port: 7201.
    Tempdir: /mydir/tmp.
  2. Enter the command line: java Line2PdfServer —start —p 7200 —r 7201 —t /mydir/tmp.
  3. To stop Line2PdfServer enter: java Line2PdfServer —stop —p 7200.

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

  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.
  2. Enter the command line: java Line2PdfAgent —s server1.
  3. To stop Line2PdfAgent enter: java Line2PdfAgent —stop.

Example 2

  1. To start Line2PdfAgent set these values:
    Client port: 9500.
    For C/C++ client.
    Remote host where Line2PdfServer is running: server1.
    RMI port: 7201.
  2. Enter the command line: java Line2PdfAgent —p 9500 —s server1—sp 7201.
  3. To stop Line2PdfAgent enter: java Line2PdfAgent —p 9500 —stop.

1.5.1.5 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.5.1.5.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.5.1.5.2 Client and Server on the Same Machine

  1. Client sends the command line arguments to server through socket communication.
  2. 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.5.1.5.3 Client and Server on Different Machines

The Client/Server Model with Client and Server on different machines requires that the agent Line2PdfAgent is based on the client machine.

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.5.1.5.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.6 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.

  • PCL2PDF User's Guide PDF HTML

  • Release Notes for PCL2PDF 1.5 PDF

1.6.1 PCL2PDF 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 RICOH Transforms Suite

This section provides a list of all the publications for RICOH Transforms Suite.

Instruction manuals

  • AFP2PDF PLUS

    For information about AFP2PDF PLUS, see these documents:

    • AFP2PDF Plus User Guide
    • AFP2PDF Plus Quick Start Guide
    • AFP2PDF Plus Setup Guide
    • AFP2PDF Plus Release Notes
    • AFP2PDF Plus - Summary of Updates
    • AFP2PDF Plus Config UI User Guide
  • AFP Visual Environment

    For information about AFP Visual Environment, see these documents:

    • AFP Visual Environment User Guide
    • AFP Visual Environment Release Notes
  • AFPMerge

    For information about AFPMerge, see these documents:

    • AFPMerge User Guide
    • AFPMerge Release Notes
  • Line2PDF Plus

    For information about Line2PDF Plus, see these documents:

    • Line2PDF Plus User’s Guide
    • Line2PDF Plus Release Notes
  • PCL2PDF

    For information about PCL2PDF, see these documents:

    • PCL2PDF User’s Guide
    • PCL2PDF Release Notes
  • PS2PDF

    For information about PS2PDF, see these documents:

    • PS2PDF User’s Guide
    • PS2PDF Release Notes
  • TIFF2PDF Plus

    For information about TIFF2PDF Plus, see these documents:

    • TIFF2PDF Plus User Guide
    • TIFF2PDF Plus Release Notes

1.6.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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

PDF
Portable Document Format
PCL
Printer Command Language

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

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

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 PCL2PDF transform converts Printer Command Language PCL5e, PCL5c and PCL XL data stream files into Adobe Acrobat Portable Document Format (PDF) files.

1.6.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, Linux 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.6.1.2.2 Requirements

Transform client requirements:

  • Microsoft Windows Server 2016 Standard or later
  • Microsoft Windows 10 Pro, Enterprise or later
  • IBM AIX 7.2 or later
  • Linux kernel 2.6.32 or later (x86_64)

End-user client requirements:

  • Adobe Acrobat
  • Acrobat Reader

1.6.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.6.1.3 Installing the PCL2PDF Transform

This procedure steps through an installation of the PCL2PDF transform on AIX, Linux, and Windows using the installer.
The PCL2PDF transform can be installed using an executable file on Windows operating systems and a bin file for AIX and Linux operating systems downloaded from https://dl.ricohsoftware.com.

Depending on the capabilities of your operating system, PCL2PDF transform installer opens either using a graphical user interface or a command line.

The PCL2PDF installer automatically installs a 60-day trial license. The trial license key is installed in the installation directory. The default installation directory is /opt/RICOH/pcl2pdf for AIX and Linux and C:\Program Files\RICOH\RICOH PCL2PDF Transform for Windows.

Use these procedures to install PCL2PDF:

For AIX:

  1. Log into the AIX system as root.
  2. Copy the RTS--setupPcl2pdf-1.X.X--pcl2pdf.AIX.bin installation file, where 1.X.X is the transform version, to a temporary directory of your choice. For example, you can use the /tmp directory.
  3. Go to the folder where you downloaded the installation file. Open a command line and type:
     cd /tmp
  4. To list the files contained in the directory, type:
    ls
  5. To start the installation process, type:
    ./RTS--setupPcl2pdf-1.X.X--pcl2pdf.AIX.bin
    where 1.X.X is the transform version.
      Important:
    • Make sure that you have permission to execute the file.
  6. Follow the instructions in the installer.
  7. Review and accept the license agreement.
  8. Select the installation folder. The default installation folder is: /opt/RICOH/pcl2pdf
  9. Click Next to review the settings.
  10. Click Install.

For Linux:

  1. Log into the Linux system as root.
  2. Copy the RTS--setupPcl2pdf-1.X.X--pcl2pdf.Linux.bin installation file, where 1.X.X is the transform version, to a temporary directory of your choice. For example, you can use the /tmp directory.
  3. Go to the folder where you downloaded the installation file. Open a command line and type:
     cd /tmp
  4. To list the files contained in the directory, type:
    ls
  5. To start the installation process, type:
    ./RTS--setupPcl2pdf-1.X.X--pcl2pdf.Linux.bin
    where 1.X.X is the transform version.
      Important:
    • Make sure that you have permission to execute the file.
  6. Follow the instructions in the installer.
  7. Review and accept the license agreement.
  8. Select the installation folder. The default installation folder is: /opt/RICOH/pcl2pdf
  9. Click Next to review the settings.
  10. Click Install.

For Windows:

  1. Log in to the Windows system as administrator.
  2. Copy the RTS--setupPcl2pdf-1.X.X--pcl2pdf.Windows.exe installation file, where 1.X.X is the transform version, to a directory of your choice.
  3. Double-click the RTS--setupPcl2pdf-1.X.X--pcl2pdf.Windows.exe installation file to start the installation process.
  4. Follow the instructions in the installer.
  5. Review and accept the license agreement.
  6. Select the installation folder. The default installation folder is: C:\Program Files\RICOH\RICOH PCL2PDF Transform.
  7. Click Next to review the settings.
  8. Click Install.

1.6.1.4 Installing a Permanent License

To use PCL2PDF transform you need a license. You must install a permanent license on the computer where the product is installed.
To install a permanent license for PCL2PDF:
  1. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  2. If the computer where PCL2PDF is installed does not have Internet access:
    1. Log into a computer that has Internet access.
    2. Use the Remote Desktop Connection to connect to the computer where PCL2PDF is installed.
  3. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  4. Click Software Activation on the right side of the screen.
  5. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. To obtain your machine fingerprint open a command prompt and run the command pcl2pdf -f. Copy your machine fingerprint. This action copies the 16-character system fingerprint that uniquely identifies the computer where PCL2PDF is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  6. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  7. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  8. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  9. If you are finished, close the browser tab. To restart the process, click Start Over.
  10. Copy the license file in the same location where PCL2PDF transform is installed.
  11. You can start using the PCL2PDF transform.

1.6.1.5 Using the PCL2PDF Transform

The PCL2PDF transform consists of a command-line interface and multiple configurable parameters.

1.6.1.5.1 Command syntax

The syntax for the pcl2pdf client command is::

pcl2pdf [-a perms][-f] [-o password] [-u password] [-p size] input_fn [output_fn]

1.6.1.5.2 Parameters

The following parameters are required:

-aperms
Encryption permissions pcsa (p: no printing, c: no changes, s: no selection, a: no adding notations).
  • This parameter is used only with the -o parameter; otherwise, -a permissions are not applied.
-d<value>
When processing images in the input stream, the Autofilter mechanism selects the compression used for them in the output PDF. In the majority of cases, it will choose a lossy compression (DCT) to favor a smaller output size. If the quality of the images in the output stream is not acceptable, this flag can disable the Autofilter for specific image types.
Set the <value> to 1 to disable Autofilter for grayscale images.
Set the <value> to 2 to disable Autofilter for color images.
Set the <value> to 3 to disable Autofilter for both grayscale and color images.
-f
Get system fingerprint for license activation.
-opassword
Encryption PDF Owner Password.
-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 17in x 11in
    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
-upassword
Encryption PDF User Password.
    Note:
  • -a permissions are not relevant, unless you specify -o.

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

  • PS2PDF User's Guide PDF HTML

  • Release Notes for PS2PDF 1.5 PDF

1.7.1 PS2PDF 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 RICOH Transforms Suite

This section provides a list of all the publications for RICOH Transforms Suite.

Instruction manuals

  • AFP2PDF PLUS

    For information about AFP2PDF PLUS, see these documents:

    • AFP2PDF Plus User Guide
    • AFP2PDF Plus Quick Start Guide
    • AFP2PDF Plus Setup Guide
    • AFP2PDF Plus Release Notes
    • AFP2PDF Plus - Summary of Updates
    • AFP2PDF Plus Config UI User Guide
  • AFP Visual Environment

    For information about AFP Visual Environment, see these documents:

    • AFP Visual Environment User Guide
    • AFP Visual Environment Release Notes
  • AFPMerge

    For information about AFPMerge, see these documents:

    • AFPMerge User Guide
    • AFPMerge Release Notes
  • Line2PDF Plus

    For information about Line2PDF Plus, see these documents:

    • Line2PDF Plus User’s Guide
    • Line2PDF Plus Release Notes
  • PCL2PDF

    For information about PCL2PDF, see these documents:

    • PCL2PDF User’s Guide
    • PCL2PDF Release Notes
  • PS2PDF

    For information about PS2PDF, see these documents:

    • PS2PDF User’s Guide
    • PS2PDF Release Notes
  • TIFF2PDF Plus

    For information about TIFF2PDF Plus, see these documents:

    • TIFF2PDF Plus User Guide
    • TIFF2PDF Plus Release Notes

1.7.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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

EPS
Encapsulated Postscript
PDF
Portable Document Format
PS
PostScript

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
  • IBM

Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe 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.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

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.7.1.2 Overview

The PS2PDF transform converts PostScript and Encapsulated Postscript(EPS) files into Adobe Acrobat Portable Document Format (PDF) files.

1.7.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, Linux 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.7.1.2.2 Requirements

Transform client requirements:

  • Microsoft Windows Server 2016 Standard or later
  • Microsoft Windows 10 Pro, Enterprise or later
  • IBM AIX 7.2 or later
  • Linux kernel 2.6.32 or later (x86_64)

End-user client requirements:

  • Adobe Acrobat
  • Acrobat Reader

1.7.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.7.1.3 Installing the PS2PDF Transform

This procedure steps through an installation of the PS2PDF transform on AIX, Linux, and Windows using the installer.
The PS2PDF transform can be installed using an executable file on Windows operating systems and a bin file for AIX and Linux operating systems downloaded from https://dl.ricohsoftware.com.

Depending on the capabilities of your operating system, PS2PDF transform installer opens either using a graphical user interface or a command line.

The PS2PDF installer automatically installs a 60-day trial license. The trial license key is installed in the installation directory. The default installation directory is /opt/RICOH/ps2pdf for AIX and Linux and C:\Program Files\RICOH\RICOH PS2PDF Transform for Windows.

Use these procedures to install PS2PDF:

For AIX:

  1. Log into the AIX system as root.
  2. Copy the RTS--setupPs2pdf-1.X.X--ps2pdf.AIX.bin installation file, where 1.X.X is the transform version, to a temporary directory of your choice. For example, you can use the /tmp directory.
  3. Go to the folder where you downloaded the installation file. Open a command line and type:
     cd /tmp
  4. To list the files contained in the directory, type:
    ls
  5. To start the installation process, type:
    ./RTS--setupPs2pdf-1.X.X--ps2pdf.AIX.bin
    where 1.X.X is the transform version.
      Important:
    • Make sure that you have permission to execute the file.
  6. Follow the instructions in the installer.
  7. Review and accept the license agreement.
  8. Select the installation folder. The default installation folder is: /opt/RICOH/ps2pdf
  9. Click Next to review the settings.
  10. Click Install.

For Linux:

  1. Log into the Linux system as root.
  2. Copy the RTS--setupPs2pdf-1.X.X--ps2pdf.Linux.bin installation file, where 1.X.X is the transform version, to a temporary directory of your choice. For example, you can use the /tmp directory.
  3. Go to the folder where you downloaded the installation file. Open a command line and type:
     cd /tmp
  4. To list the files contained in the directory, type:
    ls
  5. To start the installation process, type:
    ./RTS--setupPs2pdf-1.X.X--ps2pdf.Linux.bin
    where 1.X.X is the transform version.
      Important:
    • Make sure that you have permission to execute the file.
  6. Follow the instructions in the installer.
  7. Review and accept the license agreement.
  8. Select the installation folder. The default installation folder is: /opt/RICOH/ps2pdf
  9. Click Next to review the settings.
  10. Click Install.

For Windows:

  1. Log in to the Windows system as administrator.
  2. Copy the RTS--setupPs2pdf-1.X.X--ps2pdf.Windows.exe installation file, where 1.X.X is the transform version, to a directory of your choice.
  3. Double-click the RTS--setupPs2pdf-1.X.X--ps2pdf.Windows.exe installation file to start the installation process.
  4. Follow the instructions in the installer.
  5. Review and accept the license agreement.
  6. Select the installation folder. The default installation folder is: C:\Program Files\RICOH\RICOH PS2PDF Transform.
  7. Click Next to review the settings.
  8. Click Install.

1.7.1.4 Installing a Permanent License

To use PS2PDF you need a license. You must install a permanent license on the computer where the product is installed.
To install a permanent license for PS2PDF:
  1. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  2. If the computer where PS2PDF is installed does not have Internet access:
    1. Log into a computer that has Internet access.
    2. Use the Remote Desktop Connection to connect to the computer where PS2PDF is installed.
  3. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  4. Click Software Activation on the right side of the screen.
  5. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. To obtain your machine fingerprint open a command prompt and run the command ps2pdf -f. Copy your machine fingerprint. This action copies the 16-character system fingerprint that uniquely identifies the computer where PS2PDF is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  6. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  7. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  8. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  9. If you are finished, close the browser tab. To restart the process, click Start Over.
  10. Copy the license file in the same location where PS2PDF is installed.
  11. You can start using the PS2PDF transform.

1.7.1.5 Using the PS2PDF Transform

The PS2PDF transform consists of a command-line interface and multiple configurable parameters.

1.7.1.5.1 Command syntax

The syntax for the ps2pdf client command is::

ps2pdf.exe <-a perms> <-f> <-l> <-o pw> <-p size> <-u pw>input_fn <output_fn>  

1.7.1.5.2 Parameters

The following parameters are required:

-aperms
Encryption permissions pcsa (p: no printing, c: no changes, s: no selection, a: no adding notations).
  • This parameter is used only with the -o parameter; otherwise, -a permissions are not applied.
-d<value>
When processing images in the input stream, the Autofilter mechanism selects the compression used for them in the output PDF. In the majority of cases, it will choose a lossy compression (DCT) to favor a smaller output size. If the quality of the images in the output stream is not acceptable, this flag can disable the Autofilter for specific image types.
Set the <value> to 1 to disable Autofilter for grayscale images.
Set the <value> to 2 to disable Autofilter for color images.
Set the <value> to 3 to disable Autofilter for both grayscale and color images.
-f
Get system fingerprint for license activation.
-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.
-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
-upassword
Encryption PDF User Password.
    Note:
  • -a permissions are not relevant, unless you specify -o.

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

  • Tiff2PDF Plus User's Guide PDF HTML

  • Release Notes for Tiff2PDF Plus 1.5 PDF

1.8.1 TIFF2PDF Plus User Guide

1.8.1.1 Introduction

1.8.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.8.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.8.1.1.3 Publications for RICOH Transforms Suite

This section provides a list of all the publications for RICOH Transforms Suite.

Instruction manuals

  • AFP2PDF PLUS

    For information about AFP2PDF PLUS, see these documents:

    • AFP2PDF Plus User Guide
    • AFP2PDF Plus Quick Start Guide
    • AFP2PDF Plus Setup Guide
    • AFP2PDF Plus Release Notes
    • AFP2PDF Plus - Summary of Updates
    • AFP2PDF Plus Config UI User Guide
  • AFP Visual Environment

    For information about AFP Visual Environment, see these documents:

    • AFP Visual Environment User Guide
    • AFP Visual Environment Release Notes
  • AFPMerge

    For information about AFPMerge, see these documents:

    • AFPMerge User Guide
    • AFPMerge Release Notes
  • Line2PDF Plus

    For information about Line2PDF Plus, see these documents:

    • Line2PDF Plus User’s Guide
    • Line2PDF Plus Release Notes
  • PCL2PDF

    For information about PCL2PDF, see these documents:

    • PCL2PDF User’s Guide
    • PCL2PDF Release Notes
  • PS2PDF

    For information about PS2PDF, see these documents:

    • PS2PDF User’s Guide
    • PS2PDF Release Notes
  • TIFF2PDF Plus

    For information about TIFF2PDF Plus, see these documents:

    • TIFF2PDF Plus User Guide
    • TIFF2PDF Plus Release Notes

1.8.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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.8.1.1.5 Abbreviations

PDF
Portable Document Format
RMI
Remote Method Invocation
TIFF
Tagged Image File Format

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

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

UNIX is a registered trademark of The Open Group in the United States and other countries.

1.8.1.2 Overview

1.8.1.2.1 Description

Tiff2PDF Plus converts both single and multi- page TIFF files in Adobe Acrobat Portable Document Format (PDF) files.

1.8.1.2.2 Specifications

    Important:
  • Although the TIFF2PDF Plus program runs with Java 21 or later, the installer does not run with Java 21 or later. Use a Java version earlier than Java 21 to install TIFF2PDF Plus.

Supported Platforms
IBM AIX 7.2 or later
IBM z/OS UNIX System Services V1.13 or later
Microsoft® Windows 10 Pro, Enterprise
Microsoft Windows 11 Pro
Microsoft Windows® Server 2016 Standard
Microsoft Windows Server 2019 Standard
Microsoft Windows Server 2022 Standard
Linux® Kernel 2.6.18 or later (x86)
Linux Kernel 2.6.09 or later (IBM System z)
Transform server requirements:
Java 64bit V 1.8 or later
Client Software Requirements
Java 64bit V 1.8 or later
Language Support
Single Byte Character Sets
Double Byte Character Sets: Simplified and Traditional
Chinese, Japanese and Korean

1.8.1.3 Installing the TIFF2PDF Plus Transform

1.8.1.3.1 Installing TIFF2PDF Plus using the installer

The TIFF2PDF Plus transforms can now be installed using an executable jar.

To run the installer, perform these steps:

  • Use the following command: java -jar RTS--setupTiff2pdfPlus-1.X.X--tiff2pdfplus.jar, where 1.X.X is the transform version.
      Note:
    • To install the TIFF2PDF Plus transforms, you need 64 bit Java 1.8 or later and Administrative rights.
    • On some Java versions, due to a bug, the above java -jar command might not start the installer. Use this additional parameter: java -Djdk.util.zip.disableZip64ExtraFieldValidation=true -jar RTS--setupTiff2pdfPlus-1.X.X--tiff2pdfplus.jar.
  • On non-Windows operating environments the installer uses the /tmp directory to unpack files and run certain scripts. If there are limitations on the /tmp folder of the system, such as non-exec flag or limited space, a different temporary file directory can be specified using the -Dlax.nl.env.iatempdir= parameter. Example: java -Dlax.nl.env.iatempdir=/custom_temp_dir/ -jar RTS--setupTiff2pdfPlus-1.X.X--tiff2pdfplus.jar.
  • Depending on the capabilities of your operating system, TIFF2PDF Plus transform installer opens either using a graphical user interface or a command line.
  • Follow the installation steps of the installer. During the installation process, you must specify the installation location.

1.8.1.3.2 Installing a Permanent License

To continue using TIFF2PDF Plus after the trial license expires, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for TIFF2PDF Plus:
  1. Run the license management tool Tiff2PdfPlusLicenseManager.jar located in the license_installer folder where TIFF2PDF Plus is installed, and follow the installation steps.
  2. When prompted You can either install a new license or revoke the currently installed one., select Install License - Upload and apply a new license file.
  3. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  4. If the computer where TIFF2PDF Plus is installed does not have Internet access:
    1. Do not close the license application on the computer where TIFF2PDF Plus is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where TIFF2PDF Plus is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  5. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  6. Click Software Activation on the right side of the screen.
  7. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management application on the computer where TIFF2PDF Plus is installed. Copy your machine fingerprint field. This action copies the 16-character system fingerprint that uniquely identifies the computer where TIFF2PDF Plus is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  8. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  9. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  10. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  11. If you are finished, close the browser tab. To restart the process, click Start Over.
  12. If you accessed the Internet from a different computer than the one where TIFF2PDF Plus is installed, copy the license file to the computer where TIFF2PDF Plus is installed.
  13. Run the license management tool on the system where TIFF2PDF Plus is installed, follow the installation steps and select Install License - Upload and apply a new license file. ⇒ Install
  14. After the license management tool displays your machine fingerprint, click Next.
  15. Locate the license file and click Open.
  16. Select Next.
  17. Review the installation summary and click Install.
    You see a message that the license was installed successfully.
  18. You can start using the TIFF2PDF Plus transform.

1.8.1.3.3 Revoking the License Key

The Self-service License Key Revoke System (SSR) is designed to permit Ricoh customers a method to move license keys between systems and recover from system failures. If you must revoke more than 2 keys from the same EID, contact your local Ricoh Support team for assistance.
To revoke the license key:
  1. Run the license management tool Tiff2PdfPlusLicenseManager.jar located in the license_installer folder where TIFF2PDF Plus is installed, and follow the installation steps.
  2. Select the path where your transform is installed.
  3. Then, select Revoke License - Remove the current license file from the system. and click Install.
  4. Select the location that you want to use for your current license, then click Next.
  5. You are instructed to visit https://dl.ricohsoftware.com/?revoke to revoke your license.
  6. Click the Self-Service Revoke button.
  7. Select one of the 3 available revoke methods from the Revoke By list:
    Entitlement ID (EID)
    The EID that you must revoke for the software reporting a license violation condition.
    Activation ID (AID)
    The AID is necessary when you only must revoke a single set of keys for 1 EID. For example, if you accidentally activated using the wrong system fingerprint and have the AID string available.
    License Key File Upload (license.key file)
    Best general-purpose option for resetting all EIDs installed for a specific product on a given server. You can select a license.key file.
  8. Depending on your selection from the Revoke By list, enter the EID, AID, or upload the key file in the Enter your EID, Enter your AID, or Upload Your License File (Max file size, 150 KB) fields.
  9. Enter your company name in the Company Name field. Make sure to use the same the company name used in the original EID email.
  10. To receive the revoke details, enter your valid business email address in the Business Email Address field.
  11. Click Submit.
    After 30 seconds, you receive a notification on the website. If your request could not be approved automatically and requires review, you receive an email from the reviewer within the next few business days.
      Note:
    • Depending on the network speed or processing time, it may last up to 90 seconds until you receive the notification.
  12. Return to the license management application and click Next.
  13. Review the summary and click Install.
    You will see a message that the license was successfully revoked.
  14. Click Done.

1.8.1.4 Running Java version of TIFF2PDF Plus

Jar file tiff2pdf.jar is the only jar file required to run the TIFF2PDF Plus application. The main class name to start TIFF2PDF Plus is tiff2pdf.class.

To run Java TIFF2PDF Plus you can use one of these options:

  • Java command line.
  • Client/Server model.

1.8.1.4.1 Java Command Line

To transform a Tiff file into PDF, run this command:

  • For Windows:
    tiff2pdf.bat [options] input-file output-file
  • For other operating systems:
    tiff2pdf.sh [options] input-file output-file

1.8.1.4.2 Java Tiff2PDF Plus Command Options

Command line syntax
tiff2pdf.bat [Options] < input tiff file name> <output pdf file name>
tiff2pdf.sh [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.tifftest.pdf

1.8.1.4.3 Running Java TIFF2PDF Plus 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 TIFF2PDF Plus Server.
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

  1. To start TIFF2PDF Plus Server set these values:
    Client port:
    Default 8800.
    RMI port:
    Default 8801.
  2. Enter the command line: java Tiff2PdfServer —start.
  3. To stop the TIFF2PDF Plus Server enter: java Tiff2PdfServer —stop.

Example 2

  1. To start the TIFF2PDF Plus Server set these values:
    Client port: 7200.
    RMI port: 7201.
    Tempdir: /mydir/tmp.
  2. Enter the command line: java Tiff2PdfServer —start —p 7200 —r 7201 —t /mydir/tmp.
  3. To stop the TIFF2PDF Plus Server enter: java Tiff2PdfServer —stop —p 7200.

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

  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.
  2. Enter the command line: java Tiff2PdfAgent —s server1.
  3. To stop Tiff2PdfAgent enter: java Tiff2PdfAgent —s server1 —stop.

Example 2

  1. To start Tiff2PdfAgent set these values:
    Client port: 9500.
    For C/C++ client.
    Remote host where Tiff2PdfServer is running: server1.
    RMI port: 7201.
  2. Enter the command line: java Tiff2PdfAgent —p 9500 —s server1—sp 7201.
  3. To stop Tiff2PdfAgent enter: java Tiff2PdfAgent —s server1 —p 9500 —stop.

1.8.1.5 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.8.1.5.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.8.1.5.2 Client and Server on the Same Machine

  1. Client sends the command line arguments to server through socket communication.
  2. 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.8.1.5.3 Client and Server on Different Machines

The Client/Server Model with Client and Server on different machines requires that the agent Tiff2PdfAgent is based on the client machine.

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

1.9 Accessibility Designer

The following publications are available for RICOH Accessibility Designer. 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.9.1 RICOH Accessibility Setup Guide

1.9.1.1 RICOH Accessibility Designer Setup Guide

1.9.1.1.1 Introduction

1.9.1.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 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.9.1.1.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.9.1.1.1.3 Guides for This Application

The following guides are available for this application.
Instruction Manuals

These instruction manuals are included:

  • RICOH Accessibility Designer Setup Guide

    This guide explains the setup and startup procedures, and the settings required before you can use this application.

  • RICOH Accessibility Designer User’s Guide

    This guide explains the functions and basic operations of this application.

Help

The Help menu provides access to the HTML version of the RICOH Accessibility Designer User’s Guide and RICOH Accessibility Designer Setup Guide directly from the user interface.

Note: A web browser must be installed to view the HTML documentation. The recommended browser is the most recent version of Mozilla Firefox®. A PDF reader, such as Adobe Reader®, must be installed to view the PDF documentation.

1.9.1.1.1.4 How to Read the Documentation

1.9.1.1.1.4.1 Before Using This Application

This manual contains detailed instructions and notes on the operation and use of this application. To ensure correct operation, read this manual carefully and completely before using this application. Keep this manual in a handy place for quick reference.

1.9.1.1.1.5 How to Use the Manuals and Help

Use the instruction manuals and field help according to your needs.
To learn how to install and start this application
See the RICOH Accessibility Designer Setup Guide.
To learn about the functions and basic operations of this application
See the RICOH Accessibility Designer User’s Guide.

1.9.1.1.1.5.1 Displaying the Instruction Manuals (Setup Guide and User's Guide)

Use this procedure to view the instruction manuals.
Displaying the Setup Guide and User's Guide in HTML Format
The HTML versions of the Setup Guide and User’s Guide are available directly from the user interface. Start the application, then click the question mark located in the upper-right corner of the interface panel and select Help.

1.9.1.1.1.5.2 Symbols

The following symbols are used in this manual to help you to identify content quickly.

    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 dialogs, menus, menu items, settings, field labels, buttons, and keys.
Italic
Italic type indicates the titles of manuals and variables that you must replace with your own information.
Monospace
Monospace type indicates computer input and output.
[ ]
Square brackets indicate the names of dialogs, menus, menu items, settings, field labels, buttons, and keys.

1.9.1.1.1.6 Trademarks

Acrobat, Adobe, Reader, and PostScript are either registered trademarks or trademarks of Adobe in the United States and/or other countries.

Firefox is a registered trademark of the Mozilla Foundation.

Linux is a registered trademark of Linus Torvalds.

Microsoft, Windows, Windows Server, and Microsoft Edge are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.

Red Hat is a trademark of Red Hat, Inc., registered in the United States and other countries.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

Ubuntu and Canonical are registered trademarks of Canonical Ltd.

The proper names of the Windows operating systems are as follows:

  • Windows 10:
    • Microsoft Windows 10 Pro
    • Microsoft Windows 10 Enterprise
  • Windows 11:
    • Microsoft Windows 11 Pro
  • Windows Server 2016:
    • Microsoft Windows Server 2016 Standard
  • Windows Server 2019:
    • Microsoft Windows Server 2019 Standard
  • Windows Server 2022:
    • Microsoft Windows Server 2022 Standard
  • Windows Server 2025:
    • Microsoft Windows Server 2025 Standard

Other product names used herein are for identification purposes only and might be trademarks of their respective companies. We disclaim any and all rights to those marks.

1.9.1.1.2 System Requirements

Supported operating systems:

Windows®

  • Microsoft® Windows 10
  • Microsoft Windows 11
  • Windows Server 2016 Standard
  • Windows Server 2019 Standard
  • Windows Server 2022 Standard
  • Windows Server 2025 Standard

    Important:
  • We do not recommend installing RICOH Accessibility Designer on operating systems that are not supported. However, if you want to install RICOH Accessibility Designer on non-supported operating systems, you must run the installation program adding this parameter:
    RADInstaller.exe -DVERIFY_OS_ACTIVE=false

1.9.1.1.3 Limitations

The current limitations of the RICOH Accessibility Designer include:
  • Opened PDF files limit

    RICOH Accessibility Designer can only work with one PDF document at a time.

    See FILES from RICOH Accessibility Designer User`s Guide for more information on the list of PDF documents.

  • Table template limitations:

    • Multiple cells selection to change cell type not supported: table row data, table row header or table column header.
    • Merge cells feature not implemented.
    • Variable table cells with more than one line of text not supported.

    See Table Template from RICOH Accessibility Designer User`s Guide for more information on how to customize table elements.

  • Unmarked text for Block Lines elements

    The elements Block Lines and Block Lines Paragraph do not mark all the text if the text is not fully contained in the bounding box of the text contained within the selection box.

    See Matching Text Elements from RICOH Accessibility Designer User`s Guide for more information on how to use block lines.

  • Macros limitation

    Macros that contain Text directly under ListBody are not marked correctly, as ListItem Body does not have text property.

    For more information, see Macros from RICOH Accessibility Designer User`s Guide.

  • Repeating group limitation

    Exiting/breaking repeating group from within a condition branch not supported.

    <Action when="false">
    <ExitRepeatingGroup/>
    </Action>
  • Allowed writing systems

    The only writing system currently supported is left-to-right and top-to-bottom. Any other language that has a different writing systems, such as right-to-left (Arabic or Hebrew) or bottom-to-top (Traditional Chinese or Vietnamese) is not supported yet.

  • Font related
    • All code points must encode a single character. For example, a codepoint of 2 bytes coding 2 chars.
    • Certain fonts with mixed single byte and double byte characters are not supported.
  • Annotations are not supported in RICOH Accessibility Designer.
  • RICOH Accessibility Designer does not support:
    • forms
    • JavaScript
    • media (sound/video)
    • optional content is always flattened (becomes non-optional)
  • Tags
    • Tags related to Asian languages are not implemented. For example, Ruby or Warichu.
    • Missing tags: Formula, Quote
  • RICOH Accessibility Designer and PDF2PDFUA do not handle embedded files.
  • Existing PDF tags are removed before tagging.
  • Text content as an image is not supported, there is no OCR support.
  • PDFs with password protection are not supported.
  • PDF actions are not supported.
  • All fonts must be embedded.
  • Table row operators limitation
    • You can only use the operators Get Next Row Y and Get Next Row Height within a table.
  • List items Join match ID limitation
    • Using more than two list items in a list with the same Join match ID non-empty value is not supported.
  • Variable rule expression limitation
    • To change the value of a variable rule to an expression, you need to use the Edit functionality and not set it from the Variable Value property.
  • Macro definition debugging limitation
    • Using breakpoints and debugging on rules inside macro definitions is not supported.
  • Automatic rule creation (prototype) limitations:

    • Supports only Paragraph, Heading, Block Paragraphs, Figure (raster and vectorial), and Table with its child rules Table Row, Table Data, Column Header, and Row Header. Other rules are not supported.
    • Generated rules for a page are placed in a Condition rule named Page followed by the page number. Page condition rules are placed inside a Region rule named Autodetect followed by a sequential count.
    • Rules are sorted top to bottom by Y position, then left to right by X position for rules on the same line. This order might not match the intended reading order and needs to be verified.
    • Generated rules have Export As set to Fixed for X, Y, width, and height. The root Region rule has these values set to Absent. Rules following variable-length content might be positioned incorrectly on other documents.
    • Vectorial lines, based on maximum X/Y size, do not generate rules.
    • Raster images with overlapping centers are merged into a single Figure rule.
    • Intersecting raster images are merged into a single Figure rule when the overlapping area exceeds the configured X/Y tolerance.
    • Tables are generated first from vectorial line intersections, then from table-text detection. Some tables might not be recognized correctly depending on the drawing style.
    • Table-text detection requires every cell to contain text. Empty cells prevent recognition, and non-table text might be misidentified as a table.
    • A table is generated only when the row count and column count are both 2 or greater.
    • No alternative text is generated for any rule. Alternative text for figures, including logos and text-only images, needs to be added manually.
    • Only bold text chunks are detected as Heading rules, and no heading level is set.
    • Each page is processed independently, and the feature does not reuse structures detected on other pages.
    • Only the currently open PDF is processed.
    • Running automatic rule creation regenerates rules for the entire document each time and does not account for existing rules or previously matched items.
    • Rotated text, rotated content, or a rotated page is not supported.
    • The automatic rule creation button has no keyboard shortcut and cannot be configured in application settings.

    See Automatic Rule Creation from RICOH Accessibility Designer User`s Guide for more information.

  • Expression Builder number format limitation

    Inline expressions in the Expression Builder support only numbers in US locale format.

For more information on RICOH Accessibility Designer, see the User's guide.

1.9.1.1.4 Installing RICOH Accessibility Designer

To install RICOH Accessibility Designer:

  1. Log in to Windows as an administrator.
  2. Download and launch RADInstaller.
  3. Open the installer and follow the installation steps.
  4. Follow the steps by accepting the terms of the License Agreement and choosing the install folder, then click Install.
  5. Once the installation is complete, click Done.

To launch the RICOH Accessibility Designer interface, follow one of these possibilities:

  1. Open the install folder and run Rad.exe for Windows.
  2. Click the Windows Start button and type RICOH RAD to search RICOH Accessibility Designer, then click on it.

On Windows operating system, these files and folders are created in the C:\ProgramData\Ricoh\Rad\ directory:

\logs
The folder contains the application logs.
\templates
The folder contains table templates.
\styling
The folder contains styling themes.
styling.xml
Styling configuration file.
rules_styling.xml
Styling configuration file.

1.9.1.1.4.1 Installing a Permanent License

To use RICOH Accessibility Designer, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for RICOH Accessibility Designer:
  1. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  2. If the computer where RICOH Accessibility Designer is installed does not have Internet access:
    1. Do not close the license application on the computer where RICOH Accessibility Designer is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where RICOH Accessibility Designer is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  3. On the computer that has Internet access, go to this website: https://dl.ricohsoftware.com.
    License Action dialog
  4. Click Software Activation on the right side of the screen.
  5. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management application on the computer where RICOH Accessibility Designer is installed. Click the Copy button next to the System fingerprint field. This action copies the 16-character system fingerprint that uniquely identifies the computer where RICOH Accessibility Designer is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  6. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  7. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  8. To email the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  9. If you are finished, close the browser tab. To restart the process, click Start Over.
  10. If you accessed the Internet from a different computer than the one where RICOH Accessibility Designer is installed, copy the license file to the computer where RICOH Accessibility Designer is installed.

1.9.1.1.4.2 Running RICOH Accessibility Designer in Trial Mode

When you run RICOH Accessibility Designer without a permanent license, the application operates in trial mode with restricted functionality.

Trial mode lets you to explore the interface and create projects, but restricts these functions:

  • Exporting control files.
  • Exporting macros.
  • Exporting rules.
  • Validating batch PDFs .

PDF files saved in trial mode include:

  • A watermark on each page.
  • A header on each page indicating the PDF was generated with the trial version.

To remove these limitations, install a permanent license. See Installing a Permanent License.

1.9.1.1.4.3 Running RICOH Accessibility Designer

To run RICOH Accessibility Designer:
  1. To launch RICOH Accessibility Designer, use Rad.exe.
    Note: The default installation folder is C:\Program Files\RICOH\RICOH Accessibility Designer.
  2. To load a license file, click INSTALL LICENSE.

    You need to retrieve the license file after the purchase. For more information on the installation of a permanent license, see Installing a Permanent License in the RICOH Accessibility Designer Setup Guide.

  3. Once the license file is loaded, click Close.
Note: With RICOH Accessibility Designer you can continue to use projects and macros from earlier versions without loss of functionality. Older versions of RICOH Accessibility Designer cannot open projects and macros created with newer versions. PDF2PDFUA can use control files and macros created with older versions of RICOH Accessibility Designer. Older PDF2PDFUA cannot open control files and macros created with a newer version of RICOH Accessibility Designer. If you have an older version, you must update RICOH Accessibility Designer to benefit from the latest functions.

1.9.2 RICOH Accessibility Designer User Guide

1.9.2.1 RICOH Accessibility Designer User Guide

1.9.2.1.1 Introduction

1.9.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 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.9.2.1.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.9.2.1.1.3 Guides for This Application

The following guides are available for this application.
Instruction Manuals

These instruction manuals are included:

  • RICOH Accessibility Designer Setup Guide

    This guide explains the setup and startup procedures, and the settings required before you can use this application.

  • RICOH Accessibility Designer User’s Guide

    This guide explains the functions and basic operations of this application.

Help

The Help menu provides access to the HTML version of the RICOH Accessibility Designer User’s Guide and RICOH Accessibility Designer Setup Guide directly from the user interface.

Note: A web browser must be installed to view the HTML documentation. The recommended browser is the most recent version of Mozilla Firefox®. A PDF reader, such as Adobe Reader®, must be installed to view the PDF documentation.

1.9.2.1.1.4 How to Read the Documentation

1.9.2.1.1.4.1 Before Using This Application

This manual contains detailed instructions and notes on the operation and use of this application. To ensure correct operation, read this manual carefully and completely before using this application. Keep this manual in a handy place for quick reference.

1.9.2.1.1.5 How to Use the Manuals and Help

Use the instruction manuals and field help according to your needs.
To learn how to install and start this application
See the RICOH Accessibility Designer Setup Guide.
To learn about the functions and basic operations of this application
See the RICOH Accessibility Designer User’s Guide.

1.9.2.1.1.5.1 Displaying the Instruction Manuals (Setup Guide and User's Guide)

Use this procedure to view the instruction manuals.
Displaying the Setup Guide and User's Guide in HTML Format
The HTML versions of the Setup Guide and User’s Guide are available directly from the user interface. Start the application, then click the question mark located in the upper-right corner of the interface panel and select Help.

1.9.2.1.1.5.2 Symbols

The following symbols are used in this manual to help you to identify content quickly.

    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 dialogs, menus, menu items, settings, field labels, buttons, and keys.
Italic
Italic type indicates the titles of manuals and variables that you must replace with your own information.
Monospace
Monospace type indicates computer input and output.
[ ]
Square brackets indicate the names of dialogs, menus, menu items, settings, field labels, buttons, and keys.

1.9.2.1.1.6 Trademarks

Acrobat, Adobe, Reader, and PostScript are either registered trademarks or trademarks of Adobe in the United States and/or other countries.

Firefox is a registered trademark of the Mozilla Foundation.

Linux is a registered trademark of Linus Torvalds.

Microsoft, Windows, Windows Server, and Microsoft Edge are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.

Red Hat is a trademark of Red Hat, Inc., registered in the United States and other countries.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

Ubuntu and Canonical are registered trademarks of Canonical Ltd.

The proper names of the Windows operating systems are as follows:

  • Windows 10:
    • Microsoft Windows 10 Pro
    • Microsoft Windows 10 Enterprise
  • Windows 11:
    • Microsoft Windows 11 Pro
  • Windows Server 2016:
    • Microsoft Windows Server 2016 Standard
  • Windows Server 2019:
    • Microsoft Windows Server 2019 Standard
  • Windows Server 2022:
    • Microsoft Windows Server 2022 Standard
  • Windows Server 2025:
    • Microsoft Windows Server 2025 Standard

Other product names used herein are for identification purposes only and might be trademarks of their respective companies. We disclaim any and all rights to those marks.

1.9.2.1.2 Overview

1.9.2.1.2.1 RICOH Accessibility Designer Overview

RICOH Accessibility Designer allows users to create control files used in the process of converting Adobe Portable Document Format (PDF) files to PDF/Universal Accessibility (PDF/UA) documents.

RICOH Accessibility Designer lets you mark PDF content, by structuring document elements in a logical reading order, to ensure that a PDF is accessible to all assistive technology (AT) users. The tagged PDF content is saved into a project, exported as a control file.

With the help of RICOH Accessibility Designer, experienced users can generate an XML control file that records content for further reuse on multiple statement documents. To create an accessible PDF document, the PDF/UA Tool requires both a control file and a PDF document.

    Note:
  • To convert Advanced Function Presentation (AFP) documents to PDF files make sure to use the AFP2PDF Plus transform.

The Assistive Technology (AT) software interprets the PDF/UA document to those who depend on universally accessible information.

    Important:
  • Make sure you use a PDF/UA conforming software to verify that your PDF document meets the requirements of the PDF/UA technical specifications of accessibility prior to start your project.

RICOH Accessibility Designer allows you to perform various functions:

  • Helps you create standardized tagging, with the help of the PDF/UA tool.
  • Create or reorder the reading order of the document content.
  • Work with multiple PDF samples for the same statement format.
  • Add macro definition files to the project to reuse the same content structure within the control file.
  • Create and export a single control file to be used across multiple PDF documents.
  • Validate your work prior to exporting the control file.

1.9.2.1.2.1.1 Control Files

As you use RICOH Accessibility Designer to tag the content of a PDF file, instead of saving markup in the PDF file itself, you save markup to one control file.

In a repeating environment where your PDF workflow does not change often, you could choose to create only one control file to be applied to multiple PDF files with identical or similar content. The control file is an XML document that contains all the information related to your project, including the PDF content and all the properties for an element, such as type, alternative text, or position.

    Important:
  • The control file is not linked directly to the project saved with, it can be used with any other project for reusing tagged content. To add additional tagged content to the control file, you should open the project in RICOH Accessibility Designer, create rules and overwrite the existing control file by exporting the project you have worked on.

To manage control files you use the RICOH Accessibility Designer menu option Export from File, the Control File section.

1.9.2.1.2.2 User Interface

Accessibility Designer provides an easy to use and intuitive user interface for editing and tagging universally-accessible PDF documents.

The user interface consists of the following areas:

  1. Menu bar with file management, file editing, inserting and viewing options.

  2. Document content area with sections for opened PDF files, macro definition files, and rules.

  3. Workspace area for matching elements on the currently opened PDF page.

  4. Properties area with information such as name, description, position, or alternative text.

1.9.2.1.2.2.1 Menu Bar

The menu bar is available at the top of the Accessibility Designer user interface and it provides access to functions as project management, file editing, inserting elements, viewing PDF files and reviewing PDF matched content.
Menu bar

The menu bar lets you do the following:

  • Switch between the available menu options. Click the File tab, the Edit tab, or the Insert tab.

    You can also navigate between the tabs by keyboard, using the following key combinations: Tab or Shift+Tab.

  • Show the project name and the PDF file opened, at the top of the menu bar.
      Note:
    • The default project name generated by the system is Project 1.
  • Display the HTML version of the User’s Guide. Click the button and select Help.
  • See the version information for Accessibility Designer. Click the button and select About.
  • See the license information for Accessibility Designer. Click the button and select License.

1.9.2.1.2.2.1.1 File Tab

On the File tab you have access to file management functions on the PDF documents and projects.

File Tab

These options are available:

Project
  • New

    Create a new project.

  • Open

    Open a project already saved.

  • Save

    Save the content of the current PDF as a project file.

  • Save as

    Make a copy or save the content of the current project under a different name or location.

  • Close

    Close the current project.

      Note:
    • You are prompted to save any changes to the project before closing.
Files
  • Add PDF

    Add PDF files to mark structure elements.

      Note:
    • You can also drag and drop PDF files to the FILES section with the list of opened PDF documents.

  • Add folder

    Add a folder to the project.

  • Add Macro

    Add macro rules to the project.

Export
  • Control File

    Export current project as control file.

  • Single PDF

    Export the current PDF file that was processed with PDFUA.

  • Batch PDF

    Export a selection of PDF files that were processed with PDFUA.

PDFUA Compliance
PDF import wizard

Import one or more PDF files and verify their PDFUA compliance.

Pre-accessibility checker

Verify the PDFUA compliance for one or more existing PDF files.

    Note:
  • RICOH Accessibility Designer remembers the last folder used when browsing for files or projects, saving projects or exporting control files.

1.9.2.1.2.2.1.2 Edit Tab

On the Edit tab, you can do actions such as undo, redo, delete actions, or access the settings and enable or disable the ruler.

Edit Tab

These functions are available:

Actions
  • Undo

    Reverse the most recent actions applied to the active PDF.

  • Redo

    Reverse the last Undo action. This command is used only after the Undo command.

      Note:
    • You can undo or redo multiple action rules, but all actions are reversed in the order they are listed.

Objects
  • Delete

    Remove selected objects.

Settings
  • Application Settings

    Lets you access the settings.

  • Show Ruler

    Ruler

    Use this functionality, located at the margins of the workspace view, to help you position document elements or quickly read the position and extent of current selected object.

    Note:
  • By default, Show Ruler is enabled. You can clear the check box at any time to hide it from the workspace area.

1.9.2.1.2.2.1.3 Insert Tab

The Insert tab lets you create rules on the PDF document. You can insert your rules in a hierarchical order maintaining a clear and logical structure.

File Tab

For more information on how to add rules to a PDF document, see Creating Rules.

1.9.2.1.2.2.1.4 Toolbar

The toolbar tab gives you control over layout options such as showing, zooming, or page navigation options as well as to the review options.

Toolbar

These options are available:

Layout

Zoom
To adjust the zoom level of the pages, use one of these controls:
  • Zoom in

    Use this option to increase the size of the page.

  • Zoom out

    Use this option to decrease the size of the page.

  • Percentage

    Use this control to adjust the size of the displayed page according to a specific percentage. You can either select one of the options from the drop-down menu or you can enter any percentage.

  • Fit to width

    Use this option to fit the page to the width of the workspace area.

  • Fit to window

    Use this option to resize the page to fit the application window.

Page Navigation
To switch between pages, use one of these buttons:
  • Previous

    Use this button to go back to the previous page of the PDF file.

  • Next

    Use this button to go to the next page of the PDF file.

  • Use this option to go directly to a specific page.

Review

Single PDF
Indicates a single PDF file validation.
Multiple PDF
Indicates a batch PDF files validation.
Debug Preview
Indicates the debugging mode.

For more information on the validation process, see Validating PDF.

1.9.2.1.2.2.2 Workspace

The workspace area displays the PDF page that you are currently working on.

    Note:
  • The workspace displays a single page at a time.

All rules are highlighted in blue. After validating the PDF document, matched content is highlighted in green, while unmatched content is red.

To hide a rule from the workspace area, select , the selection tool.

Viewing options

You can switch the page that is displayed in the workspace just by selecting the page number from the Page Navigation section, in the View tab.

You can go to the next or the previous page by clicking , the button, in the View tab, in the Page Navigation section.

You can click , the Zoom out button, or , the Zoom in button, to adjust the size of the page in the workspace.

    Note:
  • You can also use the floating page functionality, available at the bottom of the workspace area, for zoom and page navigation options. Make sure that the Floating Pane option is selected in the View tab.

1.9.2.1.2.2.3 Document Content

The left panel is divided into sections to highlight the current PDF document you are working on and the rules applied to the document.
    Note:
  • The option of rotating pages and content is currently not supported.

  • The only writing system currently supported is left-to-right and top-to-bottom. Any other language that has a different writing systems, such as right-to-left (Arabic or Hebrew) or bottom-to-top (Traditional Chinese or Vietnamese) is not supported yet.

1.9.2.1.2.2.3.1 Files

The FILES section indicates the list of opened PDF documents.

To add a PDF file to the project, click , on the top right of the FILES section.

    Note:
  • You can also drag and drop multiple PDF files located on your computer to the FILES section. Drag and drop PDF file
  • You can also add PDF documents by clicking , the Add PDF icon or , the Add folder icon, from the Files tab.
  • When an imported PDF file has the same name as one of the existing files in the FILES section, a warning dialog box appears.Add PDF Warning
  • To display the full path of a PDF or a folder, hover the mouse pointer over the file or the folder.

To organize and rearrange the PDF files and folders in a different order:

  1. Select the PDF file or the folder that you want to move.
  2. Drag and drop it to a new position.

You can also make changes to the PDF files and to the folders by using the right-click menu. Right-click a file or a folder and select one of the options available in the menu:

  • To view PDF properties, select File Settings. See Displaying PDF Settings for more information.
  • To remove PDF documents from the project, select Unload.
      Note:
    • All the rules created using that PDF file will still be available into the RULES section.
  • To validate several PDF documents:
    1. Hold Ctrl+A to select multiple files.
    2. Right click and select Batch Validation from the options available in the menu

If the project contains sources that have been moved or renamed since the document was saved, right click on the file and choose one of the relink options:

Relink file
Relinks the project with the missing PDF file.
Relink from folder
Relinks the project with the folder where the PDF file is located.
Note: The right-click menu available for folders allows you just to Relink file, Relink from folder, and Unload.

For more information on how to use or change view options, see Toolbar.

1.9.2.1.2.2.3.1.1 Displaying PDF Settings

The File Settings dialog displays detailed information about a PDF document to identify it on the FILES list. The information is either set by the person who created the PDF document or generated automatically.

File Settings

General
This sections lets you view general information on the file. It also allows you to change the file location and select the location type.
  • Name: Indicates the name of the PDF document.
  • Size: Indicates the size of the PDF document, in bytes or MB on disk.
  • Location: Indicates the full path of the current PDF file.
      Note:
    • By default, the Location field displays the absolute path of the PDF file.
  • Location Type: Indicates how the PDF path is saved into the project file.
    Absolute path
    Specifies the full PDF path saved into the project.
    For example:

    Project file path: c:\projects\project.uaproj.

    PDF file path: c:\files\demo.pdf .

    Absolute PDF path within project file:path="c:\files\demo.pdf".

      Note:
    • If you move the project file anywhere on your disk, without moving the PDF file, the project file will still be able to locate the PDF. However, if the project file is moved on another disk, the PDF will not be found.
    Relative to project path
    Specifies the PDF path saved into the project, relative to the project path. When opening a project, the PDF path becomes the project path together with the relative path.
    For example:

    Project file path: c:\my work\project.uaproj.

    PDF file path: c:\my work\demo.pdf.

    Relative PDF path within project file: path="demo.pdf".

      Note:
    • If you move the project file anywhere on your disk, without moving the PDF file, the project file will not be able to locate the PDF. However, if you move both project and PDF files anywhere on the same disk or on another disk, the project finds the PDF file.
    • By default, the Location Type is set to Relative to project path.
More Info
This section offers additional information on the PDF file.
  • Author: Indicates the name of the document creator.
  • Creator: Indicates the name of the application used to create the original document.
  • Producer: Indicates the name of the application used to convert the original document into a PDF file.
  • Locale: Indicates country conventions for time, date, and language.
  • Title: Indicates the title of the PDF document.
  • Subject: Indicates the subject of the PDF document.
  • PDF Version: Indicates the PDF standard version of the document.
  • Page Size: Indicates the height and width of the document in inches.
    Note:
  • The values within these fields cannot be modified.

1.9.2.1.2.2.3.2 Macros

The MACROS screen displays macro definitions lists, divided into sections. Each section indicates the method of adding macro definitions to create macro rules.

Created
Indicates the list of macro definitions created into the project.
For more information on how to create macro definitions, see Creating Macro Definitions.
Imported
Indicates the list of imported macro definition files that contain the hierarchy of the file, with the file name at the top of the section together with the list of macro definitions.

You can also make changes to macro files by using the right-click menu. Right-click a file and select one of the options available in the menu:

  • To view the properties for a macro definition file, select File Settings. See Displaying Macro Definition File Settings for more information.
  • To remove macro files from the project, select Unload.
  • The macro view panel supports the same rule management operations as the RULES section, including drag and drop, cut, copy, paste, delete, disable, add breakpoint, and set variable.

For more information on how to access the list of macro definitions, see Adding Macro Rules to the Project.

1.9.2.1.2.2.3.2.1 Displaying Macro Definition File Settings

The File Settings dialog displays detailed information about a macro definition file to identify it on the MACROS list. The information is either set by the person who created the macro definition file or generated automatically.

File Settings

General
This sections lets you view general information on the file. It also allows you to change the file location and select the location type.
  • Name: Indicates the name of the macro definition file.
  • Size: Indicates the size of the macro definition file, in bytes or KB on disk.
  • Location: Indicates the full path of the current macro definition file.
      Note:
    • By default, the Location field displays the absolute path of the macro definition file.
  • Location Type: Indicates how the macro definition file path is saved into the project file.
    Absolute path
    Specifies the full macro definition file path saved into the project.
    For example:

    Project file path: c:\projects\project.xml.

    Macro definition file path: c:\files\macro.pdf .

    Absolute macro definition file path within project file:path="c:\files\macro.pdf".

      Note:
    • If you move the project file anywhere on your disk, without moving the macro definition file, the project file will still be able to locate the macro definition file. However, if the project file is moved on another disk, the macro definition file will not be found.
    Relative to project path
    Specifies the macro definition file path saved into the project, relative to the project path. When opening a project, the macro definition file path becomes the project path together with the relative path.
    For example:

    Project file path: c:\my work\project.xml.

    Macro definition file path: c:\my work\macro.pdf.

    Relative macro definition file path within project file: path="macro.pdf".

      Note:
    • If you move the project file anywhere on your disk, without moving the macro definition file, the project file will not be able to locate the macro definition file. However, if you move both project and macro definition files anywhere on the same disk or on another disk, the project finds the macro definition file.
    • By default, the Location Type is set to Relative to project path.
More Info
This section offers additional information on the macro definition file.
  • Definitions: Indicates the number of macro definitions included into the macro file.
    Note:
  • The values within these fields cannot be modified.

1.9.2.1.2.2.3.3 Rules

The RULES section allows you to view the hierarchy of defined rules. To comply with PDF/UA, all PDF content must be categorized in semantic elements included in a tagged structure tree.

Rules structure define the logical reading order of the document for the AT to be able to process the document structure and help the user get access to the PDF content.

Any matching content changes made on the workspace area are applied directly to the RULES section.

    Important:
  • The rules matched on a page are also applied on the other pages of the PDF document.

For more information on how to work with rules, see Managing Rules.

To hide a rule from the workspace area, select , the selection tool.

To search for a rule on the RULES section, select , the filtering tool.

File Structure

Header
For more information, see Matching Document Elements.
Body
For more information, see Matching Text Elements, Matching List Elements, Matching Object Elements, or Creating and Defining Structure Rules.
Table
For more information, see Matching Table Elements.
Footer
For more information, see Matching Document Elements.

1.9.2.1.3 Installing

1.9.2.1.3.1 System Requirements

Supported operating systems:

Windows®

  • Microsoft® Windows 10
  • Microsoft Windows 11
  • Windows Server 2016 Standard
  • Windows Server 2019 Standard
  • Windows Server 2022 Standard
  • Windows Server 2025 Standard

    Important:
  • We do not recommend installing RICOH Accessibility Designer on operating systems that are not supported. However, if you want to install RICOH Accessibility Designer on non-supported operating systems, you must run the installation program adding this parameter:
    RADInstaller.exe -DVERIFY_OS_ACTIVE=false

1.9.2.1.3.2 Installing RICOH Accessibility Designer

To install RICOH Accessibility Designer:

  1. Log in to Windows as an administrator.
  2. Download and launch RADInstaller.
  3. Open the installer and follow the installation steps.
  4. Follow the steps by accepting the terms of the License Agreement and choosing the install folder, then click Install.
  5. Once the installation is complete, click Done.

To launch the RICOH Accessibility Designer interface, follow one of these possibilities:

  1. Open the install folder and run Rad.exe for Windows.
  2. Click the Windows Start button and type RICOH RAD to search RICOH Accessibility Designer, then click on it.

On Windows operating system, these files and folders are created in the C:\ProgramData\Ricoh\Rad\ directory:

\logs
The folder contains the application logs.
\templates
The folder contains table templates.
\styling
The folder contains styling themes.
styling.xml
Styling configuration file.
rules_styling.xml
Styling configuration file.

1.9.2.1.4 Working with Projects

You can create a new project with PDF documents located on your computer or update an existing project using the Project functions. The project created by RICOH Accessibilty Designer is saved in an XML format that uses the filename extension .uaproj.

Creating New Projects

To create a new project:

  1. On the menu bar, go to File and select New to add a new project.
      Note:
    • The default project name generated by the system is Project 1.
  2. In the Files section from the File tab, click , the Add PDF icon or , the Add folder icon.
      Note:
    • You can also add PDF files by clicking on the FILES section located on the left side of the screen.
  3. In the Add PDF dialog box, browse for the files or folders that you want to add, select them, and click Open.
      Note:
    • You can select multiple PDF files in the dialog box in order to open more PDF files at once.

Editing Projects

To edit an existing project:

  1. On the menu bar, go to File and select the Open option to open a job that you have previously worked with.
  2. In the Open dialog box, browse for the files that you want to add, select them, and click Open.

Deleting PDF Files

To delete PDF documents from the project:

  1. Go to the FILES section and click on the PDF file or the folder you want to remove from your project.
  2. Right click on the file name and select Unload.
      Note:
    • All the rules created using those files will still be available into the RULES section.

1.9.2.1.4.1 Running RICOH Accessibility Designer

To run RICOH Accessibility Designer:
  1. To launch RICOH Accessibility Designer, use Rad.exe.
    Note: The default installation folder is C:\Program Files\RICOH\RICOH Accessibility Designer.
  2. To load a license file, click INSTALL LICENSE.

    You need to retrieve the license file after the purchase. For more information on the installation of a permanent license, see Installing a Permanent License in the RICOH Accessibility Designer Setup Guide.

  3. Once the license file is loaded, click Close.
Note: With RICOH Accessibility Designer you can continue to use projects and macros from earlier versions without loss of functionality. Older versions of RICOH Accessibility Designer cannot open projects and macros created with newer versions. PDF2PDFUA can use control files and macros created with older versions of RICOH Accessibility Designer. Older PDF2PDFUA cannot open control files and macros created with a newer version of RICOH Accessibility Designer. If you have an older version, you must update RICOH Accessibility Designer to benefit from the latest functions.

1.9.2.1.4.2 Exporting the Control File

The project you created can be exported with all the related data. The file format of the exported project is an .XML control file.
    Note:
  • This function is disabled in trial mode. Install a permanent license to enable export functions.
To export the content of the PDF project:
  1. On the menu bar, select File.
  2. Go to the Export section and select Control File.
    You are prompted with the Export control file window.
    • To save the project, insert the file name of the control file into the File name input field.
    • By default, the Save as Type drop-down menu contains only the Control files (*.xml) option.
  3. Click Save.

1.9.2.1.4.3 Exporting a Single PDF File

    Note:
  • This function is disabled in trial mode. Install a permanent license to enable export functions.
To export the current PDF file that was processed with PDFUA:
  1. On the menu bar, select File.
  2. Go to the Export section and select Control File.
    You are prompted with the Single PDF window.
    • To save the PDF, insert the file name of the PDF into the Export PDF file input field.
    • By default, the Save as Type drop-down menu contains only the PDF files (*.pdf) option.
  3. Click Save.

1.9.2.1.4.4 Exporting Batch PDF

    Note:
  • This function is disabled in trial mode. Install a permanent license to enable export functions.
To export a selection of PDF files that were processed with PDFUA:
  1. On the menu bar, select File.
  2. Go to the Export section and select Batch PDF.
    You are prompted with the Batch Export window.

    • Click START to process the batch export.

1.9.2.1.4.5 Exporting Rules

You can export rules as part of a control file to a desired location.
    Note:
  • This function is disabled in trial mode. Install a permanent license to enable export functions.
  1. Go to the RULES view on the left side of the screen.
  2. Select the rules that you want to export.
  3. Right-click the selected rules and select Export to.
  4. In the Export Control file dialog box, browse and select the location where you want to save the selected rules.
  5. Click Save.

1.9.2.1.5 Managing Rules

This section explains how to create rules that when processed by the PDF/UA tool will mark PDF content such as document, text, list, objects, table or structure elements.

1.9.2.1.5.1 Creating Rules

  1. On the menu bar, go to the Insert tab and select the rule from the toolbar. The currently active rule is highlighted in blue.
  2. In the workspace area, select the section where you want to define to define the rule outline (box, graphics). A blue outline appears around the selected area with multiple anchor points. As a result, the new rule will be active and highlighted in the RULES section.
      Note:
    • If you have set up a customized theme with a different color scheme, the rule is highlighted with that specific color while editing the rule. See Configuring, for more information regarding rules styling.
    • For more information regarding the use of elements, see the Insert Tab topic.
    • To position the selected area, see Positioning Rules Graphic in the Workspace Area
    All defined rules are displayed into the RULES section, located on the left side of the screen. See Managing Rules, for more information on how to manage rules.

1.9.2.1.5.1.1 Matching Document Elements

The Document section provides version information.

  • Header: a rule that applies only on the first page of a PDF document.
  • Footer: a rule that applies only on the last page of a PDF document.
      Note:
    • You should mark only one occurrence of identical header or footer, as they are not part of the reading-order of the document. The AT ignores the pagination information from other pages then the matched one, when the document is read aloud.

1.9.2.1.5.1.2 Matching Text Elements

The Text section contains text elements, such as paragraph or heading, and link element.

  • Paragraph: indicates meaningful text content.
  • Heading: specifies the title of a specific section, indicating the content of the section.
      Note:
    • The heading section is required for a PDF document to be fully accessible.
    • To differentiate different heading levels, use the Heading Level option from the PROPERTIES section, on the right side of the screen.
  • Link: indicates a rule matching a text that represent a URL link.
      Note:
    • Paragraph, Heading or Link have default Text Type set on Regular Expression.
  • Block Lines: matches all lines in a region as separate paragraphs.

    The PROPERTIES section on the right side of the screen supports the Export As functionality for exporting X, Y, Width or Height coordinates into the control file.Block Lines Properties

    For more information, see Setting Coordinates to Position an Element.

      Note:
    • This rule can be used on different line and row sizes, or heights.
    • The use of Block Lines becomes visible on the workspace area only when you validate the PDF.Block Lines
  • Block Paragraphs: indicates a macro that automatically creates paragraphs and lists, together with list items, from the selected area.
  • Reference: matches the references or end notes on documents that contain such type of information.
    Note: If you only wish to match as reference the superscript from the selected area, use the Small Text check box within the PROPERTIES section of the rule.

1.9.2.1.5.1.3 Matching List Elements

The Lists section contains list structure elements.

  • Block List: indicates an element that automatically creates lists, together with list items, items body, and item labels from the selected area.
  • Block End Note List: indicates an element that automatically creates a set of list items in an end notes list. After the PDF Validation, the results from all the pages will be automatically joined in one list.
  • List: contains a collection of related items.
  • Item: indicates elements with markers, usually bullets or list numbering.
  • Label: indicates elements with bullets.
  • Item Body: contains the content information within an item.
  • Item Group: specifies the shortcut that includes the group of Item, Item Body and Note.
      Note:
    • The Item Group name is not visible into the RULES section. When you use this shortcut, Item Group is replaced by the Item hierarchy.
    • When you undo this action, the entire group of elements is removed from the RULES section.
  • Note List: indicates an explanatory list of items.
  • Note: indicates any explanatory content.
      Note:
    • The Note element should only be used for footnotes or endnotes.
    • The default Text Type property is set on Regular Expression

1.9.2.1.5.1.4 Matching Object Elements

The Objects section specifies any graphic representation.

These object elements are available:

  • Figure: indicates rules used to match raster images, such as logos.
  • Artifact: indicates all types of image or text elements to be ignored by the Assistive Technology.

1.9.2.1.5.1.5 Matching Table Elements

The Table section indicates a list of elements used for structuring table data.

Insert Tables

These element options are available:

  • Table: shows information in a grid format, using rows and columns.
  • Manual Table: shows entire table information, without matching rows or columns.
  • Table Data: displays the data within a table cell.
  • Table Row: indicates the row of the table.
  • Column Header: indicates the header of a table column.
  • Row Header: indicates the header of a table row.

1.9.2.1.5.1.5.1 Table Builder

The Table Builder allows you to easily create and customize a table.

To create a table:

  1. On the menu bar, go to the Tables section.
  2. From the drop-down menu, click , the Table icon.
  3. With your mouse, click a part of the document where you want to apply the table.
  4. Hold the left button pressed while you drag your cursor to make the desired selection.
  5. To create and customize a table, use the Table Builder dialog.

  6. You can specify a name in the [Table Name] field:

    This is the name of the rule corresponding to the table. It is displayed in the [RULES] section:

  7. You can change the number of columns and rows by clicking , the up/down arrows next to the numbers under Columns and Rows.

      Note:
    • The default number of columns is 5 and the default number of rows is 2.

  8. On the Table Builder dialog, after selecting the desired number of columns and rows, click Continue:

  9. On the following window that opens, under [Row Type], you can change the type of row to Fixed or Variable:

  10. You can add or remove rows or columns by clicking the lower right corner of a cell:
    1. You can add a row or a column by selecting Add -> Table row/Table column from the menu:

    2. You can remove a row or a column by selecting Remove -> Table row/Table column from the menu:

  11. You can save this table as a template. To save the table template:
    1. Use the Save As Template button.
    2. Select a name for this table template and fill it in the Template Name field.

    3. Click Save. The table template is saved in the subfolder templates in the installation directory of the current version of the RICOH Accessibility Designer, for example:

      rad_current_version\res\Config\templates.

  12. To use this table, click INSERT.
  13. You also have to option to use one of the existing templates:
    • On the Table Builder dialog, under the Templates section, select the desired template from the previously saved templates:

  14. You also have the option to reset the table to the default format:
    • To do this, click Reset Format.
  15. You also have the option to merge and unmerge cells. To use the merge and unmerge cells option:
    1. On the Table Builder window, in the Table Structure section, hold the Shift key and click each cell that you want to select.
    2. Click the lower right corner of your selection and a drop-down menu appears.
    3. From the drop-down menu, select Merge.

        Note:
      • To avoid invalid table cases, the following cell merging rules have been set:
        • For variable rows, a cell should not have a row span >1 because it involves a dynamic set of rows that follow the same format. Having a cell with a row span means the cells for all the dynamic rows have overlapping incorrect cells.
        • For a fixed row that is the last row in the table or the last row before a variable row, it is also not feasible to have cells with a row span >1 because it involves a structure change for a variable row which cannot happen for a fixed set of rows (row span-1)
        • For fixed rows, the cells must have a row span greater than the number of rows preceding a variable row. For example: You can have a cell with a row span of 3 on row 2 if rows 2, 3 and 4 are fixed.

    4. To undo the merge operation, click the lower right corner of the merged range and select Unmerge.

      Note:
    • To select a single cell, click the respective cell.
    • To select multiple cells, click a cell and hold the Shift key on your keyboard. While holding the Shift key, click another cell in the table. All the cells included in its range are selected.

  16. After inserting the customized table in the file, you can make small adjustments to the table margins until the table is the size that you want.

1.9.2.1.5.1.6 Creating and Defining Structure Rules

The Structure section contains structure elements to configure rules based on conditions or repeating elements.

  • Region: indicates the grouping of multiple rules within the same container that acts like a parent for the container elements.
      Note:
    • The Region element is similar to the Repeating Group as structure, except that Region is only executed once.
    • Repeating Group indicates a repeating structure rule.

    When to use Region:

    • A list of rules matched within a Region rule allows the rules to be moved all at once by moving the Region rule.
    • A rule matched within a Region rule inherits the Region coordinate value if the Export As coordinate field of the rule is set on Absent.

  • Repeating Group: indicates a repeating structure rule.
  • Condition: defines conditions for a rule.

    See Condition Editor for information on how to work with the Condition Editor.

  • Anchor: sets the current processing cursor pointer.
  • Macro: creates a macro-based rule, that invokes of a macro definition.
  • Section: allows you to organize rules into sections that are tagged as structural elements or containers. For example, you can use Section to tag multiple paragraphs into a section that uses a particular language.
    Note: The difference between region and section is that region behaves as a logical unit and section behaves as a structural unit.

    For more information, see Adding Macro Rules to the Project.

1.9.2.1.5.1.6.1 Adding Conditions

A condition rule controls the flow of processing logic. It evaluates a specific test and then executes one of two branches based on the result: True or False. These branches are automatically created as ConditionBranch(Action) rules whenever a Condition rule is added.Users cannot insert True/False branch rules independently.
To add conditions:
  1. On the menu bar, go to Insert and select Condition from the Structure section.
  2. In the RULES hierarchy, click on the condition rule.
  3. Go to the Edit tab and click , the Edit icon, to add condition properties.

1.9.2.1.5.1.6.1.1 Condition Editor

Lets you define one or more condition entries for the condition rule. Each condition entry consists of a job property, a comparison, and a value.

Condition Editor

Each condition entry consists of the following:

Property
Specifies the property to use for the condition, such as: Current Page Number, Get Next Line, Next Image X Position, Current Line Y Position.
    Note:
  • This section is also populated with variable names, based on already created variables.

    For more information on how to set variables, see Setting Variables.

  • The comparisons for string properties, such as Get Next Line or Get Current Line, are case-sensitive.
Comparison
Select one of these:
Contains
A rule meets the condition based on a partial value of the property.
Equals
A rule meets the condition if its property value exactly matches the text or value in the Value field.
Not Equals
A rule meets the condition if its property value does not exactly match the text or value in the Value field.
Greater Than
A rule meets the condition if its property value is greater than the number in the Value field.
Less Than
A rule meets the condition if its property value is less than the number in the Value field or if the property has no value.
Matches Regex
A rule meets the condition if its property value matches the regular expression.
Not Matches Regex
A rule meets the condition if its property value does not match the regular expression.
Divisible By
A rule meets the condition if its property value is divisible by the integer number from the Value field.
Not Divisible By
A rule meets the condition if its property value is not divisible by the integer number from the Value field.
String Contains
A rule meets the condition if its property value indicates whether a specified string contains another string.
Not Contains String
A rule meets the condition if its property value indicates whether a specified string does not contain another string.
Value
Specifies the value that RICOH Accessibility Designer uses to decide whether a rule meets the condition.
    Note:
  • If no value is specified into the Value input field, you are prompted with a message stating the condition is missing a value.

To define an additional condition, click + to the right of any condition. To delete a condition, click - to the right of the condition you want to delete.

    Note:
  • While editing a condition entry using the Condition Editor, you can remove an existing condition entry. To remove a condition entry you need to have at least 2 condition entries created.

You can combine condition entries using these operations:

  • And
  • Or

The Condition Editor also contains a summary of all condition entries at the bottom of panel.

1.9.2.1.5.1.6.2 Editing Conditions

This option allows you to edit existing conditions.

To edit a condition:

  1. Select the condition from the RULES section, on the left side of the screen.
  2. Right-click and select Edit from the menu.

    The Condition Editor dialog is displayed in the workspace. For more information, see Condition Editor.

  3. Edit condition properties, comparison operators or values.
  4. Click OK.

or

  1. Select the condition from the RULES section, on the left side of the screen.
  2. Go to PROPERTIES, on the right side of the screen, and click the Edit button.Edit Condition

    The Condition Editor dialog is displayed in the workspace. For more information, see Condition Editor.

  3. Edit condition properties, comparison operators or values.
  4. Click OK.

1.9.2.1.5.1.7 Allowed children elements for rules

RICOH Accessibility Designer allows you to insert or drag and drop only certain rule elements for rules.

The following children elements are allowed when you create or define your rules:

Action

The Action rule represents the executable step within a condition branch. Although it functions as a ConditionBranch, you cannot insert it directly. Instead, Action rules are automatically created as part of the True or False branches whenever a Condition rule is added.

Page Header, Page Trailer, Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, ListItem, EndNoteList, Table, TableRow, TableData, TableColumnHeader, TableRowHeader, Note, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList, Label
Condition
Action
Document
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, PageHeader, PageTrailer, List, EndNoteList, Table, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList
EndNoteList
RepeatingGroup, Region, Section, Condition, ListItem, Cursor, Macro, SetVariable, Trace
Heading
Link, Macro, SetVariable, Trace, Figure
List
RepeatingGroup, Region, Section, Condition, ListItem, Cursor, Macro, SetVariable, Trace
ListItem
ListItemBody, Macro, Paragraph, Reference, Heading, Link, SetVariable, Trace, Label
ListItemBody
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, EndNoteList, Table, TableRow, TableData, TableColumnHeader, TableRowHeader, Note, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList
Note
Label
PageHeader
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, EndNoteList, Table, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList
PageTrailer
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, EndNoteList, Table, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList
Paragraph
Link, Macro, SetVariable, Trace
Reference
Macro
Region
Paragraph, Reference, Heading, RepeatingGroup, Region, Condition, List, ListItem, EndNoteList, Table, TableRow, TableData, TableColumnHeader, TableRowHeader, Note, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList, Label
RepeatingGroup
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, ListItem, EndNoteList, Table, TableRow, TableData, TableColumnHeader, TableRowHeader, Note, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList, Label
Section
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, ListItem, EndNoteList, Table, TableRow, TableData, TableColumnHeader, TableRowHeader, Note, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList, Label
Table
RepeatingGroup, Region, Section, Condition, List, EndNoteList, TableRow, Cursor, Macro, SetVariable, Trace
TableColumnHeader
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, EndNoteList, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList, Label
TableData
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, EndNoteList, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList, Label
TableRow
RepeatingGroup, Region, Section, Condition, List, EndNoteList, TableData, TableColumnHeader, TableRowHeader, Cursor, Macro, SetVariable, Trace
TableRowHeader
Paragraph, Reference, Heading, RepeatingGroup, Region, Section, Condition, List, EndNoteList, Image, Artifact, Link, Cursor, Macro, BlockLines, SetVariable, Trace, BlockParagraphs, BlockList, BlockEndNoteList, Label

1.9.2.1.5.1.8 Setting Variables

This option allows you to set variables that are used in the Condition Editor. Variables are displayed into the RULES or MACROS section.

To add variables:

  1. Go to the RULES or MACROS section and select the rule from the list.

    For more information, see Creating Rules.

  2. Right-click on a rule and select Set Variable from the menu.
  3. To add a variable for a rule that is not a container, select Set Variable from the menu and choose one of these options: Before or After. If your rule is a container, you can choose one of these options: Before, After, or Into.

To display and edit the available variable properties, go to the PROPERTIES section, on the right side of the screen. Set Variable Properties

For better management of your rules you have the option of renaming any variable.

  1. Go to the RULES section and select a rule from the list.
  2. Select the variable that you want to rename, right-click and select Rename variable from the menu. If you want to apply this change in all the places where your variable appears, make sure that you select Apply name to all instances.
  3. Click OK.

1.9.2.1.5.1.8.1 Variable values

In the Set Variable dialog box, use the options available:

  • Name: the name of the variable. You can either insert a new name or select a previously used name.
  • Type: the type of the variable: INT, DOUBLE, BOOLEAN, STRING.
  • Value: the value of the variable.

Set Variable

These are the values that you can select for each type of variable:

INT

Current Page Number
Indicates the current page number.
Expression
Indicates a user-defined expression.

DOUBLE

Next Image X Position
Indicates the X position of the image.
Next Image Y Position
Indicates the Y position of the image.
Next Image Width
Indicates the width of the image.
Next Image Height
Indicates the height of the image.
Next Line Y Position
Indicates the Y position of a PDF matched line.
Next Line in Region Y Position
Takes the Y position of the Next Line in Region.
Current Line Y Position
Takes the Y position of the Current Line.
Current Line in Region Y Position
Takes the Y position of the Current Line in Region.
Get Next Row Y
Indicates the Y position of the next row on the PDF page. You can only use this input within a table.
Get Next Row Height
Indicates the height of the next row on the PDF page. You can only use this input within a table.
Line Before Cursor Y
Indicates the Y position of the current line on the PDF page.
Line Before Cursor in Region Y
Indicates the Y position of the current line within the defined box.
Next line Height
Indicates the height of a PDF matched line.
Next Line in Region Height
Indicates the height of the next line within the defined box.
Cursor X
Indicates the current X coordinate of the cursor. Where cursor is the center of the last matched text element within the page.
Cursor Y
Indicates the current Y coordinate of the cursor. Where cursor is the center of the last matched text element within the page.
Current Line Height
Indicates the height of a PDF matched current line.
Current Line in Region Height
Indicates the height of the current line within the defined box.
Expression
Indicates a user-defined expression.

BOOLEAN

STRING

Get Next Line
Indicates the next line on the PDF page.
Get Next Line in Region
Indicates the next line within the defined box.
Get Current Line
Indicates the current line on the PDF page.
Get Current Line in Region
Indicates the current line within the defined box.
Line Before Cursor
Indicates the current line on the PDF page.
Line Before Cursor in Region
Indicates the current line within the defined box.
Get All Text in Region
Indicates all the text in the current region.
Next Line Font Name
Returns the list of font names used in the next line separated by ",".
Next Line in Region Font Name
Returns the list of font names used in the next line within the defined box separated by ",".
Current Line Font Name
Returns the list of font names used in the current line separated by ",".
Current Line in Region Font Name
Returns the list of font names used in the current line within the defined box separated by ",".
Expression
Indicates a user-defined expression.

1.9.2.1.5.1.8.2 Customizing Mathematical Expressions

The Expression Builder allows you to create complex mathematical expressions for existing functions, either variables or constants, defined within the rules.
To create a mathematical expression:
  1. Create a rule.
  2. To add a variable to the defined rule, right click on Document and select Set Variable.
    You are prompted with the Set Variable dialog.
  3. Fill out the required Name field and select the variable Type. From Value, make sure to select Expression from the drop-down menu list.
      Note:
    • The Expression option is available when you select INT, DOUBLE, or STRING from the Type field.
    The Set Variable dialog expends into an Advanced Builder dialog that allows you to create customized expressions.

    Expression Builder Box
    Indicates a user-defined complex expression.
    Summary
    Indicates an expression summary.

  4. To build an expression, click on Select Operand and select one the options from the drop-down menu list:
    • Functions - list of available functions;
    • Variables - list of already created variables;
    • Constants - known values;
    • Expressions- operands and operators, grouped together to indicate a certain value:
      2 operands
      Indicates an expression that consists of 2 operands and 1 operator.
      3 operands
      Indicates an expression that consists of 3 operands and 2 operators.
      Custom Operands
      Indicates an expression that consists of customized operands and operators.
      Inline
      Enter an expression of your choice.

      You can use one of these functions when you create an expression:

      • replaceFirstRegex(<Param1>, <Param2>, <Param3>): Replace first regex.
      • replaceRegex(<Param1>, <Param2>, <Param3>): Replace regex.
      • stringTrim(<Param1>): String Trim.
      • substr(<Param1>, <Param2>, <Param3>): Substract String.
      • stringLength(<Param1>): String Length.
      • range(<Param1>, <Param2>, <Param3>): Value in range.
      • concat(<Param1>, <Param2>): Concatenate Strings.

      These usage scenarios show possibilities of using the Inline option.

      • The expression uses numeric values: $x+$y or$x+1.0.
      • The expression uses string values: concat($a, "ABC") or concat($a, "1").

      You can use these operators in an expression: "+", "-", "/", "*", "%", "idiv". Also, you can use these brackets in your expressions: "(", ")".

      Note: Use the "idiv" operator for integer division.

  5. Review the Summary section.
      Note:
    • The Summary section is available only for expressions.
  6. Click ADD.
    The variable is added as a Set Variable rule under the RULES section.
To check the properties of the value, go to PROPERTIES, on the right side of the screen.

1.9.2.1.5.1.8.2.1 Creating an expression for the distance between 2 lines multiplied by a constant

  1. Create a paragraph rule to which to assign the variable to.
    Make sure the Export as field is set as Fixed for the Y coordinate.
  2. Right click on Document and select Set Variable to add a variable to the defined paragraph rule.
    You are prompted with the Set Variable dialog.
  3. Fill in the Name and select the Type of the variable, as highlighted below. Under Value, make sure to select Expression from the drop-down menu list.
    The Set Variable dialog expends into an Advanced Builder dialog that allows you to create customized expressions.Set Variable
  4. To change the operand into an expression with 2 operands, click on Select Operand and select 2 operands from the Expressions list.
    The first operand is converted into an expression by itself.
  5. Click on Select Operand and select 2 operands from the Expressions list.
  6. For the first expression, select Next Line Y Position, the - operator and Current Line Y Position. For the second expression, select the * operator and for the last operand, go to Constants and type 2.
  7. Review the Summary section.
    Expression Builder
  8. Click ADD.

1.9.2.1.5.2 Positioning Rules Graphic in the Workspace Area

You can position a rule graphic by manually selecting the rule area on the page or by entering coordinates in the X, Y, Width, and Height fields on the properties area.

Manually positioning

To position a rule manually:

  1. Go to the Insert tab to add the content type to the selected rule.
    • If , the selection tool, is active, a blue highlight is applied to the selected area to help identify matched rules.
  2. Select the content area to define a rectangular or square region.The cursor becomes a position icon.

Positioning with X, Y, Width or Height Coordinates

To position a matched element with X, Y, Width or Height coordinates:

  1. Select the rule graphic region.
  2. On the right side of the screen, in the PROPERTIES panel, enter coordinates in the X and Y fields to position the rule on the page.

1.9.2.1.5.3 Moving Rules in Document Hierarchy

You can reposition document element rules in the PDF structure hierarchy.

To move document element rules:

  1. On the left side of the screen, in the RULES or MACROS view, select the rule that you want to move.
  2. Drag and drop the rule to the new location.

1.9.2.1.5.4 Built-in Macro Rules

This topic describes the built-in macro rules. The built-in macro rules are designed to run without requiring any direct user input.

1.9.2.1.5.4.1 Block End Note List

Specifies the rule used to mark the Block End Note List elements in a bounding box defined by the X, Y, Width, Height properties.

Note: You cannot set your export options to Absent or Relative for Width and Height.
Built-in Macro Name: #ReadEndNotesListBlocks

All the lines in the region or the box are processed one by one and added to an end note list or they are skipped. When the distance between two lines is greater than the Line Height property, then it marks the end of a Block End Note List element. The distance between two lines is defined as the distance between the top Y position of the lines. The Line Height property is used to split the entire text into blocks that resemble to lists or get skipped.

For advancing to the next line Y position in the text, the getNextLineInRegion and getLineBeforeCursorInRegion operators are used. A Block End Note List element contains a set of ListItem elements and start with the first ListItem element encountered while processing.

List Items can span multiple lines with the exception that if a line matches the regular expression from the Single Line Contains property, it is processed as a single-line item. A matched List Item element is split into a Label element and a ListItemBody element.

The condition for matching new list items or the start of a List Item element is defined by the regular expression value from the List Item Regex property. The Label element from the List Item element is matched using the regular expression value from the Label Regex property. The ListItemBody element from the List Item element is matched using the regular expression value from the Note Regex property.

1.9.2.1.5.4.2 Block List

Specifies the rule used to mark lists located in a bounding box defined by the X, Y, Width, Height properties.

Note: You cannot set your export options to Absent or Relative for Width and Height.
Built in Macro Name: #ReadListBlocks

All the lines in the region or the box are processed one by one and added to a list or they are skipped. When the distance between two lines is greater than the Line Height property, then it marks the end of a list. The distance between two lines is defined as the distance between the top Y position of the lines. The Line Height property is used to split the entire text into blocks that resemble to lists or get skipped.

For advancing to the next line Y position in the text, the getNextLineInRegion and getLineBeforeCursorInRegion operators are used. A List element contains a set of ListItem elements and starts with the first ListItem element encountered while processing.

List items can span multiple lines with the exception that if a line contains the string . . . it is processed as a single line item. A matched List Item element is split into a Label element and a ListItemBody element.

Condition for matching new list items or the start of a ListItem element:

Line starting with a bullet • that corresponds to the Unicode character U+2022 (Regex = \x{2022}.*).
The bullet is matched as a Label element and the rest of the line is matched as a ListItemBody element.
Line starts with one or two digits continuing with a period and a space (Regex = ^\d{1,2}\. .*).
The start digits and period are matched as a Label element and the rest of the line is matched as a ListItemBody element.
Line starts with one or two digits then followed by a ) and a space (Regex = ^\d{1,2}\) .*)
The start digits and ) are matched as a Label element and the rest of the line is matched as a ListItemBody element.

A List Item element ends when at least one of the following is true:

  • The new line falls outside of the rule bounding box.
  • The end of a list is encountered.
  • The start of a new List Item element is encountered.

1.9.2.1.5.4.3 Block Lines

Specifies the rule used to mark each line as a paragraph located in a bounding box defined by the X, Y, Width, Height properties.

Note: You cannot set your export options to Absent or Relative for Width and Height.
Built-in Macro Name: #ReadBlockLines

All the lines in the region or the box are processed one by one and added as a separate paragraph. For advancing to the next line Y position in the text, the getNextLineInRegion operator is used.

1.9.2.1.5.4.4 Block Paragraphs

Specifies the rule used to mark paragraphs and lists located in a bounding box defined by the X, Y, Width, Height properties.

Built-in Macro Name: #ReadParagraphBlocks

All the lines in the region or the box are processed one by one and added to a paragraph or a list. When the distance between two lines is greater than the Line Height property, then it marks the end of a paragraph or a list. The distance between two lines is defined as the distance between the top Y position of the lines. The Line Height property is used to split the entire text into blocks that resemble into separate paragraphs or lists. You can set your Export as values to: Fixed, Next Image X Position, Cursor X. You can also select a previously added variable.

Note: You cannot set your export options to Absent or Relative for Width and Height.

For advancing to the next line Y position in the text, the getNextLineInRegion and getLineBeforeCursorInRegion operators are used. A List element contains a set of ListItem elements and starts with the first ListItem element encountered after the end of a paragraph or a list.

List items and paragraphs can span multiple lines with the exception that if a line contains the string . . . it is processed as a single line item.

List Items

A matched List Item element is split into a Label and a ListItemBody element.

Condition for matching new list items or the start of a ListItem element:

Line starting with a bullet • that corresponds to the Unicode character U+2022 (Regex = \x{2022}.*).
The bullet is matched as a Label element and the rest of the line is matched as a ListItemBody element.
Line starts with one or two digits continuing with a period and a space (Regex = ^\d{1,2}\. .*).
The start digits and period are matched as a Label element and the rest of the line is matched as a ListItemBody element.
Line starts with one or two digits then followed by a ) and a space (Regex = ^\d{1,2}\) .*)
The start digits and ) are matched as a Label element and the rest of the line is matched as a ListItemBody element.

A List Item element ends when at least one of the following is true:

  • The new line falls outside of the rule bounding box.
  • The end of a list is encountered.
  • The start of a new List Item element is encountered.
    List Item Regex
    This regex value is used to check if a new list item begins.
    Note Regex
    This regex value is used to mark or tag the note part of a list item.
    Label Regex
    This value is used to mark or tag the label part of a list item.
    Single Line Regex
    This regex value is used to check if a line should be processed as a single tagged item.

Paragraphs

If the line being processed in the defined region is not recognized as start or part of a List Item element, then it is processed as part of a Paragraph element. If the distance between the new line processed and the the previous line is greater than the Line Height property, then a new paragraph is started.

1.9.2.1.5.5 Editing Properties

1.9.2.1.5.5.1 Element Properties

This section contains properties than can be edited for the rules. You can edit the rule properties matched in the PDF document.

Class Type
Specifies the class type of the element. Depending on the element type, the information under this field is auto-filled.
    Note:
  • This field is not editable.
This element property can be used under the following rules: Document, Header, Footer, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Set Variable, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List, Exit Repeating Group, Action, Log Entry.
Name
Use this field to add a name for a rule.
This element property can be used under the following rules: Document, Header, Footer, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Set Variable, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List, Exit Repeating Group, Action, Log Entry.
Description
Use this field to add a description for an element.
This element property can be used under the following rules: Document, Header, Footer, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Set Variable, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List, Exit Repeating Group, Action, Log Entry.
Meta Title
Use this field to add the meta title of the document. The Meta Title field is mandatory for the document to be PDF/UA compliant.
This element property can be used under the Document rule.
Author
Use this field to add the name of the document creator.
This element property can be used under the Document rule.
Rotate Exported PDF
Use this field to set the rotation for the exported PDF. Select Disabled so that your PDF pages are not rotated in Accessibility Designer nor in the exported PDF. Select Auto Rotation to enable the rotation in Accessibility Designer without enabling the rotation in the exported PDF. Select Preserve Rotation to enable the rotation in both Accessibility Designer and exported PDF. The auto rotation is done per page and the text is rotated so that text is oriented horizontally from left to right.
This element property can be used under the Document rule.
Language
Use this field to set the language for an element that differs from other elements.
    Note:
  • The default value for the Language field is Not Set.
  • You can also set the language for the entire document if you select Document from the RULES section. On the right side of the screen, under Properties, go to the Language field and select one the available options.
This element property can be used under the following rules: Document, Paragraph, Heading, Link, Reference, Figure, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Label, Note.
You can also set the language as a variable by following these steps:
  • Go to the RULES panel on the left side of the screen.
  • Select a rule.
  • Right-click the rule and select Set Variable.
  • In the Set Variable panel enter a name for the variable, select String for Type and enter any IETF BCP 47 language tag, such as: "en" for English or "es" for Spanish.

  • Click ADD.
  • The new language variable is now displayed at the bottom of the language list in the Rules properties section on the right of the screen. You can easily identify the new language variable because it contains the "$" character in front of the name.

Setting Position and Size Coordinates
Use these input fields to manually set the X, Y, Width or Height Coordinates.
X is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the X value is used in the control file.
Y is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the Y value is used in the control file.
Width is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the Width value is used in the control file.
Height is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the Height value is used in the control file.

See Positioning Rules Graphic in the Workspace Area for more information.

This element property can be used under the following rules: Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List. Apart from the listed rules, X and Y can also be used under these rules: Anchor and Macro.
Use the Export As options to export position and size coordinates into the control file.
    Note:
  • The options for Export As for each coordinate are listed as created into the XML control file.
  • If you enabled the Set as default the last "Export As" values when creating new rules property as a rule preference when you edited your templates, each newly created rule will have the Export As values for X, Y, Width, Height copied from the most recent rule created with this setting enabled.
Alternative Text
Use this field to add an alternative text for all the rules mentioned below.
This element property can be used under the following rules: Paragraph, Heading, Link, Reference, Figure, Label, Note, Table Data, Row Header, Column Header.
    Note:
  • By default, the Text field contains the text content of the paragraph.
Title
Use this field to add a title for structure elements in the PDF document.
This element property can be used under the following rules: Document, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, List, List Item, List Item Body, Label, Note, Note List.
Summary
Use this field to add a summary in the PDF document.
This element property can be used under the Table rule.
Use metadata as alternative text
Check this option if you want to use the metadata from the PDF as alternative text for the image.
Note: This option is valid only for image type elements.
Text
When the TextType is set to Fixed, this value matches a fixed text within the defined rule region or area.
This element property can be used under the following rules: Paragraph, Heading, Link, Reference, Artifact, Table Data, Table Column Header, Table Row Header, Label, Note.
Text Type
Defines the method of matching text for a rule. You can select either Fixed or Regular Expression.
  • Fixed: To identify a fixed text value.
  • Regular Expression: To match a pattern to a given text.

The default regular expression option is .* that matches against any sequence of characters:

All regular expression options are available in the tool. For example, you can use the Regex option [...] to select a range of characters by specifying the first and last characters in the range.

When you specify the range [D-L]:

The text that matches this range is displayed as a matched element when you validate the PDF:

Recognize inline links
Use this option to automatically detect the links within the paragraph, list items, table data or header elements. You can use regular expressions to identify different types of links.

  • Https Regex
  • Explicit Regex
  • Email Regex
  • Phone Regex
This element property can be used under the following rules: Action, RepeatingGroup, Section, Region, Table, TableRow, List, ListItem, ListItemBody, EndNoteList, Document, Paragraph, Heading, Table Data, Table Column Header, Table Row Header, Note List.
Suppress if empty
Enable this option to not tag any empty elements when your rules are processed.

This element property can be used under the following rules: Paragraph, Heading, Link, Reference, Section, List, List Item, List Item Body, Label, Note, Note List.

[Join match ID]
Creates a single matched element output.
The two rules are joined by an ID that you set up in Join match ID, within the Properties and Macros sections:
Note: For example: this option can be used for a Table element that is continued from one page to another.

Once you mark the first Table element and set up the ID, you need to match the second Table element with the same ID. This can be done by manually writing or choosing it from the drop-down.

The Join match ID field also allows you to set up a variable value. Once the variable is added in RULES, it shows in the Join match ID section of the element, from where you can select it:
This element property can be used under the following rules: Paragraph, Table, Table Row, List, List Item.

For more information, see: Setting Variables.

Reference page
Indicates the page where the originating rule was defined.
This element property can be used under the following rules: Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List.
Font name
Specifies the font name by defining the visual identity of the content.
This element property can be used only under unmarked text.
Font style
Defines the visual appearance of the text by applying stylistic variations.
This element property can be used only under unmarked text.
Condition Result
Condition Result element property is read only. It is set to True or False depending on the branch type.
This element property can be used under the Action rule.
Row Span
Defines the number of rows on which the Table cell spans.
This element property can be used under the following rules: Table Data, Table Column Header, Table Row Header.
Column Span
Defines the number of columns on which the Table cell spans.
This element property can be used under the following rules: Table Data, Table Column Header, Table Row Header.
Page Break
Defines a row part of a table that spans over multiple pages.
This element property can be used under the Table Row rule.
Read Header
For a table that spans on multiple pages, if a row is present on the next page, this property defines if the row is processed.
This element property can be used under the Table Row rule.
Adjust Cell Cursor
Defines how the cursor is changed when a table cell is processed.
This element property can be used under the Table rule.
Variable Name
Defines the name of a variable.
This element property can be used under the Set Variable rule.
Variable Type
Defines the type of a variable.
This element property can be used under the Set Variable rule.
Variable Value
Defines the value of a variable.
This element property can be used under the Set Variable rule.
Macro Name
Defines the name of the macro definition used for a particular macro rule.
This element property can be used under the Macro rule.
Expression
Represents a summary read-only description of the condition expression.
This element property can be used under the Condition rule.
Artifact Type
Defines the type of content to be artifacted: text, image, or any.
This element property can be used under the Artifact rule.
Image Type
Defines the type of supported image: raster, vectorial, or any.
This element property can be used under the Figure rule.
Support Image Text
If the value is set, text images are supported and matched.
This element property can be used under the Figure rule.
Use Metadata as Alt Text
Select this option to use the metadata from the PDF as alternative text for the image.
This element property can be used under the Figure rule.
Small Text
Mark the superscript from the selected area as reference.
This element property can be used under the Reference rule.
Heading Level
Defines different heading levels.
This element property can be used under the Heading rule.
URI
Defines a text that represents a URL link.
This element property can be used under the Link rule.
Line Height
Splits the entire text into blocks that resemble lists.
This element property can be used under the Block List, Block Paragraphs, and Block End Note List rules.
List Item Regex
This regex value is used to check if a new list item begins.
This element property can be used under the Block Paragraphs and Block End Note List rules.
Note Regex
This regex value marks or tags the note part of a list item.
This element property can be used under the Block Paragraphs and Block End Note List rules.
Label Regex
This value marks or tags the label part of a list item.
This element property can be used under the Block Paragraphs and Block End Note List rules.
Single Line Regex
This regex value checks if a line should be processed as a single tagged item.
This element property can be used under the Block Paragraphs rule.
Single Line Contains
Fixed value text that checks if a line should be processed as a single tagged item.
This element property can be used under the Block End Note List rule.
Version
Defines a value used as the control file version.
This element property can be used under the Document rule.
Export
If the value is set, the logging rule is also exported in the control file.
This element property can be used under the Log Entry rule.
Log Entry
Text used for logging into the console for debugging purposes.
This element property can be used under the Log Entry rule.
Whitespace Recognition
Defines the space width in a PDF. Select either Revision 1 or Revision 2 according to your needs.
This element property can be used under the Document rule.
Actual Text
Specifies the intended reading content for screen readers. It improves accessibility by ensuring screen readers interpret and read the text correctly, regardless of how it appears visually in the PDF.
Use this field to add an actual text for all the rules mentioned below.
You can enter any custom text that you want.
You can use variables values: specified with a "$" character in front (example: $myVariable).
This element property can be used under the following rules: Paragraph, Heading, Note, Label, Reference, Link, Table Data, Row Header, Column Header.
Inline Actual Text
This property allows you to insert a short, accessible replacement text within the content of a tagged PDF element. It overrides the visible text for accessibility purposes ensuring better understanding. Once you enable this option, you will be able to use these options:
Matching regex that refers to a regular expression pattern that is used to identify specific text elements within the content.
Text to replace that specifies the replacement text that will be used when a matching regular expression pattern is found.
New actual text that defines the replacement text that is assigned as the updated text for a tagged element.
Bookmarks from headings
Specifies the option of generating PDF bookmarks automatically based on the document's heading structure. It helps you navigate the exported PDF efficiently using a hierarchical outline.
To see the bookmarks created from the headings in an exported PDF, first insert a Heading rule on a specific location, then select your Heading Level. This operation indicates the rank of importance of a heading within a document's structure.

1.9.2.1.5.5.1.1 Operators

You can choose the operator type for each coordinate prior to export the project.

Next Image X Position
Indicates the X position of the image.
Next Image Y Position
Indicates the Y position of the image.
Next Image Width
Indicates the width of the image.
Next Image Height
Indicates the height of the image.
Next Line X Position
Indicates the X position of a PDF matched line.
Next Line Y Position
Indicates the Y position of a PDF matched line.
Next Line Height
Indicates the height of a PDF matched line.
Next Line in Region Height
Indicates the height of the next line within the defined box.
Current Line Height
Indicates the height of a PDF matched current line.
Current Line in Region Height
Indicates the height of the current line within the defined box.
Current Line Y Position
Indicates the Y position of the current line on the PDF page.
Current Line in Region Y Position
Indicates the Y position of the current line within the defined box.
Cursor X
Indicates the current X coordinate of the cursor. Where cursor is the center of the last matched text element  within the page. 
Cursor Y
Indicates the current Y coordinate of the cursor. Where cursor is the center of the last matched text element  within the page. 
Get All Text in Region
Indicates all the text in the current region.
Get Next Row Y
Indicates the Y position of the next row on the PDF page based on existing horizontal lines. You can only use this input within a table.
Get Next Row Height
Indicates the height of the next row on the PDF page. You can only use this input within a table.
Line Before Cursor
Indicates the current line on the PDF page.
Line Before Cursor in Region
Indicates the current line within the defined box.
Line Before Cursor Y
Indicates the Y position of the current line on the PDF page.
Line Before Cursor in Region Y
Indicates the Y position of the current line within the defined box.
Replace First Regex
Indicates a string that replaces the first sub string that fits the specified regular expression. This function contains three String type parameters.
Replace Regex
Indicates a string that replaces the substring that fits the specified regular expression. This function contains three String type parameters.
String Trim
Indicates a string with removed whitespace from both ends.This function contains one String type parameter.
String Length
Indicates the length of a given string.This function contains one String type parameter.
Sub String
Indicates a sub string between a start index (inclusive, the 2nd parameter) and an end index (exclusive, the 3rd parameter) from a given string (the first parameter).
Note: This function allows to create custom mathematical expressions in the Expression Builder Box. The [Expressions] option can be used starting with the second operand drop-down. For more information see Customizing Mathematical Expressions.
Concatenate String
Indicates a new string containing two concatenated strings. This function contains two String type parameters.

1.9.2.1.5.5.2 Setting Coordinates to Position an Element

You can manually define the area of an element by entering X and Y coordinates and width and height values.

To set the element area:

  1. Select the target rule from the RULES list.
  2. To position the area on the page, enter coordinates in the X and Y input fields.
  3. To set the size of the area, enter width and height values in the Width and Height input fields.

Use , the Undo button, to revert the area settings. Use , the Redo button, to reapply the area settings.

1.9.2.1.5.5.2.1 Exporting Coordinates in the Control File

These export options are available:

Fixed
Position
X or Y are absolute values, calculated from the top-left corner of the page and measured in inches.
Size
Width and Height are absolute values, measured in inches.
Absent
X or Y or width height values are not exported in the XML file for the element.
    Note:
  • By definition of the control file, if a value is missing, the value of the parent is used. The top-most parent is the page.
Relative
X or Y values are relative to the parent of the element. So the X or Y values are calculated by adding the X and Y of the current document to the position of the parent element.

Values obtained from operations:

Takes the information from the next image (X or Y).
  • Next Image X Position
  • Next Image Y Position
Next Line Y Position
Takes the Y position of the Next Line.
Next Line in Region Y Position
Takes the Y position of the Next Line in Region.
    Note:
  • In region refers to the position and size of the parent element, usually a repeating group.
Current Line Y Position
Takes the Y position of the Current Line.
Current Line in Region Y Position
Takes the Y position of the Current Line in Region.

1.9.2.1.5.5.3 Adding Name and Description

You can edit PDF rules to add name and descriptions to help you navigate through the structure tree of the document.

Name
Specifies a user defined name for a given rule.
    Note:
  • If the name is set to a particular rule, it becomes the representative text displayed in the RULES view for that rule.
Description
Adds a description to the element.
    Note:
  • Make sure to close and reopen the document hierarchy to refresh the rules updates.
  • The rule description is not visible in the structure tree of the document.

1.9.2.1.5.5.4 Adding Alternative Text to Figures or Text Elements

Alternative text is associated with either a non-text element, like a figure, or a text element, like a paragraph, to provide the same essential information as the elements. The screen reader uses the text alternative accessibility requirement to render information on the meaning of the element content.
Alternative Text for Paragraphs
Indicates an additional text used to describe the function of a paragraph.
Alternative Text for Figures
Specifies the content and function of functional images for the screen reader to read the same information as the images to which it is attached.
Alternative Text for Table Data, Column Header, and Row Header
Specifies the content and function of functional images for the screen reader to read the same information as the images to which it is attached.

To add alternative text to a figure, a paragraph, a table data, column header, or row header:

  1. On the left side of the screen, go to RULES and select the matched figure, paragraph rule, table data, column header, or row header from the document hierarchy.
  2. Go to the PROPERTIES panel on the right side of the screen.
  3. In the Alternative Text field, enter descriptive alternative text for the image or the paragraph.
    Note: The Alternative Text field also lets you set up a variable value. To set up a variable value, make sure you Set Variable in RULES. Then manually add the variable name in the Alternative Text section of the element:

    For more information see: Setting Variables.

  4. To use the metadata text as alternative text for a figure, select the figure in the RULES panel on the left and select the Use metadata as alternative text check box.

1.9.2.1.5.6 Copying, Cutting, and Pasting Rules

You can copy, cut, and paste document element rules in the RULES and MACROS view.

To copy or cut document element rules:

  1. On the left side of the screen, in the RULES or MACROS view, select the rules that you want to copy or cut.
  2. Right-click the selection and select Copy or Cut:
  3. Right-click the region and select Paste:
  4. Choose between the options to paste Before, After or Into the selected rule.

    Note:
  • The name of a copied rule is Copy of initial_rule_name.
  • The rule names of cut elements are not changed.
  • Use Cut if you want to move the copied rule.
  • Use Copy if you want to paste the selected rule multiple times.
  • When pasting, the rule page is set to the current PDF page.

1.9.2.1.5.7 Deleting Rules

You can delete rules from the workspace area.

To delete a rule:

  1. Select the rule to delete from the RULES or MACROS view, located on the left side of the screen.
  2. In the menu bar, click Edit.
  3. On the Objects section, click , the delete button.
      Note:
    • You can also select the matched rule from the workspace view and click , the delete button.
    • You can also delete rules in the macro view panel when editing macro definitions.

    Rules can be deleted at any time. However, you can delete one rule at a time.

    Deleting a header rule removes its associated element rules from the logical structure of the tagged PDF document.

    To update the Validate PDF window information after removing a rule from the structure hierarchy, click , the Refresh button.

    To undo a delete action, click , the Undo button.

1.9.2.1.5.8 Adding Breakpoints

RICOH Accessibility Designer allows you to customize the breakpoints for your rules so that the validation is temporarily stopped at that specific point. The breakpoints are used in the debugging process to identify the elements that are not matched correctly.

To add breakpoints:

  1. Go to RULES or MACROS view, located on the left side of the screen.
  2. Select a rule and from the right-click menu select Debugging ⇒ Add breakpoint.

    A red circle will be attached next to the property where you added the breakpoints.
    Note:
  • You can also add breakpoints to rules in the macro view panel when editing macro definitions.

You can also verify your list of breakpoints by clicking the breakpoints icon, , located next to RULES.

A breakpoints panel is displayed and you can see all the breakpoints that you created. You can perform multiple actions from this panel. You can enable or disable one or more breakpoints or you can remove them.

1.9.2.1.5.9 Filtering Rules

RICOH Accessibility Designer helps you organize your rules efficiently and allows you to display your search results depending on your filters.

You can control your search results directly from the RULES section, using the Filters dialog, or using the Advanced filtering option from the Filters dialog. You can use all these rule filtering options simultaneously. When you apply a filter, only rules that meet the specified criteria are displayed.

To filter rules:

  1. Go to RULES, located on the left side of the screen.
  2. In the search field, enter the content that you want to find.

  3. The list displays the search results.

    This search is not case sensitive and all possible results are displayed as you start entering the content that you want to find.

    The RULES list displays all the rules that result from your searches, but if you want to return to the RULES tree view, click Clear all.
  4. Click , the Filters button.

  5. Use the toggle button Enable/Disable rule to enable or disable advanced filters.
  6. Select one or more rule types from the advanced filter dialog and click Apply.

    If you do not select any rule type, the entire list of rules is displayed.

Your filtering results is displayed in the RULES section.
Note: You cannot drag and drop rules from the filtered list of rules.

1.9.2.1.5.10 Configuring Advanced Filtering Criteria

RICOH Accessibility Designer allows you to find one or more rules where the property value matches the regular expression that you enter.

To define advanced filtering criteria:

  1. Click RULES ⇒ Filters ⇒ Advanced filtering.
  2. Select a Rule property, then enter a regular expression in the Matches Regex field.
  3. Click +Add.
  4. Click OK.
    If you want to delete a filter, click , the Delete button, next to the newly created filter. To delete all the filters at the same time, click Clear all in the upper right corner of the panel.
  5. Click OK to save your changes or CANCEL to continue your advanced filtering configuration.
    Note: If the searching algorithm finds a rules that complies with the filtering criteria, it does not continue to search in the substructure of that rule. For example, if a table is matching the filtering conditions, the algorithm does not search in the table rows and the search result will be the table with its substructure.

1.9.2.1.5.11 Adding Log Entries

You can set up a log entry to generate enhanced debugging information for your project.
To add a log entry:
  1. Go to the RULES view on the left side of the screen.
  2. Right click on a container rule.
  3. Select Add Log Entry from the list:
  4. Enter a string as a description for the log entry in the Add Log Entry dialog:
  5. Click Add to add the log entry and close the Add Log Entry dialog.
    Once you set up the log entry, the output is displayed in the LOGGING INFORMATION from the Validation Window.
  6. For complex debugging cases, you can define variables to be added to the log entry:
    1. Right click on Document.
    2. Select Set Variable to add variable.
  7. Add the variable to the log entry by editing the field.
  8. To show the logging information in the control file, check the [Export] option from Rules properties.
  9. You can also see your logging information in the validation window when you validate your PDF.
The log string can consist of:
  • Any custom text that you want.
  • Variables values: specified with a "$" character in front (example: $myVariable).
  • Variables with detailed info: specified with a "%$" string in front (example: %$myVariable).
  • Special built in variables: current element box with "%box", the current cursor with "%cur" or the entire environment set of variables with "%printenv" (equivalent of <PrintEnv>).
  • Any mathematical expression using the <Expr>...</Expr> tags .

1.9.2.1.5.12 Adding and Exiting a Repeating Group

In a repeating environment where your PDF workflow does not change often, you can set up a repeating structure rule and disable it once you no longer need it. A logical repeating group is used when a set of rules must be executed multiple times based on a dynamic list of items rather than a fixed number of iterations. Instead of repeating the same logic manually, a logical repeating group evaluates a collection and automatically applies the rule sequence to each element in that collection.

The Repeating Group defines a logical rule that allows repeating processing of contained rules as long as the position of the cursor is not altered. The cursor not being modified is the only exit criteria from the repeating group unless the Exit Repeating Group rule is used in the logic of the rules contained in the Repeating Group.

You can exit the Repeating Group if the position of the cursor is not modified or if you use the Exit Repeating Group option.

  1. To create a Repeating Group go to the RULES view on the left side of the screen.
  2. Create the rules that apply to your use case and click Insert ⇒ Repeating Group.
    The rule will repeat for all the elements that are displayed under the Repeating Group listed in the RULES section on the left side of the screen as long as you do not change the position of your cursor.
  3. To use ExitRepeatingGroup, select a Repeating Group child rule, right-click and choose Add Exit Repeating Group from the menu.
  4. The Exit Repeating Group selection applies to the closest parent Repeating Group.

1.9.2.1.5.13 Automatic Rule Creation

RICOH Accessibility Designer includes a feature that automatically generates rules from the content of the currently open PDF, reducing the amount of manual rule creation.

To access automatic rule creation, click Autodetect rules on the menu bar.

Important: Automatic rule creation is still under development. Review its limitations carefully before you rely on the generated rules.

Supported rules

Automatic rule creation currently supports only these rules: Paragraph, Heading, Block Paragraphs, Figure (raster and vectorial), and Table with its child rules Table Row, Table Data, Column Header, and Row Header. Other rules are not yet supported.

Rule organization

All generated rules for a page are placed in a Condition rule named Page followed by the page number, for example Page 3. Every page condition rule is placed inside a Region rule named Autodetect followed by a sequential count, for example Autodetect 1.

Reading order

Rules on a page are sorted top to bottom by Y position. Rules that fall on the same line, meaning they have close Y positions, are then sorted left to right by X position. This order might not match the intended reading order. Verify the reading order and reorder rules if needed.

Position and size values

Every generated rule has Export As set to Fixed for X, Y, width, and height. The root Region rule has these values set to Absent. As a result, if a page contains variable-length content, for example paragraphs or tables, the rules that follow that content might be positioned incorrectly on other documents. Adjust these positions manually.

Images
  • Vectorial lines, based on maximum X/Y size, do not generate rules.
  • Raster images with overlapping centers are merged into a single Figure rule.
  • Intersecting raster images are merged into a single Figure rule when the overlapping area exceeds the configured X/Y tolerance.
Tables

Tables are generated first using the vectorial algorithm, based on line intersections, and then using the table-text detection algorithm. Depending on the drawing style, some tables might not be recognized correctly.

Table-text detection requires every cell in the table to contain text. Empty cells prevent recognition, and in some cases non-table text might be misidentified as a table.

A table is generated only when both the row count and column count are 2 or greater. The first row becomes Column Header cells. The remaining rows become Table Data cells.

Table-text detection identifies consecutive rows whose cell centers are aligned on the Y axis, within a configured tolerance.

Headings and alternative text

Only bold text chunks are detected as Heading rules. The feature does not set a heading level. Correct heading levels manually.

The feature does not generate alternative text for any rule. Make sure you add alternative text to figures, including logos or text-only images, since the feature cannot recognize text or meaning within an image.

Text detection

Text items on a page are merged into text chunks by proximity and font-size tolerance. These chunks are used for Paragraph, Heading, Table Data, and Block Paragraphs rules.

Processing scope and behavior
  • Detection priority: tables using vectorial lines, tables using tabular text, Block Paragraphs, Paragraph and Heading, raster images, vectorial images.
  • Pages with no text, image, or vectorial content do not get a generated Condition rule.
  • Each page is processed independently. The feature does not reuse structures detected on other pages.
  • The feature processes only the currently open PDF.
  • Running automatic rule creation regenerates rules for the entire document each time. It does not account for existing rules or previously matched items. Delete rules from a previous run if you no longer need them.
  • Rotated text, rotated content, or a rotated page is not supported.
Keyboard shortcut

The Autodetect rules option has no keyboard shortcut and cannot be configured in the application settings.

1.9.2.1.6 Configuring

This section explains how to configure your application, such as setting styles and creating or customizing new themes.

1.9.2.1.6.1 Styling

1.9.2.1.6.1.1 Customizing rule settings

Ricoh Accessibility Designer lets you customize your rules and create rule templates for better management of your data. You can define the default properties of rules when they are created and inserted into the project in the Rule Settings section.
To customize your rules and create rule templates:
  1. 1. Click the Edit tab from the Menu bar.
  2. Go to Application settings.

  3. Under the Rule Settings tab, you can create your templates by clicking +Create template .
    The newly created template is displayed in the Templates column.
  4. To edit an existing template, select the template and click . You can rename templates and customize rule properties from the corresponding tables, then click and SAVE.
  5. To ease your user experience, select a template from Templates, click and enable the Set as default the last "Export As" values when creating new rules property as a rule preference. Each newly created rule will have the Export As values for X, Y, Width, Height copied from the most recent rule created with this setting enabled.
    To revert to initial rule settings for a template, select the template and click Restore to default and SAVE. All the rule properties are set to the default values.
  6. To enable a template, right-click the template and select Apply from the menu.
    appears in front of your template. This means that your template is active. You cannot use several templates simultaneously. When you create a new rule, it will be attributed with the properties from the applied template.
  7. To duplicate or delete a template, right-click the template and select Duplicate or Delete from the menu, then click SAVE.
    All your templates are saved in C:\ProgramData\Rad\rules as XML files. For example: Rules (default).xml.
    To see the active template, go to rules_config.xml in C:\ProgramData\Rad.

    Note: When you create a new rule, the default values for x,y,width height are overwritten in rule settings. When you create a table with table builder, the rule properties x,y,width, height and export as: x,y,width height from the children rules are overwritten by the algorithm that defines the table.

1.9.2.1.6.1.2 Creating Styles

You can apply different styles to your rules and items. Use the existing themes or create your own customized theme. A customized theme is used as a default styling for all the rules.
To configure the styling settings:
  1. 1. Click the Edit tab from the Menu bar.
  2. Go to Application settings.

  3. Under the Application styling tab, you can customize the item fill color, border/selected color and transparency for the rules, matched and unmatched items.

    Once you save your changes and apply the theme, the changes are visible in your document. For example, the image below shows the customized color for the background.

    Note: This is a general customization for all the rules. If you wish to customize each rule separately, follow the steps from the Styling themes section below.
    You can return to the default settings by clicking Restore to default ⇒ Save.

1.9.2.1.6.1.3 Creating or Editing Themes

You can configure each rule individually and select the style of their graphical representation on the user interface. You can define how each rule behaves in the graphical view mode.
To customize your rules:
  1. Go to the Menu bar and click the Edit tab.
  2. Go to Application Settings and then click the Styling themes tab.

  3. Click Create theme to create a new theme.
  4. If you already have an existing theme, click , the Editicon, to customize it.

  5. To see the rules, go to Rules styling tab.
  6. Right-click each rule to customize a rule, such as fill color, border color, or fill transparency. The rule you are editing will be highlighted in order to better view your selection.

    In the lower left corner, you can see the styling preview for each status of the rule, once you complete the customization.

  7. Click Save.
  8. From the Styling theme section, select the theme and click Apply theme.

    The theme in use is marked with a blue dot. The changes are applied to the current document.

    Note: You can take further actions within the Styling theme section. For example you can delete a theme, restore the theme to the default one, or duplicate a theme.

1.9.2.1.6.2 Keyboard Shortcut Keys

You can use these keyboard shortcut keys to perform various operations:

File tab:

Description Shortcut keys
New Ctrl + N
Open Ctrl + O
Save Ctrl + S
Save as Ctrl + Alt + S
Close Ctrl + W
Add PDF Ctrl + Alt + P
Add folder Ctrl + Alt + Shift + P
Add Macro Ctrl + Alt + M
Export control file Ctrl + E
Export single PDF Ctrl + Shift + E
Export batch PDF Ctrl + Shift + B

Edit Tab:

Description Shortcut keys
Undo Ctrl + Z
Redo Ctrl + Y
Delete Del

Insert Tab:

Description Shortcut keys
Add Header H
Add Footer F
Add Paragraph P
Add Reference Ctrl + Shift + R
Add Heading ;
Add Link L
Add Block End Note List Ctrl + Alt + N
Add Block List Ctrl + Alt + B
Add BlockLines B
Add BlockParagraphs [
Add Figure ]
Add Artifact A
Add Region R
Add RepeatingGroup G
Add Condition C
Add Anchor W
Add Macro rule M
Add Set Variable (no outline) S
Add List Q
Add List E
Add List Item Body Y
Add Label U
Add List Item group I
Add Note List O
Add Note N
Add standard Table T
Add manual Table K
Add Table Data D
Add Table Row J
Add Column Header Z
Add Row Header X

Navigation Toolbar:

Description Shortcut keys
Show/Hide ruler Ctrl + R
Show/Hide floating pane Ctrl + F
Zoom in
Ctrl + Numpad +
Zoom out
Ctrl + Numpad - 
Fit width Alt + W
Fit page Alt + Shift + W
Next page Ctrl + Right Arrow
Previous page Ctrl + Left Arrow
Validate single PDF F5
Validate multi PDF F6

Application:

Description Shortcut keys
Help F1
About Ctrl + A
Minimize
Ctrl + Shift + Numpad +
Maximize
Ctrl + Shift + Numpad -
Close Shift + ESC

Rules View:

Description Shortcut keys
Add Breakpoint Ctrl + F9
Add Set Variable (outline) S
Clear All Filter Alt + Shift + F
Copy Ctrl + C
Cut Ctrl + X
Paste Ctrl + V
Paste Rule After Ctrl + Alt + V
Paste Rule Before Ctrl + Alt + Shift + V
Rename variable Alt + Shift + R
Enable/Disable rule Alt + E
Show/Hide rule Alt + O
Export to Ctrl + Shift + C
Create macro Ctrl + M
Edit variable Ctrl + Alt + R
Add Set Variable (outline) S
Edit condition Ctrl + Alt + C
Show/hide rules filter Ctrl + Alt + Shift + F
Show/Hide all rules Alt + S
Toggle Enable Breakpoint F9

Macros View:

Description Shortcut keys
Export macro Ctrl + Alt + E
Move macro Ctrl + Shift + M
Edit macro Ctrl + Shift + Alt + E
Delete macro definition Backspace
Show macro file settings Ctrl + Shift + S
Remove macro file Ctrl + Shift + Alt + U

Files View:

Description Shortcut keys
Relink PDF Ctrl + Alt + F
Relink PDF from folder Ctrl + Shift + F
Show PDF settings Alt + Shift + S
Remove PDF Ctrl + Shift + U

Validation Window:

Description Shortcut keys
Show/Hide matched elements Ctrl + 1
Show/Hide unmatched elements Ctrl + 2
Toggle Show Vectorial Images Alt + Shift + V

Validation Debugging:

Description Shortcut keys
Continue Ctrl + F11
Step into F8
Step over Shift+F8
Stop Shift+F11

1.9.2.1.6.2.1 Customizing the Keyboard Shortcut Keys

If you want to use other keyboard shortcut keys than the default shortcuts keys, you can customize the combination of keys for a particular operation. You can also enable or disable one or more keyboard shortcut keys.
To customize a shortcut key:
  1. Go to the Edit tab from the Menu bar.
  2. Go to Application Settings and click Keyboard customization.
  3. Select a tab or a view from the left navigation pane.
  4. Select a shortcut key that you want to customize and click , the Editicon.
  5. Enter a combination of keys for the selected operation.
  6. To reset one or more shortcut keys to the default settings, make sure that only the shortcuts you want to reset are checked and click Reset selected.
  7. To reset all shortcut keys to the default settings, click Restore to default.
  8. Click Save.

1.9.2.1.7 Working with Macro Files

You can import a macro file located on your computer to an existing project. A macro definitions list is an XML file that stores rules to be used multiple times within the same control file or a different control file.

To import a macro file into a project:

  1. On the menu bar, go to File.
  2. In the Files section, click , the Add Macro icon.
  3. In the Add Macro dialog box, browse for the macro file that you want to add, select it, and click Open.

or

You can also add macro files by clicking , located at the top of the MACROS section, on the right side.

See Macros for more information.

1.9.2.1.7.1 Adding Macro Rules to the Project

To add macro rules to a project:
  1. Go to the Insert tab and select Macro from the Structure category to insert macros into the project.
  2. Select the content area to define a rectangular or square region.
  3. Edit the properties from the Insert Macro Rule dialog.
    Insert Macro
    The MACROS LIST from the left side of the dialog box displays the macro definitions list from the imported macro XML, while the PROPERTIES section of the dialog lets you configure the properties for each macro definition.

To configure a macro definition property:

  1. On the left side of the dialog box, in the MACROS LIST section, browse for the macro definition you want to add and select it.
  2. Edit the property for the macro rule.

    The properties on the left side of the PROPERTIES section, Macro ID, Name, and Description, are available for all macro definitions, while the properties on the right side change, based on the macro definition you select.

    • Macro ID: read-only field.
        Note:
      • Macro ID is filled automatically, based on the macro definition you select.
    • Name: optional field.
    • Description: optional field.
        Note:
      • The Name and Description information is not displayed into the control file.

  3. Click INSERT.

Macro Rules

After you add macro rules to the project, you can access them from the RULES section.Macro Rules

    Note:
  • To move a macro rule to a new rule location, you can drag and drop the macro rule.
  • You can also select multiple rules and then add the macro rule to the selected rules.
  • Multiple macro rules can be added under the same rule.
  • To move a macro rule under another rule, select the macro rule and drag and drop it to the new location.

1.9.2.1.7.1.1 Editing Macro Definition Properties

You can edit macro definition properties, once the macro definition was created, by using the PROPERTIES section on the right side of the screen.

The PROPERTIES section displays the same customized information as the Insert Macro Rule dialog.Macro Properties

Read-only fields:

  • Class Type: sets automatically on Macro Definition.
  • Macro Name: inherits the macro definition name selected on the Insert Macro Rule dialog.

    Note:
  • Macro properties list may vary depending on the macro definition.

You can also edit macro definition properties by following these steps:

  1. On the left side of the dialog box, in the MACROS LIST section, browse for the macro definition you want to edit.
  2. Right-click the macro definition and choose Edit.
  3. If you change one of the parameters in the macro you have the possibility of applying this change to all the rules that use that particular macro by enabling the option Apply changes to all rules that use this macro.

1.9.2.1.7.2 Creating Macro Definitions

The Create Macro Definition dialog allows you to manually create macro definitions for specific rules.
To create macro definitions:
  1. Go to the RULES panel and select the rule you want to apply macro definitions to.
      Note:
    • To select multiple rules, hold the Ctrl key and click each rule that you want to select.
  2. Right click on the rules and select the option Create Macro Definition from the list.Create Macro Definition
  3. Edit the Create Macro Definition dialog.
    SignatureSignature
    In the OPTIONS section, enter a display name for the macro definition into the Name field. Enter up to 64 characters.
    • If no name is added, you are prompted to add a name before you can create the macro definition.
    • If you enter the same name as one of the existing macro definitions, you are prompted to select a different name as the current name is already in use.
        Note:
      • The name for the macro definition is displayed into the Macro Rules section, located on the right side of the screen. See Macros for more information.
    In the PARAMETERS section, click +Create parameter to customize parameter names. Enter up to 64 characters.

    The resulting parameters are displayed in the PARAMETERS field on the right side of the screen. To edit a parameter, select it and click , then you can save your changes by clicking . To delete your changes, click . Also, you can delete a parameter by selecting it and clicking .

    Note: If you rename a parameter, the change will apply to all the macro rules that use that parameter.

    If you delete a parameter, it will be deleted from all the macro rules where it was assigned.

    StructureStructure

    Add to Macro Rules: moves a rule from the RULES section to the Macro Rules section.

    You can also move a rule from the RULES section to the Macro Rules section by using the Add to Macro Rules option from the right-click menu. You can move a rule several times depending on your needs.

    Remove from Macro Rules: deletes a rule from the Macro Rules list.

    You can also delete a rule from the Macro Rules section by using the Remove from Macro Rules option from the right-click menu.

    The right-click menu also allows you to enable or disable a rule.

    Select the rule for the macro definition from the RULES section.
    • If you select a parent rule to create a macro definition, the parent rule and all the children are automatically moved into the RULES section.

      Selection from the RULES section, located on the left side of the screen
      Display on the RULES section from Create Macro Definition dialog
    • If you select both parent rule and children, the RULES section will display the parent rule together with the children hierarchy, and the children selected.

      Selection from the RULES section, located on the left side of the screen
      Display on the RULES section from Create Macro Definition dialog
      RULES

    The selected rule name matches the Name field from the PROPERTIES section.

    PropertiesProperties
    Configure the Assign to parameter options from the PROPERTIES section.
      Note:
    • The list of properties may vary depending on the properties of the selected rule.
    • The left side properties from the PROPERTIES section are read only.

    To use a macro parameter inside a condition, use $$ followed by the parameter name.

    To use a variable inside a condition, use $ followed by the variable name.

    To save all changes click SAVE.

1.9.2.1.7.2.1 Editing Macro Definitions

You can edit the parameters and properties for macro definitions.

Edit Macro Definition

To edit a macro definition:

  1. On the Created section, hover over the macro definition you want to edit.
  2. Right-click the macro definition and select Edit from the menu to edit parameters and properties.

    Edit Macro Definition

    See Creating Macro Definitions for more information on macro definition parameters and properties.

  3. Click SAVE.

1.9.2.1.7.2.2 Deleting Macro Definitions

You can remove macro definitions from the Created section.

Delete Macro Definition

To delete a macro definition:

  1. On the Created section, hover over the macro definition you want to delete.
  2. Right-click the macro definition and select Delete from the menu.

    You see a warning message.

  3. Click OK.

    The selected macro definition is deleted from the Created section.

    Note:
  • After you remove the macro definition, you can no longer use the deleted macro definition to create new macros.
  • All the macro rules created using that macro definition will not function correctly.

    When you delete a macro definition referenced in a macro rule, you are prompted with a warning message when validating the PDF.

1.9.2.1.7.2.3 Moving Macro Definitions

  1. On the Created section, hover over the macro definition you want to move.
  2. Right-click the macro definition and select Move to.Move To
      Note:
    • You can select multiple macro definitions prior to saving them.
  3. In the Save Macro File dialog box, browse and select a location from the left pane, and click Save.
    The macro definition file is automatically moves under Imported, together with all the macro definitions.

1.9.2.1.7.2.4 Exporting Macro Definitions

    Note:
  • This function is disabled in trial mode. Install a permanent license to enable export functions.
  1. On the Created section, hover over the macro definition you want to export.
  2. Right-click the macro definition and select Export to.Export To
      Note:
    • You can select multiple macro definitions to be exported within the same macro definitions file.
  3. In the Export Macro File dialog box, browse and select a location from the left pane, and click Save.

1.9.2.1.7.2.5 Exporting Macro Parameters

Use macro definition parameters as Export As coordinate values for rules in that macro.

When you create parameters on the Signature tab of the Create Macro Definition dialog, those parameters become available in the Export As dropdown lists on the Properties tab. The parameters are displayed with a $$ prefix (for example, $$xPos). This lets you assign dynamic, parameter-driven values to the X, Y, Width, or Height coordinates of rules within the macro definition.

  1. Go to the RULES section and select the rules you want to include in the macro definition.
  2. Right-click the selection and select Create Macro Definition.
    The Create Macro Definition dialog opens.
  3. On the Signature tab, enter a name for the macro definition in the Name field.
  4. In the PARAMETERS section, click +Create parameter and enter a parameter name for each coordinate value you want to make dynamic (for example, xPos, yPos).
  5. Click the Properties tab.
  6. In the RULES section of the dialog, select the rule whose coordinates you want to configure.
  7. In the PROPERTIES section, click the Export As list for the coordinate you want to assign ( X, Y, Width, or Height).
  8. Select the macro parameter from the list.

    Parameters created on the Signature tab appear in the dropdown with a $$ prefix. For example, a parameter named xPos appears as $$xPos.

  9. Click CREATE.
    The macro definition is saved. The Export As values assigned to the rules are visible in the PROPERTIES panel on the right side of the main interface.
When you export the project as a control file, the rule coordinates use the macro parameter values instead of fixed positions. This allows the same macro definition to be reused with different coordinate values across multiple macro rules.
    Note:
  • You can also select macro parameters from the Export As list in the PROPERTIES panel when a macro rule is selected.

1.9.2.1.7.3 Validating Macros

Macros are not listed into the Validate PDF window, as the validation checks only for PDF elements. However, the validation displays a name replacement based on the macro name from the PROPERTIES section.

Validate PDF

For more details about the PDF validation, see Validating PDF.

1.9.2.1.8 Tutorials

1.9.2.1.8.1 Creating a Macro Rule

This tutorial provides step-by-step instructions that you can follow to better understand the functions of macros.

Functions used in this tutorial:

  • Create a new project
  • Add a PDF file
  • Add folder
  • Add a macro definitions file
  • Create a macro rule
  • Edit the macro rule properties
  • Delete a macro rule
  • Validate a macro rule

1. Create a new project
In this step, you will create the new project you want to use.
  1. Go to the File tab.
  2. To create a new project, select New from the Project section. To open an existing project, select Open.

The default project name generated by the system is Project 1.

2. Add a PDF file or a folder
In this step, you will insert the PDF file or folder into the project you created.
  1. Go to the File tab.
  2. Select Add PDF or Add folder to add a PDF file or a folder to the project.
  3. In the Add PDF or Add PDF folder dialog box, browse for the PDF file or folder that you want to add, and then click Open or Select Folder.

    The list of PDF files and folders is displayed into the FILES section, on the left side of the screen.FILES

3. Add a macro definitions file
In this step, you will add a macro XML definitions file to the project.
  1. Go to the File tab.
  2. Select Add Macro to add a macro file to the project.
  3. In the Add Macro dialog box, browse for the macro definitions file that you want to add, and then click Open.

    The structure of the macro definitions file is displayed into the MACROS section, on the left side of the screen.MACROS

4. Create a macro rule
In this step, you will create a macro rule.
  1. Select the content area to define a rectangular or square region.
  2. Go to the Insert tab and select Macro from the Structure category to insert macros into the project.
  3. In the Insert Macro Rule dialog box, select the macro definition from the MACROS LIST on the left side of the dialog box.
  4. Configure macro properties for the selected macro definition and click INSERT.
      Note:
    • The macro definitions list may vary depending on the information included in the macro XML file.
    Insert Macro

For more information on macro definitions, see the topic Macros.

5. Edit macro rule properties
In this step, you will adjust the properties for macros already created.
  1. Select the macro rule from the RULES section on the left side of the screen.
  2. Go to the PROPERTIES section to edit macro properties.Macro Properties

For more information on macro properties, see Editing Macro Definition Properties.

6. Validate a macro rule
In this step, you will validate the entire PDF document to check for any matched or unmatched macros.
  1. Go to the Review tab.
  2. Select Validate PDF from the Actions structure. A separate dialog box opens for validation results.

For more information on PDF validation, see Validating Macros.

1.9.2.1.9 Validating PDF

The Validate PDF window allows you to check whether all PDF elements have been matched.

Toolbar
Available review options are displayed on the toolbar. These options are available:
  • Search/Filter

    Toggles between search and filter content functions. The default option is Search.

  • Filter figure

    Shows only figure matched elements.

  • Filter text

    Shows only text matched elements.

  • Filter matched elements

    Shows only the elements matched on the PDF document. Matched elements are highlighted in green.

  • Vector image

    Shows or hides vector images in the Unmatched section.

  • The filter field allows you to find relevant information or narrow down results. The results are displayed in the Matched or Unmatched lists. The filtering is not case sensitive and all possible results are displayed as you start entering the content that you want to find.

  • In the search field, enter the content that you want to find. You can search for particular words from your PDF file. The results are displayed in the Matched or Unmatched lists and you can scroll up and down using the navigation arrows. The first matching element is selected and you can use the navigation arrows to select the next or the previous element that matches the entered pattern. This search is not case sensitive.

    Note: Search/Filter option applies only to the Matched and Unmatched sections.
  • ACCESSIBILITY REPORT

    Displays the ACCESSIBILITY REPORT section in the Review panel.

    • Important:
    • The PROPERTIES related to any matched on unmatched elements from the Validate PDF window are read only.
    • Macros are not listed into the validation window.
  • Filter unmatched elements

    Shows only the elements unmatched on the PDF document. Unmatched elements are highlighted in red.

      Note:
    • By default, the Filter matched elements and Filter unmatched elements buttons are enabled.

  • Refresh button

    Updates the Validate PDF view with the most recent changes.

  • Last update

    Shows the time of the latest update.

Review area
The Validate PDF review area is divided into 2 sections:
Matched
Displays matched elements.
    Note:
  • Repeating Group, Condition, and Anchor are not shown in the review panel.
Unmatched
Displays only text and figure unmatched elements.

To check if a specific element is matched on unmatched:

  1. Go to the Matched or Unmatched section.
  2. Click on the element.

    Matched element is highlighted in dark green when clicked, while unmatched element becomes dark red.

ACCESSIBILITY REPORT
The accessibility report displays if your PDF is PDF/Universal Accessibility compliant. If your PDF is not PDF/Universal Accessibility compliant, the validator generates warnings that can refer to specific indexes from the PDF associations Matterhorn Protocol 1.1. Click one of the warnings that are displayed in the ACCESSIBILITY REPORT to find the rule that generates that error.

Click Save to save the generated report and to see all the warning details.

LOGGING INFORMATION
You can use the logging information option for debugging. You can see your logging information in the validation window when you validate your PDF only after adding a log entry on a rule that allows you to use this option. For more information on adding a log entry and editing element properties for rules, go to Adding Log Entries and Element Properties.

    Important:
  • The Validate PDF window displays matched or unmatched elements from all PDF pages.
  • Multiple PDF file validation is not supported.

1.9.2.1.9.1 Single PDF Validation

To validate the content of a PDF document:
  1. On the toolbar, click , the Single PDF validate icon.
    The review options and results are available in a separate review panel.
See Validating PDF for more information on PDF content review.

1.9.2.1.9.2 Multiple PDF Validation

    Note:
  • Validation is disabled in trial mode because it saves a control file to disk.
To validate the content of multiple PDF documents:
  1. Select the PDF files for review from the FILES section, on the left side of the screen. For multiple selection of PDF files, hold the Ctrl key and select the files from the list.
      Note:
    • Make sure to select at least one PDF file prior to batch validation. Otherwise, you are prompted with a validation failed error.
  2. On the toolbar, click , the Multiple PDF review icon.
    You can also select Batch Validation from the drop down list, after selecting the PDF files to be validated from the FILES section.
  3. Customize the options from the Batch Validation dialog.
    The VALIDATION section displays selected PDF files prior validation.
    • To remove a PDF file from the validation list, select the file and click on Remove from validation, at the bottom of the VALIDATION section.

      For multiple PDF files removal, hold the Ctrl key, select the files from the list and click on Remove from validation.

      Batch Validation
    • To add additional PDF files from the project to the VALIDATION section:
      1. Click , on the right corner of the section.
      2. Select the PDF file from the FILES list and click on Add to validation, at the bottom of the section. If your PDF files are available in a folder, you can expand the folder and select the PDF files that are available inside the folder.

        For multiple selection of PDF files, hold the Ctrl key and select the files from the list.

        The files are automatically moved into the PROGRESS section.

      Batch Validation
    Available options:
    FILES
    Indicates the selected PDF file for review.
    OPTIONS
    Save To: Indicates the directory path of the report file. The default directory is a system folder used to store temporary files.
    Note: When running Batch Validation, RICOH Accessibility Designer will remember the last save location directory.
    Select File Format: Indicates the format of the report file, either with the .txt or the .dat extension file.
    Close dialog automatically after completing validation: Indicates that the Batch Validation dialog closes automatically once the validation process is finalized.
    Generate individual reports: Indicates that individual reports are generated for each PDF validation.
      Note:
    • If this option is not selected, a single report will be generated for all PDF files.
    Generate accessibility report:An accessibility report where it is specified if your document is a PDF/Universal Accessibility compliant file is added to the validation report.
    PROGRESS
    Indicates the progress of the selected PDF files to be validated.
      Note:
    • By default, the PROGRESS section is loaded with the selected PDF file from the FILES section, on the left side of the graphical user interface.
    • To remove any PDF files from the PROGRESS list, click on Remove from validation, at the bottom of the FILES section.

    Progress statusProgress status

    Progress status:
    • Validation Complete - Indicates that the validation process was successfully completed.
    • Validation Failed - Indicates that the validation process failed due to PDF errors.
    • Validation Canceled- Indicates that the validation process was stopped by the user.
      Note:
    • Individual reports with validation results are generated, regardless the progress status of the validation.
    • If Generate individual reports is not selected, a report for all validated PDF files will be generated.
  4. Click START.

1.9.2.1.9.3 Debugging PDF Elements

The sequential validation option lets you debug the elements in a document at rule execution level. You can either debug the entire document or insert breakpoints for the rules so that the validation is temporarily stopped at that specific point. The breakpoints are used in the debugging process to identify the elements that are not matched correctly.
To run a sequential validation and debug the document:
  1. Right-click an element where you want to insert a breakpoint and select Debugging ⇒ Add breakpoint
    When an element has an active breakpoint, it is matched with , a red circle icon.
  2. To disable a breakpoint, right-click an element that contains an active breakpoint and select Debugging ⇒ Disable breakpoint.
    When an element has a disabled breakpoint, it is matched with , a gray circle icon.
  3. Click , the Debug Preview icon to start debugging the matched elements.

    The validation stops at the first element matched with a breakpoint and the review panel is displayed.

  4. In the review panel, go to DEBUGGING to see information about the matched element.
  5. To execute all the rules until the next breakpoint, click , the Next/ Run icon.
    If execution is finished for a page, the process continues on the next page. 
  6. To execute all the rules until the next child rule or subsequent rule, click , Step Into icon.
    If execution is finished for a page, the process continues on the next page. 
    Example: When a breakpoint is set on a table, the Step Into option executes until first row, then it goes to the first cell, and then the second cell, if there is no child in first cell.
  7. To execute all the rules until the next subsequent rule, click , the Step Over icon.
    If execution is finished for a page, the process continues on the next page. 
    Example: When a breakpoint is set on a row, clicking Step Over executes until next row, then it goes to the next row, and so on. 
  8. To stop the debugging process, click , the Terminate icon.

1.9.2.1.9.4 Identifying Rule Errors

This feature highlights the rules errors occurred after the validation process completion.

To identify rule issues:

  1. Make sure you first validate the PDF file. See Validating PDF for validation steps.

    A Validation failed dialog is displayed to underline the items and a short summary to help you solve them.

  2. To open the rule , go to the RULES section and select the rule highlighted with , the error icon.
  3. Click on the rule.

1.9.2.1.9.5 PDFUA compliance

The PDFUA Compliance option located on the Menu bar allows you to check if your document is a PDF/Universal Accessibility compliant file.
PDF import wizard
To import and check one or more PDF files, click PDF import wizard from the Menu bar, select one or more PDF files from your work station and click Open, then Import. Your document or documents will be added in the FILES list.

To check if your PDF files are PDFUA compliant, click Run accessibility check. If the validation fails, you are informed that your document does not meet the accessibility requirements and will be marked with a red label, such as , in the FILES list.

The validator generates warnings that can refer to specific indexes from the PDF associations Matterhorn Protocol 1.1. The pre-validator checks some of the conditions mentioned in chapter Input file requirements from the PDF2PDFUA Tool: Development User Guide.

To find more information about the displayed errors, search for the error ID in the Marterhorn protocol document.

Contact your PDF producer to investigate and solve this PDF error to obtain a PDF/UA file compatible output.

Pre-accessibility checker
If you want to check the PDFUA compliance for one or more existing PDF files, select the files from the FILES list and click Pre-accessibility checker.

You can also verify the PDFUA compliance by using the right-click menu in the FILES list. Right-click one or more PDF files and select Pre-accessibility checker from the menu.

1.9.2.1.10 Troubleshooting

If you encounter problems while you are working with RICOH Accessibility Designer, you might be able to solve them by using the information in this section.

If a message appears

This section explains essential messages. If you encounter a message that is not explained in this section, follow the instructions in the message.

Validating PDF

Message Action and Reference
The condition has no branch action. Make sure you set condition rules for either the True or False branch.
The element needs to be part of a table. The matched table row element should be part of the table structure.
Missing fixed text value in element. Make sure matched elements such as paragraph, heading, link, note, table data, column header, row header are not empty when the element property is set on Fixed.

See Exporting Coordinates in the Control File for details on exporting options.

The Anchor must have at least one coordinate. Make sure at least one of X and Y anchor properties is not set to Absent.

If RICOH Accessibility Designer stops working or throws an error, run the installer again. See Installing RICOH Accessibility Designer for more details.

1.9.2.1.11 Glossary

This glossary defines technical terms and abbreviations used in RICOH Accessibility Designer.
A
AFP
Advanced Function Presentation
AT
Assistive Technology
C
control file
XML file that records content for further reuse on multiple documents with identical or similar content.
E
element
Section of content used for matching purposes in order to create rules.
M
macro definition
Used to create macro rules.
macro definitions file
An XML file that stores rules to be used multiple times within the same control file or a different control file.
macro rule
Rule with specific properties created to be used several times across the PDF file.
match
The action used to select PDF elements.
Synonym for tag.
P
PDF
Portable Document Format
An Adobe PostScript data format that can be viewed or printed.
PDF/UA
PDF/Universal Accessibility
Project
Structured tagged PDF content, exported as control file.
R
rule
Matched PDF semantic grouping.
T
tag
Standardised content marker.
Synonym for mark.
V
validation
In RICOH Accessibility Designer, the process of checking whether all PDF elements have been matched.
Synonym for review.

1.10 PDF2PDFUA

The following publications are available for RICOH PDF2PDFUA. 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.10.1 RICOH PDF2PDFUA Tool Setup Guide

1.10.1.1 RICOH PDF2PDFUA Setup Guide

1.10.1.1.1 Introduction

1.10.1.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.10.1.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.10.1.1.1.3 Publications for this Product

This publication provides an overview of the tool, and information about the installation and the use of the PDF2PDFUA tool.

Instruction manuals

For more information about the PDF2PDFUA tool, see these documents:

  • PDF2PDFUA Setup Guide
  • PDF2PDFUA User's Guide

1.10.1.1.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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.

1.10.1.1.1.5 Abbreviations

AES
Advanced Encryption Standard
AFP
Advanced Function Presentation
PDF
Portable Document Format
UA
Universal Accessibility
WCAG
Web Content Accessibility Guideline

1.10.1.1.1.6 Trademarks

Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe 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.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

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.10.1.1.2 Overview

Use the PDF2PDFUA tool together with a PDF2PDFUA control file to transform an input PDF file to a PDF/UA compliant file. The ISO standard 14289 describes the technical requirements so that a PDF file is PDF/UA compliant. The W3C's Web Content Accessibility Guidelines (WCAG) was written considering the Web content. It contains principles, guidelines and success criteria on how to create content that can be accessible. The requirements for the PDF/UA standard are complementary to the WCAG 2.0 success criteria and are therefore compliant with its requirements.

1.10.1.1.2.1 Benefits

If you already have a PDF document non-compliant with the PDF/UA standards, you can use the command line to transform the file into a PDF/UA compliant.

If you run the PDF2PDFUA Tool from the AFP2PDF Plus Transform, you can generate PDF/UA compatible document from an input AFP file.

1.10.1.1.2.2 Limitations

  • The PDF2PDFUA transform cannot create a PDF/UA compliant file if some technical requirements are not met. For more information, see "Ensuring PDF/UA and WCAG compliance" in the PDF2PDFUA Tool: User's Guide.
  • Allowed writing systems

    The only writing system currently supported is left-to-right and top-to-bottom. Any other language that has a different writing systems, such as right-to-left (Arabic or Hebrew) or bottom-to-top (Traditional Chinese or Vietnamese) is not supported yet.

1.10.1.1.2.3 Requirements

The PDF2PDFUA Tool requires JAVA v1.8 or later. To convert an AFP file to a PDF/UA compliant PDF file, make sure the AFP2PDF Plus Transform is installed on your system.

For more information on the technical requirements that an input file must meet to have the output PDF/UA compliant, see PDF2PDFUA User’s Guide.

1.10.1.1.3 Installing the PDF2PDFUA Tool

1.10.1.1.3.1 Installing PDF2PDFUA using the graphic user interface

You must install PDF2PDFUA on the system where you plan to run PDF2PDFUA.

To install PDF2PDFUA:

  1. Download RTS--pdf2pdfua-1.4.3--pdf2pdfua_win.exe on Windows and RTS--pdf2pdfua-1.4.3--pdf2pdfua_linux.bin or RTS--pdf2pdfua-1.4.3--pdf2pdfua_aix.bin on Unix.
  2. To start the installation on a Windows operating system, log in as an administrator and double-click RTS--pdf2pdfua-1.4.3--pdf2pdfua_win.exe.
  3. On the Introduction screen, click Next to continue the installation process of the transform.

      Note:
    • To stop the installation process of the transform, click Cancel.

  4. In the License Agreement dialog box:
    1. Read the license agreement.
    2. Click I accept the terms of the license agreement.
    3. Click Next.

      Note:
    • If you do not accept the terms of the license agreement, you cannot continue the installation.

  5. In the Get User Input select one of the options depending on your needs and continue the installation steps.
  6. Then, choose the installation folder.
    You can either select Stand-alone PDF2PDFUA or Integrated with AFP2PDF Plus.
  7. 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.

  8. Click Done to close the installer.

1.10.1.1.3.2 Installing a Permanent License

To continue using PDF2PDFUA Plus after the trial license expires, you must install a permanent license on the computer where the product is installed. The permanent license is valid only on this computer.
To install a permanent license for PDF2PDFUA:
  1. Run the license management tool PDF2PDFUALicenseManager.exe on Windows located in the license_installer folder where PDF2PDFUA is installed, and follow the installation steps.
  2. When prompted You can either install a new license or revoke the currently installed one., select Install License - Upload and apply a new license file.
  3. Make sure that you have the e-mail containing the entitlement ID (EID) that you received from Ricoh.
  4. If the computer where PDF2PDFUA is installed does not have Internet access:
    1. Do not close the license application on the computer where PDF2PDFUA is installed.
    2. Log into a computer that has Internet access.
    3. Use the Remote Desktop Connection to connect to the computer where PDF2PDFUA is installed.
    4. Log in with the same user name and password that you used when you started the license application.
  5. On the computer that has Internet access, go to this Web site: https://dl.ricohsoftware.com.
    License Action dialog
  6. Click Software Activation on the right side of the screen.
  7. In the Software Activation dialog, insert the EID and the system fingerprint.Login Dialog
    1. Copy and paste the EID from the e-mail you received from Ricoh.
    2. Return to the license management tool on the computer where PDF2PDFUA is installed. Copy your machine fingerprint field. This action copies the 16-character system fingerprint that uniquely identifies the computer where PDF2PDFUA is installed to the clipboard.
    3. Return to the Software Activation webpage. Paste the system fingerprint in the Enter your System Fingerprint field.
    4. Click Confirm Content.
  8. In the Activation Content Confirmation dialog:
    1. Review the confirmation information.
    2. Click Activate.
    You will receive a confirmation that your software has been activated. A license key is generated with an Activation ID for the client computer and is displayed on the screen.
    Note: The number of activations of the license is displayed under Quantity. The remaining number of activations available for this license is displayed under Remaining Quantity.
  9. To download the license key, click Download License Key. The saving procedure and file type are different for each browser. Record the folder where you saved the license key.
  10. To e-mail the license key file to someone else, click Email License Key.
    Email dialog
    1. Type the e-mail address.
    2. Click Send.
  11. If you are finished, close the browser tab. To restart the process, click Start Over.
  12. If you accessed the Internet from a different computer than the one where PDF2PDFUA is installed, copy the license file to the computer where PDF2PDFUA is installed.
  13. Run the license management tool on the system where PDF2PDFUA is installed, follow the installation steps and select Install License - Upload and apply a new license file. ⇒ Install.
  14. After the license management tool displays your machine fingerprint, click Next.
  15. Locate the license file and click Open.
  16. Select Next.
  17. Review the installation summary and click Install.
    You see a message that the license was installed successfully.
  18. You can start using the PDF2PDFUA transform.

1.10.1.1.3.3 Installing on AIX or Linux from the command line

To start the command line installer, follow these steps:
  1. Download RTS--pdf2pdfua-1.4.3--pdf2pdfua_linux.bin or RTS--pdf2pdfua-1.4.3--pdf2pdfua_aix.bin.
  2. Add execution rights. Use the shell command chmod +x RTS--pdf2pdfua-1.4.3--pdf2pdfua_linux.bin or chmod +x RTS--pdf2pdfua-1.4.3--pdf2pdfua_aix.bin.
  3. The installer uses the /tmp folder and you must make sure that it has writing writes and enough space.
  4. Run the command ./RTS--pdf2pdfua-1.4.3--pdf2pdfua_linux.bin or ./RTS--pdf2pdfua-1.4.3--pdf2pdfua_aix.bin to start the installation process, then follow the installation steps.

1.10.1.1.3.4 Installing a permanent license on AIX or Linux

To install a permanent PDF2PDFUA license on AIX or Linux:
  1. Go to the "license_installer" folder located in the PDF2PDFUA installation folder where you can find the license manager tool.
  2. Make sure that the license manager tool has execution rights. If it does not have execution rights, run: chmod +x PDF2PDFUALicenseManager.bin.
  3. Start the license manager by running ./PDF2PDFUALicenseManager.bin and follow the steps indicated.
  4. You must enter the location of the PDF2PDFUA installation folder, and you will receive a fingerprint.
  5. Follow the steps 5-11 from the Installing a Permanent License.
  6. Specify the location of the license key in the License manager.

1.10.2 RICOH PDF2PDFUA User Guide

1.10.2.1 Introduction

1.10.2.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.10.2.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.10.2.1.3 Publications for this Product

This publication provides an overview of the tool, and information about the installation and the use of the PDF2PDFUA tool.

Instruction manuals

For more information about the PDF2PDFUA tool, see these documents:

  • PDF2PDFUA Setup Guide
  • PDF2PDFUA User's Guide

1.10.2.1.4 Symbols

The following symbols are used in this manual to help you to identify content quickly.
    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.

1.10.2.1.5 Abbreviations

AES
Advanced Encryption Standard
AFP
Advanced Function Presentation
PDF
Portable Document Format
UA
Universal Accessibility
WCAG
Web Content Accessibility Guideline

1.10.2.1.6 Trademarks

Adobe, the Adobe logo, PostScript, and the PostScript logo, PDF, and the PDF logo are either registered trademarks or trademarks of Adobe 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.

Sentinel is a registered trademark of Thales DIS CPL USA, Inc.

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.10.2.2 Using the PDF2PDFUA Tool

1.10.2.2.1 Using the PDF2PDFUA Tool through the AFP2PDF Plus Transform

To convert AFP files into PDF/UA documents, you must add this option parameter in the AFP2PDF Plus configuration file:

PDFUA_CONTROL_FILE=file
Specifies the fully qualified name of the PDF2PDFUA tool control file. This file is an XML that contains information on the input file content. The PDF2PDFUA Tool uses the document to mark the content as the PDF/UA standard requires.
PDFUA_CACHE_SIZE=number
Specifies the number of most used PDFUA control files stored in cache. The number should be greater than 0.

    Note:
  • For an encrypted or a linearized PDF/UA output file set the AFP2PDF Plus option file entries, when running through the AFP2PDF Plus transform:
    For encryption:
    Default_Encryption_Permissions
    Default_owner_password
    Default_user_passowrd
    For creating linearized documents:
    Default_linearization

    For more information on how to set the options, see the chapter AFP2PDF Plus Transform Options File from the AFP2PDF Plus User's Guide.

Limitation:

  • When creating PDF/UA files, AES 256-bit encryption is not supported.

1.10.2.2.2 Using the PDF2PDFUA Tool from command line

When you run the PDF2PDFUA Tool from command line, the input file can be a PDF document and a control file converted by the PDF2PDFUA Tool into a PDF/UA compliant file.

1.10.2.2.3 Syntax

Depending on the operating system, the syntax for the PDF2PDFUA transform is:

pdf2pdfua.nnn [-ooutput file name] [-icontrol filename] [-b [number_of_threads] input directoryoutput directory] [-doutput for dumping text] [-linearizetrue/false] [-encryptowner passworduser password encryption flags] [-decryptpassword] [-keypassword] [-traceregular expression] [inputfile]

where .nnn represents the extension .bat for Windows and .sh for Linux and AIX.

1.10.2.2.4 Parameters

-b
This parameter is used to run the PDF2PDFUA transform in batch mode. The transform converts all the PDF files from a directory using a single control file that is specified through the -i parameter to PDF/UA files.

To specify the number of threads, add the number right after the -b flag. Default thread number is 1.

    Note:
  • In batch mode, the input directory and output directory parameters are mandatory. The input directory parameter replaces the input file parameter.
-linearize
This parameter is optional.
The implicit value is not specified.
  • If the value is true, the output is linearized.
  • If the value is false, the output is not linearized, even if the input is linearized.
  • If the value is not specified, the output is linearized only if the input is linearized.
-encrypt
This parameter is optional.
By default, the user has no permission. The following flags are used to grant permissions:
-allowAnnotations
-allowAssemble
-allowCopy
-allowFill
-allowModify
-allowPrintDegraded
-allowPrintHigh
-allowPrint, -allowPrintDegraded, or -allowPrintHigh.
-decryptpassword
This parameter removes the original encryption.
-keypassword
This parameter opens locked documents without removing the original encryption. The permissions are preserved.
-traceregular expression
This parameter is used to debug control files. All tracing elements are active by default in command line mode.
-validate
This parameter enables the validator. It can be used without a control file when you pre-validate the input PDF. If a control file is specified, it also checks the output PDF.

1.10.2.2.5 Configuring the PDF2PDFUA.cfg options file

Additional parameters to control settings for the PDF2PDFUA transform are specified in an options file. The name is PDF2PDFUA.cfg. The PDF2PDFUA.cfg must be located in the root directory of the PDF2PDFUA tool.

The PDF2PDFUA.cfg option parameters are:

AlwaysWriteProducer=TRUE | FALSE
Indicates that the output PDF file must contain information about the PDF2PDFUA transform version and the control file version within the PDF Producer field.

The default value is False.

When the value is False, the parameter has the same function as it is specified in the control file.

When the value is True , the parameter includes the producer meta data regardless of the control file specification. The meta data is useful for development. This parameter is no longer needed because newer versions of PDF2PDFUA include the meta data in non-standard ways. Developers can extract the meta data but a PDF reader will simply ignore it.

DefaultLogSize= integer
The default value is 10. It represents the maximum size of the default log, in megabytes. This parameter has no effect if useDefaultLog is false.
errProgramVersion = true|false
Specifies how the transform handles control files that are designed for newer versions of PDF2PDFUA.

When the value is true, it throws an exception, preventing the transform from running incompatible control files.

When the values is false, it tries to run incompatible control files generating a warning on the print handler (default STDOUT) and in the logs. This might lead to incorrect output PDFs.

The default value is true and it is strongly recommended to keep this option on true.

LegacyLinePosition=TRUE | FALSE
The default value is False.

When the value is False, the position is given by the word with the smallest Y coordinate.

When the value is True, the position is given by the word with the biggest Y coordinate. If the line contains subscripts, the getLinePosition operator returns the Y of the subscript.

LegacyNextLine= TRUE | FALSE
The default value is True. It affects the behavior of getNextLine and getNextLineInRegion except for nextLine or nextLineInRegion. These operators always use the new behavior.

Within the legacy behavior, it searches for the first line with y(line) > y(cursor). It does not work correctly if the cursor is set with getLinePosition.

Within the new behavior: it searches for the first line with y(line) ≥ y(cursor). It fixes certain issues but introduces another issue:

if y(line) = y(cursor)

For example:

<Cursor> <Y> <Expr> getLinePosition(getNextLine) </Expr> </Y> </Cursor>
<Expr> $line1 = getNextLine </Expr>
<Expr> $line2 = getCurrentLine </Expr>

Here, line1 and line2 are the same.

UseDefaultLog= TRUE | FALSE
The default value is True.

When the value is True, it creates a default log file if none was passed from the API. It is useful in standalone mode.

When the value is False, the logging is enabled only if configured from the API.

1.10.2.2.6 Features supported by the PDF2PDFUA Transform

With the PDF2PDFUA Plus transform you can batch convert several input files that have a common generation template. You can create a control file for any PDF file, including invoices, account summaries, or credit card statements. You have the possibility of creating one control file for each invoice type.

PDF2PDFUA Plus provides enhanced support for handling variable data. PDF2PDFUA Plus can handle variable data at fixed positions such as names, address boxes, but also tables with a variable number of rows or tables that span on multiple pages. The PDF2PDFUA transform allows you to mark only the real content and artifact the irrelevant content.

Note: Contact your Ricoh representative to receive more information regarding the procedure of creating a control file.

1.10.2.3 Ensuring PDF/UA and WCAG compliance

1.10.2.3.1 Input file requirements for PDF/UA compliance

If the input file contains one of these problems, the file cannot be processed or the resulting file is not PDF/UA complaint.

  • PDF file contains flickering content or PDF elements that lead to flickering (Matterhorn Protocol – Ch03-X).
  • Information within the PDF file is conveyed using contrast, color, or format layout (MP Ch04).
  • PDF file contains sound (MP Ch05).
  • PDF file uses character codes without Unicode mapping (MP Ch10).
  • PDF file contains images with paragraphs of text (MP C13-06).
  • PDF file uses non-embedded fonts (MP C21).
    Note: If used together with the AFP2PDF Plus transform, make sure that it is configured to embed the fonts.
  • PDF file contains forms.
  • PDF file contains action elements.

1.10.2.3.2 Validating the input PDF file and the output PDF UA file

The PDF2PDFUA validator generates warnings that can refer to specific indexes from the PDF associations Matterhorn Protocol 1.1. The pre-validator checks some of the conditions mentioned in the Matterhorn Protocol.

To find more information about the displayed errors, search for the error ID in the Marterhorn protocol document.

Contact your PDF producer to investigate and solve this PDF error to obtain a PDF/UA file compatible output.

1.10.2.3.3 Input file requirements for WCAG 2.0 (Level AA) compliance

To make sure that the input file is compliant with the accessibility standards of the Web Content Accessibility Guidelines (WCAG) 2.0 Level AA, check the following:

WCAG 1.4.3: Minimum contrast
The input file should contain text and images with a minimum contrast of 4.5:1.
WCAG 1.4.5: Images as text
The input file should deliver information through text, rather than images containing text.

1.10.2.3.4 Input file requirements for WCAG 2.0 (Level AAA) compliance

To make sure that the input file is compliant with the accessibility standards of the Web Content Accessibility Guidelines (WCAG) 2.0 Level AA, check the following:

WCAG 1.4.6 – Enhanced Contrast requirement
The visual presentation of text and images of text have a contrast ratio of at least 7:1.
WCAG 1.4.8 – Visual presentation
The input file should meet these requirements:
  1. Width is no more than 80 characters or glyphs (40 if CJK).
  2. Text is not justified (aligned to both the left and the right margins).
  3. Line spacing (leading) is at least space-and-a-half within paragraphs, and paragraph spacing is at least 1.5 times larger than the line spacing.
WCAG 1.4.9 Images of Text (No Exception)
Images of text are only used for pure decoration or where a particular presentation of text is essential to the information that is being conveyed.

1.10.2.3.5 Input file requirements for WCAG 2.1 (Level AA) compliance

1.4.11 Non-text Contrast (Level AA)
The visual presentation of graphical objects have a contrast ratio of at least 3:1 against adjacent colors.

1.10.2.3.6 Validating PDF/UA or WCAG compliance

You can use these tools to make sure that your PDF file is PDF/UA or WCAG compliant:

PAC – PDF Accessibility Checker
A free-to-download tool that verifies if the PDF file is PDF/UA or WCAG compliant. If the verification fails you can view any issues that lead to the file not being compliant. You can get it online from the PDF/UA Foundation: https://pac.pdf-accessibility.org/en.

1.10.2.4 Java Application Programming Interface

This chapter describes the Java API provided by RICOH PDF2PDFUA.

The code surrounded by angle brackets refers to an XML element in the control file. For example, <If> refers to conditionals in the control file.

1.10.2.4.1 Classes

These classes are part of the Java application programming interface (API) for RICOH PDF2PDFUA.

enum EncryptionAlgorithm

Package: com.ricoh.pdf2pdfua.api

Option that specifies the encryption algorithm of the output PDF.

Values:

none
The output is not encrypted.
preserve
Preserves the encryption from the input PDF.
Standard128
An RC4 128 bit key-size stream cipher.
AES128
Advanced encryption standard that uses a 128-bit key length.
AES256
Advanced encryption standard that uses a 256-bit key length.

interface IControlFile

Package: com.ricoh.pdf2pdfua.api.

Represents the syntax tree of the control file. The control file is parsed once and applied on multiple PDF files.

IControlFile refresh() throws PreprocessingException;

Used to scan the control file for changes.

Returns this if the control file is up to date.

Returns a new IControlFile if the underlying files are no longer in-sync.

interface Pdfua

Package: com.ricoh.pdf2pdfua.api

The Java service provider interface (SPI) for RICOH PDF2PDFUA.

IControlFile newControlFile(String path);

Parses the control file specified by path. A single control file instance can be reused across multiple threads.

PdfUaOpt newOpt();

Creates an instance of PdfUaOpt with default configurations.

void run(FileInputStream fis, File out, IControlFile cf, PdfUaOpt opt)
throws PDFUAException;

This method runs the PDF2PDFUA conversion. It is thread-safe and reentrant.

byte[] run(InputStream inPdf, IControlFile cf, PdfUaOpt opt) throws PDFUAException; 

This method runs the PDF2PDFUA conversion and returns a byte array containing the tagged PDF. It is thread-safe and reentrant.

class PDFUAException extends Exception

Package: com.ricoh.pdf2pdfua.api

Base class for PDF2PDFUA conversion errors.

class PdfUaLoader

Package: com.ricoh.pdf2pdfua.api

Trivial helper that loads the PDF2PDFUA service implementation. The service can be loaded directly with a ServiceLoader.

public static Pdfua load();

Loads the PDF2PDFUA service implementation.

abstract class PdfUaOpt

Package: com.ricoh.pdf2pdfua.api

Used to configure the behavior of PDF2PDFUA. It is a configuration container that has only getters and setters.

This is an abstract class, but it must never be extended by API users. To get an instance, use Pdfua.newOpt().

A single instance can be used by multiple threads but should not be modified while PDF2PDFUA is running.

public boolean getAllowAnnotations();
public void setAllowAnnotations(boolean allowAnnotation);

Permission flag for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: false

public boolean getAllowAssemble();
public void setAllowAssemble(boolean allowAssemble);

Permission flag for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: false

public boolean getAllowCopy();
public void setAllowCopy(boolean allowCopy);

Permission flag for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: false

public boolean getAllowFill();
public void setAllowFill(boolean allowFill);

Permission flag for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: false

public boolean getAllowModify();
public void setAllowModify(boolean allowModify);

Permission flag for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: false

public boolean getAllowPrint();
public void setAllowPrint(boolean allowPrint);

Permission flag for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: false

public boolean getAllowPrintDegraded();
public void setAllowPrintDegraded(boolean allowPrintDegraded);

Permission flag for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: false

public byte[] getDecryptionKey();
public void setDecryptionKey(byte[] decryptionKey);

This option is required if the input PDF is encrypted. Used to unlock the input without removing the encryption. The owner key is preferable.

Default value: null

public EncryptionAlgorithm getEncryption();
public void setEncryption(EncryptionAlgorithm encryption);

Specifies the encryption algorithm of the output.

Default value: EncryptionAlgorithm.preserve

public Boolean getLinearize();
public void setLinearize(Boolean linearize);

If linearize is true: the output PDF is linearized.

If linearize is false: the output PDF is non-linearized.

If linearize is null: the output is linearized only if the input PDF was linearized.

Default value: null

public Logger getLog();
public void setLog(Logger log);

Default value: specified in the configuration file.

public boolean getOnlyMergeXObjects();
public void setOnlyMergeXObjects(boolean onlyMergeXObjects);

This option is used for development and testing. It must not be used in a production environment.

Default value: false

public byte[] getOwnerPassword();
public void setOwnerPassword(byte[] ownerPassword);

The owner password for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: null

public PdfUaOutputHandler getStderrHandler();
public void setStderrHandler(PdfUaOutputHandler stderrHandler);

Used to handle the messages that are normally written to stderr. Default value: built-in handler as specified by the configuration file.

public PdfUaOutputHandler getStdoutHandler();
public void setStdoutHandler(PdfUaOutputHandler stdoutHandler);

Used to handle the messages that are normally written to stdout.

Default value: built-in handler as specified by the configuration file.

public PdfUaOutputHandler getTraceHandler();
public void setTraceHandler(PdfUaOutputHandler traceHandler);

Used only by the <Trace> command.

Default value: built-in handler as specified by the configuration file.

public boolean getUseLatestRevisions();
public void setUseLatestRevisions(boolean useLatestRevisions);

This option is used for development and testing. It must not be used in a production environment.

Default value: false

public byte[] getUserPassword();
public void setUserPassword(byte[] userPassword);

The user password for PDF encryption. Has no effect if the output is not encrypted by PDF2PDFUA.

Default value: null

interface PdfUaOutputHandler

Package: com.ricoh.pdf2pdfua.api

Handler for IO redirection.

void onMessage(Node src, int pageNo, String msg);

src: the XML node of the invoking control file rule. Null if the message cannot be traced to an XML node.

pageNo: the page number starts from 1. This value is zero if the message cannot be traced to a page.

msg: can contain multiple lines of text.

class PreprocessingException extends Exception

Package: com.ricoh.pdf2pdfua.api

Base class for errors that occur while the control file is preprocessed.

class UaStackTrace extends ArrayList<String>

Package: com.ricoh.pdf2pdfua.api

A stack trace that points to an XML element in the control file.

public static UaStackTrace unwind(final Node top);

1.10.2.4.1.1 Examples

This example shows how to parse a control file and how to apply it on multiple documents. All documents in a batch are supposed to be similar and compatible with the control file. For performance reasons, the control file is parsed a single time.

The software is expected to run on servers with multiple CPU cores. This example is multi-threaded because it is the standard use case.

package com.ricoh.pdf2pdfua.api.example;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import com.ricoh.pdf2pdfua.api.IControlFile;
import com.ricoh.pdf2pdfua.api.PDFUAException;
import com.ricoh.pdf2pdfua.api.PdfUaLoader;
import com.ricoh.pdf2pdfua.api.PdfUaOpt;
import com.ricoh.pdf2pdfua.api.Pdfua;
import com.ricoh.pdf2pdfua.api.preprocessor.PreprocessingException;

public class Pdf2PdfUaApiExample {
    static class ThreadSafeIterator {
        Iterator<File> i;

        ThreadSafeIterator(List<File> files) {
            i = files.iterator();
        }

        synchronized File next() {
            if (i.hasNext())
                return i.next();
            return null;
        }
    }

    static void exit(String msg) {
        System.err.println(msg);
        System.exit(1);
    }

    static File changeExtension(File f) {
        return new File(f.getAbsolutePath().replace(".pdf", ".ua.pdf"));
    }

    static Thread[] createThreadArray() {
        return new Thread[Runtime.getRuntime().availableProcessors()];
    }

    static void convertBatch(String controlFilePath, List<File> pdfs)
            throws PreprocessingException, InterruptedException {
        final Pdfua pdfuaInstance = PdfUaLoader.load();
        final IControlFile cf = pdfuaInstance.newControlFile(controlFilePath);
        final PdfUaOpt opt = pdfuaInstance.newOpt();
        final ThreadSafeIterator it = new ThreadSafeIterator(pdfs);
        Thread[] threads = createThreadArray();
        for (int i = 0; i < threads.length; i++) {
            threads[i] = new Thread() {
                public void run() {
                    File pdfIn;
                    while ((pdfIn = it.next()) != null) {
                        try {
                            FileInputStream fis = new FileInputStream(pdfIn);
                            File out = changeExtension(pdfIn);
                            pdfuaInstance.run(fis, out, cf, opt);
                        } catch (FileNotFoundException | PDFUAException e) {
                            e.printStackTrace();
                        }
                    }
                }
            };
        }
        for (Thread t : threads)
            t.start();
        for (Thread t : threads)
            t.join();
        System.out.println("Batch complete!");
    }

    public static void main(String[] args)
            throws PreprocessingException, InterruptedException {
        if (args.length < 1)
            exit("No control file!");
        ArrayList<File> files = new ArrayList<>();
        for (int i = 1; i < args.length; i++)
            files.add(new File(args[i]));
        if (files.isEmpty())
            exit("No PDF file to convert!");
        convertBatch(args[0], files);
    }
}

This example illustrates how PDF2PDFUA can work without using files. This is useful when PDF2PDFUA is integrated in other systems such as web applications.

package com.ricoh.pdf2pdfua.api.example;

import java.io.FileInputStream;
import java.io.FileOutputStream;

import com.ricoh.pdf2pdfua.api.PdfUaLoader;
import com.ricoh.pdf2pdfua.api.Pdfua;

public class Pdf2PdfUaApiExampleBytesOutput {
    public static void main(String[] args) throws Exception {
        Pdfua ua = PdfUaLoader.load();
        byte[] outputBytes = ua.run(
            new FileInputStream("./untagged.pdf"),
            ua.newControlFile("./control-file.xml"),
            ua.newOpt()
        );
        var os = new FileOutputStream("./out.pdf");
        os.write(outputBytes);
        os.close();
    }
}

1.11 RICOH InfoPrint XT

This transform technology allows you to print your native Xerox jobs on high-speed, InfoPrint intelligent printer data stream (IPDS) printers. You do not need to modify the applications that generate your Xerox jobs.

With RICOH InfoPrint XT, you can:

  • Load the resources from your Xerox printers and automatically generate the equivalent Advanced Function Presentation (AFP) resources.
  • Convert Xerox line-conditioned data stream (LCDS) and metacode jobs into AFP.
  • Optionally use RICOH InfoPrint Manager for job management and printer management in an integrated RICOH InfoPrint XT installation.

RICOH InfoPrint XT is available on AIX, Linux, and Windows.

Documentation

  • RICOH InfoPrint XT for AIX: User Guide PDF
  • RICOH InfoPrint XT for Linux: User Guide PDF
  • RICOH InfoPrint XT for Windows: User Guide PDF
  • Release notes PDF
  • Software License Agreements HTML