xxnullxx - 5dbc7fc7f87beb0001bb4ab6

RICOH ProcessDirector™ for Linux

RICOH ProcessDirector for Linux

1 RICOH ProcessDirector for Linux

RICOH ProcessDirector is a Web-based application that turns your printing operation into a controlled manufacturing process. It is a powerful and cost-effective system that lets you manage your printing environment from a single point, through a comprehensive user interface.

This information center contains the RICOH ProcessDirector product library, including information about installing, configuring, and using the base product and features. Most of the information is available in both PDF and HTML formats.

Note: To open a PDF version of a book in a new tab, click the PDF link after the book title in the list below.

To open a topic or book in HTML format in this tab:

  • Use the table of contents to find the topic you want to read and click the title.
  • Click the HTML link after the book title in the list below.

  • Planning and Installing PDF HTML
  • Release Notes PDF HTML
  • Integrating with Other Applications PDF HTML
  • Installing Document Processing Features PDF HTML
  • Using RICOH ProcessDirector Plug-in for Adobe Acrobat PDF HTML
  • White paper: Using the Enhance AFP Function PDF
  • InfoPrint Font Collection: Font Summary PDF
  • Software License Agreements HTML

1.1 Planning and Installing RICOH ProcessDirector

1.1.1 Introduction

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.1.1.2 Cautions regarding this guide

  • Some illustrations or explanations in this guide could differ from your product due to improvements or changes 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.
  • Throughout this publication, references to directory paths indicate the default paths only. If you install RICOH ProcessDirector or any of its components in a different location, including a different drive, you must adjust the paths accordingly.

    For example, if you install RICOH ProcessDirector on the D: drive of a computer running a Windows operating system, replace C: with D: in the directory paths.

1.1.1.3 Publications for this product

The RICOH ProcessDirector publications CD includes the RICOH ProcessDirector publications.
Instruction manuals

These instruction manuals are included:

  • RICOH ProcessDirector for Linux: Planning and Installing (this publication)

    This guide explains planning and installation procedures for RICOH ProcessDirector.

  • RICOH ProcessDirector: Integrating with Other Applications

    This guide provides technical information about the ways that you can configure RICOH ProcessDirector to exchange data with other applications.

    This guide can be opened from the Help menu.

  • RICOH ProcessDirector: Installing Document Processing Features

    This guide explains how to install RICOH ProcessDirector features that control and track both jobs and the individual documents in jobs.

  • RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat

    This guide explains how to use RICOH ProcessDirector Plug-in for Adobe Acrobat. You can use the Adobe Acrobat plug-in to define text, barcodes, images, and other enhancements in a PDF file. After you save your enhancements in a control file, RICOH ProcessDirector workflows can use the control file to make similar enhancements to PDF files.

  • Font Summary

    This guide explains font concepts and the different types of fonts in the RICOH InfoPrint Font Collection. The Font Summary is available only in English.

  • White Paper–Using the Enhance AFP Function

    This guide explains how to configure and use Enhance AFP control files. The guide is available only in English.

  • The RICOH ProcessDirector readme file (readme.html).

    This file tells you how to access the other publications. The readme file is available only in English.

  • The RICOH ProcessDirector release notes

    These release notes provide information about the RICOH ProcessDirector release, including new functions and updates; known limitations, problems, and workarounds; and code change requests. The release notes are available only in English.

You can also download English publications in PDF format from the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/).

RICOH ProcessDirector Information Center

The Information Center contains topics that help administrators, supervisors, and operators learn about and use RICOH ProcessDirector. The Information Center is available from the user interface and provides quick navigation and search features.

Help

Field help is available on many screens to provide information for specific tasks and settings.

1.1.1.4 How to read the documentation

1.1.1.4.1 Before using RICOH ProcessDirector

This manual contains instructions and cautions for correct use of RICOH ProcessDirector. Before using RICOH ProcessDirector, read this manual thoroughly and completely. Keep this manual handy for future reference.

1.1.1.4.2 How to use the manuals

Use the instruction manuals according to your needs.
To learn how to plan for, install, and start RICOH ProcessDirector:
See RICOH ProcessDirector for Linux: Planning and Installing.
To learn about the functions and operations of RICOH ProcessDirector and its installed features:
See the RICOH ProcessDirector Information Center.
To learn how to set property values in the user interface:
See the field help.
To learn how to install a document processing feature:
See RICOH ProcessDirector: Installing Document Processing Features.
To learn how to use the functions and operations of RICOH ProcessDirector Plug-in for Adobe Acrobat
See RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.
To learn how to configure RICOH ProcessDirector to exchange data with other applications:
See RICOH ProcessDirector: Integrating with Other Applications.
Displaying the publications

The RICOH ProcessDirector publications are available on the publications CD, so you can access them before you install the application.

    Note:
  • A PDF viewer, such as Adobe Acrobat Reader, is required to view the publications.

To access the RICOH ProcessDirector publications CD on Windows:

  1. Insert the CD in the CD drive.

    If the Windows system is configured to autorun CDs, Windows Explorer opens automatically to show the contents of the CD.

  2. If Windows Explorer does not start automatically, open it and display the contents of the CD drive.
  3. Open the readme.html file for information about the contents of the CD.

Some of these publications are also available from RICOH ProcessDirector user interface.

    Note:
  • You must log in to the RICOH ProcessDirector user interface to view the publications.

In the banner of the RICOH ProcessDirector user interface, click the Information button and select one of the following publications to download:

  • RICOH ProcessDirector: Integrating with Other Applications
  • RICOH ProcessDirector: Installing Document Processing Features
  • RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat
  • RICOH ProcessDirector: Release Notes

Displaying the Information Center

The RICOH ProcessDirector Information Center is available from the user interface.

To display the Information Center:

  • In the banner of the RICOH ProcessDirector user interface, click the Inform>ation button and select Help.
  • If you are not logged in to RICOH ProcessDirector, enter this URL in the address bar of your browser:
    • http://hostname:15080/pdhelp/index.jsp

    In the URL, hostname is the host name or IP address of the computer where RICOH ProcessDirector is installed.

In addition, you can bookmark the location of the Information Center in your browser and open it at any time outside of RICOH ProcessDirector.

Information about using the functions and operations of features are available only when the features are installed in the system.

1.1.1.5 Related information

For information about our products, see:

For information about related products, see:

  • InfoPrint Manager for AIX: Getting Started, G550-1061
  • InfoPrint Manager for AIX: Planning Guide, G550-1060
  • InfoPrint Manager for Linux: Getting Started, G550-20263
  • InfoPrint Manager for Linux: Planning Guide, G550-20262
  • InfoPrint Manager for Windows: Getting Started, G550-1072
  • InfoPrint Manager for Windows: Planning Guide, G550-1071
  • InfoPrint Manager: PSF and Server Messages, G550-1053
  • InfoPrint Manager: Reference, S550-1052
  • InfoPrint Transform Manager for Linux: Installation and User's Guide, G550-1048
  • InfoPrint Transform Manager for Linux: afp2pdf Transform Installation and User's Guide, G550-0538
  • RICOH InfoPrint XT for Linux: Installation and User's Guide, G550-20375
  • RICOH InfoPrint XT for Windows: Installation and User's Guide, GLD0-0025
  • AFP Conversion and Indexing Facility User's Guide, G550-1342
  • IBM Print Services Facility for z/OS: AFP Download Plus, S550-0433
  • IBM Print Services Facility for z/OS: Download for z/OS, S550-0429

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

1.1.1.7 Abbreviations

AFP
Advanced Function Presentation
API
Application Programming Interface
CSV
Comma-Separated Values
DNS
Domain Name System
GID
Group ID
HTTP
Hyper Text Transfer Protocol
IP
Internet Protocol
JDF
Job Definition Format
LPD
Line printer daemon
PDF
Portable Document Format
PSF
Print Services Facility
REST
Representational State Transfer
SOAP
Simple Object Access Protocol
SSL
Secure Sockets Layer
UID
Default user ID
WSDL
Web Service Description Language
YaST
Yet Another Setup Tool

1.1.1.8 Trademarks

RICOH ProcessDirector and RICOH InfoPrint Manager are trademarks of Ricoh Company, Ltd. in the United States, other countries, or both.

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

Amazon® is a registered trademark of Amazon.com LLC.

EFI®, Fiery®, and the Fiery logo are either registered trademarks or trademarks of Electronics For Imaging, Inc. in the U.S. and/or certain other countries.

Firefox® is a registered trademark of the Mozilla Foundation.

Google Chrome is a trademark of Google, Inc.

IBM®, AIX, DB2®, MVS, POWER, Print Services Facility, and z/OS® are either registered trademarks or trademarks of International Business Machines Corporation in the United States and/or other countries.

Impostrip® is a registered trademark of Ultimate TechnoGraphics Inc.

Kodak® is a registered trademark of Eastman Kodak Company.

Linux® is a registered trademark of Linus Torvalds.

MarcomCentral® is a registered trademark of MarcomCentral, a Ricoh Company.

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®, Java®, and OpenJDK™ are trademarks or registered trademarks of Oracle and/or its affiliates.

PostgreSQL® is a registered trademark of PostgreSQL Community Association of Canada.

Quadient® is a registered trademark of Quadient Group AG.

Tableau Software® and Tableau® are registered trademarks of Tableau Software.

UNIX® is a registered trademark of The Open Group.

VMware® is a registered trademark of Vmware, Inc.

Xerox® is a registered trademark of Xerox Corporation.

Thales Group code: The license management portion of this Licensee Application is based on one or more of the following copyrights:

Sentinel RMS
Copyright 1989-2022 Thales Group 
All rights reserved.

Sentinel Caffe (TM)
Copyright 2008-2022 Thales Group 
All rights reserved.

Sentinel EMS
Copyright 2008-2022 Thales Group 
All rights reserved.

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

  • Windows XP:
    • Microsoft Windows XP Professional
    • Microsoft Windows XP Enterprise
  • Windows 7:
    • Microsoft Windows 7 Professional
    • Microsoft Windows 7 Ultimate
    • Microsoft Windows 7 Enterprise
  • Windows 10:
    • Microsoft Windows 10 Pro
    • Microsoft Windows 10 Enterprise
  • Windows 11:
    • Microsoft Windows 11 Pro
  • Windows Server 2008:
    • Microsoft Windows Server 2008 Standard
    • Microsoft Windows Server 2008 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

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.1.1.9 New in this release

These new functions and updates have been included in RICOH ProcessDirector Version 3.12.1.

New functions and updates in Version 3.12.1

  • Updated translations

    The content of the Version 3.12 product interface and the help system has been translated into these languages:

    • Brazilian Portuguese
    • French
    • German
    • Italian
    • Japanese
    • Spanish

    To see the translated user interface and help content, download and install the Language Pack for your language.

  • Upgrade and migrate to PostgreSQL on the same system

    In RICOH ProcessDirector version 3.12, we introduced support for PostgreSQL as the main database underlying RICOH ProcessDirector. To move to PostgreSQL, you were required to install version 3.12 on a different server and use the Migration Assistant to migrate your data. WIth version 3.12.1, you can upgrade and migrate your data on the same system. Install RICOH ProcessDirector, making sure to choose the PostgreSQL database configuration. After the installation completes, follow the instructions to migrate your data, then remove IBM DB2 from your primary computer.

  • Manual failover now supported for PostgreSQL configurations

    Manual failover configurations for system redundancy are now supported on RICOH ProcessDirector with PostgreSQL as well as DB2.

  • XML-RPC calls no longer supported

    The Connect extension, which let you connect to RICOH ProcessDirector remotely and use XML-RPC calls in scripts, is deprecated and no longer supported. We recommend using RICOH ProcessDirector web service API instead. For information about using web services, see Web services in RICOH ProcessDirector .

  • Additional updates include:
    • Ability to save the View job in workflow image
    • Added the StepChainDemo workflow to illustrate the use of step chains
    • Updated prerequisites for the Preprinted Forms Replacement feature, so customers with the AFP Support Feature can install Preprinted Forms Replacement without also installing PDF Document Support.
    • Usability updates for the Migration Assistant

New functions and updates in Version 3.12

  • Primary database options now available

    After many years of supporting only one database, RICOH ProcessDirector can now run with PostgreSQL as its primary database. While IBM DB2 is still supported in the same configuration as it has been, PostgreSQL is now the default database configuration. Existing customers can upgrade to version 3.12 and continue to use DB2 with no interruptions, or can choose to migrate their data to a PostgreSQL database.

    Note: To migrate data from DB2 to PostgreSQL, you must install RICOH ProcessDirector version 3.12 on a different computer. You cannot install the PostgreSQL configuration on the same system as an existing DB2 configuration.

    The PostgreSQL database is installed in a Docker container, so Docker Engine must be installed on the primary computer.

  • Migration simplified

    One of the most challenging aspects of moving to a new version of an application is ensuring that everything still works. Especially when the upgrade requires moving to a new system, it is challenging to know that you have copied everything that needs to be there. The RICOH ProcessDirector Migration Assistant now makes the process much easier.

    Install the base product on a new system, then log in and start the Migration Assistant. Use the Assistant to connect to your existing installation, choose the objects and settings to migrate to the new one, and let the Assistant do the work. The Migration Assistant can handle moving data from an existing DB2 database to PostgreSQL, and can even work across operating systems.

  • RICOH ProcessDirector for AIX replacement

    In version 3.12, RICOH ProcessDirector for AIX has been discontinued. Customers running on AIX can continue to use the application until the end of support date. Alternately, they can migrate to version 3.12 on Linux or Windows and use the Migration Assistant to port their data to a new system.

  • New Supported Printers

    RICOH ProcessDirector now supports printer models with the new Fiery® N-series Controller Digital Front Ends, based on Fiery and Ricoh technology. You can define these new printer models as Ricoh PDF printers:

    • RICOH Pro C7500
    • RICOH Pro C9500

  • Updated operating system support

    You can now install RICOH ProcessDirector on these operating system versions:

    • Rocky Linux 8.4 through latest 8.X
    • Rocky Linux 9.0 through latest 9.X
    Note: You can only install the PostgreSQL configuration on these operating systems. IBM DB2 is not supported on Rocky Linux.

New functions and updates in Version 3.11.2

  • New support for custom job properties

    With this release, you can create custom properties for jobs. In the past, RICOH ProcessDirector provided 20 job properties that you could use to store custom information. However, you could not rename the fields or change anything about them. With this new function, you can create your own job properties-- assigning unique field and database property names as you want to see them.

    To define custom job properties, use the Custom properties page on the Administration tab. Fill in the property notebook, activate the property, and you can start using it in your workflows!

  • An easier way to define custom document properties

    The same Custom properties page used to define custom job properties can also be used to define document properties! This new function significantly reduces the overhead associated with creating custom document properties. You no longer need to update the docCustomProperties.xml file, run the DocCustom utility, or install the new property. Simply fill in the fields in the custom property notebook and activate. Your document properties are ready to use!

  • Updated Adobe Acrobat Plug-in

    The RICOH ProcessDirector Plug-in for Adobe Acrobat has been updated to support the OpenJDK™Java® JRE Version 1.8 in addition to Oracle® Java. An appropriate JRE must be installed on your system before you install the Plug-in. With this update, we strongly recommend installing the 64-bit version of the JRE.

    In addition, you can now install the Plug-in with the 64-bit version of Adobe Acrobat Pro.

  • Updates to translated publications

    Books and help systems containing translated information for function released in Version 3.11.1 are now available. To see the translated help content and updated books from the help menu, download and install the Language Pack for your language. PDF versions of the books are also available in the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/)

New functions and updates in Version 3.11.1

  • Updated translations

    The content of the Version 3.11 product interface and the help system has been translated into these languages:

    • Brazilian Portuguese
    • French
    • German
    • Italian
    • Japanese
    • Spanish

    To see the translated user interface and help content, download and install the Language Pack for your language.

  • Choose paper for banner pages using media settings

    If you're printing PDF jobs, you can now specify which paper to print banner pages on by media, instead of by specifying a paper tray. Your banner pages print on the correct paper, regardless of where that paper is loaded. This function is available for Ricoh PDF, Kodak PDF, and Xerox PDF printers.

  • User interface updates

    The user interface has been enhanced to adjust the size of your portlets to fit inside your browser window. When you change the size of the window (by changing the dimensions of the browser or by moving it to a different screen), the portlets shrink or expand to fill the space available.

  • Data capture improvements

    With this update, you can download a data capture file to your system directly from the data capture page, so you don't have to access the primary server to retrieve the file. You can also stop a capture that is already in progress.

  • Operating system support changes

    In this release, we increased the minimum level of CentOS required to install RICOH ProcessDirector to version 7.9.

New functions and updates in Version 3.11

  • Ability to restore to a previous installation of RICOH ProcessDirector

    With this version of RICOH ProcessDirector, you can restore a previous installation using Feature Manager. With this new function, you install a new feature and then effectively back it out if you decide that it does not meet your needs. Or, if you apply an update but something goes wrong during the install process, you can restore the installation from before the update to get back to a stable state before you try to update again.

  • New data collector to collect information about processing durations

    Now, you can use the Job Step Duration data collector to collect information about how long each step was in the queued and processing states, as well as the total length of time it takes for each step in a workflow to complete processing. You can also select job properties to capture at the end of each step.

  • Operating system support changes

    In this release, we have removed support for installing RICOH ProcessDirector application servers on Windows Server 2016.

  • Include the Preset name in AFP print jobs

    If you send AFP print jobs to a printer that uses TotalFlow Print Server, you can now include the name of the printer preset to use for the job as a job property.

  • Security vulnerabilities addressed

    Ricoh is committed to responding to results of vulnerability scans and will continue to include those fixes in each release that we deliver. In this release, various components were updated to address these vulnerabilities, including:

    • AFP Support
    • Avanti Slingshot Connect
    • Reports
    • Printer Connector
    • Ricoh PDF Printer
    • DB2
    • Product Update

Release notes for prior versions of RICOH ProcessDirector are available on the RICOH Software Information Center here: Release notes: RICOH ProcessDirector

1.1.2 Overview

RICOH ProcessDirector lets you manage all aspects of your printing processes from a comprehensive Web browser-based user interface. RICOH ProcessDirector supports job submission from other systems using file copying methods. You can copy or move jobs into directories that you specify (hot folders), and you can configure RICOH ProcessDirector so that it continually monitors the directories and automatically processes jobs as they arrive. You can also submit jobs from any system that uses the line printer daemon (LPD) protocol for file transmission. In addition, RICOH ProcessDirector lets you control and track individual documents in PDF jobs.

The extensive database that RICOH ProcessDirector uses provides detailed audit information about your printing workload and tasks.

You can access RICOH ProcessDirector from a supported Web browser on workstations in your network. You do not need to install RICOH ProcessDirector on the workstations that you use to access the user interface; you only need to install RICOH ProcessDirector on the computer that is managing your workflow.

If you have purchased and installed the AFP Support feature, RICOH ProcessDirector lets you control and track jobs and individual documents in Advanced Function Presentation (AFP) format. The feature adds support for AFP and PCLOut printers and job submission from z/OS host systems using Download for z/OS and AFP Download Plus.

Important: If you purchased RICOH ProcessDirector without the AFP Support feature, instructions for download input devices, AFP and PCLOut printers, and other AFP-specific system objects and functions do not apply to your RICOH ProcessDirector installation.

You can purchase RICOH ProcessDirector, which provides a perpetual license, or RICOH ProcessDirector Subscription, which provides access to the product for 1-5 years with renewal options for longer term use. You purchase a subscription for the base product and for each feature that you want to install.

1.1.2.1 Components

The RICOH ProcessDirector base product is made up of these components:

RICOH ProcessDirector primary server
The RICOH ProcessDirector primary server manages all job activities, including input devices that create the jobs and printers that print the jobs. The server also processes jobs through workflows, some of which include other programs. It controls both the flow of jobs and the database tables that store system information.

The RICOH ProcessDirector primary server is installed on a 64-bit x86 computer running one of these operating systems:

  • CentOS Linux 7.9 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • Rocky Linux 8.4 through latest 8.X
  • Rocky Linux 9.0 through latest 9.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
  • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64
Using the latest service pack is recommended.

In addition, you can set up your installation to have a standby computer to use as a backup (or failover) computer. RICOH ProcessDirector is installed on both the active computer and the backup computer, but it can only run on one computer at a time. Both computers must have access to an NFS file server, where print jobs and systems objects are stored. In the event of an outage on the active computer, you can run scripts provided with RICOH ProcessDirector to move processing to the backup computer without losing objects or print jobs.

    Note:
  • You must purchase a license key for both your active and backup computers.
RICOH ProcessDirector stores system information and manages jobs as they flow through the system using a database. Two databases are supported: PostgreSQL and IBM DB2.
    Note:
  • PostgreSQL is the default database configuration starting in version 3.12.
  • IBM DB2 was that default database configuration prior to version 3.12.

Existing customers can continue to use IBM DB2 or migrate their data to PostgreSQL. For details, see Upgrading, in Chapter 3.

The PostgreSQL database is installed in a Docker container. You must install Docker Engine on the primary computer before you install RICOH ProcessDirector.

If you choose to use DB2 as the main database for RICOH ProcessDirector, you can:

  • Install DB2 during the RICOH ProcessDirector installation. If you choose this option, you cannot use this DB2 installation for any other purpose.
  • Install your own copy of DB2 on the computer that you plan to use for the RICOH ProcessDirector primary server.
  • Install your own DB2 server on a different computer and a DB2 client on the primary computer.

You do not have to install the database or database-related software on computers where you install Secondary Server features; secondary servers share the database that is installed on the primary computer.

RICOH ProcessDirector user interface
The RICOH ProcessDirector user interface is a Web browser-based interface that lets you manage the printing process. Users can access the user interface from a supported Web browser on a Windows or Linux workstation as long as they have a RICOH ProcessDirector user ID. The workstation must have the most recent version of one of these Web browsers installed:
  • Mozilla Firefox
  • Google Chrome
  • Microsoft Edge

The user interface also has a Web-based file viewer that uses the Adobe Acrobat Reader (or similar PDF viewer plug-in) to display AFP or PDF files so you can select pages to reprint.

To access the user interface, enter this URL in the address bar of a Web browser, replacing hostname with the hostname or IP address of the computer that the primary server runs on: http://hostname:15080/pd

After you are authenticated, you can explore the user interface. Highlights of the user interface include:

  • The Main page includes portlets that show system health, job status, and device status in graphical ways by using colors and graphics. Users can tell at a glance the overall status of their system and easily drill down for more detail as desired.
  • On the Main page, you can move portlets by clicking the title bar, dragging the portlet to a different position, then releasing the mouse button to drop the portlet. You can also maximize any portlet, so that it fills the entire browser window. The Fit portlets to window action, lets you resize all the portlets at once so they fill the available window size.
  • You can customize the columns available in all portlets and object tables, using the Manage columns action under the Settings () menu. If a table appears on both the Main and Administration pages, you can save different columns on each page.
  • Both the Main and Administration pages are automatically updated to show property and status changes. You do not need to refresh the browser to see the most recent information.
      Note:
    • If there are more than 1500 jobs in the Jobs table, property and status changes for jobs are not updated automatically. Other portlets continue to update automatically.
  • You can add, copy, and delete all types of devices from the Main page as well as from the Administration page. On both pages, Copy and Delete are available on the More actions menu. On the Administration page, the Add action is available at the top of the table on the right side. On the Main page, the Add action is on the Settings () menu.

  • The Jobs table displays up to 1500 jobs without using pagination controls. You can scroll through the entire list of jobs in the same table, instead of advancing through them page by page.
  • Most portlets and tables include a filter that you can use to find entries easily. Click the Filter icon () and type in the box. The portlet or table displays only rows that include the text you entered.
  • The Jobs portlet includes an Advanced filter. Click the arrow to the left of the Advanced filter title to expand the filter and specify the conditions that you want to use to filter the Jobs table.
  • You can manage access to objects on both the Main and Administration pages based on location properties. If you assign objects such as printers, input devices, and jobs to specific locations, you can use the Allowed locations property for each user to define which locations they can see in the user interface.

    The Locations to show property lets users select which of their allowed locations to display in the user interface. If a user chooses to show a subset of the allowed locations, a location icon () displays in the banner area.

  • The help window that opens when you click the can be moved to a different position and resized to show more or less information. You can also highlight text in the window, so you can copy it.
The user interface is available in these languages:
  • Brazilian Portuguese (pt_BR)
  • English (en_US)
  • French (fr_FR)
  • German (de_DE)
  • Italian (it_IT)
  • Japanese (ja_JP)
  • Spanish (es_ES)
RICOH ProcessDirector information center

The information center contains topics that help users learn about and use RICOH ProcessDirector.

Open the information center by clicking ? Help in the banner of the user interface. In addition, you can bookmark the location of the information center in your browser and open it outside of RICOH ProcessDirector.

1.1.2.1.1 Features

RICOH ProcessDirector features provide more functions or let you add devices like inserters to the system. The modular design of RICOH ProcessDirector lets you add features to the base product as your business needs change. Most features are integrated seamlessly into the user interface.

Most features can be installed using the Feature Manager, available after you install the base product.

Features are copied to your system when you install the base product, but are not fully installed until you use Feature Manager to install them.

When you install a feature with Feature Manager, the feature is in trial mode. To continue using a feature after the trial period, you must purchase the feature and install a license key for it. If you do not install a license key, the feature stops working at the end of the trial period.

RICOH ProcessDirector features
Description CD number
Advanced Transform feature

The Advanced Transform feature lets you transform print jobs to or from these file formats:

  • AFP
  • PCL
  • PDF
  • PostScript
  • BMP, GIF, JPEG, PNG, TIFF (only as input data streams)

You can purchase and install any combination of these transform options.

    Note:
  • You install the Advanced Transform feature using Feature Manager. A separate license key is required for each input and output transform that you purchase. For example, if you buy Input PostScript and Output AFP, you need two license keys.
LCD2-20004
AFP Editor

AFP Editor lets you create barcodes and hide areas in indexed AFP files. You can create barcodes that contain index values, job properties, and static text. For example, if the ZIP codes in an AFP file are index values, you can create barcodes that contain the ZIP codes. You can hide areas in AFP files. No one can see the data in the hidden areas, and the data does not print. For example, you can hide areas that contain existing barcodes that you want to replace. In addition, AFP Editor can automatically replace POSTNET barcodes with Intelligent Mail barcodes (IMBs) that have the same routing code. You can also add text strings, such as Page x of y, to formatted AFP files.

You must have the AFP Support feature installed to use the AFP Editor feature.

LCD4-5680
AFP Support

The AFP Support feature lets you control and track jobs and individual documents in Advanced Function Presentation (AFP) format. AFP provides a transaction-oriented data stream that guarantees integrity between the RICOH ProcessDirector server and its printers. The printers can deliver the exact status of every page as it is received, printed, and stacked. The feature adds support for AFP and PCLOut printers.

The feature includes RICOH Visual Workbench with AFP Indexer, Document Property Designer, and AFP Enhancer modes. RICOH Visual Workbench lets you identify individual documents in AFP files and extract data from the documents. Step templates let you add steps to your workflows that use the extracted data to sort, split, and group the documents into new jobs.

The AFP Support feature is a prerequisite for many other features that work with AFP data. Without the feature, you can view but not print AFP data, and you can pass AFP jobs to other programs.

LCD2-20057
Archive

Archive lets you store jobs, documents, and job processing history in a repository and retrieve them by searching for job and document properties. For example, you search for documents by job name, customer name, and account number. After you retrieve a job or document, you can view it, review the properties that were stored with it, and check the production history. You can save the job or document to your workstation, or submit it to a workflow for reprinting or other processing.

You must have the AFP Support or PDF Document Support feature installed to use the Archive feature.

LCD2-20049
Automated Verification

The Automated Verification feature lets you add barcodes to the documents in a print job. By reading barcodes, cameras or barcode scanners detect documents that failed to complete a step in their workflow. You can automatically reprint missing documents or manually pull them out of their workflow. A job log records the disposition of the documents in each job and the user ID of the operator who did the dispositions.

You must have the AFP Support or PDF Document Support feature installed to use the Automated Verification feature.

LCD2-20045
Avanti Slingshot Connect

With the Avanti Slingshot Connect feature, you can receive jobs and JDF job tickets from the Avanti Slingshot MIS system and process them within RICOH ProcessDirector. RICOH ProcessDirector can then provide status of the job back to Avanti Slingshot as it moves through the system.

LCD2-20050
Cut Sheet Support for Kodak

With this feature, you can define and drive Kodak cut sheet printers from RICOH ProcessDirector. RICOH ProcessDirector converts media and stapling requests into the KDK format used by these printers.

LCD2-20043
Cut Sheet Support for Xerox

With this feature, you can define and drive Xerox cut sheet printers from RICOH ProcessDirector. RICOH ProcessDirector converts media and stapling requests into the XRX or XPIF format used by these printers.

LCD2-20044
Deadline Tracker

Deadline Tracker lets you manage your progress toward meeting your delivery deadlines. If you have service level agreements with your customers, this feature helps you make sure that their jobs are on schedule to be completed on time. You can see when jobs are behind schedule or risk missing their deadlines. This information helps operators prioritize work and act to bring jobs back on track for on-time delivery. You can monitor expected work (jobs that you expect to receive at set intervals). If the jobs do not arrive in time, you can inform the sender.

LCD2-20046
Electronic Presentment

The Electronic Presentment feature provides a sample workflow that receives jobs from a sample input device and uses a sample history record notification to capture the times when jobs are printed and mailed. The workflow stores jobs, documents, property values, and history information in a sample repository.

This no-charge feature is provided with the base product, but not installed by default.

You must have the Archive feature installed to use the Electronic Presentment feature.

LCD2-20054
Inserter

Inserter automates the insertion of printed documents and inserts (such as marketing materials) into envelopes. The feature can communicate with inserter controllers by sending control files to them and receiving results files from them. Using information in the results file, the feature tracks the insert status of each document in the job. Jobs are reconciled automatically (or manually, with operator control). Reprints are automatically generated for damaged documents.

You must have the AFP Support or PDF Document Support feature installed to use the Inserter feature.

LCD2-20058
Language pack

The Language pack includes translations for the user interface and help system. Install this feature to use the user interface in a supported language.

Not Applicable
MarcomCentral Connect

The MarcomCentral Connect feature lets you integrate the online-storefront and web-to-print functions of MarcomCentral into your production workflows. Sample web service input devices retrieve orders for print, digital, and other items from MarcomCentral. RICOH ProcessDirector creates a job for each order and notifies MarcomCentral when the items in the job complete specified steps in the sample workflow.

You must have the Web Services Enablement feature installed to use the MarcomCentral Connect feature.

LCD2-20074-00
PDF Document Support

The PDF Document Support feature adds functions and objects that let you control and track individual documents in PDF jobs. The feature includes RICOH ProcessDirector Plug-in for Adobe Acrobat. The plug-in lets you identify individual documents, extract data from the documents, and add enhancements such as barcodes, OMR marks, images, hidden areas, and text. Step templates let you add steps to your workflows that use the extracted data to sort, split, and group the documents into new jobs.

This no-charge feature is provided with the base product but is not installed by default.

Not Applicable
PitStop Connect

PitStop Connect lets you integrate preflight operations that use Enfocus PitStop Server 10 into your print workflows for PDF print jobs.

Enfocus PitStop Server is not included in this feature; it is a product that must be purchased separately.

LCD2-20013
Postal Enablement

Postal Enablement lets you extract mailing address data from the documents in a job and prepare the data for processing by external postal software. After the postal software verifies the addresses and improves their quality, Postal Enablement updates the documents in the job with the results from the postal software.

Postal software is not included in this feature. You can use your choice of external postal software.

You must have the AFP Support or PDF Document Support feature installed to use the Postal Enablement feature.

LCD2-20048
Preference Management

Preference Management lets you update document property values with values from an external preferences file. These values can be used to change the content of selected documents or to change the processing of those documents.

This no-charge feature is provided with the base product, but not installed by default.

You must have the AFP Support or PDF Document Support feature installed to use the Preference Management feature.

LCD2-20053
Preprinted Forms Replacement

The Preprinted Forms Replacement feature lets you print jobs on plain paper that previously required preprinted forms. You update the definition of each media object for the media requested by these jobs to include the electronic equivalent of the preprinted form data. The application that submits the print files to RICOH ProcessDirector can continue to specify the media for the jobs in the same way.

You must have the AFP Support or PDF Document Support feature installed to use the Preprinted Forms Replacement feature. If you install the AFP Support feature, the Preprinted Forms Replacement feature also lets you insert PDF forms into AFP jobs.

LCD2-20076
Quadient Inserter Express

The Quadient Inserter Express feature is a simplified version of the Inserter feature, which includes support for only Quadient inserters. The feature provides sample objects that you can use as templates for configuring RICOH ProcessDirector to communicate with Quadient inserters.

You must have the AFP Support or PDF Document Support feature installed to use the Inserter feature.

LCD2-2007711
Quadient Inspire Connect

Quadient Inspire Connect extends RICOH ProcessDirector to make it easier to interact with Quadient® Inspire V8 or above. The feature adds system objects tailored to work with files created by Quadient Inspire so they can be submitted to the processing engine to generate print jobs as part of a print workflow.

Quadient Inspire is not included in this feature; it is a product that must be purchased separately.

You must have the AFP Support feature installed to create AFP files with Quadient Inspire.

LCD4-6598
Reports

The Reports feature lets you capture selected job properties and printer status changes in a PostgreSQL database. To extract data and visualize it, you can use a business intelligence tool, such as Tableau.

This no-charge feature is provided with the base product, but not installed by default.

LCD4-5682
RICOH Supervisor Connect

The RICOH Supervisor Connect feature lets you send data collected by the Reports feature in the PostgreSQL data base to the RICOH Supervisor application in the cloud.

LCD2-2007907
RICOH Transform features

RICOH Transform features provide a powerful and cost-effective system for transforming jobs to or from the format for Advanced Function Presentation (AFP) printing. The RICOH Transform features are:

  • PostScript/PDF to AFP

    Converts PDF and PostScript into AFP

  • RICOH PCL to AFP

    Converts PCL into AFP

  • RICOH SAP to AFP

    Converts SAP OTF and ABAP into AFP

  • RICOH AFP to PDF

    Converts AFP into PDF

    Note:
  • You use the InfoPrint Transform Manager user interface and help system for some Transform configuration tasks. If you install more than one Transform feature, they share the InfoPrint Transform Manager interface.
  • All RICOH Transform features include image transforms (GIF to AFP, JPEG to AFP, and TIFF to AFP), which convert GIF, JPEG, and TIFF images to AFP.
  • A separate license key is required for each purchased transform.
  • You cannot install any of the RICOH Transform features using Feature Manager.
  • You must have the AFP Support feature installed to use the RICOH Transform features.
  • The APPE conversion tool is installed with the Ricoh Transform features.
  • PostScript/PDF to AFP Transforms, LCD4-5671
  • RICOH PCL to AFP Transform, LCD4-5672
  • RICOH SAP to AFP Transform, LCD4-5673
  • RICOH AFP to PDF Transform, LCD4-5674
Secondary Server

You can set up RICOH ProcessDirector servers that run on different computers and that interact with the primary server. The additional servers are called secondary servers.

You can use secondary servers to run external programs that workflows send jobs to. To move some processing from the primary computer to the secondary computer, you can define printers that use the secondary server as their parent server.

You cannot install this feature using Feature Manager.

LCD4-5635
Security

Security provides advanced functions, including password requirements, that increase the security of user accounts.

If you have a Lightweight Directory Access Protocol (LDAP) or Active Directory server, you can use LDAP user IDs and passwords to authenticate into RICOH ProcessDirector.

This no-charge feature is provided with the base product but is not installed by default. Installing it provides more control over the security of user accounts such as expiring unused accounts or enabling enforcement of complex password rules.

Not Applicable
Ultimate Impostrip® Connect

Ultimate Impostrip® Connect lets you integrate the imposition functions of Ultimate Impostrip® Automation or Scalable into your RICOH ProcessDirector workflows.

Ultimate Impostrip® is not included in this feature; it is a product that must be purchased separately.

LCD2-20026
Web Services Enablement

The Web Services Enablement feature lets you call REST and SOAP web services from your production workflows to exchange data with third-party applications.

The feature adds support for input devices, step templates, and notification objects that can send web service requests.

LCD2-20074-00
Whitespace Manager

Whitespace Manager lets you define available areas of white space in AFP files. You can fill the white space with content, such as images and text, during the print production process. You place content in a white-space area based on rules you define to target content for specific customers or for the best use of available space.

You must have the AFP Support feature installed to use the Whitespace Manager feature.

LCD4-5699
WPM Connect

WPM Connect lets you integrate the WPM tool into RICOH ProcessDirector workflows for more processing.

This feature is only available in Japan.

You must have the AFP Support feature installed to use the WPM Connect feature.

WPM is not included in the WPM Connect feature; it is a product that must be purchased separately.

LCD2-20014

1.1.2.1.2 Secondary servers

Secondary servers let you distribute processing, so that your RICOH ProcessDirector system runs more efficiently.

You can use secondary servers to do some of the more processing-intensive steps in your various workflows and to prevent the primary server from becoming overloaded. The primary server works with the secondary servers to coordinate the movement of all jobs across the system. The secondary servers do not have their own embedded databases for storing system information. All the servers work with the database that is installed on the primary computer.

RICOH ProcessDirector supports different types of secondary servers:

Local secondary servers
Created directly on the primary computer. Require minimal configuration.
Remote secondary servers
Created on a Linux computer that is separate from the primary computer. You must install a Secondary Server feature on the remote computer and set up communication between the secondary server and the primary server.
Container secondary servers
Created either on the Linux primary computer or on a Linux computer that is separate from the primary computer. You must install Docker Engine 19.03 or above on the computer that will host the container secondary server. On a remote computer, you must also set up communication between the secondary server and the primary server. In addition, you might need to install a Secondary Server feature.

Then, you create the container secondary server in RICOH ProcessDirector. Creating the server loads an image into a Docker container on the computer. The image contains a Linux operating system and everything needed to run a RICOH ProcessDirector secondary server.

Secondary servers can manage all types of RICOH ProcessDirector objects, such as input devices, steps, and printers. They can also run external programs that RICOH ProcessDirector accesses through external steps. External programs can do more processing or special types of processing.

For installations that have many printers and a high volume of jobs, adding secondary servers to the system can increase job throughput. The throughput increases because each server has a smaller number of printers and jobs to monitor and control.

For AFP printers, you can set up secondary servers to stage work to the remote server so that RICOH ProcessDirector keeps the pipeline to the printer full, reducing the likelihood that the printer waits for data. This configuration is particularly useful if you installed RICOH ProcessDirector on an externally hosted or distributed network, such as a virtualized or cloud environment that is far removed from the physical printers. Properties of the AFP printer object allow you to specify a directory on the secondary server to receive the print files. The secondary server then manages releasing jobs to the AFP printer when the printer needs work.

You can create secondary servers on the primary computer or install the Secondary Server feature on these systems:

  • CentOS Linux 7.9 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • Rocky Linux 8.4 through latest 8.X
  • Rocky Linux 9.0 through latest 9.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64

1.1.2.1.3 Application server

An application server is a Windows system configured to communicate with RICOH ProcessDirector. If your workflows require processing by applications that run on Windows, you can access those applications by installing RICOH ProcessDirector application server code on a Windows computer.

Application servers share the database that the primary server uses and work with the primary server to process jobs effectively. Because application servers are installed on Windows computers, they can run steps that require applications on Windows. They cannot run other steps, such as PrintJobs.

Application servers can be the parent servers for Ricoh PDF printers, Custom PDF printers, and Passthrough printers. They cannot be the parent servers for other kinds of printers.

You can install application servers on these operating systems:

  • Windows 10 Pro or Enterprise 64-bit
  • Windows 11 Pro
  • Windows Server 2019 64-bit
  • Windows Server 2022 64-bit

1.1.2.1.4 Extended features

RICOH ProcessDirector extended features are custom software components that you can purchase from your Ricoh support representative. The Ricoh support representative installs the extended features on the existing RICOH ProcessDirector primary computer.

1.1.2.2 Compatible products

You can use these products from Ricoh and its subsidiaries with RICOH ProcessDirector:

Avanti Slingshot
Avanti Slingshot is a JDF-certified print management information platform. with the Avanti Slingshot Connect feature, you can use RICOH ProcessDirector and Slingshot together, passing jobs and data between the programs.
RICOH InfoPrint Manager
InfoPrint Manager for AIX (Program Number 5765-F68), InfoPrint Manager for Linux (Program Number 5648-F40-0003L, and InfoPrint Manager for Windows (Program Number 5639-N49) are print servers that handle scheduling, archiving, retrieving, and assembly of a print job and its related resource files. InfoPrint Manager cannot be installed on the same server as RICOH ProcessDirector.
MarcomCentral
MarcomCentral is a distributed marketing software platform that you can use to customize and distribute marketing materials. With the MarcomCentral Connect feature, you can integrate MarcomCentral with your RICOH ProcessDirector workflows.
RICOH InfoPrint XT
RICOH InfoPrint XT for Linux (Program Number 5765-XTA) and RICOH InfoPrint XT for Windows (Program Number 5765-XTA) transform Xerox metacode and line conditioned data stream (LCDS) jobs to AFP.

If you plan to install RICOH InfoPrint XT for Linux on the same server as RICOH ProcessDirector, make sure that it is installed after RICOH ProcessDirector.

Requires the AFP Support feature.

RICOH Supervisor
RICOH Supervisor is a cloud-based application that helps you monitor, understand, and improve your print production environment through visual representations. With the Reports and RICOH Supervisor Connect features, you can collect data about your print operations, send them to RICOH Supervisor, and create custom dashboards to display the data.

You can use these products from other companies with RICOH ProcessDirector:

AFP Download Plus
AFP Download Plus is a separately ordered feature of IBM Print Services Facility for z/OS (IBM Program Number 5655-M32) that transforms line data to MO:DCA-P data and then transmits the print job with all required resources to RICOH ProcessDirector.

Requires the AFP Support feature.

Download for z/OS
Download for z/OS is a separately ordered feature of IBM Print Services Facility for z/OS (IBM Program Number 5655-M32) and is used to submit jobs to RICOH ProcessDirector. Download for z/OS automatically transmits output across the TCP/IP network from the host system to RICOH ProcessDirector for printing or archiving.

Requires the AFP Support feature.

Enfocus PitStop Server
PitStop Server provides PDF preflight functionality. With the PitStop Connect feature, you can include steps to send PDFs jobs to PitStop in your RICOH ProcessDirector workflows.
Ultimate Impostrip®
Ultimate Impostrip® optimizes prepress imposition processes. With the Ultimate Impostrip® Connect feature, you can integrate the imposition functions of Ultimate Impostrip® Automation or Scalable into your RICOH ProcessDirector workflows.
Quadient Inspire
Quadient Inspire enables organizations to create and deliver personalized, compliant customer communications across all digital and traditional channels, from one centralized hub. With the Quadient Inspire Connect and AFP Support features, you can send AFP jobs to Quadient Inspire for processing during your RICOH ProcessDirector workflows.

1.1.2.3 System configurations

You can install RICOH ProcessDirector with various system configurations. The hardware configurations can include:

  • Primary computer
  • Primary computer with one or more secondary servers on the same computer
  • Primary computer with an application server on a Windows computer
  • Primary computer with one or more secondary servers on different computers
  • Primary computer with a backup (failover) computer and an NFS-mounted file system

    In this configuration, only one primary server can be running at a time. System objects are created and stored on the mounted file system, so they can be accessed from the backup computer in case of a hardware failure or other outage.

Example of a system configuration shows a configuration of RICOH ProcessDirector with the AFP Support feature. The configuration has a primary server and a secondary server on a separate Linux computer. It also shows RICOH ProcessDirector components, including the optional RICOH Transform features, and the optional products you might use with RICOH ProcessDirector, including Download for z/OS and AFP Download Plus.

Example of a system configuration
The graphic shows the configuration described in the text.

Example of a configuration with active and backup computers using an NFS server shows a configuration with two primary computers (an active and a backup) and an NFS server that holds their shared file systems.

Example of a configuration with active and backup computers using an NFS server
The graphic shows a configuration with two primary computers, Node A and Node B, and an NFS server. The computers have identical operating systems and software components. They are all connected to the network. The NFS server holds these file systems: /aiw, /var/aiw, var/psf.

1.1.3 Planning for installation

Before you install or upgrade RICOH ProcessDirector, you must do these planning tasks:

  • Obtain required hardware.
  • Determine your file system setup.
  • Install required software.
  • Install optional software.

You can use the checklist in Installation planning checklist and the Task checklists at the beginning of each chapter to help you keep track of the planning tasks you have completed.

    Note:
  • Your software installs in trial mode. The trial license expires after 60 days. For more information about obtaining and installing license keys, see Downloading and installing license keys.

When you finish preparing your computers, continue with the appropriate section:

1.1.3.1 Task checklist

Here are the tasks in this chapter that you need to verify are complete. Check each item as you verify it.

Checklist for verifying that planning is complete
  Task
  The installation planning checklist is complete.

See Installation planning checklist.

  Required hardware has been obtained.

See Hardware requirements.

  Required software had been installed.

See Installing required software.

  Optional software that you want to use has been installed.

See Planning for optional software.

1.1.3.2 Hardware requirements

The computer or computers that you install the RICOH ProcessDirector base product on must meet minimum requirements. If you install RICOH ProcessDirector features on the same computer, it might need more memory, storage space, CPU, or network bandwidth.

Different components and features of RICOH ProcessDirector are installed on separate computers. Those computers have different minimum requirements than the one that the base product and all other features are installed on. These components are:

  • Application servers

    See Application server computers for hardware requirements.

  • Secondary Server

    See Secondary computers for hardware requirements.

  • RICOH ProcessDirector Plug-in for Adobe Acrobat (part of the PDF Document Support feature)

    See RICOH ProcessDirector: Installing Document Processing Features, G550-20312, for a description of the requirements.

The performance of RICOH ProcessDirector and its attached printers depends on the availability and efficiency of memory, processors, disk space, and network resources in the system configuration. Performance also depends on the content of the print data streams being processed and the overall load on the system. For example, complex print jobs, such as those containing images or bar codes, require more resources than those containing plain text. For help determining which hardware configuration meets your print requirements, contact your Ricoh representative to request a workload analysis and system sizing.

    Important:
  • References to amount of RAM or free disk space are precise. Using commonly accepted estimates in your calculations might cause your system to fail prerequisite validation.

    For example:

    • 4 GB of free disk space is equal to 4,096 MB or to 4,294,967,296 bytes.

      4 GB is not equal to 4,000 MB or to 4,000,000,000 bytes.

      If the requirement is 4 GB, 4,000 MB is not enough.

    • 12 GB of free disk space is equal to 12,288 MB or to 12,884,901,888 bytes.

      12 GB is not equal to 12,000 MB or to 12,000,000,000 bytes.

      If the requirement is 12 GB, 12,000 MB is not enough.

  • RICOH ProcessDirector hardware requirements are for physical processors and CPU cores. As an alternative, you can run RICOH ProcessDirector on a properly configured virtual machine (VM) guest. Define the VM guest so that the number of dedicated CPUs exceeds the recommended minimum hardware requirements for your configuration.

      Important:
    • Using fewer than the recommended number of physical processors can result in RICOH ProcessDirector workflow performance issues especially under load, failure of the RICOH ProcessDirector system, or failure to install RICOH ProcessDirector or any of its features.

    Examples:

    • On a physical server with 16 cores, do not configure the RICOH ProcessDirector guest environment to have 24 CPUs.
    • On a physical server with 16 cores, do not run two guest systems, each allocated 8 CPUs, where one guest is running the RICOH ProcessDirector software because the host software requires some resources.
    • Do not install RICOH ProcessDirector on a virtual host that is configured to overcommit the physical CPU resources.

  • Hardware requirements stated for other computing resources including memory, disk space, network I/O, and disk I/O should also be considered as requirements for a virtualized environment.

1.1.3.2.1 Primary computer

The system hardware requirements for the computer that the RICOH ProcessDirector base product (and most features) is installed on are:

  • An x86 computer that can run one of these 64 bit operating systems:
    • CentOS Linux 7.9 through latest 7.X for x86_64
    • Red Hat 7.6 through latest 7.X
    • Red Hat 8.1 through latest 8.X
    • Rocky Linux 8.4 through latest 8.X
    • Rocky Linux 9.0 through latest 9.X
    • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
    • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64

      Using the latest service pack is recommended.

      Note:
    • CentOS and Rocky Linux distributions are based on the Red Hat code base. References to Red Hat-derived operating systems in this documentation indicate that the statement or instruction is appropriate for Red Hat, CentOS, and Rocky Linux.
    • The DB2 database cannot be installed on Rocky Linux. As a result, you can only install RICOH ProcessDirector with the PostgreSQL database on Rocky Linux.
  • 200 GB free hard-drive space
  • Minimum of 8 GB available RAM is required

    More available RAM is required for high system loads. Large jobs, many jobs, jobs with many documents, workflow steps that run in parallel, and memory-intensive external programs all increase system loads.

      Important:
    • A minimum of 16 GB available RAM is required when you are using one or more document processing features, for example:
      • AFP Support
      • PDF Document Support
      • Archive
      • Automated Verification
      • Inserter
      • Postal Enablement
      • Preference Management

      Depending on the number of documents you process, you might need more RAM or free hard-drive space.

The operating system level does not have to be the same on the primary computer and on the computers that the Secondary Server features are installed on.

If you plan to install the base product on two computers so you can have an active computer and a backup (failover) computer, both computers must meet the minimum requirements for the RICOH ProcessDirector base product and features you are installing. The hardware does not have to be identical, but the operating system must be identical, including version, release, and service updates. You must also configure an NFS-mounted file system that your computers can access. That file system must have enough free space to hold the required file systems. The recommended size for the mounted file system is at least 110 GB.

The following features have more hardware requirements. These requirements are added to the requirements listed for the primary computer; they do not replace those requirements.

  • Advanced Transform feature
    • Minimum 1 GB more free hard-drive space allocated to the RICOH ProcessDirector/opt file system
    • Minimum 2 GB more free hard-drive space allocated to the /aiw/aiw1 file system
        Note:
      • Large jobs sometimes require more RAM to process efficiently.
  • RICOH Transform features

    These requirements apply only to the RICOH Transform features (such as, PostScript/PDF to AFP and Ricoh PCL to AFP), not to the Advanced Transform feature.

    • Minimum of an extra 10 GB free hard-drive space.
    • An extra 1 GB RAM for every CPU core, but no less than 4 GB.

      For example, if the computer has:

      • One dual-core processor, it must have an extra 4 GB RAM.
      • Two quad-core processors, it must have an extra 8 GB RAM.
      • Three quad-core processors, it must have an extra 12 GB RAM.
      • Four quad-core processors, it must have an extra 16 GB RAM.

1.1.3.2.2 Secondary computers

You can install RICOH ProcessDirector Secondary Server features on computers that meet these requirements:

  • An x86 server that runs one of the following:
    • CentOS Linux 7.9 through latest 7.X for x86_64
    • Red Hat 7.6 through latest 7.X
    • Red Hat 8.1 through latest 8.X
    • Rocky Linux 8.4 through latest 8.X
    • Rocky Linux 9.0 through latest 9.X
    • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
    • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64
  • If you only plan to run steps on the secondary server, you need 20 GB of free hard-drive space. If you plan to define printers on the secondary server, you need 200 GB or more of free hard-drive space.

    We recommend that this space is not in the rootvg volume group on Logical Volume Manager (LVM) systems.

  • Minimum of 1 GB available RAM for each secondary server. You might require more RAM, depending on the type and number of steps that you run on the secondary server and the number of printers that you define on the secondary server.

1.1.3.2.3 Application server computers

An application server has these hardware requirements:
  • An x86 computer that can run one of these operating systems:
    • Windows 10 Pro or Enterprise 64-bit
    • Windows 11 Pro
    • Windows Server 2019 64-bit
    • Windows Server 2022 64-bit
  • A minimum of two, 2.0 GHz CPU cores
  • At least 4 GB RAM

1.1.3.2.4 Other hardware requirements

  • A dual layer DVD drive or equivalent.

    The installation program for the RICOH ProcessDirector base product is provided on a DVD or as an ISO image, features are included with the base product, but updated features might be provided on DVDs, CDs, or as ISO images. To install the product, choose one of these options:

    • Mount the ISO image to the server that you plan to install on. For instructions about how to mount an ISO file, see Mounting an ISO file.
    • Use a DVD drive that is installed in either the primary or the secondary computer. In this case, you run the installation programs from the DVDs or CDs.
    • Use a DVD drive on another UNIX-based system in your network. In this case, you copy the installation program and supporting files into a remote location on a UNIX-based system in your network and use the network installation procedure to install RICOH ProcessDirector.
        Note:
      • Due to operating system incompatibilities, you cannot use a DVD drive on a Windows system to copy the files into a staging location on a Linux computer.

      You can either copy the installation program and supporting files onto the primary computer, the secondary computer, or onto a separate file server.

  • If you install RICOH ProcessDirector with IBM DB2 provided by Ricoh, you must mount two discs or ISO files at the same time. If you install RICOH ProcessDirector using physical discs, make sure you have two drives available. If you do not, follow the procedure for Installing from a remote directory to copy one of the installers to a server and install from there.
  • If you install by copying the installers or ISO images to a system in your network, the directory that you store the installers in must have sufficient room for the downloaded files. The ISO Downloads page on the Ricoh website specifies how much space is required for each package. See Downloading installation files for more details.
  • If you install your own licensed copy of the DB2 server on a different computer and use a DB2 client on the primary computer to interact with it, the computer that the DB2 server is installed on must have a minimum of 4 GB available RAM for each DB2 instance that you create for RICOH ProcessDirector to use.
  • If you install the PDF Document Support feature, the RICOH ProcessDirector Plug-in for Adobe Acrobat must run on a Windows computer. See RICOH ProcessDirector: Installing Document Processing Features, G550-20312, for hardware requirements.

1.1.3.2.5 Supported RICOH printers

These printers can be defined in RICOH ProcessDirector as Ricoh PDF printers. Find your printer and controller/DFE below to determine which datastream and port values to use when you define the printer.
    Note:
  • Some printers support more than one controller. As a result, printer models might be listed in more than one table.
Printers with the Ricoh standard internal controller

These printers must have the PostScript option installed. For these printers, set the Datastream to send value to PostScript and the Port value to 9100.

  • Gestetner DSm7110
  • Gestetner DSm7135
  • Gestetner DSm790
  • Gestetner P7675
  • IM C6500
  • IM C8000
  • Infoprint 2190
  • Infoprint 2210
  • Infoprint 2235
  • Lanier LD1100
  • Lanier LD1135
  • Lanier LD190
  • Lanier LD260c
  • Lanier LD275c
  • Lanier LD365C
  • Lanier LD375C
  • Lanier LP275
  • Lanier SP 9100
  • MP 1100
  • MP 1350
  • MP 9000
  • MP C6000
  • MP C6501SP
  • MP C7500
  • MP C7501SP
  • Pro 1106EX
  • Pro 1107
  • Pro 1107EX
  • Pro 1107EXP
  • Pro 1356EX
  • Pro 1357
  • Pro 1357EX
  • Pro 1357EXP
  • Pro C5100S
  • Pro C7100SX
  • Pro C5110S
  • Pro C5200S
  • Pro C5210S
  • Pro C5300S
  • Pro C5300SL
  • Pro C5310S
  • Pro 6100
  • Pro 6100HE
  • Pro 6100HT
  • Pro C7100
  • Pro C7100S
  • Pro C7100X
  • Pro C7110
  • Pro C7110S
  • Pro C7110SX
  • Pro C7110X
  • Pro C7200
  • Pro C7200e
  • Pro C7200S
  • Pro C7200SL
  • Pro C7200SX
  • Pro C7200X
  • Pro C7210
  • Pro C7210S
  • Pro C7210SX
  • Pro C7210X
  • Pro 8100EX
  • Pro 8100S
  • Pro 8100Se
  • Pro 8110
  • Pro 8110e
  • Pro 8110S
  • Pro 8110Se
  • Pro 8120e
  • Pro 8120S
  • Pro 8120Se
  • Pro 8200S
  • Pro 8210
  • Pro 8210S
  • Pro 8220
  • Pro 8220S
  • Pro 8300S
  • Pro 8310
  • Pro 8310S
  • Pro 8320
  • Pro 8320S
  • Pro 906EX
  • Pro 907
  • Pro 907EX
  • Pro 907EXP
  • Savin C6055
  • Savin C7570
  • SAVIN 8090
  • SAVIN 8110
  • SAVIN 8135
  • Savin C9065
  • Savin C9075
  • Savin MLP175n
  • SP 9100DN
Printers with the RICOH TotalFlow Print Server

For these printers, set the Datastream to send value to JDF/PDF. Use the default value for the Port setting.

  • Pro C7100
  • Pro C7100S
  • Pro C7100SX
  • Pro C7100X
  • Pro C7110
  • Pro C7110S
  • Pro C7110SX
  • Pro C7110X
  • Pro C7200
  • Pro C7200e
  • Pro C7200S
  • Pro C7200SX
  • Pro C7200X
  • Pro C7210
  • Pro C7210S
  • Pro C7210SX
  • Pro C7210X
  • Pro C9100
  • Pro C9110
  • Pro C9200
  • Pro C9210
Printers with N- series EFI Fiery controllers

For these printers, set the Datastream to send value to Ricoh API for Fiery. Use the default value for the Port setting.

  • Pro C7500
  • Pro C7500H
  • Pro C7500HT (Japan only)
  • Pro C9500
  • Pro C9500H
  • Pro Z75
  • Pro Z75 (Japan version)
Printers with E- and EB- series EFI Fiery controllers

For these printers, set the Datastream to send value to JDF/PDF. Set the Port value to 9102 to send jobs to the Print queue or 9103 to send jobs to the hold queue.

Note: RICOH ProcessDirector only supports these printers with the controllers listed. If your printer uses a different controller, it cannot be defined as a Ricoh PDF printer.

Printer model Controller   Printer model Controller
  • Gestetner DSm7110
  • Gestetner DSm7135
  • Gestetner DSm790
  • EB-135
 
  • Pro C550EX
  • Pro C700EX
  • E-8100
  • Lanier LD1100
  • Lanier LD1135
  • Lanier LD190
  • EB-135
 
  • Pro C5300SL
  • E-27B
  • Lanier LD260c
  • Lanier LD275c
  • E-7100 with Fiery V1.1 and higher
 
  • Savin C6055
  • Savin C7570
  • E-7100 with Fiery V1.1 and higher
  • Lanier LD365C
  • Lanier LD375C
  • E-7200
 
  • Pro C651EX
  • Pro C751
  • Pro C751EX
  • E-41A
  • MP 1100
  • MP 1350
  • MP 9000
  • EB-135
 
  • Pro C7100
  • Pro C7100S
  • Pro C7100SX
  • Pro C7100X
  • Pro C7110
  • Pro C7110S
  • Pro C7110SX
  • Pro C7110X
  • E-43A/E-83
  • MP C6000
  • MP C7500
  • E-7100 with Fiery V1.1 and higher
  • E-8100 with Fiery V1.1 and higher
 
  • Pro C720
  • Pro C720S
  • E-40
  • MP C6501SP
  • MP C7501SP
  • E-7200
 
  • Pro C7200
  • Pro C7200e
  • Pro C7200S
  • Pro C7200SX
  • Pro C7200X
  • Pro C7210
  • Pro C7210S
  • Pro C7210SX
  • Pro C7210X
  • E-45A/E-85A
  • E-46A/E-86A
  • Pro 1106EX
  • Pro 1356EX
  • Pro 906EX
  • EB-135
 
  • Pro C7200SL
  • E-35A
  • E-36A
  • Pro 1107EX
  • Pro 1357EX
  • Pro 907EX
  • EB-1357 with Fiery V1.1 and higher
 
  • Pro C900
  • Pro C900S
  • E-40/E-80 with Fiery V4.0 and higher
  • Pro 8100EX
  • Pro 8100S
  • Pro 8100Se
  • Pro 8110
  • Pro 8110e
  • Pro 8110S
  • Pro 8110Se
  • Pro 8120
  • Pro 8120e
  • Pro 8120S
  • Pro 8120Se
  • EB-32
 
  • Pro C901
  • Pro C901S
  • E-41/E-81
  • E-42/E82
  • Pro 8200S
  • Pro 8210
  • Pro 8210S
  • Pro 8220
  • Pro 8220S
  • EB-34
 
  • Pro C9100
  • Pro C9110
  • E-43/E-83
  • Pro 8300S
  • Pro 8310
  • Pro 8310S
  • Pro 8320
  • Pro 8320S
  • EB-35
 
  • Pro C9200
  • Pro C9210
  • E-45/E-85
  • E-46/E-86
  • Pro C5100S
  • Pro C5110S
  • E-22B/E-42B
 
  • SAVIN 8135
  • SAVIN 8110
  • SAVIN 8090
  • EB-135
  • Pro C5200S
  • Pro C5210S
  • E-24B/E-44B
 
  • Savin C9065
  • Savin C9075
  • E-7200
  • Pro C5300S
  • Pro C5310S
  • E-27B/E-47B
     

1.1.3.3 Planning for file systems

You can set up your file system as partitions or as a mounted file system from other storage units. However, if you plan to install the RICOH ProcessDirector base product on two computers (an active computer and a backup computer), you must create them on the mounted file system so both computers can access them.
  • On Linux computers that the base product or a Secondary Server feature is installed on:
    • A single partition is the simplest file system setup. The RICOH ProcessDirector installer can create directories in a single partition automatically.
    • Multiple partitions let the system continue functioning when it runs out of space in one partition. If you want to set up file systems in multiple partitions, you need to create and mount the file systems on your computer before you install RICOH ProcessDirector.
    • When setting up partitions of the Linux system for RICOH ProcessDirector, you can use Logical Volume Manager (LVM), Hardware RAID, or separate partitions. Hardware RAID 0 provides the best performance.
    • If you want to use Logical Volume Manager (LVM), you need to set up and mount the file systems on your computer before you install RICOH ProcessDirector.
    • RICOH ProcessDirector does not support file systems created with the 64-bit inode setting.

  • On Windows computers that have application servers installed, you do not have to set up file systems before installation.

When you determine the size and location of file systems, consider these factors:

  • Storage and backup needs
  • Failure recovery

1.1.3.3.1 File systems for the primary computer

You can let the RICOH ProcessDirector installer create the directories listed in File systems for the RICOH ProcessDirector primary computer, or you can create them yourself. If you let RICOH ProcessDirector create them, they are created as directories, not file systems. If you want to use multiple partitions or LVM, you must create the file systems manually before you install RICOH ProcessDirector. Create and mount the /aiw file system before you create the other file systems.
File systems for the RICOH ProcessDirector primary computer
File system Recommended size Minimum size Description
/aiw 80+ GB 40 GB File system for RICOH ProcessDirector print jobs, resources, backup files, and trace files. This file system is shared by the secondary computers as a mounted file system. See note 1.
/aiw/aiw1/db2 30 GB 20 GB File system for DB2 tables when DB2 is used as the database and is installed on the same computer as the base product (either the RICOH ProcessDirector version of DB2 or a separate copy). See note 2.
/aiw/aiw1/db2_logs 12 GB 12 GB File system for DB2 logs when DB2 is used as the database and is configured to store its transaction logs in a separate file system and is installed on the same computer as the base product (either the RICOH ProcessDirector version of DB2 or a separate copy). See note 2.
/var/aiw 5 GB 5 GB File system for debug information from RICOH ProcessDirector.
/var/psf 5 GB 5 GB File system for PSF configuration and temporary files.
/var/psf/segments 45 GB 10 GB File system used to improve performance. This file system must be bigger than your biggest job. It requires enough space to store data for concurrent jobs on multiple printers. The recommended minimum size is 45 GB for five printers. Increase the size by 10 GB for each additional printer.
    Note:
  • If DB2 is installed on the primary computer and stores data under /aiw/aiw1, the /aiw file system must be large enough to hold the DB2 tables and logs. In that case, the minimum file system size for /aiw is 72 GB: the minimum sizes for all three file systems combined.
  • If you install a DB2 server on another computer and a DB2 client on the same computer as the base product, you do not have to create the /aiw/aiw1/db2 and /aiw/aiw1/db2_logs on the primary computer. However, you must make sure that the DB2 server meets minimum requirements. The file system for DB2 tables and logs server must be at least 22 GB, but 32 GB is recommended.

Existing file systems that RICOH ProcessDirector uses shows the file systems that you create when you install the operating system. You might need to increase the size of these file systems before you install RICOH ProcessDirector.

Existing file systems that RICOH ProcessDirector uses
File system Recommended size Minimum size Description
/var Varies Set as an operating system default File system that contains the /var/spool/lpd directory, used to spool jobs received by LPD protocol. This file system must be large enough to hold all of the print files that you receive at one time with the LPD protocol.

If you install any Transform features, you must have an additional 1 GB free space in /var.

/var/lib/docker 50 GB 24 GB If you use PostgreSQL as the database: File system that contains required database tables for RICOH ProcessDirector.
/home (default) 5 GB free space 5 GB free space If you use DB2 as the database and it is on the same computer as the base product: File system that contains the home directory of the DB2 instance user. This DB2 is either the RICOH ProcessDirector version of DB2 or a separate copy.

    Note:
  • If /aiwinst is in /home, it must have 2.5 GB free space.
  • If /home/aiwinst is a separate file system from /home, /home/aiwinst must have 2.5 GB free space.
  • The /home file system must not be mounted with the nosuid option. To verify that the nosuid option is not used, enter mount on the command line.

2 GB free space 2 GB free space If you use DB2 as the database and it is on a different computer: File system that contains the home directory of the RICOH ProcessDirector DB2 client user when you install the DB2 client on the same computer as the base product and configure it to work with a DB2 server on a different computer.
/opt 50 GB free space

With Ricoh Postscript/PDF to AFP, PCL to AFP, SAP to AFP, or AFP to PDF installed, 1 GB additional free space

With the Advanced Transform feature installed, 1 GB additional free space

45 GB free space

With Ricoh Postscript/PDF to AFP, PCL to AFP, SAP to AFP, or AFP to PDF installed, 1 GB additional free space

With the Advanced Transform feature installed, 1 GB additional free space

File system for RICOH ProcessDirector code.
    Note:
  • The /opt file system must not be mounted with the nosuid option. To verify that the nosuid option is not used, enter mount on the command line.
/tmp 3 GB free space 750 MB free space Temporary space used by the RICOH ProcessDirector installer. The RICOH Transform features listed require an additional 500 MB of free space in /tmp.
    Note:
  • If you upgrade the DB2 database, you need 3 GB free space.
/usr 750 MB free space 750 MB free space File system that contains the /usr/lpp/psf and /usr/lib directories used for printing AFP files.

For the file systems that RICOH ProcessDirector manages, ownership and permissions must be set as shown in Ownership and permissions for file systems. If the RICOH ProcessDirector installer creates directories, it sets the correct ownership and permissions automatically.

Ownership and permissions for file systems
File system Owner Group Permissions
/var/psf root sys 2775 - drwxrwsr-x
/aiw/aiw1/db2
(See Note.)
root sys 755 - drwxr-xr-x
/aiw/aiw1/db2_logs
(See Note.)
root sys 755 - drwxr-xr-x
/var/aiw root sys 777 - drwxrwxrwx
/aiw root sys 755 - drwxr-xr-x
    Note:
  • The installation program changes the ownership to the RICOH ProcessDirector system user and group. You can use the default RICOH ProcessDirector system user (aiw1) and group (aiwgrp1), or you can specify a different user and group.

1.1.3.3.2 File systems for Linux Secondary Server features

You can let the RICOH ProcessDirector installer create the directories listed in File systems for Linux Secondary Server features, or you can create them yourself before you install RICOH ProcessDirector. If you let RICOH ProcessDirector create them, they are created as directories, not file systems. If you want to use multiple partitions, you must create the file systems manually.
File systems for Linux Secondary Server features
File system Recommended size Minimum size Description
/aiwinstaller 2 GB 2 GB File system that the installation program uses to store its files.
/var/psf 5 GB 5 GB File system for PSF configuration and temporary files.
    Note:
  • If /var/psf/segments is a subdirectory of /var/psf, /var/psf must meet the combined requirements of the two file systems.
/var/psf/segments 45 GB 10 GB File system used to improve performance. This file system must be bigger than your biggest job. It requires enough space to store data for concurrent jobs on multiple printers. The recommended minimum size is 45 GB for five printers. Increase the size by 10 GB for each additional printer.
/var/aiw 5 GB 5 GB File system for debug information from RICOH ProcessDirector.

Existing file systems that Linux Secondary Server features use shows the file systems that you create when you install the Linux operating system. You might need to increase the size of these file systems before you install RICOH ProcessDirector.

Existing file systems that Linux Secondary Server features use
File system Recommended size Minimum size Description
/var/spool/lpd Varies Set as an operating system default File system used to spool jobs received by LPD protocol. This file system must be large enough to hold all of the print files that you receive at one time with the LPD protocol.
/opt 15 GB free space 10 GB free space File system for RICOH ProcessDirector code.
    Note:
  • The /opt file system must not be mounted with the nosuid option. To verify that the nosuid option is not used, enter mount on the command line.
/tmp 750 MB free space 750 MB free space Temporary space used by the RICOH ProcessDirector installer.
/usr 750 MB free space 750 MB free space File system that contains the /usr/lpp/psf and /usr/lib directories used for printing AFP files.

For the file systems that RICOH ProcessDirector manages, ownership and permissions must be set as shown in Ownership and permissions for Linux Secondary Server feature file systems. If the RICOH ProcessDirector installer creates directories, it sets the correct ownership and permissions automatically.

Ownership and permissions for Linux Secondary Server feature file systems
File system Owner Group Permissions
/var/aiw root sys 777 - drwxrwxrwx
/var/psf root sys 2775 - drwxrwsr-x
/var/psf/segments root sys 2777 - drwxrwsrwx

1.1.3.4 Creating system groups and users

RICOH ProcessDirector requires several user groups and IDs on the primary computer to operate correctly. The installation program can create the user groups and IDs or you can create them in advance.

It is easiest to let the installer create the user groups and IDs using the default values. If the default names do not comply with user and group naming rules in your environment, you can choose different names and enter them in the installer when requested. The groups and users are created using the specified names as local system users and groups.

If you prefer to create the groups and users in advance (using either the default names or names that you specify), the installation program can find and use them. Create those groups and users according to the descriptions below and enter their names in the installation program when asked.

If you plan to install any Secondary Server features on Linux computers, you must create some groups and users on both the primary computer and secondary computers. The groups and users on the secondary computers must be identical to those on the primary computer.

    Note:
  • All Linux operating system user IDs and group names must be 1-8 characters because of a restriction in DB2. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.
Required groups

RICOH ProcessDirector requires these groups on the primary computer:

RICOH ProcessDirector group
The group that controls access to the RICOH ProcessDirector data directory. Members of this group can access the /aiw/aiw1 file system. This is the default or primary group for the RICOH ProcessDirector system user.

The default name for the group is aiwgrp1.

Print queue group
The group used for all users and applications that send jobs to printers. On some platforms, this is a system group that is created when the operating system is installed, but not on others. For example, this group is created when you install SLES, but not when you install Red Hat Linux.

The name for this group must be printq. You cannot create a group with a different name and have RICOH ProcessDirector use it. If the installer does not find a group named printq, it creates one.

PostgreSQL database group
The group used to give access to the PostgreSQL database that RICOH ProcessDirector installs in a Docker container. This group is created when you install Docker Engine.

The default name for the group is docker.

When you install RICOH ProcessDirector, the RICOH ProcessDirector system user is added to this group.

This group is only required if you use PostgreSQL as the RICOH ProcessDirector database.

DB2 database group
The group used to give members DB2 sysadm authority for database operation. This is the default or primary group for the RICOH ProcessDirector instance user and for the Database client user (if needed).

The default name for the group is aiwdbgrp.

If you plan to use a DB2 server installed on a different computer with RICOH ProcessDirector, this group is created while running the script setupRemoteDB2.sh on the computer that DB2 is installed on and also on the computer that RICOH ProcessDirector is installed on.

This group is only required if you use IBM DB2 as the RICOH ProcessDirector database.

DB2 database fenced group
The internal group required by DB2; the default or primary group for the fenced user.

The default name for the group is aiwdbfgp.

If you plan to use a DB2 server installed on a different computer with RICOH ProcessDirector, this group is created during the installation on the computer that DB2 is installed on.

This group is only required if you use IBM DB2 as the RICOH ProcessDirector database.

RICOH ProcessDirector also requires the RICOH ProcessDirector group and print queue group on any secondary computers.

Required users

RICOH ProcessDirector requires these users on the primary computer:

RICOH ProcessDirector system user
The user ID that RICOH ProcessDirector runs under. This user must have the RICOH ProcessDirector group set as its default or primary group. It must also be a member of the Print queue group and the DB2 database or PostgreSQL database group. You can use the default values for the other user properties.

The default system user ID is aiw1.

DB2 instance user
The user ID that the RICOH ProcessDirector DB2 database instance runs under. This user must have its default or primary group set to the DB2 database group. It must also be a member of the RICOH ProcessDirector group. You can use the default values for the other user properties.

The default DB2 instance user ID is aiwinst.

If you plan to use a DB2 server installed on a different computer, this user is created on the computer that DB2 is installed on.

DB2 fenced user
A second user ID that DB2 requires when you create an instance. This user must be a member of the DB2 database fenced group. You can use the default values for the other user properties.

The default DB2 fenced user ID is aiwdbfid.

If you plan to use a DB2 server installed on a different computer, this user is created on the computer that DB2 is installed on.

DB2 database client user
The user ID that the DB2 client uses. This user is only required if you install a DB2 server on a different computer and the DB2 client on the same computer as RICOH ProcessDirector. This user must have its primary or default group set to the DB2 database group. You can use the default values for the other user properties.

The default DB2 database client user ID is aiwclnt.

RICOH ProcessDirector also requires the RICOH ProcessDirector system user on any secondary computers.

    Note:
  • If you set up passwords with expiration rules for these user IDs, you must administer those IDs as needed. If you do not change the passwords as needed and they expire, RICOH ProcessDirector stops working.

RICOH Transform features users and groups

One additional group and two additional users are required if you install any of these RICOH Transform features:

  • Ricoh AFP to PDF
  • Ricoh PCL to AFP
  • Ricoh PostScript/PDF to AFP
  • Ricoh SAP to AFP
The default users are ipsitm and ipsejz; the default group is itm. The Advanced Transform feature does not require these users and group.

    Important:
  • Do not make either RICOH Transform features user ID the same as the RICOH ProcessDirector user ID. For example, if the RICOH ProcessDirector user ID is aiw1, do not enter aiw1 for either Transform feature user ID.

1.1.3.5 Secure Sockets Layer and Transport Layer Security support

RICOH ProcessDirector provides support for the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocols, so you can protect the print data in the system.

SSL and TLS are widely used to protect data on the Internet. The SSL and TLS protocols use digital certificates to establish a secure connection between a Web server and any client systems that interact with it. After the connection is established, data transferred between the systems is encrypted using security keys. Only the intended recipient of the information can decrypt the data.

You can also use SSL or TLS to protect data on a smaller scale, such as within a print system like RICOH ProcessDirector. You can activate SSL or TLS to provide a greater level of security for the print data that is exchanged between the primary server and user interfaces, as well as the data that is exchanged with other applications using the Web services that RICOH ProcessDirector supports.

To use SSL or TLS on a computer, you must obtain a digital certificate and install it on that computer. It is recommended that you get your certificate from a certificate authority (CA), because CAs are considered trusted third parties. You can use a self-signed certificate for testing, but using that certificate on production systems is not recommended.

When the certificate is issued, the CA sends it to you in an e-mail. You store the certificate in a keystore on the computer that the certificate is registered to.

    Note:
  • RICOH ProcessDirector only supports Java Key Stores (JKS) files. To create a keystore, see the Java documentation about enabling SSL or TLS.

After the Web server is configured to use it, SSL or TLS is automatically used for communications. The URL for the RICOH ProcessDirector user interface changes to use the https:// prefix. You can still access the user interface using the http:// address, but you can configure the Web server to forward all requests to the secure address.

To use SSL or TLS with RICOH ProcessDirector, you can get a digital certificate and install it on the primary computer before you install the base product. After the base product is installed, you must activate SSL or TLS in the RICOH ProcessDirector Web server component.

1.1.3.6 Considerations for virtual and cloud environments

RICOH ProcessDirector can be installed in virtual environments, such as those provided with VMware, or cloud platforms such as Amazon Web Services.

When configuring this type of system, the operating system prerequisites, memory and file system requirements still apply. Three other network configuration items are important:

  • The hostname assigned to the RICOH ProcessDirector instance cannot change when the server is restarted. If this value changes over a restart, you will have a short grace period to update your license keys before the system stops running.
  • If you are printing across an externally hosted or distributed network, you may need substantial network bandwidth to keep high-speed printers running at rated speed over long distances. Contact Ricoh Software Support for help with configuring your network capacity.

    If you are printing to AFP printers, you can use a secondary server to receive and buffer print jobs so that data transmission to the printers can keep up with high print speeds. After installing the secondary server, set these properties on the AFP printer:

    • Printer server: The secondary server name
    • Copy to secondary server: Yes
    • Destination directory on secondary server: The location on the secondary server file system where you want RICOH ProcessDirector to write print files.

  • Securing data across your network and from cloud platforms to printers on the ground is your responsibility. Use of virtual private networks (VPNs) sometimes introduces performance degradation in file transfer. Involve your network and security administrators when planning to host RICOH ProcessDirector in these environments.

1.1.3.7 Installing required software

RICOH ProcessDirector requires this software on the primary computer:

  • A supported Linux operating system
  • Docker Engine 24.0.6 or higher

    This software is only required if you are using PostgreSQL as your database.

  • A supported database

    RICOH ProcessDirector uses a database to manage the flow of data. Two databases are supported:

    PostgreSQL
    The default database for RICOH ProcessDirector in version 3.12 and higher. The RICOH ProcessDirector installation program installs PostgreSQL in a Docker container. You must install Docker Engine 24.0.6 or higher before you install RICOH ProcessDirector to use the PostgreSQL configuration.
    IBM DB2
    The default database for RICOH ProcessDirector in version 3.11.2 and lower and an alternate configuration for version 3.12 and higher.

    You can use the version of DB2 provided with RICOH ProcessDirector or an DB2 version 11.5.8 or higher that you have installed outside of RICOH ProcessDirector. If you already have DB2 version 11.5.8 or higher installed on a computer in your network, you can configure RICOH ProcessDirector to work with that version instead. See Installing DB2.

If you plan to install a Secondary Server feature, this software is required on the secondary computer:

  • A supported Linux operating system

If you plan to install an application server on a Windows computer, this software is required on the Windows computer:

  • Windows Server 2019 64-bit operating system
  • Windows Server 2022 64-bit operating system
  • Windows 10 Pro or Enterprise 64-bit operating system
  • Windows 11 Pro operating system

These features require additional software:

  • Secondary Docker

    Docker Engine 19.03 or above is required on Linux computers that will host Docker container secondary servers.

  • PitStop Connect

    Enfocus PitStop Server 10 or higher on an application server that is configured to work with the primary server.

  • Ultimate Impostrip® Connect

    Ultimate Impostrip® Automation or Scalable on an application server that is configured to work with the primary server or on a separate Windows system.

      Note:
    • If your Windows computer runs in a language other than English, do not install Ultimate Impostrip® in the default install directory. The program does not work properly with non-English default install paths. We recommend installing Ultimate Impostrip® in C:\ImpostripOnDemand on non-English Windows computers.
  • Quadient Inspire Connect

    Quadient Inspire Designer V8 or higher.

  • The AFP Support feature includes RICOH Visual Workbench, a separate user interface that you can install on any Linux or Windows system in your network.

    Java 1.8 or later must be installed on the system that is used for RICOH Visual Workbench.

  • The PDF Document Support feature includes RICOH ProcessDirector Plug-in for Adobe Acrobat, a separate user interface that you can install on a Windows system in your network. Java 1.8 or later and Adobe Acrobat Pro 2020 or DC must be installed on the system that is used for RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • RICOH Transform features

    WorldType Fonts version 8.13 for RICOH SAP to AFP files to transform correctly when IS/3 support is enabled.

    Java Runtime Environment 1.4 or higher.

  • Avanti Slingshot Connect

    Avanti Slingshot with the JDF Integration add-on installed on an application server that is configured to work with the primary server.

Other required software:

  • A supported Web browser

    A Web browser is required to open the RICOH ProcessDirector user interface, so it is required on any system that is used to access the user interface.

  • A PDF viewer

    A PDF viewer is used inside the RICOH ProcessDirector user interface to display the contents of print jobs. It should be installed on any system that is used to access the user interface, but it is not required. If you open the user interface from a computer that does not have a PDF viewer installed, you see an error message if you try to view a job. Using Adobe Reader is recommended as it provides the most functionality.

1.1.3.7.1 Installing an operating system

RICOH ProcessDirector requires a 64-bit operating system that supports running 32-bit applications. You can install any of these operating systems, depending on the hardware you have:

64-bit system (for primary or secondary):
One of these operating systems:
  • CentOS Linux 7.9 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • Rocky Linux 8.4 through latest 8.X
  • Rocky Linux 9.0 through latest 9.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
  • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64
Note: CentOS and Rocky Linux distributions are based on the Red Hat code base. References to Red Hat-derived operating systems in this documentation indicate that the statement or instruction is appropriate for Red Hat, CentOS, and Rocky Linux.
64-bit system (for Windows application servers):
One of these operating systems:
  • Windows 10 Pro or Enterprise 64-bit
  • Windows 11 Pro
  • Windows Server 2019 64-bit
  • Windows Server 2022 64-bit

    Important:
  • RICOH ProcessDirector checks to make sure that the operating system meets these minimum requirements. The installation program does not install the software on earlier versions of the operating systems.

1.1.3.7.1.1 Installing the SLES operating system

  1. See the SLES documentation to install SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64 or SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64.
    1. Make sure that these components are installed on both the primary and secondary computers:
      • Korn shell (mksh)
      • binutils
      • insserv-compat package
      • libX11.so.6 and its dependent libraries
      • Perl interpreter (Perl.rte 5.8.8 or later)
      • Zip and unzip utilities
      • The fontconfig and freetype libraries

        We also strongly recommend installing DejaVu Fonts. OpenJDK requires these libraries to identify available fonts on the system.

      • On a SLES 12 primary computer only: The net-tools package.
      • On a SLES 15 primary computer only: The net-tools-deprecated package.
      • glibc 2.27 or higher

        This package is only required if you plan to install any RICOH Transform features.

    2. If you plan to install application servers, install the Network Information Service (NIS) server on the SLES primary computer. You can use YaST (Yet Another Setup Tool) to install NIS. In YaST, click Software Software Management and search for ypserv.
      The rpcbind service is required on the primary computer.
    3. Security Enhanced Linux (SELinux) must be disabled during the install process for RICOH ProcessDirector. You can enable it again after the install is complete.
  2. Create Linux partitions and file systems. See Planning for file systems for recommendations and considerations.
  3. Run these commands and look for the expected results to verify that you installed SLES correctly:
    SLES commands and expected results
    Command Expected result
    To check the SLES release:

    cat /etc/os-release

    Returns the operating system version and patch level.
    To verify that the operating system is 64-bit:

    uname -a

    A response that includes: x86_64
    To check for Korn shell (mksh):

    rpm -q mksh

    Response similar to:

    mksh-50-2.13.x86_64

    To check for binutils:

    rpm -q binutils

    Results resemble this example:

    binutils-2.31-9.26.1.z86_64

    To check for insserv-compat:

    rpm -qa | grep insserv-compat

    Results resemble this example:

    insserv-compat-0.1-4.3.1.noarch

    If no results are returned, you must install the missing package.

    To install the serving-compat package, type:

    zypper install insserv-compat

    To check for libX11.so.6:

    rpm -qa |grep -i X11

    ls -l /usr/lib*/libX11*

    Results include a collection of libraries with the text X11 in the name, such as:

    libX11-6-1.6.2-12.5.1.x86_64
    libX11-data-1.6.5-1.41.noarch
    libxkbcommon-x11-0-0.8.0-1.17.x86_64
    ghostscript-x11-9.25-23.13.1.x86_64
    xorg-x11-essentials-7.6_1-1.22.noarch

    If fewer than five results are returned, not all of the dependencies are installed. Install the libX11 libraries again, making sure to install all of the dependencies.

    To check the version of Perl that is installed:

    rpm -q perl

    A response that resembles: perl-5.8.8-14.10
    To verify that the libraries for font support are installed:
    • rpm -qa | grep fontconfig
    • rpm -qa | grep freetype
    • rpm -qa | grep -i dejavu
    Results resemble these examples:
    • fontconfig-2.13.0-4.3.el7.x86_64
    • freetype-2.8-14.el7.x86_64
    • dejavu-fonts-common-2.35-7.el8.noarch

    If no results are returned, you must install the missing library or fonts.

    To install all three, type:

    zypper install libfreetype6 fontconfig dejavu-fonts

    To check for the net-tool packages:

    On SLES 12:

    rpm -qa |grep net-tools

    On SLES 15:

    rpm -qa |grep net-tools-deprecated

    Results resemble these examples:
    • net-tools-1.60-765.5.4.x86_64
    • net-tools-deprecated-2.0+git20170221.47bb4a-3.11.x86_64
    To check the versions of zip and unzip that are installed:

    rpm -q zip

    rpm -q unzip

    zip-3.0-1.el6.x86_64 (typical)

    unzip-6.0-1.el6.x86_64 (typical)

    getconf GNU_LIBPTHREAD_VERSION NPTL 2.19
    To verify that the rpcbind service is running:

    rpcinfo

    A response that includes system information indicates that the rpcbind service is running. If the responses is an error message, the rpcbind service is not running. Type this command to start the rpcbind service: /sbin/rpcbind
    If you are going to print with AFP printers whose parent server is a SLES Linux server, the portmap utility must be installed and running.

    rpcinfo -p

    This command only returns results if the rpcbind service is running.

    A response that includes portmap, such as:

    program vers proto port service 100000 4 tcp 111 portmapper

    To check the status for SELinux:

    getenforce

    Disabled
    To check the version number of glib library

    rpm -q glibc

    Results resemble this example:

    glibc-2.22-15.3.x86_64

      Note:
    • If you have installed a later version of a prerequisite, the version number returned varies.

    If the command results are not as you expect, use YaST to make sure you have installed the required components (see step 1). In YaST, click Software Install/Remove Software.

  4. Verify date, time, and time zone settings through YaST, and correct if necessary:
    Click System Clock and Time Zone Configuration. If you change the date, time, or zone, you might have to reboot the system for your changes to take effect.
  5. Continue with Setting up networking configuration.

1.1.3.7.1.2 Installing a Red Hat-derived operating system

RICOH ProcessDirector can be installed on a supported Red Hat, CentOS, or Rocky Linux operating system.
  1. See the Red Hat, CentOS, or Rocky documentation to install the operating system.
    1. Make sure that these components are installed on both the primary and secondary computers:
      • Two versions of Korn shell: ksh and mksh
      • binutils
      • /usr/lib64/libstdc++.so.6

        The 64-bit version of a shared library that RICOH ProcessDirector uses. On supported Red Hat or CentOS Linux 7.x versions, the libraries are installed by: .so.6: libstdc++-4.8.5-4.el7.x86_64

          Note:
        • The libraries are provided on the operating system installation media or can be downloaded from the Red Hat or CentOS website.

      • libX11.so.6 and its dependent libraries
      • Perl interpreter (Perl.rte 5.8.8 or later)
      • Zip and unzip utilities
      • The fontconfig and freetype libraries

        We also strongly recommend installing DejaVu Fonts. OpenJDK requires these libraries to identify available fonts on the system.

      • The net-tools package.
      • The initscripts-service package.

        This package is required only for Rocky Linux.

      • glibc 2.27 or higher

        This package is only required if you plan to install any RICOH Transform features.

    2. If you plan to install an application server on Windows, you must install a Network Information Service (NIS) server on the primary computer. These services are required on the primary server:
      • ypserv
      • ypbind
      • rpcbind
    3. On servers that have a Common UNIX Printing System (CUPS) printer type defined:

      These RPMs are required:

      • system-config-printer

        This RPM is only required for supported Red Hat or CentOS Linux 7.x versions.

      • system-config-printer-libs
      • system-config-printer-udev
        Note:
      • CUPS printer types include Passthrough and PCLOut printers that use the lpr command.
    4. Security Enhanced Linux (SELinux) must be disabled during the install process for RICOH ProcessDirector. You can enable it again after the install is complete.
  2. Create Linux partitions and file systems. See Planning for file systems for recommendations and considerations.
  3. Run these commands and look for the expected results to verify that you installed Red Hat correctly:
    Red Hat/CentOS/Rocky Linux commands and expected results
    Command Expected result
    To check the Red Hat release:

    cat /etc/redhat-release

    To check the CentOS release:

    cat /etc/centos-release

    To check the Rocky Linux release:

    cat /etc/os-release

    Red Hat Enterprise Linux Server release release_number

    CentOS Linux release release_number (Core)

    NAME="Rocky Linux"
    VERSION=release_number

    To verify that the operating system is 64-bit:

    uname -a

    Results that include x86_64 as in this example:

    Linux myserver 3.10.0-123.el7.x86_64 #1 SMP Mon May 5 11:16:57 EDT 2014 x86_64 x86_64 x86_64 GNU/Linux

    To check for the Korn shell packages:

    rpm -q ksh

    and

    rpm -q mksh

    Results resemble this example:

    ksh-20120801-19.el7.x86_64

    and

    mksh-56c-5.el8.x86_64

    To check for binutils:

    rpm -q binutils

    Results resemble this example:

    binutils-2.30-108.el8.x86_64

    To check for /usr/lib64/libstdc++.so.6:

    Go to /usr/lib64/ and type:

    ls

    The list of files must include this exact entry:
    /usr/lib64/libstdc++.so.6
    The list might link that entry to this one:
    /usr/lib64/libstdc++.so.6.0.13
    To check for libX11.so.6:

    rpm -qa |grep -i X11

    ls -l /usr/lib*/libX11*

    Results include a collection of libraries with the text X11 in the name, such as:

    libX11-1.6.5-2.el7.x86_64
    libX11-common-1.6.5-2.el7.noarch
    libxkbcommon-x11-0.7.1-1.el7.x86_64
    xorg-x11-font-utils-7.5-21.el7.x86_64
    xorg-x11-xinit-1.3.4-2.el7.x86_64

    If fewer than five results are returned, not all of the dependencies are installed. Install the libX11 libraries again, making sure to install all of the dependencies.

    To check the version of Perl that is installed:

    rpm -q perl

    Results resemble this example:

    perl-5.16.3-283

    To verify that the libraries for font support are installed:
    • rpm -qa | grep fontconfig
    • rpm -qa | grep freetype
    • rpm -qa | grep -i dejavu
    Results resemble these examples:
    • fontconfig-2.13.0-4.3.el7.x86_64
    • freetype-2.8-14.el7.x86_64
    • dejavu-fonts-common-2.35-7.el8.noarch

    If no results are returned, you must install the missing library or fonts.

    To install all three, type:

    yum install freetype fontconfig dejavu-sans-fonts

    To check for the net-tools package:

    rpm -q net-tools

    Results resemble this example:

    net-tools-2.0-0.25.20131004git.e17.x86_64

    To check the versions of zip and unzip that are installed:

    rpm -q zip

    rpm -q unzip

    Results resemble these examples:

    zip-3.0-1.el6.x86_64 (typical)

    unzip-6.0-1.el6.x86_64 (typical)

    getconf GNU_LIBPTHREAD_VERSION Results indicate version 2.17 or higher:

    NPTL 2.17

    To verify the RPM files that printer objects require:

    rpm -qa | grep system-config-printer

    The list of results should include:
    system-config-printer
    system-config-printer-libs
    system-config-printer-udev
      Note:
    • system-config-printer only appears in the list for Red Hat or CentOS Linux 7.x versions
    If you are going to print with AFP printers whose parent server is a Linux server, the portmap utility must be installed and running.

    rpcinfo -p

    A response that includes portmap, such as:

    program vers proto port 100000 4 tcp 111 portmapper

    To check the status for SELinux:

    getenforce

    Disabled
    To check the version number of glib library

    rpm -q glibc

    Results resemble this example:

    glibc-2.22-15.3.x86_64

      Note:
    • If you have installed a later version of a prerequisite, the version number returned varies.

    If the command results are not as you expect, use the operating system tools to make sure that you have installed the required components (see step 1).

  4. Verify date, time, and time zone settings, and correct if necessary. To display the settings, type:

    timedatectl

  5. Continue with Setting up networking configuration.

1.1.3.7.1.3 Installing a Windows Operating System

When you install an application server on a Windows operating system, choose the correct mode to run in and open the correct ports in the firewall.

RICOH ProcessDirector can be installed on these operating systems:

  • Windows Server 2019 64-bit
  • Windows Server 2022 64-bit
  • Windows 10 Pro or Enterprise 64-bit
  • Windows 11 Pro

To install a Windows operating system:

  • See the Windows documentation to install the appropriate operating system. When you are asked to choose 32-bit or 64-bit mode, choose 64-bit mode for the Windows operating system. RICOH ProcessDirector is not compatible with 32-bit mode.

    Make sure that User Account Control (UAC) is set to OFF. You can turn it back on when the installation is complete.

  • RICOH ProcessDirector supports both IPv4 and IPv6 protocols. If you use IPv4, IP addresses can be expressed using dotted-decimal addresses or the fully qualified host name. If you use IPv6, you must use the fully qualified host name of the server.
  • Depending on your configuration, you might also need these ports:

    Ports to open on the RICOH ProcessDirector primary server
    Port Source system Description
    15080 User workstation Access to the RICOH ProcessDirector user interface if not using TLS.
    15090 Administrator workstation Access to the RICOH ProcessDirector Feature Manager interface if not using TLS.
    15443 User workstation Access to the RICOH ProcessDirector user interface if using TLS.
    15453 Administrator workstation Access to the RICOH ProcessDirector Feature Manager user interface if using TLS.
    515 Customer application Required when sending jobs to RICOH ProcessDirector using LPR.
    5001-65535 Customer mainframe Required when sending jobs to RICOH ProcessDirector using Download for z/OS or AFP Download Plus. The port numbers defined in RICOH ProcessDirector must match the port numbers defined as printers on the mainframe.
    55555 RICOH ProcessDirector secondary server Required if you use secondary servers that are not defined on the same system as the primary server. Allows communication between the secondary server and the primary server.
    15080 or 15443 RICOH TotalFlow Print server Used to send printing status to RICOH ProcessDirector.
    Ports to open on RICOH ProcessDirector primary and secondary server
    Port Source system Description
    15081 Administrator workstation Used to import the custom PDF printer definition to the RICOH ProcessDirector server that will be communicating with the printer

    Only necessary when using custom PDF printers. Most systems do not use custom PDF printers.

    15081 Ricoh PDF printer The job ticket contains reference to a PDF file that the printer retrieves.
    Ports to open on the NFS server
    Port Source system Description
    111 RICOH ProcessDirector primary and secondary server Used by the NFS server and User Name Mapping function when sharing data from the primary server to secondary servers or other systems using NFS.
    2049 RICOH ProcessDirector primary and secondary server Used by the NFS server when sharing data from the primary server to secondary servers or other systems using NFS.
    Ports to open on printers
    Port Source system Description
    161 RICOH ProcessDirector primary and secondary server Required when RICOH ProcessDirector gets printer status and information using SNMP.
    8010 RICOH ProcessDirector primary and secondary server Required when RICOH ProcessDirector gets printer status and information using SNMP.
    9100-9103 RICOH ProcessDirector primary and secondary server Required when sending jobs to a printer with a EFI Fiery controller using Postscript job tickets.
    Ports to open on LDAP server
    Port Source system Description
    389, 636, or other port as configured. RICOH ProcessDirector primary server Required when RICOH ProcessDirector is using LDAP to authenticate users.
    Ports to open on printers that support JMF interfaces 1
    Port Source system Description
    80 RICOH ProcessDirector primary and secondary server Required when RICOH ProcessDirector sends IMSS queries using the HTTP protocol.
    8010 RICOH ProcessDirector primary and secondary server Required when sending JMF files to EFI Fiery controllers.
    9100 (default) - 9103 RICOH ProcessDirector primary and secondary server Required when sending jobs to a printer with a EFI Fiery controller using Postscript job tickets.

    9100 is the default port. EFI printers use port 9102.

    1These printers are defined in RICOH ProcessDirector as Ricoh PDF Printer objects.
    Ports to open on Passthrough printers
    Port Source system Description
    515 RICOH ProcessDirector primary server Required when receiving jobs from RICOH ProcessDirector using LPR.
    Ports to open on IPDS printers
    Port Source system Description
    5001-65535 RICOH ProcessDirector primary server Required when sending files to RICOH ProcessDirector using Download for z/OS or AFP Download Plus.

    These port numbers are configured when you create the input devices that receive these jobs. Open these ports after you define the input devices.

    Ports to open on a transform server
    Port Source system Description
    6984-6992 RICOH ProcessDirector primary server Required if you use any of the RICOH Transforms and they are not installed on the primary server. These transforms are not the same as the RICOH ProcessDirector Advanced Transform feature.
    16080 Administrator workstation Access to the Transform Features user interface if using any of the RICOH Transforms.
    Ports to open for the Reports feature
    Port Source system Description
    5432 RICOH ProcessDirector primary server and any system accessing RICOH ProcessDirector reports data Access to PostgreSQL database used to store data collected by the Reports feature. This database might be on the primary computer or on a different computer on your network.

    Required when using the RICOH ProcessDirector Reports feature.

    Ports to open on a DB2 server
    Port Source system Description
    DB2 prior to 11.5.8: 50000

    DB2 11.5.8 and higher: 25000

    RICOH ProcessDirector primary server Required when RICOH ProcessDirector uses a DB2 database installed on a different server.

    These are the default ports used by DB2; the default value changed in Version 11.5.8. If your installation of DB2 uses a different port, open the port you use.

    Ports to open for a primary PostgreSQL database
    Port Source system Description
    5442 RICOH ProcessDirector primary server Used for communication with the Docker container that holds the PostgreSQL database for RICOH ProcessDirector

  • The language that RICOH ProcessDirector runs in depends on the browser that you use to access it. To change the language, you have to change the language of the operating system.

1.1.3.7.2 Installing DB2

You can use the version of DB2 that is supplied with RICOH ProcessDirector, or you can install your own copy of DB2. Your own copy can be installed on the same computer as the RICOH ProcessDirector base product or on a different Linux computer.

To install your own copy on the primary computer and use them together, your copy must be:

  • DB2 11.5.8 or later

If you have a different release of DB2, you cannot use it with RICOH ProcessDirector.

1.1.3.7.2.1 Installing the RICOH ProcessDirector version of DB2

Use the RICOH ProcessDirector version of DB2 if you have no other applications that require DB2. Only RICOH ProcessDirector can use this version.

The RICOH ProcessDirector version of DB2 can be installed when you install the RICOH ProcessDirector base product on a computer where no other version of DB2 is installed. If another compatible version of DB2 is installed, you can choose whether to install and use the RICOH ProcessDirector version of DB2 or to use the other version of DB2.

The DB2 database can be installed from a separate disc or an ISO file. If you select to install RICOH ProcessDirector with the DB2 database, the RICOH ProcessDirector installation program requires that another disk with DB2 is inserted or the ISO is mounted.

To work together, DB2 and RICOH ProcessDirector require several system users and groups. You should never log in as these users, but you might need to recognize them for recordkeeping and security.

Choose one of these three ways to create and specify which users and groups the applications should use:

  • Before you start the installation program, create the users and groups. Then, during the installation process, enter the names of the users and groups that you created. RICOH ProcessDirector finds and uses them.

    See Creating system groups and users for information about required users and groups.

  • During the installation process, enter different names for the users and groups and let RICOH ProcessDirector create them.
  • During the installation process, let RICOH ProcessDirector create the users and groups using the default values.

    The default users and groups are:

    DB2 instance user
    aiwinst
    DB2 instance group
    aiwdbgrp
    DB2 fenced user
    aiwdbfid
    DB2 fenced group
    aiwdbfgp

    Note:
  • If you set up passwords with expiration rules for these user IDs, you must administer those IDs as needed. If you do not change the passwords as needed and they expire, RICOH ProcessDirector stops working.

When you install RICOH ProcessDirector, the installation program creates a DB2 instance and user ID using the value you enter for the DB2 instance user. There must be no other DB2 instance or user ID with this name on the RICOH ProcessDirector system, even in a different version of DB2.

1.1.3.7.2.2 Installing your own copy of DB2 on the primary computer

Use your own copy of DB2 on the same computer as RICOH ProcessDirector if:
  • You have other applications that require DB2 on that computer.
  • You already have a DB2 license for the computer that you want to use with RICOH ProcessDirector.
  • You want to manage DB2 outside RICOH ProcessDirector.

You must install DB2 11.5.8 or later before you install RICOH ProcessDirector.

When you install RICOH ProcessDirector, the installation program configures the existing version of DB2. It creates a DB2 instance for RICOH ProcessDirector to use. No other application should use this DB2 instance.

To work together, DB2 and RICOH ProcessDirector require several system users and groups. You should never log in as these users, but you might need to recognize them for recordkeeping and security.

Choose one of these three ways to create and specify which users and groups the applications should use:

  • Before you start the installation program, create the users and groups. Then, during the installation process, enter the names of the users and groups that you created. RICOH ProcessDirector finds and uses them.

    See Creating system groups and users for information about required users and groups.

  • During the installation process, enter different names for the users and groups and let RICOH ProcessDirector create them.
  • During the installation process, let RICOH ProcessDirector create the users and groups using the default values.

    The default users and groups are:

    DB2 instance user
    aiwinst
    DB2 instance group
    aiwdbgrp
    DB2 fenced user
    aiwdbfid
    DB2 fenced group
    aiwdbfgp

1.1.3.7.2.3 Installing and configuring your own copy of DB2 on a different computer

Use your own DB2 server on a different computer and a DB2 client on the same computer as RICOH ProcessDirector if:
  • You have other applications that already use DB2 on another computer.
  • You already have a DB2 license for another computer that you want to use with RICOH ProcessDirector.
  • You want to manage DB2 outside RICOH ProcessDirector.
  • You want to use the same DB2 server with several RICOH ProcessDirector primary servers.

The DB2 client and server do not have to be on the same operating system, but they must be at the same level and fix pack. RICOH ProcessDirector only supports using DB2 11.5.8 or later in this configuration.

    Important:
  • On Linux, the DB2 server requires a 64-bit operating system.

Before you install RICOH ProcessDirector, you must install and configure a DB2 server on the other computer and a DB2 client on the primary computer. If you are installing a manual failover configuration, you must install the DB2 client on both the active and the backup computers.

To install and configure the DB2 server and client:

  1. Install DB2 11.5.8 or later using the installation instructions provided with DB2.
    In the Set up a DB2 instance window, choose the option to defer this task until later.
  2. Verify that the computer that the DB2 server is installed on meets the memory and disk requirements to support RICOH ProcessDirector, keeping these issues in mind:
    • Each RICOH ProcessDirector primary server that connects to this DB2 server must use a separate directory on the DB2 server to store its databases. Each of those directories must have 22 GB of space available. By default, the primary servers use the home directory for their instance user to store their databases. If you use the default setting, make sure that the home directory for the instance user is large enough.

      However, in a manual failover configuration, the active and the backup computers share a DB2 instance. As a result, they both use the same directory and only require 22 GB of space, not 44 GB.

    • If you change the directory that the instance uses to store its databases, make sure that the home directory for each instance user has at least 300 MB of space available.
  3. Use the provided script to configure DB2 to work with each RICOH ProcessDirector primary server that connects to it.
    This configuration includes: creating a DB2 instance for RICOH ProcessDirector to communicate with; tuning the instance; creating the required groups and users (if needed); and starting the instance.

    The script is included in the /scripts directory on the RICOH ProcessDirector base product DVD.

    To configure the DB2 server:

    1. Insert the base product DVD in the drive and go to the /scripts directory.
        Note:
      • If you are using a Red Hat, CentOS, or Rocky Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:

        mount -t iso9660 -o remount, exec <mount_point>

        You must remount the drive for every CD or DVD that you insert.

    2. Type this command to run the script and press Enter:
      ./setupRemoteDB2.sh
    3. Respond to the prompts as required:
      • When the script asks for the DB2 instance name, type an instance name to use with one of your primary servers.

        Each primary server must have a unique DB2 instance. The default instance name is aiwinst; you can use this name with one of your primary servers. Record the instance name and password to use when you install RICOH ProcessDirector.

      • When the script asks for the DB2 instance group and the DB2 fenced user group, you can choose the default group or another existing group, or specify a new group to be created. The defaults are:
        DB2 instance group
        aiwdbgrp
        DB2 fenced group
        aiwdbfgp
        The instance user uses the DB2 instance group as its primary group; the DB2 fenced user uses the DB2 fenced user group as its primary group. If you are unsure which group to use, consult your DB2 administrator.
      • When the script asks for the DB2 fenced user name, you can choose the default user or another existing user, or specify a new user to be created. The default is aiwdbfid. If you are unsure which user to use, consult your DB2 administrator. You should never log in as this user, but you might need to recognize it for recordkeeping and security.
      • When the script asks for a DB2 instance port number, enter the port that you want DB2 to listen on for the primary server that uses this instance. The port number must be less than 65536. Record the port number to use when you install RICOH ProcessDirector.
    4. On the DB2 server computer, run the script again for each primary server that will connect to DB2.
        Note:
      • If you are configuring a manual failover environment, the backup computer shares the DB2 instance with the active computer. Do not run the script again for a backup computer.
    5. Record the host name or IP address of the computer that DB2 is installed on.
  4. Install the DB2 client on each of the computers that you plan to install RICOH ProcessDirector on, including any backup computers.
    Use the DB2 installation CD and choose the IBM Data Server Runtime Client.

    In the Set up a DB2 instance window of the installer, choose the option to defer this task until later.

    After the installation finishes, make sure the same DB2 Fix Pack that is installed on the client is also installed on the server.

  5. Continue installing RICOH ProcessDirector using the instructions in Installing.

1.1.3.7.3 Setting up networking configuration

To set up networking based on system networking information:
  1. Make sure that RICOH ProcessDirector has access to a Domain Name System (DNS) server. The DNS server must have correct entries for the host name and IP address of each RICOH ProcessDirector primary computer and application/secondary computer on the network.
      Note:
    • RICOH ProcessDirector supports both IPv4 and IPv6 protocols. If you use IPv4, IP addresses can be expressed using dotted-decimal addresses or the fully qualified host name. If you use IPv6, you must use the fully qualified host name of the server.
    • If you use an IPv6 address, you must complete additional configuration steps after you install RICOH ProcessDirector. See Configuring to use IPv6 addresses.
  2. Make sure that /etc/hosts on the primary computer has an entry for its IP address and the fully qualified host name.
  3. In your firewall, open any ports that RICOH ProcessDirector uses. Depending on your configuration, you might need these ports:

    Ports to open on the RICOH ProcessDirector primary server
    Port Source system Description
    15080 User workstation Access to the RICOH ProcessDirector user interface if not using TLS.
    15090 Administrator workstation Access to the RICOH ProcessDirector Feature Manager interface if not using TLS.
    15443 User workstation Access to the RICOH ProcessDirector user interface if using TLS.
    15453 Administrator workstation Access to the RICOH ProcessDirector Feature Manager user interface if using TLS.
    515 Customer application Required when sending jobs to RICOH ProcessDirector using LPR.
    5001-65535 Customer mainframe Required when sending jobs to RICOH ProcessDirector using Download for z/OS or AFP Download Plus. The port numbers defined in RICOH ProcessDirector must match the port numbers defined as printers on the mainframe.
    55555 RICOH ProcessDirector secondary server Required if you use secondary servers that are not defined on the same system as the primary server. Allows communication between the secondary server and the primary server.
    15080 or 15443 RICOH TotalFlow Print server Used to send printing status to RICOH ProcessDirector.
    Ports to open on RICOH ProcessDirector primary and secondary server
    Port Source system Description
    15081 Administrator workstation Used to import the custom PDF printer definition to the RICOH ProcessDirector server that will be communicating with the printer

    Only necessary when using custom PDF printers. Most systems do not use custom PDF printers.

    15081 Ricoh PDF printer The job ticket contains reference to a PDF file that the printer retrieves.
    Ports to open on the NFS server
    Port Source system Description
    111 RICOH ProcessDirector primary and secondary server Used by the NFS server and User Name Mapping function when sharing data from the primary server to secondary servers or other systems using NFS.
    2049 RICOH ProcessDirector primary and secondary server Used by the NFS server when sharing data from the primary server to secondary servers or other systems using NFS.
    Ports to open on printers
    Port Source system Description
    161 RICOH ProcessDirector primary and secondary server Required when RICOH ProcessDirector gets printer status and information using SNMP.
    8010 RICOH ProcessDirector primary and secondary server Required when RICOH ProcessDirector gets printer status and information using SNMP.
    9100-9103 RICOH ProcessDirector primary and secondary server Required when sending jobs to a printer with a EFI Fiery controller using Postscript job tickets.
    Ports to open on LDAP server
    Port Source system Description
    389, 636, or other port as configured. RICOH ProcessDirector primary server Required when RICOH ProcessDirector is using LDAP to authenticate users.
    Ports to open on printers that support JMF interfaces 1
    Port Source system Description
    80 RICOH ProcessDirector primary and secondary server Required when RICOH ProcessDirector sends IMSS queries using the HTTP protocol.
    8010 RICOH ProcessDirector primary and secondary server Required when sending JMF files to EFI Fiery controllers.
    9100 (default) - 9103 RICOH ProcessDirector primary and secondary server Required when sending jobs to a printer with a EFI Fiery controller using Postscript job tickets.

    9100 is the default port. EFI printers use port 9102.

    1These printers are defined in RICOH ProcessDirector as Ricoh PDF Printer objects.
    Ports to open on Passthrough printers
    Port Source system Description
    515 RICOH ProcessDirector primary server Required when receiving jobs from RICOH ProcessDirector using LPR.
    Ports to open on IPDS printers
    Port Source system Description
    5001-65535 RICOH ProcessDirector primary server Required when sending files to RICOH ProcessDirector using Download for z/OS or AFP Download Plus.

    These port numbers are configured when you create the input devices that receive these jobs. Open these ports after you define the input devices.

    Ports to open on a transform server
    Port Source system Description
    6984-6992 RICOH ProcessDirector primary server Required if you use any of the RICOH Transforms and they are not installed on the primary server. These transforms are not the same as the RICOH ProcessDirector Advanced Transform feature.
    16080 Administrator workstation Access to the Transform Features user interface if using any of the RICOH Transforms.
    Ports to open for the Reports feature
    Port Source system Description
    5432 RICOH ProcessDirector primary server and any system accessing RICOH ProcessDirector reports data Access to PostgreSQL database used to store data collected by the Reports feature. This database might be on the primary computer or on a different computer on your network.

    Required when using the RICOH ProcessDirector Reports feature.

    Ports to open on a DB2 server
    Port Source system Description
    DB2 prior to 11.5.8: 50000

    DB2 11.5.8 and higher: 25000

    RICOH ProcessDirector primary server Required when RICOH ProcessDirector uses a DB2 database installed on a different server.

    These are the default ports used by DB2; the default value changed in Version 11.5.8. If your installation of DB2 uses a different port, open the port you use.

    Ports to open for a primary PostgreSQL database
    Port Source system Description
    5442 RICOH ProcessDirector primary server Used for communication with the Docker container that holds the PostgreSQL database for RICOH ProcessDirector

  4. Verify network connectivity:
    1. To verify that host name resolution is working, enter this command:
      host localhost

      If you can access the DNS server, the response includes the host name localhost or loopback and the address 127.0.0.1. For example:

      localhost.mycompany.com is 127.0.0.1

    2. From the computer where you will access the RICOH ProcessDirector user interface, use both the host name and the IP address to ping the primary computer.
    3. From all application and secondary computers (if any), ping the primary computer.
    4. From the primary computer, ping all secondary computers (if any).
    5. Contact the network administrator if you are not successful with any of these verifications.
  5. Verify that the speed, duplexing, and autonegotiation settings for the Ethernet card are those that your network administrator recommends for optimum performance. The optimum settings are different for each installation.
    To display and change these settings:
    1. Log in as the root user.
    2. To display the Ethernet settings, enter:
      ethtool eth0
    3. If necessary, use the ethtool command to change these settings. Check with the network administrator for the appropriate flags and values for your network. For example, this command sets full-duplex mode:
      ethtool -s eth0 duplex full

      This command sets autonegotiation on:

      ethtool -s eth0 autoneg on

1.1.3.7.4 Running the prerequisite checker

Use the prerequisite checker to verify that your system is ready to install RICOH ProcessDirector.
    Note:
  • By default, the prerequisite checker log file is stored in this directory: /opt/infoprint/ippd/logs/installer/prereq.out
To run the prerequisite checker:
  1. Log in to the primary computer as the root user.
      Important:
    • You must log in as a user with UID 0. If you must log in as a different user, you can use sudo su - or su - to become the root user. However, do not use sudo or the su command in any other way to become the root user.
  2. Open a command line and enter this command to make sure that you are in the root directory:
    • cd /
  3. If you are installing from a product DVD:
    1. Insert the base product DVD in the drive.
    2. To determine the name of the mount point, enter:
      • ls /media
      On some systems, the name of the mount point is the same as the name of the CD or DVD.

      Note: If you are using a Red Hat, CentOS, or Rocky Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:

      mount -t iso9660 -o remount, exec <mount_point>

      You must remount the drive for every CD or DVD that you insert.

    3. Mount the drive, if necessary. Enter:
      • mount /media/mount_point
    4. Change directories so you can see the contents of the DVD. Enter these commands:
      • cd /media/mount_point
      • ls
      You see several scripts and directories, including a script called setup.
  4. If you are installing from a mounted ISO file:
    1. Create the ISO mounting point. For example, mkdir /isomount.
      Note: The mounting point for the ISO file does not need to be created off the root directory. It can be created anywhere on the system.
    2. Transfer the ISO file to the computer. For example, place the file in the directory /tmp/RPD.iso.
    3. Mount the ISO file using this command:mount -o loop /<location of ISO>/<mounting point>For example: mount -o loop /tmp/RPD.iso /isomount
  5. If you are installing from a remote directory:
    1. Follow the instructions in Installing from a remote directory. Return and complete this procedure after you go to the mounted directory.
  6. To start the prerequisite checker, enter: ./setup -p PREREQ_ONLY=TRUE
    Note: Make sure that you enter the command for the prerequisite checker correctly. If you type the -p flag incorrectly, the installer ignores the flag and runs the full installation program instead of the prerequisite checker.
If your system has all the prerequisites installed, the prerequisite checker exits without a message. If your system does not have all the prerequisites installed, a message is displayed showing the missing prerequisites. Refer to the prerequisite checker logs for more information. By default, the log file is stored in this directory: /opt/infoprint/ippd/logs/installer/prereq.out

1.1.3.7.5 Installing a Web browser

RICOH ProcessDirector requires a Web browser to access and display its user interface. You can access the user interface from the primary computer or from another computer. The workstation must have the most recent version of one of these Web browsers installed:

  • Mozilla Firefox
  • Google Chrome
  • Microsoft Edge

The user interface has a Web-based file viewer that requires a PDF viewer plug-in to display AFP or PDF files so you can select pages to reprint. To view print files, you can use an Acrobat plugin or the default PDF viewers that are included with Firefox, Chrome, and Edge.

We recommend installing Adobe Reader on any computers used to manage jobs. If you need to install Adobe Reader, you can download it from the Adobe website. The website tries to detect the operating system and language that your system is running. If you want to download the software in a different language, click More download options.

    Note:
  • To view jobs that use double-byte fonts using an Acrobat plugin in RICOH ProcessDirector, be sure that the font package for the Adobe Reader is installed on your system. This package is available from the Adobe website (http://supportdownloads.adobe.com/product.jsp?platform=windows&product=10).
  • Use the latest versions of the Firefox, Chrome and Edge browsers to get better functionality from their default PDF viewers.

1.1.3.7.5.1 Configuring Google Chrome

To access the RICOH ProcessDirector user interface from the Google Chrome Web browser, configure the browser with these settings:
  1. In the Chrome address bar, enter: chrome://settings/
  2. Under Privacy and security:
    1. Click Cookies and other site data and select Allow all cookies.
    2. Go back to Privacy and security and click Site settings. Scroll down to Content and click JavaScript. Make sure Sites can use Javascript is turned on.
  3. If you want to use the viewer component of RICOH ProcessDirector, you must verify that Chrome is configured to open PDF files in its built-in PDF viewer:
    1. In the Chrome address bar, enter: chrome://settings/content/pdfDocuments
    2. Make sure that the Open PDFs in Chrome is selected.
      Some actions (such as highlighting search text or using small or large zoom values) do not function properly when you use the built-in viewer with RICOH ProcessDirector.
  4. Close the settings tab.

1.1.3.7.5.2 Configuring Mozilla Firefox

To access the RICOH ProcessDirector user interface from a Windows computer with the Mozilla Firefox Web browser, you must configure the browser.
Important: The instructions to configure your version of Mozilla Firefox might differ from the instructions below. If any of the instructions do not work with your version of Firefox, click Help Help and search the Firefox help system. For example, search for enable javascript. As an alternative, use a search engine. For example, search for Firefox enable javascript.
To configure Mozilla Firefox:
  1. In the Firefox address bar, enter: about:config.
  2. Click I accept the risk!.
  3. To verify that Javascript is enabled:
    1. Find the javascript.enabled preference.
    2. Make sure the value is set to True.
      If the value is set to False, double-click the javascript.enabled preference to change the value to True.
  4. If you want to use the RICOH ProcessDirector right-click context menu, verify that the menu is enabled:
    1. Find the dom.event.contextmenu.enabled preference.
    2. Make sure the value is set to True.
      If the value is set to False, double-click the dom.event.contextmenu.enabled preference to change the value to True.
  5. Close the about:config tab.
  6. Click Menu Button Options.
  7. To make sure that Firefox can accept cookies:
    1. Click the Privacy & Security ()tab.
    2. In History, select Use custom settings for history to tailor cookies. Ensure Accept cookies from sites is selected.
  8. Optional: To change how files are downloaded:
    1. Click the General () tab.
    2. In the Downloads area, select Always ask you where to save files.
  9. Optional: If the Language feature is installed, you can change the language that RICOH ProcessDirector uses for the user interface text and most of the messages that it issues:
    1. In Language, click Choose and follow the instructions to add your language to the top of the list. Then click OK.
      Note: RICOH ProcessDirector supports these languages and locales:
      • Brazilian Portuguese (pt_BR)
      • English (en_US)

      • French (fr_FR)
      • German (de_DE)
      • Italian (it_IT)
      • Japanese (ja_JP)
      • Spanish (es_ES)
  10. Optional: When you install Firefox, it is configured to use a built-in PDF viewer. You can use the built-in PDF Viewer with RICOH ProcessDirector, but some actions (such as zoom and highlighting search text) might not function properly.

    In some cases, using a different plugin provides more functionality. Depending on the version of Firefox that you are running, you might need to try different options to find one that works with the RICOH ProcessDirector viewer.

    To set up the browser to use a different plugin for the viewer, do these steps:

    1. In Applications, go to the Content Type list, find Portable Document Format (PDF), and select it.
    2. Next to Portable Document Format (PDF), select the PDF plug-in you want to use.
    3. Try to view a job in RICOH ProcessDirector to see if it meets your needs.
    4. Repeat this process until you find the plugin that works best for you.
  11. Optional: In general, we do not recommend logging in to RICOH ProcessDirector as more than one user from the same workstation. If you do, each user must log in to a different browser session. To make this possible, you must create a browser profile for each additional user ID and enable Firefox to use more than one profile at a time:
    1. Close Firefox.
    2. Click Start Run.
    3. Enter this command:
      firefox.exe -ProfileManager
    4. Follow the instructions in the Profile Manager to create a new profile.
    5. In the Windows Control Panel, click System Advanced system settings Environment Variables.
    6. In the System Variables area, click New.
    7. In the Variable name field, type MOZ_NO_REMOTE.
    8. In the Variable value field, type 1.
    9. Click OK to close the New System Variable window.
    10. Click OK to close the Environment Variables window.
    11. Click OK to close the System Properties window.
    Whenever you start Firefox, you will be able to choose a profile that is not already in use.

1.1.3.8 Planning for optional software

You can install optional software to be used with RICOH ProcessDirector. The categories of optional software are:

  • Job submission
  • Data transforms
  • Fonts
  • Formatting changes to PDF banner pages

1.1.3.8.1 Job submission

RICOH ProcessDirector can receive jobs from any system that can send jobs to hot folders or from any system that can use the LPD protocol or pdpr command. If you have the AFP Support feature, RICOH ProcessDirector can receive jobs from the Job Entry Subsystem (JES) spool on a z/OS host. Jobs are submitted to input devices that you define in RICOH ProcessDirector. Input devices receive the jobs and then initiate job processing.

The supported job submission methods are:

Hot folders
Receives print files through File Transfer Protocol (FTP) or your preferred file copying method. When you copy or move a print file to the hot folder directory, the input device that is associated with the hot folder automatically receives the job and initiates job processing.
LPD
Receives jobs that are submitted using the line printer daemon (LPD) protocol. Users can use the lpr command or another command that uses the LPD protocol to submit jobs to a RICOH ProcessDirector LPD input device. The input device automatically receives the job and initiates job processing.
pdpr
If you are migrating from InfoPrint Manager and you use the pdpr command to submit jobs, you can configure RICOH ProcessDirector to accept jobs from the pdpr command. The RICOH ProcessDirectorpdpr script creates an lprafp command to submit jobs, adding flags to send supported job property values to the primary server.

If you have the AFP Support feature, these job submission methods are also supported:

AFP Download Plus
Converts line data to AFP data and transmits the print job with all required resources across the TCP/IP network from the host system to RICOH ProcessDirector for printing.
Download for z/OS
Automatically transmits output across the TCP/IP network from the host system to RICOH ProcessDirector for printing or archiving.

Download for z/OS and AFP Download Plus are separately ordered features of PSF for z/OS. For information about PSF for z/OS and its features, see the IBM website (http://www.ibm.com).

In addition to deciding which job submission methods to use, you need to determine the naming convention for the job submission directories on the primary computer where you want the input files to be. You must specify these directories when you create an input device:

Folder location directory
The name of the directory that an input device monitors for incoming jobs. For example, /aiw/aiw1/System/hf/LineData for hot folder jobs, /aiw/aiw1/System/lpd/LPDLineData for LPD jobs, or /aiw/aiw1/System/dl/AFP for Download for z/OS or AFP Download Plus jobs.
Staging location directory
The name of the directory where the job submission method places the input file. Consider creating a subdirectory of the folder location directory. For example, /aiw/aiw1/System/hf/LineData/Staged for line data input files received from hot folders or /aiw/aiw1/System/dl/AFP/Staged for AFP input files received from Download for z/OS or AFP Download Plus.

    Note:
  • Let RICOH ProcessDirector create these directories automatically with the correct ownership when it creates an input device. Do not create the directories yourself.

Each directory must provide read and write access to a group that the RICOH ProcessDirector system user (aiw1 is the default) is a member of so that RICOH ProcessDirector can read and modify the input files. One option is to use the RICOH ProcessDirector group (aiwgrp1 is the default). For more information about the RICOH ProcessDirector group, see Creating system groups and users and Completing post-installation tasks.

Before you use Download for z/OS or AFP Download Plus with RICOH ProcessDirector, you must configure the software to communicate with RICOH ProcessDirector. Some of the configuration tasks include:

  • Define a JES initialization statement for a functional subsystem application (FSA).
  • Create a startup procedure to identify program name, region size, and printing defaults for the FSA.
  • For Download for z/OS, create a routing control data set that points to the IP address of the primary computer and port number of the input device.
  • For AFP Download Plus, define a Startup Procedure to point to the IP address of the primary computer and port number of the input device.
  • Use installation exits, if necessary, for modifications to software functions. Both Download for z/OS and AFP Download Plus can use installation Exit 15, which transmits additional print parameters to RICOH ProcessDirector.

See the RICOH ProcessDirector information center for information about these topics:

  • Copying files to hot folders or sending files using the LPD protocol.
  • Installing and configuring the RICOH ProcessDirectorpdpr script.
  • Configuring Download for z/OS and AFP Download Plus with RICOH ProcessDirector.

For information about configuring Download for z/OS and AFP Download Plus, see PSF for z/OS: Download for z/OS and PSF for z/OS: AFP Download Plus.

1.1.3.8.2 Data transforms

Data transforms receive print jobs from RICOH ProcessDirector and transform the data from one data stream to another so that it can be printed.

You can purchase RICOH ProcessDirector features that are used to transform jobs from one datastream to another. You can also purchase external programs and connect them to RICOH ProcessDirector.

Products and features that provide data transforms
Product Data streams transformed to AFP Data streams transformed from AFP Other transforms Information
RICOH Transform features
  • GIF, JPEG, and TIFF
  • PCL
  • PDF and PostScript
  • SAP OTF and ABAP
  • PDF
  RICOH Transform feature information center
Advanced Transform feature
  • PCL
  • PDF
  • PostScript
  • PCL
  • PDF
  • PostScript
  • InputImage

    BMP, GIF, JPEG, PNG, and TIFF

When you send jobs with image files included in AFP object containers, you must install an input data stream transform to process them correctly. For example, for AFP files containing images, you must use the InputImage transform. When installed, the InputImage transform automatically handles images in these formats.

When you order the Advanced Transform feature, you choose the input data stream and output data stream transforms that you need. Then, you can combine them as needed.

For example, if you choose the InputAFP, InputPS, the OutputPDF, and the OutputPCL transforms, you can convert:

  • AFP to PDF
  • AFP to PCL
  • PostScript to PDF
  • PostScript to PCL

RICOH InfoPrint XT for Linux(installed on the same computer as the base product or on a secondary computer) Xerox metacode and LCDS     RICOH InfoPrint XT for Linux: Installation and User's Guide
RICOH InfoPrint XT for Windows(installed on an application server) Xerox metacode and LCDS     RICOH InfoPrint XT for Windows: Installation and User's Guide

For more information about these RICOH software products, see the RICOH Software web site: https://ricohsoftware.com.

For information about using an external step in a workflow to use data transforms, see the RICOH ProcessDirector information center in the user interface.

1.1.3.8.2.1 Preparing to install RICOH Transform features

Before you install a RICOH Transform features, make sure your system meets the minimum requirements.
  • Hardware requirements:
    • Minimum of an extra 10 GB free hard-drive space.
    • An extra 1 GB RAM for every CPU core, but no less than 4 GB.

      For example, if the computer has:

      • One dual-core processor, it must have an extra 4 GB RAM.
      • Two quad-core processors, it must have an extra 8 GB RAM.
      • Three quad-core processors, it must have an extra 12 GB RAM.
      • Four quad-core processors, it must have an extra 16 GB RAM.

  • File systems for the primary computer:
    1 GB additional free space in the RICOH ProcessDirector/opt file system.
  • Required software:

    WorldType Fonts version 8.13 for RICOH SAP to AFP files to transform correctly when IS/3 support is enabled.

    Java Runtime Environment 1.4 or higher.

    glibc 2.18 or higher

  • System and network setup:
    1. Determine the number of nodes that the RICOH Transform features will use.
      This value is based on the number of processor cores in the computer where you want to install the Transform feature. The value is 2 or half of the cores in the computer, whichever is larger. For example, if the computer has:
      • One single-core processor, the number of nodes is 2.
      • One dual-core processor, the number of nodes is 2.
      • Two dual-core processors, the number of nodes is 2.
      • Two quad-core processors, the number of nodes is 4.
      • Four quad-core processors, the number of nodes is 8.
    2. In your firewall, open the ports that the Ricoh Transform feature uses.
      These ports must have LISTEN permission for the listed application on the computer where you want to install the Transform feature:
      • Port 6980 for /opt/infoprint/itm/clients/fdi/fdi.
      • Ports 6984 and 6985 for /opt/infoprint/itm/hn/feps.
      • Port 6986 for /opt/infoprint/itm/clients/coord/coord.
      • Port 6989 through 6989 + (N-1) for /opt/infoprint/itm/node1/node through /opt/infoprint/itm/nodeN/node.

        Where N is the total number of nodes that the RICOH Transform features will use, as described above.

        For example, if the total number of nodes is 2, give LISTEN permission to:

        • Port 6989 for /opt/infoprint/itm/node1/node
        • Port 6990 for /opt/infoprint/itm/node2/node

      These applications must be able to make outgoing connections to the ports indicated on any computer:

      • /opt/infoprint/itm/clients/fdi/fdi to port 6984.
      • /opt/infoprint/itm/hn/feps to port 6986.
      • /opt/infoprint/itm/clients/coord/coord to ports 6984 and 6986.
      • /opt/infoprint/itm/hn/pd/pdexec to port 6984.
      • /opt/infoprint/itm/node[1 to N]/node to port 6985.
      • /opt/infoprint/itm/node1/xforms/ctt_standalone/ctt_standalone through /opt/infoprint/itm/nodeN/xforms/ctt_standalone/ctt_standalone to port 6989 through port 6989 + (N -1).

        Where N is the total number of nodes that the RICOH Transform features will use, as described above.

        For example, if the total number of nodes is 2:

        • /opt/infoprint/itm/node1/xforms/ctt_standalone/ctt_standalone to port 6989
        • /opt/infoprint/itm/node2/xforms/ctt_standalone/ctt_standalone to port 6990

    3. Add additional system users and groups.
      One additional group and two additional users are required.

      The default users are ipsitm and ipsejz; the default group is itm.

1.1.3.8.3 Supplied fonts

Five sets of fonts are included with the RICOH ProcessDirector media package. The fonts are not available for download when you download RICOH ProcessDirector. You can request the RICOH ProcessDirector media package when you order RICOH ProcessDirector.

The RICOH ProcessDirector media package provides these fonts:

AFP Outline Fonts (LCD4-5683)
These fonts can be used on Linux and Windows. They include fonts for Japanese, Korean, Simplified Chinese, and Traditional Chinese.
AFP Classic OpenType Fonts (LCD2-20029)
These fonts have four styles: Regular, Bold, Italic, and Bold Italic.
AFP Asian Classic OpenType Fonts (LCD2-20055)
These fonts can be used to replace the older AFP Asian single byte character set (SBCS) fonts.
WorldType Fonts (LCD4-5684)
These are OpenType and TrueType fonts in Microsoft Unicode format.
AFP Raster Fonts (LCD4-5700)
These fonts are distinguished from AFP outline fonts because they have character set and coded font names that are eight characters rather than six characters.

To install these fonts for use with RICOH ProcessDirector, copy all the fonts from the supplied media to the /usr/lpp/ipfonts directory on your primary computer. Be sure to copy all font files from the media subdirectories to /usr/lpp/ipfonts . Do not maintain the subdirectory structure from the source directory, but do make sure that the uppercase file names are preserved.

The AFP printer driver component and the line2afp data stream conversion component of RICOH ProcessDirector search that directory when they need a resource to process a job.

The AFP Support feature also provides a basic set of 240-pel and 300-pel fonts (compatibility fonts). These fonts include both uniformly spaced and mixed-pitch type families. These font families are included:

  • APL
  • Boldface
  • Courier
  • Document
  • Essay
  • Format
  • Gothic
  • Letter Gothic
  • Orator
  • Prestige
  • Roman
  • Script
  • Serif
  • Symbols
  • Text

1.1.3.8.4 Formatting PDF banner pages

You can change the formatting for PDF banner pages that RICOH ProcessDirector produces and sends to printers.

PDF banner pages use configuration files in the JRXML format. RICOH ProcessDirector provides sample JRXML files, but you can use customized files instead. The Jaspersoft® Studio application is open source software that helps you create JRXML files. You can download Jaspersoft Studio from https://community.jaspersoft.com/project/jaspersoft-studio and install the application on any supported workstation.

When you have created the JRXML files, copy them to the /aiw/aiw1/control_files/banner_pages/ directory on the primary computer and update the Header page configuration file and Trailer page configuration file properties for jobs that are sent to printers to use the new files.

    Note:
  • If you use specific fonts in your JRXML files, make sure that the fonts are available on your server.

    If a specific font is not available, find a compatible font and update the JRXML to use it instead. For example, if you installed DejaVu fonts and need a font that is compatible with Lucida Sans, open a command prompt and type:

    fc-match "Lucida Sans"

    Update the JRXML with the compatible font.

1.1.4 Upgrading

If you have RICOH ProcessDirector installed, you can upgrade to the current version without uninstalling your existing software, or by installing on a new system and moving your objects to it.

For information about the new functions and updates included in this release, see New in this release.

If you are upgrading RICOH ProcessDirector and have another computer, we recommend that you install on that computer. By installing on a different computer, you decrease the risk of problems and minimize downtime during this process. When the installation finishes, you can migrate your objects from your existing system to the new system. You can then verify the new installation while the old computer is still running.

In version 3.12, RICOH ProcessDirector introduced the Migration Assistant. Start this tool on your newly installed system (known as the target system) to access your existing system (known as the source system) and move objects over. The Migration Assistant simplifies the process, so you don't have to manually export objects from one system and import them to the new system.

Database evolution

For many years, RICOH ProcessDirector supported only IBM DB2 as its database. In version 3.12, support was expanded to include PostgreSQL. PostgreSQL replaced DB2 as the default configuration for RICOH ProcessDirector.

When you upgrade to version 3.12 or later, you have two choices:

  • Continue to use DB2
  • Migrate to PostgreSQL

    Note: If you choose this option, you install PostgreSQL during the installation process, then move your data into the new database after the installation is complete.

Each option has different variables to consider, such as:

  • The PostgreSQL configuration can be installed on Rocky Linux; DB2 cannot.
  • If you plan to install the upgrade on a different computer, the Migration Assistant can move your objects and settings into PostgreSQL just as easily as into DB2.

Choose which database configuration to use before you upgrade, based on these factors and specifications for your environment.

1.1.4.1 Upgrading on the same computer

If you are upgrading to a more recent version of RICOH ProcessDirector on the same computer, you need to meet certain requirements:
  • You have Version 3.7 or higher of RICOH ProcessDirector.
  • Your system meets all the prerequisites for this version.
      Important:
    • The installer for newer versions of RICOH ProcessDirector enforces prerequisites more rigorously than earlier versions. If your operating system does not meet the minimum requirements, the installer cancels the installation. You do not need to uninstall RICOH ProcessDirector to install an operating system upgrade.
    • Before upgrading, determine the database to use for running RICOH ProcessDirector. Starting with version 3.12, PostgreSQL is now the default database configuration. When upgrading to a more recent version you can continue to use DB2 with no interruptions or can choose to migrate your data to a PostgreSQL database.

The installation process upgrades the base product and almost all the features that are currently installed. RICOH Transform features and extended features (custom software components) are not updated automatically. You install them separately after you install the upgrade.

If you use more than one RICOH Transform features, upgrade all the transform features before you install your new license key.

To upgrade to the current version of RICOH ProcessDirector on the same computer:

  1. Verify that your system meets the prerequisites.
  2. Before upgrading your system, back up your data.
    See Backing up data for more information.
      Note:
    • If you are migrating from DB2 to the PostgreSQL database, take a backup of your DB2 database to avoid the risk of data loss.
  3. If RICOH ProcessDirector is running with a DB2 database and you want to update your database, update it before or after you install RICOH ProcessDirector. See Upgrading the DB2 database for more information.
  4. Follow the instructions in Preparing the primary computer for installation and Installing the base product. When the installation is complete, return here and continue with step 6.
    See Installing for more information.
      Note:
    • If you plan to use PostgreSQL for your database configuration, choose Install and use PostgreSQL when you are asked which database configuration to use.
  5. If you installed PostgreSQL and need to migrate your data to PostgreSQL, continue with: Migrating data from DB2 to PostgreSQL
  6. If you did not restart the computer that RICOH ProcessDirector is installed on as part of step 4 above, restart it now.
  7. When the computer restarts, RICOH ProcessDirector should start automatically. Use your browser to log in to the user interface. If an error occurs during the installation, contact Ricoh Software Support.
      Note:
    • Use the About box to verify that the product version was updated.
    • Use the Feature Manager to verify that all of your previously installed features were updated to new levels.

      Open Feature Manager by clicking Administration Utilities Features. If you see an error message, you must start Feature Manger manually:

      1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
      2. Open a command prompt and type: startaiw -f
      3. To complete the process, clear your browser cache.

        Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.

      4. Reload the Feature Manager web page.
  8. Continue with Completing the upgrade process to finalize the upgrading process.
    Important:
  • RICOH ProcessDirector and all features install in trial mode. After you upgrade, download and install license keys. If the trial period expires before you install license keys, the software stops working. See Downloading and installing license keys for more information.

1.1.4.2 Upgrading on a different computer with Migration Assistant

To reduce the risk of problems, we recommend installing RICOH ProcessDirector on a different computer and then migrating your objects from the existing system to the new system.
Using the Migration Assistant when upgrading reduces downtime during migration by preventing problems such as missing features and ensuring that objects and all their dependencies are migrated together.

When using the Migration Assistant, the system you want to migrate from is referred to as the source system, while the destination system for migration is referred to as the target system.

1.1.4.2.1 Preparing to use the Migration Assistant

For a successful migration, we recommend taking some measures to prepare your systems to avoid difficult-to-solve problems that could lead to migration failure.
To prepare your systems for migration:
  1. Install RICOH ProcessDirector on the target system.
    1. Verify that your system meets the prerequisites.
    2. Follow the installation instructions just as you would for a new installation.

      See Installing for more information.

    3. Return to this procedure after you complete the process to install the base product.
    4. Log in to the version of RICOH ProcessDirector that you just installed. Use the User Name aiw and the Password aiw.

      When you change the password for this user, remember the new password. We recommend logging in as this user until the migration process is complete and all users are imported to the target system.

    5. Install the same features that you had on your old system and any new features that you have purchased. If an error occurs during the installation, contact Ricoh Software Support.
    6. Download and install license keys. RICOH ProcessDirector and all features install in trial mode. If the trial period expires before you install license keys, the software stops working.

      See Downloading and installing license keys for more information.

      Note: You can install license keys after the migration process is complete if you prefer.
  2. If you are using the Preprinted Forms Replacement feature, export the media.zip file from your target system and copy it to the source system. Follow the instructions for Exporting media with electronic forms.
  3. When you import step resources, the files that they refer to are not included in the export package. Copy the files referenced in the step resources from the source system to the target system manually. You must copy the files to the target system before you start the Migration Assistant.
    1. To import all the step resources, copy the contents of /aiw/aiw1/StepResources from the source system into the same directory on the target system.
    2. To import specific step resources, open the XML file that you exported. Find the entry for each step resource that you exported and locate the StepResource.File property. In that value, find the name of the RSC file associated with that step resource. For example, in this value:
      <property name="StepResource.File" value="{&quot;fileName&quot; : 
      &quot;/aiw/aiw1/StepResources/
      1992052c6ef44a229b8b43d77232bf53.rsc1992052c6ef44a229b8b43d77232bf53.rsc
      &quot; , &quot,&quot;displayName&quot; : &quot;
      Ricoh_Export-2019-08-26_13-30-04.xml&quot;}"/>

      The file name is: 1992052c6ef44a229b8b43d77232bf53.rsc

    3. Find the file on the source system and copy it into the same directory on the target system.
  4. The Migration Assistant cannot migrate credentials of any kind. However, objects that require them fail to import if they do not exist on the target system. Export your Password, Session, and Static credentials from the source system now. Import them onto your target system before you start the Migration Assistant.
      Note:
    • Private Key credentials cannot be exported, because they must be created on the system where they are used. Objects that use private key credentials fail in the Migration Assistant and must be recreated manually afterwards.
  5. Prevent common issues that can result in migration failure:
    1. Take a snapshot or backup of both the source and target systems to avoid the risk of data loss.

      See Backing up data for more information.

        Note:
      • Using Migration Assistant to upgrade on a different computer does not affect the source system, preserving the data and configuration. We recommend backing up both systems as a safety measure.
    2. Make sure that the Product Update features are installed on both systems at the same level. In the Feature Manager, find the Product Update feature for both systems and compare the values in the Installed Version column.
        Note:
      • If the target system has a higher version, you have the opportunity to download the package during the migration. Then you can install the Product Update using Import Package on the source system Feature Manager page.
      • If the source system has a higher version, find the most recent product update package in: /opt/infoprint/ippd/available. The name of the package is: ProductUpdate-3.4.version_number.epk. Download the package, then log in to the target system. Open Feature Manager, import the package, then install it.

        For more information, see Adding or upgrading a feature using Import Package.

    3. Check file system capacity. For a successful migration, the target system should have at least as much available capacity as the source system.
    4. Disable any software that scans and locks files, such as antivirus and security software, that may interfere with installation or performance.

1.1.4.2.2 Running the Migration Assistant

With the Migration Assistant, objects are transferred from one RICOH ProcessDirector system to the other. This process significantly minimizes the likelihood of human error associated with the import of a large number of objects.
Before you begin, make sure you know the URL for the login page of the system you want to migrate from (source system). To proceed with migration, you need Administrator access for both the source and target systems.
    Note:
  • We recommend logging in to the target system using the aiw user, as your RICOH ProcessDirector user ID probably does not exist on the new system yet.
  • You can create a new administrator user to log in to the target system, but, if it exists on the source system, it is overwritten during migration.
To use the Migration Assistant:
  1. Log in to your RICOH ProcessDirector target system as aiw user.
  2. Click the Administration tab.
  3. In the left pane, click Utilities Migration Assistant.
  4. Select IMPORT FROM ANOTHER SYSTEM.
  5. Log in to the source system with an administrator user name and password.
      Note:
    • You must provide the full URL for the log in page of the source system.
  6. On the Verify page, make sure all the information presented is correct and click Continue.
  7. On the Prepare page, review the suggested actions to reduce the migration failure possibilities. For each step, you have the option to either complete or ignore it. Click Save and Continue to proceed with the migration.
    For example, in this step, you can make sure that the Product Update features are installed on both systems at the same level. In the Feature Manager, find the Product Update feature for both systems and compare the values in the Installed Version column.
    • If the target system has a higher version, click the download button in the Migration Assistant to save the package to your system. Then you can install the Product Update using Import Package on the source system.
    • If the source system has a higher version, find the most recent product update package in: /opt/infoprint/ippd/available. The name of the package is: ProductUpdate-3.4.version_number.epk. Download the package, then log in to the target system. Open Feature Manager, import the package, then install it.

      For more information, see Adding or upgrading a feature using Import Package.

  8. On the Features page, click CHECK FEATURES to compare the features installed on the systems. To proceed, make sure that both the source and target systems have the same features installed.
    If any features are missing, click Save and Continue. Review the features to install and click OK. Feature Manager opens so you can install the missing features. After the features are installed, log in to your RICOH ProcessDirector target system again and return to the Migration Assistant. When both systems contain the same features, click Continue to proceed with the migration.
      Note:
    • If you purchased one or more features for the first time, they can exist on the target system only.
    • If you worked with Ricoh's Advanced Solutions Practice to install additional functions on your source system, you must transfer those feature packages to your target system. Contact your Ricoh representative for assistance.
  9. On the Objects page, select to migrate all objects from your source system or specific objects.
    We recommend migrating all objects, but you can select which objects to migrate if you want to take this opportunity to remove some objects from your system. If you choose to selectively migrate objects, click the Select objects and choose the objects you want to migrate.

    The Migrate options let you overwrite any identically named objects on the target system with the corresponding objects from the source system.

  10. On the Settings page, select which previously configured system settings to migrate. These settings are configured in the Settings section of the Administration page. Choose the settings to import and click Save and Continue.
    Note: System Identification properties cannot be exported with General System settings and must be created on the system where they are used.
  11. Before proceeding with the migration process, review the configuration to import from the source system. If you need to change any choices, you can navigate to any step of setting up the migration elections by selecting Edit.
  12. When everything is confirmed, click START MIGRATION.
    The Migration Assistant starts to import objects and settings while displaying the progress. You can download the migration log file to review the details when any migration errors occur or the final version when the migration is complete.
  13. Download the ZIP file log if there are any errors that you need to review.
  14. After you download the ZIP file, click X button at the top of the page to exit the MIGRATION ASSISTENT.
    Note:
  • You can click X in the upper right corner of the window followed by SAVE CHANGES to save the progress at anytime during migration. In this way, you can return to complete the migration process from where you left off.
  • See Completing the upgrade process to complete the migration process.

1.1.4.3 Completing the upgrade process

After you upgrade RICOH ProcessDirector, you must do a few more steps to make the transition easier.
If you upgraded on the same computer, the upgrade process converts your objects to versions that are compatible with the new RICOH ProcessDirector version. All your existing users and groups exist, so your users can log in using the same names and they have the same authority levels. When you log in, you see all of your printers, input devices, and other objects.

If you upgraded on a different computer, you should be able to log in and see all the objects that you imported. However, there are still some manual steps required to finish the migration process.

To complete the upgrade process:

  1. If you upgraded to a different computer with Migration Assistant, take these actions:
    1. Re-enable any antivirus and security software that were disabled during the migration process.
    2. The Migration Assistant cannot import TLS configuration information; you must configure it on the new system again.
    3. If you migrated your primary server from one operating system to another (especially from Windows to Linux or vice-versa), check and update all paths used in your workflow steps.

      Make sure all directory paths are updated to the directory structure of the new system. If you are migrating from RICOH ProcessDirector AIX to Linux or Windows, this step is essential.

    4. Review the log for any errors, including objects that failed to import.
      Objects the use Private key credentials fail to import because the credentials do not exist. Recreate your private key credentials on the target system, then create those objects manually.
    5. Copy all your configuration files to the right locations, so your jobs can find them.

      Restore any configuration files that you store outside of the /aiw/aiw1 file system.

    6. Recreate the visual mechanisms used to help distinguish between RICOH ProcessDirector from another. Use the System identification settings on the System Settings page to set a background color or configure a tab in the banner.
    7. If you created a custom portlet on a RICOH ProcessDirector system prior to version 3.10.2, you cannot import it to a system with RICOH ProcessDirector version 3.12 or later. Create the custom portlet again on the source system.
    8. Update your secondary and application servers, then make sure the migrated objects can connect with the upgraded system.

      See Setting up application and secondary servers for more information.

        Note:
      • Verify that all input devices and printers connected to the secondary and application servers are functioning properly.
      • Verify that all applications running on these systems, such as Avanti, PitStop, and Ultimate Impostrip®, are able to connect.
    9. If you use the RICOH Supervisor Connect feature, the Migration Assistant copied some settings, but cannot complete the connection process.

      Refer to the procedure Setting up to send data to RICOH Supervisor to connect to RICOH Supervisor.

    10. If you use custom document properties that were created in RICOH ProcessDirector prior to version 3.11.2, copy /aiw/aiw1/config/docCustomDefinitions.xml to the target system and run the docCustom utility to activate them. Custom document properties created in RICOH ProcessDirector 3.11.2 using the Custom properties page migrate just as any other properties do.
    11. Before putting the new system into production, set the value for “Smallest job number” from System Setting to synchronize your job numbering.
  2. Update any secondary and application servers to the new level.
  3. Before they log in for the first time, tell your users to clear their browser cache.

    Information that is stored in the browser cache can cause errors when users try to use the newer level. Clearing the cache prevents those errors.

1.1.4.4 Backing up data

You can use a backup script to archive a copy of your RICOH ProcessDirector system configuration.
To back up RICOH ProcessDirector data:
  1. Stop all application and secondary servers. The backup procedure stops the primary server automatically. See Stopping the base product and secondary servers andStopping an application server.
  2. Log in to the primary computer as the root user.
  3. Enter /opt/infoprint/ippd/bin/aiwbackup.pl with any of these options:
    Option Description
    -f filename Back up data to a directory and file name other than the default, which is /tmp/aiw_backup_data.[timestamp].tar.gz .
    -m Do not make a backup image of the DB2 database. Use this option if the DB2 database is on a different computer.
    -r Input files and job files (the files in the spool directory that contain job information, including copies of input files) are saved by default. A backup with the -r option does not save input files or job files, but it does save jobs. System data and control files are always saved.
      Important:
    • The -r option is slightly different on the aiwbackup and aiwrestore commands:
      • On aiwbackup, the -r option removes only input files and job files from the saved system. It does not delete the jobs from the system.
      • On aiwrestore, the -r option removes jobs, input files, and job files from the restored system.
      If you use the -r option when you back up RICOH ProcessDirector, you should also use it when you restore the system to avoid restoring jobs whose files have not been saved.
    -h or -? Display help for the aiwbackup command.
    For example, this command saves data, including jobs, but not including input files or job files, to a file called mybackup.tar.gz:
    • /opt/infoprint/ippd/bin/aiwbackup.pl -f mybackup.tar.gz -r
    You see a message that all servers will be stopped, whether jobs and input files will be backed up, and the location of the backed up files.
  4. Enter Y to proceed with the backup.
    When the backup is complete, you see a message that the backup was successful.

1.1.4.5 Exporting media with electronic forms

To reuse media objects with electronic forms on another RICOH ProcessDirector system, you can export them by copying the media.zip file to another system. The Export Objects function exports media objects but does not export the electronic forms defined for media objects.
RICOH ProcessDirector creates a media.zip file whenever you define, edit, rename, or delete a media object.
To export media with electronic forms:
  1. Log in to the primary computer.
  2. Go to this directory:

    • /aiw/aiw1/share on Linux
    • C:\aiw\aiw1\share on Windows

  3. Copy the media.zip file to the system that you are exporting the media to.
  4. Log in to the RICOH ProcessDirector primary computer on that system and put the media.zip file in this directory:
    • /aiw/aiw1 on Linux
    • C:\aiw\aiw1 on Windows
  5. Extract the media objects from the media.zip file.
    Extracting the media objects:
    • Puts a media.xml file in the same directory as the media.zip file.
    • Adds all electronic forms defined for the media to this directory:
      • /aiw/aiw1/constantforms on Linux
      • C:\aiw\aiw1\constantforms on Windows

    If the constantforms directory has another version of an electronic form, the file extraction process asks if you want to replace the form. For example, the constantforms directory could have copies of the sample forms installed with the Preprinted Forms Replacement feature.

    • To extract only forms that are not on the system where you are importing the media objects, choose the option to replace none of the files.
    • To replace all the forms on the system with the version of the forms in the media.zip file, choose the option to replace all the files.

  6. Make sure that the RICOH ProcessDirector system user and group ( aiw1 and aiwgrp1 are the defaults) have permission to read and modify these files and directories:
    • The constantforms directory
    • All electronic forms in the constantforms directory
  7. Import the media objects:
    1. Click the Administration tab on the user interface of the system where you are importing the media objects.
    2. In the left pane, click Utilities Import Objects.
    3. Click File to Import.
    4. Go to this directory:
      • /aiw/aiw1 on Linux
      • C:\aiw\aiw1 on Windows
    5. Select the media.xml file.
    6. Select the media objects that you want to import.
    7. To make sure that you do not update media objects that exist, click Deselect existing objects.
    8. Click Import.
    For more information about importing objects, see the related task for copying objects from another system.

1.1.4.6 Upgrading a manual failover environment

If you have your primary computers installed in a manual failover environment, you must upgrade both systems.

The process for upgrading a manual failover configuration varies based on the database configuration that you used with the previous version and the one you want to use with the new version, and can be complicated by other factors.

    Important:
  • Before proceeding to upgrade in a manual failover environment, you must make sure that the production and failover servers meet the prerequisites to install the update. Therefore, you must run the prerequisite checker first on the production server and then on the failover server. See Running the prerequisite checker
  • Make sure that the failover process is set up correctly and running succesfully before upgrading a manual failover environment, by switching from the production server to the failover server and back to the production server.

To start the upgrading process in a manual failover environment:

  1. On the production server, do these steps:
    1. Upgrade the production server to the current version. See Upgrading to the current version.
    2. Verify the installation to make sure that the installation completed successfully.
    3. Install the license keys for the production server. See Downloading and installing license keys
    4. Log in to the production server as the system user (aiw1 is the default).
    5. Open a command line and type stopaiw to shut down RICOH ProcessDirector on the production server.
  2. On the failover server, do these steps:
    1. Log in as the root user.
    2. Open a command line and go to the directory where the installation media is located and type scripts/failover-setup-rpd-node.sh and press Enter to run the script. The script adds entries to /etc/services, installs PSF if necessary, and updates the rpm database on the failover server.
    3. Switch the active node to the failover server by entering /opt/infoprint/ippd/bin/changeHostname.pl server_hostname where server_hostname is the name of the production server.
    4. Verify the installation on the failover server.
    5. Install the license keys for the failover server.
    6. Log in to the failover server as the system user (aiw1 is the default).
    7. Open a command line and type stopaiw to shut down RICOH ProcessDirector on the failover server.
  3. On the production server, log in as the root user.
  4. Switch the active node to the production server by entering /opt/infoprint/ippd/bin/changeHostname.pl server_hostname where server_hostname is the name of the failover server.

1.1.4.7 Upgrading the DB2 database

When you upgrade RICOH ProcessDirector, the version of DB2 database that is embedded in RICOH ProcessDirector is left at the same level. You can upgrade the DB2 database before you start the RICOH ProcessDirector install program or after the install program completes.

If all these statements are true, you can upgrade the DB2 database using the DB2 installation DVD or ISO file provided with RICOH ProcessDirector:

  • Your current DB2 database and RICOH ProcessDirector system is backed up.
  • The current installed version of the DB2 database is 9.7, 10.1, or 10.5.
  • The DB2 database being updated is the version installed by RICOH ProcessDirector and not supplied by an external source.
  • You have the DB2 installation DVD or ISO file provided by Ricoh.

You can use scripts provided on the DB2 installation media to upgrade the DB2 database before or after you install RICOH ProcessDirector.

    Note:
  • You can only use the upgrade scripts with the version of DB2 that is installed with RICOH ProcessDirector. If you installed your own version of DB2 to work with RICOH ProcessDirector, use the standard upgrade process provided by IBM.

If you manually upgrade the DB2 database before upgrading RICOH ProcessDirector, do not start RICOH ProcessDirector until you upgrade to the new version. Some older versions of RICOH ProcessDirector do not work with newer versions of the DB2 database.

Whether you are installing using a DVD or an ISO image, make sure that you can access the DB2 installation media from the primary server. Complete these procedures as needed:

To upgrade the DB2 database manually:

  1. Verify that your system meets the requirements listed above.
  2. Log in to the primary computer as the system user (aiw1 is the default).
  3. Open a command line and type: stopaiw
  4. Type su - root and press Enter. When prompted, enter the password for the root user and press Enter.
  5. Go to the directory where the DB2 installation media is mounted and find: scripts/upgradeDB2.sh
  6. To run the script, type scripts/upgradeDB2.sh and press Enter.
      Note:
    • It can take several minutes for the script to complete.

      When the script finishes, the command prompt returns: Successfully upgraded DB2.

  7. Check the installation log for any errors. Go to /opt/infoprint/ippd/logs/installer/ and open upgradeDB2.log.
  8. Verify the DB2 database level on the system. Type /usr/local/bin/db2ls and press Enter.

    The command displays the current DB2 database level along with the install path and install date. If the installation was successful, the DB2 database level is 11.5.8.

  9. If you upgraded the DB2 database before upgrading RICOH ProcessDirector, continue with installing RICOH ProcessDirector.
  10. If you upgraded the DB2 database after upgrading RICOH ProcessDirector, start RICOH ProcessDirector and log in to verify that the upgrade was successful.

1.1.4.8 Migrating data from DB2 to PostgreSQL

If you previously used RICOH ProcessDirector with DB2 and are migrating to the PostgreSQL database configuration, you must migrate your data from one database to the other after installing the update.
After the upgrade, RICOH ProcessDirector is still running on the DB2 database.
    Note:
  • This procedure assumes that you installed RICOH ProcessDirector in the default location. If you installed in a different location, paths to files and scripts must be adjusted to your installation.

    The default paths are:

    • $AIWPATH: /opt/infoprint/ippd
    • $AIWDATA: /aiw/aiw1

To migrate your data from DB2 to PostgreSQL:

  1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
  2. Make sure that you can access both the DB2 and the PostgreSQL databases. Open a command line and enter these commands.
    • To check for DB2 enter: db2 connect to aiwdb

      If no connection info is returned, enter: db2start and check the status again.

    • To check for PostgreSQL, enter: docker info
  3. Prepare a migration directory.
    1. Create a temporary directory for the migration. For example: mkdir $AIWDATA/tmp/migrateDb2ToPostgresql
    2. Navigate to: $AIWPATH/base
    3. Copy the migrateDb2toPostgresql-version.zip to your temporary migration directory and unzip.
    4. In your temporary migration directory, update the permissions for migrateDb2ToPostgresql.pl
      Type: chmod +x migrateDb2ToPostgresql.pl
    5. Update the permissions for rexact.pl.
      Type: chmod +x rexact.pl
  4. Run the migration tool.
    1. Stop RICOH ProcessDirector, except the database: stopaiw -d
    2. Log in as the root user.
    3. Run . /opt/infoprint/ippd/base/config/ippdprofile
    4. From the migration directory, run the migration script: ./migrateDb2ToPostgresql.pl

    The migration starts by restarting the activation to create tables in PostgreSQL database. Activation status messages are displayed.

    When the activation is complete, the script runs the migration. As the migration script runs, you should see status messages such as: Migrating table <tablename>

      Note:
    • Additional log messages are written to: $AIWPATH/logs/installer/rexact.log and $AIWPATH/logs/installer/migrateDb2ToPostgresql.log
    • If you see error messages during the migration, see Troubleshooting data migration errors.
  5. Stop and restart RICOH ProcessDirector:
    1. Log in as the RICOH ProcessDirector system use (aiw1 is the default).
    2. Run stopaiw
    3. Run startaiw
  6. Log in to RICOH ProcessDirector. All objects and jobs should now appear on the Main page.
      Note:
    • You can see extra jobs in the system if sample input devices are enabled while the migratingDb2ToPostgresql.pl script runs. The script reactivates and submits jobs to the sample input devices.
  7. After you verify everything, proceed with uninstalling the DB2 database.
  8. To uninstall DB2:
    1. Log in as the root user.
    2. Enter these commands to uninstall DB2 database.
      • cd $AIWPATH/db_version/instance
      • ./db2idrop aiwinst
      • cd $AIWPATH/db_version/install
      • ./db2_deinstall –a
    3. Remove the following directories if they exist:
      • $AIWDATA/db2
      • $AIWDATA/db2_logs
  9. Continue with Completing the upgrade process.

1.1.4.8.1 Troubleshooting data migration errors

If you see errors when migrating data from DB2 to PostgreSQL, check the following:

Unable to connect to the DB2 database.
Make sure that DB2 is running and that you can connect to it. To check for DB2 database enter: db2 connect to aiwdb

If no connection info is returned, enter: db2start and check the status again.

Unable to connect to the PostgreSQL database.
Make sure that PostgreSQL database is running.
To check for PostgreSQL database open a command line and type: docker info
Table {0} was not found in the PostgreSQL database.
If you see this message and you find that there are missing objects or configurations on the server, contact Software Support. It is normal for some tables to be removed if they are no longer used.
Table {0} was not found in the DB2 database.
Tables might be missing be due to the installation of additional features.
Failed to migrate table {0} because of {1}
Try to migrate the table again by running ./migrateDb2ToPostgresql.pl -t <tablename> script. If the table migration fails again, contact Software Support for assistance.
Unable to read the list of tables for migration.
Contact Software Support for further assistance.
Invalid configuration file: System.database.cfg
Check the file permissions for the System.database.cfg file. Type: ls -l $AIWDATA/config/System.database.cfg and compare the output to this: -rwxrwxr-x

If they do not match, update the permissions as needed. Otherwise, contact Software Support for further assistance.

Unable to remove the DB2 license because of {0}
The DB2 file could not be cleaned. This error can be ignored as uninstalling DB2 results in cleaning the file.

1.1.5 Installing

When you order RICOH ProcessDirector and request media, you receive one or more installation discs.

If you do not request media or if you want to install before the physical media arrives, you can download ISO images from the Ricoh Production Print website: http://rpp.ricoh-usa.com/products/software/workflow/ricoh-processdirector. To download the software, follow the instructions in Downloading installation files.

The discs or the ISO files include:

  • One that holds the base product. This DVD or ISO file includes installers for trial versions of the features that can be installed using Feature Manager.
  • DVDs and CDs that hold supplied fonts. See Supplied fonts

    .
  • If you purchased a Secondary Server feature, a CD or ISO file that holds the secondary server installer.
  • If you purchased any of the Ricoh Transforms, DVDs or ISO files that hold the installers for each transform.

The RICOH ProcessDirector Secondary Server feature and application servers are the only components that are installed on different computers.

    Important:
  1. RICOH ProcessDirector is installed in trial mode. After you install, you can download and install license keys for the features that you have purchased. See Downloading and installing license keys for more information.
  2. The installation instructions for installing RICOH ProcessDirector on an active computer with a backup computer in a manual failover configuration are different than for installing on a primary computer alone. See Installing a manual failover environment.
  3. If the computer where you plan to install the base product already has a RICOH ProcessDirector Secondary Server feature installed, you must uninstall the Secondary Server feature before you install the base product. See Uninstalling Secondary Server features for details.
  4. To migrate your objects from a primary server running on one operating system to a primary server running on a different operating system, follow the instructions in Running the Migration Assistant after installing RICOH ProcessDirector.
  5. RICOH ProcessDirector is not guaranteed to work with third party products installed on the server, such as antivirus programs and network sniffers. Such programs may affect ports or files which are needed for RICOH ProcessDirector to function normally.

1.1.5.1 Task checklist

Here are the tasks you need to complete in this chapter. Check each item as you complete the task.

Checklist for completing installation tasks
  Task
  Preparing the primary computer for installation

Use this procedure to make sure that you are ready to run the installation program.

 

Optional: Downloading installation files

If you do not have installation discs, use this procedure to download ISO images of them.

  Optional: Installing from a remote directory

You can use a remote directory to install RICOH ProcessDirector or a Secondary Server feature without using a DVD. You can use a DVD drive on a different computer to copy the installation programs into the remote directory on your network. The remote directory holds the installers so you can access them from the computers that you want to install RICOH ProcessDirector on. The remote directory can be located on the computer that you plan to install RICOH ProcessDirector on.

  Installing the base product

Use this procedure to install RICOH ProcessDirector.

  Optional: Installing a manual failover environment

A manual failover environment consists of two primary servers, one production server and one failover server, that can both access file systems installed on a shared file server. If the production server becomes unavailable, you can move processing to the failover server until the production server is available again.

  Troubleshooting installation errors

If you have trouble installing RICOH ProcessDirector, you can find information in the installation logs.

1.1.5.2 Preparing the primary computer for installation

When you are ready to install RICOH ProcessDirector, use this procedure to make final configuration updates and verify that the system configured correctly.
    Note:
  • If you are using a copy of DB2 installed on a different computer instead of the version of DB2 that is included with RICOH ProcessDirector, make sure that you complete Installing and configuring your own copy of DB2 on a different computer before you start this procedure.
  • Setting the umask to use strict permissions might cause read or write issues on the installation folder. Therefore we recommend setting umax to 022, the default set of permissions.
To prepare the primary computer:
  1. Make sure that the planning checklist is complete and the required hardware and software are available and installed. See Planning for installation.
  2. Make sure that /etc/hosts on this computer has an entry for its IP address and the fully qualified host name.
  3. Log in as the root user.
      Important:
    • You must log in as a user with UID 0. If you must log in as a different user, you can use sudo su - or su - to become the root user. However, do not use sudo or the su command in any other way to become the root user.
  4. We recommend that you set user resource limits for the maximum number of open files, number of processes, and stack size.
    All systems perform better with the new settings. Systems with areas of high volume require the settings.
    1. Edit the /etc/security/limits.conf file with a text editor to set these limits:
      * soft nofile 16384
      * hard nofile 32768
      * soft nproc 16384
      * hard nproc 65536
      * soft stack 16384
      * hard stack 32768
    2. Save the file and exit the editor.

      The new limits do not take effect until you log out and log back in.

  5. Optional: If you plan to use IBM DB2 as the RICOH ProcessDirector database, check to see whether DB2 or a DB2 client is installed on this computer. Enter this command to see if a separate copy of DB2 or a DB2 client is installed:
    • db2ls
    The results show whether DB2 is installed and the level of that installation. If there are no results, DB2 is not installed outside of RICOH ProcessDirector. If DB2 is installed, take one of the following actions to use either the installed copy or the RICOH ProcessDirector version.
    • If DB2 11.5.8 or higher is installed, continue installing RICOH ProcessDirector.
    • If there is a DB2 version lower than 11.5.8, update to DB2 version 11.5.8 or higher.
  6. Disable your antivirus software. Antivirus software sometimes quarantines files that databases use, causing operation errors. If you are using RICOH ProcessDirector with a PostgreSQL database, make sure to exclude the folder from the virus scans.
  7. If your IT department does not let you disable antivirus software, set up exceptions within your antivirus software for these paths:
    • /aiw/aiw1/db2
    • /aiw/aiw1/db2_logs
    • /home/aiwinst/sqllib
    • /opt/infoprint/ippd/db
    • /var/psf
    • /var/lib/docker
  8. Disable Security Enhanced Linux (SELinux). Installation errors occur on Linux systems when you run the RICOH ProcessDirector installation program with SELinux enabled. To verify the SELinux mode and disable it:
    1. Open a command line and type this command to view the current SELinux mode: getenforce
    2. If the result of the command is Enforcing, disable SELinux. Open /etc/selinux/config in a text editor and find the SELINUX line. Change that line to:
      SELINUX=disabled

      Save and close the file.

    3. Run the getenforce command again to make sure SELinux is disabled.

1.1.5.3 Downloading installation files

If you do not have installation discs, use this procedure to download ISO images of them.
To download installation files:
  1. In a web browser, open this page: https://dl.ricohsoftware.com/
  2. Click Software Downloads, enter your Entitlement ID, and click Submit.
  3. Under Product Downloads in this EID, click the title of the base product that you want to download.
    Note: For information about using ISO files to install software, click Working with ISO files on the right side of the Web page.
  4. After each file downloads, validate its MD5 checksum to the value shown on the Web page. Use this command, substituting the name of the file for ProductUpdate.iso:
    • md5sum ProductUpdate.iso

    If the checksum does not match, download the file again.

  5. If you need to install a Ricoh Transform feature, click the feature and save its ISO file to your computer.
  6. Optional: Burn the base product ISO file onto a blank dual-layer DVD. Burn the ISO file for each separately downloaded feature onto its own blank CD or DVD. If you have software that allows you to mount an ISO file, you do not have to burn the images to physical media.
You are now ready to use the installation program to install RICOH ProcessDirector.

1.1.5.4 Mounting an ISO file

You can use a virtual drive to mount an ISO file to install RICOH ProcessDirector.
To mount an ISO file:
  1. Create the ISO mounting point. For example, mkdir /isomount.
      Note:
    • The mounting point for the ISO file does not need to be created off the root directory. It can be created anywhere on the system.
  2. Transfer the ISO file to the computer. For example, place the file in the directory /tmp/RPD.iso.
  3. Mount the ISO file using this command: mount -o loop /<location of ISO>/<mounting point>
    For example: mount -o loop /tmp/RPD.iso /isomount

1.1.5.5 Installing from a remote directory

You can use a remote directory to install RICOH ProcessDirector or a Secondary Server feature without using a DVD. You can use a DVD drive on a different computer to copy the installation programs into the remote directory on your network. The remote directory holds the installers so you can access them from the computers that you want to install RICOH ProcessDirector on. The remote directory can be located on the computer that you plan to install RICOH ProcessDirector on.
The remote directory must have enough free space to hold the installers you want to store. We recommend having at least 7 GB of space in the remote directory for each installer. If you have installers for two operating systems in the same staging area, we recommend having at least 14 GB of space in the remote directory.

All the computers that you use in this procedure must be UNIX-based systems. In addition:

  • You cannot store the installers in a remote directory on a Windows computer and then install RICOH ProcessDirector on a Linux computer.
  • If the DVD drive is on a third computer that is mounted to the remote directory, that computer must also be a UNIX-based computer.

To install from a remote directory:
  1. If you plan to copy the installation programs from a DVD drive on the same computer as the remote directory, continue with the next step. If you plan to copy the installation programs from a DVD drive that is not on the computer that holds the remote directory, mount the remote directory to the computer with the DVD drive .
  2. Copy the installers to the remote directory:
    1. Log in to the computer that you want to create the remote directory on and open a command prompt.
    2. Create a directory that the files can be copied to, such as /installers. Configure the directory so other computers can mount it. This is the remote directory.
    3. Insert the base product DVD in the drive.
        Note:
      • If you are using a Red Hat, CentOS, or Rocky Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:

        mount -t iso9660 -o remount, exec <mount_point>

        You must remount the drive for every CD or DVD that you insert.

    4. Go to the media mount point to view the contents.
      You should see a file named mk_remote.
    5. Type this command to run the script:
      • ./mk_remote -d <directory>
      Substitute the path to the remote directory that you created above for <directory>.
    6. When the script finishes, type cd / and eject the CD or DVD.
    7. When you finish moving all the installers, you can go to the remote directory to verify that the installers have been copied correctly.
  3. Access the installers from the computer that you want to install RICOH ProcessDirector on:
    1. Log in to the computer that the software will be installed on.
      Note: You must install the base product before you install any Secondary Server features. A Secondary Server feature cannot be installed on the same computer as the base product.
    2. Create a directory to mount to the remote directory. We recommend that you give the directory the same name as the remote directory.
    3. Mount the directory you just created to the remote directory.
    4. Go to the mounted directory.
      You see several files and directories, including a script named setup.
  4. Run the setup script in the mounted directory to start the installer.
    • To install the base product, type: ./setup
    • To install a Secondary Server Feature, type: ./setup IPPDs

      The base product must be installed on the primary computer already.

  5. When the installer starts:
    • For the base product, continue by following the instructions that appear in the installer as described in section Installing the base product.
    • For the Secondary Server feature, continue by following the instructions that appear in the installer as described in section Installing on Linux systems.
      Note:
    • If the computer's operating system is a supported Red Hat-derived operating system and its language is Japanese, Simplified Chinese, or Traditional Chinese, choose English on the dropdown language menu. Japanese, Simplified Chinese, and Traditional Chinese characters do not display properly during a Red Hat installation of RICOH ProcessDirector.

1.1.5.6 Installing the base product

Before you begin, make sure that you have verified all the prerequisites for your configuration as listed in Planning for installation and Preparing the primary computer for installation.

    Note:
  • On Red Hat-derived operating systems, CD and DVD drives are configured to mount automatically. However, drives that are automatically mounted are often set up so you cannot run programs from the media, including installation programs. You must unmount the drive and mount it again before you can start the installation program. You must remount the drive for every CD or DVD that you insert.
  • During the installation, the RICOH ProcessDirector license files are copied to the /opt/infoprint/ippd/base/license directory.
  • The installation instructions describe how to install with a graphical display. If you cannot run the installation program in graphical mode, use console mode to install with a text-based installation program. To start the installer in console mode, insert -console in the command after the word setup. For example, to install the base product, type:
    • ./setup -console

    To use the installer in console mode:

    • Press Enter to move to the next screen.
    • Type back to return to the previous screen.
    • Type quit to exit the installer.

To install the base product:
  1. Log in as the root user.
      Important:
    • You must log in as a user with UID 0. If you must log in as a different user, you can use sudo su - or su - to become the root user. However, do not use sudo or the su command in any other way to become the root user.
  2. Open a command line and enter this command to make sure you are in the root directory:
    • cd /
  3. Insert the base product DVD in the drive.
  4. To determine the name of the mount point, enter:
    • ls /media
    On some systems, the name of the mount point is the same as the name of the CD or DVD.
      Note:
    • If you are using a Red Hat, CentOS, or Rocky Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:

      mount -t iso9660 -o remount, exec <mount_point>

      You must remount the drive for every CD or DVD that you insert.

  5. Mount the drive, if necessary. Enter:
    • mount /media/mount_point
  6. Change directories so you can see the contents of the DVD. Enter these commands:
    • cd /media/mount_point
    • ls
    You see several scripts and directories, including a script called setup.
  7. To start the installer, enter: ./setup

    The installer starts and displays the Introduction screen. Select the appropriate language for the installer to use and then click OK.

      Note:
    • If the computer's operating system is a supported Red Hat-derived operating system and its language is Japanese, Simplified Chinese, or Traditional Chinese, choose English on the dropdown language menu. Japanese, Simplified Chinese, and Traditional Chinese characters do not display properly during a Red Hat installation of RICOH ProcessDirector.
  8. Follow the instructions in the installer.

    The installer verifies many of the prerequisites for the system. If it finds any problems, it lists them for you. You cannot proceed until you correct them. After you fix the issues, verify the prerequisites again by returning to the Prerequisite Verification window. Click Previous in the installer or type back in console mode, then continue with the installer.

      Important:
    • After you verify all the prerequisites, click Cancel to change a previous entry and begin the installation process again. Clicking the Previous button sometimes causes problems.

  9. Review and accept the license and maintenance agreements.
  10. You can choose the name that you want to use for the RICOH ProcessDirector system user or you can use the default name. This is the user that RICOH ProcessDirector runs under. The default system user is aiw1.
      Note:
    • All Linux operating system user IDs and group names must be 1-8 characters because of a restriction in DB2. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.

    Enter a name for the user. If the installer finds that the user already exists on the system, it asks if you want to use that user. If you did not create the user, choose No and enter a different name. If the installer does not find the user on the system, the installer creates it.

  11. Enter the security group to use as the primary group for the system user, the UID and GID numbers for the user and group, and the home directory for the system user. The default values are shown in the installer, but you can change them.
    If you created the user and group before you started the installer, you are not asked for these values.
  12. Choose a password for the system user and enter it twice. Remember this password; you need it later when you have to log in as the system user. If you created the user before you started the installer, you are not asked for the password.
  13. Choose the language that you want the system user to use. This language determines the language used for some messages, even if you set the browser for the user interface to a different language.
  14. Choose the database that you want to use with RICOH ProcessDirector.
    If you are upgrading an existing system, you can continue to use IBM DB2 and skip to step 19 or choose to install PostgreSQL. If you install PostgreSQL, you must migrate your data after the installation finishes.
  15. If you select to install RICOH ProcessDirector with PostgreSQL, continue to step 19.
  16. If you choose to use IBM DB2, select one of these options:
    • IBM DB2 included with RICOH ProcessDirector
    • IBM DB2 installed on this server
    • IBM DB2 installed on a different server
  17. If you choose IBM DB2 included with RICOH ProcessDirector:
    1. Click Next.
    2. In the next window, click Choose to select the installation media location.
    3. In the Select a folder dialog, select the folder or mount point for the DB2 installation media and click Select.
    4. Click Next to continue with the installation.
    If the path was incorrect or the DB2 installer was not located, click Previous to go back or Next or Cancel to exit the installation.
  18. If you choose DB2 installed on a different server, the next window shows any DB2 clients that are installed on the system. Choose the one that you want to use.
    1. Enter values for the users and groups that DB2 requires, along with any other instance information requested.
      The users and groups vary based on the DB2 configuration that you use:
      • The RICOH ProcessDirector version of DB2 requires an instance user, a fenced user, and their corresponding groups.
      • A separate copy of DB2 installed on the same computer as the base product requires an instance user, a fenced user, and their corresponding groups.
      • A separate copy of DB2 installed on a different computer requires an instance user and group for the DB2 client on the primary computer, and an instance user, a fenced user, and their corresponding groups for the DB2 server on the other computer.

        You created these users and groups when you installed and configured the DB2 client and server in Installing and configuring your own copy of DB2 on a different computer.

        Note:
      • All Linux operating system user IDs and group names must be 1-8 characters because of a restriction in DB2. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.

      If you created the users and groups before you started the installer, make sure you use the correct values.

  19. Review the pre-installation summary and click Install to start installing.
  20. Click Done to complete the installation.
  21. On the command line, type this command to return to the root directory:
    • cd /
  22. If you have installed from a DVD, eject the disc.
  23. If you see error messages, view the installation logs in the /opt/infoprint/ippd/logs/installer directory and contact Software Support.
  24. Reboot the system.
    If you're upgrading to the current version, see Upgrading on the same computer.
  25. Continue with Logging in for the first time.
      Note:
    • Your software installs in trial mode. The trial license expires after 60 days. For more information about obtaining and installing license keys, see Downloading and installing license keys.

1.1.5.7 Troubleshooting installation errors

If you have trouble installing RICOH ProcessDirector, you can find information in the installation logs.
The installer logs information in these directories:
  • opt/infoprint/ippd/logs
  • opt/infoprint/ippd/logs/installer
  • /tmp

Installation errors occur on Linux systems when you run the RICOH ProcessDirector installation program with SELinux enabled.

  • To see whether Security Enhanced Linux (SELinux) is enabled on your system, open a command prompt and type:
    • getenforce
  • If the command returns Enforcing, disable SELinux and try to install again.

Here are some possible DB2 scenarios if you have to reinstall RICOH ProcessDirector:
  • If you installed the RICOH ProcessDirector version of DB2:

    When you install RICOH ProcessDirector, the installation program creates a DB2 instance and user ID using the value you enter for the DB2 instance user. There must be no other DB2 instance or user ID with this name on the RICOH ProcessDirector system, even in a different version of DB2.

    If the installation program finds an instance using that name, it cannot create the instance. You can either delete the existing instance or choose another value for DB2 instance user. To delete an existing instance, enter this command, substituting the name you want to use for DB2 instance user:

    • /opt/IBM/db2/V11.1/instance/db2idrop DB2 instance user
      Note:
    • The path name might be different if you have installed a version of DB2 other than 11.1 or if DB2 is not installed in the default location.
    • When you delete a DB2 instance, you delete all data in that instance.

  • If you installed your own copy of DB2 on the primary computer:

    If you have to reinstall RICOH ProcessDirector, the DB2 instance that the first installation created might still exist. To check, log in as the root user and enter this command:

    • /opt/IBM/db2/V11.1/instance/db2ilist
      Note:
    • The path name might be different if DB2 is not installed in the default location.

  • If you installed your own copy of DB2 on a computer other than the primary computer (a remote computer):

    If you have to reinstall RICOH ProcessDirector, the DB2 instance that the first installation created might still exist. To check, log in as the root user and enter this command:

    • /opt/IBM/db2/V11.1/instance/db2ilist
      Note:
    • The path name might be different if DB2 is not installed in the default location.

    If you find a DB2 instance with the name that you want to use, you cannot reuse it. You can either:

    • Enter a different name for the DB2 instance when you reinstall RICOH ProcessDirector.
    • Enter this command to delete the existing DB2 instance:
      • /opt/IBM/db2/V11.1/instance/db2idrop aiwinst
        Important:
      • When you delete a DB2 instance, you delete all data in that instance.

1.1.5.8 Installing a manual failover environment

A manual failover environment consists of two primary servers, one production server and one failover server, that can both access file systems installed on a shared file server. If the production server becomes unavailable, you can move processing to the failover server until the production server is available again.

Installing a manual failover environment is a complex procedure. Before you start the configuration process, consult with your system administrator. Manual failover is primarily used in enterprise environments and might not be appropriate for your setting.

This procedure assumes that you use NFS for file sharing. Based on your system requirements and workflow, you might need a different setup, such as a SAN or NAS. Determine your system requirements and use the best technology for your company. Use the following steps as a guide to set up your system.

Before you start this procedure, open the required ports in your firewall to allow communication between your file server, production server, and failover server. Also, make sure you have completed these procedures as needed:

Whether you are installing using a DVD or an ISO image, make sure that you can access the installation media from the production server, the failover server, and the file server.

To install a manual failover environment:

  1. Determine the GID for each of these system groups. See Creating system groups and users for more information about system groups. You must use the same system group names and GID values on the production and failover systems. The defaults are listed below. If you choose to use different values, record them here for future reference.
    Group Name Default GID Database configuration
    printq 1002
    • DB2
    • PostgreSQL
    aiwgrp1 32458
    • DB2
    • PostgreSQL
    docker 977 PostgreSQL
    aiwdbgrp 1000 DB2
    aiwdbfgp 1001 DB2
  2. Determine the UID values for each of these user names. You must use the same system user names and UIDs on the production and failover systems. See Creating system groups and users for more information about system users. The values are listed below.
    User name Default UID Group Membership Database configuration
    aiw1 32457 aiwgrp1
    • DB2
    • PostgreSQL
    printq
    • DB2
    • PostgreSQL
    aiwdbgrp DB2
    docker PostgreSQL
    aiwinst 1000 aiwdbgrp DB2
    aiwdbfid 1001 aiwdbfgp DB2
  3. Determine the hostnames for each of these servers.
    Server Description
    Production server The system that has the primary server installed and the system RICOH ProcessDirector runs on during normal operations.
    Failover server The system that RICOH ProcessDirector runs on as a backup, used when the normal server is unavailable.
    File server The system set up by a network administrator which hosts files such as installed code, configuration files, data files, and the database. Might be a SAN or NAS.
    Note: A DNS can be set to use a single hostname alias to redirect to either the production or failover server, depending on which system is active. With this configuration, users can access the system from a single URL.
  4. Log on to the file server as an administrator.
  5. Open a command line. Go to the directory where the installation media is located and into the scripts directory. Find failover-create-shares.sh.
    If you have custom share paths or are using a technology other than NFS, copy failover-create-shares.sh to /tmp. Edit the script to match your system configuration.
  6. Run the script.
    In a PostgreSQL configuration, type:
    ./failover-create-shares.sh postgresql
    In a DB2 configuration, type:
    ./failover-create-shares.sh db2
  7. Verify that the script created these directories on the file server:
    • /aiw/aiwdata
    • /aiw/aiwpath
    • /aiw/varaiw
    • /aiw/homeaiw1
    • /aiw/homeaiwinst (this directory is created only when using a DB2 database)
    • /aiw/homeaiwdbfid (this directory is created only when using a DB2 database)
    • /aiw/varpsf
    • /aiw/docker-volumes (this directory is created only when using a PostgreSQL database)
  8. In the directory where the installation media is located, type: scripts/failover-update_exports.sh to add these shares to NFS.
  9. Restart NFS. Type: showmount -e then cat /etc/exports to view and confirm the settings are correct on the file server.
    Make sure the added shares are correct and check the flags and permissions of each share.
  10. Log in to the production server as the root user and mount the shared directories:
    1. Open a command line. Go to the directory where the installation media is located.
    2. Run the script.
      In a PostgreSQL configuration, type:
      scripts/failover-create-mountpoints.sh postgresql
      In a DB2 configuration, type:
      scripts/failover-create-mountpoints.sh db2
    3. If the directory /usr/local/bin does not exist, type: mkdir -p /usr/local/bin and press Enter.
    4. Copy scripts/mountDrives.sh from the installation media to /usr/local/bin
    5. Using a text editor, edit mountDrives.sh. Make sure you change the file server value to the name of your file server.
    6. If you are not using NFS to share and mount the filesystems, modify the script to run the appropriate commands to mount them.
    7. To make the script executable, type: chmod +x /usr/local/bin/mountDrives.sh and press Enter.
    8. To run the script, type: /usr/local/bin/mountDrives.sh and press Enter.
    9. To confirm the shared directories are mounted, type: df and press Enter .
  11. Create users on the production server:
    1. Copy scripts/failover-user-configuration from the installation media to /tmp on the production server.
    2. Using a text editor, open failover-user-configuration. Compare the system user and system group values to the system user and system group values from Step 2. If you are using the default values, these values do not need to be changed.
    3. To run the script, go to the directory where the installation media is located and type: scripts/failover-create-users.sh /tmp/failover-user-configuration and press Enter.
    4. Type: id username for each user name to verify it was created.
      For example, if you type: id aiw1, your output might look like:

      uid=3133(aiw1) gid=1038(ipserv) groups=10(wheel),1038(ipserv),111(staff1)

  12. Install RICOH ProcessDirector on the production server. See Installing the base product.
    When prompted for system users and system groups, use the same values you used in the scripts and select the system user (aiw1 is the default). Do not reboot the system after installing RICOH ProcessDirector. The mapped drives might need to be re-mapped if the system is rebooted.
  13. Continue with Logging in for the first time. Do not do the Verifying the installation procedure. Return to this section to complete the manual failover environment installation.
  14. Completely shut down RICOH ProcessDirector on the production server:
    1. Log in to the production server as the system user (aiw1 is the default).
    2. If you run in a PostgreSQL configuration, go to the directory where the installation media is located. Type scripts/failover-docker-setup.sh and press Enter.
    3. Open a command line and type: stopaiw
    4. Type: su - root and press Enter. When prompted, enter the password for the root user and press Enter.
    5. If you run in a DB2 configuration, type: /opt/infoprint/ippd/db/bin/db2fmcu -d
    6. If you run in a DB2 configuration, type: ps -ef | grep db2 to display all db2 processes that are still running. To end each db2 process, type:
      kill followed by each of the process IDs listed in the results of the grep command. For example, your results might look similar to:
      dasusr1  14729     1  0 Aug24 ?   00:00:01 /home/dasusr1/das/
                                                  adm/db2dasrrm
      root     18266     1  0 Aug24 ?   00:15:08 /opt/infoprint/ippd/db/
                                                  bin/db2fmcd
      dasusr1  18342     1  0 Aug24 ?   00:00:23 /opt/infoprint/ippd/db/das/
                                                  bin/db2fmd -i dasusr1 -m /
                                                  opt/infoprint/ippd/db/das/
                                                  lib/libdb2dasgcf.so.1
      root     21049     1  0 Sep01 ?   00:00:00 db2wdog 0 [aiwinst] 
      aiwinst  21051 21049  0 Sep01 ?   01:13:01 db2sysc 0  
      root     21059 21049  0 Sep01 ?   00:00:00 db2ckpwd 0 
      aiwinst  21061 21049  0 Sep01 ?   00:00:00 db2vend (PD Vendor 
                                                 Process - 1) 0    

      In these results, the process IDs are listed in the second column. To end the first process in the list, type: kill 14729 and press Enter.

    7. Type: ps -ef | grep psfapid to display all psfapid processes. To end each psfapid process, type:
      kill followed by each of the process IDs listed in the results of the grep command.
    8. Type: ps -ef | grep aiw1 to display all aiw1 processes. To end each aiw1 process, type:
      kill followed by each of the process IDs listed in the results of the grep command.
  15. Log in to the failover server as the root user and mount the shared directories:
    1. Run the script.
      In a PostgreSQL configuration, type:
      scripts/failover-create-mountpoints.sh postgresql
      In a DB2 configuration, type:
      scripts/failover-create-mountpoints.sh db2
    2. If the directory /usr/local/bin does not exist, type: mkdir -p /usr/local/bin and press Enter.
    3. Copy scripts/mountDrives.sh from the installation media to /usr/local/bin.
    4. Using a text editor, edit mountDrives.sh. Make sure you change the file server value to the name of your file server. If you are not using NFS, update the script to use your sharing technology.
    5. If you are not using NFS to share and mount the filesystems, modify the script to run the appropriate commands to mount them.
    6. To make the script executable, type: chmod +x /usr/local/bin/mountDrives.sh and press Enter.
    7. To run the script, type: /usr/local/bin/mountDrives.sh and press Enter.
    8. To confirm the shared directories are mounted, type: df and press Enter.
  16. Create users on the failover server:
    1. Copy scripts/failover-user-configuration from the installation media to /tmp on the failover server.
    2. Using a text editor, open failover-user-configuration. Compare the system user and system group values to the system user and system group values from Step 2. If you are using the default values, these values do not need to be changed.
    3. To run the script, go to the directory where the installation media is located, type: scripts/failover-create-users.sh /tmp/failover-user-configuration then press Enter.
    4. Type: id username for each user name to verify it was created.
      For example, if you type: id aiw1, your output might look like:

      uid=3133(aiw1) gid=1038(ipserv) groups=10(wheel),1038(ipserv),111(staff1)

  17. On the failover server:
    1. Log in as the root user.
    2. Open a command line and go to the directory where the installation media is located. Type: scripts/failover-setup-rpd-node.sh and press Enter to run the script.
      The script adds entries to /etc/services, installs PSF if necessary, and updates the rpm database on the failover server.
    3. Type: /opt/infoprint/ippd/bin/changeHostname.plproduction_server_hostname where production_server_hostname is the name of the production server.
    4. To verify the installation on the failover server, log in to the product again. This time, use the host name of the failover server in the Web browser: http://failover hostname:15080/pd If you can log in, the installation is successful.
  18. Switch processing back to the production server:
    1. Log in to the failover server as the system user (aiw1 is the default).
    2. Open a command line and type: stopaiw
    3. Log in to the production server as the root user.
    4. On the production server, type: /opt/infoprint/ippd/bin/changeHostname.plfailover_server_hostname where failover_server_hostname is the name of the failover server. The failover server is currently the primary server.
  19. Install the license keys for the production and failover servers. You must purchase two license keys, one per server.
    1. On the production server, install the license key for the production server. See Downloading and installing license keys.
    2. Open a command line and log in as the system user (aiw1 is the default) and type: stopaiw
    3. Switch processing to the failover server. On the failover server, open a command prompt as the root user and type: /opt/infoprint/ippd/bin/changeHostname.plproduction_server_hostname where production_server_hostname is the name of the production server.
    4. On the failover server, install the license key for the failover server. See Downloading and installing license keys.
      When you open the RICOH ProcessDirector user interface on the failover server, you might see the message License key violation detected. Contact Software Support. This message does not appear after the license key is installed.
    5. Open a command line and log in as the system user (aiw1 is the default) and type: stopaiw
    6. Switch processing to the production server. On the production server, open a command prompt as the root user and type: /opt/infoprint/ippd/bin/changeHostname.plfailover_server_hostname where failover_server_hostname is the name of the failover server.
Any features installed on the production server are automatically available when you switch processing to the failover server.

1.1.5.9 Troubleshooting manual failover environment installation errors

If you see errors when setting up a manual failover environment, check the following:
  • If your production server, failover server, and file server cannot communicate with each other, make sure the correct ports on your firewall are open.
  • If you notice a decrease in system or network performance after setting up a manual failover environment, your network infrastructure might not support the increase in bandwidth the manual failover environment requires. Contact your system administrator and make sure the correct file sharing technology is used. For example, instead of using NFS, it might be more efficient for your network to use a SAN. Make sure you have a dedicated network or your router or network switch is correctly configured for the increase in bandwidth.
  • If you receive any licensing errors after the install, delete the RICOH ProcessDirector license file /aiw/aiw1/config/license/license.key. Copy scripts/failover-setup-rpd-node.sh from the installation media to /tmp and run the script. When prompted, if you accept the license agreement, make sure you type yes and press Enter. If your problem persists, contact Software Support.
  • If you receive errors when trying to mount NFS, this problem might be caused by certain versions of Linux defaulting to NFS version 4. By default, NFS version 4 does not allow shared directory ownership. The system must be set up so that the production and failover servers can change the file and directory ownership of the files on the NFS shares. If you cannot modify NFS to fix this issue, modify the directory’s ownership.

    Type chown aiw1:aiwgrp1 /aiw/aiw1 to change the ownership.

    If this does not work, edit /etc/sysconfig/autofs using a text editor and change MOUNT_NFS_DEFAULT_PROTOCOL=4 to MOUNT_NFS_DEFAULT_PROTOCOL=3. For example:

    # MOUNT_NFS_DEFAULT_PROTOCOL - specify the default protocol used by
    # mount.nfs(8). Since we can't identify
    # the default automatically we need to
    # set it in our configuration. This will
    # only make a difference for replicated
    # map entries as availability probing isn't
    # used for single host map entries.
    #
    MOUNT_NFS_DEFAULT_PROTOCOL=3

    Then edit /etc/nfsmount.conf and change Defaultvers=4 to Defaultvers=3. Then change Nfsvers=4 to Nfsvers=3.

    Update the system by restarting NFS or rebooting the servers.

  • If you switch between the production server and the failover server, and one of the servers cannot start up, then there might be locks on the file system. This is typically caused by one of the servers not being shut down correctly. To determine if this is the issue:
    1. In a command prompt, type su - aiw1 -c "db2start;db2 connect to aiwdb"

      Look in the results for a message like this: SQL1391N The database is already in use by another instance of the database manager. SQLSTATE=51023

      If you see a similar message, you must release the locks on the database.

    2. Reboot the fileserver to release the locks.

1.1.6 Setting up application and secondary servers

After successfully installing the base product, you can set up application and secondary servers on other computers in your network.
Secondary servers run on Linux computers; application servers run on Windows computers. Those computers must meet the requirements listed in the section Secondary computers.
    Note:
  • If you only want to create local secondary servers on the primary computer, you do not have to complete these procedures.
Secondary servers created on other computers use the Network File System (NFS) protocol to access the /aiw file system on the primary server. Application servers can use NFS or a different protocol to access the /aiw file system. Some configuration is required on both the primary computer and the secondary computers to enable that access.

After you configure the communication protocol between the computers, you install the Secondary Server feature or the Application Server and define the server object in RICOH ProcessDirector.

1.1.6.1 Task checklist

Here are the tasks you need to complete in this chapter. Check each item as you complete the task.

Checklist for application server and secondary server tasks
  Task
  Preparing the primary computer

Before you install any application or remote secondary servers you must export the /aiw file system and create an application or secondary server object in RICOH ProcessDirector. If you plan to use NFS on an application server, you must also verify that an NFS server is installed and started on the primary computer. If you plan to use Samba on an application server, you do not need to install NFS.

  Installing on Linux systems

Use this procedure to install a secondary server.

  Preparing a Windows application server

When you install an application server on Windows, you are required to mount the /aiw file system from the primary computer so the Windows application server has write access to the /aiw file system as the system user (aiw1 is the default).

  Installing application servers on Windows computers

After you have completed the prerequisite steps, you can install an application server on a Windows system in your network.

  Configuring an application server to run as a service

Application servers can be configured to run as Windows services. Windows services can be set up to start automatically when a user logs in to the system.

1.1.6.2 Preparing the primary computer

Before you install any application or remote secondary servers you must export the /aiw file system and create an application or secondary server object in RICOH ProcessDirector. If you plan to use NFS on an application server, you must also verify that an NFS server is installed and started on the primary computer. If you plan to use Samba on an application server, you do not need to install NFS.

After you configure NFS, Samba, or your preferred protocol, use the RICOH ProcessDirector user interface to add and enable the application or secondary server.

1.1.6.2.1 Configuring the primary server to use NFS

To use NFS on an application server, you must verify that an NFS server is installed and started on the primary computer so the /aiw filesystem is accessible.
To configure the primary server to use NFS:
  1. Verify that the NFS server on the primary computer is installed and started.
    On a SLES primary computer:
    1. In YaST, click Network Services NFS Server.
    2. Verify that Start is set and then click Next. You see that /aiw is one of the available directories.
    3. Click Finish.

    On a Red Hat, CentOS, or Rocky Linux primary computer:

    1. Open a command prompt and type this command:
      • systemctl list-unit-files | grep nfs
    2. In the results, verify that the nfs-server.service and nfs-lock.service services are listed. For supported Red Hat and Rocky Linux 8.x and 9.x versions, verify that rpc-statd.service is listed. If either one is not included in the list, use Yum to install it.
      Open a command prompt and type this command, replacing service with the name of the service or services to install:
      • yum install service
    3. Start or restart the nfs-server.service and nfs-lock.service services.
      For Red Hat 7.6 through latest 7.X, type these commands:
      • systemctl restart nfs-server.service
      • systemctl restart nfslock.service
      • systemctl enable nfs-lock.service
      • systemctl enable nfs-server.service
    For supported Red Hat and Rocky Linux 8.x and 9.x versions, type these commands:
    • systemctl restart nfs-server.service
    • systemctl restart rpc-statd.service
    • systemctl enable rpc-statd.service
    • systemctl enable nfs-server.service
  2. Update the exports file so the primary computer can connect to one or more secondary or application computers:
    1. Open /etc/exports in a file editor.
    2. Add lines to create exports for the secondary or application computers. Follow this format, replacing serverN with the host names of the secondary or application computers.
      • For a Linux secondary computer, use these parameters:
        • /aiw server1(rw,no_root_squash,sync)
      • For an application server, use these parameters:
        • /aiw server1(crossmnt,rw,no_root_squash,sync,no_subtree_check)
      • For multiple application or secondary servers, include each server as an entry on the same line.

        As an alternative, type a space and a backslash (\) to continue on another line:

        /aiw server1 \
        (crossmnt,rw,no_root_squash,sync,no_subtree_check) \
        server2(crossmnt,rw,no_root_squash,sync,no_subtree_check) \
        server3 (crossmnt,rw,no_root_squash,sync,no_subtree_check)

    3. Save the file and exit the editor.
  3. Restart the NFS server so it uses the updated file.
    • On SLES, type:
      • systemctl restart nfsserver
    • On Red Hat 7.6 through 7.X and CentOS, type:
      • service nfs restart
    • On supported Red Hat and Rocky Linux 8.x and 9.x versions, type:
      • systemctl restart nfs-server.service
  4. If your network does not have a Domain Name System (DNS) server, edit /etc/hosts on the primary computer to add the host name and IP address of the computer that is prepared for the application servers or Secondary Server feature.

1.1.6.2.2 Defining application and remote secondary servers

After you configure NFS, Samba, or your preferred protocol, you must create the application or secondary server in RICOH ProcessDirector.

To define the application or secondary server:

  1. Open a Web browser and enter http://hostname:15080/pd in the address bar replacing, hostname with the host name of the primary computer.
  2. Log in to RICOH ProcessDirector.
  3. Click the Administration tab.
  4. In the left pane, click Objects Servers.
  5. On the Servers page, click Add and choose the type of server you are creating.
  6. Specify a server name and the IP address or host name for the application/secondary computer. As an option, specify a description and values for the other properties of the server.
  7. Choose an option for the In general server pool field.
    Servers in the general server pool can run any step defined in any workflow.

    For a secondary server, you can specify either Yes or No. If you want the secondary server to run only specific steps, specify No in this field and then tune each step template that you want to run on the secondary server.

    For an application server, specify No for In general server pool.

      Note:
    • If any external steps send jobs to the application server, you must tune the step template appropriately. For information about how to tune the step template, click Help from the top task bar of the RICOH ProcessDirector user interface to see the information center.
  8. Click OK.
  9. In the left pane, click Objects Servers.
  10. Select the server and then click Enable.

1.1.6.3 Installing on Linux systems

You can install the RICOH ProcessDirector Secondary Server feature on a Linux system in your network.
    Important:
  • Secondary Server features are not required to have the same level of code as the base product. However, we recommend checking and upgrading the secondary server whenever the primary server is upgraded. To determine the level of code that is installed on either computer, enter this command:
    • echo $AIW_VERSION
  • Before you begin this procedure, make sure that you followed the steps from Preparing the primary computer.

To install the Secondary Server feature on a Linux system:

  1. Log in as the root user.
      Important:
    • You must log in as a user with UID 0. If you must log in as a different user, you can use sudo su - or su - to become the root user. However, do not use sudo or the su command in any other way to become the root user.
  2. Make sure that /etc/hosts on this computer has an entry for its IP address and the fully qualified host name.
  3. Open a command line and enter this command to make sure you are in the root directory:
    • cd /
  4. Insert the RICOH ProcessDirector Secondary Server feature DVD.
  5. To determine the name of the mount point, enter:
    • ls /media
    On some systems, the name of the mount point is the same as the name of the DVD.
      Note:
    • If you are using a Red Hat Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:
      • mount -t iso9660 -o remount, exec <mount_point>
      You must remount the drive for every DVD that you insert.
  6. Mount the drive, if necessary. Enter:
    • mount /media/mount_point
  7. Change directories so you can see the contents of the DVD. Enter these commands:
    • cd /media/mount_point
    • ls
    You see several scripts and directories, including a script called setup.
  8. To start the installer, enter: ./setup
    • ./setup IPPDs

    The installer starts and displays the Introduction screen. Select the appropriate language for the installer to use and then click OK.

      Note:
    • If the computer's operating system is a supported Red Hat-derived operating system and its language is Japanese, Simplified Chinese, or Traditional Chinese, choose English on the dropdown language menu. Japanese, Simplified Chinese, and Traditional Chinese characters do not display properly during a Red Hat installation of RICOH ProcessDirector.
  9. Follow the instructions in the installer.

    The installer verifies many of the prerequisites for the system. If it finds any problems, it lists them for you. You cannot proceed until you correct them. After you fix the issues, verify the prerequisites again by returning to the Prerequisite Verification window. Click Previous in the installer or type back in console mode, then continue with the installer.

      Important:
    • After you verify all the prerequisites, click Cancel to change a previous entry and begin the installation process again. Clicking the Previous button sometimes causes problems.

  10. Review and accept the license and maintenance agreements.
  11. Type the host name or fully qualified IP address of the primary computer and verify it.
  12. Enter the name of the RICOH ProcessDirector system user that you used on the primary computer. The default system user is aiw1.
      Note:
    • All Linux operating system user IDs and group names must be 1-8 characters because of a restriction in DB2. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.

    If the installer finds that the user already exists on the system, it asks if you want to use that user. If you did not create the user, choose No and enter a different name. If the installer does not find the user on the system, the installer creates it.

    Do not select the check box for Use system update file from another computer.

  13. Enter the values that you used on the primary computer for:
    • The security group to use as the primary group for the system user
    • The UID number for the user
    • The GID number for the group
    • The home directory for the system user

    The default values are shown in the installer.

    If you created the user and group before you started the installer, you are not asked for these values.

  14. Enter the same password that you used for the system user on the primary computer twice. Remember this password; you need it later when you have to log in as the system user. If you created the user before you started the installer, you are not asked for the password.
  15. Choose the language that you want the system user to use. This language determines the language used for some messages, even if you set the browser for the user interface to a different language.
  16. Review the pre-installation summary and click Install to start installing.
    The final window displays the URL for accessing the user interface in this format, where hostname is the host name of the primary computer:
    • http://hostname:15080/pd
  17. Click Done to complete the installation.
    The secondary server starts automatically.
  18. On the command line, type this command to return to the root directory:
    • cd /
  19. If you have installed from a DVD, eject the disc.
  20. Reboot the system.
      Note:
    • If you have an automated recovery mechanism for system outages, disable it before rebooting.
  21. To verify that the secondary server is running, enter this command on the command line:
    • ps -ef | grep Instance
    You should see an instance statement such as:
    • java com.ibm.aiw.instance.SecondaryInstance hostname

    If the software is not running, view the installation logs in the /opt/infoprint/ippd/logs directory. If this does not solve the problem, contact customer support.

  22. To make sure that the secondary server is connected to the primary server, log in to the RICOH ProcessDirector user interface and click Administration Objects Servers to verify that the Connection status column contains Connected.
After your secondary server is running, you must determine how it is used and change the properties of some objects accordingly. For example:
  • What printers and input devices do you want the secondary server to manage?

    Create or modify those devices so this secondary server is listed as their Parent server.

  • What step templates can run on this secondary server?

    Tune those step templates so that they can run on this secondary server.

  • What external programs on this secondary computer can be accessed using an external step?

    Set up the external program and configure a step based on the RunExternalProgram step template so it uses that program.

1.1.6.4 Preparing a Windows application server

When you install an application server on Windows, you are required to mount the /aiw file system from the primary computer so the Windows application server has write access to the /aiw file system as the system user (aiw1 is the default).
There are various ways to mount the /aiw file system on the primary computer from the application server. You can use any method to mount the file system. The procedures below use Samba and NFS file sharing as examples.

1.1.6.4.1 Connecting to the primary computer using Samba

To use Samba file sharing, you must configure Samba on the primary computer so the /aiw filesystem is accessible to the Windows application server. The share is then mounted on the Windows application server.
To connect to the primary computer using Samba:
  1. Log on to the primary computer as root.
  2. If Samba is not installed, install it.
  3. Configure Samba using a setup tool such as Yast. While the configuration procedure is similar between operating systems, commands or tools used might differ. Configure as follows:
    1. Enter the workgroup or domain name.
    2. Set RICOH ProcessDirector as a domain controller. RICOH ProcessDirector does not need to be set as a domain controller. This setting does not affect RICOH ProcessDirector functionality.
    3. Set Samba to start on boot.
    4. Share the /aiw drive as a share named aiw.
  4. Modify the smb.conf file located in /etc/samba/ to include lines similar to these:
    [global]
       workgroup = RPDWorkgroup
       passdb backend = tdbsam
       encrypt passwords = Yes
       restrict anonymous = 2
       domain logons = No
       domain master = No  
       security = user
       wins support = No
       ntlm auth = Yes
       min protocol = SMB2
       max protocol = SMB3
       client min protocol = SMB2
       client max protocol = SMB3
    
    [aiw]
        comment = RPD share
        inherit acls = Yes
        path = /aiw
        read only = No
        write list = root aiw1
        valid users = root aiw1
        force create mode = 0664
        force directory mode = 0775
        guest ok = No
    
      Note:
    • These settings are suggestions for the contents of smb.conf; they are not necessarily the exact settings you should use. The global section likely contains additional lines. Leave the additional lines in the file. Additional sections can be commented out or deleted to prevent other parts of the system from being shared through Samba.

      This configuration file must have read and write privileges from the Windows machine as the system user (aiw1 is the default).

    • You must enable the SMBv2 and SMBv3 protocols on the Samba server to avoid any connection errors.
  5. Optional: Add the following lines to the smb.conf under the [aiw] section to increase security:
    valid users = root aiw1
    hosts allow = windowspc
      Note:
    • Replace windowspc with the name of the application server and aiw1 with the system user ID if you do not use the default.
  6. Save the smb.conf file.
  7. Restart the Samba daemon.
  8. Run the command smbpasswd -a root and enter the password for root.
  9. Run the command smbpasswd -a system_user, where system_user is the system user ID (aiw1 is the default), and enter the password for the system user.
  10. On the application server, map the /aiw filesystem from the primary computer using the Map Network Drive dialog in Windows and this address for the server:
    \\<primary_server_hostname>\aiw
    To map the network drive from a command prompt, use this command:
    • net use <drive_letter>: \\primary_server_hostname\aiw

    To give read and write permission on the mapped Samba folder, use this command:

    • setsebool -P samba_export_all_rw 1

    Replace primary_server_hostname with the hostname or IP address of the primary computer.

  11. Test the configuration by creating a file in the drive_letter:\aiw1 directory and then deleting it.
  12. Note the name of the drive for use during the installation process.
  13. Continue with Installing application servers on Windows computers.

1.1.6.4.2 Connecting to the primary computer using NFS

To use NFS file sharing, you must configure NFS on the primary computer so the /aiw filesystem is accessible to the Windows application server. The share is then mounted on the Windows application server.
To connect to the primary computer using NFS:
  1. On the application server, verify File Services are installed for the Network File System:
    1. Press Windows Key+r to open the Run dialog box and type:
      appwiz.cpl. This opens the Programs and Features window.
    2. In the Program and Features window, click Turn Windows Features on or off.
    3. Follow the instructions in the features wizard to make sure that NFS is installed.
      • For Windows Server 2019, install NFS by selecting Features → Client for NFS.
      • For Windows 10 Pro or Enterprise, install NFS by selecting Services for NFS → Client for NFS.
          Note:
        • Client for NFS is only available on Windows 10 version 1703 or later.
  2. Add registry entries to configure NFS with the UID and GID used to access files:
    1. Log in to the primary computer.
    2. In a command prompt type id <system_user> where <system_user> is your system user ID (default aiw1).
    3. Note the UID and GID numbers and convert them to hexadecimal format.
      Note: The UID is the system user ID (default aiw1) and the GID is the system group ID (default aiwgrp1). They are specified in hexadecimal values in the registry, for example, the default UID of 32457 is 0x00007ec9, and the default GID of 32458 is 0x00007eca.
    4. On the application server, create a file named nfs.reg.
      Note:

      You can create nfs.reg, anywhere on your system.

      Make sure you have file extensions showing. If you do not display file extensions, the file is created as a text file, not a registry file.
    5. Edit nfs.reg so it contains the following contents:

      Windows Registry Editor Version 5.00
      
      [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ClientForNFS\CurrentVersion\Default]
      "AnonymousGID"=dword:<GID_hex>
      "AnonymousUID"=dword:<UID_hex>

    6. Replace <GID_hex> with the GID hexadecimal number starting after the 0x. For example, if the GID hexadecimal number is 0x00007eca, replace <GID_hex> with 00007eca.
    7. Replace <UID_hex> with the UID hexadecimal number starting after the 0x. For example, if the UID hexadecimal number is 0x00007ec9, replace <UID_hex> with 00007ec9.
    8. Save nfs.reg and close the file.
    9. Double-click nfs.reg to run the registry file, which adds the UID and GID values to the registry.
      Note: Make sure that the values in the registry file exactly match the instructions. Incorrect registry modification can damage your operating system.
    10. Delete nfs.reg from your system.
    11. Restart the NFS service by typing the following commands into a command prompt:
      nfsadmin client stop
      nfsadmin client start
      If you receive error messages when stopping or starting the NFS service, restart the application server computer.
  3. On the application server, map the /aiw filesystem from the primary computer using the Map Network Drive dialog in Windows and this address for the server:
    \\<primary_server_hostname>\aiw
      Note:
    • If the connection fails, map the filesystem manually. Open a Command Prompt, and type: mount primary_server_hostname:/aiw drive_letter.
  4. Test the configuration by creating a file in the <drive_letter>:\aiw1 directory and then deleting it.
  5. Note the name of the drive for use during the installation process.
  6. Continue with Installing application servers on Windows computers.

1.1.6.5 Installing application servers on Windows computers

After you have completed the prerequisite steps, you can install an application server on a Windows system in your network.
    Important:
  • The application server code level must match the base product code level on the primary computer.
  • After you verify all the prerequisites, click Cancel to change a previous entry and begin the installation process again. Clicking the Previous button sometimes causes problems.
To install an application server on a Windows computer:
  1. Log in as an administrator.
  2. Insert the RICOH ProcessDirector base product DVD in the drive.
  3. Use Windows Explorer to view the contents of the DVD and find appserver\setupIPPDs.exe.
  4. Double-click setupIPPDs.exe to start the installer.
  5. In the installer, do these steps:
    1. Select the appropriate language and click OK. You see a welcome window for the installation program.
    2. Review the information presented in each window and click Next until you reach the Choose installation folder window. Choose a directory to install the application server in and click Next.
        Note:
      • You cannot choose a directory with international characters (such as á, É, î, ñ, ô, ß) or double-byte characters anywhere in the directory path.
    3. Enter the drive letter that you used to mount the /aiw filesystem from the primary server.
      For example, to connect to the J drive type J:
    4. Click Next.
    5. In the Preinstallation summary window, review the information and click Install.
    6. Restart the computer to complete the installation.
  6. When the system restarts, log in using the user ID that you want to run RICOH ProcessDirector under.
  7. Optional: Make sure the connection between the application server and RICOH ProcessDirector is included in the local intranet zone. This step is important so that you can gather troubleshooting information in the future.
    1. Log in to the application server as the user that the service runs under.
    2. Select Start Internet Options Security Local Intranet
    3. Click Sites.
    4. Under Add this website to the zone type the drive letter that you used to map the connection between the application server and the RICOH ProcessDirector primary server. Include a colon after the drive letter. For example, this application server has drive R: mapped to the primary server, type: R:
    5. Click Add.
    6. Click Close.
    7. Click OK in the Internet properties dialog.
  8. Start the application server. Use the Start application server link in the RICOH ProcessDirector start menu folder.
  9. To make sure that the application server is connected to the primary server, log in to the RICOH ProcessDirector user interface and click Administration Objects Servers to verify that the Connection status column contains Connected.
  10. If the application server is not connected to the primary server, see the Application server does not connect troubleshooting topic in the RICOH ProcessDirector information center. Click Help from the top task bar of the RICOH ProcessDirector user interface to see the information center.

1.1.6.6 Configuring an application server to run as a service

Application servers can be configured to run as Windows services. Windows services can be set up to start automatically when a user logs in to the system.

To configure an application server to run as a service:

  1. Make sure the application server is installed and functions correctly.
  2. Make sure the RICOH ProcessDirector is connected to the application server:
    1. Log in to RICOH ProcessDirector.
    2. Go to Administration Objects Servers and verify the application server is connected.
  3. Log in to the Windows computer that the application server is installed on.
  4. Stop the application server. Use the Stop application server link in the RICOH ProcessDirector start menu folder.
  5. Windows services do not automatically have access to mapped network drives. The mountaiwdata.bat file grants access to these mapped network drives. Edit the provided mountaiwdata.bat file to automatically mount the shared drive for the service:
    1. Go to C:\Program Files\Ricoh\ProcessDirector\bin.
    2. Make a copy of the file mountaiwdata_sample.bat and rename it to mountaiwdata.bat. If you are upgrading or reinstalling the system, already have the mountaiwdata.bat file, and want to keep your previous settings, you do not have to do this step.
    3. Open mountaiwdata.bat and include commands to mount the drive and map it to the drive letter that you have previously set up.

      For example, if you use Samba and Windows file sharing to map your drive, your BAT file contents might include commands such as:

      • net use /delete <drive_letter>:
      • net use <drive_letter>: \\<primary_host_name>\aiw /user:<primary_host_name>\aiw1 <password> /persistent:yes

      where <drive_letter> is your mapped application server drive, <primary_host_name> is the name of the server RICOH ProcessDirector is installed on, and <password> is your system password for the RICOH ProcessDirector system user ( aiw1 is the default system user).

      If you use NFS and Windows file sharing to map your drive, your BAT file contents might include commands such as:

      mount -o anon \\<primary_host_name>\aiw <drive_letter>

      where <primary_host_name> is the name of the server RICOH ProcessDirector is installed on and <drive_letter> is your mapped application server drive.

    4. Make sure that the drive is not currently mapped, then run mountaiwdata.bat. When it finishes, open Windows Explorer and make sure that the drive is mapped and connected.
  6. Install the application server service:
    1. Start a command prompt as an administrator. Even if you are logged on to your system as an administrator, you must start the command prompt by selecting Run as administrator from the right-click menu.
    2. Go to C:\Program Files\Ricoh \ProcessDirector\bin.
    3. Type aiwsvc install and press Enter. This installs the application server service.
    4. Open the Windows Services window and look for the Ricoh Process Director Application Server service to make sure the application service installed.
  7. Optional: Set the application server service to run as a local administrator user.
      Note:
    • The application server service can run as a local administrator user service or a LocalSystem service (default). If it runs as a LocalSystem service, a password is not required. If it runs as a local administrator service, Windows requires a password for the user.
    1. In the Windows Services window, right-click the Ricoh Process Director Application Server service and select Properties.
    2. In the Log On tab, select This Account and specify the user and password.
    3. Click OK.
  8. In the Windows Services control panel, right-click the Ricoh Process Director Application Server service and select Start.
  9. Verify the application server service has started. In the Windows Services control panel, the status should read Started. In RICOH ProcessDirector, go to Administration Objects Servers and verify the application server is connected and that the startup type is set to Automatic.

1.1.7 Completing post-installation tasks

After you finish installing RICOH ProcessDirector, you complete post-installation tasks.
    Note:
  • The installer creates files with the default group ownership set to the RICOH ProcessDirector group (aiwgrp1 is the default). Any user who is in the RICOH ProcessDirector group can access files that RICOH ProcessDirector creates:
    • If you have users with Linux system user IDs who need to work directly with RICOH ProcessDirector files or submit files to hot folders, you must add their user IDs to the RICOH ProcessDirector group. Be sure to use that group as an additional group for your users, not as their default group.
    • If you create another group to own directories that RICOH ProcessDirector input devices use, you must add the RICOH ProcessDirector system user (aiw1 is the default) to the new group.

1.1.7.1 Task checklist

Here are the tasks you need to complete in this chapter. Check each item as you complete the task.

Checklist for completing post-installation tasks
  Task
  Configuring to use IPv6 addresses

You can use IPv6 addresses for the primary server and some of the other IP addresses in RICOH ProcessDirector.

  Logging in for the first time

After you install, reboot the primary computer and log in to RICOH ProcessDirector using a Web browser.

  Verifying the installation

If you have finished installing RICOH ProcessDirector and want to verify the installation, use this procedure to enable the Sample printer, submit a test job to the HotFolderPDF input device, and process the job.

  Optional: Deleting temporary installer files

If a file system named /aiwtmp remains on your system after the RICOH ProcessDirector installer has finished an installation, you can delete that folder and all its contents.

  Installing features using Feature Manager

After you install the base product, you can install features using the Feature Manager.

  Downloading and installing license keys

If you have purchased RICOH ProcessDirector, RICOH ProcessDirector Subscription, or any feature, use this procedure to download license keys and install them.

  Configuring RICOH ProcessDirector

You use the user interface to complete configuration tasks for RICOH ProcessDirector, such as setting up job processing, defining input devices for job submission, defining your printer hardware to RICOH ProcessDirector, and adding users. The RICOH ProcessDirector information center describes these configuration tasks.

  Scheduling automatic maintenance

RICOH ProcessDirector provides maintenance scripts that must be run regularly on the primary computer to improve performance. By default, RICOH ProcessDirector runs these scripts every day at midnight. You can change the time or frequency, and you can run your own maintenance scripts at the same time.

  Optional: Replacing your control files with the sample files

When you install a new version of RICOH ProcessDirector, the installer automatically adds new sample control files to the /aiw/aiw1/samples directory and copies them to your control files directory, /aiw/aiw1/control_files. It does not overwrite any of your customized control files in /aiw/aiw1/control_files. You can use the copyConfigurationFiles script to install the default control files or to overwrite your customized control files.

  Optional: Copying objects from another system

To reuse objects from another RICOH ProcessDirector system, you can use the other system to export them. On this RICOH ProcessDirector system, you can import the objects rather than recreating them manually.

  Optional: Installing and configuring the pdpr script

If you are migrating from InfoPrint Manager and you use the pdpr command to submit jobs, you can install the RICOH ProcessDirector pdpr script on the computers that submit jobs and use the same command to send jobs to RICOH ProcessDirector.

  Optional: Setting up to use LDAP authentication

If you have an existing LDAP or Active Directory server, you can use LDAP or Active Directory user names and passwords to authenticate into RICOH ProcessDirector.

1.1.7.2 Configuring to use IPv6 addresses

You can use IPv6 addresses for the primary server and some of the other IP addresses in RICOH ProcessDirector.
To configure to use IPv6 addresses:
  1. Log in to the primary computer as aiw1.
  2. Open /aiw/aiw1/config/jvmsettings.cfg in a text editor.
  3. Find all lines that contain preferIPv4Stack=true.
  4. Change true to false:
    preferIPv4Stack=false
  5. Save the file.
  6. Run the command: startaiw

1.1.7.3 Logging in for the first time

After you install, reboot the primary computer and log in to RICOH ProcessDirector using a Web browser.
When the installation process finishes:
  1. Start a Web browser.
  2. Enter this URL replacing hostname with the host name of the primary computer: http://hostname:15080/pd
  3. On the login page, type the default administrator user ID aiw and the default password aiw and then click Log in. You are prompted to change the password before you can log in to the user interface. Make note of your new password on the Installation planning checklist.
  4. If the browser page is blank after a full minute, so you do not see the RICOH ProcessDirector login page, first try to refresh the browser. If you still do not see the login page, you might need to stop and restart the base product.
    1. Log in to the primary computer as the RICOH ProcessDirector system user, using the user and password you entered in the installer (aiw1 is the default).
        Note:
      • The installer sets up the RICOH ProcessDirector system user with environment variables and paths that permit all of the administrative functions for RICOH ProcessDirector. If you use the su command to switch from another login to the system user, use the - (minus) flag (su - username) to make sure that you inherit the environment that was set up for the system user.
    2. Enter stopaiw at the command prompt and wait for all the components to stop.
    3. Enter startaiw at the command prompt.
    4. To verify that RICOH ProcessDirector is running, enter this command on the command line:
      • ps -ef | grep Instance
      You should see a statement that includes PrimaryInstance, such as:
      • aiw1 6593 1 0 Mar23 pts/3 00:00:05 java -Xmx2048m
      • -Djava.net.preferIPv4Stack=true
      • -Djava.awt.headless=true com.ricoh.aiw.primary.PrimaryInstance

      If there is a secondary server, you should also see a process that includes SecondaryInstance.

    5. Enter this URL in the Web browser, replacing hostname with the host name of the primary computer:
      • http://hostname:15080/pd
    6. If you still see a blank page, view the installation logs in the /opt/infoprint/ippd/logs directory.
  5. If you see a message that the browser cannot connect to the primary server:
    1. Log in to the primary computer as the RICOH ProcessDirector system user, using the user and password you entered in the installer (aiw1 is the default).
        Note:
      • The installer sets up the RICOH ProcessDirector system user with environment variables and paths that permit all of the administrative functions for RICOH ProcessDirector. If you use the su command to switch from another login to the system user, use the - (minus) flag (su - username) to make sure that you inherit the environment that was set up for the system user.
    2. Enter startaiw at the command prompt.
    3. To verify that RICOH ProcessDirector is running, enter this command on the command line:
      • ps -ef | grep Instance
      You should see a statement that includes PrimaryInstance, such as:
      • aiw1 6593 1 0 Mar23 pts/3 00:00:05 java -Xmx2048m
      • -Djava.net.preferIPv4Stack=true
      • -Djava.awt.headless=true com.ricoh.aiw.primary.PrimaryInstance

      If there is a secondary server, you should also see a process that includes SecondaryInstance.

    4. Enter this URL in the Web browser, replacing hostname with the host name of the primary computer:
      • http://hostname:15080/pd
    5. If you still see the message, view the installation logs in the /opt/infoprint/ippd/logs directory.
RICOH ProcessDirector is now open and the base product is running. See Verifying the installation to verify the installation by printing a test job.

1.1.7.4 Verifying the installation

If you have finished installing RICOH ProcessDirector and want to verify the installation, use this procedure to enable the Sample printer, submit a test job to the HotFolderPDF input device, and process the job.
This verification procedure only applies to new installations. When you upgrade an existing installation, RICOH ProcessDirector does not create a Sample printer.
To verify the installation:
  1. If you are not logged in to the RICOH ProcessDirector user interface, log in.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. On the command line, enter this command to copy a test file into the hot folder that the HotFolderPDF input device monitors:
    • cp /aiw/aiw1/testfiles/Demo.pdf /aiw/aiw1/System/hf/defaultPDF
  4. Wait a few seconds for the RICOH ProcessDirector user interface to refresh. If it does not refresh automatically, refresh your browser.You should see a job in the Jobs table on the Main page. The job's Phase should be Complete, and its State should be Retained.
    If you do not see a job, see the Job not appearing in Jobs table troubleshooting topic in the RICOH ProcessDirector information center. Click Help () from the top task bar of the RICOH ProcessDirector user interface to see the information center.
  5. Right-click the job and select View Log. The log should show that the job printed. For example, if the job ID is 10000000, the log should show message AIWI0016I: 10000000 printed. The job does not print on a real printer.
    This verifies that RICOH ProcessDirector is installed correctly.
The PDF workflow processes jobs that are submitted to the HotFolderPDF input device. During the Prepare phase, the workflow runs a RunExternalProgram step. This step is an example of how you can integrate other programs into your workflow. The step produces a CSV file with information about the job. To see the type of information that you can access with a step in a workflow, look at the output in the CSV file. The file is in the /aiw/aiw1/samples directory. The file name is the job ID followed by info.csv. For example, 10000000.info.csv.

    Note:
  • Your software installs in trial mode. The trial license expires after 60 days. For more information about obtaining and installing license keys, see Downloading and installing license keys.

1.1.7.5 Deleting temporary installer files

If a file system named /aiwtmp remains on your system after the RICOH ProcessDirector installer has finished an installation, you can delete that folder and all its contents.

If the installer creates the /aiwtmp directory, it also deletes it. However, if you create /aiwtmp before starting the installer, the installer does not remove this file system. If any errors occur during the installation, files might be left in this file system, which can now be removed.

To delete the temporary installer files:

  1. Log in to the primary computer as root.
  2. Open a command line and enter these commands to find the root directory and see its contents:
    • cd /
    • ls
  3. If you see the /aiwtmp file system, delete it and all its contents.

1.1.7.6 Installing features

After you install RICOH ProcessDirector or RICOH ProcessDirector Subscription, you can add features at any time.
You install most features using the Feature Manager, available on the Administration tab.

The RICOH Transform features cannot be installed using the Feature Manager. See Installing RICOH Transform features for instructions.

    Important:
  • All features are installed in trial mode. To continue using a feature after the trial period, you purchase the feature and install a license key for it. See Downloading and installing license keys for more information.

    To see whether a feature is running in trial mode and how many days remain for each feature in trial mode, go to the Licenses page of the Administration tab and look at the License state column.

  • The maintenance license for RICOH ProcessDirector includes maintenance for features. They do not have separate maintenance licenses.
  • Licenses for the RICOH ProcessDirector Subscription base product and its features expire when the base product subscription period is over.
  • If you intend to install the AFP Support feature, we recommend that you install it before or at the same time as your other features. If you install features that process documents (such as Archive) before you install AFP Support, RICOH ProcessDirector does not install the AFP versions of sample workflows supplied with those features.
  • The PDF Document Support feature has a two-part installation process. You install the RICOH ProcessDirector components on the primary computer using the Feature Manager. You install RICOH ProcessDirector Plug-in for Adobe Acrobat on a computer with Adobe Acrobat Pro installed.
  • When you install RICOH ProcessDirector, some configuration files in /aiw/aiw1/control_files/external programs are used by both the RICOH Transform and the Advanced Transform features. However, the Advanced Transform features supply a different sample version of the xform.cfg. That sample file includes parameters that are only used by the Advanced Transform features.

    After you install the Advanced Transforms, you must make those parameters available. Find the xform.cfg installed by the Advanced Transform features in /aiw/aiw1/samples/control_files/external programs . Compare it to the one installed by the base product in /aiw/aiw1/control_files/external programs . Manually merge any changes from the sample file into the base product file.

    If you are upgrading to a newer version, update the xform.cfg file as well as the profiles installed in /aiw/aiw1/cpt/profiles , such as mffafp.pro.

1.1.7.6.1 Installing features using Feature Manager

After you install the base product, you can install features using the Feature Manager.
    Note:
  • If you have any RICOH Transform features installed, you must shut down the Transform Features application before you install any feature with Feature Manager. Restart the Transform Features application after the feature installation completes.
To install one or more features using Feature Manager:
  1. If one or more secondary servers are defined and started, stop all of the secondary servers. See Stopping the base product and secondary servers.
  2. Log in as a user authorized to use Feature Manager.
  3. Click the Administration tab.
  4. In the left pane, choose Utilities Features.
    Some browsers might prevent opening the Feature Manager in a new tab due to the pop-up blockers. Verify your settings and allow Feature Manager to open in a new browser tab.
    If you see an error message, you must start Feature Manager manually:
    1. Log in to the primary server as the RICOH ProcessDirector system user (aiw1 is the default).
    2. Open a command prompt and type: startaiw -f
    3. Refresh the Feature Manager web page.
  5. If the feature that you want to install is not listed, you must import it. See Adding or upgrading a feature using Import Package for details about importing the feature package.
  6. If the feature that you want to install is in the list, select the check box next to it.
  7. In the Available versions column for each feature, select the version of the feature you want to install.
  8. Click Install.
  9. Review the information in the confirmation window, specify a name for the Installation display name, then click OK to continue.
    The features are installed, then RICOH ProcessDirector restarts to finish the install process.
    Note: If one or more features fail to install, choose one of these options:
    • Click Try again to retry the installation. If the install fails a second time, click Restore this Installation to return to a stable state.
    • Click Restore this Installation to revert the system to the state it was in before this installation.

    If you cannot install a particular feature or restore an installation, contact Ricoh Software Support.

  10. Click DISMISS. The dialog closes and you see the login page.
  11. To complete the installation process, clear your browser cache.
    Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.
  12. Log in again.
  13. Restart any secondary servers that you stopped in step 1. See Starting the base product and secondary servers.

1.1.7.6.2 Adding or upgrading a feature using Import Package

You can use Feature Manager to add a new feature or upgrade an existing feature by downloading a feature package file, either from the Ricoh website or from a feature DVD, and then using the Import Package action.
You must save the feature package file to a location that can be accessed by using the primary computer.

If you download the feature package file from the Ricoh website, save it to a location that is accessible from RICOH ProcessDirector. This location can be on the primary computer, a workstation, or a network drive. Remember where you save the file so that you can browse to it from RICOH ProcessDirector. Additionally, you must extract the file in that location so the EPK file within the downloaded file can be seen.

If you receive the feature package file from a DVD, you need to locate the file on the DVD, copy it from the DVD onto the primary computer, and remember where you put it so you can browse to it.

To import a feature package using Import Package:
  1. If one or more secondary servers are defined and started, stop all of the secondary servers. See Stopping the base product and secondary servers.
  2. Log in as an administrator or other user with authority to import packages.
  3. In the left pane, choose Utilities Features.
    If you see an error message, you must start Feature Manger manually:
    1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
    2. Open a command prompt and type: startaiw -f
    3. To complete the process, clear your browser cache.
      Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.
    4. Reload the Feature Manager web page.
    The Feature Manager page opens in a new browser tab.
  4. Click Import Package.
  5. In the Package to import field click Image of folder..
  6. Select the feature package EPK file for the feature you want to install and click Open.
    The import automatically begins.
  7. When the import finishes, the feature you installed or upgraded appears in the main Feature Manager window.
    The feature appears in the Feature Manager table selected.
  8. In the Available Versions column, use the list to select the version of the feature you want to install.
  9. Click Install.
  10. Review the information in the confirmation window, then click OK to continue.
    The feature is installed, then RICOH ProcessDirector is restarted to finish the install process.
  11. Click DISMISS to close the Feature Manager browser tab.
  12. To complete the process, clear your browser cache.
    Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.
  13. Log in again.

1.1.7.6.3 Installing RICOH Transform features

Before you install any RICOH Transform features:
  • Make sure that your computer meets the additional hardware and software requirements specified.See Primary computer and Data transforms for those requirements. You can install one or more RICOH Transform features on the primary server or on another computer on your network.
  • Make sure that Security Enabled Linux (SELinux) is not blocking any processes residing in any of the subdirectories of /opt/infoprint/itm.
  • The AFP Support feature must be installed on the primary server even if the Transform feature is installed on a computer other than the primary server.
  • The RICOH Transform features are installed in trial mode. To continue using the RICOH Transform features after the trial period, you must purchase each transform that you want to use and a license key for it.

You can either:

  • Do the steps in this section to install RICOH Transform features using their DVDs.
  • Use Installing from a remote directory to copy the RICOH Transform features installers to a staging location on your network, then mount the computer that you want to install features on to that location and run the installers.

    Note:
  • This task does not apply to the Advanced Transform feature. If you are installing the Advanced Transform feature, use the instructions for installing features using Feature Manager.
To install a RICOH Transform features:
  1. Stop the base product. See Stopping the base product and secondary servers.
  2. Log in as the root user.
      Important:
    • You must log in as a user with UID 0. Do not use sudo or the su command to become the root user.
  3. Insert the appropriate RICOH Transform features DVD.
      Note:
    • If you are using a Red Hat, CentOS, or Rocky Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:

      mount -t iso9660 -o remount, exec <mount_point>

      You must remount the drive for every CD or DVD that you insert.

    The media mount point is /media/cdrom.

  4. To determine the name of the media mount point, enter:
    • ls /media
    On some systems where the media is mounted automatically, the name of the mount point is the same as the name of the CD or DVD.
  5. On a SLES system, enter this command to mount the DVD drive:
    • mount /media/cdrom
  6. Enter this command to start the installation program:
    • /media/cdrom/setup
  7. Select the appropriate language for the installer to use and click OK.
  8. Reply to any prompts in the installer.
    When the installer asks you to choose a directory to install the transform in, you can choose a directory on any drive. However, you cannot choose a directory with international characters (such as á, É, î, ñ, ô, ß) or double-byte characters anywhere in the directory path.

    The installation program analyzes the system. If it reports any errors, follow the instructions to correct them.

    If the installation program finds an older version of the RICOH Transform features, you must uninstall it. All custom configurations or resources associated with the older version are also deleted.

    If this is the first RICOH Transform features installed, the program detects that the Transform Feature Base is not installed. Click Next to install it.

    The installation program checks for missing dependencies.After you install all of the

  9. Review the information in the Pre-Installation Summary window and click Install.
    When the installation program completes, it shows a summary, including information about accessing the user interface with a Web browser. The default password is nopassword.
  10. When the installer completes, click Done.
  11. Unmount and eject the DVD.
  12. If you have another RICOH Transform features to install, repeat this procedure beginning with the step to insert the appropriate RICOH Transform features DVD, described above. Make sure you install all the Transform features before you install the license key.
      Note:
    • When upgrading a transform feature, make sure that all transform features are at the same version. If the transform features are not at the same version, the transform feature you did not upgrade stops working.
    • When installing a new version of Transform Features over a previous version, make sure to uninstall first the previous version of Transform Features. Uninstalling Transform Features deletes the files stored in your installation folders.
      Important:
    • To install a language pack, enter this command: /media/cdrom/linux/features/install_tf_rpd_language_pack.sh

1.1.7.6.3.1 Logging into the Transform Features user interface

This section describes how to log into the Transform Features user interface.
To log in:
  1. Open a Web browser and enter this address:
    • http://target server host name or ip address:port determined at install/itm
    The default port number is 16080.
    For example, if a Transform Feature is installed on a host with TCP/IP address 127.0.0.1 with the default port, the address is: http://127.0.0.1:16080/itm.
  2. In the browser window, you see the Log in to the Transform Feature user interface page. Type the Transform Features password.
    The default password is nopassword.
  3. Click Log in.
    You see the Transform Features user interface main page.
      Note:
    • If you do not use the Transform Features user interface for 30 minutes or more, you must log in again.

    When you first log in to the Transform Features user interface, you see one transform server that has been added by default during the installation.

1.1.7.7 Downloading and installing license keys

If you have purchased RICOH ProcessDirector, RICOH ProcessDirector Subscription, or any feature, use this procedure to download license keys and install them.
Before you begin this procedure:
  • Install the product or feature in trial mode.
  • If you have not already purchased the software, contact your local Ricoh support representative or sales representative.

    After you purchase the software, Ricoh Production Print sends an email to the email address provided when the order was placed with the Entitlement Management System (EMS) - Entitlement Certificate in the subject line. This email contains an Entitlement ID (EID).

  • Follow all the steps in this procedure each time that you receive an email with an Entitlement ID for RICOH ProcessDirector components that you have purchased.

    You will receive a new Entitlement ID when you renew the subscription for RICOH ProcessDirector Subscription.

  • License keys are specific to the release of RICOH ProcessDirector or RICOH ProcessDirector Subscription that you have installed. Be sure that the version on the About dialog matches the information in the email.
  • This procedure for downloading and installing license keys does not apply to the Transform Features. See Installing the Transform Feature license keys for more information.
To download and install license keys:
  1. Open RICOH ProcessDirector.
  2. Click the (information icon) button at the right of the banner and select About.
  3. Click INSTALL LICENSES.
  4. Click the link to open the license activation website.
  5. On the Software Activation page, enter your EID and system fingerprnt.
    • Find the EID in the Ricoh-Entitlements email and type or paste it into the EID field.
    • Copy the system fingerprint from the Install Licenses dialog.
  6. Click Confirm Content.
  7. Select the license you want to activate and click Activate.
  8. After the license is activated, click Download License Key.
    The license key file is downloaded to your computer.
  9. Return to the Install Licenses dialog.
  10. In the Install licenses dialog, click and select the license file you want to install.
  11. Click Done.
  12. Restart RICOH ProcessDirector to complete the installation. See Starting the base product and secondary servers.
      Important:
    • If the trial period or subscription expires before you restart RICOH ProcessDirector, RICOH ProcessDirector shuts down.
The license keys for all purchased features are now installed on the primary computer. Any feature without a license key remains in trial mode until its trial period ends. If you purchase an additional feature, renew your subscription, or renew your maintenance on the product, repeat this process to install the new key.

When the trial period ends, the steps and objects that are supplied with the feature stop working, but remain on the system. Installing a license key after you purchase the feature activates the steps and objects without requiring a reinstall.

When a subscription expires, all of your objects remain in the system, but you cannot log in. Contact Ricoh software support for assistance with installing a new license on a system with an expired subscription.

1.1.7.8 Installing the Transform Feature license keys

You can install a Transform Feature license key on a computer other than the primary computer using an installation program from the Transform Features directory.
To install a Transform Feature license key:
  1. Log in as an administrator or root user to the computer that the Transform Feature is installed on.
  2. Get the fingerprint for the computer.
    1. Open a command prompt.
    2. For Linux, navigate to the /opt/infoprint/itm/license_installer directory, and type:
      • ./GetFingerprint.sh
    3. For Windows, navigate to the drive:\Program Files\InfoPrint\InfoPrint Transform Features\license_installer directory, and type:
      • GetFingerprint.cmd
    The output of the command looks like this:

    • *1AW QLQ7 BQDZ RLRZ

      Note:
    • This fingerprint is required to generate the license key. Save the fingerprint for later.

  3. Get the license file.
    1. When you purchased the Transform Feature, Ricoh Production Print sent an email to the email address provided when the order was placed with the Entitlement Management System (EMS) - Entitlement Certificate in the subject line. This email contains an Entitlement ID (EID) and a link to the Entitlement Management System website.
    2. Open the Entitlement Management System website in your browser.
    3. In the Login Using list, select EID.
    4. Find the EID in the email and type or paste it into the EID field.
    5. Click Login.
    6. Select the license you want to activate and click Activate.
    7. In the Activate Product(s) window, enter the system fingerprint and click Generate.
        Note:
      • If you see an error message that the license could not be generated because checksum validation failed, you entered an incorrect system fingerprint.
    8. Select what you want to do with the license file:
      • Select Save to File to save the license file to your computer.
          Note:
        • Note the hostname and the fingerprint (without the *) when saving the license file.This is valuable information to have when recovering from a hard drive failure.
      • To add the license keys to an existing license file, select Append To File.
      • To email yourself a copy of the license file, select E-mail.
          Note:
        • Check the email address in the Contact field. If a copy of the email (including the license key file) should be sent to a different email address, click E-mail. Type the email address and click Send.
    9. Log out from the EMS website.
    10. If you received the license key file in an email, transfer it to the computer that the Transform Feature is installed on or a network location that is accessible to that computer.
  4. Install the license key.
    • For Linux:
      1. Open a command prompt.
      2. Navigate to the /opt/infoprint/itm/license_installer directory, and type ./install_license_keys.sh.
    • For Windows:
      1. In Windows Explorer, navigate to the drive:\Program Files\InfoPrint\InfoPrint Transform Features\license_installer directory.
      2. Double-click license_keys_installer.exe to run the license key installation program.

1.1.7.9 Configuring RICOH ProcessDirector

You use the user interface to complete configuration tasks for RICOH ProcessDirector, such as setting up job processing, defining input devices for job submission, defining your printer hardware to RICOH ProcessDirector, and adding users. The RICOH ProcessDirector information center describes these configuration tasks.

To access the RICOH ProcessDirector information center to learn about configuration tasks:
  1. Enter http://hostname:15080/pd from the Web browser on a workstation. The host name of the primary computer is hostname.
  2. Click Help from the top task bar. You see the RICOH ProcessDirector information center.
  3. From Contents in the left pane, click Configuring. You see a list of configuration tasks in the right pane.
  4. Select the configuration tasks that apply to your installation.

1.1.7.10 Scheduling automatic maintenance

RICOH ProcessDirector provides maintenance scripts that must be run regularly on the primary computer to improve performance. By default, RICOH ProcessDirector runs these scripts every day at midnight. You can change the time or frequency, and you can run your own maintenance scripts at the same time.

While these scripts are running, they might slow RICOH ProcessDirector down for a few minutes. Therefore, you should avoid running them at peak production times.

These entries in the crontab file run the maintenance scripts:

00 00 * * 0-6 /aiw/aiw1/maintenance/maintenance.pl daily
00 00 * * 0 /aiw/aiw1/maintenance/maintenance.pl weekly

crontab entries are in this format:

mm hh dd month weekday command
The first entry runs all scripts in the /aiw/aiw1/maintenance/daily directory at 00:00 (midnight) every day from Sunday (0) through Saturday (6). The second entry runs all scripts in the /aiw/aiw1/maintenance/weekly directory at 00:00 (midnight) every Sunday. (By default, there are no scripts in /aiw/aiw1/maintenance/weekly.)

  • To run the maintenance scripts weekly instead of daily, move them to the /aiw/aiw1/maintenance/weekly directory.
  • To change the time, day, or frequency for running maintenance scripts, edit the crontab file.
    1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
    2. Enter this command:
      • crontab -e
    3. Make any necessary changes.
      For example, this entry runs all scripts in the /aiw/aiw1/maintenance/daily directory at 10:30 PM every Monday, Wednesday, and Friday:
      30 22 * * 1,3,5  /aiw/aiw1/maintenance/maintenance.pl daily
  • To run your own scripts at the same time as the RICOH ProcessDirector maintenance scripts, copy them into the /aiw/aiw1/maintenance/daily or /aiw/aiw1/maintenance/weekly directory.
    Make sure that the RICOH ProcessDirector system user ID has execute permission for your scripts.

1.1.7.11 Tuning Java memory allocation

Allocating more memory to Java often improves the performance of RICOH ProcessDirector. However, it is imperative that you take several factors into consideration before you change this configuration.
Run with the default setting for a while before you consider changing the Java memory allocation. If you repeatedly experience Java out of memory errors, consider increasing the allocation.
Important: We recommend allocating no more than 50% of the available system memory on your system to RICOH ProcessDirector Java processes. This recommendation takes into consideration the memory needs of other parts of RICOH ProcessDirector, such as the database, transforms, custom code, and other components. The recommendation also ensures that the operating system and other tools and utilities have the resources they require to operate.

To tune Java memory allocation:

  1. Check the amount of RAM installed on your system. Divide that number by 2 and write it down.
  2. Check how much memory is allocated to other applications that run on this system.
    Reduce the number you wrote down by the amount of memory each application uses. The resulting value is the total amount of heap memory that is available for you to allocate to Java for all running RICOH ProcessDirector primary and secondary processes.
    Note: If your RICOH ProcessDirector solution requires more memory than the amount determined in this step, we recommend upgrading the system memory to meet the stated guidelines. Allocating more than 50% of available memory to the RICOH ProcessDirector Java heap negatively impacts performance.
  3. Log in to the primary computer as the system user (aiw1 is the default).
  4. Open $AIWDATA/config/jvmsettings.cfg in a text editor.
    By default, $AIWDATA is /aiw/aiw1.
  5. Find the line that looks like this:
    primary=-Xmx2048m -Djava.net.preferIPv4Stack=true -Djava.awt.headless=true

    The value after primary=-Xmx is the maximum amount of heap memory the RICOH ProcessDirector Java run time environment is allowed to use for the RICOH ProcessDirector primary process. In this example, the primary server can use 2048MB (2GB) of RAM for its heap.

  6. Update the -Xmx value to the number you determined in step 2.
    For example, to allow the primary server use 8GB of heap space, you can specify -Xmx8192m or -Xmx8g
  7. Save and close the file.
  8. Restart RICOH ProcessDirector to apply the changes.

1.1.7.12 Replacing your control files with the sample files

When you install a new version of RICOH ProcessDirector, the installer automatically adds new sample control files to the /aiw/aiw1/samples directory and copies them to your control files directory, /aiw/aiw1/control_files. It does not overwrite any of your customized control files in /aiw/aiw1/control_files. You can use the copyConfigurationFiles script to install the default control files or to overwrite your customized control files.

Replacing your control files requires Perl to run. Before replacing your control files, make sure a Perl interpreter is installed.

To replace your control files with the sample files:
  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. On the command line, enter this command:
    • /opt/infoprint/ippd/bin/copyConfigurationFiles.pl

    You can add these optional parameters to the copyConfigurationFiles command:

    • [-r [-b]] [-w forceReplaceFile] [samplesDirectoryconfigurationFilesDirectory] [[-o differencesOutputFile] [-c]] [-v] [-help]
    -r
    The script overwrites existing files in the /aiw/aiw1/control_files directory.
    -b
    The script backs up each file it replaces. The backup files are called replaced_file.bak. It does not back up files unless they are being replaced by a different version of that file.
    -w forceReplaceFile
    The script overwrites a specific set of files. List the file paths to overwrite in the forceReplaceFile file.
    samplesDirectory
    The directory where the sample files are located. The default is /aiw/aiw1/samples.
    configurationFilesDirectory
    The directory where the control files are located. The default is /aiw/aiw1/control_files.
    -o differencesOutputFile
    The script writes any file names where there are different versions of a file in the samples and control_files directories. The different version file names are written to the differencesOutputFile file.
    -c
    The script compares the files in the /aiw/aiw1/samples and /aiw/aiw1/control_files directories and prints a list of which files are in both directories but have different content. Running the script with this parameter does not do the normal copying and replacing.
    -v
    The script displays additional file information while copying files.
    -help
    The script displays help and syntax information.

New versions of RICOH ProcessDirector might add new functions that require updated control files. To move your customized content from the old control files to the new control files:

  1. Generate a list of which files have new versions. Enter this command:
    • copyConfigurationFiles.pl -o /tmp/differencesOutputFile
  2. Copy the new control files. Enter this command: copyConfigurationFiles.pl -r -b -w /tmp/differencesOutputFile

    Specifying the -b option means the script backs up files before overwriting them.

  3. Copy your customized content from the replaced_file.bak backup files to the corresponding control file.

1.1.7.13 Copying objects from another system

To reuse objects from another RICOH ProcessDirector system, you can use the other system to export them. On this RICOH ProcessDirector system, you can import the objects rather than recreating them manually.
You can export and import objects such as input devices, workflows, printers, media objects, notifications, servers, step templates, user names, groups, and locations. You can also export and import some objects added by features or extensions.
    Important:
  • We recommend using the Migration Assistant when upgrading to a different computer to copy objects from one system to another. For additional information see Upgrading on a different computer with Migration Assistant .
  • Do not import objects added by a feature or extension that is not installed on this system.
  • Before you import an object that has the same name as an existing object of the same type, make sure that the existing object is disabled. If the object is an input device, also make sure that it is disconnected. When you import the new object, the existing object is updated to match the new one.
  • Before you import an input device or printer whose Parent server property has any value other than System, make sure that the parent server has been added as a secondary server. Make sure that the secondary server has been enabled and connected to the primary server.
  • If you are using the Preprinted Forms Replacement feature, export the media.zip file before you import media objects with electronic forms. Follow the instructions in the help system for exporting media objects with electronic forms.
  • When you import step resources, the files that they refer to are not included in the export package. Copy the files referenced in the step resources from the export system to the import system manually. You must copy the files to the import system before you import the step resource objects.
    • To import all the step resources, copy the contents of /aiw/aiw1/StepResources from the export system into the same directory on the import system.
    • To import specific step resources, open the XML file that you exported. Find the entry for each step resource that you exported and locate the StepResource.File property. In that value, find the name of the RSC file associated with that step resource. For example, in this value:
      • <property name="StepResource.File" value="{&quot;fileName&quot; : &quot;/aiw/aiw1/StepResources/ 1992052c6ef44a229b8b43d77232bf53.rsc1992052c6ef44a229b8b43d77232bf53.rsc&quot; , &quot,&quot;displayName&quot; : &quot;Ricoh_Export-2019-08-26_13-30-04.xml&quot;}"/>

      The file name is: 1992052c6ef44a229b8b43d77232bf53.rsc

      Find the file on the export system and copy it into the same directory on the import system.

  • You can export objects from a primary server running on one operating system and import them on a primary server running on a different operating system.

    If you export objects from Windows and import them on Linux, you need to manually update the paths for the paths or the configuration files.

To copy objects from another system:

  1. Click the Administration tab.
  2. In the left pane, click Utilities Import Objects.
  3. In the File to import field, click to select the XML file that contains the properties of exported objects.
    The default name of this file is Ricoh_Export_timestamp.xml. The administrator who exported the objects might have given the file a different name.
      Note:
    • If you exported media objects with electronic forms, the name of the file is media.xml. It is in this directory:
      • /aiw/aiw1
    The file is automatically examined, and the objects are evaluated. If there are issues with any objects in the file, you see a dialog that lists the import errors and warnings. Close the dialog and all the objects appear in the Objects to import table. Objects with errors or warnings are marked with an icon.

    Repeat this step for all the files you want to import. Objects from additional files are added to the table, so they can all be added at the same time.

  4. Review the objects in the list. Select any object marked with a warning or error symbol and click Details to see additional information about the warning or error. Follow the instructions in the description to resolve problems. You cannot import objects that are marked as errors.
  5. Select the objects that you want to import.
  6. Optional: To make sure that you do not update objects that exist, click Deselect existing objects.
  7. Click Import.
    If the Import button is disabled, one or more selected objects are marked with the error icon. Click Deselect error objects to clear the selection for those objects and click Import again. The objects without errors are imported.

    Return to the error objects to resolve the issues and try to import them again.

    Note:
  • Credential objects might be contained in the file you import if they were included as references in workflows, step templates, input devices, or transmitter objects. The imported credential objects cannot be used until you re-enter values for the User name and Password properties on the imported system.
  • If an imported workflow refers to a step that does not exist on this system, RICOH ProcessDirector replaces the step with a placeholder step named ReplacedStep. The original step name and step template name are available in the Step properties. The ReplacedStep acts like the ContinueToNextStep step template, so it simply passes the job to the next processing step without changing it.
  • Contact your local Ricoh support representative if you receive an error message for step templates not containing a reference to an extension when importing objects.

1.1.7.14 Installing and configuring the pdpr script

If you are migrating from InfoPrint Manager and you use the pdpr command to submit jobs, you can install the RICOH ProcessDirector pdpr script on the computers that submit jobs and use the same command to send jobs to RICOH ProcessDirector.
The installation package for the pdpr script is copied to the primary computer when you install the base product. You can copy the installation package and install it on computers that submit jobs running these operating systems:
  • CentOS Linux 7.9 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • Rocky Linux 8.4 through latest 8.X
  • Rocky Linux 9.0 through latest 9.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
  • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64
  • Windows 7
      Note:
    • To install the pdpr script on a different operating system, contact your Ricoh support representative.
The pdpr script requires Perl to run. Before you install the pdpr script, make sure that a Perl interpreter is installed on the client systems.

The pdpr script uses a control file named pdpr.cfg to determine whether jobs are sent to InfoPrint Manager or to RICOH ProcessDirector. You can either store the control file on the same computer that you install the pdpr script on, or you can store it in a central location and let the pdpr script access it using FTP. The pdpr script uses an anonymous login to the FTP server, so the anonymous user must have read permission for the control file.

To get the most recent pdpr script, contact your Ricoh support representative.

To install and configure the pdpr script:

  1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default), or with a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
  2. Find the pdpr installer file: /aiw/aiw1/samples/pdpr/pdpr_installer.
  3. Copy the file to a temporary directory on the computer that runs the pdpr command.
  4. Log in to a client computer:
    • On a Linux-based client, log in as the root user and open a command prompt.
    • On a Windows client, log in as a user with administrator permission and open a command prompt.
  5. Change directories to the directory that contains pdpr_installer.
  6. Type: perl pdpr_installer
    The installer interface runs in the command prompt window.
  7. When the installer asks where you want to install the program, choose a different directory than the temporary directory that the pdpr_installer was copied in to.
      Important:
    • If you install into the temporary directory, the installation fails. You get an incomplete installation that has a pdpr directory instead of the pdpr script.
  8. Respond to the questions in the installer according to these definitions:
    Hostname or IP address of RICOH ProcessDirector server
    Fully qualified hostname or IP address of the computer that the primary server is installed on.
    Full FTP path for pdpr.cfg file
    If you want to store the pdpr.cfg file in a central location, the full path to the pdpr.cfg file. The value must end with the file name pdpr.cfg.

    If you plan to store the pdpr.cfg file on the same system as the pdpr script, do not type anything; press Enter and continue with the installer.

  9. Finalize the installation process:
    • If you are installing on a Linux client, log out and log back in so the changes can take effect.
    • If you are installing on a Windows client, restart the computer so the changes can take effect.
  10. To define rules for parsing the pdpr command and submitting jobs to RICOH ProcessDirector, edit the pdpr.cfg file.
    The file must contain one line for each rule that you define. Jobs are sent to an input device based on the last rule that they match. If the job does not meet the conditions of any of the rules, it is sent to InfoPrint Manager.

    Each line of the file follows this syntax:

    • FileName | LDName,regular_expression, input_device_name, [BOTH]

    Use FileName if you want to parse the file name of the input file to determine where to send the job. Use LDName to parse the value of the -d (InfoPrint Manager logical destination) option on the pdpr command to determine where to send the job.

    For example, the file might contain these lines:

    LDName, .*\.[Pp][Ss], InputPS
    FileName, .*\.[Aa][Ff][Pp], InputAFP

    The first line instructs the script to look at the -d option on the pdpr command. If the value specified for that option ends with .ps or .PS, the job is sent to the input device named InputPS. The second line instructs the script to look at the file name of the input file. If the file name ends with .afp or .AFP, the job is sent to the input device named InputAFP.

    If neither condition is met, the job is sent to InfoPrint Manager using the value stored in the PDHOST environment variable on the system.

    Add the BOTH parameter to the end of an entry to indicate that if the condition is satisfied, the job should be sent to both InfoPrint Manager and RICOH ProcessDirector. This is useful when you are initially configuring RICOH ProcessDirector to receive jobs from pdpr because you can test the RICOH ProcessDirector configuration while continuing to use InfoPrint Manager in your production environment.

Now you can configure RICOH ProcessDirector to receive jobs submitted with the pdpr script from all the client systems. For more information, see the RICOH ProcessDirector information center in the user interface.

1.1.7.15 Setting up to use LDAP authentication

If you have an existing LDAP or Active Directory server, you can use LDAP or Active Directory user names and passwords to authenticate into RICOH ProcessDirector.
You must install the Security feature before you can set up to use LDAP authentication.

Consult your LDAP administrator for the values of the LDAP server and other properties you set in this procedure. Before you turn on LDAP authentication, you map RICOH ProcessDirector security groups to existing LDAP groups.

After you turn on LDAP authentication, the first time that a user logs in:

  • RICOH ProcessDirector authenticates the user name and password with the LDAP server.
  • RICOH ProcessDirector creates a RICOH ProcessDirector user name that is identical to the LDAP user name.
      Note:
    • No LDAP password information is stored on the RICOH ProcessDirector server.
  • RICOH ProcessDirector assigns the user RICOH ProcessDirector group memberships based on the values for the Product to LDAP group mapping property and the LDAP group memberships of the user.

Each time that a user logs in:

  • RICOH ProcessDirector authenticates the user name and password with the LDAP server.
  • If you synchronize product groups with LDAP groups, RICOH ProcessDirector updates the product group memberships of the user based on:
    • The values for the Product to LDAP group mapping property.
    • The LDAP group memberships of the user.
  • If you do not synchronize product groups with LDAP groups, RICOH ProcessDirector does not update the product group memberships of the user. You can assign group memberships to users manually in RICOH ProcessDirector. See the RICOH ProcessDirector information center for information about managing users and groups.

To set up to use LDAP authentication:
  1. Log in as a user who is a member of the Administrator security group.
  2. Click the Administration tab.
  3. In the left pane, click Settings LDAP.
  4. Set the LDAP server property to either of these values:
    • The network IP address.
    • The fully qualified host name of the LDAP server and the port that the system uses for authentication.

      To include more than one LDAP server, use a semicolon (;) to separate the entries.

  5. Specify values for the Root distinguished name, User search base, and User search filter properties.
    The value you enter for the User search filter property determines the format of your RICOH ProcessDirector user names, for example, an email address format or a UID format.
  6. Optional: Specify a value for the Email attribute property.
    If you enter a value for this property, RICOH ProcessDirector sets a value for the Email address property when it creates a user.
  7. Specify values for the Manager distinguished name and Manager password properties.
  8. Specify values for the Group search base, Group search filter, and Group search member properties.
    RICOH ProcessDirector uses the name of the LDAP group specified in the Product to LDAP group mapping property in the Group search filter property when it authenticates an LDAP user to RICOH ProcessDirector.
  9. If you want to manage RICOH ProcessDirector security groups using LDAP, set the Synchronize with LDAP property to Yes. If you want to manage security groups using RICOH ProcessDirector, set the property to No.
  10. Specify the connections between product groups and LDAP groups:
    1. Select a product security group from the list.
    2. Type the name of the corresponding LDAP group next to it.
    3. Click + to the right of the LDAP group and map another product group to an LDAP group.
    4. Repeat the previous step until you have mapped all product groups to LDAP groups.
  11. Check to see whether your browser has automatically filled the Manager distinguished name and Manager password properties. If they are filled, clear the properties and leave them blank.
  12. To secure the connection to the LDAP server and establish Transport Layer Security (TLS), specify a value for the LDAP security property:
    • To use the StartTLS operation, set the property to StartTLS.

      StartTLS works with most default implementations of LDAP.

    • To use the Secure LDAP (LDAPS) protocol, set the property to ldaps.

      Do not specify LDAPS unless your LDAP administrator already has set up your LDAP implementation to use LDAPS.

  13. To verify that you can log in with your LDAP credentials:
    1. In the Test LDAP Settings section, enter an LDAP user name and password. Make sure that the user name is a member of an LDAP group that is mapped to the RICOH ProcessDirector Administrator group.
    2. Click Test LDAP Settings.
      If the test is successful, you receive a message that says LDAP settings test succeeded.

      If you receive an error message, click Close, update your LDAP settings, and click Test LDAP Settings again.

  14. When the test completes successfully, set the Authenticate with LDAP property to Yes.
    If you cannot get a successful test, leave the Authenticate with LDAP property set to No and have your LDAP specialist look at other possible issues.
  15. Click SAVE.
    If you have not used the test function before you click SAVE with the Authenticate with LDAP property set to Yes, the system runs the test with the user ID and password specified.
    • If the test succeeds, the settings are saved and LDAP authentication is activated.
    • If the test fails, you see an error message and none of the settings are saved.

      Fix the LDAP settings and run the test until it passes. If the test continues to fail, set the Authenticate with LDAP property to No and click SAVE. Work with your LDAP specialist to resolve the problems and retest the settings.

After you turn on LDAP authentication:
  • Local RICOH ProcessDirector users cannot log in to RICOH ProcessDirector.
  • The first time that an LDAP user logs in to RICOH ProcessDirector, the system creates a user name that is identical to the LDAP user name.
  • If the Synchronize with LDAP property is set to Yes, RICOH ProcessDirector does not use any product groups that are not associated with LDAP groups.

RICOH ProcessDirector does not delete existing user names when you turn on LDAP authentication. You must manually delete those user names from the system.

    Note:
  • When LDAP authentication is turned on and RICOH ProcessDirector has a user with the same user name as an LDAP user:
    • RICOH ProcessDirector keeps the password of the existing user.
    • RICOH ProcessDirector lets the user authenticate with LDAP.
  • If LDAP authentication is turned off, the user can authenticate with the RICOH ProcessDirector password.

1.1.7.16 Communicating between RICOH ProcessDirector and the LDAP server

When you set up communications between RICOH ProcessDirector and your LDAP server, you might have to modify your LDAP server settings for these binds and search requests.

This table maps the Database property names to the corresponding names in the user interface. Use this table as a reference to help understand what properties are passed and returned by the searches and binds performed by RICOH ProcessDirector.

Database and User Interface property names
Database Property Name User Interface Property Name
WorkflowSystem.AdLdap.GroupMap Product to LDAP group mapping
WorkflowSystem.AdLdap.GroupSearchBase Group search base
WorkflowSystem.AdLdap.GroupSearchFilter Group search filter
WorkflowSystem.AdLdap.GroupSearchMember Group search member
WorkflowSystem.AdLdap.ManagerDN Manager distinguished name
WorkflowSystem.AdLdap.ManagerPassword Manager distinguished name password
WorkflowSystem.AdLdap.rootDN Root distinguished name
WorkflowSystem.AdLdap.Server LDAP server
WorkflowSystem.AdLdap.UserSearchBase User search base
WorkflowSystem.AdLdap.UserSearchFilter User search filter
User.ID User name
User.Password User password

RICOH ProcessDirector creates these binds whenever a user logs in:

  • bind ${WorkflowSystem.AdLdap.Server} using ${WorkflowSystem.AdLdap.ManagerDN} and ${WorkflowSystem.AdLdap.ManagerPassword}

    When the Manager distinguished name system property (WorkflowSystem.AdLdap.ManagerDN) does not have a value, an Anonymous bind is created.

  • bind to ${WorkflowSystem.AdLdap.Server} using ${User.ID} and ${User.Password}
      Note:
    • The password for User.Password must be set when making changes for LDAP. If the password is not set, the bind fails.

RICOH ProcessDirector does these search requests whenever a user logs in:

  • For all RICOH ProcessDirector LDAP groups:searchRequest "${WorkflowSystem.AdLdap.GroupSearchBase},${WorkflowSystem.AdLdap.rootDN}" wholeSubtree Filter: (${WorkflowSystem.AdLdap.GroupSearchFilter}${WorkflowSystem.AdLdap.GroupMap})

    The results must include the Group search member. The value of the Group search member is used as the RICOH ProcessDirector user name.

  • When a user name is set to the value returned on the Group search member argument:searchRequest "${WorkflowSystem.AdLdap.UserSearchBase},${WorkflowSystem.AdLdap.rootDN}" wholeSubtree Filter: (${WorkflowSystem.AdLdap.UserSearchFilter}=${User.ID})

Verify communications between RICOH ProcessDirector and your LDAP server are working correctly by testing the Group search base and User search base:

  • Test the Group search base by entering this command at a command prompt:

    ldapsearch -D "WorkflowSystem.AdLdap.ManagerDN" -x -W -b "WorkflowSystem.AdLdap.GroupSearchBase,WorkflowSystem.AdLdap.rootDN" -h "WorkflowSystem.AdLdap.Server" -s sub "(WorkflowSystem.AdLdap.GroupSearchFilter=GroupMap)"

    If communications between RICOH ProcessDirector and your LDAP server are working correctly, data containing the group search is returned. The response contains information stored in your LDAP server:

    UID=UserName, ou=GroupName, ou=OrganizationName, dc=ComputerName, dc=CompanyName

    GroupName is returned by WorkflowSystem.AdLdap.GroupSearchBase. OrganizationName, ComputerName, and CompanyName are returned by WorkflowSystem.AdLdap.rootDN.

  • Test the User search base by entering this command at a command prompt:

    ldapsearch -D "WorkflowSystem.AdLdap.ManagerDN" -x -W -b "WorkflowSystem.AdLdap.UserSearchBase,WorkflowSystem.AdLdap.rootDN" -h "WorkflowSystem.AdLdap.Server" -s sub "(WorkflowSystem.AdLdap.UserSearchFilter=User.ID)"

    Data containing the user search is returned if communications between RICOH ProcessDirector and your LDAP server are working correctly. The response contains information stored in your LDAP server:

    UID=UserName, ou=OrganizationUsers, ou=OrganizationName, dc=ComputerName, dc=CompanyName

    OrganizationUsers is returned by WorkflowSystem.AdLdap.UserSearchBase. OrganizationName, ComputerName, and CompanyName are returned by WorkflowSystem.AdLdap.rootDN.

1.1.7.17 Creating a Docker container secondary server

Use this procedure to create a Docker container secondary server on a Linux system and connect it to your primary computer.
Before you begin this procedure, install Docker Engine 19.03 or above on the Linux computer that will host the container secondary server.
    Note:
  • On RICOH ProcessDirector for Linux, you can create Docker container secondary servers on the primary computer or on a separate Linux computer.

To create a Docker container secondary server:

  1. Contact Ricoh Software Support for assistance with this process.
    The Software Support team can help evaluate your system and determine whether this procedure needs to be modified to fit your needs.
  2. Download and install the Secondary Docker feature.
  3. If directed by Software Support, install the Secondary Server feature on the remote Linux computer that will host the Docker container secondary server.

    Follow the procedures outlined in Setting up application and secondary servers. If you are installing a Docker container secondary server only on the primary computer, you do not have to install the Secondary Server feature nor configure NFS. Skip to step 7.

  4. If you did not install the Secondary Server feature:
    1. Configure NFS to communicate between the primary computer and the computer that will host the Docker container secondary server.

      Follow the procedure in Configuring the primary server to use NFS to set up NFS on the primary computer.

    2. On the computer that will host the Docker container secondary server, create this directory: /aiw, then mount it to the /aiw directory on the primary computer.
      Use this command: mount -t nfs primary computer IP address or hostname:/aiw /aiw
  5. On the computer that will host the Docker container secondary server:
    1. Create a Linux user ID with the same name as the RICOH ProcessDirector system user (aiw1 is the default). Add that user ID to the docker group.
    2. Change the ownership of the /aiw directory to the user you created.
  6. Log in to RICOH ProcessDirector.
  7. Create the server object to represent the Docker container secondary server.
    1. Click the Administration tab.
    2. In the left pane, click Objects Servers.
    3. On the Servers page, click Add Container secondary server
    4. Fill in the properties as appropriate.
    5. Click OK.
    RICOH ProcessDirector creates the server object and installs the container secondary server on the target system.
  8. When the installation process completes, start the container secondary servers. Log in to the computer that hosts the secondary container servers and run the command below.
      Note:
    • If you created the container secondary server on the primary computer, run the command on the primary computer.

      Replace directory with: /aiw

      The path_to_script is not required on the primary server.

    • If you created the container secondary server on a different computer, run the command from the secondary computer.

      On a secondary computer, you must provide the full path to the script on the primary computer, including the directory that is mounted to the /aiw directory on the primary server. In the command below, replace these values:

      • path_to_script

        The full path to the script on the primary server, including the mounted directory. If the mounted directory is /aiw (as in the procedure above), the value is: /aiw/aiw1/bin/

      • directory

        The full path to the directory that is mounted to the /aiw directory on the primary server. In the procedure above, this directory is also /aiw.

    • To start a specific container secondary server, replace [secondary_name] with the name of that server. Omit this value to start all of the container secondary servers present on the Linux computer.
    [path_to_script]containers.pl start directory[secondary_name]
    For example:
    • To start all the container secondary servers on the primary server:

      containers.pl start /aiw

    • To start one of four container secondary servers on a different computer:

      /aiw/aiw1/bin/containers.pl start /aiw secServContainer3

To stop the Docker container secondary servers, run this command on the computer that hosts them:

[path_to_script]containers.pl stop directory[secondary_name]

Follow the replacement instructions above for [path_to_script], directory and [secondary_name].

1.1.7.18 Moving processing to and from a failover server

Failover servers are designed to take over processing in the event that your RICOH ProcessDirector production server suffers a catastrophic event. Use this procedure to move processing between the RICOH ProcessDirector production server and the failover server.
To switch RICOH ProcessDirector processing to and from a failover server:
  1. Log in as the system user (aiw1 is the default) to the server you are moving processing from. If the system is not available (for example hardware failure or if the system is powered down), continue with step 3. If you are moving processing from the production server to the failover server, log in to the production server.If you are moving processing from the failover server to the production server, log in to the failover server.
  2. Open a command line and enter: stopaiw
  3. Log in as the root user to the server you are moving the processing to.
  4. Enter /opt/infoprint/ippd/bin/changeHostname.plserver_hostname where server_hostnameis the name of the server you are moving processing from and press Enter. If you are moving processing from the production server to the failover server, server_hostnameis the production server.If you are moving processing from the failover server to the production server, server_hostnameis the failover server.

1.1.7.19 Setting up to send data to RICOH Supervisor

The RICOH Supervisor settings let you configure the system to send data to RICOH Supervisor.

The data that you send to RICOH Supervisor must be stored in the Reports database by the RICOH ProcessDirector data collectors. Before you do this procedure, you need to configure the Reports feature, including setting up data collectors and workflow steps to gather the data that you want to send to RICOH Supervisor. The data collected by the data collectors before setting up a RICOH Supervisor data transmitter can be used in RICOH Supervisor after the transmission is enabled.

    Note:
  • Make sure that you have enabled data capturing in Reports Database Settings and for each data collector you want to collect data.

To create a connection to RICOH Supervisor and to transmit data, you must complete a series of steps. The data connection requires you to create a credential and a data transmitter. The credential uses an authentication code to create a certificate that authenticates with RICOH Account Administration for access to Ricoh cloud applications. To get access to RICOH Account Administration, contact the system administrator for RICOH Supervisor.

After you create a certificate that authenticates RICOH ProcessDirector to Ricoh cloud, you must create a RICOH Supervisor data transmitter that enables the data transmission.

    Important:
  • Only one Ricoh cloud credential and one RICOH Supervisor data transmitter can be created for sending data to RICOH Supervisor.

To set up to send data to RICOH Supervisor:

  1. Click the Administration tab.
  2. In the left pane, click Settings RICOH Supervisor.
  3. Go to Settings and set the values for these properties:
    1. Select the time zone for the RICOH ProcessDirector primary computer from the Primary computer time zone list.
    2. Enter the name of the RICOH ProcessDirector system in the System display name field. The name identifies your RICOH ProcessDirector system in RICOH Supervisor.
    3. If you choose to use a proxy server, make sure that the proxy server is configured on the System Settings page.
    4. Click Save settings.
  4. In the Credential section, click Add icon, the Add icon, to create a Ricoh cloud credential. A new dialog opens to set up the credential:
    1. Fill in the fields in the General section.
    2. In the Certificate section, click Generate code. RICOH Account Administration opens in a new tab.
    3. Log in to RICOH Account Administration and copy the code.
    4. Return to RICOH ProcessDirector and paste the generated code into the One-time code field.
    5. Click OK to generate the certificate and save the credential.
  5. In the Data Transmitter section, click Add icon, the Add icon, to create a new RICOH Supervisor data transmitter. A new dialog opens to set up the data transmitter:
    1. Review the current values for the properties and make any required updates on all the tabs. To see information about any of the properties, click the question mark button next to the property name.
    2. When all the settings are configured correctly, click the switch at the top of the General tab to enable the data transmitter.
    3. Click OK.
If all settings are configured correctly, you should see a green check mark in front of every section. The first data transmission occurs on the schedule you set. The first transmission could take a while to complete, even if only a small amount of data is sent. The upper right corner of the RICOH Supervisor Settings page shows the status of the connection and the date and time of the last successful transmission.

1.1.7.20 Installing a RICOH ProcessDirector product update

1.1.7.20.1 Preparing for the update

When you prepare your system for an update, you must determine how you want to update your system and what components you have installed, and then back up your system.

To prepare for an update:

  1. Decide how to update your system. You have two choices:
    • Download the full product ISO file for the most recent version of RICOH ProcessDirector.

      The ISO file includes a full update of the base product and all of the features. You install the update the same way that you initially installed the product.

      This option is the most efficient, because there is only one package to download and installed features are updated automatically.

        Note:
      • RICOH Transform features must be downloaded and installed separately.
    • Download the update packages for the base product and each of the features you have installed.

      Downloading individual update packages can be faster than downloading the full ISO file, as each package is significantly smaller than the ISO file. However, each package must be downloaded individually. If you have a large number of features to update, the process can take a long time.

      You can only install a product update on RICOH ProcessDirector systems at Version 3.6 or higher. If your software is below Version 3.6, use the full product ISO file or contact Software Support.

  2. If you have RICOH Transform features installed, log in to the Transform Feature user interface and open the About dialog. Note the transforms that you have installed.
  3. If you chose to use the full product ISO file, follow the instructions in chapters 3 and 4 of Ricoh ProcessDirector: Planning and Installing for downloading and installing the update.
  4. If you chose to install update packages, you must update the base product and all features that are currently installed.
    1. Log in as a user authorized to use Feature Manager.
    2. Click Administration.
    3. In the left pane, choose Utilities Features
      If you see an error message, you must start Feature Manger manually:
      • Log in to the primary computer as the default user and open a command prompt. Type: startaiw -f
      To complete the process, clear your browser cache and reload the Feature Manager web page.
    4. Make a list of all the features that have a version number In the Installed Version column.
      The Product Update feature contains the base product, so it must be updated.
  5. Back up the system. Type these commands.
    • zip -r aiwlib.zip /aiw/aiw1/lib/*
    • zip -r ext-xml.zip /opt/infoprint/ippd/extensions/**/extension.xml
      Note:
    • This procedure stops and starts your RICOH ProcessDirector server. Do this procedure at a scheduled maintenance time.

1.1.7.20.2 Downloading and installing update packages

Product updates for RICOH ProcessDirector can be downloaded from the Ricoh Software Web page.
    Note:
  • This procedure assumes that you are not using the primary computer to access an external Web page and download the update files.

    If you download the files directly to the primary computer, download the files to this directory:

    • /opt/infoprint/ippd/available

To download and install the update packages:
  1. In a web browser, open this page: https://dl.ricohsoftware.com/.
  2. Click Software Downloads, enter your Entitlement ID, and click Submit.
  3. Optional: If you have RICOH Transform features to update, find and click the names of those transforms to download them.
  4. Click View Related Files on the right side of the page.
  5. Click the title of each package that you want to download, starting with Ricoh ProcessDirector: Product Update Feature.
    Use the list of installed features that you made to determine which other packages to download.
  6. After each package downloads, validate its MD5 checksums to the value shown on the Web page. Use this command, substituting the name of the file for ProductUpdate.epk:
    • md5sum ProductUpdate.epk

    If the checksum does not match, download the file again.

  7. Log in to the primary server as the aiw1 user.
  8. Copy the EPK files into this directory on the primary computer:
    • /opt/infoprint/ippd/available
  9. Install the Product Update feature using Import Package.
  10. When the installation completes, RICOH ProcessDirector restarts. Use your browser to log in to the user interface. If an error occurs during the installation, contact Ricoh Software Support.
  11. If you downloaded other feature packages, use Feature Manager to install them.
  12. If you downloaded RICOH Transform features, mount and install each ISO file.
    For details about running the install program, refer to RICOH ProcessDirector: Planning and Installing, chapter 4.

1.1.8 Starting, stopping, and uninstalling

You can start and stop RICOH ProcessDirectorservers . You can also uninstall RICOH ProcessDirector.

1.1.8.1 Starting the base product and secondary servers

RICOH ProcessDirector base product and secondary servers start automatically when the systems on which they are installed start. However, you might need to start the base product or a secondary server without restarting the entire operating system.

After a system shutdown and restart, all the printers are disabled. If you want all the printers that were enabled before the shutdown to be enabled after the system is restarted, you can change the Remember enabled status of printers system property to Yes.

To start the base product or remote secondary servers:

  1. Log in to the system as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Access the command line.
  3. Enter this command:
    • startaiw
  4. If the startaiw command fails, enter these commands:
    • stopaiw
    • startaiw
On the primary computer, the command starts the primary server, local secondary servers, the user interface program, and the information center. On a secondary computer, the secondary server starts and connects to the primary server.

1.1.8.1.1 Deactivating the autostart script on Linux

If you do not want the RICOH ProcessDirector base product or secondary servers to start automatically when you restart the system on which they are installed, you can deactivate the autostart script. You remove two symbolic links from the script to deactivate it. RICOH ProcessDirector can be running when you deactivate the script.
To deactivate the autostart script:
  1. Log in as the root user.
  2. Access the command line.
  3. Enter this command:
    systemctl disable aiwserv.service

1.1.8.1.2 Activating the autostart script on Linux

If you previously deactivated the autostart script on your system, you can reactivate it. Reactivating the autostart script causes the RICOH ProcessDirector base product or secondary server to start automatically when the system starts. You add two symbolic links from the script to activate it.
    Note:
  • When you install RICOH ProcessDirector, the default is that it activates the autostart script. If you have not deactivated it, you do not have to do this procedure.

To activate the autostart script:

  1. Log in as the root user.
  2. Access the command line.
  3. Enter this command:
    systemctl enable aiwserv.service

1.1.8.1.3 Starting and stopping the base product when the DB2 server is on a different computer

The RICOH ProcessDirector primary server and its DB2 client must always be able to connect to the DB2 server. If the DB2 server is installed on a different computer and you reboot that computer, you must stop and restart RICOH ProcessDirector.
Stop and restart RICOH ProcessDirector and the DB2 server in this order:
  1. Log in to the Linux system as the RICOH ProcessDirector system user (aiw1 is the default).
  2. Enter this command to stop RICOH ProcessDirector:
    stopaiw
  3. Reboot the computer where the DB2 server is installed.
    The DB2 server stops automatically.
  4. Log in to the DB2 server computer as the RICOH ProcessDirector DB2 instance user.
    The default user ID is aiwinst.
  5. Enter this command to start the DB2 server:
    db2 start db manager
  6. On the RICOH ProcessDirector primary computer, log in as the RICOH ProcessDirector system user again and enter this command to restart RICOH ProcessDirector:
    startaiw 
If the DB2 server stops unexpectedly, stop RICOH ProcessDirector, then continue with the step after stopping RICOH ProcessDirector, described above.

1.1.8.2 Starting an application server

To run processing steps on an application server, the application server must be running. If the application server is not configured as a service, you must start the application server manually.
To manually start an application server:
  1. Log in to the Windows system as the user that the application server runs under.
  2. Start the application server. Use the Start application server link in the RICOH ProcessDirector start menu folder.

1.1.8.3 Stopping the base product and secondary servers

When you stop the RICOH ProcessDirector base product or a remote secondary server, you can stop the system with or without waiting for job-processing steps to complete. If you have the AFP Support feature installed, you can also choose whether to stop processes that were started by the RICOH ProcessDirector printer driver component, by Download for z/OS, or by AFP Download Plus.

After a system shutdown and restart, all the printers are disabled. If you want all the printers that were enabled before the shutdown to be enabled after the system is restarted, you can change the Remember enabled status of printers system property to Yes.

To stop the base product or a remote secondary server:

  1. Log in to the system as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Access the command line.
  3. Optional: To minimize the impact of shutting down the system on processes that are currently running, disable the input devices associated with the server.
  4. Enter one of these commands:
    • To stop the system immediately without waiting for steps to complete:
      • stopaiw

      Any steps that were in a processing state will move to an error state when you restart the system.

    • To stop the system after the currently processing steps are complete:
      • stopaiw -q
    • To stop the system and all processes that were started by the printer driver component, by Download for z/OS, or by AFP Download Plus:
      • stopaiw -t

      This option is only available on a primary computer with the AFP Support feature installed.

    On the primary computer, the command shuts down the primary server, local secondary servers, the user interface program, and the information center. If a remote secondary server is connected to the primary server when the primary server stops, the secondary server tries to reestablish the connection every 30 seconds, until it can connect or until the remote secondary server stops.

    On a secondary computer, the command disconnects the remote secondary server from the primary server and stops the secondary server.

1.1.8.4 Stopping an application server

You can stop an application server through the Windows Start menu. Stopping the server prevents RICOH ProcessDirector from accessing any external programs on the Windows system.
To stop an application server:
  1. Log in to the Windows system as the user that the application server runs under.
  2. Stop the application server. Use the Stop application server link in the RICOH ProcessDirector start menu folder.

1.1.8.5 Uninstalling RICOH ProcessDirector

You might need to uninstall RICOH ProcessDirector (for example, if you need to restore to a previous level).

1.1.8.5.1 Uninstalling the base product, features, and extensions

You can use one command to uninstall the base product and all features and extensions (except Secondary Server features) at the same time. You cannot uninstall features or extensions individually.

To uninstall the base product and all features and extensions:

  1. Log in to the primary computer as the root user.
  2. Enter one of these commands:
    • If you are running the primary computer from a graphical user interface such as X Windows:
      • /opt/infoprint/ippd/_uninstall/ippd/removeIPPD -i gui
    • If you are running the primary computer from a terminal window:
      • /opt/infoprint/ippd/_uninstall/ippd/removeIPPD -i console
      Note:
    • If you see an error that the Java virtual machine cannot be found, enter this command, then try to run the command again:

      . ~aiw1/.profile

    RICOH ProcessDirector starts the program that guides you through the uninstallation process. Follow the instructions in the program.
  3. Click Uninstall to start the uninstallation process.
    You can choose to remove the system user (aiw1), the system group (aiwgrp1), and the database user (aiwclnt) and group (aiwdbgrp).
    When the uninstallation is complete, you either see a message that the uninstallation was successful or a message that there were errors and the location of the error log file.
  4. Click Done.
  5. The uninstallation program leaves behind part of the directory structure. To completely remove all files that the RICOH ProcessDirector installation program installed, remove any file systems that were created as part of the installation.
    File systems to remove include:
    • /aiw/aiw1/db2
    • /aiw/aiw1/db2_logs
    • /aiw
    • /opt/infoprint/ippd
    • /var/psf/segments
    • /var/psf
    • /var/aiw
      Important:
    • Do not remove the /opt/infoprint directory if RICOH InfoPrint XT or RICOH Transform Feature are installed on the server you are using.
  6. To remove the RICOH ProcessDirector databases and DB2 instance from a DB2 server on a different computer:
    1. Log in to that computer as the DB2 instance owner of the RICOH ProcessDirector database.
    2. Insert the RICOH ProcessDirector base product DVD in the drive.
    3. Go to the /scripts directory on the RICOH ProcessDirector base product DVD.
    4. Enter this command to run the uninstall script:
      • ./remoteDB2uninstall.sh
      Note:
    • remoteDB2uninstall.sh lets you choose whether to remove the RICOH ProcessDirector user IDs or user groups created by setupRemoteDB2.sh. It does not remove RICOH ProcessDirector user IDs or user groups that you created manually.
  7. To remove the Docker container when you are using RICOH ProcessDirector with a PostgreSQL database, you must first stop the Docker container and then remove it.
    1. Enter this command to stop the Docker container:
      docker stop container-name
    2. Enter this command to remove the Docker container:
      docker rm container-name
    3. Enter this command if you also want to remove the associated volumes:
      docker volume prune

      This command deletes all persistent data previously associated with containers that have now been removed.

    The container-name is rpd-aiwdb-postgres for the primary database and rpd-reports-postgres for the Reports database.
  8. Restart the primary computer.

1.1.8.5.1.1 Uninstalling Transform Features

If you want to uninstall Transform Features, you need to uninstall it from the server and the BladeCenter, as appropriate.

1.1.8.5.1.1.1 Uninstalling Transform Features from a server

This section describes the procedure for uninstalling Transform Features from a server.
To uninstall Transform Features from a server:
  1. For Linux, run this command from this path: /opt/infoprint/itm/_uninst/uninstall_itm.sh, and for Windows, specify the uninstall command from this path: install_path\_uninst\uninstall.exe
  2. To uninstall only a specific transform, for Linux, run this this command:
    /opt/infoprint/itm/_inst/feature/<transform_id>/_uninst/uninstall_tf_<transform_id>.sh where <transform_id> is the transform name.
  3. You see the Welcome to the uninstall program page.
  4. Click Next.
    You see the summary page stating that the installer will uninstall Transform Features.
  5. Click Uninstall.
    You see the page stating that Transform Features has successfully uninstalled.
  6. Click Finish to exit the wizard.
On Windows operating systems, Transform Features can also be uninstalled from the Control Panel.

1.1.8.5.1.1.2 Uninstalling Transform Features from a Linux server from the command line

This section describes how to uninstall Transform Features from the command line.
To uninstall Transform Features from a Linux server:
  1. Log in as a root (administrator) user.
  2. For a console uninstall, enter this command:
    /opt/infoprint/itm/_uninst/uninstall_itm.sh
  3. To uninstall only a specific transform, enter this command:
    /opt/infoprint/itm/_inst/feature/<transform_id>/_uninst/uninstall_tf_<transform_id>.sh where <transform_id> is the transform name.

1.1.8.5.1.1.3 Uninstalling Transform Features from a Windows server from the command line

This section describes how to uninstall Transform Features from the command line.
To uninstall Transform Features from a Windows server:
  1. Log in as an administrator user.
  2. For a console uninstall, enter this command:
    install_path\_uninst\uninstall.exe -i console
  3. For a silent uninstall (does not produce any output and does not require user input), enter this command:
    install_path\_uninst\uninstall.exe -i silent

1.1.8.5.2 Uninstalling Secondary Server features

To uninstall Linux secondary servers:
  1. Log in as the root user.
  2. Enter this command:
    /opt/infoprint/ippd/_uninstall/ippds/removeIPPDs

    RICOH ProcessDirector starts the installation program that guides you through the uninstallation process. Follow the instructions in the installer.

  3. Choose whether to remove any RICOH ProcessDirector users and groups.
  4. Click Uninstall to start the uninstallation process.
  5. When the uninstallation is complete, you see either a message that the uninstallation was successful or a message that there were errors and the location of the error log file.
  6. Click Done.
  7. To completely remove all files installed by RICOH ProcessDirector, delete these file systems and directories:

    /aiw

    /var/psf/segments

    /var/psf

    /var/aiw

1.1.8.5.3 Removing the application server as a service

To remove the application server as a service without uninstalling the application server:
  1. Log in to the Windows computer that the application server is installed on.
  2. In a Windows command prompt, go to C:\Program Files\Ricoh\ProcessDirector\bin.
  3. Type: aiwsvc uninstall and press Enter.
  4. Open the Windows Services window, and look for the Ricoh Process Director Application Server service. If the Ricoh Process Director Application Server is no longer there, the application service has been removed.
  5. Turn off the automatic drive mounting function that the application service used:
    1. In Windows Explorer, go to C:\Program Files\Ricoh\ProcessDirector\logs.
    2. Remove or disable the mountaiwdata.bat file. If you plan to reactivate the application server service in the future, disabling the file is a good option. You can disable the file by commenting out the file contents or by renaming it to something similar to mountaiwdata.bat.bak.
  6. Optional: Start the application server. Use the Start application server link in the RICOH ProcessDirector start menu folder.

1.1.8.5.4 Uninstalling an application server

To uninstall an application server from a Windows computer:
  1. Log in to the application server as an administrator.
  2. If the application server is installed on a Windows 11 Pro computer, before uninstalling the application server, you must add an environment variable to run the uninstall script. To add the environment variable:
    1. Click the Windows Start button and type Control Panel.
    2. Click Control Panel.
    3. Go to System and click Advanced system settings.
    4. Click Environment Variables in the System Properties dialog.
    5. Click New in the System variables section.
    6. Enter JAVA_TOOL_OPTIONS in the Variable name field.
    7. Enter "-Dos.name=Windows Server 2019" in the Variable value field.
    8. Click OK.
  3. Go to the directory where you installed RICOH ProcessDirector. If you accepted the default directory during installation, go to C:\Program Files\Ricoh\ProcessDirector.
  4. Go to _uninstall\ippds and run removeIPPDs.exe.
  5. Click Uninstall to start the uninstallation process.
    When the uninstallation is complete, you either see a message that the uninstallation was successful or a message that there were errors and the location of the error log file.
  6. Click Done.

1.1.9 Installation planning checklist

This checklist contains tasks that can help you plan for your RICOH ProcessDirector installation.

Installation planning checklist
Check each item as you complete the task.
  Task Notes
  Determine your system configuration (see System configurations for an example of a configuration). Keep in mind your requirements for file sharing (such as Shark, FAST, RAID, or NFS) and failure recovery.

 
  Estimate your current and future storage and backup needs. Consider production volumes, print resource management, and failure recovery.

 
  Make sure that you have adequate network capacity.

 
  Determine which printers you want to use with RICOH ProcessDirector. When you define printers to RICOH ProcessDirector, you need this information:
  • Printer name
  • TCP/IP port number
  • TCP/IP address or host name
  • SNMP community name, if you want to use SNMP to monitor the printer

You should also decide on the language for the printer driver component to use when it returns messages to RICOH ProcessDirector.

 
  Obtain the required hardware for your configuration that meets your storage and backup requirements See Hardware requirements.

 
  Decide whether to set up your file system as partitions or as mounted file systems from other storage units. See Planning for file systems.

 
  Decide which database configuration to use with RICOH ProcessDirector:
  • PostgreSQL
  • IBM DB2 supplied with RICOH ProcessDirector
  • Your own copy of DB2

If you use your own copy:

  • Decide whether to install DB2 on the primary computer or on a different computer.
  • If you install DB2 on a different computer, determine the directory for RICOH ProcessDirector information.

 
  Determine what values to use for the RICOH ProcessDirector group on this computer. The default name for the group is aiwgrp1 and the default GID is 32458. You can change either value. Keep in mind that the GID must be the same across all primary and secondary computers; therefore, if you choose your own, make sure the value is large enough to avoid conflicts. All operating system user and group names must have 1-8 characters because of a database restriction. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.

See Creating system groups and users for additional information about creating this group and other required groups.

 
  Determine what values to use for the RICOH ProcessDirector system user. The default name for the system user is aiw1 and the default UID is 32457. You can change either value. Keep in mind that the UID must be the same across the primary and all secondary computers that connect to it; therefore, if you choose your own, make sure the value is large enough to avoid conflicts. All operating system user and group names must have 1-8 characters because of a database restriction. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.

If you create directories for RICOH ProcessDirector input devices to use, this UID must be a member of the group that owns these directories.

See Creating system groups and users for additional information about creating this user and other required users.

 
  If you choose to use DB2, determine the user IDs and groups for DB2 to use. Default names are provided, but you can change them to meet your requirements. All operating system user and group names must have 1-8 characters because of a database restriction. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.
  • In any DB2 configuration, you need an Instance group and a Database fenced group. The default names for those groups are aiwdbgrp and aiwdbfgp.
  • In any DB2 configuration, you need an Instance user and a Fenced user. The default names for the users are aiwinst and aiwdbfid.
  • If you install a DB2 client on the same computer as the base product and a DB2 server on a different computer, you need a Database client user. The default name for this user is aiwclnt.
You should never log in as any of these users, but you might need to recognize them for recordkeeping and security.
 
  Establish a host name and IP address for each server, including the DB2 server on a different computer if you use one. RICOH ProcessDirector supports IPv4 addresses.

 
  Determine the password to use when you log in to the RICOH ProcessDirector user interface with the aiw user name. The first time you log in to RICOH ProcessDirector with the default user name of aiw and the default password of aiw, you are prompted to change the password. The password must be 8 to 32 alphanumeric characters.  
  If you use a DB2 server on a different computer, determine the password for the RICOH ProcessDirector instance user.

 
  Determine how many RICOH ProcessDirector user IDs you want to create and which authority you want each ID to have, such as monitor, operator, supervisor, or administrator. Determine what other authority groups you want to create and what actions they can do.  
  If you want to use LDAP or Active Directory user IDs and passwords to authenticate RICOH ProcessDirector users, ask your LDAP administrator to create LDAP groups for each level of access you want to set up as a RICOH ProcessDirector security group.  
  Consider which job submission methods you are going to use to send jobs to RICOH ProcessDirector. You can copy or FTP files into hot folders, send files using the LPD protocol, or use the pdpr command. If you have the AFP Support feature, you can use Download for z/OS or AFP Download Plus. The job submission method you use depends on the system you are sending the jobs from. For more information, see Job submission.  
  Determine which resources must be available for RICOH ProcessDirector to use (such as standard and non-standard AFP fonts). Then, consider how you want to share your resources so they are available to RICOH ProcessDirector (for example, NFS or Samba).

If you store your resources in the /aiw/aiw1/resources directory on your primary computer, all the RICOH ProcessDirector components, including any secondary servers, can find them with no additional configuration. RICOH ProcessDirector does not make any changes to that directory during updates, so you do not have to reload the resources when you install an update.

 
  Install the required software for your configuration (see Installing required software).  
  Install any optional software, such as Download for z/OS, AFP Download Plus, or InfoPrint Transform Manager (see Planning for optional software).

 
  Change the language for the computer, if required:
SLES
In YaST:
  • Click System Choose Language.
  • Click System Select Keyboard Layout.

In the KDE Control Center, click Regional & Accessibility Country/Region & Language.

Red Hat, CentOS, or Rocky Linux
To check which locale is currently in use, type: cat /etc/locale.conf
To check which locales are installed on the system, type: localectl list-locales
To change the locale that is in use, type: localectl set-locale LANG=locale name

Replace locale name with the name of one of the locales that is installed on the system.

Windows
Click Control Panel Regional and Language Options.
RICOH ProcessDirector supports these languages and locales:
  • Brazilian Portuguese (pt_BR)
  • English (en_US)
  • French (fr_FR)
  • German (de_DE)
  • Italian (it_IT)
  • Japanese (ja_JP)
  • Spanish (es_ES)
  Security Enhanced Linux (SELinux) must be disabled during the install process for RICOH ProcessDirector.

To check the status of SELinux, type: getenforce

You can enable it again after the install is complete.

1.1.10 Accessibility

Ricoh strives to provide products with usable access for everyone, regardless of age or ability.

For more information about the commitment that we have made to accessibility, refer to the Accessibility page on the Ricoh website.

Accessibility features

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

The major accessibility features in this product let you:

  • Use screen readers, screen magnifiers, and other assistive technologies.
  • Use a keyboard instead of a mouse.
  • Change attributes such as volume, color, contrast, and font size.

In addition, the information center and the publications for the product are in an accessible format.

To enable assistive technology support in the installer, specify the console option at the end of the setup command. For example, to enable assistive technology on Linux computers, enter:

./setup -console

Keyboard navigation

This product uses standard Microsoft Windows navigation keys.

    Important:
  • You cannot use the Workflow tab, the AFP Indexer mode of RICOH Visual Workbench (which is part of the AFP Support feature), the AFP Editor feature, or the Whitespace Manager feature with the keyboard alone. They require a mouse.
RICOH ProcessDirector user interface shortcut keys

When the Jobs table on the Main page or a table on the Administration page has focus, you can use these shortcut keys:

User interface shortcut keys
Description Ctrl + key
Select all objects in the table. a
Open the field help for the currently selected property. F1

When viewing a job in a workflow, you can use these shortcut keys:

View job in workflow shortcut keys
Description Ctrl + key
Zoom in. +
Zoom out. -
Return to the default zoom level. 0
RICOH ProcessDirector workflow shortcut keys

On the Workflow Editor, you can use these shortcut keys:

Workflow shortcut keys
Description Ctrl + key
Save the workflow. Ctrl + s
Undo a previous action, including changes made on a step or connector property notebook. Ctrl + z
Reverse an Undo action, including changes made on a step or connector property notebook. Ctrl + y or Ctrl + Shift + z
Show or hide the Step Templates window. Ctrl + e
Show or hide the Map. Ctrl + m
Zoom in. Ctrl + +
Zoom out. Ctrl + -
Reset the zoom to the default value. Ctrl + 0
Reset the default size and location of the Map window. Ctrl + d
Copy one or more steps. Steps must be selected first. Ctrl + c
Delete one or more steps. Steps must be selected first. Delete

1.2 Using RICOH ProcessDirector

1.2.1 Overview

1.2.1.1 New in this release

These new functions and updates have been included in RICOH ProcessDirector Version 3.12.1.

New functions and updates in Version 3.12.1

  • Updated translations

    The content of the Version 3.12 product interface and the help system has been translated into these languages:

    • Brazilian Portuguese
    • French
    • German
    • Italian
    • Japanese
    • Spanish

    To see the translated user interface and help content, download and install the Language Pack for your language.

  • Upgrade and migrate to PostgreSQL on the same system

    In RICOH ProcessDirector version 3.12, we introduced support for PostgreSQL as the main database underlying RICOH ProcessDirector. To move to PostgreSQL, you were required to install version 3.12 on a different server and use the Migration Assistant to migrate your data. WIth version 3.12.1, you can upgrade and migrate your data on the same system. Install RICOH ProcessDirector, making sure to choose the PostgreSQL database configuration. After the installation completes, follow the instructions to migrate your data, then remove IBM DB2 from your primary computer.

  • Manual failover now supported for PostgreSQL configurations

    Manual failover configurations for system redundancy are now supported on RICOH ProcessDirector with PostgreSQL as well as DB2.

  • XML-RPC calls no longer supported

    The Connect extension, which let you connect to RICOH ProcessDirector remotely and use XML-RPC calls in scripts, is deprecated and no longer supported. We recommend using RICOH ProcessDirector web service API instead. For information about using web services, see Web services in RICOH ProcessDirector .

  • Additional updates include:
    • Ability to save the View job in workflow image
    • Added the StepChainDemo workflow to illustrate the use of step chains
    • Updated prerequisites for the Preprinted Forms Replacement feature, so customers with the AFP Support Feature can install Preprinted Forms Replacement without also installing PDF Document Support.
    • Usability updates for the Migration Assistant

New functions and updates in Version 3.12

  • Primary database options now available

    After many years of supporting only one database, RICOH ProcessDirector can now run with PostgreSQL as its primary database. While IBM DB2 is still supported in the same configuration as it has been, PostgreSQL is now the default database configuration. Existing customers can upgrade to version 3.12 and continue to use DB2 with no interruptions, or can choose to migrate their data to a PostgreSQL database.

    Note: To migrate data from DB2 to PostgreSQL, you must install RICOH ProcessDirector version 3.12 on a different computer. You cannot install the PostgreSQL configuration on the same system as an existing DB2 configuration.

    The PostgreSQL database is installed in a Docker container, so Docker Engine must be installed on the primary computer.

  • Migration simplified

    One of the most challenging aspects of moving to a new version of an application is ensuring that everything still works. Especially when the upgrade requires moving to a new system, it is challenging to know that you have copied everything that needs to be there. The RICOH ProcessDirector Migration Assistant now makes the process much easier.

    Install the base product on a new system, then log in and start the Migration Assistant. Use the Assistant to connect to your existing installation, choose the objects and settings to migrate to the new one, and let the Assistant do the work. The Migration Assistant can handle moving data from an existing DB2 database to PostgreSQL, and can even work across operating systems.

  • RICOH ProcessDirector for AIX replacement

    In version 3.12, RICOH ProcessDirector for AIX has been discontinued. Customers running on AIX can continue to use the application until the end of support date. Alternately, they can migrate to version 3.12 on Linux or Windows and use the Migration Assistant to port their data to a new system.

  • New Supported Printers

    RICOH ProcessDirector now supports printer models with the new Fiery® N-series Controller Digital Front Ends, based on Fiery and Ricoh technology. You can define these new printer models as Ricoh PDF printers:

    • RICOH Pro C7500
    • RICOH Pro C9500

  • Updated operating system support

    You can now install RICOH ProcessDirector on these operating system versions:

    • Rocky Linux 8.4 through latest 8.X
    • Rocky Linux 9.0 through latest 9.X
    Note: You can only install the PostgreSQL configuration on these operating systems. IBM DB2 is not supported on Rocky Linux.

New functions and updates in Version 3.11.2

  • New support for custom job properties

    With this release, you can create custom properties for jobs. In the past, RICOH ProcessDirector provided 20 job properties that you could use to store custom information. However, you could not rename the fields or change anything about them. With this new function, you can create your own job properties-- assigning unique field and database property names as you want to see them.

    To define custom job properties, use the Custom properties page on the Administration tab. Fill in the property notebook, activate the property, and you can start using it in your workflows!

  • An easier way to define custom document properties

    The same Custom properties page used to define custom job properties can also be used to define document properties! This new function significantly reduces the overhead associated with creating custom document properties. You no longer need to update the docCustomProperties.xml file, run the DocCustom utility, or install the new property. Simply fill in the fields in the custom property notebook and activate. Your document properties are ready to use!

  • Updated Adobe Acrobat Plug-in

    The RICOH ProcessDirector Plug-in for Adobe Acrobat has been updated to support the OpenJDK™Java® JRE Version 1.8 in addition to Oracle® Java. An appropriate JRE must be installed on your system before you install the Plug-in. With this update, we strongly recommend installing the 64-bit version of the JRE.

    In addition, you can now install the Plug-in with the 64-bit version of Adobe Acrobat Pro.

  • Updates to translated publications

    Books and help systems containing translated information for function released in Version 3.11.1 are now available. To see the translated help content and updated books from the help menu, download and install the Language Pack for your language. PDF versions of the books are also available in the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/)

New functions and updates in Version 3.11.1

  • Updated translations

    The content of the Version 3.11 product interface and the help system has been translated into these languages:

    • Brazilian Portuguese
    • French
    • German
    • Italian
    • Japanese
    • Spanish

    To see the translated user interface and help content, download and install the Language Pack for your language.

  • Choose paper for banner pages using media settings

    If you're printing PDF jobs, you can now specify which paper to print banner pages on by media, instead of by specifying a paper tray. Your banner pages print on the correct paper, regardless of where that paper is loaded. This function is available for Ricoh PDF, Kodak PDF, and Xerox PDF printers.

  • User interface updates

    The user interface has been enhanced to adjust the size of your portlets to fit inside your browser window. When you change the size of the window (by changing the dimensions of the browser or by moving it to a different screen), the portlets shrink or expand to fill the space available.

  • Data capture improvements

    With this update, you can download a data capture file to your system directly from the data capture page, so you don't have to access the primary server to retrieve the file. You can also stop a capture that is already in progress.

  • Operating system support changes

    In this release, we increased the minimum level of CentOS required to install RICOH ProcessDirector to version 7.9.

New functions and updates in Version 3.11

  • Ability to restore to a previous installation of RICOH ProcessDirector

    With this version of RICOH ProcessDirector, you can restore a previous installation using Feature Manager. With this new function, you install a new feature and then effectively back it out if you decide that it does not meet your needs. Or, if you apply an update but something goes wrong during the install process, you can restore the installation from before the update to get back to a stable state before you try to update again.

  • New data collector to collect information about processing durations

    Now, you can use the Job Step Duration data collector to collect information about how long each step was in the queued and processing states, as well as the total length of time it takes for each step in a workflow to complete processing. You can also select job properties to capture at the end of each step.

  • Operating system support changes

    In this release, we have removed support for installing RICOH ProcessDirector application servers on Windows Server 2016.

  • Include the Preset name in AFP print jobs

    If you send AFP print jobs to a printer that uses TotalFlow Print Server, you can now include the name of the printer preset to use for the job as a job property.

  • Security vulnerabilities addressed

    Ricoh is committed to responding to results of vulnerability scans and will continue to include those fixes in each release that we deliver. In this release, various components were updated to address these vulnerabilities, including:

    • AFP Support
    • Avanti Slingshot Connect
    • Reports
    • Printer Connector
    • Ricoh PDF Printer
    • DB2
    • Product Update

Release notes for prior versions of RICOH ProcessDirector are available on the RICOH Software Information Center here: Release notes: RICOH ProcessDirector

1.2.1.2 Product overview

RICOH ProcessDirector is a print manufacturing system architecture that lets you manage all aspects of your printing processes. Whether your printing environment is small, with a single printer, or large, with many printers, RICOH ProcessDirector can grow as your business needs grow.

The modular design of RICOH ProcessDirector provides flexibility, while the comprehensive user interface provides consistency in how you manage all aspects of your printing environment:

  • The open framework of RICOH ProcessDirector lets you make the most of your existing software investment. You can use third-party programs, or create your own command-line programs and incorporate them in your RICOH ProcessDirector processing tasks.
  • RICOH ProcessDirector provides seamless connections to your sources of data. You can copy or move files into hot folders and configure RICOH ProcessDirector so that it continually monitors those directories, then automatically creates and processes jobs. You can submit jobs using the LPD protocol from anywhere in your network, and have RICOH ProcessDirector automatically process those jobs. If you have the AFP Support feature installed, you can send jobs from a z/OS host using Download for z/OS or AFP Download Plus.
  • RICOH ProcessDirector accepts jobs in various data streams and can send them to a wide variety of printers from different vendors.
  • The extensive RICOH ProcessDirector database includes detailed audit information about your printing workload and tasks, and lets you manage your business more efficiently.

RICOH ProcessDirector runs as a Web application, so you can access it from a browser running on any Microsoft Windows or Linux computer on your network. You do not need to install RICOH ProcessDirector on those computers, only on the primary computer.

1.2.1.2.1 RICOH ProcessDirector subscription

You can purchase a RICOH ProcessDirector subscription for different periods of time, ranging from 1 to 5 years.

You purchase a subscription for the base product and for each feature that you want to install. If you purchase a feature subscription after the base product, the feature subscription is prorated to expire at the same time as the base product.

    Note:
  • You can install trial versions of features, but to continue using them after the trial period, you must purchase the feature subscription.

When there are 60 days left in a subscription, an expiration warning message appears in the product banner to let you know. You must renew your subscription before it expires to avoid interruption in access.

If the subscription expires, you must contact Software Support for renewal assistance.

    Note:
  • You can check the subscription expiration date at any time from Administration Licenses.

1.2.1.2.2 System objects

A RICOH ProcessDirector system is made up of several objects.

1.2.1.2.2.1 Primary server

The RICOH ProcessDirector base product is made up of the primary server, the user interface, and the information center. The primary server includes the RICOH ProcessDirector database, the PSF print driver, and other components. The primary server can interact with application servers and secondary servers. The number of application and secondary servers required depends on the needs of your environment. The primary computer is the computer that the primary server, along with the rest of the base product and most features, is installed on.

You install the base product on an x86 server that has one of these operating systems installed:

  • CentOS Linux 7.9 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • Rocky Linux 8.4 through latest 8.X
  • Rocky Linux 9.0 through latest 9.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
  • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64

    Using the latest service pack is recommended.

Note: The DB2 database cannot be installed on Rocky Linux. As a result, you can only install RICOH ProcessDirector with the PostgreSQL database on Rocky Linux.

The primary server:

  • Manages all aspects of job processing, from the input devices that receive input files to the printers that print the jobs.
  • Processes each job through a series of steps, some of which can call other programs that are not part of RICOH ProcessDirector to do special processing.
  • Manages related applications, such as:
    • The database that RICOH ProcessDirector uses to store system information.
    • The web server that it uses to display the user interface.
  • Manages this information center.
  • Controls system settings, such as:
    • What hosts can submit jobs using the LPD protocol.
    • The retention period for jobs after their processing completes.
    • How frequently users must change their RICOH ProcessDirector passwords.
  • Maintains a shared file system that application and secondary servers mount to access system-wide information.

1.2.1.2.2.2 Secondary servers

Secondary servers let you distribute processing, so that your RICOH ProcessDirector system runs more efficiently.

You can use secondary servers to do some of the more processing-intensive steps in your various workflows and to prevent the primary server from becoming overloaded. The primary server works with the secondary servers to coordinate the movement of all jobs across the system. The secondary servers do not have their own embedded databases for storing system information. All the servers work with the database that is installed on the primary computer.

RICOH ProcessDirector supports different types of secondary servers:

Local secondary servers
Created directly on the primary computer. Require minimal configuration.
Remote secondary servers
Created on a Linux computer that is separate from the primary computer. You must install a Secondary Server feature on the remote computer and set up communication between the secondary server and the primary server.
Container secondary servers
Created either on the Linux primary computer or on a Linux computer that is separate from the primary computer. You must install Docker Engine 19.03 or above on the computer that will host the container secondary server. On a remote computer, you must also set up communication between the secondary server and the primary server. In addition, you might need to install a Secondary Server feature.

Then, you create the container secondary server in RICOH ProcessDirector. Creating the server loads an image into a Docker container on the computer. The image contains a Linux operating system and everything needed to run a RICOH ProcessDirector secondary server.

Secondary servers can manage all types of RICOH ProcessDirector objects, such as input devices, steps, and printers. They can also run external programs that RICOH ProcessDirector accesses through external steps. External programs can do more processing or special types of processing.

For installations that have many printers and a high volume of jobs, adding secondary servers to the system can increase job throughput. The throughput increases because each server has a smaller number of printers and jobs to monitor and control.

For AFP printers, you can set up secondary servers to stage work to the remote server so that RICOH ProcessDirector keeps the pipeline to the printer full, reducing the likelihood that the printer waits for data. This configuration is particularly useful if you installed RICOH ProcessDirector on an externally hosted or distributed network, such as a virtualized or cloud environment that is far removed from the physical printers. Properties of the AFP printer object allow you to specify a directory on the secondary server to receive the print files. The secondary server then manages releasing jobs to the AFP printer when the printer needs work.

You can create secondary servers on the primary computer or install the Secondary Server feature on these systems:

  • CentOS Linux 7.9 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • Rocky Linux 8.4 through latest 8.X
  • Rocky Linux 9.0 through latest 9.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64

1.2.1.2.2.3 Application server

An application server is a Windows system configured to communicate with RICOH ProcessDirector. If your workflows require processing by applications that run on Windows, you can access those applications by installing RICOH ProcessDirector application server code on a Windows computer.

Application servers share the database that the primary server uses and work with the primary server to process jobs effectively. Because application servers are installed on Windows computers, they can run steps that require applications on Windows. They cannot run other steps, such as PrintJobs.

Application servers can be the parent servers for Ricoh PDF printers, Custom PDF printers, and Passthrough printers. They cannot be the parent servers for other kinds of printers.

You can install application servers on these operating systems:

  • Windows 10 Pro or Enterprise 64-bit
  • Windows 11 Pro
  • Windows Server 2019 64-bit
  • Windows Server 2022 64-bit

1.2.1.2.2.4 Workflows

A workflow defines a set of steps that a job follows through the system. A printing process can contain one or more workflows, depending on the type of processing required and the configuration of your system.

A job is an input file that RICOH ProcessDirector has accepted and submitted for processing.

A workflow can contain linear or conditional processing. In linear processing, each step receives a job from one step and sends the job to one step. In conditional processing, each step receives a job from one or more steps and sends the job to one or more steps. RICOH ProcessDirector uses conditional processing rules to determine which step to send each job to.

When you create a workflow, you specify what steps the job passes through during processing, you place the steps in phases, and you make connections between them. You also set values for job properties, such as customer name and due date, to be used when processing jobs. In conditional workflows, you create rules by specifying conditions, and you assign the rules to the connectors from a step to steps in different branches of the workflow.

If you use the same set of connected steps in many of your workflows, you can create a step chain with those steps to use in your workflows.

When you drag a step chain into one of the processing phases of another workflow, the steps from the step chain you added are copied into the phase where you dropped the step chain. The step chain appears as a single step in the workflow with a number as its icon, indicating how many steps are contained in the step chain. Changes to the steps in the current workflow do not apply to the step chain that was dropped in. Changes made to a step chain outside of the workflow are not applied to the step chains placed in the workflows.

The default processing phases in the base product are:

  • Receive
  • Prepare
  • Print
  • Complete
Features can add other phases, such as Assemble and Insert.

    Important:
  • When you use the Workflow Editor to edit a job type created in a previous version of RICOH ProcessDirector, the job type becomes a workflow. It can no longer be opened on the Administration page by clicking Workflow Job Types.

1.2.1.2.2.5 Step templates, steps, and step chains

Step templates are the basic building blocks for processing on the RICOH ProcessDirector system. A step template contains the code that does a specific action, such as creating or removing a job. It can also define default job property values. When you add a step to a workflow, you select a step template to use as the basis for the step.

RICOH ProcessDirector provides several step templates that the supplied RICOH ProcessDirector workflows use. You can also use these step templates to create steps and step chains in your own workflows.

Step chains are groups of connected steps that you can use in your workflows like a step template. If you use the same set of steps in many of your workflows, you can create a step chain with those steps. You can then use the step chain instead of adding each step every time you create a new workflow.

For example, you have a set of steps with logic that detects the data stream of the job, sends PDF files through an OptimizePDF step, sends AFP files through a transform to PDF, and then sends both PDF and AFP files through steps that count pages and extract document properties. You could make a step chain of that set of steps and drop it into each workflow that you build. You might have to change the value of some properties set on the steps for each workflow but you save yourself the time of adding the steps and connectors to each new workflow.

1.2.1.2.2.5.1 Running the StepChainDemo sample workflow

The StepChainDemo workflow presents an example of step chain usage by showcasing how to group a collection of steps with a well-defined function. After you create a step chain, you can include it in other workflows, making the process easier and visually simplifying the workflow.

The sample objects and files used in this workflow include:

  • Workflow: StepChainDemo
  • Sample step chains:
    • ReceivePDFJob
    • PrepareForPrint
    • CompressAndRetain
  • Sample input device: HotFolderStepChain
  • Sample PDF file: /aiw/aiw1/testfiles/Demo.pdf

The illustrations below show the sample workflow as a series of phases containing step chains and steps corresponding to the processing steps that your jobs pass through. The step chains appear as a single steps in the workflow with numbers as their icons, indicating how many steps are contained in the step chains. The color of the step chains match the color of the phase they are in.

Review the sample workflow and run a sample job to understand how step chains work.

The Receive phase sets the initial values of job properties and optimizes PDF jobs. In this phase, the ReceivePDFJob step chain is executed, which includes the following steps: SetJobPropsFromTextFile, DetectInputDataStream, and OptimizePDF.

The Prepare phase consists of the PrepareForPrint step chain, which includes the following steps to prepare the PDF sample for print: CountPages, AssignValues, AssignValues2, and RunExternalProgram. This step chain also provides an example of how to create rules by using specifying conditions. During the CountPages step, RICOH ProcessDirector calculates the total number of sheets in the job. Depending on this value, the job is sent to different branches, using either AssignJobValues or AssignJobValues2 step.

After jobs have completed all other processing, they arrive in the Complete phase. In this phase, the CompressAndRetain step chain is executed, which includes the following steps: ContinueToNextStep, RetainCompletedJobs, CompressFiles, and RemoveJobs. During the execution of these steps, PDF data files that are larger than 10 MB get compressed, and the job is retained for three days before being removed.

To run the sample workflow:

  1. Log in to RICOH ProcessDirector.
  2. Click the Main tab.
  3. In the Printers portlet, select the Sample printer and click Enable.
  4. In the Input Devices portlet, select the HotFolderStepChain hot folder input device and click Enable and Connect.
  5. Navigate to /aiw/aiw1/testfiles and copy Demo.pdf into /aiw/aiw1/System/hf/stepchain. The job shows up in the Jobs table.
    The sample workflow uses a sample printer that does not print any data.
  6. In the Jobs table, find the job. To view the job in the workflow, on the Jobs portlet, right-click the job and select View job in workflow.
    You can double-click the step chains to view the job's path through the conditions. For example, if you click the PrepareForPrint step chain icon, you can see that the job followed the second path ( AssignJobValues 2). This occurred because the Demo.pdf file has more than 20 pages.
    Note:
  • If you want to run the example again, you must copy the sample file to the hot folder again.
  • You can copy a larger file to the hot folder to simulate printing large files that go through the CompressFiles step of the CompressAndRetain step chain.

1.2.1.2.2.5.2 Positional job properties

You can place steps based on the same step template in a workflow multiple times. If the job properties associated with the step template take different values for each step, they are positional properties.

For example, two different steps based on the RunExternalProgram step template can process jobs by running two different external programs. The External command job property specifies the program that each step runs to process jobs.

Other step templates share the same value for each job property across the steps in the same workflow. When you change the value of a job property for one step based on the step template, the value of the property for the other steps changes.

For example, a workflow has two branches, and each branch has a different RetainCompletedJobs step. The Requested printer job property specifies the printer requested for the job. If you change the value of the Requested printer property for one step from PrinterBldg1 to PrinterBldg2, the value of the property for the other step changes to PrinterBldg2.

If you want two different branches of a workflow to print their jobs to a different printer, you must place a step based on the AssignJobValues step template before each PrintJobs step. Set the values you want for each branch of the workflow on each AssignJobValues step. The value of the Requested printer property in each AssignJobValues step overrides the Requested printer property value in the two PrintJobs steps.

To see the positional properties for a job in the jobs table on the Main page of the user interface, right-click the job and select Properties.

On each tab in the job property notebook, positional job properties are displayed under a heading that gives the names of the phase, workflow, and step.

For example, if a job in the PDF workflow has a RunExternalProgram step in the Prepare phase, the External command property is displayed under this heading: Prepare - PDF - RunExternalProgram.

    Note:
  • You cannot set the values of positional properties using the Manage job defaults action in the Workflow editor.

1.2.1.2.2.6 Input device types

Input devices receive input files, create jobs, and submit them to the RICOH ProcessDirector system for processing.

Input devices accept individual or multiple input files and submit them for processing. The input device can process multiple files in either of these ways:

  • It can collect the data and submit it as a single job.
  • It can submit each file as a child of a parent job.
If you have the AFP Support feature installed, RICOH ProcessDirector treats each data set as an input file. Multiple data sets can be submitted as single jobs or as child jobs.

The types of input devices are:

Hot folder
Hot folder input devices are directories that the system monitors. When a print job is copied or sent to a hot folder, the system notices it and begins to process it.
LPD
Line printer daemon (LPD) input devices receive jobs that are submitted using the LPD protocol. LPD input devices specify a control file to change LPD control file parameters for a job to a job properties file in property name=value format. For PDF jobs, the control file is receive_lpd_pdf_jobtype.cfg. For AFP jobs, the control file is receive_lpd_jobtype.cfg.
Download
Download input devices receive data sets from Download for z/OS or AFP Download Plus. Download for z/OS and AFP Download Plus send job control language (JCL) parameters in a separate file with the job. Download input devices specify the control file, receive_jcl_jobtype.cfg, to change JCL parameters for a job to a job properties file in property name=value format. This device type is only available if the AFP Support feature is installed.
REST web service
REST web service input devices call a Representational State Transfer web service to retrieve XML or JSON files from an application. The input device can create a job containing the entire XML or JSON file, or it can examine the file using an XPath or JSONPath expression. If the input device finds XML elements or JSON objects specified by the expression, it can create a single job containing the entire file. Alternatively, it can create one or more jobs, each containing a portion of the file. This device type is only available if the Web Services Enablement feature is installed.
SOAP web service
SOAP web service input devices call a Simple Object Access Protocol web service to retrieve XML files from an application. The input device can create a job containing the entire XML file, or it can examine the file using an XPath expression. If the input device finds XML elements specified by the expression, it can create a single job containing the entire file. Alternatively, it can create one or more jobs, each containing a portion of the file. This device type is only available if the Web Services Enablement feature is installed.
SFTP
SFTP input devices poll using the SFTP protocol for files matching a file name pattern that you specify from a directory on an SFTP server. You must supply a credential to permit the input device to access the server.

RICOH ProcessDirector provides some predefined input devices of certain types that you can use as samples. A predefined input device is not provided for SFTP.

1.2.1.2.2.7 Printers

Printer objects represent the printers in your environment that receive print jobs from RICOH ProcessDirector.

A print job is one or more input files that have been submitted for printing.

RICOH ProcessDirector can interact with printers represented by these printer object types:

AFP
AFP printer objects represent Intelligent Printer Data Stream (IPDS) printers. They print jobs in AFP format. You can use all RICOH ProcessDirector actions with jobs that have been submitted to AFP printers. This object type is available only when the AFP Support feature is installed.

Some IPDS printers, such as the InfoPrint 5000, also print non-IPDS jobs. You can configure the AFP printer object to share the physical printer. When shared, the physical printer can accept non-IPDS jobs from another input source, such as a hot folder.

Custom PDF
Custom PDF printer objects represent PostScript printers that are not on the list of supported Ricoh PDF printers. These printers include some Ricoh PostScript printers and PostScript printers from other manufacturers. RICOH ProcessDirector uses a custom printer definition file to convert PDF print files into PostScript commands supported by a Custom PDF printer. In response to customer requests, Ricoh creates the custom printer definition files from PostScript Printer Description (PPD) files supplied by the manufacturers.
These printer objects can be defined on Linux primary and secondary servers and on Windows application servers.
You cannot use some of the RICOH ProcessDirector job actions (such as Jump to) with jobs that have been submitted to Custom PDF printers.
When you use the Stop job action:
  • Depending on the control unit of the printer, the job stops printing.
  • RICOH ProcessDirector stops sending segments of multiple-segment jobs to the printer.
Kodak PDF
Kodak PDF printer objects represent printers that can print PDF files. This object type is available only if the Cut Sheet Support for Kodak feature is installed.
Passthrough
Passthrough printer objects represent printers that can print jobs in non-AFP formats such as PCL, PostScript, and PDF. You specify the command that sends the jobs to the printer. You cannot use some of the RICOH ProcessDirector job actions (such as Jump to and Stop) with jobs that have been submitted to Passthrough printers.
PCLOut
PCLOut printer objects represent Printer Command Language (PCL) printers. They print jobs that are submitted in AFP format and converted to PCL format. You specify the command that sends the jobs to the printer. You cannot use some of the RICOH ProcessDirector job actions (such as Jump to and Continue) with jobs that have been submitted to PCLOut printers. You can use the Stop action only on a job that is printing on a PCLOut printer. You must request the action while the job is being converted to PCL. This object type is available only if the AFP Support feature is installed.
Ricoh PDF
Ricoh PDF printer objects represent printers that can print PDF files. Depending on what data streams your printer supports, you can tell RICOH ProcessDirector to send the printer PostScript, or JDF job tickets with the PDF files.
These printer objects can be defined on Linux primary and secondary servers and on Windows application servers.
You cannot use some of the RICOH ProcessDirector job actions (such as Jump to) with jobs that have been submitted to Ricoh PDF printers.
When you use the Stop job action:
  • Depending on the control unit of the printer, the job stops printing.
  • RICOH ProcessDirector stops sending segments of multiple-segment jobs to the printer.
Ricoh TotalFlow
Ricoh TotalFlow printer objects represent printers that use TotalFlow Print Server.

When some models of Ricoh TotalFlow printers print a job, they send ink usage information to RICOH ProcessDirector. To determine whether your printer supports this feature, consult the printer documentation.

Xerox PDF
Xerox PDF printer objects represent printers that can print PDF files. This object type is available only if the Cut Sheet Support for Xerox feature is installed.

You can configure some printers to monitor a hot folder for non-IPDS files. You can use RICOH ProcessDirector to copy jobs to the hot folder for the printer. In this case, you do not create a printer object.

You cannot use some of the RICOH ProcessDirector job actions (such as Print again and Jump to) with jobs that are submitted to the hot folder for a printer.

1.2.1.2.2.8 Locations

A location is an object that you create to represent a geographical or physical location, such as a name city or a room number in a building. You can also create locations to reflect limited-access spaces, such as a secure print area where sensitive jobs are produced. After you create locations, you can use them to restrict access to objects. Many objects have a Location property, including printers and jobs.

Location settings apply to both the Main page and the Administration page. Administrators determine what locations each user is allowed to see. Users can then select which locations to show using the Preferences dialog. Administrators can also prohibit users from changing the locations they choose to show.

1.2.1.2.2.9 Media objects

Media objects represent the paper, forms, or envelopes that jobs are printed on. RICOH ProcessDirector uses them to determine the media that jobs request and to schedule jobs to printers.

RICOH ProcessDirector has two types of media objects:

System media
Represents the media that is specified for jobs and that can be used for all printers.
Printer media
Represents the media that is used with a specific printer.

System media and printer media might have different names for the same physical media. If the media names are different, you can create a media mapping to indicate that they represent the same physical media.

A media object includes various properties that describe the physical media that can be loaded in a cut sheet printer. Properties for media objects include size, color, weight, and other characteristics. RICOH ProcessDirector provides several predefined system media objects that you can use. You can also define your own media objects or have RICOH ProcessDirector create them for you.

If you have the Preprinted Forms Replacement feature, media objects include properties for electronic forms. A step in your workflow can add an electronic form to job data to create a print file that can be printed on plain paper.

RICOH ProcessDirector distinguishes between the media that a printer supports and the media that are currently loaded in a printer.

  • If a media object is supported, the printer can print on that media. However, the media is not necessarily loaded in any input tray.
  • If a media object is ready, it is currently loaded in an input tray.

When you load new media in the input trays on a printer, you might need to update the media ready for the printer device. To see if the media was updated automatically, use the Show Trays action on the printer.

1.2.1.2.2.10 Notifications

Notification objects define the events that cause the system to generate notifications. You can define any number of notification objects based on the needs of your shop.

Email notifications send emails to specified individuals or groups based on the occurrence of specified events. The Archive feature adds history record notifications. History record notifications collect timestamps for job state changes. You can choose which changes to record and under what conditions, such as certain step names or workflows. The Web Services Enablement feature adds Web service notifications. Web service notifications call a web service when specific input device, job or printer events occur.

Email notifications

When you create an email notification object, you can specify:

  • The event that causes the system to send the notification.
  • The subject line and content of the email that is sent, including variable inserts such as the input device name, printer name, job name, or other properties.
  • Who should receive the notification, including carbon copies and blind carbon copies.
  • The conditions that determine when the notification email is sent. For example, you can set up one notification object to monitor when a printer enters the Needs attention state and send a notification email to one group if the printer problem occurs between 8:00 and 12:00. You can define a different notification object to send the same email to a different user if the printer problem occurs after 12:00.
  • A limit for the number of messages you want to receive within a specified time period.

After you create an email notification object, you can use the Test function to check that the correct message was sent to the specified users.

History record notifications

When you create a history record notification object, you can specify:

  • Which job states are monitored.
  • What changes to those job states trigger the object to write a history record.

When the history records are written, they contain the following information:

  • Step - The name of the step the job was in when the record was triggered.
  • Event type - One of three values you specified for a state change: ChangedTo, ChangedFrom, and Changes.
  • State - The job state that is being tracked.
  • Phase - The workflow phase the job was in when the record was triggered.
  • Workflow - The workflow processing the job.
  • Time event occurred - The time the event occurred (as a timestamp).
  • Name - Name of the history record notification object that wrote the record.
You cannot see history records until you store them in an archive. To see the history records, from the Archive tab, specify the job and document properties you used to write the history records in the repository and click Search. Click the ID of the result and then click the History tab to see the data in the history records.

Web service notifications

When you create a Web service notification object, you can specify:

  • The URL of the Web service that the notification communicates with.
  • The payload the Web service passes to the external application.
  • The static credential or authentication request required to use the other application.

    When setting a static credential, the authentication request properties are not used. If you need to authenticate before calling the desired Web service, use the Authentication URL and Authentication payload properties.

  • If the Web service uses a proxy to communicate through.
  • The event that causes the system to send the notification.
  • The conditions that determine when the notification web service call is executed. For example, you can set up one notification object to monitor when a job completes printing and send a communication over web services to tell the application that submitted the job that it has printed. You can request that the web service call only be sent if the job is from a certain customer or has a specific filename.

1.2.1.2.2.11 Users and groups

All RICOH ProcessDirector users must have a unique RICOH ProcessDirector user name and password and must belong to at least one RICOH ProcessDirector group.

The group controls which tasks and actions the user can access and do. RICOH ProcessDirector provides these groups:

Administrator
Administrators can access all functions and interfaces. They can create and configure all RICOH ProcessDirector objects, such as input devices and printers. They can also create and modify the workflows that control the processing that RICOH ProcessDirector does for all jobs.
Supervisor
Supervisors can access the Administration page of the RICOH ProcessDirector user interface, but they cannot create RICOH ProcessDirector objects or edit the properties of all the objects that they can see. They can disable and enable printers and change printer properties. They can also change all job properties.
Operator
Operators cannot access the Administration page of the user interface. They can change a subset of job properties, such as the requested printer, and do actions on printers, such as enabling, disabling, and changing scheduling properties. They can also do most of the available job and input device actions.
Monitor
Monitors have view-only access to the RICOH ProcessDirector system. They can see job properties and input files, see the candidate jobs for a printer, and change their own passwords, but they cannot do any other actions. They cannot see the contents of jobs or access the Administration page.

You can be a member of more than one user group. If you are a member of more than one user group, you are granted the highest level of authority from the groups you belong to. For example, if you are a member of both the Supervisor and Operator user groups, you retain all the access privileges of the Supervisor user group. Which means that you can do actions that a typical member of the Operator group cannot do.

You can also create your own groups.

1.2.1.2.2.12 System user and group

When you install RICOH ProcessDirector on an UNIX-based system, the installation program creates a RICOH ProcessDirector system user as a member of the RICOH ProcessDirector group. You use the system user to log in to the system that RICOH ProcessDirector runs on.

During installation on an UNIX-based system, you can use the default names that RICOH ProcessDirector assigns for the system user, aiw1, and the RICOH ProcessDirector group, aiwgrp1. On a Windows system, RICOH ProcessDirector does not assign a default RICOH ProcessDirector system user name and group. Instead, the installation program prompts you for the system user and group names.

If you need to follow your company's naming requirements, you can do one of these:

  • Create your own RICOH ProcessDirector group and system user before the RICOH ProcessDirector installation and then specify them when prompted during the installation. You must create the RICOH ProcessDirector group first so the system user is created as a member of the group.
  • Specify your own RICOH ProcessDirector group and system user when prompted during the installation.
The RICOH ProcessDirector system user and group you specify will have the same authorities as the default aiw1 system user and aiwgrp1 group.

Note: You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.

To create your own RICOH ProcessDirector group and system user before installation:

  1. Log in as the root user.
  2. Enter this command to create a group on a Linux computer:
    • groupadd group_name
  3. Enter this command on a Linux computer, to create a system user that is a member of the group you just created:
    • useradd -g group_name -d home_dir user_name
    Note: The system user is put in the /home/user_name directory. Specifying the home directory, home_dir, is optional. If it is not specified, the commands use for Linux the default home directory that is set in /etc/default/useradd.
  4. Install RICOH ProcessDirector. When prompted during the installation, enter the group and system user names you created.

1.2.1.2.2.13 Credentials

A credential object specifies the user authentication information required to access an SFTP server or another application. You can use credentials with input devices, steps, and data transmitters that need access to other servers or applications.

If multiple input devices or steps access the same SFTP site with the same credentials, you can specify the user authentication information once in the Credential object and then select that credential in the step or input device that needs it.

RICOH ProcessDirector provides support for the following types of credentials:

Credentials for input devices and steps
Password
Password credentials use a user name and password for authentication.
SSH Key
SSH key credentials require a private key in OpenSSL (traditional SSLeay) or PKCS#8 format. Different utility programs to generate SSH keys are available on each operating system.

If the credentials change and you have multiple input devices or steps that use the same ones, you can edit the Credential object and the new values will be used automatically in all of those places.

Credentials for data transmitters
Static
Static credentials use an authorization code to connect to an application. A user or application can use the same credential repeatedly.
Session
Session credentials use a password to connect to an application and retrieve temporary authentication data, such as a token. The token is valid for the current communication session with the application and then it expires.
Ricoh cloud
Ricoh cloud credentials use a one-time code to generate a certificate. When the certificate is obtained, it can be used to connect to Ricoh cloud applications, such as RICOH Supervisor. The RICOH Supervisor Connect feature adds support for the Ricoh cloud credential type.

1.2.1.2.2.14 Step resources

A step resource identifies a file that is used by a workflow step for its processing. Some step templates allow you to specify a file for the step to use when processing jobs. Some of these files might be created on your workstation but need to be available to the workflow when it processes jobs. You can view, retrieve, and replace the file by editing the step resource object.

For example, the RICOH ProcessDirector Plug-in for Adobe Acrobat is used inside Adobe Acrobat Professional to identify documents within a PDF file and extract document properties for each document in a PDF job. The plug-in produces a control file that is used by the IdentifyPDFDocuments step. To have the file ready when the step runs in a workflow, you create a Step resource object by uploading the file. Then you select that step resource as a value for the Identify PDF control file property on the IdentifyPDFDocuments step.

1.2.1.2.2.15 Custom job and document properties

Custom properties are properties that are unique to your implementation of RICOH ProcessDirector. You create them when the standard job and document properties do not meet your needs.

When you define custom properties, you choose the database name and the label that displays in property notebooks and column headings. You also choose what kind of data is stored in the property, such as integers, numbers, or strings, and the default access that the different user groups have for the property. For document properties, you can also decide whether the values are stored in the database or just in the document properties file, to save space and minimize processing requirements.

After you create a property, you have to activate it. After it is activated, you can use the property just as you would with any other job or document property. You can set a value for it, add it as a table column, view it in a property notebook, or use it in custom portals or in conditions on connectors.

If you need to change the definition of a custom property, you need to deactivate it before changing it. When you reactivate the custom property, you must reconnect it to all the objects it was connected before.

When you create custom properties, the property definitions are stored as system objects. As a result, you can import and export the customized properties or migrate them to another system.

1.2.1.2.2.16 Log

You can use the system log to view messages and other information about the primary RICOH ProcessDirector system.

The system log page lets you specify what type of information you want to look at (All log entries, Error messages, Messages, Property Changes, or State changes) and the time frame that you are interested in (in hours or days).

1.2.1.2.2.17 Barcode format objects

Barcode format objects help RICOH ProcessDirector interpret barcodes that you scan while jobs are processing. When your barcode format objects are configured correctly, you can scan a barcode and use the information in it to find a document in RICOH ProcessDirector.

For example, an operator must reprint documents that are damaged during insertion. The operator uses the Reconcile action and selects By barcode scan in the Search for documents area. Then, the operator selects the name of the barcode format and scans the barcodes that are printed on the damaged documents. The barcodes include the value of the Document number property and the barcode format identifies where to look in the barcode to find that value. When all the documents are scanned, RICOH ProcessDirector displays the list of documents on the Reconcile dialog so the operator can reprint them.

Barcode formats are used:

  • In the Documents portlet on the Main page. Select By barcode scan and click Edit (image of the edit icon).
  • On the Reconcile Job dialog as described in the example.

When you define a barcode format object, you list the job and document property values that are included in your barcodes. For each property, you must also specify:

  • The starting position of the property value in the barcode. The first character that the camera or barcode scanner reads is position 1.
  • The length of the property value in the barcode.

    Note:
  • The barcode format must match the configuration of the camera or barcode scanner hardware. If the camera or barcode scanner is configured to read only one property in the barcode, in the barcode format specify that this property starts in position 1. For example, a document property starts in position 10 in the full barcode. The camera or barcode scanner is configured to read only characters 10 through 25. In the barcode format, specify that the document property starts in position 1.

These job and document properties are useful for finding documents in the system:

  • Document number

    The number that RICOH ProcessDirector assigns to each document.

  • Job number

    The number that RICOH ProcessDirector assigns to a job.

  • Insert sequence

    The position of the document in the job.

  • Inserter job name

    The inserter job name for the job.

  • Sequence in child job

    The sequence of the document in the child job. If the job is the original job, the value is the same as the Sequence in original job property. Use the child property to account for changes that occurred in other steps such as sorting or splitting a job.

The barcode format identifies only the RICOH ProcessDirector properties in the barcode. It does not identify any other data in the barcode.

Some barcodes contain values for multiple job or document properties. However, a barcode format only has to interpret entries for the properties that are required for the current task. You have to define the job or document properties that you want to use when you search for a document.

For the Inserter feature: If the barcode contains a value for the Document number property, the barcode format does not need to define any other job or document property in the barcode. The document number identifies each document in the system. If the barcode format contains the Document number property, RICOH ProcessDirector ignores any other job and document properties in the barcode format.

For the Automated Verification feature:

  • The barcode on each document must include the values of the Job number and Sequence in child job properties. The barcode format must identify where the values for those two properties are located in the barcodes.
  • You must plan for the child jobs created for reprints. Make sure that the barcode symbology you use allows the period character ( . ). Every child job that is created for reprinting includes at least one period character. If you install only one camera or barcode scanner and read all barcodes in the same location on an envelope, one barcode format should be all you need for the system. If other data is included in the barcode and that data is not easy to standardize across applications, you might need to create more than one barcode format. However, the values of the Job number and Sequence in child job properties must be in the same positions in the barcode for all barcode formats used for the same barcode reader.

1.2.1.2.2.18 Barcode readers

Barcode readers represent the cameras and barcode scanners in your Automated Verification installation that read barcodes on documents in a print job to verify that each document has been processed.

You must create one barcode reader for each camera or barcode scanner. The same combination of IP address and port can only be used by one barcode reader.

You associate the barcode reader with one or more barcode formats. The barcode format identifies where the Job number and Sequence in child job properties are found in the barcode on each document. You use two different barcode formats if a barcode reader must read two different types of barcodes. The Job number and Sequence in child job properties must be in the same position in the barcode for all the barcode formats used by this barcode reader.

Barcode readers can be disconnected manually from the Barcode reader portlet on the Main page. However, they might become disconnected if the camera or barcode scanner is powered off or cannot be reached on the network. If the barcode reader is not connected to RICOH ProcessDirector when some barcodes are read, the information about those documents is not available and might need to be read again.

If the barcode reader scans a barcode that it cannot recognize using any of the available barcode formats, an alert is shown in the Barcode Readers portlet to indicate that an invalid scan was detected. Use the barcode reader log to investigate the problem. Use the Clear Alert action to remove the alert from the barcode reader in the portlet.

RICOH ProcessDirector provides a predefined barcode reader that you can use as a sample.

1.2.1.2.2.19 Data Collectors

Data collector objects capture property values during job processing and store them in a PostgreSQL database created by the Reports feature. You can access that data and use it as input to your business intelligence software.

Data Collectors let you configure:

  • The database table where the property values are stored.
  • The retention period for the captured data.
  • Job, printer, device, and user property values to capture.

You cannot store positional job properties in the Reports database. To determine whether a property is positional, check the help for that property.

RICOH ProcessDirector provides these data collectors that you can configure to meet your needs:

Job Step Duration
Lets you measure how long each step was in the queued and processing states, as well as the total duration for each step to complete processing.
You can also select job properties to capture at the end of each step along with the step duration information.
Job Step Progress
Lets you select the job properties that are captured at the start and completion of each step in the workflow.
You can use this data collector along with the WritePropsToReportsDatabase step to collect job and document properties.
Job Print Progress
Lets you select the job and printer properties that are captured when a job starts printing and when it finishes printing successfully, or if an error occurs.
Printer Status
Lets you select the printer properties that are captured each time that the Enabled status or Printer status changes.
User Actions on Barcode Readers
Lets you select the barcode reader and user properties that are captured when a user does an action on a barcode reader.
User Actions on Input Devices
Lets you select the input device and user properties that are captured when a user does an action on an input device.
User Actions on Inserters
Lets you select the inserter and user properties that are captured when a user does an action on an inserter.
User Actions on Jobs
Lets you select the job and user properties that are captured when a user does an action on a job.
User Actions on Printers
Lets you select the printer and user properties that are captured when a user does an action on a printer.
User Actions on Users
Lets you select the target user and user properties that are captured when a user does an action on a target user.
Workflow Step Collector
Lets you manage the data stored by the WritePropsToReportsDatabase step.
Collect the values of document properties using the WritePropsToReportsDataBase step. You can include the step multiple times in a workflow to track changes in the value of the documents. The supplied Workflow Step Collector manages the job and document property data stored by the step.

1.2.1.2.2.20 Data Transmitters

Data transmitter objects let you configure what data in the PostgreSQL database created by the Reports feature to send to another application.

RICOH ProcessDirector provides these data transmitter types:

REST Transmitter
REST transmitters use the REST protocol to send the data to another application. Data is stored in a separate file for each database table.
RICOH Supervisor Transmitter
RICOH Supervisor transmitters send data only to RICOH Supervisor.
The RICOH Supervisor data transmitter is added by the RICOH Supervisor Connect feature.

Data transmitters let you configure:

  • The database tables from which to extract information.
  • The credential used to authenticate with the target application.
  • The schedule for when and how often the data is sent.

If you use REST transmitters, you can also send data manually, using the one-time transmission function. If you send a one-time transmission, you can send all of the data in the Reports database for a specific time period or all of the data since the last successful transmission.

    Note:
  • If you send all data since the last successful transmission, the transmission is treated the same as a scheduled transmission. The next scheduled transmission does not include data sent in this type of one-time transmission.
  • However, if you send the data for a specific time period, the transmission is treated as an exception. In the next scheduled transmission, the data might be included.

1.2.1.2.2.21 Documents

A document is the smallest unit that can be tracked by a workflow. For example, a document can be a set of pages that make up one bill, one statement, or one mailpiece.

A print file can contain thousands of documents. If the print file is in AFP format, each document is bounded by the Begin Page Group and End Page Group AFP structured fields.

1.2.1.2.2.22 Inserter controller objects

Inserter controller objects represent the inserter controllers in your installation. An inserter controller is software that runs on another computer (such as a Windows computer) and can manage several inserter devices that insert printed documents and additional inserts (such as marketing materials) into envelopes.

You create at least one inserter controller object for each inserter controller and associate the appropriate inserter controller object with jobs. To specify different properties for different applications, create several inserter controller objects for one inserter controller.

The inserter controller object controls how RICOH ProcessDirector communicates with the inserter controller and how it reprints documents after insertion. The inserter controller object defines:

  • The script or command for sending control files to the inserter controller, and the script for receiving results files from the inserter controller
  • The rules for writing control files and for interpreting results files
  • The default insert status for documents that have no reported status
  • The completion method for determining when the inserter controller has finished inserting a job
  • The reprint method for reprinting documents that were damaged during insertion

1.2.1.2.2.23 Repositories

Repository objects hold job and document data that you want to store so you can retrieve it later. When you retrieve the job or document information, you can view the job, submit it again, or review detailed information about the job or document and its processing history. You can create multiple repositories, each with a unique retention period.

When you create a repository object, you can specify:

  • The retention period for the repository. Objects older than the retention period are deleted by the system.
  • The path to the file system or directory for the repository folder. This file system or directory can reside on the local machine or on a mounted drive anywhere on your network.
  • A repository location. This value can be used to control who can retrieve files from the repository.
The job and document properties to be used in retrieving jobs, documents, and history information from the repository are specified in the StoreInRepository step of the workflow. Job history information is recorded by a history record notification object. You can specify whether the StoreInRepository step saves the history information as well as the job and document data.

RICOH ProcessDirector supplies a sample repository that you can use to experiment with storing and retrieving jobs and documents.

1.2.1.2.2.24 Service policies

A service policy defines job checkpoints and the service level agreement (SLA) deadline. Checkpoints let you track the progress of jobs as they flow through the system; the SLA deadline represents the time that the job must complete a specific processing step to meet your commitments to your clients.

Examples of performance commitments are:

  • Jobs will be printed 4 hours after they arrive in the system.
  • Jobs will be printed by 18:00 on the day they arrive if they arrive in the system before 10:00. Otherwise, they will be printed by 18:00 the next day.
  • Jobs will be ready to mail by 16:00 on the day after they arrive.

In addition, a service policy specifies whether RICOH ProcessDirector should adjust the job checkpoints and deadline to skip over any times when services are not provided, such as holidays and weekends. RICOH ProcessDirector can make sure that the job checkpoints and any deadlines do not occur during no-service periods.

Each service policy defines job checkpoints and an SLA that apply to one specific performance commitment. For example, if an installation has three performance commitments for different types of jobs or for different clients, the administrator would create three service policies.

The administrator can associate each service policy with one or more workflows. As each job arrives in the system, RICOH ProcessDirector uses the service policy that is associated with the workflow to set checkpoints and a deadline for the job.

1.2.1.2.2.24.1 SLA deadline

The SLA deadline represents your ultimate commitment to your clients. It is the time by which a job must complete the processing step that the SLA measures.

Most jobs do not have to complete their workflows to meet the requirements of their SLA. For example, some jobs could meet the requirements of their SLA if RICOH ProcessDirector prints them by a certain time. The jobs could stay in the RetainJobs step for 72 hours after they have been printed. The requirements of the SLA have been satisfied when the jobs finish printing.

When you define a service policy, you include information that RICOH ProcessDirector uses to calculate the SLA deadline. RICOH ProcessDirector supports these deadline calculation methods:

  • Elapsed time

    Calculates the deadline by adding the value of the SLA duration property to the checkpoint start time for the job. The checkpoint start time is when the job started processing for the purposes of the SLA.

  • Specific time

    Calculates the deadline using the Number of days and SLA target time properties. The SLA deadline is set at a specific time, regardless of the time the job arrived in the system.

    Note:
  • RICOH ProcessDirector calculates the SLA deadline only when you choose a deadline calculation method and enter values for the corresponding properties.
  • SLA deadline does not use estimated durations or the deadline set by the Change Deadline action or a SetDeadline step in the workflow that processed the job.

RICOH ProcessDirector lets you choose a step in a workflow to represent the end point of the SLA commitment. That step is the SLA target step. The SLA target step could represent:

  • When the job finishes printing.
  • When the printed output is delivered to the inserter line.
  • When the job has been inserted and is ready to be picked up.

When a job completes the SLA target step, RICOH ProcessDirector records the time as the SLA target step time and compares it to the SLA deadline to determine the SLA outcome:

  • If the job completes the target step before the SLA deadline, the SLA outcome is recorded as Met.
  • If the job does not complete the target step before the SLA deadline, the SLA outcome is recorded as Missed. RICOH ProcessDirector adds a black dot to the Schedule risk column for the job in the Jobs table.

    You cannot change the SLA outcome after is has been calculated.

1.2.1.2.2.24.2 Checkpoints

A service policy can define job checkpoints that occur at the end of a processing phase. Examples are the Receive, Prepare, Print, and Complete phases. A job checkpoint always occurs at the end of a phase.

In general, a service policy defines job checkpoints for at least two phases: a checkpoint for the final phase and one or more checkpoints for intermediate phases. Checkpoints for intermediate phases let you find jobs that are late before they miss the checkpoint for the final phase.

For example, a service policy could define a checkpoint at the end of the Prepare phase and a checkpoint at the end of the Print phase. If an error (for example, a transform error) occurs during the Prepare phase, RICOH ProcessDirector marks the job Late when it misses the Prepare checkpoint. A yellow dot appears in the Deadlines portlet and in the Schedule risk column for the job in the Jobs table. If the operator can correct the error, the job could complete printing on time. If the job completes the Print phase before the Print checkpoint, the checkpoint status changes back to OK. The yellow dot is removed.

A service policy does not need to define a job checkpoint for each phase. A service policy might not define a checkpoint for these types of phases:

  • Phases that do not contain any steps (for example, the Prepare phase).
  • Phases where errors are not likely to occur (for example, the Receive phase).
  • Phases that occur after jobs have met the performance objective (for example, the Complete phase).

1.2.1.2.2.24.3 Checkpoint intervals

For each checkpoint that the service policy defines, the service policy specifies a time interval. The interval is the amount of time that you expect a job to take to complete a phase. The interval does not include estimated durations set for steps in the workflow.

The interval for each phase starts from the checkpoint start time, which is the same time for all intervals. The checkpoint start time is one of these times:

  • The time that the last file for a job arrives in the system (the Job arrival time). If child jobs are created for the job, they have the same job arrival time as the parent job.
  • A start time set by RICOH ProcessDirector or by an authorized user (the Adjusted arrival time).
  • A fixed start time specified in the service policy (the Service policy start time).

By default, the adjusted arrival time is the same as the job arrival time. RICOH ProcessDirector might set a new adjusted arrival time:

  • When a job is assigned to a new workflow
  • When a job enters a certain step
  • When a job is split or commingled

A service policy might specify a fixed start time if all jobs must be printed by a fixed time. For example, if all jobs must be printed by 10:00 the next day, the service policy specifies a start time of 10:00 and an interval of 24 hours for the Print phase.

When a service policy specifies a fixed start time, it can specify one of these adjustment methods. The Adjustment method tells RICOH ProcessDirector how to adjust the checkpoint start time. The adjustment methods are:

  • Cutoff: The checkpoint start time depends on whether the adjusted arrival time is before or after the service policy start time. If the adjusted arrival time is:
    • Before the service policy start time, the checkpoint start time is the service policy start time on the same day as the adjusted arrival time
    • After the service policy start time, the checkpoint start time is the service policy start time on the next day
    If the adjusted arrival time changes, the checkpoint start time might also change.
  • Start: The checkpoint start time is the start time specified in the service policy on the same day as the adjusted arrival time.

This diagram shows how the checkpoint start time and the intervals for successive phases relate to each other. Notice that the interval for each phase starts from the same checkpoint start time, not from the end of the previous phase. Therefore, the interval for each phase includes the time that it takes to complete all previous phases.

Checkpoint start time <- Receive interval -> End of Receive phase
Checkpoint start time <-- Prepare interval --> End of Receive + Prepare phases
Checkpoint start time <--- Print interval ---> End of Receive + Prepare + Print phases
Checkpoint start time <---- Complete interval ----> End of Receive + Prepare + Print + Complete phases
Note: You can change the phase names to match the functions that you do in that phase better.

These examples show sample start times and intervals that a service policy might specify when using different adjustment methods.

No adjustment method: In this example, jobs must be printed 4 hours after the adjusted arrival time. Because the adjustment method is None, the checkpoint start time is the same as the adjusted arrival time. If the adjusted arrival time has not been reset, it is the same as the time the job arrived in the system.

Start time: not specified
Adjustment method: None
Interval for Receive checkpoint: 20 minutes
Interval for Prepare checkpoint: 2 hours
Interval for Print checkpoint: 4 hours
Job arrival time <- Receive interval = 20 minutes -> Job arrival + 20 minutes
Job arrival time <--- Prepare interval = 2 hours ---> Job arrival + 2 hours
Job arrival time <------ Print interval = 4 hours ------> Job arrival + 4 hours

Cutoff adjustment method: In this example, jobs must be printed by 18:00 if the adjusted arrival time is before 10:00. Otherwise, the job must be printed by 18:00 on the next day. Because the adjustment method is Cutoff, the checkpoint start time is the start time (10:00) on the same day as the adjusted arrival time or on the next day.

Start time: 10:00
Adjustment method: Cutoff
Interval for Receive checkpoint: 20 minutes
Interval for Prepare checkpoint: 4 hours
Interval for Print checkpoint: 8 hours
10:00 <- Receive interval = 20 minutes -> 10:20
10:00 <------ Prepare interval = 4 hours ------> 14:00
10:00 <------------ Print interval = 8 hours ------------> 18:00

Start adjustment method: In this example, jobs must be printed by 16:00 on the day after the adjusted arrival time. Because the adjustment method is Start, the checkpoint start time is the start time (23:59) on the same day as the adjusted arrival time.

Start time: 23:59
Adjustment method: Start
Interval for Receive checkpoint: 20 minutes
Interval for Prepare checkpoint: 4 hours
Interval for Print checkpoint: 16 hours
23:59 <- Receive interval = 20 minutes -> 00:19
23:59 <------ Prepare interval = 4 hours ------> 03:59
23:59 <------------------ Print interval = 16 hours ------------------> 15:59

Note: In these examples, each service policy defines a final checkpoint for the Print phase and intermediate checkpoints for the Receive and Prepare phases. The intermediate checkpoints let you find jobs that are late before they miss their final checkpoint. For example, if an error (such as a transform error) occurs during the Prepare phase, RICOH ProcessDirector marks the job late when it misses the Prepare checkpoint. If the operator corrects the error, the job might be able to complete printing on time.

1.2.1.2.2.24.4 Checkpoint times

For each job that has an associated service policy, RICOH ProcessDirector records planned checkpoint times. In addition, it records actual checkpoint times for all jobs, even for jobs that do not have an associated service policy.

The checkpoint times are:

  • Planned checkpoint time: The date and time when the job is expected to complete a phase. RICOH ProcessDirector calculates each planned checkpoint time by adding the time interval for the phase to the checkpoint start time. If the checkpoint start time changes, the planned checkpoint times change accordingly.
  • Actual checkpoint time: The date and time when the job actually completed the phase.

RICOH ProcessDirector displays these checkpoint times in the property notebook for each job that is in the system. After a job is removed from the system, the audit file for the job (jobnumber.yy-mm-dd_hh-mm-ss.positional_attributes.csv) contains the checkpoint times.

This example shows sample planned and actual checkpoint times for a job that has completed the Print phase and is currently in the Complete phase.

Checkpoint Planned checkpoint time Actual checkpoint time
Receive:   1/8/07 09:20:22
Prepare: 1/8/07 12:00:00 1/8/07 10:00:30
Print: 1/8/07 14:00:00 1/8/07 12:00:59
Complete:    

Sometimes, checkpoint times are blank:

  • Planned checkpoint time: The service policy does not define a checkpoint for a phase. In this example, the Receive and Complete checkpoint times are blank because the service policy does not define a Receive or Complete checkpoint.
  • Actual checkpoint time: A job has not completed a phase, or a job does not flow through a phase. The actual checkpoint time for the Complete phase is usually blank when the job is still in the system.

RICOH ProcessDirector can update the planned and actual checkpoint times when you reprocess a job:

  • Planned checkpoint times: If you use the Process Again action to reprocess a job from the first step and the properties of the service policy or no-service periods have changed, RICOH ProcessDirector calculates new planned checkpoint times for the job.
  • Actual checkpoint times: If you use the Print Again or Process Again action to reprocess a job and the service policy specifies Yes in the Reset on reprocess property, RICOH ProcessDirector records new actual checkpoints for the phases that the job completes again.

1.2.1.2.2.24.5 No-service periods

RICOH ProcessDirector can adjust the planned checkpoint and SLA deadline times so they do not occur during periods when your installation does not provide services. For example, you might not provide services on holidays and weekends. These periods are called no-service periods. You define these periods in no-service period objects.

Note: No-service periods are not considered for deadlines set with the SetDeadline step or the Change Deadline action.
Each service policy specifies whether to adjust planned checkpoints and the SLA deadline for the no-service periods. For example, if you provide services during no-service periods only for express jobs, the service policy for express jobs would specify not to adjust planned checkpoints, while other service policies would specify to adjust planned checkpoints.

These examples show how RICOH ProcessDirector adjusts the checkpoint start time, planned checkpoint times, and SLA deadline for no-service periods.

Job arrives during a no-service period: In this example:

  • January 1 is defined as a no-service period.
  • The interval for the Prepare checkpoint is 2 hours.
  • The interval for the Print checkpoint is 1 day.
  • The checkpoint start time is the time the job arrives in the system.
  • To meet its deadline, the job must be delivered to the inserter line 28 hours after it arrives.
  • The job arrived in the system on January 1, 2007 (01/01/2007) at 10:00:00.
Checkpoint/Deadline times Not adjusted for no-service periods Adjusted for no-service periods
Checkpoint start: 1/1/07 10:00:00 1/2/07 00:00:00
Planned Prepare: 1/1/07 12:00:00 1/2/07 02:00:00
Planned Print: 1/2/07 10:00:00 1/3/07 00:00:00
SLA deadline 1/2/07 14:00:00 1/3/07 04:00:00

Checkpoint interval includes a no-service period: In this example:

  • Every Saturday is defined as a no-service period.
  • The interval for the Prepare checkpoint is 2 hours.
  • The interval for the Print checkpoint is 1 day.
  • The checkpoint start time is the time the job arrives in the system.
  • To meet its deadline, the job must be ready to be sent to the post office 72 hours after it arrives.
  • The job arrived in the system on January 5, 2007 (01/05/2007) at 10:00:00.
Note: January 6, 2007 is a Saturday.
Checkpoint/Deadline times Not adjusted for no-service periods Adjusted for no-service periods
Checkpoint start: 1/5/07 10:00:00 1/5/07 10:00:00
Planned Prepare: 1/5/07 12:00:00 1/5/07 12:00:00
Planned Print: 1/6/07 10:00:00 1/7/07 10:00:00
SLA deadline 1/8/07 10:00:00 1/9/07 10:00:00

If you delete a no-service period, checkpoint times and the deadline for jobs that are already in the system do not change, even if they were set using that no-service period. To reset the checkpoints and deadline, you must reprocess the job from the beginning.

1.2.1.2.2.24.6 Time zones

The service policy specifies the time zone where jobs are printed. If jobs are printed in more than one time zone, you must create a service policy for each time zone.

For example, if jobs are printed in the US/Eastern time zone and the US/Mountain time zone, you must create two service policies, one for each time zone. These service policies can be exactly the same except for the name of the service policy and the time zone.

1.2.1.2.2.24.7 Checkpoint status

RICOH ProcessDirector periodically calculates a checkpoint status for each job as it progresses through the system. The checkpoint status helps you find jobs that are late meeting their checkpoints.

The checkpoint status can be one of these values:

Late
The job has missed the next planned checkpoint, or the job missed the last planned checkpoint.
OK
The job is on schedule to meet the next planned checkpoint. However, it could have missed a previous checkpoint.

When the checkpoint status for a job is Late, RICOH ProcessDirector adds a yellow dot in the Deadlines portlet and in the Schedule risk column for the job in the Jobs table.

In addition, RICOH ProcessDirector can display the checkpoint status as a column in the Jobs table so the operator can use the Filter function to display jobs with a value of Late for the Checkpoint status property.

After a job is removed from the system, the audit file for the job (jobnumber.yy-mm-dd_hh-mm-ss.policy_properties.cfg.csv) can contain the final checkpoint status.

1.2.1.2.2.25 No-service periods

A no-service period defines a period of time when an installation does not provide services (for example, a holiday). No-service periods work together with service policies but are not considered for deadlines set by the SetDeadline step or the Change Deadline action.

Each service policy specifies whether all the no-service periods apply to the service policy. If they apply, RICOH ProcessDirector adjusts the planned checkpoints of jobs so that they do not occur during the no-service periods.

For example, a service policy for express print jobs might specify not to adjust planned checkpoints for the no-service periods because the installation provides services every day for express print jobs. However, the service policy for regular jobs might specify to adjust planned checkpoints for the no-service periods.

All the no-service periods work together as one unit. A service policy can specify whether all the no-service periods apply to the policy. However, a service policy cannot specify which no-service periods apply.

Examples of no-service periods are:

  • Every January 1
  • August 1, 2008
  • Every Friday from 18:00 to 23:59
  • Every Sunday, all day

If you delete a no-service period, checkpoint times for jobs that are already in the system do not change, even if they were set using that no-service period. To reset the checkpoint times, you must reprocess the job from the beginning.

1.2.1.2.2.26 Expected work

Expected work objects represent jobs that are scheduled to arrive at specific intervals. You can associate expected work objects with input devices so the input devices can monitor for those jobs to arrive. If they do not arrive when they are expected, the system alerts you.

You define expected work as jobs that are expected to arrive in a given time period. The input device counts the number of jobs that arrive and compares them to the expected number of jobs at specific intervals. You can refine the expected work object so it applies to specific types of jobs based on characteristics of the input file name. The input device parses the input file names to see if they match a regular expression and counts only the jobs that match.

    Note:
  • If you use the lpr or lprafp command to submit a job to an LPD input device, the command renames the input file using a format that RICOH ProcessDirector cannot reliably parse. In this case, we recommend using only the Number of jobs expected property on expected work objects and leaving the File patterns property blank.

Expected work objects are particularly useful if your service level agreements (SLAs) with your customers rely on receiving jobs from them by a particular time.

For example, you have a customer who sends you three jobs every day. The SLA states that if the jobs arrive by 8:00 AM, they must be printed by 4:00 PM. You create an expected work object that instructs an input device to check the status at 8:00 AM each day and associate it with the appropriate input device. At 8:00 AM, the input device checks to see how many jobs have arrived:

  • If all three jobs have arrived, processing continues as usual.
  • If one or more of the jobs has not arrived, the Expected work status property of the input device is set to Late and an alert (Alert icon) icon appears to the right of the input device.
You can then use the Show expected work action on the input device to see more information about the work that has not arrived and try to resolve the problem.

You can define expected work objects to check for work at various time intervals based on the SLAs that you must meet. You can associate multiple expected work objects with an input device, so the same input device can monitor for jobs that arrive daily and for jobs that arrive monthly on the first of the month. You can also associate an expected work object with multiple input devices, if they all expect to receive jobs on the same schedule.

1.2.1.2.2.27 Property mapping objects

A property mapping object defines the relationship between the headings in a preferences file and the document properties defined in the system. The property mapping is used by the ApplyPreferences step in a workflow to add or change values in the document properties file (DPF) for the job.

When you define a property mapping object, you map headings in the preferences file to properties in the document properties file. Then you specify one of these Usage values for that pair:

  • Identify document

    This pair is used to find which documents to update in the DPF.

    In the image below, the heading of Account number is mapped to the Member document property and the usage is set to Identify document. When the ApplyPreferences step runs, it reads the preferences file. For each row, it finds the value of the Account number, then searches the document properties file to find the entry that has the same value listed for the Member property.

  • Update property

    These pairs are used to update values in the document properties file. These properties might not have values in the document properties file initially.

    In the image below, the headings Email address and Output type are mapped to document properties with the same names. The Usage for both pairs is set to Update property. When the ApplyPreferences step locates the entry in the DPF whose Member property matches an Account number value, it updates the Email address and Output type properties in the DPF for that entry with the values in the corresponding row of the preferences file.

You must map at least two headings to document properties, one for each Usage type.

The values can be used by other steps in the workflow to group documents for common processing such as one set of documents to email and another set of documents to print.

The same property mapping object can be used by multiple workflows as long as the preferences files contain the same headings. The order of the headings can be different in each preferences file.

1.2.1.2.3 Input file formats

You can submit several types of input files to RICOH ProcessDirector to process and print.

The input file types that can be submitted to RICOH ProcessDirector are:

Advanced Function Presentation (AFP)
A composed format that can contain text, graphics, images, and barcodes. Composition instructions are in the form of Mixed Object Document Content Architecture (MO:DCA) structured fields. AFP resources, such as fonts, can either be stored externally or embedded in the AFP data stream. AFP is the file format RICOH ProcessDirector uses to print jobs on IPDS printers if the AFP Support feature is installed. Without the AFP Support feature, you can view AFP jobs and pass them to other programs.
ABAP
Contains data that is in the SAP Advanced Business Application Programming (ABAP) format.
DBCS ASCII
Contains data that is encoded in a double-byte character set (DBCS) ASCII code page.
DBCS EUC
Contains data that is encoded in a double-byte character set (DBCS) Extended UNIX Code (EUC) code page.
ditroff
Contains device-independent troff (ditroff) data preformatted for an AFP device.
GIF
Contains image data that is in the Graphics Interchange Format (GIF).
Image data
Contains image data that is in the Image Object Content Architecture (IOCA) format.
JPEG
Contains image data that is in the Joint Photographic Experts Group (JPEG) format.
JSON
Contains data that is in the JavaScript Object Notation (JSON) format.
LCDS
Contains data that is in the Xerox line-conditioned data stream (LCDS) format.
Line data
A combination of plain text and formatting controls, such as carriage controls and table reference characters (TRCs) for spacing and font selections. You can instruct RICOH ProcessDirector to use a composition product, such as the line2afp transform that it provides, to process line data input files.
Metacode
Contains data that is in the Xerox metacode format.
Mixed mode
Input files that contain combinations of line data and MO:DCA structured fields. Mixed mode input files can only be processed if the AFP Support feature is installed.
OTF
Contains data that is in the SAP Output Text Format (OTF).
PCL
Contains data that is in the Hewlett-Packard Printer Control Language (PCL) format.
PDF
Contains data that is in the Adobe Portable Document Format (PDF) format.

When RICOH ProcessDirector processes PDF 2.0 input files in a workflow, steps that modify PDF files convert the data to PDF 1.7 format. If no steps in the workflow modify the PDF, the input file passes through RICOH ProcessDirector in PDF 2.0 format. PDF 2.0 files that are sent to a Ricoh PDF or Ricoh TotalFlow printer with banner pages turned on are also converted to PDF 1.7 format.

PostScript
Contains data that is in the Adobe PostScript format.
PPML
Contains data that is in the Personalized Print Markup Language (PPML) format.
TIFF
Contains image data that is in the Tagged Image File Format (TIFF).
XML
Contains data that is in the Extended Markup Language (XML) format.

Depending on your printers, you may need to use data transforms to convert some of these formats into a format that your printers support. Several products provide data transforms:

  • The RICOH Transform features can convert these input file formats to AFP:
    • GIF, JPEG, and TIFF
    • PCL
    • PDF and PostScript
    • SAP OTF and ABAP
    It can convert the following input file format to PDF:
    • AFP

    You must install the AFP Support feature to use the RICOH Transform features.

  • If you have RICOH InfoPrint XT installed on the RICOH ProcessDirector primary computer, secondary computer, or on the same computer as an application server, you can also use it to convert Xerox metacode and LCDS data to AFP. To use InfoPrint XT, include a step that runs the transform program in the appropriate workflow and configure the step to run on the computer where InfoPrint XT is installed.

1.2.1.2.4 Output formats

RICOH ProcessDirector can send jobs to Ricoh TotalFlow printers, Ricoh PDF printers, Custom PDF printers, and to any printer that can receive jobs submitted using the LPD protocol. With the AFP Support feature installed, it can also send jobs to IPDS printers. It can copy print jobs to the hot folders that some printers, such as the InfoPrint 5000 printer, use to receive non-IPDS jobs.

RICOH ProcessDirector supports these output formats for printers:

AFP
With the AFP Support feature installed, RICOH ProcessDirector can send AFP print jobs to IPDS printers. RICOH ProcessDirector can receive status information about the job from those printers and can send requests to the printer. Those requests include interrupting a job that is currently printing or using the Jump to action to move to a different place in the job and resume printing.
PCL
RICOH ProcessDirector can send jobs to PCLOut printers that the printer driver component of the AFP Support feature has converted from AFP to PCL. RICOH ProcessDirector cannot receive status information about the job from those printers.
PDF
RICOH ProcessDirector can send PDF files to Ricoh TotalFlow printers.
If a Ricoh PDF printer supports the data stream, RICOH ProcessDirector can send the printer PDF files.

With the Cut Sheet Support for Kodak feature installed, RICOH ProcessDirector can send PDF files to Kodak PDF printers.

With the Cut Sheet Support for Xerox feature installed, RICOH ProcessDirector can send PDF files to Xerox PDF printers.

PostScript
RICOH ProcessDirector can send PDF files to Ricoh PDF and Custom PDF printers by converting PDF to PostScript.

With the Cut Sheet Support for Kodak feature installed, RICOH ProcessDirector can send PDF files to Kodak PostScript printers by converting PDF to PostScript.

Other
RICOH ProcessDirector can send print jobs in other formats to Passthrough printers. RICOH ProcessDirector cannot receive status information about the job from those printers. It can send requests to the software queue that represents the printer, but not to the printer itself.

To print jobs on printers that have hot folders, you can use a Passthrough printer. Configure the Passthrough printer to copy jobs to a printer hot folder. The hot folder submits jobs to that printer. If you copy a print job to a hot folder, RICOH ProcessDirector cannot receive status information about the job from the printer.

Note: If RICOH ProcessDirector can access the printer hot folder as a mapped drive or mounted file system, you can use a CopytoFolder step. The step submits a job to the printer. However, if you use the CopyToFolder step, you cannot use the Schedule Jobs action to assign jobs to a printer. The CopyToFolder step does not use the Requested printer property that the Schedule Jobs action sets to assign jobs to a printer.

1.2.1.2.5 Job submission methods

You can submit jobs to RICOH ProcessDirector from other systems using FTP, web services, other file copying methods, or a command that uses the LPD protocol. If you have the AFP Support feature installed, you can submit jobs to RICOH ProcessDirector from host systems using Download for z/OS and AFP Download Plus.

Jobs are submitted to input devices that you define. Input devices receive the job and initiate job processing.

The supported job submission methods are:

FTP, SCP, or file copy
You can use an FTP or SCP client, web services, or your preferred file copying method to move print files into a hot folder. You can include a Job Definition Format (JDF) job ticket with the print files. When you copy or move a job to the hot folder directory, the input device that is associated with the hot folder automatically receives the job and initiates job processing.
RESTful web services
You can use a REST web service utility to submit jobs. If you can configure your application to use REST web services, you can use the submitFile utility to submit a file to a workflow or hot folder.
LPD protocol
You can use the lpr command or another command that uses the LPD protocol to submit jobs to a RICOH ProcessDirector LPD input device. Specify the name of the LPD input device as the target printer. For example, the name of the LPD input device is the value of the -P option of the lpr command, or of the -p option of the lprafp command.
Download for z/OS
Download for z/OS is a separately orderable feature of IBM Print Services Facility (PSF) for z/OS. Download for z/OS automatically sends host system output to other systems in the TCP/IP network, such as RICOH ProcessDirector, for further processing.
AFP Download Plus
AFP Download Plus is also a separately orderable feature of PSF for z/OS. It can gather job attributes and print resources, process PSF exits, convert line data to the AFP data stream, package the job, secure the job, and send the job to another system in the TCP/IP network, such as RICOH ProcessDirector, for further processing.

1.2.1.2.6 Jobs with JDF job tickets

When you submit a job to an input device, you can submit a JDF job ticket with it. RICOH ProcessDirector can set many job properties from values in the job ticket. Jobs with JDF tickets work best when configured with Ricoh PDF printers.

RICOH ProcessDirector supports functions defined in the JDF Specification that the system requires, including a subset of the JDF Integrated Digital Printing Interoperability Conformance Specification (IDP ICS) and the associated Application Note. The IDP ICS is based on the JDF combined digital printing process, which is intended for integrated digital printers.

RICOH ProcessDirector does not support all possible values in the JDF job ticket. If RICOH ProcessDirector cannot use a value to set a job property, it will remove unsupported values from the job ticket.

    Note:
  • The IdentifyPDFDocuments step can receive multiple sets of PDF files and job tickets. The step combines them into a single PDF file and a single job ticket. When the step creates the combined job ticket, it includes only values that RICOH ProcessDirector supports. It does not include unsupported values in the combined job ticket. The IdentifyPDFDocuments step is provided by the PDF Document Support feature.

RICOH ProcessDirector synchronizes the job ticket and the job properties notebook to the extent possible whenever the job ticket is requested. If the workflow contains a step based on the RunExternalProgram step template that submits the job to another application, it can submit the JDF job ticket too. The step compares the property values in the job property notebook with the values in the job ticket and updates the values as needed. If the other application changes values that RICOH ProcessDirector supports in the job ticket, RICOH ProcessDirector updates the job properties after the other application processes the job and returns the updated job ticket.

The value of the Media property is a special case, because it depends on the setting for Media Matching:

  • If Media Matching is set to Use media product ID or media name, RICOH ProcessDirector uses one of these media names as the value of the Media property for a job:
    • The name of the media object with the matching product ID specified in the job ticket.
    • The name of the media specified in the job ticket.

    RICOH ProcessDirector first checks whether the job ticket specifies a media product ID. If it does, RICOH ProcessDirector looks for a system media object with the same product ID. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job. If RICOH ProcessDirector does not find a match, it looks for a media object with the media name specified in the JDF job ticket. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job.

  • If Media Matching is set to Use the properties selected below, RICOH ProcessDirector uses the media properties (such as size) listed in the job ticket to search the existing system media objects and find one that matches. When it finds an appropriate media object, the name of that object is set as the value of the Media property for the job.

    You can choose the properties that are used for Media Matching based on the needs of your installation.

    If more than one media object matches, RICOH ProcessDirector tries to determine which one is the best match based on the rest of the media properties in the job ticket, including the name of the media. If the system cannot determine the best match or if no media objects match, the job goes to Error state. You can use the Correct Media action on the job to select the media and move the job out of Error state.

If a job ticket specifies values for media and stapling, you can view and change them in the job properties notebook. On the Scheduling tab, the Media required property lists the media values for both the job and any page exceptions. The Stapling required property shows whether stapling is required. You can set the job values in the Media and Staple properties on the Scheduling tab. You can change the page values on the Page Exception tab using the Page exceptions action.

If a job ticket specifies values for sides exceptions, you can view them using the Page Exceptions action on the job in the user interface. You cannot change the Sides page exceptions.

If you have the PDF Document Support feature, do not modify any media settings when a job is between the IdentifyPDFDocuments step and the BuildPDFFromDocuments step in a workflow.

    Note:
  • Media and stapling values for page exceptions are only applied to PDF jobs with JDF job tickets sent to Ricoh PDF printers or Passthrough printers.
  • Only media values for page exceptions are applied to jobs sent to Kodak PDF printers and Xerox PDF printers. Stapling is not supported for these printers.

The JDF job ticket is stored in the spool directory for the job with the data files. The job ticket is named jobID.overrides.jdf

1.2.1.2.6.1 Understanding page counts in PDF jobs

When a PDF job with a JDF job ticket that specifies a mixture of duplex and simplex pages is processed by the CountPages step, the blank sides of the simplex sheets are not counted in the Total pages property. Some printer controllers cannot process job tickets with these Sides page exceptions.

For those controllers, you can use either the IdentifyPDFDocuments or the BuildPDFFromDocuments step to insert blank pages in the PDF file instead, through the Page exceptions for sides property. Both of those step templates are included in the PDF Document Support feature.

The Page exceptions for sides property has these values:

  • Replace with job value

    All Sides are processed using the Duplex job property. All existing Sides page exceptions in the JDF are removed. If a simplex page is included in a duplex job, a blank PDF page is inserted in the output PDF. The blank page is counted in the Total pages property and could result in a click charge by the printer vendor for that page.

  • Keep values from JDF:

    All the Sides page exceptions in the JDF are included in the JDF produced by the step. The job-level Sides value in the JDF is also used. The blank sides are not included in the Total pages property.

If an AFP or PostScript job is transformed to PDF using the TransformToPDFWithMediaInfo step that is provided with the Advanced Transform feature, any sides settings in the AFP or PostScript are preserved as Sides page exceptions in the JDF output by the transform. Blank sides produced by these page exceptions are not included in the Total pages property.

The JDF job ticket produced by the step includes a Sides page exception for every page in the job. To improve processing speed, add an OptimizeJDF step in the workflow after the TransformToPDFWithMediaInfo step.

1.2.1.2.7 Jobs with XML files

RICOH ProcessDirector can process jobs submitted as XML files. You can submit XML files to a hot folder input device or place an XML file at a location from which the RICOH ProcessDirector server retrieves it.

If you place an XML file at a location from which it is retrieved, RICOH ProcessDirector processes the file as jobs move through the workflow. You submit another type of file to the hot folder to initiate the process. For example, you can submit a print file or a trigger file, such as a file with job overrides or with no content.

Note: The Web Services Enablement feature lets you use SOAP or REST Web service protocols to receive XML data from and exchange it with other applications.

Two step templates manipulate XML:

  • A step based on the CreateJobsFromXML step template creates jobs from elements in an XML file that match an XPath expression.

  • A step based on the ApplyXSLTransform step template transforms XML into a file that specifies the values of RICOH ProcessDirector job or document properties. The step also transforms XML into another XML format.

If an element in the XML files specifies a URL to download a file, you can use the ApplyXSLTransform step to assign the URL to the value of a job property. Then you can use a step based on the DownloadFile step template to download the file.

This usage scenario shows how to process orders in an XML file by setting RICOH ProcessDirector job properties.

1.2.1.2.7.1 Usage scenario for processing orders in an XML file

In this scenario, a printing company wants to process orders in XML files received from web-to-print sellers. Each XML file contains multiple orders, and each order can include both print and promotional items, such as coffee mugs and baseball caps.

In this scenario, the RICOH ProcessDirector administrator uses a third-party tool (such as Altova MapForce) to create Extensible Stylesheet Language Transformations (XSLT) style sheets. For examples of XML input files, XPath expressions, XSLT style sheets, and RICOH ProcessDirector overrides files that work with this scenario, see the related reference.

Reviewing and preparing to process the XML

The RICOH ProcessDirector administrator reviews the contents of the XML files and decides how to process them.

  1. First the administrator identifies the XML elements that supply values for RICOH ProcessDirector job properties.

    In the example XML input file, two XML elements supply information required to track each item in an order. The number attribute of the order element and the customername element supply the order number and customer name.

    For print items, the printfile element supplies the URL of the PDF file to download and print.

    For promotional items, the number attribute of the stock element supplies the location of the item in the warehouse.

    For all items, the quantity element supplies the quantity ordered.

    This table shows these five XML elements and the names of the corresponding RICOH ProcessDirector job properties.

    XML element Database name of job property User interface name of job property
    <order number> Job.Info.Attr1 Custom 1
    <customername> Job.CustomerName Customer name
    <printfile> Job.DownloadFile URL for download file
    <stock number> Job.Info.Attr2 Custom 2
    <quantity> Job.Copies Job copies requested

  2. The administrator breaks the process into five parts:
    • Create a separate XML job for each order.
    • Assign the order values (order number and customername) to job properties.
    • From each order, create a separate XML job for each item.
    • Assign the item values (printfile, stock number, and quantity) to job properties.
    • Process print items and stock items in separate workflows.
  3. The administrator decides to define four workflows:
    • The ExtractOrdersFromXML workflow receives orders and makes separate jobs for each order.
    • The SplitOrderIntoPrintAndStockJobs workflow separates the items in each order into print and stock jobs.
    • The ProcessPrintJobs workflow processes print jobs.
    • The ProcessStockJobs workflow processes stock jobs.

    A step based on the CreateJobsFromXML step template creates jobs from elements in an XML file that match an XPath expression. The step submits the jobs to a workflow.

  4. The administrator decides to use three CreateJobsFromXML steps, each with a different XML Path Language (XPath) expression:
    • The first step creates a separate XML job for each order.

      The Order Jobs expression identifies the XML elements that match orders: /seller/order

    • The second step creates a separate XML job for each print item.

      The Print Jobs expression identifies the XML elements that match print items: /order/item/printfile/ancestor::item

    • The third step creates a separate XML job for each promotional item.

      The Stock Jobs expression identifies the XML elements that match promotional items: /order/item/stock/ancestor::item

    The administrator assigns the CreateJobsFromXML steps to workflows:

    • The first step goes in the ExtractOrdersFromXML workflow. The step submits the XML jobs for each order to the SplitOrderIntoPrintAndStockJobs workflow.
    • The second and third steps go in the SplitOrderIntoPrintAndStockJobs workflow. The second step submits XML jobs for print items to the ProcessPrintJobs workflow. The third step submits XML jobs for promotional items to the ProcessStockJobs workflow.

    A step based on the ApplyXSLTransform step template can transform XML into a RICOH ProcessDirector overrides file that specifies the values of job properties.

  5. The administrator decides to use three ApplyXSLTransform steps. Each step uses an XSLT style sheet. The administrator uses a third-party XSLT tool to create the XSLT style sheets.
    • The first step uses the Order Jobs XSLT style sheet. It converts the name attribute of the order element and the customername element into the Job.Info.Attr1 and Job.CustomerName job properties.

      The step goes in the SplitOrderIntoPrintAndStockJobs workflow before the two CreateJobsFromXML steps.

    • The second step uses the Print Jobs XSLT style sheet. It converts the printfile element and the quantity element into the Job.DownloadFile and Job.Copies job properties.

      The step goes in the ProcessPrintJobs workflow.

    • The third step uses the Stock Jobs XSLT style sheet. It converts the number attribute of the stock element and the quantity element into the Job.Info.Attr2 and Job.Copies job properties.

      The step goes in the ProcessStockJobs workflow.

  6. The administrator decides to use a DownloadFile step to download PDF files from a specified URL.

    Because the printing company uses a proxy server to communicate with external web sites, the administrator sets up RICOH ProcessDirector to use the proxy server.

Setting up the input device and workflows

The administrator sets up a hot folder input device to receive XML files and four workflows to process them.

  1. The ExtractOrdersFromXML workflow creates a job for each order in the XML input file.

    After the SetJobPropsFromTextFile and DetectInputDataStream steps, the administrator adds the CreateJobsFromXML step. The administrator sets the value of the XPath expression to /seller/order and the value of the workflow for new jobs to SplitOrderIntoPrintAndStockJobs. The administrator specifies that new jobs are not created as child jobs. Each order is an independent job.

  2. The SplitOrderIntoPrintAndStockJobs workflow receives each order job, creates XML files for print and promotional items, and submits them as child jobs to the appropriate workflow.

    After the SetJobPropsFromTextFile and DetectInputDataStream steps, the administrator adds an ApplyXSLTransform step. The step uses the Order Jobs XSLT style sheet.

    After the ApplyXSLTransform step, the administrator adds two CreateJobsFromXML steps:

    • For the first step, the administrator sets the value of the XPath expression to /order/item/printfile/ancestor::item and the value of the workflow for new jobs to ProcessPrintJobs.
    • For the second step, the administrator sets the value of the XPath expression to /order/item/stock/ancestor::item and the value of the workflow for new jobs to ProcessStockJobs.
    • For both steps, the administrator specifies that new jobs are created as child jobs. The administrator also specifies that the parent jobs continue to the next step when no child jobs are created. For example, child jobs are not created in the first CreateJobsFromXML step if an order job does not have any print items.

    After the second CreateJobsFromXML step, the administrator adds a step based on the WaitForRelatedJobs step template. This step holds the parent jobs until all the child jobs for print and promotional items have been processed.

  3. The ProcessPrintJobs workflow receives each job for a print item, and prints the items.

    After the SetJobPropsFromTextFile and DetectInputDataStream steps, the administrator adds an ApplyXSLTransform step. The step uses the Print Jobs XSLT style sheet.

    After the ApplyXSLTransform step, the administrator adds a step based on the DownloadFile step template to download the PDF file specified by the value of the Job.DownloadFile property. The administrator sets the value of the Path to downloaded file property to ${getFileName(print,pdf,write)} so that the PDF file is downloaded to the spool directory for the job.

    Following the DownloadFile step, the administrator adds the steps that the printing company uses to process PDF jobs.

    After the last step that processes the print jobs, the administrator adds a step based on the ManualStepWithAutoStart step template. This step gives a shipping clerk time to add the print job to the order in the shipping department.

    After the ManualStepWithAutoStart step, the administrator adds a step based on the WaitForRelatedJobs step template. This step holds each job for a print item in an order until all the jobs in the order have been processed.

  4. The ProcessStockJobs workflow receives each job for a promotional item, and accounts for the time required to retrieve a promotional item from the warehouse.

    After the SetJobPropsFromTextFile and DetectInputDataStream steps, the administrator adds an ApplyXSLTransform step. The step uses the Stock Jobs XSLT style sheet.

    After the ApplyXSLTransform step, the administrator adds a step based on the ManualStepWithAutoStart step template. This step gives a shipping clerk time to get the promotional item from the warehouse and add it to the order in the shipping department.

    After the ManualStepWithAutoStart step, the administrator adds a step based on the WaitForRelatedJobs step template. This step holds each job for a promotional item in an order until all the jobs in the order have been processed.

This figure shows the four workflows. The green lines show the workflow that each CreateJobsFromXML step submits XML jobs to.

Processing jobs through the workflows

When the administrator enables the workflows and submits an XML file to the input device, RICOH ProcessDirector processes the job through the four workflows.

The ExtractOrdersFromXML workflow receives the XML job from the input device and creates an XML file for each order element that matches the Order Jobs XPath expression. The workflow submits each XML file as a job to the SplitOrderIntoPrintAndStockJobs workflow.

The SplitOrderIntoPrintAndStockJobs workflow does this processing:

  • It receives each order job.
  • It uses the Order Jobs XSLT style sheet to convert order number and customername elements and values into job properties and values.
  • It records the job properties and values in an overrides file.
  • It creates an XML file for each item element that matches the Print Jobs XPath expression. The workflow submits each XML file as a child job to the ProcessPrintJobs workflow. A copy of the overrides file is submitted with each child job.

    It creates an XML file for each item element that matches the Stock Jobs XPath expression. The workflow submits each XML file as a child job to the ProcessStockJobs workflow. A copy of the overrides file is submitted with each child job.

  • It holds the parent job for each order until all the child jobs have been processed.

The ProcessPrintJobs workflow does this processing:

  • It receives each job for a print item.
  • It uses the Print Jobs XSLT style sheet to convert the printfile and quantity elements and values into job properties and values.
  • It records the job properties and values by overwriting the contents of the overrides file submitted with the job.
  • It uses the value of the Job.DownloadFile property to download the PDF file for each print item.
  • It prints the PDF file.
  • It waits while a shipping clerk checks the values of the Custom 1 (order number) and Customer name properties for the job. The clerk then adds the print item to the order in the shipping department.

    To move the job to the next step in the workflow, the clerk uses the Manual complete action.

  • It holds each job for a print item until order processing is complete.

The ProcessStockJobs workflow does this processing:

  • It receives each job for a promotional item.
  • It uses the Stock Jobs XSLT style sheet to convert stock number and quantity elements and values into job properties and values.
  • It records the job properties and values by overwriting the contents of the overrides file submitted with the job.
  • It waits while a shipping clerk does these tasks:
    • Finds the stock number of the item by checking the value of the Custom 2 property.
    • Gets the required number of promotional items from the warehouse.
    • Checks the values of the Custom 1 (order number) and Customer name properties for the job.
    • Adds the promotional items to the order in the shipping department.

    To move the job to the next step in the workflow, the clerk uses the Manual complete action.

  • It holds each job for a promotional item until order processing is complete.

When all the jobs for the print and promotional items in an order have reached the WaitForRelatedJobs step, order processing is complete. RICOH ProcessDirector moves the parent job for the order and all the child jobs for the items to the steps based on the RetainCompletedJobs step template.

1.2.1.2.8 Jobs with JSON files

RICOH ProcessDirector can process jobs submitted as JSON files. You can submit JSON files to an input device or place a JSON file at a location from which the RICOH ProcessDirector server retrieves it. You can use REST web service input device to retrieve JSON files that become jobs.

If you place a JSON file at a location from which it is retrieved, RICOH ProcessDirector processes the file as jobs move through the workflow. You submit another type of file to the hot folder to initiate the process. For example, you can submit a print file or a trigger file, such as a file with job overrides or with no content.

Note: The Web Services Enablement feature lets you use REST Web service protocols to receive JSON data from and exchange it with other applications.

A step based on the ConvertJSONToXML step template converts a JSON input file to an XML output file. You can then use RICOH ProcessDirector step templates that manipulate XML files.

1.2.1.2.9 Processing jobs with encrypted PDF files

RICOH ProcessDirector can receive encrypted PDF files, but must decrypt the files to process the jobs.

Most steps cannot process encrypted files. As a result, you must decrypt the file before the first step in the workflow that needs to open the PDF file. Use a step based on the DecryptPDF step template to remove the encryption from a PDF file.

    Note:
  • The DecryptPDF step template cannot process PDF files inside a ZIP file.

When you encrypt a PDF file, you can specify one or two passwords. The Owner password is the master password. It completely unlocks the file, so the recipient can read it, fill in form fields, and even edit the contents of the file. RICOH ProcessDirector steps need the level of access provided by the Owner password when they process jobs, because they often make changes to those PDF files.

The User password is a more limited password. It unlocks the file so that it can be read, but not edited in any way. This password is only needed if both of these statements are true:

  • The recipient must enter a password to open the file to read it.
  • The recipient must be prohibited from changing the document, such as by filling in forms or editing the contents.

If the file does not contain secure information, you can encrypt it so that it can be opened without a password, but require the Owner password for editing functions.

To decrypt a PDF file, you must use the Owner password that was set when the file was created. Work with your customer to determine the best way to manage these passwords. You can choose to use the same password for every PDF file that a customer submits. In that case, you can record the Owner password value in the DecryptPDF step without updating it.

Alternatively, you can choose to set a different password for every PDF file that is submitted. If the password changes with every job, you must provide a way for the operator to enter the password for each job. You can add a manual step to the workflow before the DecryptPDF step and give it a name like EnterOwnerPassword. During processing, the job stops at that step. The operator can open the job property notebook and enter the Owner password in the Enhance PDF tab. Then the operator can complete the manual step so the password is available when the DecryptPDF step runs.

The Owner password can also be submitted in an overrides file along with other job properties. However, this method is not recommended because it is not secure.

1.2.1.2.10 Workflow phases

RICOH ProcessDirector has several distinct workflow phases. These phases help to organize the path that jobs take through the system. Jobs can flow through all the phases or through a few of the phases. The addition of features to the base RICOH ProcessDirector product might add additional phases to the workflow. The default phase names can be changed to better match the functions that you perform in that phase.

Steps in the phases do the actual phase work. The workflow determines which phases the job passes through and the order of the steps in each phase.

The processing phases in the base product are:

Receive phase
In the Receive phase, the RICOH ProcessDirector system accepts input files for processing. Each job is assigned a workflow, which defines the phases and steps that process the job. Steps in the Receive phase also set the initial values of job properties for use by later steps in the workflow.

For example, RICOH ProcessDirector might queue the job to the first step of the Prepare phase or queue the job directly to the Print phase.

After the Receive phase queues the input file, it becomes a job on the RICOH ProcessDirector system.

Prepare phase
The Prepare phase composes, transforms, and indexes the job to create printable pages. You can also instruct RICOH ProcessDirector to run external programs during the Prepare phase to further condition or interpret the job.
Assemble phase
If you have the PDF Document Support or AFP Support feature, the Assemble phase organizes documents prior to a phase such as Print that produces the physical documents.
Print phase
The Print phase routes and sends the job to an available printer, monitors printing status, and reports print completion. It can include a manual quality check, which can let the operator make printer adjustments prior to reprinting the job. It might also send the job to an external program for customized processing.
Insert phase
If you have the Inserter feature, the Insert phase communicates with the inserter controller and reconciles the job after it completes insertion.
Complete phase
After jobs have completed all other processing, they arrive in the Complete phase. The Complete phase manages the retention period for jobs; it deletes jobs that have no retention periods or whose retention periods have expired. For jobs that consist of a parent job and one or more child jobs, the Complete phase makes sure that no additional actions take place until all the related jobs reach the Complete phase. In the Complete phase, you can also invoke external programs on completed jobs. For example, an external program can copy the jobs to an archive system.

1.2.1.2.11 Document properties file

The document properties file (DPF) can contain properties of documents in a job. The file is stored in the spool directory for the job.

The document properties file is created automatically by the step templates IdentifyPDFDocuments, IdentifyDocuments, ReadDocumentsFromDatabase, CreateJobsFromDocuments, and CreateAFPJobsFromDocuments. The file is structured like a table; the first line identifies the properties that are in the file, and each additional line contains the property values for each document. RICOH ProcessDirector uses the information in the document properties file to keep track of the documents associated with each job.

1.2.1.2.12 Document database

The document database is an internally managed database that stores and manages the properties of individual documents in the system. You do not do actions directly on the document database, but on the documents that it contains.

During the configuration process, you work with your Ricoh support representative to decide whether to define document properties as database properties or as limited properties.

1.2.1.2.13 Document properties configuration file

The document properties configuration file defines custom document properties to use with document processing features. The file is named docCustomDefinitions.xml.

You set up this file when you prepare configuration files after you install the PDF Document Support or AFP Support feature. You update the file whenever you need to define a new custom document property. The file identifies which custom document properties are managed in the database, and which properties exist only in the document properties file.

Note: If you define custom document properties from the Administration tab, you do not have to create or edit this file.

1.2.1.2.14 Document properties names file

The document properties names file is an optional file that defines caption information for custom document properties for display in the user interface. The file is named docCustomDefinitions.properties. It is associated with custom document properties that you define in the docCustomDefinitions.xml file.

If you are using only one language in your environment and you defined custom document property captions in the docCustomDefinitions.xml file, you do not need to edit the docCustomDefinitions.properties file.

1.2.1.2.15 Document properties template file

The document properties template file determines which properties go into the document properties file for a job. The template file lets you control the number of document properties to be used, as well as the order of the columns in the document properties file.

You can use multiple document property template files in one RICOH ProcessDirector system.

1.2.1.2.16 Properties

RICOH ProcessDirector uses properties to define the characteristics of all its objects, such as input devices, workflows, and jobs. It stores the properties and their corresponding values in database tables.

The RICOH ProcessDirector user interface provides a complete description for each property. The description supplies information about the valid values and meaning of each property.

The properties are:

System properties
System properties define certain high-level characteristics of the RICOH ProcessDirector system and the RICOH ProcessDirector objects. For example, system properties control how often users must change their passwords.

Administrators typically set any system properties that the installation requires when they initially configure the system. Administrators can also access system properties through the Administration page of the RICOH ProcessDirector user interface, so they can later set or change a system property.

Application/secondary server properties
Application/secondary server properties define certain characteristics of application and secondary servers.

Administrators typically set server properties when they create a server. For example, they can determine how many steps a server is capable of running at the same time. Administrators can also access server properties through the Administration page of the RICOH ProcessDirector user interface, so they can later set or change a server property.

Input file properties
Input file properties define certain characteristics of the files that RICOH ProcessDirector receives through its input devices.

RICOH ProcessDirector supplies the values for input file properties and can display them in a table. Users can review the property values, but cannot edit them. For example, a user can verify that the correct workflow was applied to a specific input file. RICOH ProcessDirector uses an input device property to record the time when it received an input file. Operators might find this useful if they need to verify that a certain file arrived at a specified time, such as for an audit.

Input device properties
Input device properties define the characteristics of input devices.

Administrators typically set input device properties when they create an input device. For example, they can use an input device property to control the maximum number of communication errors that can occur before RICOH ProcessDirector shuts down the input device. They can also assign a workflow to an input device so that the device applies a specific set of steps and job property values to all the input files that it receives.

Step template properties
RICOH ProcessDirector provides step templates that administrators use to create the individual steps within the workflows for the RICOH ProcessDirector system.

Step template properties define the characteristics of a step, such as what default values to set for the job properties.

Step properties
Step properties define the characteristics of the processing steps within the phases. Administrators typically set the step properties when they initially configure the workflow. Steps reside within workflows.
Job properties
Job properties define the characteristics of jobs, which RICOH ProcessDirector input devices create from the input files that they receive.

Job properties are the largest group of properties in RICOH ProcessDirector. They control all aspects of job processing. For example, you can use job properties to:

  • Specify the media required for the job.
  • Specify whether header or trailer pages are printed with the job.
  • Retain the job for a set period of time after all job processing completes.
Job properties are set through a variety of methods. The most common method is to create a workflow to set the job properties when the job enters the RICOH ProcessDirector system. Administrators can assign the workflow to an input device, and the input device can then apply the values for job properties to every job that it receives. RICOH ProcessDirector also lets users change or override values for job properties on a job-by-job basis.

If you install document processing features, you use document properties to define characteristics of documents inside each job. Document properties are particularly useful for variable data jobs, You can use document properties to track data that changes from document to document, such as:

  • Account numbers
  • Customer names and addresses
  • Delivery preferences

Document properties
RICOH ProcessDirector provides a general set of document properties that you can use, or you can define your own. Document property values are usually extracted from jobs based on specifications you provide using RICOH ProcessDirector for Adobe Acrobat or RICOH Visual Workbench.
Workflow properties
Workflow properties include steps and the job properties that the steps set.
Printer properties
Printer properties define the network location and scheduling characteristics of the printer devices.
User properties
User properties define the characteristics of users who have been authorized to use the system.

RICOH ProcessDirector provides a predefined set of groups. You can also define your own groups. Administrators assign groups to users during initial configuration. Groups control the functions and areas of the RICOH ProcessDirector interface that users can access.

Custom properties
Custom properties are job and document properties that are unique to your installation. If none of the provided job and document properties meet your requirements, you can define your own. You can configure the characteristics of a custom property from a database name to levels of access for different user groups. Once activated, custom properties can be used as any other job or document property.

1.2.1.2.17 Input device, job and printer event notifications

You can configure the system to send an email when certain input device, job or printer events happen. The emails can go to one or more people, or to all the members of a group.

For example, you can send a supervisor an email with the log attached whenever a printer goes into an error state or you can send your preflight staff an email when a job has an error in a composition step.

Notification emails can be sent conditionally, based on the time of day, input devices, printers or jobs involved, or other input devices, printer or job properties.

To configure RICOH ProcessDirector to send email notifications, you define one or more notification objects based on the recipients and types of notifications that need to be sent.

1.2.1.2.18 Media

RICOH ProcessDirector uses media objects to represent physical media. Like printer objects, media objects are representations of physical objects outside of the system. Each media object represents a type of paper, envelope or other material that your printers can print on.

You can define media objects for each type of media that you use in your environment. RICOH ProcessDirector uses those media objects to map the media requested by a job with the physical media that is loaded in the printer.

RICOH ProcessDirector has two types of media object:

  • System media

    Represents media that is specified for jobs and that can be used for all printers.

  • Printer media

    Represents the media that is used with a specific printer.

System media and printer media might have different names for the same physical media. If the media names are different, you can create a media mapping to indicate that they represent the same physical media. For most printer types, you set the Media to use property to specify which media names to send to that printer with jobs.

By defining media objects with enough information about the properties of the media that distinguish them from one another in your operation, RICOH ProcessDirector can send the right information to the printer to select the correct media.

1.2.1.2.18.1 Media matching

When RICOH ProcessDirector sends jobs to cut sheet printers, it must determine two things: what media a job should be printed on and what media is loaded in a printer. When RICOH ProcessDirector establishes that information, it can schedule jobs correctly.

When a job is submitted with a job ticket, the job ticket usually includes information about the media that the job should be printed on. That information can include the product ID and name of the requested media, as well as properties of the media, such as size and color. The Media Matching setting determines how the system interprets that information to set the Media property for the job.

    Note:
  • When a job has page exceptions, the system sets the job property for page exceptions the same way that it sets the Media property for the job.
  • Media product IDs are used only with jobs sent to Ricoh PDF printers with a Data stream to send value of JDF/PDF. Some control units for Ricoh PDF printers can be configured to use product IDs to select media.

The Media Matching setting also affects how the Media ready property for a printer is set. If a printer supports SNMP or JMF, it can send information about the media loaded in its trays to RICOH ProcessDirector. The system compares the information returned by SNMP or JMF with existing media objects to find one that matches. If the Media to use property on the printer is set to Printer, RICOH ProcessDirector compares the names to existing printer media. If it finds a match, the printer media must be mapped to its system media equivalent for jobs to print correctly. If the Media to use property on the printer is set to System, RICOH ProcessDirector compares the names to existing system media.

When it finds a match, the name of the matching media object is used for the value of the Media ready property for the input tray. If none of the existing media objects match, RICOH ProcessDirector creates a media object of the correct type (system or printer), with the specified values and includes that media name in the value of the Media ready property.

RICOH ProcessDirector provides two options for media management: Use media product ID or media name and Use the properties selected below.

  • The Use media product ID or media name option uses one of these media names as the value of the Media property for a job:
    • The name of the media object with the matching product ID specified in the job ticket.
    • The name of the media specified in the job ticket.

    The option does not check any other media properties.

    RICOH ProcessDirector first checks whether the job ticket specifies a media product ID. If it does, RICOH ProcessDirector looks for a media object with the same product ID. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job. If RICOH ProcessDirector does not find a match, it looks for a media object with the media name specified in the JDF job ticket. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job.

    You must use the Show Trays action on the printer object to specify the media loaded in the printer.

    When this option is selected, you can create media objects that have the same property values but different product IDs or names.

  • The Use the properties selected below option uses one or more media properties specified in the job ticket to determine the value of the Media property for the job. You can choose the media properties that are relevant to your operations. RICOH ProcessDirector examines the values of the relevant media properties in the job ticket and finds a media object with matching values for those properties. If more than one media object matches the specified properties, RICOH ProcessDirector uses more logic to choose the most appropriate value.

    In addition, you must use this option if you want RICOH ProcessDirector to use SNMP or JMF to set the Media ready property for printers based on the properties of the media, and create media objects if needed. If the printer does not return all the relevant properties for a media object, RICOH ProcessDirector cannot set the media in the input tray automatically. You must use the Show Trays action on the printer object to specify the media loaded in the printer.

When the Media property for a job and the Media ready property for printers are set, RICOH ProcessDirector can use those values to help schedule the job to the appropriate printer.

1.2.1.2.18.2 Media substitution

You can use media mapping to change the media that a job requests. Media mappings are specific for each printer.

You might need to substitute media in a variety of situations:

  • If a customer submits jobs that request a system media named Letter, your cut sheet printers have printer media named 8.5x11, you can create a mapping for each printer that links the Letter system media with the 8.5x11 printer media.
  • If the two printer models in your environment report different names or property values for the same media, you can create mappings for each printer so that RICOH ProcessDirector sends the correct media information to each one.

    For example, if Printer 1 reports Printer1Red as the printer media name when it is loaded in a tray, and Printer 2 reports the same media as Printer2Red, you create mappings from Printer1Red and Printer2Red to the Red system media. Any job requesting Red media can print on either printer.

1.2.1.2.19 Web services in RICOH ProcessDirector

RICOH ProcessDirector provides Web services that use Representational State Transfer (REST) software architecture principles so you can access its functions from other applications.

RESTful Web services send requests and receive results using the Hypertext Transfer Protocol (HTTP). Each Web service has a Universal Resource Indicator (URI) associated with it. When you create requests, you modify the URI to include specific information about the object that you are interested in or the action that you want to do. These modifications can be simple, such as inserting the name of a printer object into the URI, or highly complex, such as using Extensible Markup Language (XML) to describe the criteria to use when searching for objects and how they should be sorted when they are returned. If you code XML elements to include in your requests, they must be Universal Resource Locator (URL)-encoded before they are added to the URI.

With RICOH ProcessDirector, you can use Web services to request information about print jobs and other objects in the system. You can also use them to set properties and do actions such as enabling and disabling objects, modifying properties, and starting and stopping printers.

1.2.1.2.19.1 Using RICOH ProcessDirector REST API documentation

RICOH ProcessDirector provides REST APIs for web service integration. Interactive documentation is provided with these APIs and provides live testing and information for each available API.

The REST API documentation includes many APIs that an application can use to integrate with RICOH ProcessDirector. You can use the REST API documentation and testing interface to test your parameter settings. When you use the interface to test web services, you access the RICOH ProcessDirector primary server. Actions such as creating, deleting, and enabling objects are executed on the primary server and are reflected in the RICOH ProcessDirector user interface. As a result, we suggest creating objects specifically for testing purposes.

These steps demonstrate how to request the log files for an object using REST APIs. These steps log you in to RICOH ProcessDirector, request the log files for the Sample printer, and log you out.

  1. Open a Web browser and enter your RICOH ProcessDirector hostname or IP address into the address bar. Add /restapi/ to the end of your hostname or IP address to access the REST API documentation. For example, http://hostname:15080/restapi/
  2. In the users section and find POST /users/login.
  3. Click Try it out.
  4. Log in to RICOH ProcessDirector by entering your RICOH ProcessDirector credentials:
    • For the name parameter, enter your RICOH ProcessDirector user name.
    • For the pwd parameter, enter the password associated with your RICOH ProcessDirector user name.
  5. Click Execute.
    The REST API documentation uses the values you enter to build a Curl command and a Request URL. Then it submits the request to the request URL and logs you in.

    RICOH ProcessDirector sends a response indicating whether you successfully logged in. The response includes additional information including the token and the actions that this User ID is allowed to do.

  6. In the Response Body box, find and copy the token value.

  7. In the objects section, scroll down until you find POST /objects/log/{objectType}/{name}.
  8. Click Try it out.
  9. Retrieve the log messages for the Sample printer by entering these parameters:
    1. For the token parameter, paste the token you copied above.
    2. For the objectType parameter, type Printer.
      The values for objectType are case-sensitive. You can use the web service POST /util/objecttypes to get a list of object types available on your system. The web service POST /util/objecttypes is found in the util section.
    3. For the name parameter, type Sample.
  10. Click Execute.
    The log entries for the Sample printer are returned in the Response Body box.

    The Curl and Request URL values are also returned.

  11. In the users section find POST /users/logout/{name}.
  12. Click Try it out.
  13. Log out of RICOH ProcessDirector:
    • For the token parameter, paste the token you copied above.
    • For the name parameter, enter your RICOH ProcessDirector user name.
  14. Click Execute.
    You are logged out of RICOH ProcessDirector.
  15. Example values are included with certain APIs. With example values you can update the sample code and modify it for testing.

    These steps demonstrate how to use a REST API to connect a hot folder using an example value. These steps log you in to RICOH ProcessDirector, set the Input Device to accept files from HotFolderPDF, and log you out.

  16. Open the REST API interface as above.
  17. In the users section and find POST /users/login.
  18. Click Try it out.
  19. Log in to RICOH ProcessDirector by entering your RICOH ProcessDirector credentials:
    • For the name parameter, enter your user name.
    • For the pwd parameter, enter the password associated with your user name.
  20. Click Execute.
  21. In the Response Body box, find and copy the token value.
  22. In the objects section, scroll until you find POST /objects/{objectType}/connect.
  23. Click Try it out.
  24. Connect HotFolderPDF by entering these parameters:
    1. For the token parameter, paste the token you copied above.
    2. For the objectType parameter, type InputDevice.
      The values for objectType are case-sensitive. You can use the web service POST /util/objecttypes to get a list of object types available on your system. The web service POST /util/objecttypes is found in the util section.
    3. For the body parameter, click Edit Value. Example text displays in a code box. Replace the word “string” with “HotFolderPDF”. Make sure the double quotes are around the name of the object.
  25. Click Execute.
    The properties and settings for HotFolderPDF are returned in the Response Body box. The Response Code and Response Headers are also returned.
  26. In the users section find POST /users/logout/{name}.
  27. Click Try it out.
  28. Log out of RICOH ProcessDirector:
    • For the token parameter, paste the token you copied above.
    • For the name parameter, enter your RICOH ProcessDirector user name.
  29. Click Execute.
    You are logged out of RICOH ProcessDirector.

1.2.1.2.19.2 Usage notes

The Web services provided with RICOH ProcessDirector follow specific conventions. When you integrate Web services with your application, refer to these usage notes to make sure that your implementation functions properly.

  • You must use the POST /users/login/ Web service to establish a connection and receive a credential token from the RICOH ProcessDirector server before you can use any other Web services. All of the other Web services require that you include a credential token in the request header of the URI. If you do not, you receive an immediate 401 Unauthorized HTTP error.
  • You cannot translate actions and URIs into other languages because they are fixed-character strings. For example, "token:" remains the same for all languages.
  • Record sets retrieved might change between invocations of any service, especially when you use sorting or filtering functions; successive identical requests might not yield the same records.
  • If you activate Secure Sockets Layer (SSL) or Transport Layer Security (TLS) support, RICOH ProcessDirector uses the SSL protocol for all HTTP communications, including Web services. If SSL or TLS support is active, you must use a Web services client that supports SSL or TLS to invoke Web services.
  • RICOH ProcessDirector Web services only return JavaScript Object Notation (JSON) data. XML is not supported.

1.2.1.2.20 Features

RICOH ProcessDirector features provide more functions or let you add devices like inserters to the system. The modular design of RICOH ProcessDirector lets you add features to the base product as your business needs change. Most features are integrated seamlessly into the user interface.

Most features can be installed using the Feature Manager, available after you install the base product.

Features are copied to your system when you install the base product, but are not fully installed until you use Feature Manager to install them.

When you install a feature with Feature Manager, the feature is in trial mode. To continue using a feature after the trial period, you must purchase the feature and install a license key for it. If you do not install a license key, the feature stops working at the end of the trial period.

RICOH ProcessDirector features
Description CD number
Advanced Transform feature

The Advanced Transform feature lets you transform print jobs to or from these file formats:

  • AFP
  • PCL
  • PDF
  • PostScript
  • BMP, GIF, JPEG, PNG, TIFF (only as input data streams)

You can purchase and install any combination of these transform options.

    Note:
  • You install the Advanced Transform feature using Feature Manager. A separate license key is required for each input and output transform that you purchase. For example, if you buy Input PostScript and Output AFP, you need two license keys.
LCD2-20004
AFP Editor

AFP Editor lets you create barcodes and hide areas in indexed AFP files. You can create barcodes that contain index values, job properties, and static text. For example, if the ZIP codes in an AFP file are index values, you can create barcodes that contain the ZIP codes. You can hide areas in AFP files. No one can see the data in the hidden areas, and the data does not print. For example, you can hide areas that contain existing barcodes that you want to replace. In addition, AFP Editor can automatically replace POSTNET barcodes with Intelligent Mail barcodes (IMBs) that have the same routing code. You can also add text strings, such as Page x of y, to formatted AFP files.

You must have the AFP Support feature installed to use the AFP Editor feature.

LCD4-5680
AFP Support

The AFP Support feature lets you control and track jobs and individual documents in Advanced Function Presentation (AFP) format. AFP provides a transaction-oriented data stream that guarantees integrity between the RICOH ProcessDirector server and its printers. The printers can deliver the exact status of every page as it is received, printed, and stacked. The feature adds support for AFP and PCLOut printers.

The feature includes RICOH Visual Workbench with AFP Indexer, Document Property Designer, and AFP Enhancer modes. RICOH Visual Workbench lets you identify individual documents in AFP files and extract data from the documents. Step templates let you add steps to your workflows that use the extracted data to sort, split, and group the documents into new jobs.

The AFP Support feature is a prerequisite for many other features that work with AFP data. Without the feature, you can view but not print AFP data, and you can pass AFP jobs to other programs.

LCD2-20057
Archive

Archive lets you store jobs, documents, and job processing history in a repository and retrieve them by searching for job and document properties. For example, you search for documents by job name, customer name, and account number. After you retrieve a job or document, you can view it, review the properties that were stored with it, and check the production history. You can save the job or document to your workstation, or submit it to a workflow for reprinting or other processing.

You must have the AFP Support or PDF Document Support feature installed to use the Archive feature.

LCD2-20049
Automated Verification

The Automated Verification feature lets you add barcodes to the documents in a print job. By reading barcodes, cameras or barcode scanners detect documents that failed to complete a step in their workflow. You can automatically reprint missing documents or manually pull them out of their workflow. A job log records the disposition of the documents in each job and the user ID of the operator who did the dispositions.

You must have the AFP Support or PDF Document Support feature installed to use the Automated Verification feature.

LCD2-20045
Avanti Slingshot Connect

With the Avanti Slingshot Connect feature, you can receive jobs and JDF job tickets from the Avanti Slingshot MIS system and process them within RICOH ProcessDirector. RICOH ProcessDirector can then provide status of the job back to Avanti Slingshot as it moves through the system.

LCD2-20050
Cut Sheet Support for Kodak

With this feature, you can define and drive Kodak cut sheet printers from RICOH ProcessDirector. RICOH ProcessDirector converts media and stapling requests into the KDK format used by these printers.

LCD2-20043
Cut Sheet Support for Xerox

With this feature, you can define and drive Xerox cut sheet printers from RICOH ProcessDirector. RICOH ProcessDirector converts media and stapling requests into the XRX or XPIF format used by these printers.

LCD2-20044
Deadline Tracker

Deadline Tracker lets you manage your progress toward meeting your delivery deadlines. If you have service level agreements with your customers, this feature helps you make sure that their jobs are on schedule to be completed on time. You can see when jobs are behind schedule or risk missing their deadlines. This information helps operators prioritize work and act to bring jobs back on track for on-time delivery. You can monitor expected work (jobs that you expect to receive at set intervals). If the jobs do not arrive in time, you can inform the sender.

LCD2-20046
Electronic Presentment

The Electronic Presentment feature provides a sample workflow that receives jobs from a sample input device and uses a sample history record notification to capture the times when jobs are printed and mailed. The workflow stores jobs, documents, property values, and history information in a sample repository.

This no-charge feature is provided with the base product, but not installed by default.

You must have the Archive feature installed to use the Electronic Presentment feature.

LCD2-20054
Inserter

Inserter automates the insertion of printed documents and inserts (such as marketing materials) into envelopes. The feature can communicate with inserter controllers by sending control files to them and receiving results files from them. Using information in the results file, the feature tracks the insert status of each document in the job. Jobs are reconciled automatically (or manually, with operator control). Reprints are automatically generated for damaged documents.

You must have the AFP Support or PDF Document Support feature installed to use the Inserter feature.

LCD2-20058
Language pack

The Language pack includes translations for the user interface and help system. Install this feature to use the user interface in a supported language.

Not Applicable
MarcomCentral Connect

The MarcomCentral Connect feature lets you integrate the online-storefront and web-to-print functions of MarcomCentral into your production workflows. Sample web service input devices retrieve orders for print, digital, and other items from MarcomCentral. RICOH ProcessDirector creates a job for each order and notifies MarcomCentral when the items in the job complete specified steps in the sample workflow.

You must have the Web Services Enablement feature installed to use the MarcomCentral Connect feature.

LCD2-20074-00
PDF Document Support

The PDF Document Support feature adds functions and objects that let you control and track individual documents in PDF jobs. The feature includes RICOH ProcessDirector Plug-in for Adobe Acrobat. The plug-in lets you identify individual documents, extract data from the documents, and add enhancements such as barcodes, OMR marks, images, hidden areas, and text. Step templates let you add steps to your workflows that use the extracted data to sort, split, and group the documents into new jobs.

This no-charge feature is provided with the base product but is not installed by default.

Not Applicable
PitStop Connect

PitStop Connect lets you integrate preflight operations that use Enfocus PitStop Server 10 into your print workflows for PDF print jobs.

Enfocus PitStop Server is not included in this feature; it is a product that must be purchased separately.

LCD2-20013
Postal Enablement

Postal Enablement lets you extract mailing address data from the documents in a job and prepare the data for processing by external postal software. After the postal software verifies the addresses and improves their quality, Postal Enablement updates the documents in the job with the results from the postal software.

Postal software is not included in this feature. You can use your choice of external postal software.

You must have the AFP Support or PDF Document Support feature installed to use the Postal Enablement feature.

LCD2-20048
Preference Management

Preference Management lets you update document property values with values from an external preferences file. These values can be used to change the content of selected documents or to change the processing of those documents.

This no-charge feature is provided with the base product, but not installed by default.

You must have the AFP Support or PDF Document Support feature installed to use the Preference Management feature.

LCD2-20053
Preprinted Forms Replacement

The Preprinted Forms Replacement feature lets you print jobs on plain paper that previously required preprinted forms. You update the definition of each media object for the media requested by these jobs to include the electronic equivalent of the preprinted form data. The application that submits the print files to RICOH ProcessDirector can continue to specify the media for the jobs in the same way.

You must have the AFP Support or PDF Document Support feature installed to use the Preprinted Forms Replacement feature. If you install the AFP Support feature, the Preprinted Forms Replacement feature also lets you insert PDF forms into AFP jobs.

LCD2-20076
Quadient Inserter Express

The Quadient Inserter Express feature is a simplified version of the Inserter feature, which includes support for only Quadient inserters. The feature provides sample objects that you can use as templates for configuring RICOH ProcessDirector to communicate with Quadient inserters.

You must have the AFP Support or PDF Document Support feature installed to use the Inserter feature.

LCD2-2007711
Quadient Inspire Connect

Quadient Inspire Connect extends RICOH ProcessDirector to make it easier to interact with Quadient® Inspire V8 or above. The feature adds system objects tailored to work with files created by Quadient Inspire so they can be submitted to the processing engine to generate print jobs as part of a print workflow.

Quadient Inspire is not included in this feature; it is a product that must be purchased separately.

You must have the AFP Support feature installed to create AFP files with Quadient Inspire.

LCD4-6598
Reports

The Reports feature lets you capture selected job properties and printer status changes in a PostgreSQL database. To extract data and visualize it, you can use a business intelligence tool, such as Tableau.

This no-charge feature is provided with the base product, but not installed by default.

LCD4-5682
RICOH Supervisor Connect

The RICOH Supervisor Connect feature lets you send data collected by the Reports feature in the PostgreSQL data base to the RICOH Supervisor application in the cloud.

LCD2-2007907
RICOH Transform features

RICOH Transform features provide a powerful and cost-effective system for transforming jobs to or from the format for Advanced Function Presentation (AFP) printing. The RICOH Transform features are:

  • PostScript/PDF to AFP

    Converts PDF and PostScript into AFP

  • RICOH PCL to AFP

    Converts PCL into AFP

  • RICOH SAP to AFP

    Converts SAP OTF and ABAP into AFP

  • RICOH AFP to PDF

    Converts AFP into PDF

    Note:
  • You use the InfoPrint Transform Manager user interface and help system for some Transform configuration tasks. If you install more than one Transform feature, they share the InfoPrint Transform Manager interface.
  • All RICOH Transform features include image transforms (GIF to AFP, JPEG to AFP, and TIFF to AFP), which convert GIF, JPEG, and TIFF images to AFP.
  • A separate license key is required for each purchased transform.
  • You cannot install any of the RICOH Transform features using Feature Manager.
  • You must have the AFP Support feature installed to use the RICOH Transform features.
  • The APPE conversion tool is installed with the Ricoh Transform features.
  • PostScript/PDF to AFP Transforms, LCD4-5671
  • RICOH PCL to AFP Transform, LCD4-5672
  • RICOH SAP to AFP Transform, LCD4-5673
  • RICOH AFP to PDF Transform, LCD4-5674
Secondary Server

You can set up RICOH ProcessDirector servers that run on different computers and that interact with the primary server. The additional servers are called secondary servers.

You can use secondary servers to run external programs that workflows send jobs to. To move some processing from the primary computer to the secondary computer, you can define printers that use the secondary server as their parent server.

You cannot install this feature using Feature Manager.

LCD4-5635
Security

Security provides advanced functions, including password requirements, that increase the security of user accounts.

If you have a Lightweight Directory Access Protocol (LDAP) or Active Directory server, you can use LDAP user IDs and passwords to authenticate into RICOH ProcessDirector.

This no-charge feature is provided with the base product but is not installed by default. Installing it provides more control over the security of user accounts such as expiring unused accounts or enabling enforcement of complex password rules.

Not Applicable
Ultimate Impostrip® Connect

Ultimate Impostrip® Connect lets you integrate the imposition functions of Ultimate Impostrip® Automation or Scalable into your RICOH ProcessDirector workflows.

Ultimate Impostrip® is not included in this feature; it is a product that must be purchased separately.

LCD2-20026
Web Services Enablement

The Web Services Enablement feature lets you call REST and SOAP web services from your production workflows to exchange data with third-party applications.

The feature adds support for input devices, step templates, and notification objects that can send web service requests.

LCD2-20074-00
Whitespace Manager

Whitespace Manager lets you define available areas of white space in AFP files. You can fill the white space with content, such as images and text, during the print production process. You place content in a white-space area based on rules you define to target content for specific customers or for the best use of available space.

You must have the AFP Support feature installed to use the Whitespace Manager feature.

LCD4-5699
WPM Connect

WPM Connect lets you integrate the WPM tool into RICOH ProcessDirector workflows for more processing.

This feature is only available in Japan.

You must have the AFP Support feature installed to use the WPM Connect feature.

WPM is not included in the WPM Connect feature; it is a product that must be purchased separately.

LCD2-20014

1.2.1.2.20.1 Security feature

The Security feature provides advanced functions, including password requirements, that increase the security of user accounts.

If you have an existing Lightweight Directory Access Protocol (LDAP) or Active Directory server, you can use LDAP user IDs and passwords to authenticate into RICOH ProcessDirector.

You must use the Feature Manager to install the Security feature. You do not need to purchase the feature, and it does not require a license key. The Security feature adds a new Security page to the Settings section of the Administration page.

1.2.1.2.20.1.1 Migrating to LDAP security

If you have been using RICOH ProcessDirector user IDs and passwords to authenticate into RICOH ProcessDirector, you can migrate to use LDAP user IDs and passwords.
You must have an existing LDAP or Active Directory server.
To migrate to LDAP security:
  1. Upgrade to RICOH ProcessDirector Version 3.3 or later for LDAP security support.
  2. Install the Security feature using Feature Manager.
  3. Make sure that all users who authenticate into RICOH ProcessDirector have working LDAP user IDs and passwords.
  4. Set up LDAP authentication and turn it on.
  5. All users who are members of RICOH ProcessDirector security groups must be members of LDAP groups that map to RICOH ProcessDirector groups.
      Important:
    • Make sure that members of the RICOH ProcessDirector Administrator security group are members of an LDAP group that maps to the Administrator group.
  6. Manually delete existing RICOH ProcessDirector users that are not LDAP users.
      Note:
    • User IDs that were defined in RICOH ProcessDirector cannot be used when LDAP authentication is on. If for some reason you need to turn LDAP authentication off, you are responsible for keeping at least one user who is a member of the Administrator security group but is not an LDAP user.

1.2.1.2.20.1.2 Advanced security functions

The Security feature provides advanced functions that increase the security of user accounts.

If you have an existing Lightweight Directory Access Protocol (LDAP) or Active Directory server, you can use LDAP user IDs and passwords to authenticate into RICOH ProcessDirector. Password rules and change intervals set by the LDAP server apply to the RICOH ProcessDirector user IDs.

If you use RICOH ProcessDirector user IDs and passwords to authenticate into RICOH ProcessDirector, you can specify requirements for passwords:

  • Minimum length
  • Maximum age before expiration
  • Enforcement of password complexity rules

For both methods of authenticating into RICOH ProcessDirector, you can specify:

  • Whether an account can log in multiple times concurrently
  • The number of unsuccessful login or password change attempts that are allowed before the user is locked out
  • The lockout duration
  • How long accounts can be inactive before they are suspended

The Security feature records unsuccessful login attempts in the system log. If the Reports feature is installed, the Security feature also records unsuccessful login attempts in reports generated from the UserActivity report template.

The Users table and user properties notebook include user account status: Active, Locked-Inactive, or Locked-Password Failure.

To access these functions, click the Administration tab. In the left pane, click Settings Security.

1.2.1.2.20.2 AFP Support

The AFP Support feature lets you control and track jobs and individual documents in Advanced Function Presentation (AFP) format.

AFP is a set of formal information presentation architectures, including Mixed Object Document Content Architecture (MO:DCA) and Intelligent Printer Data Stream (IPDS) protocol. The printer driver component converts a device-independent AFP data stream into IPDS for input to printers.

AFP provides:

  • A transaction-oriented data stream that guarantees integrity between the RICOH ProcessDirector server and its printers because the printers can deliver the exact status of every page as it is received, printed, and stacked.
  • Support for open, industry-standard data formats.
  • Secure central management of resources. Resources do not need to reside on each printer. They can be loaded once, processed as raster images, and then reused. Confidential resources like digital signatures can be downloaded on demand and deleted at the end of a job.

When processing documents within jobs, AFP carries the information that defines the documents within the data stream for the job. A separate control file is not required to define the documents in the data stream.

The AFP Support feature has these major parts:

  • A new type of input device with supplied examples
  • Two new types of printer devices
  • New scheduling properties
  • New step templates
  • New workflows
  • Resources
  • Document processing functions

Download input device type

You can send jobs to download input devices from a z/OS host using Download for z/OS or AFP Download Plus. The DownloadAFP input device accepts AFP data sets. The DownloadLineData input device accepts line data or mixed-mode data.

AFP and PCLOut printer device types

AFP printer devices represent Intelligent Printer Data Stream (IPDS) printers. They print jobs in AFP format, including jobs that have been converted to AFP format by Transform features. AFP printer devices include many additional printer properties that control data formatting, resource and color management, and communication between the RICOH ProcessDirector server and its printers.

PCLOut printer devices represent Printer Command Language (PCL) printers. They print jobs that are submitted in AFP format and automatically converted to PCL format by the AFP print driver component of RICOH ProcessDirector. You specify the command that sends the jobs to the printer. PCLOut printer devices include some of the additional printer properties provided with AFP printer devices.

New scheduling properties

The AFP Support feature adds these scheduling properties for jobs: Job class, Job destination, and Job form.

The feature adds these scheduling properties for printers: Printer class, Printer destination, and Printer form.

New step templates

The feature adds several step templates for processing AFP jobs within workflows. For example:

  • A step based on the ConvertLineDataJobIntoAFP step template converts a line-data job into the AFP format and sets a variety of job properties that control the conversion process.
  • A step based on the EnableRepositioning step template locates the beginning of each page in an AFP or PDF job for use with the RICOH ProcessDirector viewer component. The step lets you select individual documents to print again or jump to if a printer error occurs.
  • A step based on the InsertCMR step template inserts an AFP color management resource (CMR) into a job.

New workflows

The feature supplies several workflows that you can use as templates for creating your own workflows. For example:

  • The AFP workflow processes AFP input files that are submitted to a hot folder input device or with the LPD protocol.
  • The PreviewPrintWithColorManagement workflow prints two samples of a job to an InfoPrint® 5000 using different AFP CMRs. You can then print the entire job using the CMRs you choose.
  • The OutputPDF workflow uses Transform Features to convert jobs in different data streams (such as AFP, PCL, PostScript, and SAP) to PDF files. For example, you can use the workflow to copy PDF files into a hot folder that is associated with your printer. The AFP Support feature is a prerequisite for the Transform Features.
  • The Transform workflow calls a RICOH ProcessDirector Transform or InfoPrint Transform Manager to convert the input files to the AFP format.

Resources

The feature supplies these resources:

  • Form definitions that describe the characteristics of a form: overlays required (if any), the paper source (for cut-sheet printers), duplexed printing, text suppression, and the position of the composed-text data on the form.
  • AFP color management resources (CMRs) that provide all the color management information, such as ICC profiles and halftones, that an AFP system needs to process a print job and maintain consistent color from one device to another.
  • AFP Compatibility Fonts, including both uniformly spaced and mixed-pitch type families.
  • AFP page definition resources that contain a set of formatting controls, including: the number of lines per sheet, font selection, print direction, and mappings for individual data fields to positions on the composed page.
  • Configuration files for banner pages to print on AFP printers, including the separator page that prints between copies of a multi-copy AFP job.

Document processing functions

To process individual documents within AFP jobs, the AFP Support feature adds:

  • RICOH Visual Workbench

    The AFP Indexer mode of RICOH Visual Workbench lets you identify documents and create index tags in AFP files. When you view an AFP file that contains documents and index tags in RICOH ProcessDirector, you can navigate in the file to find pages containing specific values for the index tags. You can also reprint all the pages in one or more documents.

    The Document Property Designer mode lets you customize document and job properties for AFP files. A customized property can contain the value of any index tag in an AFP document.

    The AFP Enhancer mode lets you create barcodes and text, and hide areas that contain unwanted content, such as obsolete barcodes.

  • New step templates

    Steps based on the IdentifyDocuments and BuildAFPFromDocuments step templates identify documents, extract document data values for index tags, and apply document changes made with RICOH Visual Workbench to AFP jobs.

    Steps based on the SortDocuments, SplitDocuments, and GroupDocuments step templates let you manipulate documents within a single file and output the documents as one or more new jobs.

    A step based on the SetDocPropsFromList step template lets you set the value of a document property from a list file that is external to RICOH ProcessDirector. You can use the value of the document property to group documents in a job for common processing.

    If you convert AFP documents to PDF, a step based on the EmailDocuments step template lets you email each PDF document in a job as an attachment to an individual email address.

1.2.1.2.20.3 Document processing features

Document processing features expand the capabilities of a workflow from controlling and tracking jobs to controlling and tracking individual documents in a job.

Without changing the application that creates the job, you can change how the individual documents are processed, using business rules to indicate what processing to do. You can pull documents out of a workflow, attach documents to email, or reprint individual documents. The documents in the job can be split into multiple jobs, sorted based on document-specific information such as address data, or grouped into subset jobs based on data in the document.

Two features add basic functions and objects for processing documents. You must install one or both of these features before you can install the other document processing features:

  • PDF Document Support adds functions and objects for processing documents in PDF jobs. This no-charge feature is provided with the base product but is not installed by default.

  • AFP Support adds functions and objects for processing documents in AFP jobs.

The other document processing features add functions and objects for specialized needs such as archiving document information in a repository or inserting documents into envelopes. To install these features, you must install PDF Document Support, AFP Support, or both. If you install PDF Document Support, the other document processing features work with PDF files. If you install AFP Support, they work with AFP files. If you install both, they work with both types of files. Examples of these document processing features are:

  • Archive
  • Automated Verification
  • Inserter
  • Postal Enablement
  • Preference Management

PDF Document Support and AFP Support let you identify individual documents within a job and map data, such as customer names or postal codes, in the documents to RICOH ProcessDirector document properties. RICOH ProcessDirector stores the document properties and their values in a document properties file.

PDF Document Support includes RICOH ProcessDirector Plug-in for Adobe Acrobat to identify documents and map data. You can also use the plug-in to add enhancements such as barcodes, OMR marks, images, hidden areas, and text to the documents.

AFP Support includes RICOH Visual Workbench to identify documents and map data. You can purchase features that add plug-ins to RICOH Visual Workbench:

  • AFP Editor lets you create barcodes and text, and hide areas that contain unwanted content, such as obsolete barcodes.

  • Whitespace Manager lets you define areas of white space and then fill the white space with content, such as images and text.

Object

PDF Document Support and AFP Support add the barcode format object. Barcode formats are used to interpret the data collected by a barcode scanner. You can define a barcode format that includes a document property that identifies each document in a job. Then you can scan the barcode on a document to find the document in the system.

You can use a hand-held barcode scanner attached to the computer to reconcile documents. We recommend that you configure your barcode scanner to send a New Line signal after each scan.

Workflow phase

PDF Document Support and AFP Support add the Assemble phase to the RICOH ProcessDirector workflow. The figure Document processing phase in the RICOH ProcessDirector workflow, shows how the Assemble phase fits into the workflow.

Note: If you have customized phase names in your system, those phase names differ from the phase names in the diagram.
Document processing phase in the RICOH ProcessDirector workflow
Image shows the Receive, Prepare, Assemble, Print, and Complete phases

Step templates

PDF Document Support and AFP Support add step templates for processing documents within workflows:

  • For PDF Document Support, steps based on the IdentifyPDFDocuments and BuildPDFFromDocuments step templates apply your document definitions, data mappings, and other document changes made with RICOH ProcessDirector Plug-in for Adobe Acrobat to PDF jobs.

  • For AFP Support, steps based on the IdentifyDocuments and BuildAFPFromDocuments step templates apply your document definitions, data mappings, and other document changes made with RICOH Visual Workbench to AFP jobs.

  • A step based on the SetDocPropsFromConditions step template lets you update the document properties file for a job based on other document and job property values. For example, you can group documents based on a particular postal code range, and then create separate child jobs for the postal code groups.

  • Steps based on the SortDocuments, SplitDocuments, and GroupDocuments step templates let you manipulate documents within a single file and output the documents as one or more new jobs.

  • A step based on the EmailDocuments step template lets you email each PDF document in a job as an attachment to an individual email address. RICOH ProcessDirector can send email directly through the default SMTP server or indirectly through an email service provider.

  • A step based on the SetDocPropsFromList step template lets you read one or more list files in a directory and set the value of a specified document property for each document in the document properties file for the job. You can use the value of the document property to group documents in a job for common processing. For example, using this step, you can provide a "pull list" of documents in a job. Using the pull list, you can suppress documents from printing, divert them from inserting, or send them to an express mail service.

  • A step based on the SetPropertiesForReconcile step template lets you use the Insert sequence document property to find documents on the Reconcile Job dialog or the Documents portlet.
  • A step based on the Reconcile step template lets an operator set an action to take for the documents in a job. You can place a Reconcile step after a PrintJobs step in a workflow. When a job enters the Reconcile step, the operator selects the Reconcile action to reconcile a job manually. During manual reconciliation, the operator marks documents that are OK, any documents to be reprinted, and any documents to pull from the job without reprinting.

  • A step based on the CreateReprints step template processes documents to be reprinted after reconciliation by creating a child job containing only the reprints. The child job can be sent through the same workflow as the original job or through a different workflow.

For a complete list of step templates supplied with document processing features, see the Reference section of the RICOH ProcessDirector information center.

1.2.1.2.20.3.1 PDF Document Support

The PDF Document Support feature adds functions and objects that let you process individual documents in PDF jobs. The feature includes RICOH ProcessDirector Plug-in for Adobe Acrobat.

The plug-in lets you identify documents in a sample PDF file that represents your production PDF files. In the sample PDF file, you add markup such as barcodes and text to the documents, and you map data in the documents to document properties so that RICOH ProcessDirector can extract the data.

1.2.1.2.20.3.1.1 Processing PDF files that contain documents

The PDF Document Support feature lets you manipulate the individual documents in a PDF file. For example, you can rearrange their output order or group them according to different envelope size requirements. You can find a specific document by searching for a document property in the PDF file.

You use RICOH ProcessDirector Plug-in for Adobe Acrobat to define page groups, document properties, markup, media, and finishing for a sample PDF file. You save those definitions in a control file.

Steps in a workflow extract information about the documents in a PDF file and store that information in a document properties file, which is structured like a table. The document properties file lets RICOH ProcessDirector do operations on individual documents rather than only on the job as a whole.

When you create a workflow to receive PDF files, you include a step based on the IdentifyPDFDocuments step template. You specify the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that contains the page group definition and any document properties. This step builds a document properties file that represents an inventory of all the documents in the job.

To process individual documents, you can add steps to the Assemble phase of the workflow based on these step templates:

  • GroupDocuments lets you classify all the documents into groups based on up to six document properties. For example, if you had a file of 5000 insurance policy addenda documents, you could group all of them into all the combinations of policy type (auto or home) and state.
  • SortDocuments lets you sort documents by up to six document properties. For example, you could alphabetize the policy addenda within each group so you would have all the auto policies in states A-Z followed by all the home policies in states A-Z.
  • SplitDocuments lets you divide a large job into several smaller jobs based on the number of documents or the number of sheets in the smaller job.

Each of these steps adds or changes information in the document properties file without changing the contents of the original PDF job. The document properties file that was created initially to identify all of the documents has more information added to it, such as the location of each document in the rearranged PDF file.

After you define steps to manipulate the documents into the new grouping and order that you want, you include a step in the Assemble phase of the workflow that builds a new PDF file with the individual documents organized according to that ordering. You use a step based on the BuildPDFFromDocuments step template if you want to create a single output job based on the newly ordered documents. However, if you want to create separate output jobs because you used the SplitDocuments step or you want to print each group of documents created by the GroupDocuments step separately, you also add a step based on the CreateJobsFromDocuments step template.

To allow for more complicated manipulation of the documents, you can add multiple RICOH ProcessDirector Plug-in for Adobe Acrobat control files that define different markup to be added to each document. You specify the name of the control files containing these definitions when you create the BuildPDFFromDocuments step in the Assemble phase of a workflow.

The remainder of the workflow that processes PDF jobs looks the same as if you did not have PDF Document Support installed-steps can enable repositioning of the print job in case you need to recover from a paper jam or reprint selected documents, and a step based on the PrintJobs step template manages the print processing. Steps in the Complete phase let you retain the job in RICOH ProcessDirector for an interval you specify, and then the job is deleted from the system when that interval expires.

If you want to view the values of document properties in the user interface or to search for a document based on a property value, include a WriteDocumentsToDatabase step in your workflow. This step saves document property values to the document database.

1.2.1.2.20.3.1.2 Using RICOH ProcessDirector Plug-in for Adobe Acrobat

RICOH ProcessDirector Plug-in for Adobe Acrobat is an Adobe Acrobat Professional plug-in that you use to define and display enhancements in a PDF file that represents the PDF files that are processed by the steps in your workflows.

Enhancements include barcodes, OMR marks, images, hidden areas, and text. The enhancements you define in the PDF file are not saved in the PDF file; instead, they are saved in control files that you make available to a server used by RICOH ProcessDirector. RICOH ProcessDirector uses the control files to apply the same enhancements to production PDF files when it processes them for printing.

To extend markup capabilities, RICOH ProcessDirector Plug-in for Adobe Acrobat provides page groups, document properties, and conditional processing.

1.2.1.2.20.3.1.2.1 Page groups

A page group is a set of pages that make up a single document, such as a mailpiece or customer statement, within a PDF file. In RICOH ProcessDirector Plug-in for Adobe Acrobat, a document is a page group. A single PDF file can contain many documents. If an entire PDF file is treated as a single page group, the PDF file represents one document.

You should define a page group before you add markup. After you define a page group, you can apply markup to specific pages in each document. For example, you can add a barcode to the first page of each document, an image to all front-facing pages of each document, or text to the first back-facing page of each document.

You can define a page group in these ways:

  • As the entire PDF file.

  • As a fixed number of pages.

  • Based on text you select that is in the same location on the first page of each page group.

    RICOH ProcessDirector Plug-in for Adobe Acrobat uses the repeated text to determine the first page of each page group. For example, you have 100,000 customer statements in one PDF file. Each statement has three or more pages. To define a page group, you select Page 1 of, which is in the same location on the first page of each statement.

    Note: If you are using a sample PDF file to define page groups, make sure that the content and location of the text you select are consistent among the production PDF files.

  • Based on a specific key word or phrase that appears on the first page of a document within a region of text. The surrounding text might change, but the key word or phrase remains the same.

  • Based on text you specify that is on the first page of each page group. When you type the text, you can include wildcard characters. RICOH ProcessDirector Plug-in for Adobe Acrobat interprets the wildcard characters as any character.

  • Based on Java regular expressions that you define to specify text on the first page of each page group.

    For example, you define a Java regular expression so that RICOH ProcessDirector Plug-in for Adobe Acrobat starts a new page group each time it finds the English text Page 1 of or the Spanish text Página 1 de.

  • When text in a selected area changes.

    For example, you draw a box around the account name on a statement in a PDF file. Whenever the text in the box changes, that page becomes the first page of a new page group. The location of the box on every page must encompass only the text to evaluate or white space (no text).

Use the Page Group Navigator to see a list of the pages in each page group. After you verify that the page groups are correct, save your control file, which contains your new page group definition. If you define document properties, save them in the same control file. You then add the name and location of the control file to a RICOH ProcessDirector step based on the IdentifyPDFDocuments step template.

1.2.1.2.20.3.1.2.2 Document properties

A document property is data, such as a customer name or postal code, extracted from a specific location on a page within a document. Using document properties, you can add markup based on variable information. For example, you can add a different image to documents sent to different states or provinces.

RICOH ProcessDirector Plug-in for Adobe Acrobat has an advanced address block parsing tool to help you extract city, state or province, postal code, and other document properties from complex, variable line addresses. If you need to reprint documents in a job, you can use RICOH ProcessDirector to search for document property values to find the specific documents you need to reprint.

You can define your own document property or select a RICOH ProcessDirector document property from a drop-down list. You can use RICOH ProcessDirector document properties with functions provided by RICOH ProcessDirector document processing features.

Note: When you use RICOH ProcessDirector Plug-in for Adobe Acrobat to define document properties, you select from a list of your RICOH ProcessDirector document properties. After you install RICOH ProcessDirector Plug-in for Adobe Acrobat or any time that you change RICOH ProcessDirector document properties, you need to load the document properties into RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see RICOH ProcessDirector: Installing Document Processing Features.

Click Ricoh View Document Property Values to verify that document property values are extracted correctly.

If you want to use document property values with an external program, you can save the values to a tab-delimited text file.

1.2.1.2.20.3.1.2.3 Conditional processing

When you add markup to a PDF file using RICOH ProcessDirector Plug-in for Adobe Acrobat, you can create conditional processing rules to place the markup on specific pages.You also can use conditional processing rules to apply media and finishing options and to specify the pages from which RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector extract document property values.

Rules can specify conditions based on pages within documents, such as All Front Pages, as well as on job properties, document properties, statistics, and conditional triggers (text that determines whether a condition is met).

For example, you want the word Invoice at the top of the first page of a statement to trigger the placement of a barcode. First, you select the word Invoice and define it as a conditional trigger. Then you define a rule that specifies the conditional trigger. When you add a barcode to a PDF file, you specify this rule to control placement of the barcode. The barcode only prints on the pages where the word Invoice appears in the location specified by the conditional trigger.

Your RICOH ProcessDirector workflows can contain steps that set job property values during RICOH ProcessDirector processing. If you use RICOH ProcessDirector Plug-in for Adobe Acrobat to define a rule with a job property, you can dynamically create and alter how the rule is applied by setting the job property value in RICOH ProcessDirector. For example, you could use the Job.CustomerName job property to print a barcode only when the value of that property is BANK. RICOH ProcessDirector also keeps track of job processing statistics, such as the current page in a document. If you want to apply a barcode to page three in every document in a PDF job, you can make Stat.CurrentPageInDocument = 3 a condition for the application of a rule.

1.2.1.2.20.3.1.2.4 Markup

RICOH ProcessDirector Plug-in for Adobe Acrobat supports five types of markup: barcodes, OMR marks, images, text, and hidden areas.

For each type of markup, you assign a name that identifies the markup contents. Then you assign values for location, placement, and other properties. You can define document properties and conditional processing for markup using data that varies by document within the PDF file.

When RICOH ProcessDirector Plug-in for Adobe Acrobat displays a PDF file, your markup appears as a set of boxes with names. The PDF file is not altered. The Markup Navigator lets you locate and edit markup that is hidden under other markup.

To view and verify the content and placement of your markup on specific pages, you preview the PDF file.

1.2.1.2.20.3.1.2.5 Control files

A control file saves your page group definition, document properties, conditional triggers, and markup independently of a PDF source file. Control files are templates that RICOH ProcessDirector uses to apply the same markup rules to the PDF files it processes.
    Note:
  • Saving your PDF source file by clicking File Save or File Save As does not save your RICOH ProcessDirector Plug-in for Adobe Acrobat page groups, document properties, or markup.

To use the RICOH ProcessDirector IdentifyPDFDocuments step in a PDF workflow, you must add the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that defines page groups or document properties for that step. Any markup definition must be saved to one or more control files that are used by the RICOH ProcessDirector BuildPDFFromDocuments step.

You do not need to create separate control files for the page group, document properties, and markup definitions: all definitions can be saved in one control file if that control file is added to both the IdentifyPDFDocuments and the BuildPDFFromDocuments steps. However, you might choose to create multiple control files if you can apply one or more control files to different PDF workflows. For example each workflow might require its own document properties, but some workflows might require the same area to be hidden to cover OMR marks. For each workflow you would save a separate control file that defines document properties, but save only one control file to hide OMR marks. In each workflow, you would specify the workflow-specific control file that defines document properties. But in the step in each workflow that is based on the BuildPDFFromDocuments step template, you would specify the same control file that contains the hidden-area definition.

    Note:
  • The IdentifyPDFDocuments step uses one control file to create page groups and extract document properties. The BuildPDFFromDocuments step optionally uses one or more control files to apply markup and restructure a PDF file. ( BuildPDFFromDocuments does not require a control file.) In order to preview markup, you must define a page group and the document property definitions whose values you use in markup content. If you save a page group or property definition to a control file that you add to the BuildPDFFromDocuments step, RICOH ProcessDirector ignores those definitions. The BuildPDFFromDocuments step receives page grouping and document properties definitions from a workflow that includes the IdentifyPDFDocuments step.

See the help topics on RICOH ProcessDirector Plug-in for Adobe Acrobat control files and previewing markup for more information.

1.2.1.2.20.3.1.2.6 Sample PDF files

If your production PDF files are large (for example, over 1000 pages in length), you should mark up a smaller sample PDF file that represents the PDF files you process in RICOH ProcessDirector.

You only need to mark up one sample PDF file, save all your changes to control files, and then use RICOH ProcessDirector to apply those changes to all of your production PDF files that match the sample PDF file. If you use RICOH ProcessDirector to process several PDF files that have different formats or different document properties, you need to mark up a sample PDF file for each type of file that you print using RICOH ProcessDirector. When working with RICOH ProcessDirector Plug-in for Adobe Acrobat, the goal is to mark up a PDF file that represents your production PDF files but that is smaller than your production files. If you mark up a PDF file in RICOH ProcessDirector Plug-in for Adobe Acrobat that is under 1,000 pages, you can work more quickly when adding markup and when using preview and viewing extracted document properties.

Both your sample PDF file and PDF files processed by RICOH ProcessDirector must contain all fonts and images in the PDF file itself. If you have PDF files with varying page sizes, markup may not appear as you expect. The placement reference for all markup, document properties, and page group definitions is the top left corner of each page.

1.2.1.2.20.3.2 AFP support for documents

In addition to functions and objects that let you process AFP jobs, the AFP Support feature adds functions and objects that let you process individual documents in AFP jobs. The feature includes RICOH Visual Workbench.

With AFP Indexer mode of RICOH Visual Workbench, you identify documents and create index tags in a sample AFP file that represents your production AFP files. With Document Property Designer mode, you customize document and job properties and link them to index tags that are defined in the sample AFP file. With AFP Enhancer mode, you create barcodes and text, and hide areas that contain unwanted content, such as obsolete barcodes.

You can purchase additional features that add plug-ins to RICOH Visual Workbench, such as AFP Editor and Whitespace Manager, that expand its capabilities. For example, AFP Editor lets you create barcodes and hide areas in indexed AFP files. Whitespace Manager lets you define areas of white space and then fill the white space with content, such as images and text.

1.2.1.2.20.3.2.1 Processing AFP files that contain documents

The AFP Support feature lets you manipulate the individual documents in an AFP file. For example, you can rearrange their output order or group them according to different envelope size requirements .You can find a specific document by searching for a document property in the AFP file.

You use the AFP Indexer mode of RICOH Visual Workbench to create named page groups and index tags in the original job data. Then you use the Document Property Designer mode of the RICOH Visual Workbench to map the index tags to document properties that you want to use to locate and manipulate documents. You use the AFP Enhancer mode to create barcodes and text and hide areas that contain unwanted content such as obsolete barcodes.

The RICOH Visual Workbench creates a control file containing those mappings.

Steps based on AFP Support step templates extract information about the documents in an AFP file and store that information in a document properties file, which is structured like a table. The document properties file lets RICOH ProcessDirector do operations on individual documents rather than only on the job as a whole.

When you create a workflow to receive AFP files, you include a step based on the IdentifyDocuments step template. You specify the RICOH Visual Workbench control file that contains the page group definition and any document properties. This step builds a document properties file that represents an inventory of all the documents in the job.

To process individual documents, you can add steps to the Assemble phase of the workflow based on these step templates:

  • GroupDocuments lets you classify all the documents into groups based on up to six document properties. For example, if you had a file of 5000 insurance policy addenda documents, you could group all of them into all the combinations of policy type (auto or home) and state.
  • SortDocuments lets you sort documents by up to six document properties. For example, you could alphabetize the policy addenda within each group so you would have all the auto policies in states A-Z followed by all the home policies in states A-Z.
  • SplitDocuments lets you divide a large job into several smaller jobs based on the number of documents or the number of sheets in the smaller job.

Each of these steps adds or changes information in the document properties file without changing the contents of the original AFP job. The document properties file that was created initially to identify all of the documents has more information added to it, such as the location of each document in the rearranged AFP file.

After you define steps to manipulate the documents into the new grouping and order that you want, you include a step in the Assemble phase of the workflow that builds a new AFP file with the individual documents organized according to that ordering. You use a step based on the BuildAFPFromDocuments step template if you want to create a single output job based on the newly ordered documents. If, however, you want to create separate output jobs because you used the SplitDocuments step or you want to print each group of documents created by the GroupDocuments step separately, you instead use a step based on the CreateAFPJobsFromDocuments step template.

To allow for more complicated manipulation of the documents, you can build an Enhance AFP control file that defines text or barcode data to be added to each document, or to identify text blocks or areas to be removed from each document. You specify the name of the control file containing these definitions when you create the BuildAFPFromDocuments or CreateAFPJobsFromDocuments step in the Assemble phase of a workflow.

The remainder of the workflow that processes AFP jobs looks the same as if you did not have AFP Support installed—steps can enable repositioning of the print job in case you need to recover from a paper jam or reprint selected documents, and a step based on the PrintJobs step template manages the print processing. Steps in the Complete phase let you retain the job in RICOH ProcessDirector for an interval you specify, and then the job is deleted from the system when that interval expires.

If you want to view the values of document properties in the user interface or to search for a document based on a property value, include a WriteDocumentsToDatabase step in your workflow. This step saves document property values to the document database.

1.2.1.2.20.3.2.2 Introduction

RICOH Visual Workbench lets you 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 then applies the same enhancements to production AFP files when it prepares them for processing.

Page groups or documents are AFP structures that organize AFP files into smaller, uniquely identifiable units. For example, an AFP file contains several bank statements that all have the same format. Each statement is a page group. RICOH Visual Workbench lets you apply the same enhancements on all the page groups in the AFP file.

Modes

RICOH Visual Workbench has these modes:

  • AFP Indexer lets you create AFP page groups and indexes, and define supplemental pages.
  • Document Property Designer lets you assign values to document properties.
  • AFP Enhancer lets you create barcodes and text, and hide areas that contain unwanted content, such as obsolete bar codes.

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

RICOH Visual Workbench, AFP Indexer, Document Property Designer, Pipeline Manager, and AFP Enhancer are all part of the AFP Support feature.

Plug-ins

Two components plug in to RICOH Visual Workbench:

  • The AFP Editor component, like AFP Enhancer, lets you create barcodes and text, and hide areas that contain unwanted content. In addition, AFP Editor lets you:
    • Create PDF417 barcodes.

    • Automatically replace POSTNET barcodes with Intelligent Mail barcodes that have the same routing code.

    • Create a condition between two barcodes that determines which barcode is created in a page group.

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

Control files

RICOH Visual Workbench creates two control files:

  • Visual Workbench control file

    When you enhance a sample AFP file with any of the modes or plug-ins, RICOH Visual Workbench creates a Visual Workbench control file with information about the enhancements you made. One or more steps in the workflow use the control file to apply all the enhancements, except those made with AFP Enhancer, to production AFP files.

  • EnhanceAFP control file

    One or more steps in the workflow use the EnhanceAFP control file to apply all the enhancements made with AFP Enhancer to production AFP files. You export the EnhanceAFP control file when you are ready to use it in a workflow. If you want to make more enhancements with AFP Enhancer after you export the EnhanceAFP control file, first you load the Visual Workbench control file that contains the original enhancements. You use AFP Enhancer to make the additional enhancements and save the Visual Workbench control file. Then you export an updated version of the EnhanceAFP control file to apply the new enhancements to the workflow.

User interface

The RICOH Visual Workbench user interface displays the sample AFP file and lets you select modes and plug-in features to enhance the file. The user interface lets you interact with the file by clicking text to select it and drawing boxes to indicate positions. For example:

  • You click text that you want to index or use as a trigger to create page groups.

  • You draw a box you where you want to create a barcode or text.

AFP data requirements

AFP files that contain data in Mixed Object Document Content Architecture for Presentation (MO:DCA-P) format are required for use with RICOH Visual Workbench.

1.2.1.2.20.3.2.2.1 User interface

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

The RICOH Visual Workbench 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.
    Note:
  • The user interface can display AFP files that the RICOH ProcessDirector transform features transformed to AFP format (for example, from PDF to AFP). You can also enhance these AFP files.

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. The Document Property Designer mode lets you customize document properties.

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 Workbench 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, RICOH Visual Workbench 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.
Exit
Stops RICOH Visual Workbench. If you have not saved the control file for the AFP file that is open, RICOH Visual Workbench 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, and hidden areas.

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.
AFP Enhancer Modify Definitions

Lets you modify or delete definitions for barcodes, text and hidden areas.

Export Enhance AFP Control File

Lets you save an Enhance AFP control file to a directory on the primary computer.

Document Properties Link Document Properties

Lets you link document properties to index tags.

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 features 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, and text strings 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.
AFP EnhancerAFP Enhancer mode
Creates barcodes and text and hides areas that contain unwanted content such as obsolete barcodes.
Document Property Designer Document Property Designer mode
Links document properties to index tags in the control file.
Pipeline Manager
Orders and runs a set of filters.
Help
The Help menu options are:
AFP Enhancer Help
In AFP Enhancer mode, opens the help topics for AFP Enhancer.
Document Property Designer
In Document Property Designer, opens the help topics for Document Property Designer.
Help Contents (F1)
Opens help topics for the RICOH Visual Workbench in the RICOH ProcessDirector information center.
About
Displays the version number of RICOH Visual Workbench 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.

If Document Property Designer is installed, the Document Properties tab lists the document properties, the index tag the property is linked to, and the link options. You can double-click a property to link it to an index tag or to change the link options.

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.2.1.2.20.3.2.2.2 Control files

RICOH Visual Workbench control files contain information about the enhancements made to sample AFP files. A step in the workflow uses the control file to make the same enhancements to production AFP files.

When you enhance a sample AFP file, RICOH Visual Workbench 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, RICOH Visual Workbench can use the same control file. All enhancements for the sample AFP file must be defined in the same control file. RICOH Visual Workbench 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. In addition, select a directory that is automatically backed up. For example, you could create directory /aiw/aiw1/control_files/workbench (on Linux) or C:\aiw\aiw1\control_files\workbench (on Windows) and save all control files in that directory. On Linux, permissions should be set so that the RICOH ProcessDirector system user (aiw1 is the default) or all users in the RICOH ProcessDirector group (aiwgrp1 is the default) can read and update files in the directory.

RICOH ProcessDirector provides step templates that use the information in the control file to make enhancements to production AFP files. You can include these step templates in any workflow:

  • IndexAFP: A step based on this step template uses the information in the control file to create page groups and index tags, and define supplemental pages.
  • EditAFP: A step based on this step template uses the information in the control file to create bar codes, text, and hidden areas. As an option, RICOH ProcessDirector can first create page groups and index tags that are defined in the same control file. This step template is available only if AFP Editor is installed.
  • FillWhiteSpace: A step based on this step template uses the information in the control file to fill white space areas in AFP files with content, such as images or text. As an option, RICOH ProcessDirector can first create page groups and index tags that are defined in the same control file. This step template is available only if Whitespace Manager is installed.
  • IdentifyDocuments: A step based on this step template uses the information in the control file to calculate values for document properties.

When you configure the step in a workflow, you can use symbolic notation for the name of the Visual Workbench control file. Symbolic notation lets you use the same workflow for input files that require different Visual Workbench control files. For example, if you have two input files, abc.afp and xyz, with corresponding control files, abc.afp.ctl and xyz.ctl, and you want to use the same workflow for both files, you can use ${Job.InputFile}.ctl as the control file. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the Visual Workbench control file property to the name of the input file plus the .ctl extension.

1.2.1.2.20.3.2.2.3 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 in RICOH ProcessDirector, you can navigate in the file to find pages containing specific index values.

You can also reprint all the pages in one or more page groups. In addition, AFP Editor, Document Property Designer, and Whitespace Manager can use the page groups and index values to define barcodes, text strings, and white space.

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

1.2.1.2.20.3.2.2.3.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.2.1.2.20.3.2.2.3.3 Index tags

The AFP Indexer mode of RICOH Visual Workbench 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 in RICOH ProcessDirector, 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. If you installed AFP Editor, you can 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.

1.2.1.2.20.3.2.2.4 AFP Editor

The AFP Editor feature is a plug-in to RICOH Visual Workbench. 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. You make these enhancements in sample AFP files that represent your production AFP files.

AFP Editor creates these types of barcodes:

  • Code 39

  • Data Matrix

  • Interleaved 2–of-5

  • Intelligent Mail (IMB)

  • Portable Data File 417 (PDF417)

  • POSTNET

  • Quick Response (QR) Code

AFP Editor lets you:

  • Hide existing barcodes and replace them with new barcodes.

  • Automatically replace POSTNET barcodes with Intelligent Mail barcodes that have the same routing code.

  • Create a condition between two barcodes that determines which barcode is created in a document.

    For example, an AFP file has QR Codes on some but not all documents. You want to add a new, larger QR Code to each document that does not have a QR Code. You define a QR Code that matches the existing QR Code, and you define the new QR Code. You create a condition so that whenever a document does not have a QR Code, the new QR Code is added.

To define a barcode or text, you use the values of index tags, job properties, and static text. For example, you use the AFP Indexer mode of RICOH Visual Workbench to define a postal code as an index tag. AFP Editor lets you create a barcode that uses the value of the index tag for the postal code.

Note: AFP Editor lets you include the value of a document property in a barcode only if an index tag in the documents is mapped to the document property. For example:
  • You map an index tag that contains the postal code to the Postal code document property, and you use the value of the index tag that contains the postal code when you define a barcode. The barcode contains the value of the Postal code document property.

  • You are using the Automated Verification feature, so the barcodes must contain both the Job number and Sequence in child job properties. AFP Editor cannot create a barcode that contains the Sequence in child job document property, because the documents have no data about their relative position within a child job. RICOH ProcessDirector computes the value of the Sequence in child job document property for each document. As a result, you must use AFP Enhancer to generate those barcodes.

AFP Editor lets you put the page in the page group and the page count for the page group in barcodes and text. For example, AFP Editor lets you put Page 1 of 5 in a barcode that prints on page 1 and Page 2 of 5 in a barcode that prints on page 2.

AFP Editor lets you limit the placement of barcodes, text, and hidden areas to specific pages in each document. For example, AFP Editor lets you place a barcode on the first page of each document or text on all the even-numbered pages.

Control file used with AFP Editor

You save your AFP Editor work in a Visual Workbench control file.

When you are ready to use the barcodes, text, and hidden areas in a workflow, send or copy the Visual Workbench control file to a directory on the primary computer that RICOH ProcessDirector has access to.

New step template

AFP Editor adds the EditAFP step template. A step based on this step template uses information in a RICOH Visual Workbench control file to create barcodes, text, and hidden areas in AFP files.

1.2.1.2.20.3.2.2.4.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. The AFP Enhancer mode of RICOH Visual Workbench 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 Reed-Solomon 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.
  • 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 Reed-Solomon error correction algorithm (ECC 200) to ensure data reliability.

The AFP Editor feature lets you create all the types of barcodes listed above and an additional type of barcode:

  • 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 uses Reed-Solomon error correction.

1.2.1.2.20.3.2.2.4.1.1 Barcode placement and orientation

When you use the RICOH Visual Workbench 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 document. The area can be a horizontal rectangle (for a picket-fence barcode), a vertical rectangle (for a ladder barcode), or a square.
Note: The terms document and page group are synonyms.

AFP Enhancer and AFP Editor have different capabilities for placing barcodes.

Both AFP Enhancer and AFP Editor let you limit the placement of a barcode to specific pages in each document. For example, you can place a barcode on the first page of each document or on all the even-numbered pages.

AFP Enhancer lets you limit the placement based on conditional processing. For example, you can create a CEL expression to place a barcode on the first page of a document based on the value of the State document property.

To specify an orientation with AFP Enhancer, you edit the EnhanceAFP control file manually.

AFP Editor lets you 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

1.2.1.2.20.3.2.2.4.1.2 Data for most types of barcodes

AFP Enhancer and AFP Editor let you create Code 39, Data Matrix, Interleaved 2-of-5, PDF417 (AFP Editor only), POSTNET, and QR Code barcode objects that follow the AFP Bar Code Content Object Architecture (BCOCA). AFP Enhancer and AFP Editor use the default values for all BCOCA properties and display the default properties you can change.

For information about the default values, see Bar Code Object Content Architecture Reference, S544-3766.

AFP Enhancer lets you define a barcode with the Content Expression Language (CEL). Components of CEL expressions include index values, document properties, job properties, keywords, and static text.

AFP Editor lets you specify this data to encode in the barcode symbol, in any combination, provided that 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. The barcode data for text is the same in every page group.
  • Human-readable interpretation (HRI).
  • Code page encoding.

1.2.1.2.20.3.2.2.4.1.3 Intelligent Mail barcode data

Intelligent Mail barcodes (IMBs) have several representations and two basic formats. A serial number that identifies each mailpiece is required when IMBs are used with the United States Postal Service (USPS) Intelligent Mail Full-Service option.
Representations

AFP Enhancer lets you create Intelligent Mail barcodes (IMBs) in one of these representations:

  • BCOCA objects: This object follows the Bar Code Content Object Architecture (BCOCA).
  • Generic barcodes: This object guarantees compatibility on all IPDS printers.
  • Font barcodes: A Presentation Text Object Content Architecture (PTOCA) object with transparent text represents the content. The referenced font resource must be available when printing.
  • DrawRule barcodes: A PTOCA object uses rules to represent the content.

AFP Editor lets you create Intelligent Mail barcodes (IMBs) in one of these representations:

  • BCOCA objects: Barcode 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 other barcode representations. However, some older printers, such as IBM 3900 printers, cannot process BCOCA IMBs. To print on these printers, you must use other barcode representations to create IMBs.

Formats

IMBs have 5 elements and up to 31 digits. The mailer ID and serial number elements combine to fill 15 of the digits. There are 2 basic formats for IMBs, based on the length of the mailer ID assigned by the USPS. The 2 figures show the formats:

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

Both IMB formats have these elements:

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.

AFP Editor lets you specify these IMB elements on the Data tab.

AFP Enhancer lets you specify these IMB elements using Content Expression Language (CEL). For example, you can use this supplied CEL example:

'04260' Job.Postal.MailerID fmt("%05d",Doc.Address.ZipCode) '00'

Content of CEL example Information to substitute or insert
04 Replace 04 with your 2-digit Barcode ID.

If you have the Postal Enablement feature, the Job.Postal.MailStream job property specifies this information. Define the property as your Barcode ID in the SetPostalJobProps step.

260 Replace 260 with your 3-digit Service type ID.

If you have Postal Enablement, the Job.Postal.Type job property specifies this information. Define the property as your Service type ID in the SetPostalJobProps step.

Job.Postal.MailerID Replace this job property with a custom job property, such as Job.Info.Attr1. Define the property as your Mailer ID in the SetJobPropsFromTextFile step.

If you have Postal Enablement, use this job property to specify the Mailer ID. Define the property as your Mailer ID in the SetPostalJobProps step.

If you do not need to specify a unique serial number for each document:
  • Insert a space, 6 zeroes, and another space between Job.Postal.MailerID and fmt("%05d",Doc.Address.ZipCode) if you have a 9-digit Mailer ID.

  • Insert a space, 9 zeroes, and another space if you have a 6-digit Mailer ID.

If you need to specify a unique serial number, see the next section.

fmt("%05d",Doc.Address.ZipCode) Create an index tag for the ZIP code data and map the index tag to the Doc.Address.ZipCode document property.

If the ZIP code is nine digits, change "%05d" to "%09d".

'00’ If you want to extend the barcode by two digits, leave this content in the example.

If you do not want to extend the barcode by two digits, delete this content.

This CEL example uses the Job.Info.Attr1 job property with a 6-digit Mailer ID and a 5–digit ZIP code:

'04080' Job.Info.Attr1 000000000 fmt("%05d",Doc.Address.ZipCode) '00'

This CEL example uses Postal Enablement job properties with a 9–digit Mailer ID and a 9–digit ZIP code:

Job.Postal.MailStream Job.Postal.Type Job.Postal.MailerID 000000 fmt("%09d",Doc.Address.ZipCode)

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.

AFP Enhancer

AFP Enhancer lets you specify a serial number using a document property.

To add a serial number to the '04260' Job.Postal.MailerID fmt("%05d",Doc.Address.ZipCode) '00' supplied CEL statement:

  • Insert a format function fmt() with the document property you are using for the serial number.

    For example, insert fmt("%09d",Doc.Custom.AccountNumber):

    '04260' Job.Postal.MailerID fmt("%09d",Doc.Custom.AccountNumber) fmt("%05d",Doc.Address.ZipCode) '00'

    The format function expands the number to 9 digits if you specify "%09d" or to 6 digits if you specify "%06d".

  • Create an index tag for the account number data and map the index tag to the document property, for example, Doc.Custom.AccountNumber.

    Note: If you want to use data that repeats every month as the serial number but the serial number must not repeat for 45 days, create an index tag for the month data in a document date. Map the index tag to a custom document property, such as Doc.Custom.Month. Insert 2 format functions:

    fmt("%02d",Doc.Custom.Month) fmt("%07d",Doc.Custom.AccountNumber)

AFP Editor

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.

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

    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.

When the EditAFP step 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 the EditAFP step processes.

For example, if the serial number file contains the 6-digit serial number 000001, and the EditAFP step 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. You can specify a different serial number file for each sample AFP file that has its own control file. Make sure the serial number file has the appropriate permissions set so that the RICOH ProcessDirector system user (aiw1 is the default) and all users in the RICOH ProcessDirector group (aiwgrp1 is the default) can read and update the file.

Note: The EditAFP step processes 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.

1.2.1.2.20.3.2.2.4.1.4 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 deletes POSTNET barcodes and creates 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.2.1.2.20.3.2.2.4.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. 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.2.1.2.20.3.2.2.5 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.2.1.2.20.3.2.2.5.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.2.1.2.20.3.2.2.5.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.2.1.2.20.3.2.2.6 Pipeline Manager

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

The AFP Indexer and AFP Enhancer modes have filters. If AFP Editor and Whitespace Manager are installed, they also have filters. By using the filters for modes and plug-ins, 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.2.1.2.20.3.2.2.6.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.2.1.2.20.3.2.2.6.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.2.1.2.20.3.2.2.6.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.2.1.2.20.3.2.2.7 AFP Enhancer

AFP Enhancer mode of RICOH Visual Workbench 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. You make these enhancements in sample AFP files that represent your production AFP files.

AFP Enhancer creates these types of barcodes:

  • Code 39

  • Data Matrix

  • Interleaved 2–of-5

  • Intelligent Mail (IMB)

  • POSTNET

  • Quick Response (QR) Code

AFP Enhancer lets you hide existing barcodes and replace them with new barcodes.

To define a barcode or text, you use the Content Expression Language (CEL). Components of CEL expressions include index values, document properties, job properties, keywords, and static text. Several CEL examples are provided.

AFP Enhancer lets you limit the placement of barcodes, text, and hidden areas to specific pages in each document. For example, AFP Enhancer lets you place a barcode on the first page of each document or text on all the even-numbered pages. AFP Enhancer also lets you limit placement based on conditional processing. For example, you create a CEL expression to place text on the first page of a document when the value of the State document property is California or New York.

Control files used with AFP Enhancer

You save your AFP Enhancer work in a Visual Workbench control file.

When you are ready to use the barcodes, text, and hidden areas in a workflow, you use the Export EnhanceAFP Control File function to save an EnhanceAFP control file to a directory on the primary computer that RICOH ProcessDirector has access to.

Note: AFP Enhancer lets you use a graphical user interface to create the information in the EnhanceAFP control file. Another way to create or modify an EnhanceAFP control file is with a text editor. If you edit the file, that information is not available to AFP Enhancer.

Step templates used with AFP Enhancer

These step templates use the EnhanceAFP control file to change the content of AFP files:

  • BuildAFPFromDocuments

    A step based on this step template creates an AFP file for a job. If you define barcodes, text, and hidden areas in an EnhanceAFP control file, this step applies them. The AFP file produced by this step becomes the AFP file for the subsequent steps in the workflow.

  • CreateAFPJobsFromDocuments

    A step based on this step template generates one or more child AFP jobs. If you define barcodes, text, and hidden areas in an EnhanceAFP control file, this step applies them.

  • BuildEnhanceAFPFile (for Advanced Document Pool only)

    If you have the Document Pool extended feature, a step based on this step template creates a control file that manages enhancements so that some documents have different enhancements than other documents.

1.2.1.2.20.3.2.2.8 Document Property Designer

Document Property Designer lets you customize document and job properties for AFP files. You can use these properties in your workflows in a variety of ways.

You can work with your RICOH ProcessDirector support representative to define custom properties for your installation. You can define these document properties, for example:

  • To sort documents according to ZIP codes, you can define a custom document property named Zip code.
  • To group documents according to account numbers, you can define a custom document property named Account number.

A customized property can contain the value of any index tag in an AFP document. Index tags are called Tagged Logical Elements (TLEs) in the AFP architecture.

You use Document Property Designer to link the properties to index tags that are defined in a sample AFP file that represents your production AFP files. Document Property Designer creates a Visual Workbench control file with information about how the properties are linked to index tags. Then you configure the RICOH ProcessDirector steps that calculate the values of properties. The steps use the control file to determine how document or job properties are linked to index tags.

For example, if you have defined a document property named Zip code, and each document in your sample AFP file contains an index tag named mail code that contains the ZIP code, you can use the Document Property Designer to link the Zip code document property to the mail code index tag. When a document property is linked to an index tag, RICOH ProcessDirector assigns the value of the index tag to the document property in the production AFP jobs that contain the same index tags as the sample AFP file.

You can link the same property to different index tags in different sample AFP files. For example, if one sample AFP file has an index tag named mail code and a second sample AFP file has an index tag named route code, you can link the same document property to index tag mail code in the first sample AFP file and to index tag route code in the second sample AFP file. If you link one or more properties to different index tags in different sample AFP files, you must create a separate Visual Workbench control file for each sample AFP file. Then you can configure the RICOH ProcessDirector steps that calculate the values of properties so that each step uses the control file that applies to the production AFP jobs that use the workflow.

You can also link several index tags to the same property. For example, if you have an index tag named routing code and an index tag named postal code, you can map both index tags to the property mail code. You can use the same Visual Workbench control file for several jobs that use different index tag names for the same property; however, the system expects that only one of the index tags will be in a particular document. If more than one index tag occurs in a document, the system assigns the property value based on the first occurrence.

When you link properties to index tags, Document Property Designer also lets you:

  • Edit the index tag value so that the property contains only part of the index tag value. For example, you can edit a customer account number so that the property contains only a portion of the account number.
  • Define link options for the properties. For example, you can specify the default value for a document property if the index tag is not found in a document.

1.2.1.2.20.3.3 Inserter features

The Inserter features help to automate the insertion of printed documents and extra inserts (such as marketing materials) into envelopes. RICOH ProcessDirector supports two features that support inserters: the full Inserter feature and the Quadient Inserter Express feature.

Both Inserter features:

  • Prepare print jobs for insertion.
  • Write and send control files to inserter controllers.
  • Receive results files from inserter controllers and interpret them to determine the insert status of each document in the job.
  • Automatically (or manually, with operator control) reconcile the job, and reprint any damaged documents.

Supported inserters

The Inserter feature works with inserters from a wide range of manufacturers; the Quadient Inserter Express feature only works with Quadient inserters. They provide sample system objects and sample configuration files for inserters from these manufacturers:

  • Bowe
  • Bowe with JetVision camera systems
  • Bowe Bell & Howell
  • Gunther
  • Inserters with Ironsides camera systems
  • Kern
  • Pitney Bowes
  • Quadient with the Automated Insertion Management System (AIMS) software.
    Note:
  • The Quadient Inserter Express feature only provides sample system objects and sample configuration files for Quadient inserters.

Prerequisites

To use the Inserter features, first install a feature that supports document processing:

  • For PDF files, install the PDF Document Support feature.

  • For AFP files, install the AFP Support feature.

File requirements

Input files must be either:

  • PDF files for which you have defined page groups using RICOH ProcessDirector Plug-in for Adobe Acrobat.

  • Advanced Function Presentation (AFP) format, or a format that RICOH ProcessDirector can convert to AFP format. AFP page groups must define the mailpieces in the file.

    With the AFP Support feature installed, RICOH ProcessDirector automatically converts line data and mixed-mode files to AFP format.

    If you have AFP Support and purchase the InfoPrint XT product, RICOH ProcessDirector converts Xerox metacode and Line Conditioned Data Stream (LCDS) files to AFP format.

    If you have AFP Support and purchase the Advanced Transform feature, RICOH ProcessDirector converts PostScript, PDF, or PCL data into an AFP format that is acceptable for use with AFP document processing functions.

    The AFP Indexer mode of RICOH Visual Workbench creates page groups in AFP files created by InfoPrint XT or the Advanced Transform feature.

    The Ricoh PostScript/PDF to AFP, PCL to AFP, and SAP to AFP Transform features convert input files into AFP image data files. These files do not contain page groups. As a result, they cannot be used with the document processing functions provided in the AFP Support feature.

Workflow phase processing

The inserter features add the Insert phase to the RICOH ProcessDirector Workflow Editor. The figure Insert phase in the RICOH ProcessDirector workflow, shows how the Insert phase fits into the existing phases.

    Note:
  • If you have customized phase names in your system, those phase names differ from the phase names in the diagram.
Insert phase in the RICOH ProcessDirector workflow
Image shows the Receive, Prepare, Assemble, Print, Insert, and Complete phases

A job that requires insertion is processed through the workflow phases, with some variations specific to inserting.

Receive phase
RICOH ProcessDirector accepts an input file for processing and creates a job in the system. It assigns the job a unique job number in the system.
Prepare phase
RICOH ProcessDirector creates page groups and extracts the values of document properties in AFP or PDF jobs.
Assemble phase
RICOH ProcessDirector processes the documents in the job:
  1. RICOH ProcessDirector assigns each document in the job a unique document number.
  2. RICOH ProcessDirector enhances the documents. For example, it hides existing insertion control marks and adds barcodes to control insertion. The barcodes contain the values of document and job properties (such as the job number, document number, and the insert sequence number of the document).
Print phase
RICOH ProcessDirector prints the job. The job header page is configured to include the job number, the inserter job name , and the name of the inserter controller for the job. The inserter job name can be different from the job number.
Insert phase
RICOH ProcessDirector communicates with the inserter controller and reconciles the job after it completes insertion:
  1. If the inserter controller uses an inserter control file to control the insertion of documents in a job, RICOH ProcessDirector creates the inserter control file for the job and sends it to the inserter controller.
      Note:
    • You can configure RICOH ProcessDirector to create the inserter control file before printing the job. This setting is useful if the inserter operator loads the initial portion of a large job on the inserter before the job finishes printing.
  2. The inserter operator manually loads and runs the job on the inserter.
  3. RICOH ProcessDirector receives the inserter results file (if any) for the job and interprets it to determine which documents to reprint.
  4. RICOH ProcessDirector reconciles the job:
    • If the automatic reconciliation method is selected, RICOH ProcessDirector automatically reprints any damaged documents.
    • If the manual reconciliation method is selected, the operator uses the Reconcile function to review the list of damaged documents and indicate which documents to reprint. The operator can also mark individual documents as pulled (removed) from the job. Pulled jobs are not reprinted.
  5. RICOH ProcessDirector reprints documents on the printer that the administrator selected for reprints or on the printer that the operator selected during manual reconciliation.
    • If the closed-loop reprint method is selected, RICOH ProcessDirector reprints the documents in the same job.
    • If the open-loop reprint method is selected, RICOH ProcessDirector creates a child job to reprocess the documents (for example, add new barcodes) and print them.
Complete phase
If jobs are retained on the system, the operator can reprint any documents that are damaged after the job completes reconciliation. Two methods to reprint the documents are available:
  • Reconcile the job again. This method reprints the documents in the same job (closed-loop reprint method) or in a child job (open-loop reprint method).
  • Create a new job. If a Transform feature is installed, RICOH ProcessDirector can transform the documents to a different data stream and print them on a suitable printer.

Step templates

The Inserter feature adds several step templates:

  • The WriteInserterControlFile and SendInserterControlFile step templates let you create an inserter control file. The inserter control file tells the inserter controller how to process each document in a job and send the file to the inserter controller.

  • The SetInsertProperties step template lets you set document properties that are required for insertion.

  • The InsertJobs step template lets you track the insertion of documents into envelopes.

  • The CreateInserterReprints step template lets you process documents to be reprinted after insertion by creating a print file containing only the reprints.

Reconciliation method

Both the PDF Document Support and AFP Support features support manual reconciliation. When a job enters the Reconcile step, the operator selects the Reconcile action to start manual reconciliation for the job. Then the operator uses the Reconcile Job dialog on the RICOH ProcessDirector user interface to request an action for each document in the job. To use manual reconciliation, set the Automatic reconciliation property on the Reconcile step to No.

The inserter features add support for automatic reconciliation. When a job enters the Reconcile step, RICOH ProcessDirector automatically reconciles the documents in the job and reprints any documents whose barcodes were not read. Operator action is required in these situations:

  • The documents to be reprinted exceed the percentage allowed for the job in the Maximum documents to reprint % property.
  • The inserter controller does not report a status for one or more documents in the job, and the Default insert status property of the inserter controller is not set.

To use automatic reconciliation, set the Automatic reconciliation property on the Reconcile step to Yes.

1.2.1.2.20.3.3.1 Inserter control files

File-based inserter controllers use an inserter control file to control the insertion of the documents in the job. RICOH ProcessDirector can create an inserter control file for each job and send it to the inserter controller before the job is inserted.

Some inserters use two control files for each job. In this case, RICOH ProcessDirector can create two control files for each job. The first and second control files can have different formats and content.

    Note:
  • The Quadient Inserter Express feature only supports the use of one inserter control file.

The contents of the control file vary, depending on the requirements of the inserter. The file contains an optional header record, which usually contains information about the entire job, and a record for each document in the job. The record for each document contains information related to insertion, such as which bins of the inserter should deliver inserts for the document, whether the document should be diverted to a special output bin, and so on.

RICOH ProcessDirector can write control files in any of these output formats:

  • Fixed-length record (FLR): The fields in each record have a fixed length, with no delimiter between each field.
  • Comma-delimited (DEL): The fields in each record are separated by a comma.
  • Extensible Markup Language (XML): The file is in XML format.

The Encoding property lets you specify if the data should be encoded using ASCII or UTF-8. When the format is FLR, use UTF-8 if any properties have multi-byte character set encoding.

Because inserter control files vary in format and content, you create these files for each type of inserter:

  • Rules file: Defines the fields in each record (except for the header record) of the inserter control file and specifies the value to put in each field of the record. This file is required. RICOH ProcessDirector uses the rules file to write the inserter control file records. Typically, RICOH ProcessDirector writes one record for each document in a job. The records follow the header record (if any). In each field, you can put static text (such as blanks or zeroes) or the value of a RICOH ProcessDirector property (such as the Document number property).
  • Header rules file: Defines the fields in the header record and specifies the value to put in each field of the record. RICOH ProcessDirector uses the header rules file to write the header record at the top of the inserter control file. Typically, RICOH ProcessDirector creates one header record in an inserter control file. Some inserters generate several XML elements in the header, but these elements occur only once in the XML output file. In each field, you can put static text (such as characters, blanks or zeroes) or the value of a RICOH ProcessDirector property (such as the Job number property). This file is required only if the inserter control file format specifies a header record.
RICOH ProcessDirector provides sample rules files that you can modify for your installation. With the Quadient Inserter Express feature, you receive sample files for Quadient inserters. With the full Inserter feature, you receive sample files for a wider variety of inserters.

On the Send command property for the inserter controller object, you specify a command or script that RICOH ProcessDirector runs to send the inserter control file (or files) to a directory where the inserter controller can read the control file. The directory can be on the same computer or on a different computer. RICOH ProcessDirector names the inserter control file as specified on the send command or script. The file name can include the value of any job property, such as the Job number or Inserter job name property. (By default, the inserter job name is the job number; however, you can specify another value in the Inserter job name property.) For example, if the job number is 10000023, the file name can be 10000023 or Kern10000023. The file extension can be any value.

RICOH ProcessDirector provides several scripts that you can use to send the control file to the inserter controller. Or, you can use another script that accepts the same parameters as the provided scripts. For information about using the scripts, see the related Task topics.

1.2.1.2.20.3.3.2 Inserter results files

After a job completes insertion, most inserter controllers write an inserter results file that contains the status of each document in the job after insertion and other information related to insertion. RICOH ProcessDirector receives the inserter results file (or files) for each job from the inserter controller and interprets the information in the file to determine which documents to reprint and how to set job and document properties.

For example, RICOH ProcessDirector sets the Status document property to indicate the insert status of each document.

Inserter results files vary in format and content, depending on the inserter. RICOH ProcessDirector processes these types of inserter results files:

  • Results files that are job-specific: each results file contains the results for only one job
  • Results files that are not job-specific: each results file contains results for more than one job (such as Gunther results files)
The requirements for job-specific and non-job-specific control files differ as described below.

A results file can contain one record for each document, with a status code that indicates the status of the document after insertion. Or, the results file can contain a record only for each document that needs to be reprinted.

RICOH ProcessDirector can read results files in any of these output formats:

  • Fixed-length record (FLR): The fields in each record have a fixed length, with no delimiter between each field.
  • Comma-delimited (DEL): The fields in each record are separated by a comma.

Because inserter results files vary in format and content, you must create these rules files:

  • Parsing rules files: Defines the fields in each record of the inserter results file.
  • Job-properties rules files: Specifies how to set RICOH ProcessDirector job-property values. This file is used only with job-specific results files.
  • Document-properties rules files: Specifies how to set RICOH ProcessDirector document-property values.
RICOH ProcessDirector provides sample rules files that you can modify for your installation. With the Quadient Inserter Express feature, you receive sample files for Quadient inserters. With the full Inserter feature, you receive sample files for a wider variety of inserters.

Requirements: The inserter results files must meet these requirements. The requirements differ, depending on whether the results files are job-specific (one results file for each job) or non-job-specific:

  • Job-specific results files: The file name of each results file must be unique for each job in the system associated with the inserter controller. We recommend that the file name of the results file contain the value of a job property whose value is unique for each job in the system, such as the Job number or Inserter job name property. (By default, the inserter job name is the job number; however, you can set another value in the Inserter job name property.) You specify the file name for the results file in the Receive command property of the inserter controller object.

    Example: If the job number is 10001023, the name of the results file could be 10001023 or Kern10001023.

    Each record in the file must contain the value of one of these document properties to identify the document to which the record applies:

    • Document number
    • Insert sequence

      Note:
    • The Quadient Inserter Express feature only supports job-specific results files.
  • Non-job-specific results files: Each record in the file must contain the value of this document property to identify the document to which the record applies:
    • Document number
    RICOH ProcessDirector requires the document number because the document number is unique for each document in the system.

On the Receive command property for the inserter controller object, you specify a command or script that RICOH ProcessDirector runs to receive the inserter results file for the job or, if the inserter results files are not job-specific, to receive all the inserter results files.

RICOH ProcessDirector provides several scripts that you can use to receive the inserter results files from the system where the inserter controller writes the files. Or, you can use another script that accepts the same parameters as the provided scripts.

1.2.1.2.20.3.3.3 Inserter completion methods

The inserter completion method is how RICOH ProcessDirector determines when the inserter controller has finished inserting a job.

There are two completion methods to choose from when you create an inserter controller:

Automatic completion
When RICOH ProcessDirector receives a results file from the inserter controller for the job, it automatically moves the job to the next step in the workflow, which is usually based on the Reconcile step template.

Use this method if the inserter controller creates a job-specific results file after each job has finished insertion. A job-specific results file contains information for only one job. Most inserter controllers create job-specific results files.

Manual completion
An operator must select the Complete Insertion action to start the reconciliation process for the job.

Use this method if the inserter controller does not create a job-specific results file after each job finishes insertion, or if it creates a job-specific results file before the job has finished insertion. Gunther inserter controllers do not create a job-specific results file after each job has finished insertion.

1.2.1.2.20.3.3.4 Inserter reconciliation methods

RICOH ProcessDirector reconciles each job after the job finishes insertion. During reconciliation, RICOH ProcessDirector determines which documents in the job were damaged and need to be reprinted, and which documents to pull (remove) from the job. The reconciliation method tells RICOH ProcessDirector whether to reconcile damaged documents automatically, or manually with operator control.

When the administrator configures job workflows for insertion, the administrator selects the reconciliation method in the step based on the Reconcile step template. An operator can change the reconciliation method for a particular job by editing the job's properties and changing the value in the Automatic reconciliation property.

The reconciliation methods are:

Automatic reconciliation
When a job finishes insertion, RICOH ProcessDirector automatically reconciles the documents in the job and reprints any damaged documents. Use this method if operators in your installation use the interface of the inserter controller to reconcile jobs.

Operator action in RICOH ProcessDirector is required in these situations even with automatic reconciliation:

  • The inserter controller does not report a status for one or more documents in the job, and the Default insert status property of the inserter controller is not set.
  • The documents to be reprinted exceed the percentage of reprints allowed for the job in the Maximum documents to reprint (%) property.

Manual reconciliation
When a job finishes insertion, the operator selects the Reconcile action to start manual reconciliation for the job. Then the operator uses the Reconcile Job page of the RICOH ProcessDirector user interface to select an action for each document in the job.

The Reconcile Job page shows the insert status of each job and the initial action that RICOH ProcessDirector has determined for each document, based on the insert status of the document and the value of the Default insert status property on the inserter controller.

The operator can request one of these actions for each document:

  • OK: Document is not reprinted.
  • Pull: Document is marked pulled (removed from the job) in the database and is not reprinted.
  • Reprint: Document is reprinted.

RICOH ProcessDirector can use the automatic reconciliation method only if the inserter controller creates an inserter results file (or files). RICOH ProcessDirector uses the status reported in inserter results files to determine which documents in a job have been damaged during insertion and need to be reprinted. If the inserter controller does not create inserter results files, RICOH ProcessDirector must use the manual reconciliation method.

    Note:
  • If the original job is retained in the system after it has completed, the operator can use the RICOH ProcessDirector Process Again action to reprint any documents in the job. This function is useful if the operator discovers additional damaged documents after reconciliation.

1.2.1.2.20.3.3.5 Inserter reprint methods

The inserter reprint method is how RICOH ProcessDirector reprints documents that are damaged during insertion.

Some inserter controllers support only one type of reprint method. Other inserter controllers are configurable, so you can select the reprint method that you prefer.

When you configure the inserter controller object, you select the reprint method in the Reprint method property.

There are two reprint methods:

Open loop
RICOH ProcessDirector reprocesses the documents and creates a child job that contains the documents to be reprinted. The job number of the child job is the original job number with a numeric suffix (for example, 1000001.1).

The child job starts processing from the first step in the current workflow. If the workflow contains a step that writes barcodes for insertion, the barcodes are rewritten to include the new job number of the child job and the new insert sequence number of the document.

RICOH ProcessDirector creates an inserter control file for the child job and sends it to the inserter controller. The inserter control file contains a record for each document in the child job. If the record specifies the sequence number of the document, the sequence number is the new sequence number of the document in the child job.

After the child job is created, the original job moves to the next step in the workflow. The original job is not removed from the system until the child job is printed, inserted, and reconciled, and the retention time for the original job expires.

Closed loop
RICOH ProcessDirector does not reprocess the documents. It reprints the documents in the same job with the same job number. After all documents in the job have been reprinted, inserted, and reconciled, the job moves to the next step in the workflow.

1.2.1.2.20.3.4 Automated Verification

The Automated Verification feature lets you add barcodes to the documents in a print job. Cameras or barcode scanners read the barcodes to detect documents that fail to complete a step in their workflow. You choose whether RICOH ProcessDirector automatically reprints any missing documents or an operator specifies an action to take for each missing document.
Note: The feature only detects documents that are missing from a job. It does not detect pages that are missing from documents.

The Automated Verification feature adds an object, a step template, and a reconciliation method to RICOH ProcessDirector.

Prerequisites

To use the Automated Verification feature, first install a feature that supports document processing:

  • For PDF files, install the PDF Document Support feature.

  • For AFP files, install the AFP Support feature.

Object

The Automated Verification feature adds the barcode reader object. Barcode readers represent the cameras and barcode scanners in your system that read barcodes on documents in a print job to verify that each document has been processed. Each camera or barcode scanner requires a barcode reader object.

Each barcode reader must have at least one barcode format object. To report the data that the camera or barcode scanner reads, the barcode format must match the configuration of the camera or barcode scanner. The barcode format must include the Job number and a document property that is used to identify each document in a job.

Step template

The Automated Verification feature adds the ReadBarcodeData step template. After one or more barcode readers report results, a step based on the ReadBarcodeData step template checks whether all documents in a job have been detected. You can configure the step to process jobs in these ways:

  • After all the barcodes have been read, the step sends the job to the next step.

  • After all the barcodes have been read, the step waits for an operator to do the Complete barcode step action.

  • The step waits a specified amount of time for the results file to be updated. The step then sends the job to the next step even if some documents have not been detected.

Reconciliation method

Both the PDF Document Support and AFP Support features support manual reconciliation. When a job completes the ReadBarcodeData step and enters the Reconcile step, the operator selects the Reconcile action to start manual reconciliation for the job. Then the operator uses the Reconcile Job dialog in the RICOH ProcessDirector user interface to specify an action for each document in the job. To use manual reconciliation, set the Automatic reconciliation property on the Reconcile step to No.

The Automated Verification feature adds support for automatic reconciliation. When a job enters the Reconcile step, RICOH ProcessDirector automatically reconciles the documents in the job and reprints any documents whose barcodes were not read. Operator action is required in these situations:

  • The documents to be reprinted exceed the percentage allowed for the job in the Maximum documents to reprint % property.
  • Any duplicate barcodes are read in the job.

To use automatic reconciliation, set the Automatic reconciliation property on the Reconcile step to Yes.

Additional information

The Automated Verification feature integrates with barcode readers that return data over an IP address and port using the TCP/IP Sockets protocol. The feature does not support systems such as file-based inserters that exchange data by sending and receiving files across a network. To determine the best camera or barcode scanner for the device you want to monitor, contact a Ricoh support representative.

1.2.1.2.20.3.4.1 Usage scenario: Verifying documents after insertion

This scenario describes the steps required to set up a camera or barcode scanner to read barcodes through the window on each envelope of a job as the envelopes exit the inserter. Some of these steps can be done at the same time.
  1. Prepare the camera or barcode scanner hardware.
    1. Purchase the camera or barcode scanner and install it on the inserter.
        Note:
      • Follow the instructions provided by the manufacturer when you install the camera or barcode scanner. Test the lighting conditions to be sure that the camera can read the barcode clearly. If light reflects off the plastic window, barcodes might not be read. In addition, measure the location of the camera or barcode scanner to ensure it lines up with the placement of the barcode on all the types of documents it scans.
    2. Connect the camera or barcode scanner to the network. Write down the IP address and port number that the camera uses.
  2. Understand and create your barcode format.
    1. Determine what type of barcode you want to use and how you want to format data in the barcodes that are added to your documents. The barcode format must contain the Job number job property and the Sequence in child job document property. Determine how many characters you want to allocate to each of those properties and whether you want to include other information in the barcode.
        Note:
      • Although the Job number is set at eight characters initially, you should include at least two more characters (.n) in the barcode format. The job numbers of child jobs created for reprints have at least 10 characters. Be sure the barcode symbology you use allows periods, because they are present in the job number of every child job created for reprints.
    2. Log in to RICOH ProcessDirector as an administrator and create the barcode format object. If you install only one camera and read all barcodes in the same location on an envelope, one barcode format should be all you need for the system. If other data might be included in the barcode for other reasons and that data cannot easily be standardized across applications, you might need to create more than one barcode format. However, the Job number and Sequence in child job properties must be in the same positions in the barcode for all barcode formats used for the same barcode reader.
  3. If the print file is in PDF format, add barcodes to the print data.
    1. Follow the instructions in RICOH ProcessDirector: Installing Document Processing Features to install the plug-in on your Adobe Acrobat Professional system.
    2. Open the file in Adobe Acrobat Professional and activate the Ricoh plug-in.
    3. Define how document boundaries in the print file can be determined. These boundaries are the triggers that RICOH ProcessDirector can use to know where one document ends and another begins.
    4. After document boundaries are set, define the area to place the barcode and its contents. Be sure that the placement matches what the camera or barcode scanner expects to see. You can place the barcode only on the first page of each document since the camera (in this example) is reading through the envelope.
    5. For the first Content Type, select Job Property and a Content Value of Job.ID. Click Edit and select Pad with Character as the Modifier. Type 0 for Character to Pad with, and specify at least three digits, to allow the handling of reprint jobs.
    6. Return to the Add barcode dialog and select Document Property for the next Content Type with a Content Value of Doc.SequenceInChild. Repeat the steps above to pad the value with 0s for at least the number of digits equal to the number of documents you expect to have in the job. For example: If you expect to have 9,999 documents in this job, enter 4 in the Minimum Padded Text Length field. If you expect to have 100,000 documents in this job, enter 6 in the Minimum Padded Text Length field.
    7. Save the control file created by the plug-in. Send the file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user can access.
  4. If the print file is in AFP format, add barcodes to the print data.
      Important:
    • For AFP jobs, you must have page groups already defined to add barcodes. If your AFP files do not contain page groups, you can use the AFP Indexer mode in RICOH Visual Workbench to add page groups.

    If you want to use the Verification recipient property to identify your documents, you must have an index tag already in the AFP file that you can map to the Verification recipient document property that the Automated Verification feature adds. The sample file provided already has that property defined. To link your own index tag to the property:

    1. Open the AFP file in the AFP Visual Workbench. Select the DPD plug-in.
    2. Double-click on the Verification recipient property name at the bottom of the window and supply the requested information in the Define link options dialog.
    3. Save the control file created by AFP Visual Workbench. Send the file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user can access.
    4. To create the barcode, select the Enhance AFP mode and export an EnhanceAFP control file, which is used by the BuildAFPFromDocuments step. A sample control file named VerifyAFPbarcode.cfg is included in the /aiw/aiw1/testfiles directory (Linux) or the C:\aiw\aiw1\testfiles directory (Windows). Use the comments in the file to specify the number of characters for each property to match your barcode format. Make sure that the location of the barcode matches where the camera or barcode scanner is focused.
  5. Create a barcode reader object.
    Log in to RICOH ProcessDirector as an administrator and create the barcode reader object to correspond to the camera or barcode scanner. Use the IP address, port, and barcode format you already created.
  6. The VerifySample workflow provided with RICOH ProcessDirector processes both PDF and AFP files through the Automated Verification workflow. Starting with a copy of the VerifySample workflow, modify it to process your own print files:
    1. If your print file is PDF, on the IdentifyPDFDocuments step and on the BuildPDFFromDocuments, specify the control file you built using the Acrobat plug-in.
    2. If your print file is AFP, on the IdentifyDocuments step, specify the control file you built using the AFP Visual Workbench. On the BuildAFPFromDocuments step, specify the Enhance AFP control file that you previously created.
    3. On the ReadBarcodeData step, specify the barcode reader you set up earlier.
    4. Specify which document property this ReadBarcodeData step should update when the barcode reader receives information about the barcodes on documents.
    5. Decide how you want to manage the completion of this step and how long you want to wait to be sure that all barcodes have been read.
  7. Create an input device that points to the workflow you created.
  8. To test the system, submit a job.
    1. Enable the workflow and connect the barcode reader, and make sure that the input device is connected and enabled.
    2. Submit the file to the input device.
  9. When the job reaches the ReadBarcodeData step, its state changes to Reading barcodes. The camera on the inserter reads the barcodes through the windows of the envelopes containing documents for the job.

    The operator can select the Complete barcode step action on the Jobs table to see the percent of documents read. The dialog does not automatically update, but the operator can close and reopen it - during a long-running job, for example - to check on progress.

  10. If the ReadBarcodeData step is configured to complete the step automatically when 100 percent of the documents have been seen or after a period of inactivity, the job moves to the next step in the workflow without the operator intervening.

    If the job does not move to the next step, the operator must select the Complete barcode step action for the job. That dialog shows the percent of documents read by the scanner and the number of documents that have not been read. The operator can choose to complete the step even with the missing documents so that the job can go to the next step, often Reconcile.

  11. If the Reconcile step is configured to mark all missing documents for reprint automatically and submit the child job to a printer, a child job containing the reprints is created automatically. The original job moves to the next step in its workflow if no duplicate scans were detected. If any documents were detected more than once, the job moves to the Waiting to reconcile state even if Automatic reconciliation is turned on.

    If Automatic reconciliation is turned off, the operator must select the Reconcile action on the job when it is in the Waiting to reconcile state. On the Reconcile dialog, the operator can see a list of documents where the value of the Document status property that the step updates is set to Attention or Duplicate. The operator can choose to reprint, pull, or accept ( Mark OK) one or more documents in the Attention or Duplicate state.

    When all the documents in the job have a status other than Attention or Duplicate, the Reconcile step is complete and the job moves to the next step.

1.2.1.2.20.3.4.2 Automated Verification reconciliation methods

During reconciliation, the system determines which documents in the job need to be reprinted because their barcodes were not read. The value of the Automatic reconciliation property tells the system whether to reconcile documents automatically, or manually with operator control.

When the administrator configures workflows for Automated Verification, the administrator selects the reconciliation method in the step based on the Reconcile step template. An operator can change the reconciliation method for a particular job by editing the job's properties and changing the value in the Automatic reconciliation property.

The reconciliation methods are:

Automatic reconciliation
When a job completes the ReadBarcodeData step, RICOH ProcessDirector automatically reconciles the documents in the job and reprints any documents whose barcodes were not read.
    Note:
  • Operator action is required if the documents to be reprinted exceed the percentage allowed for the job in the Maximum documents to reprint % property. Operator action is also required if any duplicate barcodes are read in the job. In this case, the job enters the Waiting to reconcile state and the Reconcile action must be performed to set a disposition for each document that has a Duplicate status.
Manual reconciliation
When a job completes the ReadBarcodeData step, the operator must select the Reconcile action to start manual reconciliation for the job. Then the operator uses the Reconcile Job page of the RICOH ProcessDirector user interface to select an action for each document in the job.

The Reconcile Job page shows the status of each document and the initial action that RICOH ProcessDirector has determined for each document, based on the Document status property selected on the ReadBarcodeData step.

    Note:
  • The table on the Reconcile Job page has columns for the Document status 1 and Document status 2 properties. To add another document status property, edit the columns to add the Document status 3, Document status 4, or Document status 5 property to the table.

The operator can request one of these actions for each document:

OK
Document is not reprinted.
Pull
Document is marked pulled (removed from the job) in the database and is not reprinted.
Reprint
Document is reprinted.

    Note:
  • To reprint additional documents after reconciliation, you can use the Create Job action on the Documents portlet on the Main page to create a new job to process selected documents.

1.2.1.2.20.3.5 Archive

The Archive feature lets you store jobs, documents, and job processing history in a repository and retrieve them by searching on job and document properties. For example, you might search for documents by job name, customer name, and account number. After you retrieve a job or document, you can view it, review the properties that were stored with it, check the production history, and submit the job or document to a workflow for reprinting or other processing.

The feature has these major parts:

  • A new repository object and two new step templates.

  • A new type of notification object.

Prerequisites

To use the Archive feature, first install a feature that supports document processing:

  • For PDF files, install the PDF Document Support feature.

  • For AFP files, install the AFP Support feature.

New repository object

Repository objects hold job and document data and job processing history that you want to store for possible retrieval, including to submit again as a new job. When you retrieve the information, you can view the job, submit it again, or review detailed information about the job and its production history. You can create multiple repositories, each with a unique retention period. Each repository can be on the local system or a mounted drive anywhere in your network. To control who can retrieve files from a repository, you can associate the repository and its users with a specific location.

History record notifications

The Archive feature adds a new type of notification object called a history record notification. These objects monitor the system for changes to the Current job state property. When that property changes, the history record notification captures the new state, the timestamp, and the workflow, phase, and step that the job is in. This information can be then stored in the repository.

Using the information captured by the history record notification object, you can save the production time line of the job to answer questions about job and document processing.

New step templates

Archive adds the StoreInRepository step template. A step that is based on this step template stores a copy of any file selected by the File to store property in a repository with the job and document properties you specified. The job and document properties you select to store with the file can be used to retrieve the job or document.

You can also use the Store history records property to have the step store the history records generated for the job by one or more history record notification objects.

Archive also adds the ExportFromRepository step template. A step that is based on this step template lets you export the properties from a repository to a comma-delimited (CSV) file.

1.2.1.2.20.3.5.1 Usage scenarios for Archive

These scenarios show how the Archive feature might be used to improve your production processes by storing jobs, documents, and their history in a repository and retrieving them when needed.

1.2.1.2.20.3.5.1.1 Usage scenario for storing jobs up to one year

In this scenario, a print shop wants to store jobs for one year because customers sometimes ask for jobs to be rerun with updated data.

Currently the print shop runs 200 jobs a day and uses a RetainCompletedJobs step in their workflow to retain jobs for one month. Jobs are difficult to find because the Jobs table has 6,000 jobs. One job out of 100 is reprinted with updates. With the Archive feature, the print shop can store jobs in a repository for one year and retain jobs in the Jobs table for only two days. The Jobs table now has only 400 jobs. The print shop can find stored jobs faster by searching the repository for them instead of looking through the Job properties of 6,000 jobs.

An administrator at the print shop creates a repository with a retention period of one year. The administrator adds a step based on the StoreInRepository step template after the PrintJobs step in the PDF print workflow, but before the RetainCompletedJobs step. The administrator specifies six job properties in the StoreInRepository step: Assigned to printer (the date and time when the printer received the job), Customer name, Custom 2 (which stores the cycle date), Input file name, Requested location, and Workflow. The print shop staff can search for and retrieve jobs based on the six job properties.

The pre-press department uses RICOH ProcessDirector Plug-in for Adobe Acrobat to identify individual documents in a PDF file. The pre-press staff then submits the job to the PDF workflow.

When the job completes the StoreInRepository step, the job and its six job properties are stored in the repository. Two days after the job is printed, it completes the RetainCompletedJobs step and is deleted from the Jobs table.

In June 2014, several months after a postcard job is run for a real estate company, the print shop receives a request to reprint the postcards with a new contact name. The print shop supervisor searches the repository for a Customer name value of Metro Real Estate and an Assigned to printer value greater than 1/1/14 12:00:00 AM. The search results table lists jobs that match the Metro Real Estate Customer name. All 12 jobs printed for the customer in 2014 are shown. The supervisor looks at the dates in the Assigned to printer column of the Result table to find the job that should be reprinted with a new contact name.

The supervisor views the job to verify that it is the right one and then submits the job to a short workflow that emails the PDF file as an attachment to the pre-press department. The pre-press staff uses RICOH ProcessDirector Plug-in for Adobe Acrobat to update the contact name on all the documents in the PDF file. The updated PDF file is then submitted to a PDF workflow for reprinting.

1.2.1.2.20.3.5.1.2 Usage scenario for storing documents to satisfy requests for reprints

In this scenario, a commercial printer prints and mails account statements for a bank once a month. When customers request reprints of their bank statements, the bank wants the commercial printer to satisfy those requests for up to four years after the statements are printed. The bank also wants to save the production history for jobs that are stored, so they can confirm that those statements were printed when the original job was processed.

Currently the commercial printer runs 500 jobs a day and uses a RetainCompletedJobs step in the workflow to retain jobs for three days. Retaining the jobs longer than three days would make jobs difficult to find in the Jobs table and might cause performance issues with the print production system. For example, if the commercial printer retained jobs for three months, the Jobs table would have 45,000 jobs.

An administrator at the commercial printer creates a repository with a retention period of four years. The administrator then defines a history record notification object that records job state information whenever the Current job state property changes to Complete. Then to minimize the number of notifications that are recorded, he sets a condition so the history record is only saved when the Current step equals PrintJobs.

The administrator adds a step based on the StoreInRepository step template after the PrintJobs step in the PDF print workflow, but before the RetainCompletedJobs step, and saves the print file. The administrator specifies both job and document properties in the StoreInRepository step. The job properties are Customer name, Custom 2 (which stores the cycle date), Time submitted, and Workflow. The document properties are Verification recipient, Account number, and Postal code. The Administrator also sets the Store history records property to Yes. The commercial printer’s staff can use any combination of the job and document properties to search for and retrieve documents and information about their processing history.

The pre-press department uses RICOH ProcessDirector Plug-in for Adobe Acrobat to identify documents in a PDF file and define the document properties. The staff then submits the job to the PDF print workflow.

When the job completes the StoreInRepository step, the job and its print completion timestamp are stored in the repository. Three days after the job is run, it is deleted from the Jobs table.

In August 2014, eight months after a job is run, the commercial printer receives a request from the bank to reprint a document with Account Number 1122345687. The print department supervisor searches the repository for a document with a value of DEC2013 for the Custom 2 job property and a value of 112234568 for the Account number document property. The Results table lists the document that matches those property values.

The supervisor displays the detailed information about the document. On the History tab, he confirms that the document found is the correct document. He then submits the statement to a reprint workflow that only has steps related to printing.

1.2.1.2.20.3.6 Electronic Presentment

The Electronic Presentment feature provides a sample workflow that receives jobs from a sample input device and uses a sample history record notification to capture the times when jobs are printed and mailed. The workflow stores jobs, documents, property values, and history information in a sample repository.

This no-charge feature is provided with the base product but is not installed by default.

Note: You must have the Archive feature installed to use the Electronic Presentment feature.

1.2.1.2.20.3.6.1 Running the Electronic Presentment sample workflow

The Electronic Presentment feature provides a sample workflow that stores data in a sample repository.

The sample objects and files used in this workflow include:

  • Workflow: ElectronicPresentmentSample
  • Sample input device: ElecPresFolder
  • Sample history record notification: EPSampleHistory
  • Sample repository: ElecPresRepository
  • Sample PDF files: /aiw/aiw1/testfiles/ElecPresDemo.pdf and ElecPresDemo2.pdf
  • Sample PDF control file: /aiw/aiw1/testfiles/ElecPresDemo.ctl

To run the sample workflow:

  1. Log in to RICOH ProcessDirector.
  2. Click the Main tab.
  3. In the Printers portlet, select the Sample printer and click Actions Enable.
  4. On the Input Devices portlet, select the ElecPresFolder hot folder input device and click Actions → Enable and Connect.

    The first time you try this procedure, RICOH ProcessDirector immediately submits the ElecPresDemo.pdf and ElecPresDemo2.pdf jobs to the ElectronicPresentmentSample workflow.

    When the jobs reach the ToMailroom step, which is based on the Wait step template, they are held for two minutes to simulate the time required to process jobs in the mailroom.

  5. In the Jobs table, find the jobs and check to see that the value in the Phase column for each job is Complete.

    The ElecPresDemo.pdf and ElecPresDemo2.pdf files and their documents are now stored in the ElecPresRepository repository.

  6. Click the Archive tab.
  7. In the Search portlet, select the ElecPresRepository repository.
  8. Select Address block line 1 from the Property drop-down menu, = (equal to) from the Comparison drop-down menu, type Myrna Donald in the Value field, and click Search.

    The Results table displays two statements for Myrna Donald.

The functions that store data in a repository, search for the data, and display it on the Archive page of the RICOH ProcessDirector user interface are part of the Archive feature.

1.2.1.2.20.3.7 Postal Enablement

The Postal Enablement feature lets you extract mailing address data from the documents in a job and prepare the data for processing by external postal software. After the postal software verifies the addresses and improves their quality, the Postal Enablement feature can process results received from the postal software to update the documents in the job.

The feature adds a collection of step templates and workflows to RICOH ProcessDirector.

Postal Enablement does not provide postal software. You can use your choice of external postal software, for example, the TEC Mailing Solutions MailPreparer software or the Bell and Howell BCC Mail Manager software.

You can use steps based on existing RICOH ProcessDirector step templates to exchange data with postal software, or you can manually move files between RICOH ProcessDirector and the postal software.

Prerequisites

To use the Postal Enablement feature, first install a feature that supports document processing:

  • For PDF files, install the PDF Document Support feature.

  • For AFP files, install the AFP Support feature.

New step templates

Postal Enablement adds four step templates.

  • SetPostalJobProps

    A step based on this step template lets you set job properties needed by postal software to determine how to process the mail piece information contained within the external document properties file.

  • BuildExternalDocPropsFile

    A step based on this step template lets you extract document data from the document properties file and create a file with the document data and headings that you need to send to an external program. The file you create is called an external document properties file.

  • MapExternalResultsFiletoDocProps

    A step based on this step template maps document properties that you select from an external results file to the document properties included in a modified results file. The external results file is produced by an external program.

  • UpdateDocPropsFromExternalResultsFile

    A step based on this template merges the properties in the modified results file into the document properties file for the job.

New workflows

Postal Enablement adds four sample workflows.

  • PrintAndMailJob

    This workflow collects document data to send to postal software and uses a step based on the RunHotFolderApplication step template to exchange files with the postal software. After receiving the output of the postal software, the workflow updates the document data and prints the job for mailing.

  • GroupDocsForPostalProcess

    This workflow collects document data to send to postal software and updates the document data from the output of the postal software. Using rules that you set up to interpret the data, the workflow produces child jobs for each type of mail that the postal software identified. The workflow is configured to pass the child jobs to one of the next two workflows.

  • ProcessQualifiedDocuments

    This workflow processes child jobs created by the GroupDocsForPostalProcess workflow if the documents in the job qualified for additional postal processing. The workflow sorts the documents, using the optimal method determined by the postal software, and passes the child jobs to the PrintForPostalProcess workflow.

  • PrintForPostalProcess

    This workflow prints the child jobs created by the GroupDocsForPostalProcess workflow. The child jobs contain qualified, nonqualified, and other types of mail. The workflow makes sure that the order of documents within each job is correct for each type of mail.

1.2.1.2.20.3.7.1 Extracting document properties for use with other programs

When you use document processing features, documents inside your print jobs are given property values in addition to the properties that apply to the job as a whole. Document properties can include: number of pages in a document, name of the recipient, and account number among many others. You can also define your own document properties that suit your requirements for accounting or other tracking purposes. Document property values can be collected and extracted so you can use them outside of your print workflow system. In addition, document property values can be returned to the system so they can be used by later steps in the workflow.
Note: The Postal Enablement feature uses this process to extract document properties so they can be sent to external postal software and returned to RICOH ProcessDirector. Examples below refer to Postal Enablement, but this function can be used to collect document property values for other purposes as well.
Document property processing flow
Illustration showing the flow of information from step to step, as described in the paragraphs below.

Document property processing flow shows the steps that you can use to identify and extract the document properties for a job, along with the files that are used and produced by each step. Use these steps in this order:

  • IdentifyDocuments or IdentifyPDFDocuments

    These steps create the document properties file using a control file as a guide. For AFP jobs, the step uses the Visual Workbench control file; for PDF jobs, the step uses the Identify PDF control file.

    The step places the document properties file in the job’s spool directory with the name jobid.original.dpf.

  • WriteDocumentsToDatabase

    This step reads the jobid.original.dpf and records the document property values in the database. It also makes a copy of the file, renames it to jobid.document.dpf, and places the file in the job’s spool directory.

  • BuildExternalDocPropsFile

    This step reads the jobid.document.dpf and builds a new text file, called the external document properties file. You can specify which properties to include in the external document properties file and some basic formatting information.

    For example, if you are using the Postal Enablement feature, you might want to extract address information for each document and send it to TECMailing’s MailPreparer software for address cleansing. As input, MailPreparer accepts a text file in comma-separated value (CSV) format. That file can include a header row which lists the MailPreparer names for each property. Each row after that includes the document property values that correspond to those properties. You can configure the step to create the external document properties file in that format.

    When the step runs, it creates the external document properties file with the name that you specify. You can use this file as input for another program (such as MailPreparer) or you can use the file in other tasks outside the print workflow.

To import document property values and update them in the database so that other steps in the workflow can use them, use these steps in this order:

  • MapExternalResultsFileToDocProps

    This step receives a file called the external results file and interprets it, mapping the contents to RICOH ProcessDirector document properties. The external results file can be in tab-delimited or CSV format.

    The step can be configured to retain and map all of the information in the external results file or to retain and map select values. For example, the external results file returned by MailPreparer contains over 80 values for each document. Your print workflow might only require 15 of them. You can configure the step to retain and map the 15 values required and ignore the rest of them.

    The result of this step is a modified results file. You can specify the file name and the directory that the file is stored in. This file is used as input for the UpdateDocPropsFromExtResultsFile step.

  • UpdateDocPropsFromExtResultsFile

    This step reads the modified results file and updates the document properties file (jobid.document.dpf) in the job’s spool directory. Other steps in the workflow can now make use of the updated property values.

1.2.1.2.20.3.8 Preprinted Forms Replacement

The Preprinted Forms Replacement feature lets you print jobs on plain paper that previously required preprinted forms. You update the definition of each media object for the media requested by these jobs to include the electronic equivalent of the preprinted form data. The application that submits the print files to RICOH ProcessDirector can continue to specify the media for the jobs in the same way.

For each of your preprinted forms, you associate a PDF page representing the electronic equivalent of the preprinted data with each side of a media object. The incoming job requests the media for the job or for selected pages in the job by name. A step in the workflow combines the PDF page data with the job data to create a print file that you can print on plain paper.

The electronic form properties of media objects are used only when jobs go through the step that combines the electronic forms with the job data. You can use the same media objects to print jobs on preprinted forms when jobs do not go through that step.

You can process jobs that are ready to use electronic forms and jobs that are not ready in one workflow by sending them through two branches:

  • The jobs that are ready to use electronic forms go through a branch with the step that combines electronic forms with job data.
  • The jobs that are not ready go through a branch without the step.

The branches check a job property, such as Custom 1. You assign the property one value for jobs that are ready to use electronic forms and another value for jobs that are not ready.

Using branches in your workflow, you can use electronic forms to reduce or eliminate your inventory of preprinted forms at your own pace. For example, you can select the preprinted form that you are about to reorder or the most expensive preprinted form to move to electronic forms first.

Prerequisites

The Preprinted Forms Replacement feature requires the PDF Document Support or the AFP Support feature. If you install the AFP Support feature, the Preprinted Forms Replacement feature also lets you insert PDF forms into AFP jobs.

Step templates

Preprinted Forms Replacement provides the CombinePDFWithForm and CombineAFPWithForm step templates. Steps based on these step templates combine electronic forms with data in PDF or AFP files respectively.

    Note:
  • The CombineAFPWithForm step template is available when the Preprinted Forms Replacement and AFP Support features are installed.

Electronic Form properties for media objects

To define electronic forms for a media object, you use the Electronic Form section of the media properties notebook.

The Front of form and Back of form properties let you create an electronic form from a page in a PDF file. You can create an electronic form for the front side of the media, the back side, or both. When the CombinePDFWithForm or CombineAFPWithForm step processes jobs or pages that request media with values for these properties, the step combines the forms with the data.

The Media name for printing property tells RICOH ProcessDirector the media name to use to schedule the job and to print the job or pages that request the media. The property values give you these choices:

  • Replace the name of the media requested for the job with a new name.
  • Keep the original name.
  • Remove the name so that the printer default media is used.

The Media name for printing property values let you implement Preprinted Forms Replacement in your printing operation without retraining your operators or changing the data exchanged with other applications. For example:

  • The Form1240 media object was created for a preprinted form on white paper. After you attach electronic forms to the media object, you want the CombinePDFWithForm or CombineAFPWithForm step to remove the media name Form1240 when jobs or pages request Form1240 media. You set the value of the Media name for printing property to None. RICOH ProcessDirector prints the jobs or pages on the paper that is set as the default media on the printer.
  • The Form1400 media object was created for a preprinted form on blue paper. After you attach electronic forms to the media object, you want the step to replace the media name Form1400 with Letter Blue when jobs or pages request Form1400 media. You set the value of the Media name for printing property to Selected and then select Letter Blue. RICOH ProcessDirector prints the jobs or pages on Letter Blue paper.
  • The Form 2010 media object was created for a preprinted form on high-quality bond paper. After you attach electronic forms to the media object, you want the step to keep Form 2010 as the media name when jobs or pages request Form 2010 media.

    You set the value of the Media name for printing property to Current name. Form 2010 remains a media name in the printer catalog. Operators load high-quality bond paper (without preprinted data) for jobs that request Form 2010 media.

When you choose a value for the Media name for printing property, take your Management Information System (MIS) reporting needs into account. Consider how you want to track and charge for the media.

1.2.1.2.20.3.8.1 Usage scenario for printing jobs on plain paper instead of preprinted paper

In this scenario, a printing company wants to replace their preprinted paper with electronic forms that print on plain paper. They want to make the replacements on a client-by-client basis, and they start by replacing the preprinted paper for Client A. They continue to print the jobs for all their other clients on preprinted paper.

An application at Client A submits jobs to the input device for the workflow that processes PDF jobs. The jobs specify Form For Client A as the media. The printing company already has a RICOH ProcessDirector media object named Form For Client A.

To replace the preprinted paper, the printing company creates a PDF file that uses the same page size as the preprinted paper and has the same content. The printing company adds the PDF file as an electronic form to the Form For Client A media object. While adding the form to the media object, the printing company selects None as the value of the Media name for printing property.

The printing company then adds a step based on the CombinePDFWithForm step template to the PDF workflow after the OptimizePDF step and before the CountPages step.

Because the printing company processes jobs for many different clients through the PDF workflow, they add a branch from the OptimizePDF step to the CountPages step. That branch bypasses the CombinePDFWithForm step.

To route the jobs for Client A through the CombinePDFWithForm step, the printing company sets this rule on the connector from the OptimizePDF step to the CombinePDFWithForm step: Job.CustomerName = 'Client A'. The value of the Order of execution property for the rule is 1.

After the printing company modifies the PDF workflow, the jobs from Client A move through the CombinePDFWithForm step. The step combines the electronic forms defined for the Form For Client A media object with the job data and checks the value of the Media name for printing property. Because the value is None, the step removes all instances of the media name Form For Client A from the job. As a result, the job prints on the printer default media. The jobs for all the other clients bypass the CombinePDFWithForm step and print on preprinted paper.

The PDF workflow modified by the printing company is similar to the ElectronicFormJobSample workflow supplied with the Preprinted Forms Replacement feature. The biggest difference between the workflows is the rule on the connector from the OptimizePDF step to the CombinePDFWithForm step. For more information about the ElectronicFormJobSample workflow, refer to the Information Center.

1.2.1.2.20.3.9 Preference Management

The Preference Management feature lets you update document property values with values from an external preferences file. These values can be used to change the content of selected documents or to change the processing of those documents.

For example, you can create a preferences file that identifies customers who have chosen eco-friendly options. After you identify the customers, you change their Output type to email so that they can receive their statements via email instead of by postal mail.

The ApplyPreferences step uses a property mapping object to map the values from the preferences file to RICOH ProcessDirector document properties. The property mapping object specifies document properties that identify documents to be updated. The values of those document properties must match values in the preferences file. Then, the object specifies which document properties are updated with values from the preferences file.

This no-charge feature is provided with the base product.

Prerequisites

To use the Preference Management feature, first install a feature that supports document processing:

  • For PDF files, install the PDF Document Support feature.

  • For AFP files, install the AFP Support feature.

Step template

Preference Management provides the ApplyPreferences step template. A step based on this step template lets you specify a preferences file used to update one or more job or document property values.

Object

Preference Management provides the Property mapping object. This object lets you map information from the preferences file to document properties in RICOH ProcessDirector, which are then used by steps to generate output files.

1.2.1.2.20.3.9.1 Using information about documents

All document processing features collect and track information about individual documents in a job. RICOH ProcessDirector extracts the information (such as customer names and addresses) from data in the documents themselves. The Preference Management feature lets you use other information (such as favorite movies or document delivery preferences) about the individual or account associated with each document. The documents themselves do not contain that information.

You can use information about the individuals or accounts in two different ways:

  • To change the content of documents

  • To control how RICOH ProcessDirector processes documents

To change the content of documents, you apply markup based on the values of document properties. For example, you have information about the favorite movie of each customer. You create markup for several different special offers. You define a RICOH ProcessDirector document property for favorite movies. You send the information about favorite movies to RICOH ProcessDirector in a preferences file. RICOH ProcessDirector uses the information to select a special offer and apply it to each document.

To control how RICOH ProcessDirector processes documents in your workflow, you create conditional processes based on the values of document properties. For example, you have information about the document delivery preferences of each customer. You define a RICOH ProcessDirector document property for delivery preferences, and you send the information about customer delivery preferences to RICOH ProcessDirector in a preferences file. You create conditional processes that print or email documents to customers by assigning the values for the document property that specifies delivery preferences to a job property so that RICOH ProcessDirector can create separate jobs for the documents with each delivery preference.

1.2.1.2.20.3.9.2 Usage scenario for applying document markup based on a preferences file

In this scenario, a company changes their PDF print process to add a marketing offer to customer statements in a composed PDF file before printing the statements. One of two different marketing offers can be added. The choice for each statement is based on the award level that a customer has attained. Because the award level is not part of the data on the statement, the company exports award levels from their customer database into a text file that contains headers. That text file is used as a preferences file. The values in the file determine the offer applied to each statement.

The preferences file contains customer account numbers and award levels. Customers at the Platinum award level receive one offer, and customers at the Gold award level receive another offer. Customers who have not attained an award level do not receive an offer.

Before changing their process, the company prints all their statements using the EnhancePDFDocuments supplied workflow. The value of the Identify PDF control file property on the IdentifyPDFDocuments step is /aiw/aiw1/control_files/EnhancePDFdocs.ctl. The value of the Build PDF control file 1 property on the BuildPDFFromDocuments step also is /aiw/aiw1/control_files/EnhancePDFdocs.ctl.

The company uses the HotFolderPDF supplied input device with the Child workflow property set to EnhancePDFDocuments.

They use RICOH ProcessDirector Plug-in for Adobe Acrobat to identify the statements as individual documents in the production PDF file for each job. The data in each statement includes the account number.

To support the new process, the administrator:

  • Sets up custom document properties and adds markup for the offers.
  • Creates a property mapping object.
  • Makes the preferences file available to RICOH ProcessDirector.
  • Adds the ApplyPreferences step to the EnhancePDFDocuments workflow.

Setting up custom document properties and adding markup

To set up custom document properties and add markup, the administrator:

  • Defines two custom document properties (with captions that specify the user interface names) in the docCustomDefinitions.xml file:
    • Doc.Custom.AccountNumber, with Account number for the caption
    • Doc.Custom.AwardLevel, with Award level for the caption
  • Runs the docCustom utility and updates the Custom Document Properties feature.
  • Loads the updated RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • Uses the Define Document Property function in the plug-in to map account number data in the documents to the Account number document property (database name Doc.Custom.AccountNumber).

    During processing, the IdentifyPDFDocuments step in the workflow extracts the data for the Account number document property from each document in the PDF file for the job.

      Note:
    • The Define Document Property function cannot be used to map data to the Award level document property (database name Doc.Custom.AwardLevel) because the documents do not have that data. During processing, the ApplyPreferences step in the workflow uses the preferences file to populate the property values.

  • Uses the Manage Rules function in the plug-in to define two rules:
    • The Award_level_platinum rule has these rule conditions: Doc.Custom.AwardLevel = Platinum
    • The Award_level_gold rule has these rule conditions: Doc.Custom.AwardLevel = Gold
  • Uses the Add Image function in the plug-in to add two images:
    • The first image is placed on documents that meet the conditions in the Award_level_platinum rule.
    • The second image is placed on documents that meet the conditions in the Award_level_gold rule.
  • Uses the Save control file function in the plug-in to save the document property definition and the markup for the two images in the EnhancePDFdocs.ctl control file.
  • Sends the control file to the RICOH ProcessDirector server.

Creating a property mapping object

The administrator creates a CustomerPreferences property mapping object with these values:

  • On the General section, the value of File type is CSV.
  • On the Property Mapping section the values are:
    Heading Document property Usage
    Account Number Account number Identify document
    Awards Award level Update property
Making the preferences file available to RICOH ProcessDirector

To make the preferences file available to RICOH ProcessDirector, the administrator:

  • Creates an /aiw/aiw1/preferences directory for preferences files.
  • Asks the department that provides the preferences file to name it EnhancePDFprefs.csv and write it to the /aiw/aiw1/preferences directory.
  • Makes sure that the preferences file is ready for RICOH ProcessDirector to process:
    • The file must be in comma-separated values (CSV) format or tab-delimited format.

      The columns of data must have the headings specified in the property mapping object: Account Number and Awards.

    This example shows a portion of the file:

    Account Number,Awards
    2000144372,Gold
    2001144678,None
    2001154898,Platinum
    2004187456,None
    2007192007,None
    2010197554,Gold
    2010223114,Gold
    2012234096,Platinum
    2231547625,None

Modifying the workflow

To modify the EnhancePDFDocuments workflow that the company uses to print statements, the administrator adds an ApplyPreferences step after the IdentifyPDFDocuments step and sets values for the step properties:

  • The value of Preferences file is /aiw/aiw1/preferences/EnhancePDFprefs.csv.
  • The value of Property mapping is CustomerPreferences.

Processing jobs through the workflow

After setting up the workflow and testing it, the administrator places the workflow in production.

The HotFolderPDF supplied input device receives a PDF job with statement documents and submits it to the EnhancePDFDocuments workflow.

The job moves to the IdentifyPDFDocuments step. RICOH ProcessDirector identifies the documents in the PDF file and determines the value of the Doc.Custom.AccountNumber property for each document. RICOH ProcessDirector writes the values of the property to the document properties file for the job.

The job moves to the ApplyPreferences step. RICOH ProcessDirector reads the information in the EnhancePDFprefs.csv file and creates one column of data in the document properties file. The column contains values for the Doc.Custom.AwardLevel property.

The job moves to the BuildPDFFromDocuments step. RICOH ProcessDirector applies images to the documents by using the values for the Doc.Custom.AwardLevel property in the document properties file.

1.2.1.2.20.3.9.3 Usage scenario for distributing statements based on a preferences file

In this scenario, a company changes their PDF print process to distribute statements to customers through multiple channels. Customers choose whether their statements are printed, emailed, or displayed in their customer account on the company Web site. Because this information is not part of the data on the statement, the company exports the information from their customer database into a text file that contains headers. That text file is used as a preferences file. The values in the file determine how each statement is distributed to the customer.

The preferences file contains customer account numbers, statement delivery preferences, email addresses, and marketing preferences. Customers choose whether they want to receive offers from the company and third party vendors, offers only from the company, or no offers.

Before changing their process, the company prints all their statements using the EnhancePDFDocuments supplied workflow. The value of the Identify PDF control file property on the IdentifyPDFDocuments step is /aiw/aiw1/control_files/EnhancePDFdocs.ctl. The value of the Build PDF control file 1 property on the BuildPDFFromDocuments step also is /aiw/aiw1/control_files/EnhancePDFdocs.ctl.

The company uses the HotFolderPDF supplied input device with the Child workflow property set to EnhancePDFDocuments.

They use RICOH ProcessDirector Plug-in for Adobe Acrobat to identify the statements as individual documents in the production PDF file for each job. The data in each statement includes the account number.

To support the new process, the administrator:

  • Sets up custom document properties.
  • Creates a property mapping object.
  • Makes the preferences file available to RICOH ProcessDirector.
  • Adds the ApplyPreferences step to the EnhancePDFDocuments workflow.
  • Adds steps that let the modified EnhancePDFDocuments workflow email statements to customers and display statements on the company Web site.

Setting up custom document properties

To set up custom document properties, the administrator:

  • Defines two custom document properties (with captions that specify the user interface names) in the docCustomDefinitions.xml file:
    • Doc.Custom.AccountNumber, with Account number for the caption
    • Doc.Custom.PrefOffers, with Offers preference for the caption
  • Runs the docCustom utility and updates the Custom Document Properties feature.
  • Loads the updated RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • Uses the Define Document Property function in the plug-in to map account number data in the documents to the Account number document property (database name Doc.Custom.AccountNumber).

    During processing, the IdentifyPDFDocuments step in the workflow extracts the data for the Account number document property from each document in the PDF file for the job.

      Note:
    • The Define Document Property function cannot be used to map data to the Offers preference document property (database name Doc.Custom.PrefOffers) because the documents do not have that data. During processing, the ApplyPreferences step in the workflow uses the preferences file to populate the property values.

  • Uses the Save control file function in the plug-in to save the document property definition in the EnhancePDFdocs.ctl control file.
  • Sends the control file to the RICOH ProcessDirector server.

Creating a property mapping object

The administrator creates a CustomerPreferences property mapping object with these values:

  • On the General section, the value of File type is CSV.
  • On the Property Mapping section, the values are:
    Heading Document property Usage
    Account Number Account number Identify document
    Output Type Output type Update property
    Email Address Email address Update property
    Offers Offers preference Update property

Making the preferences file available to RICOH ProcessDirector

To make the preferences file available to RICOH ProcessDirector, the administrator:

  • Creates an /aiw/aiw1/preferences directory for preferences files.
  • Asks the department that provides the preferences file to name it EnhancePDFprefs.csv and write it to the /aiw/aiw1/preferences directory.
  • Makes sure that the preferences file is ready for RICOH ProcessDirector to process:
    • The file must be in comma-separated values (CSV) format or tab-delimited format.

      The columns of data must have the headings specified in the property mapping object: Account Number, Output Type, Email Address, and Offers.

    This example shows a portion of the file:

    Account Number,Output Type,Email Address,Offers
    2000144372,Print,,All
    2001144678,Print,,None
    2001154898,Email,m.lopez@isp1.com,Company
    2004187456,Print,,Company
    2007192007,Web,j.gomez@isp2.com,All
    2010197554,Email,s.jones@isp3.com,Company
    2010223114,Email,d.wilson@isp4.com,None
    2012234096,Web,a.larson@isp5.com,None
    2231547625,Print,,All

Modifying the workflow

To modify the EnhancePDFDocuments workflow that the company uses to print statements, the administrator:

  • Adds an ApplyPreferences step after the IdentifyPDFDocuments step and sets values for the step properties:
    • The value of Preferences file is /aiw/aiw1/preferences/EnhancePDFprefs.csv.
    • The value of Property mapping is CustomerPreferences.
  • Adds a GroupDocuments step after the ApplyPreferences step and sets the value of the Group first property to Output type.

    The GroupDocuments step creates three groups of documents based on the values of the Output type document property. The values come from the EnhancePDFprefs.csv file: Print, Email, and Web.

  • Adds a CreateJobsFromDocuments step to the workflow after the GroupDocuments step and sets the value of the Child workflow property to the name of the current workflow.
  • Disconnects the CreateJobsFromDocuments step from the BuildPDFFromDocuments step.
  • Adds a condition on the connector between the SetJobPropsFromTextFile and CountPages steps. The rule on the connector is: Job number Unlike *.*

    This rule lets you process parent and child jobs through different branches. Parent jobs, which do not have a . (period) in their names, use this branch.

  • Adds a SetDocPropsFromConditions step and connects the SetJobPropsFromTextFile step to it. The SetDocPropsFromConditions step starts a new branch for child jobs. The connector does not have a rule. Child jobs, which have a decimal point in their job number, go down this branch.

    The SetDocPropsFromConditions step specifies a property conditions file that sets the Custom 1 job property (database name Job.Info.Attr1) based on the value of the Output type document property from the preferences file. The property conditions file has this content:

    "Doc.Pref.Output","Job.Info.Attr1"
    "=Email","Email"
    "=Print","Print"
    "=Web","Web"

  • Connects the SetDocPropsFromConditions step to the BuildPDFFromDocuments step.
  • Creates a workflow branch for child jobs with statements to be printed by adding a condition on the existing connector from the BuildPDFFromDocuments step to the CountPages step. The rule on the connector is: Custom 1 = Print
  • Adds an EmailDocuments step and connects the BuildPDFFromDocuments step to it. The EmailDocuments step sends each statement as a PDF file to the email address for the customer.

    The preferences file contains the customer email addresses.

  • Creates a workflow branch for child jobs with statements to be emailed by adding a condition on the connector between the BuildPDFFromDocuments and EmailDocuments steps. The rule on the connector is: Custom 1 = Email
  • Adds a RunExternalProgram step and connects the BuildPDFFromDocuments step to it. The RunExternalProgram step sends the statements to an external program that posts them on the company Web site.
  • Creates a workflow branch for child jobs with statements to be posted on the company Web site by adding a condition on the connector between the BuildPDFFromDocuments and RunExternalProgram steps. The rule on the connector is: Custom 1 = Web
  • Adds a WaitForRelatedJobs step between the PrintJobs step and the RetainCompletedJobs step.
  • Connects the CreateJobsFromDocuments, EmailDocuments, and RunExternalProgram steps to the WaitForRelatedJobs step.

Processing jobs through the workflow

After setting up the workflow and testing it, the administrator places the workflow in production.

The HotFolderPDF supplied input device receives a PDF job with statement documents and submits it to the EnhancePDFDocuments workflow.

The job goes through the workflow branch for parent jobs and moves to the ApplyPreferences step. RICOH ProcessDirector reads the information in the EnhancePDFprefs.csv file and creates three columns of data in the document properties file for the job. The columns contain values for these properties:

  • Doc.Pref.Output
  • Doc.Email.Address
  • Doc.Custom.PrefOffers

The job moves to the GroupDocuments step, which places each document in one of three groups based on the value of the Output type property.

The job moves to the CreateJobsFromDocuments step, which creates a child job for each group of documents and submits the child jobs to the same workflow.

The child jobs go through the workflow branch for child jobs.

When the child jobs reach the SetDocPropsFromConditions step, RICOH ProcessDirector sets the value of the Custom 1 job property:

  • For the child job with the Output type property set to Print, the Custom 1 job property is set to Print.
  • For the child job with the Output type property set to Email, the Custom 1 job property is set to Email.
  • For the child job with the Output type property set to Web, the Custom 1 job property is set to Web.

RICOH ProcessDirector sends the child jobs to the print branch, email branch, or Web branch of the workflow based on the value of the Custom 1 job property.

The child job with documents to be printed moves to the WaitForRelatedJobs step after the PrintJobs step.

The child job with email documents moves to the EmailDocuments step, and RICOH ProcessDirector uses the value specified for the Email address property to email each policy as a PDF file to the customer.

The child job then moves to the WaitForRelatedJobs step.

The child job with Web documents moves to the RunExternalProgram step, which sends the statements to an external program that posts them on the company Web site.

The child job then moves to the WaitForRelatedJobs step.

When all of the child jobs reach the WaitForRelatedJobs step, the parent job and the child jobs start their retention period.

    Note:
  • This usage scenario shows how to add values for the Offer preferences property to the document properties file but does not use those values in the workflow. The company might use the property to determine whether to add an image with a marketing offer to the customer statement.

1.2.1.2.20.3.10 Usage scenarios for processing documents

If you have the PDF Document Support or AFP Support feature, this topic provides links to usage scenarios. These scenarios show how document processing is used to improve your production processes and to offer new services to clients.

1.2.1.2.20.3.10.1 Usage scenarios for AFP jobs

These scenarios show the steps that a workflow might follow as it processes AFP jobs that contain documents.

1.2.1.2.20.3.10.1.1 Sorting (one-to-one) job scenario

This scenario describes how you can sort a job so that its documents print in a certain order.

In this example, an application produces a job that is unsorted. The administrator wants to sort the job alphabetically according to customer last name.

One-to-one usage scenario diagram

RICOH ProcessDirector supports job sorting using the document properties file. The document database is not required because the same input file is used for both the original job and the production job.

  1. The SortJob workflow receives and prepares the incoming data. SortJob is based on the sample SortAFP workflow that AFP Support includes.
  2. A step based on the IdentifyDocuments step template creates a document properties file containing properties of each document in the job.
  3. The job moves to the Assemble phase, where a step based on the SortDocuments step template processes it.
  4. A step based on the BuildAFPFromDocuments step template updates the AFP file for Job 1001 to put the documents in their sorted order.

1.2.1.2.20.3.10.1.2 Splitting (one-to-many) job scenario

This scenario describes how you can divide a large job into smaller ones. One benefit of this approach is that it might reduce overall printing time.

In this example, an application produces one large job with 80,000 documents. The administrator wants to split the job to print 40,000 documents on one printer and the rest on another.

One-to-many usage scenario diagram

RICOH ProcessDirector supports job splitting using the document properties file. A document database is not required because the same input file is used for both the original job and the production job.

  1. The LargeApp workflow receives and prepares the incoming data.
  2. A step based on the IdentifyDocuments step template creates a document properties file containing properties of each document in the job.
  3. The job moves to the Assemble phase, where it is processed by the SplitJobs step that specifies the document count to divide the job.
  4. A step based on the CreateAFPJobsFromDocuments step template creates two production jobs of the PrintSplit workflow.

1.2.1.2.20.3.10.2 Usage scenarios for PDF jobs

These scenarios show the steps that a workflow might follow as it processes PDF jobs.

1.2.1.2.20.3.10.2.1 Sorting (one-to-one) PDF job scenario

This scenario describes how you can sort a PDF job so that its documents print in a certain order.

In this example, an application produces a job that is unsorted. The administrator wants to sort the job alphabetically according to customer last name.

One-to-one usage scenario diagram

RICOH ProcessDirector supports job sorting using the document properties file. The document database is not required because the same input file is used for both the original job and the production job.

  1. You create a SortJob workflow to receive and prepare the incoming data. You base SortJob on the sample SortPDF workflow that PDF Document Support installs.
  2. In your new workflow, SortJob, you specify a RICOH ProcessDirector Plug-in for Adobe Acrobat control file in the IdentifyPDFDocuments step. This step creates a document properties file containing document property values for each document in the job.
  3. You specify the sorting properties in the SortDocuments step to the Assemble phase.
  4. You define the BuildPDFFromDocuments step to update the PDF file for Job 1001 to put the documents in their sorted order. In this step, you also specify the RICOH ProcessDirector Plug-in for Adobe Acrobat control files that add markup to PDF files that you process using this workflow.

1.2.1.2.20.3.10.2.2 Splitting (one-to-many) PDF job scenario

This scenario describes how you can divide a large PDF job into smaller ones. Benefits of this approach is that it might reduce overall printing time or share your printing resources.

In this example, an application produces one large job with 80,000 documents. The administrator wants to split the job to print 40,000 documents on one printer and the rest on another.

One-to-many usage scenario diagram

RICOH ProcessDirector supports job splitting using the document properties file. A document database is not required because the same input file is used for both the original job and the production job.

  1. You create a new workflow named LargeApp to receive and prepare the incoming data. For example, you can copy the SortSplitPDF workflow into a new workflow and name it LargeApp.
  2. In your new workflow, LargeApp, you specify a RICOH ProcessDirector Plug-in for Adobe Acrobat control file in the IdentifyPDFDocuments step. This step creates a document properties file containing document property values for each document in the job.
  3. You define the SplitDocuments step in the Assemble phase to divide the job into the specified segments. If you do not want to sort or group documents, delete the steps that don't apply to your new workflow.
  4. You define the CreateJobsFromDocuments step which creates two production jobs (child jobs). In the CreateJobsFromDocuments step, you define the names of the RICOH ProcessDirector Plug-in for Adobe Acrobat control files that add markup the PDF file.
  5. For the child jobs, you can either use the AssemblePDF workflow or create a copy of that workflow to define a specific workflow to print the child jobs.

1.2.1.2.20.3.10.3 Usage scenario for emailing documents to customers

In this scenario, a print shop wants to show customers who are receiving print statements that they can receive their statements as PDF files. The print shop changes the PDF workflow that prints customer statements so that, in addition to printing the statements, it sends all of them as PDF files to an email service provider. The service provider emails the statements to the customers.

The print shop uses RICOH ProcessDirector Plug-in for Adobe Acrobat to identify the statements as individual documents in the production PDF file for each job. The data in each statement includes the customer name and email address.

To change the workflow so that it both prints and emails statements, an administrator at the print shop configures RICOH ProcessDirector to support the new process.

The administrator:

  • Configures RICOH ProcessDirector to send documents to an external SMTP server at the email service provider. The configuration involves setting values for the Alternate SMTP server properties.
  • Defines a custom document property, Doc.Custom.CustomerName, in the docCustomDefinitions.xml file, runs the docCustom utility, and upgrades the Custom Document Properties feature.
  • Loads the updated RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • Uses the Define Document Property function in the plug-in to specify the data that two document properties extract from each document in the PDF file for the job:
    • Doc.EmailAddress extracts the email address of the customer.
    • Doc.Custom.CustomerName extracts the customer name.
  • Saves the two document property definitions in the control file that identifies the statements as individual documents.
  • Adds the EmailDocuments step to the workflow and sets values for the step properties:
    • The value of Recipient address is ${Doc.EmailAddress}.
    • The value of Subject line is Statement for ${Doc.Custom.CustomerName}.
    • The value of Message is Save trees by receiving your statements electronically!
    • The value of Attach document is Yes.
    • The value of Name of attachment is ${Doc.Custom.CustomerName}.pdf.
When the administrator enables the workflow and submits a job to it, RICOH ProcessDirector:
  • Sends the email service provider a PDF file for each customer statement in the job.
  • Prints a statement for each customer.

The service provider emails each customer their statement. A customer named Anita Doe receives this email:

To: Anita.Doe@mymail.comSubject: Statement for Anita Doe
Attachment: Anita Doe.pdf
__________________________________________________
Save trees by receiving your statements electronically!

After receiving a print statement by mail and a PDF statement by email, each customer can decide whether to receive future statements by mail or email.

1.2.1.2.20.3.10.4 Usage scenarios for pulling documents from a job

These scenarios show how you might offer new services to clients by extracting documents from a job and sending them through steps that provide special processing.

1.2.1.2.20.3.10.4.1 Usage scenario for pulling reminder notices from a job when late payments are received

In this scenario, a service bureau prints reminder notices in a PDF print job for a client when customers miss payments. The service bureau holds the print job until 3:00 PM. Between 1:00 PM and 3:00 PM, the client sends a pull list, which contains the account numbers of customers who have made late payments. The service bureau suppresses the reminder notices for those customers from printing by extracting the reminder notices from the print job.

The service bureau uses RICOH ProcessDirector Plug-in for Adobe Acrobat to identify the reminder notices as individual documents in the production PDF file for each job. The data in each reminder notice includes the account number.

To change the workflow so that it pulls reminder notices for the accounts on the pull list, an administrator at the service bureau configures RICOH ProcessDirector to support the new process.

The administrator:

  • Uses the Define Document Property function in RICOH ProcessDirector Plug-in for Adobe Acrobat to define the Doc.PullProp document property. To define the property, the administrator specifies the account number data that the IdentifyPDFDocuments step in the workflow extracts from each document in the PDF file for the job.

    In this scenario, the administrator uses the values of the Doc.PullProp document property (that is, the account numbers) to determine the documents to be removed from the job. This property is supplied with all document processing features. As an alternative, the administrator can define another document property, such as Doc.Custom.AccountNumber, in the docCustomDefinitions.xml file, and use that property instead of Doc.PullProp.

    Note: If you define a custom document property, you must run the docCustom utility, update the Custom Document Properties feature, and load the updated RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.

  • Uses the Save control file function in the plug-in to save the document property definition in the control file that identifies the reminder notices as individual documents.

  • Sends the control file to the RICOH ProcessDirector server.

  • Specifies the name of the control file as the value of the Identify PDF control file property for the IdentifyPDFDocuments step.

  • Adds a Wait step to the workflow after the IdentifyPDFDocuments step and sets the value of the Wait until property to 3:00 PM.

  • Adds a SetDocPropsFromList step to the workflow after the Wait step and sets values for the step properties:

    • The value of List file directory is /aiw/aiw1/clientfiles/pull.

    • The value of Delimiter is New Line.

    • The value of Columns in list file is Pull property. Pull property is the user interface name of the Doc.PullProp document property.

      If the administrator had defined a Doc.Custom.AccountNumber document property to specify the account number data, the value of Columns in list file would be Doc.Custom.AccountNumber.

    • The value of Document property to set is Pull document. Pull document is the user interface name of the Doc.Pull document property.

      The Doc.Pull property is supplied with all document processing features. It is a convenient choice for the value of the Document property to set document property. As an alternative, the administrator could create a custom document property and use it as the value of Document property to set.

    • The value of Value for matching documents is YES.

    • The value of Value for other documents is NO.

  • Adds a Group Documents step to the workflow after the SetDocPropsFromList step and sets the value of the Group first property to Pull document.

  • Adds a CreateJobsFromDocuments step to the workflow after the Group Documents step and sets the value of the Child workflow property to the name of the current workflow.

  • Adds conditional processing near the start of the workflow to process parent and child jobs differently. The new branch for child jobs lets them bypass the document identification steps.

  • Adds a SetDocPropsFromConditions step at the start of the branch for child jobs.

    The step assigns a value to a job property based on the value of the Pull document document property. The property conditions file sets the value of the Custom 1 job property to Pull or Print.

  • Creates two workflow branches, one for child jobs with documents to be printed, and the other for child jobs with pulled documents. The rules for the branches are:

    • Custom 1 = Pull

    • Custom 1 = Print

  • Adds a SendEmail step to the branch for child jobs with pulled documents. The step sends the PDF file for the job to the client for verification that the documents were pulled.

    • The value of the Recipient address property is the email address of the person at the client company who requested PDF files for verification.

    • The value of the Attachments property is ${getCurrentFile(pdf)}.

    • The value of the Message property is These reminder notices were pulled from job ${Job.Name}.

  • Rejoins the two branches by connecting them to a WaitForRelatedJobs step.

Note: The workflow in this usage scenario is similar to the PullPDFSample workflow. Examine that workflow to see all the steps, the connectors to the branches, and the values of step properties.

The administrator enables the workflow and submits a job to it at 8:00 AM.

The job goes through the workflow branch for parent jobs and stops at the Wait step.

At 1:00 PM, the operator receives a pull list from the client and uploads it to the /aiw/aiw1/clientfiles/pull directory. The pull list contains six account numbers:

245876A270011H335698R520905B558721L875540R

At 2:50 PM, the operator receives a second pull list from the client and uploads it. The pull list contains two account numbers:

445009S500112A

AT 3:00 PM, RICOH ProcessDirector releases the job from the Wait step.

The job moves to the SetDocPropsFromList step. RICOH ProcessDirector :

  • Retrieves the two pull lists from the aiw/aiw1/clientfiles/pull directory

    .
  • Examines the values for the Doc.PullProp property in the document properties file in the spool file for the job.

  • Creates a column of values for the Doc.Pull property in the document properties file.

    When the value of the Doc.PullProp property matches one of the eight account numbers in the pull lists, RICOH ProcessDirector sets the value of the Doc.Pull property to YES.

    It sets the value of the Doc.Pull property for all other documents in the document properties file to NO.

The job moves to the Group Documents step, which places each document in one of two groups based on the value of the Doc.Pull property.

The job moves to the CreateJobsFromDocuments step, which creates a child job for each group of documents and submits the child jobs to the same workflow.

The child jobs go through the workflow branch for child jobs.

When the child jobs reach the SetDocPropsFromConditions step, RICOH ProcessDirector sets the value of the Custom 1 job property:

  • For the child job with the Doc.Pull property set to Yes, the Custom 1 job property is set to Pull.

  • For the child job with the Doc.Pull property set to No, the Custom 1 job property is set to Print.

RICOH ProcessDirector sends the child jobs to the print branch or pull branch of the workflow based on the value of the Custom 1 job property.

The child job with pulled documents moves to the SendEmail step, and RICOH ProcessDirector emails the job to the client for verification. The child job then moves to the WaitForRelatedJobs step.

The child job with documents to be printed moves to the WaitForRelatedJobs step after the PrintJobs step.

When both child jobs arrive at the WaitForRelatedJobs step, RICOH ProcessDirector sends them to the RetainCompletedJobs step.

1.2.1.2.20.3.10.4.2 Usage scenario for pulling policies based on addresses in a disaster area

In this scenario, a service bureau prints policies in a PDF print job. Because severe flooding has made mail delivery impossible in two postal codes, the service bureau suppresses the printing of policies with customer addresses in those postal codes. It removes those policies from the print job and emails them to customers.

The workflow in this scenario does not have a step that waits for receipt of a pull list. Jobs move through the workflow without waiting. As soon as the service bureau provides a pull list of postal codes in a disaster area, RICOH ProcessDirector removes documents with those postal codes from each print job that enters the SetDocPropsFromList step. When mail delivery resumes to all postal codes in the pull list, the service bureau removes the pull list, and RICOH ProcessDirector does not remove documents from print jobs that enter the SetDocPropsFromList step. The step remains in the workflow and can be used whenever documents need to be pulled from a job.

The service bureau uses RICOH ProcessDirector Plug-in for Adobe Acrobat to identify the policies as individual documents in the production PDF file for each job. The data in each policy includes the customer name, customer email address, and postal code.

To change the workflow so that it pulls policies for customers in the disaster area, an administrator at the service bureau configures RICOH ProcessDirector to support the new process.

The administrator:

  • Defines two custom document properties, Doc.Custom.CustomerName and Doc.Custom.PostalCode, in the docCustomDefinitions.xml file.
  • Runs the docCustom utility and updates the Custom Document Properties feature.
  • Loads the updated RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • Uses the Define Document Property function in the plug-in to define three document properties:
    • Doc.Custom.PostalCode specifies the postal code data.
    • Doc.Custom.CustomerName specifies the customer name data.
    • Doc.EmailAddress specifies the customer email address data.

      This document property is supplied with all document processing features.

    The IdentifyPDFDocuments step in the workflow is going to extract the data for the three document properties from each document in the PDF file for the job. RICOH ProcessDirector is going to use the values of the Doc.Custom.PostalCode document property to determine which documents to pull from the job. RICOH ProcessDirector is going to use the values of the Doc.Custom.CustomerName and Doc.EmailAddress document properties in the step that emails pulled documents.

  • Uses the Save control file function in the plug-in to save the document property definitions in the control file that identifies the policies as individual documents.
  • Sends the control file to the RICOH ProcessDirector server.
  • Specifies the name of the control file as the value of the Identify PDF control file property for the IdentifyPDFDocuments step.
  • Adds a SetDocPropsFromList step to the workflow and sets values for the step properties:
    • The value of List file directory is /aiw/aiw1/clientfiles/pull.
    • The value of Delimiter is New Line.
    • The value of Columns in list file is Doc.Custom.PostalCode.
    • The value of Document property to set is Pull document. Pull document is the user interface name of the Doc.Pull document property.

      The Doc.Pull property is supplied with all document processing features. It is a convenient choice for the value of the Document property to set document property. As an alternative, the administrator could create a custom document property and use it as the value of Document property to set.

    • The value of Value for matching documents is YES.
    • The value of Value for other documents is NO.
  • Adds a Group Documents step to the workflow after the SetDocPropsFromList step and sets the value of the Group first property to Pull document.
  • Adds a CreateJobsFromDocuments step to the workflow after the Group Documents step and sets the value of the Child workflow property to the name of the current workflow.
  • Adds conditional processing near the start of the workflow to process parent and child jobs differently. The new branch for child jobs lets them bypass the document identification steps.
  • Adds a SetDocPropsFromConditions step at the start of the branch for child jobs.

    The step assigns a value to a job property based on the value of the Pull document document property. The property conditions file sets the value of the Custom 1 job property to Pull or Print.

  • Creates two workflow branches, one for child jobs with documents to be printed, and the other for child jobs with pulled documents. The rules for the branches are:
    • Custom 1 = Pull
    • Custom 1 = Print
  • Adds an EmailDocuments step to the branch for child jobs with pulled documents. The step sends each document as a PDF file to the email address for the customer.
    • The value of Recipient address is ${Doc.EmailAddress}.
    • The value of Subject line is Policy for ${Doc.Custom.CustomerName}.
    • The value of Message is Because mail service to postal code ${Doc.Custom.PostalCode} has been interrupted, we have attached a PDF copy of your policy.
    • The value of Attach document is Yes.
    • The value of Name of attachment is ${Doc.Custom.CustomerName}.pdf.
  • Rejoins the two branches by connecting them to a WaitForRelatedJobs step.
  • Creates a pull list and uploads it to the /aiw/aiw1/clientfiles/pull directory. The pull list contains two postal codes:
    8045580540

The administrator enables the workflow and submits a job to it.

The job goes through the workflow branch for parent jobs and moves to the SetDocPropsFromList step. RICOH ProcessDirector :

  • Retrieves the pull list from the /aiw/aiw1/clientfiles/pull directory.
  • Examines the values for the Doc.Custom.PostalCode property in the document properties file in the spool file for the job.
  • Creates a column of values for the Doc.Pull property in the document properties file.

    When the value of the Doc.Custom.PostalCode property matches one of the two postal codes in the pull list, RICOH ProcessDirector sets the value of the Doc.Pull property to YES.

    It sets the value of the Doc.Pull property for all other documents in the document properties file to NO.

The job moves to the Group Documents step, which places each document in one of two groups based on the value of the Doc.Pull property.

The job moves to the CreateJobsFromDocuments step, which creates a child job for each group of documents and submits the child jobs to the same workflow.

The child jobs go through the workflow branch for child jobs.

When the child jobs reach the SetDocPropsFromConditions step, RICOH ProcessDirector sets the value of the Custom 1 job property:

  • For the child job with the Doc.Pull property set to Yes, the Custom 1 job property is set to Pull.
  • For the child job with the Doc.Pull property set to No, the Custom 1 job property is set to Print.

RICOH ProcessDirector sends the child jobs to the print branch or pull branch of the workflow based on the value of the Custom 1 job property.

The child job with pulled documents moves to the EmailDocuments step, and RICOH ProcessDirector emails each policy as a PDF file to the customer. A customer named John Doe receives this email:

To: John.Doe@mymail.comSubject: Policy for John Doe
Attachment: John Doe.pdf__________________________________________________Because mail service to postal code 80455 has been interrupted,we have attached a PDF copy of your policy.

The child job then moves to the WaitForRelatedJobs step.

The child job with documents to be printed moves to the WaitForRelatedJobs step after the PrintJobs step.

When both child jobs arrive at the WaitForRelatedJobs step, RICOH ProcessDirector sends them to the RetainCompletedJobs step.

After mail delivery resumes to postal codes in the pull list, the administrator removes the pull list from the /aiw/aiw1/clientfiles/pull directory.

RICOH ProcessDirector prints all documents in the jobs that go through the workflow until the administrator places another pull list in the pull directory.

1.2.1.2.20.4 The Common Properties feature

The Common Properties feature adds job and document properties that are useful for transaction processing and tracking purposes.

The job properties are not associated with a step template but can be set in a workflow using the AssignJobValues step or the Manage job defaults action in the Workflow Editor. If you use the Manage job defaults action, the job properties are shown in the job property notebook. If you use the AssignJobValues step, they are not shown on the job property notebook.

You can use these job properties in rules defined on connectors in your worklow. You can use these properties when searching for jobs in the Jobs table.

The document properties can be set using the SetDocPropsFromList or SetDocPropsFromConditions step or other steps that set values for document properties. If you have the Preference Management feature installed, you can set values for these document properties using a property mapping from a preferences file.

You can use these job and document properties when searching for documents in the Documents portlet. You can also use these document properties to sort and group documents and to store in a repository if you have the Archive feature installed.

Job properties
Database name Notebook field name Data type
Job.ApplicationID Application ID String128
Job.ApplicationSubType Application Sub-type String128
Job.ApplicationType Application Type String128
Job.ClientID Client ID String32
Job.CompanyID Company ID String128
Job.CompanyName Company name String128
Job.CycleDate Cycle Date Date
Job.CycleID Cycle ID String32
Job.DeliveryMethod Delivery Method String128
Job.DocumentSubType Document Sub-Type String128
Job.DocumentType Document Type String128
Job.DueDate Due date Time
Job.FoldType Fold Type String128
Job.IssueDate Issue Date Time
Job.LineOfBusiness Line of Business String128
Job.WorkflowType Workflow Type String128
Document properties
Database name Notebook field name Data type
Doc.ApplicationID Application ID String128
Doc.ApplicationSubType Application Sub-type String128
Doc.ApplicationType Application Type String128
Doc.ClientID Client ID String32
Doc.CompanyID Company ID String128
Doc.CompanyName Company name String128
Doc.CycleDate Cycle Date Date
Doc.CycleID Cycle ID String32
Doc.DeliveryMethod Delivery Method String128
Doc.DocumentSubType Document Sub-Type String128
Doc.DocumentType Document Type String128
Doc.DueDate Due date Time
Doc.FoldType Fold Type String128
Doc.IssueDate Issue Date Time
Doc.LineOfBusiness Line of Business String128
Doc.WorkflowType Workflow Type String128

1.2.1.2.20.5 Advanced Transform feature

The Advanced Transform feature is a customizable component. You can purchase transforms for the input and output data streams that you need.

Transforms to and from these data streams are available:

  • AFP
  • BMP, GIF, JPEG, PNG, TIFF (only as input data stream)
  • PCL
  • PDF
  • PostScript

When you order the Advanced Transform feature, you specify which input data stream transforms and which output data stream transforms you need. When you configure workflows, you can combine the input and output data stream transforms as needed.

    Note:
  • When you send jobs with PDF or image files included in the AFP object containers, you must install the appropriate input data stream transform to process them correctly. For example, for AFP files containing images, you must use the InputImage transform. When installed, the InputImage transform converts automatically the jobs containing the supported images. For AFP files containing PDF data, you must install both the InputAFP and InputPDF transforms.

After you install and activate the Advanced Transform feature, you must install either a trial license key or a purchased license key for each input and output data stream transform that you want to use.

1.2.1.2.20.6 Web Services Enablement

This feature lets RICOH ProcessDirector objects and steps use Representational State Transfer (REST) and Simple Object Access Protocol (SOAP) to communicate with web services for applications. The RICOH ProcessDirector implementations of REST and SOAP support Extensible Markup Language (XML). The implementation of REST also supports JavaScript Object Notation (JSON).

The feature adds:

  • Input device types
  • Notification object types
  • Step templates

Input device types

Web Services Enablement provides two types of input devices. REST and SOAP web service input devices communicate with applications by calling web services and retrieving information that RICOH ProcessDirector uses to create jobs.

Notification object types

Web Services Enablement provides two types of notification objects. REST and SOAP web service notifications call web services to update an application when a job or printer event occurs. For example, a notification can update an application when all the items in an order job ship to a customer. A notification also can alert an application when a printing error occurs, or when an input device status changes.

Step templates

Web Services Enablement provides these step templates:

  • CallRESTService
  • CallSOAPService

Steps based on these step templates let you communicate with applications that provide web service interfaces. These steps call web services from any phase within RICOH ProcessDirector workflows.

Authentication

Web Services Enablement input devices and notifications can communicate with web services for applications that require API key or session authentication. They also can communicate with applications that do not require authentication. Input devices authenticate when they poll for input. Notifications authenticate when they send status to the application.

For API key authentication, you put an authorization code in a Static credential property or define an HTTP user ID and password. The object passes the authorization code or the HTTP user ID and password to the web service that exchanges data. The web service then authenticates with the application and returns a response.

For session authentication, you put authentication credentials (user ID and password) and other values in a set of authentication request properties. The input device or notification first calls a REST web service to authenticate with the application. After a successful authentication, the web service returns a token. The input device or notification then transmits the token in the call to the web service that exchanges data.

1.2.1.2.20.6.1 Usage scenario for processing JSON orders with web services

In this scenario, a printing company wants to process orders retrieved from a web site for ordering books. Each order consists of 2 job tickets. One job ticket provides information (including the location of the print file) required to print the book. The other job ticket provides information required to print the cover for the book. The book and its cover go through different production processes, and the printing company must report when the whole order is completed. The web site provides a REST web services interface.

The Web Services Enablement feature includes sample objects that show how this scenario works:

  • RestfulWebServiceWF workflow
  • RestfulWebServiceSample REST web service input device
  • JSON orders and job tickets
  • XPath expression
  • XSLT style sheets
  • RICOH ProcessDirector overrides files
  • RestfulWebServiceSampleNotify REST web service notification

To examine the RestfulWebServiceWF workflow, see the related task topic about running a workflow that processes orders retrieved from REST web services.

Learning the requirements of the book-ordering web site

The printing company learns the requirements to communicate with the REST web services for the book-ordering web site. RICOH ProcessDirector must call 3 web services:

  • A call to one web service retrieves JSON information about each book order. If orders are waiting at the web site, the web service returns one JSON order in response to each GET call. If no orders are waiting, the web service does not respond to the call.

    Contents of sample JSON order:

    {"Order": {"orderId": "ORD1238875463", "customername": "Ricoh"}}

  • A call to another web service retrieves JSON information about the job tickets for the book and its cover.

    Sample JSON job ticket information:

    {"JobTicket": [{ "itemnumber": "1182563839", "copies":"4","media" : "Letter Plain","file" : "http://localhost:15080/restapi/Brochure.pdf","type" : "Brochure","title" : "RPDBestSeller"}, { "itemnumber": "1934194376", "copies":"4","media" : "Letter Preprinted","file" : "http://localhost:15080/restapi/Cover.pdf","type" : "Cover" ,"title" : "RPDBestSeller" }]}

  • A call to a third web service sends the item number of each completed job ticket for an order. When both item numbers for an order have been sent, the web service creates a PDF file that lists the job numbers and item numbers. The web service places the PDF file in a directory.

    Contents of sample PDF file:

    10000001.2 with item number 1182563839 has been processed10000001.1 with item number 1934194376 has been processed

    Note:
  • The 3 sample web services simulate web services for a book-ordering web site but are available locally as part of the Web Services Enablement feature. They return sample data in response to specific requests made by the RestfulWebServiceSample input device, the CallRESTService step in the RestfulWebServiceWF workflow, and the RestfulWebServiceSampleNotify notification.
  • The sample web services generate sample orders with different order IDs and sets of sample job tickets with different item numbers. The rest of the data in the samples is the same.

To make the calls to the web services, the RICOH ProcessDirector administrator learns:

  • The values required to authenticate with the book-ordering web site.
  • The values required to request data from each web service.
  • The format of the data provided in the response from each web service.

The administrator uses a browser plug-in to run manual tests that request responses from the REST web services. Examples of plug-ins include RESTClient for Mozilla Firefox and Boomerang for Google Chrome.

Preparing to process the JSON

The administrator reviews the contents of the JSON orders and job tickets returned by the REST web services and identifies information that RICOH ProcessDirector requires. Next, the administrator evaluates the RICOH ProcessDirector capabilities that call web services and process XML and JSON. The administrator decides on the RICOH ProcessDirector objects and sets of steps that process the orders and job tickets and extract required information. The administrator then defines the XPath expressions and XSLT style sheets required by the objects and steps.

  1. To process orders and job tickets in RICOH ProcessDirector, the administrator identifies JSON objects that supply required information. The administrator assigns the values of those objects to RICOH ProcessDirector job properties.
    • To call the web service that retrieves JSON information about the job tickets, the administrator must supply the order ID. The administrator also wants to track the customer name in RICOH ProcessDirector.

      Two members of the JSON order object provide these values: orderId and customername.

      This table shows the 2 JSON members and the names of the RICOH ProcessDirector job properties that the administrator uses to extract the information.

      JSON member Database name of job property User interface name of job property
      orderId Job.Info.Attr3 Custom 3
      customername Job.CustomerName Customer name

    • To create separate jobs for each job ticket, the administrator must use the item number. To download and print the PDF files for books and covers, the administrator must use the file, copies, and media information in the job ticket. The administrator also wants to track the book type and title in RICOH ProcessDirector.

      Six members of the JSON job ticket object provide these values: file, itemnumber, type, title, copies, and media.

      This table shows these 6 JSON members and the names of the RICOH ProcessDirector job properties.

      JSON member Database name of job property User interface name of job property
      itemnumber Job.Info.Attr1 Custom 1
      file Job.Info.Attr2 Custom 2
      type Job.Info.Attr4 Custom 4
      title Job.Info.Attr5 Custom 5
      copies Job.Copies Job copies requested
      media Job.Media Media

  2. Before designing the RICOH ProcessDirector process, the administrator examines the RICOH ProcessDirector objects and step template that call REST web services:
    • REST web service input device
    • REST web service notification
    • CallRESTService step template

    Each of them can make DELETE, GET, PATCH, POST, or PUT calls, and each can process JSON or XML.

    The input device can create a job from every response, or it can evaluate the response for a JSONPath or XPath expression. If the input device does an evaluation, it can create a job each time it finds the expression.

  3. The administrator also examines the RICOH ProcessDirector step templates that process XML:
    • A step based on the ApplyXSLTransform step template can convert input in one format into output in another format. For example, the step can convert XML into this output:
      • A text file containing Ricoh ProcessDirector job or document properties.
      • A file with XML in another format for input to the CreateJobsFromXML step.
    • A step based on the CreateJobsFromXML step template can create one or more XML jobs by evaluating the contents of an XML input file. The step can submit the jobs as independent jobs or child jobs to a specified workflow.

    Because ApplyXSLTransform and CreateJobsFromXML do not process JSON, a step based on the ConvertJSONToXML step template can convert JSON to XML for input to those steps.

  4. The administrator decides on the basic components of the RICOH ProcessDirector process.
    • To retrieve JSON orders from the book-ordering web site, the administrator chooses a REST web service input device.

      Because each response contains a single order, the administrator sets up the input device to create a job from every response.

    • To retrieve JSON job tickets for each order, the administrator chooses 3 steps:
      • A ConvertJSONToXML step converts the JSON orders into XML for input to an ApplyXSLTransform step.
      • The ApplyXSLTransform step converts order ID and customer name values in the XML orders into RICOH ProcessDirector Custom 3 and Customer name job properties.
      • Using the value of the Custom 3 property, a CallRESTService step retrieves the JSON job tickets.
    • To create a job for each job ticket, the administrator chooses 2 steps:
      • A ConvertJSONToXML step converts the JSON job tickets into XML for input to a CreateJobsFromXML step.
      • The CreateJobsFromXML step creates a separate job for each job ticket by evaluating the response using an XPath expression.
    • To extract information from the job tickets and use it to download PDF print files, the administrator chooses 3 steps:
      • An ApplyXSLTransform step converts values in the XML job tickets into RICOH ProcessDirector job properties. For example, the URL of the file to download is converted to the value of the Custom 2 job property.
      • Using the value of the Custom 2 job property, a DownloadFile step downloads the PDF print files.
      • An AssignJobValues step sets the input data stream to PDF to tell the other steps in the workflow the type of file that they are processing.
    • When both PDF jobs in an order are printed, the administrator wants to notify the book-ordering web site that the order is ready to ship. Because the web site uses REST, the administrator chooses a REST web service notification.
  5. For the CreateJobsFromXML step, the administrator needs an XML Path Language (XPath) expression that identifies the job tickets. To define the expression, the administrator examines the XML for the job tickets.
  6. For each ApplyXSLTransform step, the administrator needs an XSLT style sheet to convert XML elements into job properties. The administrator uses an XSLT tool (such as Altova MapForce) to create 2 XSLT style sheets:
    • An order-to-overrides-file XSLT style sheet converts the order ID and customer name elements of the order into job properties.
    • A job-ticket-to-overrides-file XSLT style sheet converts the file, item number, type, title, copies, and media elements of the job ticket into job properties.

    Each ApplyXSLTransform step outputs the job properties in a text file. The value of each Output file property specifies an overrides file in the spool directory for the job.

    RICOH ProcessDirector uses the values in the overrides file to set the values of the properties for the job. Values from the orders are used to retrieve job tickets. Values from the job tickets are used to download and process print files.

Setting up the workflow

The administrator sets up a workflow with 2 branches.

  1. The administrator creates a workflow named ProcessBookOrders and sets the properties of the SetJobPropsFromTextFile step.
  2. The administrator adds 10 steps to the workflow in this order:
    • DetectInputDataStream

      This step sets the Input data stream property to JSON.

    • ConvertJSONToXML

      This step uses the default values for the JSON input file and XML output file.

    • ApplyXSLTransform

      This step uses the order-to-overrides-file XSLT style sheet to create a text file that sets values for the Custom 3 and Customer name properties. The step outputs the text file as an overrides file in the spool directory for the job. RICOH ProcessDirector uses the overrides file to set the Custom 3 and Customer name property values for the job.

    • AssignJobValues

      This step sets the value of the Job name property to ORDER-order ID.

    • CallRESTService

      This step makes a GET call to another web service for the book-ordering web site. The step specifies order ID as the value of the Request parameters property:

      orderId:${Job.Info.Attr3}

      The web service returns JSON job ticket information.

    • ConvertJSONToXML

      This step uses the default values for the JSON input file and XML output file.

    • CreateJobsFromXML

      The administrator sets the value of the XPath expression to //JobTicket and the value of the workflow for new jobs to ProcessBookOrders. To keep the new jobs connected to the original job for the order, the administrator sets the value of the Create child jobs property to Yes. To specify order ID as the job name, the administrator sets the value of the Name for new job property property to ${Job.Info.Attr3}.

      The XML jobs that enter the step go to the next step, while the new child jobs are sent down a separate branch of the workflow.

    • RunHotFolderApplication

      The administrator adds this step to communicate with the web service that creates PDF files and puts them in a hot folder. First, the web service polls a hot folder for order jobs. After the web service receives 2 requests per order from the RestfulWebServiceSampleNotify notification, the web service puts a PDF file in another hot folder. The RunHotFolderApplication step specifies the hot folder for order jobs as the value of the Sending folder property. The step specifies the hot folder with the PDF files as the value of the Retrieval folder property.

        Note:
      • This scenario includes a RunHotFolderApplication step because the sample RestfulWebServiceWF workflow uses this step to exchange data with the sample web service. Instead of returning a PDF file when an order is complete, the web service could do a different function. For example, the web service could send an email message to notify the packing department that the order is ready to pick up.

    • AssignJobValues

      This step sets the value of the Input data stream property to PDF so that the PDF files created by the web service can be viewed in the workflow.

    • RetainCompletedJobs
  3. The administrator connects the RetainCompletedJobs step to the RemoveJobs step.
  4. The administrator creates a second branch to process the child jobs for the books and their covers.
    • The administrator sets a rule on the connector between the SetJobPropsFromTextFile and DetectInputDataStream steps:
      • Rule name: Parent
      • Order of execution: 1
      • Property: Job number
      • Comparison: Unlike
      • Value: *.*

      The rule sends JSON jobs that the input device retrieves to the DetectInputDataStream step.

    • The administrator adds an ApplyXSLTransform2 step in the Receive phase and connects it to the SetJobPropsFromTextFile step.

      The step uses the job-ticket-to-overrides-file XSLT style sheet to create an overrides file that sets values for the Custom 2, Custom 1, Custom 4, Custom 5, Job copies requested, and Media properties. Custom 2, Custom 1, Custom 4, and Custom 5 are file, item number, type, and title, respectively.

    • The administrator sets a rule on the connector between the SetJobPropsFromTextFile and ApplyXSLTransform2 steps:
      • Rule name: Child
      • Order of execution: 2
      • Property: Job number
      • Comparison: Like
      • Value: *.*

      The rule sends child jobs that the CreateJobsFromXML step creates to the ApplyXSLTransform2 step.

    • Because the focus of this scenario is web services, the printing portion is simple. A production process could send the books and their covers through different steps in different workflows or branches to different printers.
  5. The administrator adds 6 steps to the workflow in this order:
    • DownloadFile

      This step downloads PDF files for the book and its cover from a web site. The step sets the value of the URL for download file property to Custom 2, which contains the file download information from the job ticket.

    • AssignJobValues

      This step sets the value of 3 job properties:

      • Requested printer
      • Input data stream
      • Job name

      The value of Job name is ${Job.Info.Attr5}-${Job.Info.Attr4}: the book title, a hyphen, and the type of print job (book or cover).

    • OptimizePDF
    • CountPages
    • CreatePageRanges
    • PrintJobs
        Note:
      • Because the focus of this scenario is web services, the printing portion of the workflow has only 4 steps. A production process could send the books and their covers through many more steps in separate branches (or separate workflows) to different printers.
  6. The administrator completes the workflow by connecting the PrintJobs step to the RetainCompletedJobs step.

This figure shows the input device, workflow, and notification. The black line indicates that the CreateJobsFromXML step submits the child jobs to the ProcessBookOrders workflow.

Setting up the input device

On the General tab of the REST web service input device, the administrator sets the value of the child workflow property to ProcessBookOrders. The input device submits JSON orders retrieved from the web service for the book-ordering web site to that workflow. The administrator sets the polling interval to 30 seconds to retrieve orders quickly when several of them are waiting at the web site. Other properties are set to match the environment of the printing company.

On the Request tab, the administrator specifies the values required to retrieve JSON orders from the REST web service. Because each response contains one JSON order, the administrator sets the value of the Create jobs from response property to Always. The network at the printing company does not require a proxy server.

    Note:
  • To use a proxy server, set the Use proxy server property to Yes. Proxy server properties are set on the Proxy server tab of the System Settings page.

On the Authentication tab, the administrator specifies the values required to authenticate with the REST web service.

    Note:
  • The supplied RestfulWebServiceSample input device shows how to set up a REST web service input device for this scenario. The input device calls a web service that does not require authentication. For information about authenticating with a REST web service, see the related task topic.

Setting up the notification

On the Request tab of the REST web service notification, the administrator specifies the values required by the REST web service that receives the notification. The network at the printing company does not require a proxy server.

    Note:
  • To use a proxy server, set the Use proxy server property to Yes.

On the Authentication tab, the administrator specifies the values required to authenticate with the REST web service.

    Note:
  • The supplied RestfulWebServiceSampleNotify notification shows how to set up a REST web service notification for this scenario. The notification calls a web service that does not require authentication. For information about authenticating with a REST web service, see the related task topic.

On the Event tab, the administrator specifies the notification event information:

  • Event type: Job
  • Property: Current job state
  • Action: Changes to
  • Value: Retained

On the Conditions tab, the administrator specifies the notification conditions information:

  • Apply any or all of the following conditions = All
  • Property 1: Workflow
  • Comparison 1: =
  • Value 1: ProcessBookOrders
  • Property 2: Job number
  • Comparison 2: like
  • Value 2: *.*

The summary of the conditions statement is:

Job.JobType = 'RestfulWebServiceWF' AND Job.ID like '*.*'

When all the child jobs for an order reach the RetainCompletedJobs step, the notification calls the web service. The web service creates a PDF file containing the item number of each job ticket in the order. The web service puts the file in a hot folder monitored by the RunHotFolderApplication step. The PDF file appears in the jobs table. Employees at the printing company can view the PDF file to confirm that the book and cover for the order have been printed.

Processing jobs through the workflow

The RestfulWebServiceWF workflow supplied with the Web Services Enablement feature is similar to the ProcessBookOrders workflow. To see how jobs are processed through the ProcessBookOrders workflow, run the RestfulWebServiceWF workflow. For more information, see the related task topic about running a workflow that processes orders retrieved from REST web services.

1.2.1.2.20.7 Reports

The Reports feature lets you capture printer status changes, user actions, and job and document property values in a PostgreSQL database. You can extract and analyze the data from the database using a business intelligence tool such as Tableau. You can also transmit selected tables from the database to an application of your choice using a REST web service.

The feature adds one step template and two objects called Data Collectors and Data Transmitters. The Reports feature does not include business intelligence software. You can use your preferred tool with the information stored in the Reports database.

Step template

  • WritePropsToReportsDatabase

    Lets you choose which job and document properties to store in the Reports database when the step runs and the database table to store the data in. You can insert multiple WritePropsToReportsDatabase steps in a workflow wherever you want to store properties at different times during job processing.

Objects

The Reports feature adds the Data collector and Data transmitter objects.

Data collector
Data collectors let you configure what RICOH ProcessDirector information to store in the PostgreSQL database. You can capture job property values, document property values, printer data, and user activity data using the supplied Data collectors.
Data transmitter
Data transmitters let you configure what information to extract from one or more PostgreSQL databases to send to another application. Data transmitters use the REST protocol to send the data to another application. You can specify when and how often the data is sent.

Reports database

The Reports feature stores data in a PostgreSQL database regardless of the database configuration that RICOH ProcessDirector uses. To create the Reports database, you have two options:

  • Use the instance of PostgreSQL provided with RICOH ProcessDirector.

    Even if you use IBM DB2 as your primary database, PostgreSQL is available with your installation. If you choose this option, PostgreSQL runs on your primary computer, but the Reports database is in a separate database system from the primary database. The configuration process is simplified, because the database is created automatically when you enable data collection.

    Note: The provided version of PostgeSQL is provided as a Docker image. If your primary database is DB2, you must install Docker Engine on your primary server to use this option.

  • Use your own installation of PostgreSQL.

    If you prefer to use your own installation, RICOH ProcessDirector can connect to a PostgreSQL database on any system in your network. Before you enable data collection, you must create a database system, database, and database user ID.

Configuration

You use the Administration page to configure basic information about the Reports database, such as:

  • The database name
  • The user and password that RICOH ProcessDirector uses to access the database
  • The host name and port of the computer that the database tables are stored on

To collect job, printer, or user activity data, configure the appropriate data collector to specify the data to capture. To use the WritePropsToReportsDatabase step, add the step to your workflows as needed. When the step runs, it stores the property values in the specified database tables. If the table does not exist when the step runs, RICOH ProcessDirector creates it.

After the database is created and contains data, you can use SQL statements to query data and to export data to external storage for long-term use or use a data transmitter to send the data to another application that accepts data exchange over the REST protocol.

To send data on a specific schedule, or when the Enabled status changes, you configure the appropriate data transmitter to specify the interval and frequency.

You can use the One-time transmission function to send a specific set of data outside the scheduled time, such as when testing the transmitter or to resend data that was previously sent.

Data visualization

To analyze data stored in the Reports database, you can use a business intelligence tool, such as Tableau. The Reports feature includes a Tableau workbook with sample worksheets that let you visualize the data for pages printed and jobs by customer. After examining the supplied data visualizations, you can create your own data visualizations and publish them to a server or make them available to management.

1.2.1.2.20.7.1 Usage scenario for Reports

In this scenario, a printing company wants to generate daily reports that show the pages printed on each printer and the jobs printed by each customer. They want to create a reporting dashboard with the two reports and publish the dashboard to a server that company management can access.

The printing company installs the Reports feature on their RICOH ProcessDirector for Windows primary server, which includes the PostgreSQL database program. Then, they open the Administration page and select Reports Database Settings to create the reports database.

The printing company wants to generate two reports: Pages printed by printer and Jobs printed by customer. They can collect that data for both of those reports using the Job Print Progress data collector. For the first report, they need to capture the Pages stacked and Previous Printer job properties; for the second report, they need to capture the Job number and the Customer name properties.

The user selects Reports Data Collectors and opens the Job Print Progress data collector. On the data collector property notebook, the user finds the Job properties to capture list and selects these properties:

  • Pages stacked
  • Previous Printer
  • Job number
  • Customer name
The user names the table job_printing and enables data collection for the data collector.

After the user clicks OK, RICOH ProcessDirector captures the values of the properties in the PostgreSQL database each time that a job starts or stops printing.

After enabling data collection for the job_printing table and populating it with data, the printing company installs the Tableau business intelligence (BI) tool on a remote server. They configure RICOH ProcessDirector to let Tableau connect to the PostgreSQL database remotely.

Using Tableau, the printing company connects to the job_printing table in the PostgreSQL database. They choose to update the data in Tableau automatically when the data is captured in PostgreSQL.

To prepare the Pages printed by printer report, the printing company:

  • Creates a worksheet named Pages printed by printer.
  • Populates the worksheet with the values of the Job.PreviousPrinter and Job.PagesStacked properties.
  • Renames Job.PreviousPrinter to Printer and Job.PagesStacked to Pages.
  • Chooses a pie chart to visualize the data.

When the printing company finishes preparing the report, they save the worksheet as a Tableau workbook (TWB) file.

To set up the Jobs printed by customer report, the printing company:

  • Creates a worksheet named Jobs printed by customer.
  • Populates the worksheet with the values of the Job.ID and Job.CustomerName properties.
  • Renames Job.ID to Job and Job.CustomerName to Customer.
  • Chooses a bar chart to visualize the data.

When the printing company finishes preparing the report, they save the worksheet as a Tableau workbook (TWB) file.

The printing company creates a reporting dashboard with the two reports and saves the dashboard as a Tableau workbook (TWB) file. The workbook is then published to a server that company management can access to display the dashboard.

1.2.1.2.20.8 RICOH Supervisor Connect

The RICOH Supervisor Connect feature lets you send data collected by the Reports feature in the PostgreSQL database to the RICOH Supervisor application in the cloud.

Then, you can use RICOH Supervisor to build dashboards that present the historical data visually.

Prerequisites

Before you can send data to RICOH Supervisor, you must:

  • Install the Reports feature. This feature is available in the Feature Manager and does not require a license.
  • Set up the PostgreSQL database to start collecting the information.
  • Enable data collectors to store the appropriate property values.
  • Add the WritePropsToReportsDatabase step template to any workflows that need to collect job and document properties as jobs process through them.
  • Request access to RICOH Account Administration, so you can configure a secure connection with Ricoh cloud applications.

System objects:

This feature adds these object types:

Ricoh cloud credential
The RICOH Supervisor Connect feature adds the Ricoh cloud credential type. This type of credential is used to create a secure connection with Ricoh cloud applications.
RICOH Supervisor Data Transmitter
RICOH ProcessDirector uses a special type of data transmitter, the RICOH Supervisor Data Transmitter. Based on the settings made in the RICOH Supervisor Data Transmitter, you can specify what data should be sent and when to send it.

Connecting and sending data

To connect and send data to RICOH Supervisor, RICOH ProcessDirector uses a Ricoh cloud credential and the RICOH Supervisor data transmitter. The data that you send to RICOH Supervisor is stored in the PostgreSQL database by the RICOH ProcessDirector data collectors. The data transmitter can send job, printer, device, or user property values captured by the data collectors based on a schedule you set.

Most RICOH ProcessDirector features add job properties that can be captured for reporting purposes, such as SLA outcome from the Deadline Tracker feature.

You can also send the job and document properties collected by the WritePropsToReportsDatabase step in workflows. The tables that are specified within the step can be selected to be sent with the RICOH Supervisor data transmitter.

RICOH Supervisor can display properties captured by the RICOH ProcessDirector data collectors using different widgets. The RICOH ProcessDirector Connect Add-on includes a default RICOH ProcessDirector dashboard. The default RICOH ProcessDirector dashboard contains these default widgets:

Total Print Volume
Shows the total printed number of sheets and pages daily.
Volume by Printer
Shows the total printed number of sheets and pages for each printer.
Volume by Customer
Shows the total number of sheets and pages printed for each customer. This uses the Customer name job property which is set in the workflow for each job.
Volume by Location
Shows the total number of sheets and pages printed at each location. This uses the Requested location job property which is set in the workflow for each job.
Volume by Printer Operator
Shows the total number of sheets and pages scheduled for printing by each user.
Volume by Inserter Operator
Shows the total number of sheets and pages reconciled by each user. Only available for jobs that have a Reconcile step in their workflows. The Reconcile step is provided with the Inserter, Automated Verification, PDF Document Support, and AFP Support features.
SLA Outcome by customer
Shows how many jobs completed their Service Level Agreement (SLA) target step before the SLA deadline.

To customize your RICOH ProcessDirector dashboard, duplicate the default RICOH ProcessDirector dashboard, then edit the existing widgets or add more widgets from the widgets library. For example, you can customize the Total Print Volume widget to show the number of documents instead of pages or sheets. You can search for different values you want to display in the widget, then you can switch them on or off depending on the data you want to see. You can share a duplicated dashboard with other users to view your collection of widgets.

For more information about setting up a RICOH Supervisor dashboard and widgets, see the Working with Dashboards topic in the RICOH Supervisor help system.

RICOH Supervisor Connect does not provide access to RICOH Supervisor. You must purchase a RICOH Supervisor subscription and the RICOH ProcessDirector Connect add-on separately. If you want to purchase additional viewer subscriptions for other company employees, contact a Ricoh representative.

To create your own widgets in RICOH Supervisor, you must purchase the self-service add-on for each user and you must log in as a self-service user. To purchase the self-service add-on, contact a Ricoh representative.

1.2.1.2.20.9 Avanti Slingshot Connect

The Avanti Slingshot Connect feature lets you exchange information with the Avanti Slingshot Management Information System (MIS) software. After creating orders, Avanti Slingshot can send PDF print jobs with JDF job tickets to RICOH ProcessDirector. Alternatively, RICOH ProcessDirector can send Avanti Slingshot the information required to create orders for jobs in RICOH ProcessDirector workflows.

After RICOH ProcessDirector receives jobs from Avanti Slingshot or sends order information to Avanti Slingshot, the feature automates the reporting of job processing time to Avanti Slingshot cost centers. When a job finishes printing, the feature reports this information:

  • The amount of time the job spent on the printer.
  • The total pages or sheets printed on specific media by name and by product ID when that property is defined.
  • Whether the job was printed with CMYK ink or toner or only with black ink or toner.

RICOH ProcessDirector and Avanti Slingshot exchange information over an HTTP connection.

To configure your Avanti Slingshot system so that it sends jobs to RICOH ProcessDirector or receives order information from RICOH ProcessDirector, contact your Avanti support representative.

If Avanti Slingshot sends PDF files with JDF job tickets, RICOH ProcessDirector receives them in a hot folder input device that uses the JDF Batching method. The hot folder has the same name as the line item on the sales order. RICOH ProcessDirector acknowledges receipt of each job and reports status to Avanti Slingshot as the jobs move through the workflow.

If Avanti Slingshot receives order information from RICOH ProcessDirector, Avanti Slingshot acknowledges receipt of the information for each job. RICOH ProcessDirector reports status to Avanti Slingshot as the jobs move through the workflow.

Avanti Slingshot Connect does not provide the Avanti Slingshot software. You must purchase and install Avanti Slingshot with the JDF Integration add-on.

Collecting ink usage data

When you define a Ricoh continuous forms printer as a Ricoh TotalFlow Printer, you can specify the ink and protector coat that is loaded using the ink names set in Avanti Slingshot.

Every time RICOH ProcessDirector sends a job to the defined Ricoh TotalFlow printer, the printer tracks the amount of each type of ink or protector coat that is used. The collected ink amount is sent back to RICOH ProcessDirector when the job finishes printing or is canceled.

If any part of the job is reprinted, the ink used for the reprints is reported to RICOH ProcessDirector as well. RICOH ProcessDirector stores the total volume of ink used for each job in the cumulative ink usage properties.

The job information sent to Avanti Slingshot from RICOH ProcessDirector includes the values of the cumulative ink properties and the ink names. Thus, you can determine the amount of a certain ink the job used.

Step template

Avanti Slingshot Connect provides the CreateOrderInSlingshot step template. A step based on this step template lets you call an Avanti Slingshot web service that creates an order for a job received from RICOH ProcessDirector.

Note: The feature also includes these templates: CallRESTService and CallSOAPService. They are not required to communicate with Avanti Slingshot.

Properties and reporting

Avanti Slingshot Connect adds two properties to all steps in a workflow: Slingshot cost center and Slingshot milestone status. You can associate one or more steps with a single cost center to identify all the time spent on processing by the cost center.

You define the Avanti Slingshot cost centers used by RICOH ProcessDirector in an avanti.cfg control file.

RICOH ProcessDirector reports the time when a job enters the first step associated with an Avanti Slingshot cost center. RICOH ProcessDirector also reports the time when a job completes the last step associated with the cost center.

Avanti Slingshot Connect adds these properties to the property notebook for each RICOH ProcessDirector printer:

  • Slingshot cost center

    RICOH ProcessDirector reports the time spent printing the job to this Avanti Slingshot cost center.

  • Job color to report

    RICOH ProcessDirector uses this property when it reports the total pages printed in a job. The property specifies whether all the pages in the job were printed with CMYK ink or toner or only with black ink or toner.

  • Print unit to report

    RICOH ProcessDirector reports the print volume to Avanti Slingshot in pages or sheets.

  • Cyan ink

    Specifies the cyan ink name defined in Avanti Slingshot.

  • Magenta ink

    Specifies the magenta ink name defined in Avanti Slingshot.

  • Yellow ink

    Specifies the yellow ink name defined in Avanti Slingshot.

  • Black ink

    Specifies the black ink name defined in Avanti Slingshot.

  • Protector coat

    Specifies the protector coat ink name defined in Avanti Slingshot.

  • MICR ink

    Specifies the MICR ink name defined in Avanti Slingshot.

  • Highlight ink

    Specifies the highlight ink name defined in Avanti Slingshot.

RICOH ProcessDirector automatically reports the total pages printed on specific media.

1.2.1.2.20.9.1 Usage scenario for receiving jobs from Avanti Slingshot

In this scenario, a print shop creates a sales order with two jobs in Avanti Slingshot and sends the jobs to RICOH ProcessDirector for processing. RICOH ProcessDirector sends Avanti Slingshot the time required for preflight operations and printing.

Before any Avanti Slingshot jobs are sent to RICOH ProcessDirector, an administrator at the print shop uses the Avanti Slingshot Connect feature to configure RICOH ProcessDirector.

The administrator sets up hot folder input devices to receive jobs from Avanti Slingshot and submit them to RICOH ProcessDirector workflows. The names of the two hot folders in this scenario are Statements and Mailer Inserts. They use the JDF Batching method.

The administrator modifies the RICOH ProcessDirector workflows to send information back to Avanti Slingshot. The names of the two workflows in this scenario are PDF and Insert. The PDF workflow prints jobs on regular paper and does not impose them. The workflow receives jobs from the Statements hot folder. The Insert workflow prints jobs on special coated paper and imposes eight pages on each side of each sheet. The workflow receives jobs from the Mailer Inserts hot folder.

To send external preflight information from each workflow to Avanti Slingshot, the administrator:

  • Assigns the Preflight cost center to the RunExternalProgam and CreatePageRanges steps.

  • Gives the RunExternalProgam step a Slingshot milestone status value of In progress. The first time that RICOH ProcessDirector sees this value for the Preflight cost center, it sends Avanti Slingshot the time that the step receives a job.

  • Gives the CreatePageRanges step a Slingshot milestone status value of Complete. The first time that RICOH ProcessDirector sees this value for the Preflight cost center, it sends Avanti Slingshot the time when the job moves to the next step.

The administrator assigns an Avanti Slingshot cost center to each RICOH ProcessDirector printer that prints jobs received from Avanti Slingshot. The printer in this scenario is the Ricoh Pro C901. The administrator assigns it the Ricoh Pro C901 cost center.

The administrator sets the Print unit to report value for the Ricoh Pro C901 printer to Pages.

After the administrator has configured RICOH ProcessDirector, the print shop receives a new order to print 100,000 statements with advertising inserts.

The accounting staff creates a sales order in Avanti Slingshot with two line items:

  • Statements

  • Mailer Inserts

The print shop supervisor:

  • Makes sure that the Ricoh Pro C901 printer is specified on the section associated with each line item.

  • Uploads a PDF file for the statements to the Statements line item.

  • Uploads a PDF file for the inserts to the Mailer Inserts line item.

To create Avanti Slingshot jobs, the print shop supervisor releases the sales order with its two line items to production.

To print the jobs, the supervisor exports each job to RICOH ProcessDirector.

Avanti Slingshot sends the statements job to the Statements hot folder. The hot folder submits the job to the PDF workflow.

Avanti Slingshot sends the inserts job to the Mailer Inserts hot folder. The hot folder submits the job to the Insert workflow.

As each job moves through its workflow, RICOH ProcessDirector sends Avanti Slingshot the processing time required to do external preflight operations and to print the job.

When each job finishes printing, the RICOH ProcessDirector sends Avanti Slingshot this information:

  • The amount of time the job spent on the printer.
  • The total pages printed on specific media.
  • Whether the job was printed with CMYK ink or toner or only with black ink or toner.

Using this information, Avanti Slingshot computes the costs of preflight operations and printing for each job.

1.2.1.2.20.10 Deadline Tracker

The Deadline Tracker feature lets you manage your progress toward meeting your delivery deadlines. By using deadlines and Service Level Agreement (SLA) job checkpoints, you can make sure that your print jobs are on schedule to be completed on time. You can see when jobs are behind schedule or might miss their deadlines. This information helps operators prioritize work and take actions to bring jobs back on track for on-time delivery.

The feature has these major parts:

  • Three system objects
  • A step template

With this feature, you can track jobs to a deadline, to a schedule, to both a schedule and a deadline, or to a checkpoint. You can track jobs based on completion of a phase in the workflow or a step in a phase. You can also be notified when work does not arrive in the RICOH ProcessDirector system as expected.

The Deadline Tracker feature adds a Deadlines portlet to the Main page. The portlet contains dots that show the number of jobs that have missed or are close to missing a deadline or checkpoint.

When you hover over a dot, you see a legend that lists the statuses represented by the dot. Click View all jobs in this state to open a table of all the jobs in that state.

If no jobs are late, the Deadlines portlet shows a green checkmark.

The feature adds the Schedule risk column to the right of the column of check boxes in the Jobs table. The column heading is blank. You can see the name of the column by hovering over the heading area. When a job is behind schedule or might miss its deadline, a colored dot appears in the Schedule risk column. To sort jobs by schedule risk, with jobs that have the most risk at the top of the column, you can click the column heading.

The Jobs table sorted by schedule risk

System Objects

This feature adds these system objects:

Service policies
Service policies define job checkpoints at the end of each processing phase. For example, a service policy defines job checkpoints for jobs that need to be printed 4 hours after they arrive in the system. The administrator creates one service policy for each performance commitment and associates each service policy with the appropriate workflows.
No-service periods
No-service periods define the periods of time when no services are provided (for example, holidays and weekends). The administrator creates no-service periods and indicates in each service policy whether the no-service periods apply to that policy.
Expected work
Expected work objects define print jobs that you expect to receive at set intervals.

Step Template

This feature adds the SetDeadline step template to the list of supplied step templates. When you add the step template to a workflow, you specify a Deadline step and set a deadline date and time. Each job in the workflow must complete the step by the specified date and time to meet its deadline. If a job misses its deadline, a red dot appears in the Deadlines portlet and in the Schedule risk column for the job in the Jobs table.

Tracking to a deadline

You can set job deadlines so you can see whether a job meets or misses its deadline.

When you set a deadline for completing a step in a workflow, the Deadline tab on the job properties notebook shows you values for the Deadline, Deadline step, and Deadline outcome properties. You can add these properties as columns on the Jobs table to make deadline information available to your operators.

You can set up an email notification that watches for the Deadline outcome property for a job to change to Missed and sends an email to one or more users to alert them of the missed deadline.

Tracking to a schedule

You can set estimated durations for steps in a workflow so you can track the progress of jobs as they move through the system and see when jobs are behind schedule.

This feature adds the Estimated durations action to the Workflow Editor portlet. Using this action, you can quickly set the estimated duration for all the steps in a workflow.

When you set estimated durations for the steps in a workflow, the Deadline tab on the job properties notebook shows you values for these properties:

  • Percent complete: how much of the estimated duration for the job has completed.
  • Tracking status: whether the job is on schedule or behind schedule.
  • Predicted completion time: a date and time computed by adding up the estimated durations of all steps in the predicted path of the job through the workflow.

You can add these properties as columns on the Jobs table to make information about whether a job is on schedule or behind schedule available to your operators. If a job is behind schedule, a yellow dot appears in the Deadlines portlet and in the Schedule risk column for the job in the Jobs table.

For a job in a conditional workflow, RICOH ProcessDirector uses only the estimated durations for the steps on the branch of the workflow that the job is likely to follow.

You can set up an email notification that watches for the Tracking status property for a job to change to Behind schedule and sends an email to one or more users to alert them that a job is in danger of missing its schedule.

Tracking to a schedule and a deadline

You can set job deadlines and estimated durations so you can track the progress of jobs as they move through the system and you can see when a job has missed, or is in danger of missing, its deadline.

When you set both a deadline for completing a step and estimated durations for the steps in a workflow, the Deadline tab on the job properties notebook shows you values for all the properties for tracking to a deadline and tracking to a schedule. The notebook also shows you a value for an additional property: Predicted outcome. The three predicted outcomes are OK, May miss, and Cannot determine.

RICOH ProcessDirector calculates the predicted outcome for a job by using the estimated durations, the current date and time, and the deadline for the job. When a predicted outcome is May miss, an orange dot appears in the Deadlines portlet and in the Schedule risk column for the job in the Jobs table. After the deadline step runs and the deadline outcome is set, RICOH ProcessDirector does not change the predicted outcome.

You can set up an email notification that watches for the Predicted outcome property for a job to change to May miss and sends an email to one or more users to alert them that a job is in danger of missing its deadline.

Tracking to checkpoints

You can set job checkpoints to track the progress of jobs as they move through the phases in a workflow. Instead of setting estimated durations for each step, you set an amount of time for each phase to complete. If the phase does not complete in the allocated time, the job is late. A yellow dot appears in the Deadlines portlet and in the Schedule risk column for the job in the Jobs table. However, if the job moves through the next phase more rapidly than expected and finishes before the next checkpoint, the checkpoint status of the job changes from Late to OK. The yellow dot is removed.

Monitoring for expected jobs

You can configure RICOH ProcessDirector to let you know if the scheduled number of jobs do not arrive in an input device by the time that you expected them. If some of the expected work does not arrive in an input device, an alert (Alert icon) icon appears to the right of the input device. The operator can then respond by tracking down the missing jobs.

1.2.1.2.20.10.1 Usage scenarios for Deadline Tracker

These scenarios show how to set deadlines, estimated durations, or both for a Deadline Tracker workflow.

1.2.1.2.20.10.1.1 Time of day deadline in a workflow scenario

In this scenario, all of the jobs in a linear PDF workflow must be printed by 5:00 pm on the day after they are received.

You place one SetDeadline step in the workflow. You specify PrintJobs as the value of the Deadline step property. You specify Tomorrow as the value of the Deadline date property. You specify 5:00 PM as the value of the Deadline time property.

Linear PDF workflow
  • SetJobPropsFromTextFile
  • DetectInputDataStream
  • CountPages
  • SetDeadline: makes PrintJobs the deadline step; sets tomorrow at 5:00 pm for the deadline time
  • PrintSetup: lets the operator verify that the requested paper is loaded in the trays
  • CreatePageRanges
  • PrintJobs
  • RetainCompletedJobs
  • RemoveJobs

With this workflow, you can see whether a job meets or misses its 5:00 pm deadline. If a job misses its deadline, RICOH ProcessDirector adds a red dot to the Schedule risk column for the job in the Jobs table.

A new customer asks if you can turn around jobs that arrive before noon on the same day, with later jobs finishing the next day. To accomplish this, you can use time of day deadlines in a conditional workflow. For example, you have a workflow with two branches.

  • The connector to the first step in branch A has a rule with two conditions:
    • Current day = Today
    • Current time < 12:00 PM

      You specify that All of the conditions apply.

    When these conditions are met, the job is sent down branch A. The SetDeadline step sets the value of the Deadline time to Today at 5:00 PM.
  • The connector to the first step in branch B has a rule with two conditions:
    • Current day = Today
    • Current time => 12:00 PM

      You specify that All of the conditions apply.

    When these conditions are met, the job is sent down branch B. The SetDeadline step sets the value of the Deadline time to Tomorrow at 5:00 PM.

1.2.1.2.20.10.1.2 Two deadlines in a linear workflow scenario

In this scenario, a linear PDF workflow sends each job through an external program for the accounting department and then prints the job. You want to set one deadline for the external program and another deadline for printing the job. You place two SetDeadline steps in the workflow. The first SetDeadline step tracks the time required to complete the RunExternalProgram step. The second SetDeadline step tracks the time to print each job after it completes the RunExternalProgram step.
Linear PDF workflow
  • SetJobPropsFromTextFile
  • DetectInputDataStream
  • CountPages
  • SetDeadline: makes RunExternalProgram the deadline step; sets 30 minutes for the deadline time (Deadline date = Relative to property value; Property = Current time; Plus or minus = 30 minutes).
  • RunExternalProgram: runs a program for the accounting department.
  • SetDeadline: makes PrintJobs the deadline step; sets 15 minutes for the deadline time (Deadline date = Relative to property value; Property = Current time; Plus or minus = 15 minutes).
  • PrintSetup: lets the operator verify that the requested paper is loaded in the trays.
  • CreatePageRanges
  • PrintJobs
  • RetainCompletedJobs
  • RemoveJobs

With this workflow, you can see whether a job meets or misses each of its deadlines. If a job misses its first deadline, RICOH ProcessDirector adds a red dot to the Deadlines portlet and to the Schedule risk column for the job in the Jobs table. If the job then meets its second deadline, the red dot is removed.

1.2.1.2.20.10.1.3 Three deadlines in a conditional workflow scenario

In this scenario, a conditional workflow has separate processing paths for PDF jobs, AFP jobs, and other jobs (PostScript and PCL). PDF jobs go through a time-consuming preflight step performed with the PitStop Connect Feature. AFP jobs go through a time-consuming accounting step that runs an external program. Other jobs do not go through the time-consuming preflight or accounting steps. You want to set a different deadline for each path: two hours for PDF jobs, 90 minutes for AFP jobs, and 30 minutes for other jobs. You place a SetDeadline step at the start of each path.
Conditional workflow: shared steps
  • SetJobPropsFromTextFile
  • DetectInputDataStream
Path for PDF jobs
  • SetDeadline: makes PrintJobs the deadline step; sets two hours for the deadline time (Deadline date = Relative to property value; Property = Time submitted; Plus or minus = 2 hours).
  • Preflight (step based on RunPitStopOnJob step template)
  • CountPages
  • PrintSetup (step based on AssignJobValues step template): assigns print properties to PDF jobs.
  • CreatePageRanges
Path for AFP jobs
  • SetDeadline: makes PrintJobs the deadline step; sets 90 minutes for the deadline time (Deadline date = Relative to property value; Property = Time submitted; Plus or minus = 90 minutes).
  • CountPages
  • Accounting (step based on RunExternalProgram step template): runs a program for the accounting department.
  • PrintSetup (step based on AssignJobValues step template): assigns print properties to AFP jobs.
  • CreatePageRanges
Path for other jobs
  • SetDeadline: makes PrintJobs the deadline step; sets 30 minutes for the deadline time (Deadline date = Relative to property value; Property = Time submitted; Plus or minus = 30 minutes).
  • PrintSetup (step based on AssignJobValues step template): assigns print properties to other jobs.
Shared steps
  • PrintJobs
  • RetainCompletedJobs
  • RemoveJobs

With this workflow, you can see whether a job meets or misses its deadline to complete printing. If a job misses its deadline, RICOH ProcessDirector adds a red dot to the Schedule risk column for the job in the Jobs table. Red dots are added for each type of job after print completion deadlines of different lengths are missed. Red dots are added for PDF jobs after two hours. Red dots are added for AFP jobs after 90 minutes. Red dots are added for other jobs after 30 minutes.

1.2.1.2.20.10.1.4 Estimated durations for steps in a linear workflow scenario

In this scenario, a linear workflow has nine steps. You want to track whether a job is on time or behind schedule from the time that the job enters the workflow until it completes the PrintJobs step. The first two steps process a job immediately. Four steps each take five minutes to process a job. One step takes ten minutes to process a job. You set estimated durations for those seven steps. You do not set estimated durations for the two steps that follow the PrintJobs step.
Linear PDF workflow
  • SetJobPropsFromTextFile: 1 second
  • DetectInputDataStream: 1 second
  • CountPages: 5 minutes
  • RunExternalProgram (runs a program for the accounting department): 5 minutes
  • PrintSetup (lets the operator verify that the requested paper is loaded in the trays): 5 minutes
  • CreatePageRanges: 5 minutes
  • PrintJobs: 10 minutes
  • RetainCompletedJobs: no estimated duration
  • RemoveJobs: no estimated duration

With this workflow, you can see the percent complete, the tracking status (On schedule or Behind schedule), and the predicted completion time.

When a job completes the PrintSetup step, the job is 50 percent complete because three five-minute steps have run of the 30-minute total. Based on the two remaining steps with estimated durations, RICOH ProcessDirector sets the Predicted completion time property to 15 minutes from the time when the job completes the PrintSetup step.

If the job completes the CountPages step within five minutes and two seconds after starting the SetJobPropsFromTextFile step, the Tracking status of the job is On schedule. If the job completes the RunExternalProgram step within ten minutes and two seconds after starting the SetJobPropsFromTextFile step, the Tracking status of the job continues to be On schedule.

If the job does not complete the PrintSetup step within 15 minutes and two seconds of starting the SetJobPropsFromTextFile step, RICOH ProcessDirector sets the Tracking status of the job to Behind schedule. If the Tracking status of a job is Behind schedule, RICOH ProcessDirector adds a yellow dot in the Deadlines portlet and in the Schedule risk column for the job in the Jobs table.

1.2.1.2.20.10.1.5 Deadlines and estimated durations in a linear workflow scenario

In this scenario, a linear workflow has 10 steps. You want to track whether a job is on time or behind schedule from the time that the job enters the workflow until it completes the PrintJobs step. The first three steps process a job immediately. Four steps each take 5 minutes to process a job. One step takes 10 minutes to process a job. You set estimated durations for those eight steps. You do not set estimated durations for the two steps that follow the PrintJobs step. You also want to know if a job does not meet its printing deadline. You place a SetDeadline step near the start of the workflow.
Linear PDF workflow
  • SetJobPropsFromTextFile: 1 second.
  • DetectInputDataStream: 1 second.
  • SetDeadline: makes PrintJobs the deadline step; sets the deadline time to 35 minutes from the time that the job was submitted (Deadline date = Relative to property value; Property = Time submitted; Plus or minus = 35 minutes); 1 second.
  • CountPages: 5 minutes.
  • RunExternalProgram: runs a program for the accounting department; 5 minutes.
  • PrintSetup (lets the operator verify that the requested paper is loaded in the trays): 5 minutes.
  • CreatePageRanges: 5 minutes.
  • PrintJobs: 10 minutes.
  • RetainCompletedJobs: no estimated duration.
  • RemoveJobs: no estimated duration.

With this workflow, you can see the deadline date and time, the deadline step, the deadline outcome, the percent complete, the tracking status (On schedule or Behind schedule), the predicted completion time, and the predicted outcome.

When a job completes the PrintSetup step, the job is 50 percent complete because 3 steps with durations of 5 minutes have run of the 30-minute total. Based on the two remaining steps with estimated durations, RICOH ProcessDirector sets the Predicted completion time property to 15 minutes from the time when the job completes the PrintSetup step.

If the job completes the CountPages step within 5 minutes and 3 seconds after starting the SetJobPropsFromTextFile step, the Tracking status of the job is On schedule. If the job completes the RunExternalProgram step within 10 minutes and 3 seconds after starting the SetJobPropsFromTextFile step, the Tracking status of the job remains On schedule. If the job does not complete the PrintSetup step within 15 minutes and 3 seconds of starting the SetJobPropsFromTextFile step, RICOH ProcessDirector sets the Tracking status of the job to Behind schedule. If the Tracking status of a job is Behind schedule, the row for the job in the Jobs table is colored yellow.

RICOH ProcessDirector calculates the predicted outcome for a job by using the estimated durations, the current date and time, and the deadline for the job. When a predicted outcome is May miss, RICOH ProcessDirector adds an orange dot to the Schedule risk column for the job in the Jobs table.

If the job has not started the PrintJobs step 26 minutes after the job was submitted to the workflow, RICOH ProcessDirector sets the predicted outcome to May miss. The predicted outcome changes because the deadline is for 35 minutes and the estimated duration of the PrintJobs step is 10 minutes. RICOH ProcessDirector estimates that the duration of the job is going to be 36 minutes.

If a job misses its deadline, RICOH ProcessDirector adds a red dot to the Deadlines portlet and to the Schedule risk column for the job in the Jobs table.

1.2.1.2.20.10.1.6 Adjusting Service Level Agreements for weekends and holidays

When you negotiate your Service Level Agreements (SLAs), you use No-service periods for days you are closed, such as weekends and holidays. The days that you are closed are not considered when calculating SLA deadlines.

To accommodate holidays, the administrator creates a No-service period. RICOH ProcessDirector accounts for the No-service period when it calculates the SLA deadline and uses the correct deadline to track the status of the job against the SLA. No-service periods can only be used when tracking to a checkpoint. You cannot use No-service periods with the SetDeadline step or when tracking to a schedule.

For example:

  • A customer has a 72-hour SLA, and submits a job at 1:00 PM Friday. Because you are closed Saturday and Sunday, the 72-hour SLA deadline is 1:00 PM Wednesday.
  • A customer has a 24-hour SLA, and submits the job at 4:30 PM on December 31. You are closed on January 1 for the New Year's holiday, so the SLA deadline is 4:30 PM on January 2.

To add a No-service period for the New Year's holiday, the administrator:

  • Navigates to the Objects section of the Administration tab and selects No-service period.
  • Adds a new No-service period.
  • Names the No-service period by typing New Years Day Holiday in the No-service period name field.
  • Adds a description of the holiday in the Description field.
  • Selects the day of the holiday in the Day field and month of the holiday in the Month field by setting Day to 1 and Month to 1 for January.
  • Sets the year of the holiday or leaves the Year field empty so that it repeats every year. In this scenario, the holiday repeats every year, so the Year field is left blank.
      Note:
    • If the No-service period changes from year to year, you must specify a year and make a separate No-service period for each year.
  • Sets the Start time of the holiday. In this scenario, the start time is set to 12:00 AM.
  • Sets the End time of the holiday. In this scenario, the end time is set to 11:59 PM.

Once set, this No-service period repeats every year for the New Year’s Day holiday. RICOH ProcessDirector calculates the job processing schedule for when the business is closed. When the business opens on January 2, printing resumes with the SLA checkpoints adjusted to accommodate the holiday.

1.2.1.2.20.10.1.7 Setting up to monitor for expected work

When you have recurring jobs, you can use the expected work function to check that the jobs have arrived on time at the correct input device.

To monitor for expected work, the administrator creates an Expected work object and then associates the object with one or more input devices.

For example, you have a customer who sends you three jobs on the first day of every month. Their SLA states that if the jobs arrive by 8:00 AM on the first day of the month, they must be printed by 4:00 PM. You create an expected work object that instructs an input device to check the status at 8:00 AM on the first day of the month. Then you associate the expected work object with the appropriate input device. At 8:00 AM on the first day of the month, the input device checks to see how many jobs have arrived:

  • If all three jobs have arrived, processing continues as usual.
  • If one or more of the jobs has not arrived, the Expected work status property of the input device is set to Late. An alert (Alert icon) icon appears to the right of the input device.

To define an expected work object that represents three print jobs that arrive by 8:00 AM on the first day of every month, the administrator:

  • Navigates to the Objects section of the Administration tab and selects Expected work.
  • Adds an Expected work object.
  • Names the expected work object by typing Monthly Statements in the Expected work name field.
  • Adds a description of the object in the Description field.
  • Adds a Start date and time to specify the date and time when the input device begins monitoring for the jobs. The time is set to 8:00 AM.
  • Specifies that three jobs are expected by typing 3 in the Number of jobs expected field. Optionally specifies a File pattern that the input device uses to identify which input files to count, such as .*pdf$ for PDF files.
  • Indicates that the jobs arrive on the first day of every month by specifying the Day in the Expected work interval field and First day of every month for the Frequency field.
  • Edits the properties of one or more input devices to monitor to specify Monthly Statement as the value for the Associated expected work property.

After the expected work start date and time, the input device monitors for the three jobs on the first day of every month. If the three jobs do not arrive as expected, an alert (Alert icon) icon appears to the right of the input device.

    Note:
  • You can set up a notification object to send an email when expected work for an input device is late.
  • If you have the Web Service Enablement feature, you can set up a notification object to issue a SOAP or REST web service call when expected work for an input device is late.

1.2.1.2.20.11 MarcomCentral Connect

The MarcomCentral Connect feature illustrates how you can integrate the online-storefront and web-to-print functions of MarcomCentral® into your production workflows. A SOAP web service input device retrieves orders for print, digital, and other items from MarcomCentral. RICOH ProcessDirector creates a job for each order and a child job for each item in the order. RICOH ProcessDirector downloads files for print items and notifies MarcomCentral to close out the order when all the items complete their processing.
A working simulation with sample objects and workflows

The MarcomCentral Connect feature includes a complete simulation that demonstrates how to exchange information using calls to MarcomCentral web services. The web services connect RICOH ProcessDirector objects and workflows to a sample store at the MarcomCentral web site. The sample store serves as a test environment for the RICOH ProcessDirector web services interface to MarcomCentral.

The simulation has these objects and workflows:

  • The MarcomReceiveOrders sample SOAP web service input device simulates a call to the MarcomCentral web service that returns orders by date. The input device retrieves sample orders, turns them into jobs, and assigns them to the MarcomProcessOrders workflow.

  • The MarcomProcessOrders sample workflow processes MarcomCentral orders. It converts MarcomCentral order information into RICOH ProcessDirector job properties. The workflow retrieves the job ticket for each item in the order and creates a child job for each job ticket. The workflow submits the child jobs to the MarcomProcessJobTicket workflow.

  • The MarcomProcessJobTicket sample workflow processes MarcomCentral job tickets. It converts job ticket information into RICOH ProcessDirector job properties. The workflow uses MarcomCentral stock-keeping unit (SKU) IDs to get information about how to process the items in each order. The workflow sends each printable item through a branch that downloads a file and prints it. The workflow sends each non-printable item through a branch that holds the job until the warehouse confirms that the item has been added to the order.

  • When all items in the order have completed processing, the MarcomCloseoutOrders sample SOAP web service notification simulates a call to the web service that closes the order. If the notification actually called the web service, the web service would close the order in the sample store. The status of each item in the order in the sample store would change to Shipped.

This illustration shows how the RICOH ProcessDirector input device, workflows, and notification call MarcomCentral web services to exchange information with a MarcomCentral store.

This illustration shows an input device, workflows, and a notification calling web services to exchange information with a MarcomCentral store.

The following illustration highlights three steps in the MarcomProcessOrders workflow:

  • ApplyXSLTransform

    This step converts information in MarcomCentral format to RICOH ProcessDirector job properties.

  • CallSOAPService

    This step calls the MarcomCentral Job Tickets web service and retrieves the job tickets for each order.

  • CreateJobsFromXML

    This step uses the information returned by the MarcomCentral web service to create a job for each job ticket. The step submits the jobs to the MarcomProcessJobTicket workflow.

This illustration highlights three steps in the MarcomProcessOrders workflow.

The third illustration highlights six steps (one step is actually a set of steps) in the MarcomProcessJobTicket workflow. The workflow includes two ApplyXSLTransform steps, a CallSOAPService step, and a DownloadFile step. The step DownloadFile uses a URL provided with the job ticket information to download a print file. The workflow also includes a set of steps for printing files and a step for processing non-print items.

This Illustration highlights six steps in the MarcomProcessJobTicket workflow.

After you run the simulation and examine how it works, you can modify the samples and connect them to your store at the MarcomCentral web site. For example, you can add steps to access an external data source with the information required to process items ordered at your store. You can replace the printing steps in the MarcomProcessJobTicket workflow with the steps in your production workflow or send child jobs to multiple production workflows. You can add notifications to send additional information to MarcomCentral. For more information, see the related tasks.

Job properties and sample files for converting information

The MarcomCentral Connect feature includes job properties and sample XSLT style sheets:

  • The MarcomCentral order ID, MarcomCentral order number, MarcomCentral job ticket ID, and MarcomCentral product type job properties receive values converted from XML elements in MarcomCentral orders and job tickets.

  • Five XSLT style sheets show you how to convert XML elements into job properties for the order job and for each ticket job.

Prerequisites

The MarcomCentral Connect feature requires the Web Services Enablement feature.

1.2.1.2.20.12 Quadient Inspire Connect

The Quadient Inspire Connect feature extends RICOH ProcessDirector to make it easier to interact with Quadient Inspire Designer v8 and higher. The feature adds system objects tailored to work with files created by Quadient Inspire Designer so they can be submitted to the processing engine to generate print jobs as part of a print workflow.

After you create an application in Quadient Inspire Designer, you can:

  • Submit raw, unprocessed formatting, configuration, and data files to a hot folder and send them to Quadient Inspire Designer to create an AFP job or PDF job as part of a workflow.

    If you want to generate AFP or PDF output as part of job processing, you can submit the WFD file and JOB file from Quadient Inspire Designer along with variable data files (in any format that Quadient Inspire Designer supports) to a hot folder that uses the List batching method.

  • Use Quadient Inspire Designer to modify an existing AFP or PDF file as part of a workflow.

    If you have an existing AFP or PDF application that you want to continue to use, you can submit a WFD file to a hot folder as a print job. RICOH ProcessDirector invokes Quadient Inspire Designer, which locates the existing AFP or PDF file and uses the information in the WFD file to recreate the AFP or PDF file.

When generating or modifying a file, the hot folder assigns the job to a workflow that contains a step based on the ComposeAFP or ComposePDF step template to send the files to Quadient Inspire Designer. The step waits until the AFP or PDF file is returned to continue processing.

New Step Templates

The feature adds step templates to send jobs to Quadient Inspire Designer.

  • ComposePDF

    A step based on this step template uses Quadient Inspire Designer to generate a new PDF file from a WFD file and one or more raw data files. The step waits for the new file to be returned.

  • ComposeAFP

    A step based on this step template uses Quadient Inspire Designer to generate a new AFP file from a WFD file and one or more raw data files. The step waits for the new file to be returned. ComposeAFP is only available when the Quadient Inspire Connect and AFP Support features are installed.

1.2.1.2.20.13 PitStop Connect

PitStop Connect lets you integrate preflight operations that use Enfocus PitStop Server 10 or higher into your workflows for PDF print jobs.

This feature adds the RunPitStopOnJob step template to the list of supplied step templates. When configured correctly, the step template submits a PDF print job to PitStop Server along with an action list or PDF profile. RICOH ProcessDirector waits for PitStop Server to process and return the job so it can move to the next step in the workflow.

The action list or PDF profile contains instructions for actions that PitStop Server does when it processes a job. For example, PitStop Server can:

  • Do color conversions
  • Change the fonts used
  • Remove objects from print jobs
  • Detect blank pages
RICOH ProcessDirector provides a sample action list for use with job that are sent to the InfoPrint 5000. This action list optimizes printed output for the InfoPrint 5000 while minimizing waste. You can use the supplied action list or create new ones with PitStop Professional and configure workflows to use the new action lists.

To work with RICOH ProcessDirector on a UNIX-based operating system, PitStop Server 10 or higher must be installed on a computer running Windows Server 2016 or Windows Server 2019 that is configured as a RICOH ProcessDirector Application server.

To work with RICOH ProcessDirector for Windows, PitStop Server 10 or higher must be installed on the primary computer.

1.2.1.2.20.14 Ultimate Impostrip® Connect

Ultimate Impostrip® Connect lets you integrate the impositioning functions of Ultimate Impostrip® into your workflows.

This feature adds the RunImpostripOnJob step template to the list of supplied step templates. When configured correctly, the step template submits a PDF print job to the Ultimate Impostrip® input hot folder that is set up to perform the appropriate impositioning functions on the job. RICOH ProcessDirector waits for the Ultimate Impostrip® server to return the updated job, then continues processing with the next step in the workflow.

To work with RICOH ProcessDirector, Ultimate Impostrip® Automation or Ultimate Impostrip® Scalable must be installed on:

  • A RICOH ProcessDirector Application server
  • A separate computer running Microsoft Windows Server 2016 or Microsoft Windows Server 2019

    Note:
  • If Ultimate Impostrip® is installed on a Windows computer running in a language other than English, do not install Ultimate Impostrip® in the default install directory. The program does not work properly with non-English default install paths. We recommend installing Ultimate Impostrip® in C:\ImpostripOnDemand on non-English Windows computers.

1.2.1.2.20.15 Cut Sheet support for Kodak feature

The Cut Sheet support for Kodak feature provides support for the Kodak Digimaster printer.

Kodak PDF printer devices represent printers that can print PDF or Postscript files. They print jobs in PDF or Postscript format, including jobs that have been converted to PDF or Postscript format. You cannot use some of the RICOH ProcessDirector actions (such as Jump to and Stop) with jobs that have been submitted to Kodak PDF printers. Kodak PDF printers support job and page-exception media, multiple copies, and punch and staple finishing options.

The Cut Sheet support for Kodak feature adds the ability to create Kodak PDF printer devices. This type of printer can accept PostScript or PDF files. If both formats of a file exist in the job's spool directory when the job is scheduled for printing, the file with the most recent time is sent to the printer. If a transform converts a PostScript file to PDF, the PDF format of the file is sent to the Kodak PDF printer.

1.2.1.2.20.16 Cut Sheet support for Xerox feature

The Cut Sheet support for Xerox feature provides support for specific models of Xerox printers.

Xerox® PDF printer devices represent printers that can print PDF files using XRX and XPIF (Xerox Printing Instruction Format) tickets. They print jobs in PDF format, including jobs that have been converted to PDF format. You cannot use some of the RICOH ProcessDirector actions (such as Jump to and Stop) with jobs that have been submitted to Xerox PDF printers. Xerox PDF printers support job- and page-exception media, multiple copies, and staple finishing options.

The Cut Sheet support for Xerox feature adds the ability to create Xerox PDF printer devices.

1.2.1.2.20.17 WPM Connect

WPM Connect lets you send AFP print jobs to WPM Web for additional processing.

This feature adds the SetWPMProperties step template to the list of supplied step templates. When added to a workflow, that step template lets you specify values that RICOH ProcessDirector uses to create a User Information Page (UIP) for WPM Web. WPM Web can use that UIP to process the print job.

The UIP is a type of banner page that is sent to WPM Web before the print job. The UIP is not printed like other banner pages. WPM Web automatically accepts and interprets the UIP and uses the information it contains to set WPM properties.

When you configure the SetWPMProperties step template, you must specify coded fonts that RICOH ProcessDirector should use to create the UIP for both double-byte and single-byte characters. Make sure that those coded fonts are added to the code page mapping file for banner pages before you try to send a job to WPM Web. The code page mapping file for banner pages is stored in: /aiw/aiw1/control_files/banner_pages/

Add lines to map your SBCS and DBCS coded fonts to the IBM-930 or IBM-939 code pages. For example, add lines like these:

X0H16N=IBM930
X0G32F=IBM930
X0H16U=IBM939
X0M32F=IBM939

Also make sure that the coded fonts are stored in a directory that RICOH ProcessDirector searches for resources. For example, you can add the directory to the AFP resource path property for the printer object.

After you create workflows that include steps based on the SetWPMProperties step template, you can define an AFP printer object that sends print jobs to the WPM AFP Emulator. When you set the value of the Create User Information Page property for an AFP printer to Yes, RICOH ProcessDirector creates the UIP and sends the UIP and the print job to WPM Web.

1.2.1.2.21 Extended features

RICOH ProcessDirector extended features are custom software components that you can purchase from your Ricoh support representative. The Ricoh support representative installs the extended features on the existing RICOH ProcessDirector primary computer.

1.2.1.3 RICOH ProcessDirector user interface

The RICOH ProcessDirector user interface is a Web browser-based interface that you can access from any Windows or Linux system that is connected to the network and has a supported browser installed.

To access the user interface, enter this URL in the address bar of a Web browser, replacing hostname with the hostname or IP address of the computer that the primary server runs on: http://hostname:15080/pd

Supported browsers are:

  • Most recent version of Mozilla Firefox
  • Most recent version of Google Chrome
  • Most recent version of Microsoft Edge based on Chromium

The RICOH ProcessDirector user interface consists of pages that let users do specific tasks. The Main page can be configured to show the portlets for the types of objects that you want to see and work with, such as jobs and printers. The Administration page can be used to manage all objects except print jobs.

Administrators also use the Workflow page to create and manage step templates and workflows.

    Note:
  • Always use the tabs to navigate in the user interface because using the browser's forward and back buttons can cause unexpected results.

The portlets on the Main page let you interact with system objects, such as jobs and printers. You can rearrange the portlets within an area, move them to other areas, or close the ones that you do not use often.

1.2.1.3.1 Comparing the legacy and updated user interfaces

The updated user interface provides a subset of the functionality that is available in the legacy user interface. This table compares the actions that you can do for various types of objects in each interface.
Device and object actions and information
Action Legacy user interface Updated user interface
Add, Copy, Delete printers, input devices, barcode readers, and inserter controllers Actions available on Administration page. Actions available on Administration page or Main page (if authorized)
Add a printer that uses the RICOH TotalFlow Print server Define as a Ricoh PDF printer. Set the value of the Type of printer property to Ricoh TotalFlow. Define as a Ricoh TotalFlow printer.
Any action that can only be done on one selected object at a time Error message appears if you try the action with multiple objects selected. Button or menu item for the action is disabled when multiple objects are selected.
Complete barcode step Dialog shows the number of documents that have been read. Dialog shows the number of documents that have not been read.
Editing input devices that are connected or enabled Warning message provides a link to disable and disconnect before you make changes. Disable and disconnect action available in More actions menu. If you try to save changes for an enabled or connected input device, a message appears. You can choose to disable and disconnect as part of saving the changes.
Enter large values in a text area on a property notebook Stretch the text area control to make it bigger. Type your text. The area automatically expands as you exceed the space displayed.
Find information in logs Default content displayed is messages (not errors, state changes, or property changes) stored in the last 24 hours, sorted oldest to newest. You can filter by type of log entry and by length of time. If you change the filter, you must click the Refresh button to update the contents. Columns cannot be changed or reordered. Default content displayed is all messages for the object, sorted newest to oldest. In addition to filtering by type of log entry and by length of time, you can use the string filter field Funnel icon. Entries that contain the search text in any column of the log are displayed. If you change a filter, the contents are updated automatically. To get new data, click Refresh from Server. Columns can be changed and reordered.
Import and Export objects Select each object you want to export from its object type table on the Administration tab. Use the Mark for Export function to build the export list. Then use the Export objects action to perform the export. Select the Export Objects action from the Administration page. Use the Add objects by type list to display lists of each object type and add them to the Export list. Use the Export action to perform the export.
Manage favorite printers and input devices Favorites are marked with yellow stars in Main page portlets. Favorites are marked with blue stars in Main page portlets. The same favorites are also marked on Administration pages.
Prohibit users from opening the property notebook and editing properties for an object Update the Group that the users belong to.

For each object type, find the View Properties and Edit properties actions and add them to the Prohibited actions list.

Update the Group that the users belong to.

Under Action permissions, select each object type, then find the View Properties action and clear the check box.

Under Property permissions, select each object type, then find the property that you do not want members of the group to edit. Clear the Edit check box.

Update Media action on printers Action available on the Administration and Main pages. Action available on the Administration and Main pages. The Update Media action was renamed Show Media and will display a list of printer media for printers that have the new Media to use property set to Printer.
Show Trays action on printers The Get tray information from printer check box determines if the Update media action can be used to change what media is set for each tray. The Get tray information from printer property is set on the SNMP tab of the printer property notebook and does not prevent using the Set tray media action. From the Show Trays dialog, you can use the Set tray media action to specify what media is in each try. You can also use the Tray media properties action to edit the properties of media objects.
View printer progress indicator Use the Icon view of the Printers portlet on the Main page. Use the Graphic view of the Printers portlet on the Main page.
Job actions
Action Legacy user interface Updated user interface
Change property values for multiple jobs at once Not available Select jobs, click the Update multiple action and select the properties and values you want to set on all the selected jobs.
Delete all Action available on Main page. Not available
View page level exceptions Use Page Exceptions tab on Job property notebook. Page exceptions for Sides (duplex) are not shown. Use Page exceptions action on action menu. Page exceptions for Sides (duplex) are shown.
Edit page level exceptions Use Page Exceptions tab on Job property notebook. Use Page exceptions action on action menu. Page exceptions for Sides (duplex) can be edited.
Filter jobs in the Jobs table Use the Filter entry field or Filter table function. Use links in the System Summary. Use the string filter field Funnel icon or the Advanced filter. That filter lets you set multiple property values as filters using AND, OR, or custom logic and save filters for easy reuse. Use links in the System Summary.
Groups actions Action available on Main page. Not available
Process again When selecting a restart step, the list of steps is shown from oldest to most recent. When selecting a restart step, the list of steps is shown from most recent to oldest.
User actions and Preference settings
Action Legacy user interface Updated user interface
Change automatic refresh interval Update on Preferences page. No longer needed. Tables on the Main page are updated in real time.
Change Time format setting Update on Preferences page. Setting is only applied to some properties. Open Preferences dialog from User menu () to update. Setting is applied to all properties. Updated user interface does not use the setting from the legacy user interface.
Change your password Action available on Preferences page. Action available in User menu ().
Locate the name of user who is logged in Displayed on right side of banner area. Displayed in the User menu ().
Save views of Main page Hover over the Main tab and select Save view. Hover over the Main tab until the menu appears, then choose a view from the Saved Views list.
Log out Click link on right side of banner area. Action available in User menu ().
System and interface actions
Action Legacy user interface Updated user interface
Prohibit some actions using Groups Actions related to exporting objects, and tuning step templates can be prohibited for groups of users. Group settings for exporting objects and tuning step templates are ignored.
Get details of license status Check system log. From Administration tab, use Licenses.
Locate the system identifier Displayed in red text on the Main tab. Displayed in white text with a blue highlight in the banner area.
Select all entries in a table Click inside the table then press Ctrl+A or drag mouse pointer across rows and columns. Function not available.
Use browser Find function (Ctrl+F) to locate a string in the user interface Ctrl+F highlights the string only on the dialog or page that currently has focus. Ctrl+F highlights the string on both the dialog and the page that is behind it in the browser.
View jobs that are at risk for missing or have already missed their delivery deadline or service level agreement (SLA). The rows for the jobs in the Jobs table are colored yellow, orange, red, or black. Yellow, orange, red, or black dots appear in the Schedule risk column for the jobs in the Jobs table. A Deadlines portlet shows a count of the jobs in each state that have a schedule risk.
Install features From Administration tab, use System Features. From Administration tab, use Utilities Features.
Install license key Click (information icon) in the right corner of the window and click About. Then click License. Click (information icon) in the right corner of the window and click About. Then click INSTALL LICENSES.
View the system log Click the View log button in the System Summary portlet. Action available in Settings menu () in the System Summary portlet.
Document actions
Action Legacy user interface Updated user interface
Search for documents using job properties or custom document properties When search results are displayed and you refresh the browser, the results remain. When search results are displayed and you refresh the browser, the results are cleared. Searches can be saved for easy reuse.
Archive actions
Action Legacy user interface Updated user interface
Saved searches To save a search, specify the search and click Save. The saved search includes the Repository to search and Number of results settings. To save a search, specify the search and click Save search. The saved search does not include the Repository to search and Number of results settings.
Using saved searches Searches saved with the updated user interface do not appear in the Saved searches list in the legacy user interface. Searches saved with the legacy user interface do not appear in the Search list in the updated user interface.
Deleting saved searches Not available Hover over a saved search in the Search list and click the X that appears at the right of the entry. When the X turns red, click it again to delete the saved search.
Step template and Workflow actions
Action Legacy user interface Updated user interface
Tune step templates From the Administration tab, select Step templates. From the Step templates table, select the step template you want to tune and click the Tune action. From the Workflow tab, select Step templates. From the Step templates table, click the step template you want to tune and use the Tuning tab on the step template property notebook.
Edit an enabled workflow You must disable the workflow before editing it. You can edit an enabled workflow. When you save the workflow, it is momentarily disabled then enabled again.
Save a workflow with unconnected steps, missing required values Not available You can save a workflow even if some steps are not connected or are missing values for properties that require a value. The errors are reported when you enable the workflow so you can save incomplete workflows as you continue to work on them.
Drag a workflow into a workflow Using the Workflow editor, you can drag a workflow from the Workflow Objects portlet into the workflow the same way you can drag a step template into the workflow. A new object called a step chain containing a set of connected steps can be added to a workflow. Using the Workflow editor, select Step chains from the top right of the window and a Step chain window opens. You can select a step chain from the window and drag it into the workflow.
Set expected durations for steps in workflow when Deadline Tracker feature is installed In Workflow Editor portlet, click Edit estimated durations icon, the Edit estimated durations icon. In the Workflow editor, right-click on the canvas and select Estimated durations from the menu.

1.2.1.3.2 Banner

The RICOH ProcessDirector user interface has a banner at the top, which is always available from any page or task panel in the interface.

The banner lets administrators, supervisors, and operators do these actions:

  • Switch between the available pages. For example, click the Main tab or the Administration tab at the left of the banner.
    Note: Always use the tabs to navigate in the user interface because using the browser's forward and back buttons can cause unexpected results.
  • See the main menu, hover over the Main tab until it appears.
  • See the RICOH ProcessDirector information center. Click the (information icon) button at the right of the banner and select Help.
  • See RICOH ProcessDirector version information. Click the (information icon) button at the right of the banner and select About.
  • See who is logged in using the current browser session. Click the User icon button at the right of the banner and find the user name at the top of the menu.
  • Log the current user out of the RICOH ProcessDirector system. Click the User icon button at the right of the banner and select Log out.
  • A location pin (Location pin icon) is displayed on the banner if one or more locations are hidden.

The banner area of the user interface

1.2.1.3.3 Main page

The Main page of the RICOH ProcessDirector user interface is separated into resizable areas which contain a variety of portlets, including: System Summary, Printers, Input Devices, and Jobs. This is the primary RICOH ProcessDirector interface for operators.

RICOH ProcessDirector offers standard portlets to display data about your jobs and devices.

You can create custom portlets to include important information about your jobs and devices in a meaningful structure. An administrator must use the Administration page to add the first custom portlet. After the first custom portlet is created, all users can add that portlet to their Main page. In addition, custom portlets can then be defined by clicking the Main tab and selecting Add custom portlet ().

    Note:
  • Always use the tabs to navigate in the user interface because using the browser's forward and back buttons can cause unexpected results.

The Main page of the user interface

The illustration above shows examples of these items:

  1. Banner

    The banner is on every page of the RICOH ProcessDirector user interface.

  2. Tabs

    To view a page, click its tab in the banner. This example shows the Main page.

  3. Portlets

    Each portlet is a modular pane that displays data about your jobs and devices. This example shows the Printers portlet. RICOH ProcessDirector provides a variety of portals that you can choose to include on your Main page. You can also create custom portlets to display information that is relevant to your operation.

You can drag portlets above or below existing portlets. You can also create additional columns of portlets by hovering over the left or right edge of the screen or between existing columns.

To resize a column or the portlets inside a column, hover on the bar between portlets. When you see the double arrow cursor (Double arrow cursor), hold the left mouse button and drag the cursor.

To open and close portlets, hover over the Main tab. A list of available portlets opens. You can select which portlets to display or hide. Portlets always open in the top left area of the page. After you open the portlet, you can click in its header area and drag it to another location on the page.

You can only add a limited number of portlets to the left-most column on the page. If you reach the limit, you must either delete portlets or move them to other columns on the page.

Use the portlets on this page to get a view of the entire shop floor.

  • To see what actions occur if you click the icons and text, hover the mouse pointer over them.
  • To do an action, select an object and click a button at the top of the portlet or right-click the object that you are interested in.

1.2.1.3.3.1 System Summary portlet

The System Summary portlet shows the phase and overall processing state for each job in the RICOH ProcessDirector system.

When you click a number or phase name in the System Summary, the Jobs table changes to display information about the associated jobs. For example, you can display detailed information for jobs with errors in the Print phase by clicking the number in the Error column for the Print row. To see all the jobs in the Print phase, click the Print phase name. To see all the jobs in the system, click the All link in the bottom row of the summary.

    Note:
  • Always use the tabs to navigate in the user interface because using the browser's forward and back buttons can cause unexpected results.

The System Summary portlet

The number in parentheses shows the total number of jobs in the phase. The default processing phases are: Receive, Prepare, Print, and Complete. If you have changed the phase names, the names you provided are used. If you have added RICOH ProcessDirector features or extensions to the base product, more phases might be shown in the System Summary portlet.

The progress categories are (from left to right):

Preprocessing
RICOH ProcessDirector is conditioning the job for the major processing that the phase does. This can include waiting for a resource (such as another computer to run a program on) to become available.
Active
The job has reached the major processing step or steps for the phase.
Manual
The job is waiting for an operator to do an action. Either the job has been stopped or a manual step in the phase is processing the job. A manual step requires a response from an operator to indicate that the step is complete before RICOH ProcessDirector moves the job to the next step for further processing.
Error
Job processing has stopped because of an error. Someone must do a corrective action before RICOH ProcessDirector continues to process the job. You can instruct RICOH ProcessDirector to do these actions on jobs that are in an error state:
  • Process again: Reposition the job to an earlier step and start to process the job again.
  • Override error: Ignore the error and let the job continue as if the step had successfully completed its processing. Use this action with caution because the job might skip a process that you require.
  • Delete: Delete the job from the system.

The View Log option under the Settings (Settings icon) menu at the top right of the System Summary lets you see log information for the RICOH ProcessDirector system.

1.2.1.3.3.2 Documents portlet

The Documents portlet contains the Documents table. The Documents table lets you see information about individual documents in the system and do actions on them.

Initially, the Documents table does not display any documents in the system. You can search for documents in the system by selecting either By property or By barcode scan.

The Documents table displays all the documents found in the system that meet the search criteria. If you do more than one search, the table clears the results from the first search and replaces them with the results of the new search.

You can configure the columns in the Documents table by clicking the Settings (image of the Settings icon) icon and then clicking Manage Columns. Columns can also be reordered and resized.

  • To change the width of table columns, click the separator between two column headings and drag it to a new position.
  • To change the order of the columns, click a column heading, drag it to a different position, and release the mouse button.

You can do actions on documents in the table by right–clicking a document and selecting an action:

  • To select a document, click the check box in the first column of the table.
  • To clear the selection, click the check box again.
  • To select all the documents that are displayed in the table, click the check box at the top of the first column.
  • To view a document in its original form, before any changes such as barcode additions or other content changes were made, right–click the document and select View Original.
  • To view a document in its current form, after any changes such as barcode additions or other content changes were made, right–click the document and select View Current.

    Note:
  • Only properties that are defined as database properties in the document property configuration file appear in the Documents table. Values for limited properties do not display.
  • The Documents table displays the values of document properties according to their current value in the database. If a step such as SortDocuments has processed a document, but the updated value in the document properties file has not yet been written to the database (a WriteDocumentsToDatabase or UpdateDocumentsInDatabase step has not occurred), then the Documents table still shows the previous value.

1.2.1.3.3.3 Inserter Controllers portlet

The Inserter Controllers portlet list shows information about the inserter controllers that you created.

You can do actions on the inserter controllers such as: enabling, disabling, and viewing and exporting the log. You can also view the properties of the inserter controllers.

The Inserter Controllers portlet

To do an action, select the check box next to an inserter controller and use the buttons at the top of the portlet. As an alternative, you can right-click the row and select an action from the list.

The star icon indicates whether the inserter controller is one of your favorite inserter controllers. If you see a blue star, the inserter controller is a favorite inserter controller; if it is gray, it is not a favorite. To see all inserter controllers or only your favorite inserter controllers, click the star in the header row of the table.

The inserter controllers and their properties are displayed differently, depending on whether the portlet is open in the List View or the Graphic View. To switch between the List View and the Graphic View, set the Device portlets on Main property in the Preferences dialog or the user property notebook.

The Inserter controller name column uses icons to represent whether the inserter controller is enabled. To open the property notebook for the device, click the inserter controller name.

The arrow to the left of the icon shows whether the inserter controller is enabled or disabled; inserter controllers can process jobs only when they are enabled. To change the device status, click the arrow.

A yellow bar next to the check box indicates that the inserter controller is not enabled.

To manage the columns that are displayed in the table, click the Gear menu button at the top right of the portlet and select Manage Columns. You can also right-click anywhere in the Inserter Controllers table header row and select Manage Columns. By default, these columns are displayed in the portlet:

  • Inserter controller name

    Shows the name of the inserter controller.

  • Active jobs

    Shows the number of active jobs currently assigned to the inserter controller.

  • Location

    The location, if any, that the inserter controller is associated with.

  • Enabled status

    Shows whether the inserter controller is enabled.

  • Completion method

    Shows the method the system uses to determine that the inserter controller has finished inserting a job.

Changing the column settings in the Graphic View also changes them in the List View.

Only inserter controllers that are associated with locations in the Locations to show property on your preferences appear in the Inserter Controllers table.

You can filter the list by typing any string in the filter field Funnel icon at the top of the Inserter Controllers portlet. Inserter controllers that contain the string in any property that is included in a column in the table are displayed.

To export entries in the Inserter Controllers table into a single Comma-Separated Value (CSV) file, click the Gear menu button and select Export Table to CSV.

The exported list only contains entries for inserter controllers that match all the filters that are set. For example, you type Gunther in the filter field Funnel icon. The list in the CSV file contains only the entries for inserter controllers with the word Gunther in their names. The entries are sorted by inserter controller name.

To add new insterter controllers, administrators can click the Gear menu button at the top right of the portlet.

1.2.1.3.3.4 Barcode Readers portlet

The Barcode Reader portlet shows information about the barcode readers you have created.

You can use the controls on the portlet to do actions on the barcode readers. The actions include connecting, disconnecting, viewing properties, viewing logs, and exporting logs for barcode readers.

The Barcode Reader portlet of the Main page with a barcode reader displayed.

You can do an action on a barcode reader by using either of these methods:

  • Select the check box and use the buttons at the top of the portlet.
  • Right-click the row and choose the action from the list.

The star icon indicates whether the barcode reader is one of your favorite barcode readers. If you see a blue star, the barcode reader is a favorite barcode reader; if it is gray, it is not a favorite. To see all barcode readers or only your favorite barcode readers, click the star in the header row of the table.

The barcode readers and their properties are displayed differently, depending on whether the portlet is open in the List View or the Graphic View. To switch between the List View and the Graphic View, set the Device portlets on Main property in the Preferences dialog or the user property notebook.

The arrow to the left of the icon shows whether the barcode reader is connected or disconnected. When the barcode reader is disconnected, the camera or barcode scanner is unreachable and any barcodes read by the device are not reported to RICOH ProcessDirector. Unless a user disconnected the barcode reader using the portlet, RICOH ProcessDirector automatically attempts to reconnect a disconnected barcode reader.

To connect or disconnect a barcode reader, click the arrow.

If a barcode reader has an alert, the barcode reader has received scan data that it does not recognize. Use the barcode reader log to investigate the problem. Use the Clear Alert action to remove the alert from the barcode reader in the portlet.

If there is a yellow bar next to the barcode reader, the barcode reader is disconnected. If there is a red bar next to the barcode reader, the barcode reader has detected an error.

To manage the columns that are displayed in the table, click the Gear menu button at the top right of the portlet and select Manage Columns. You can also right-click anywhere in the Barcode Readers table header row and select Manage Columns. By default, these columns are displayed in the portlet:

  • Name

    Shows the name of the barcode reader.

  • Barcode reader location

    The location, if any, that the barcode reader is associated with.

  • Barcode format

    Shows the type of barcode set.

  • Connection status

    Shows whether the barcode reader is connected.

  • Barcode reader state

    Shows whether the barcode reader is ready to use.

  • Description

    The description, if any, that the barcode reader is associated with.

  • IP Address

    Shows the IP address associated with the barcode reader.

Changing the column settings in the Graphic View also changes them in the List View.

  • To sort the barcode readers according to one of the columns in the table, click the column heading. One click sorts the column into ascending order, two clicks sorts the column in descending order.
  • To reorder the properties displayed for the barcode readers, click a column heading, drag it to a different position, and release the mouse button.

Only barcode readers that are associated with locations in the Locations to show property on your preferences appear in the Barcode Readers table.

You can filter the list by typing any string in the filter field Funnel icon at the top of the Barcode Reader portlet. Barcode readers that contain the string in any property that is included in a column in the table are displayed.

To export entries in the Barcode Readers table into a single Comma-Separated Value (CSV) file, click the Gear menu button and select Export Table to CSV.

The exported list contains only entries for barcode readers that match all the filters that are set. For example, you type Scanner in the filter field Funnel icon. The list in the CSV file contains only the entries for barcode readers with the word Scanner in their names. The entries are sorted by barcode reader name.

To add new barcode readers, administrators can click the Gear menu button at the top right of the portlet.

1.2.1.3.3.5 System Health portlet

The System Health portlet shows CPU and memory usage information for the primary server.
System Health portlet, with the CPU usage set to 5% and the Memory usage set to 55%.

The graphic changes color as usage increases.

  • When usage is 50% or lower, the graphic is green.
  • When usage is 51% to 75%, the graphic is yellow.
  • When usage is 76% or higher, the graphic is red.

To see a list of the 10 processes that use the most memory, hover the mouse pointer over the Memory graphic.

1.2.1.3.3.6 Input Devices portlet

The Input Devices portlet lists the defined input devices.

You can do actions on the input devices, such as enabling, disabling, connecting, and disconnecting the input device.

To do an action on an input device, click the check box to select it and use the buttons at the top of the portlet, or right-click the row and select an action from the list.

The star icon indicates whether the input device is one of your favorite input devices. If you see a blue star, the input device is a favorite input device; if it is gray, it is not a favorite. To see all input devices or only your favorite input devices, click the star in the header row of the table.

The input devices and their properties are displayed differently, depending on whether the portlet is open in the List View or the Graphic View. To switch between the List View and the Graphic View, set the Device portlets on Main property in the Preferences dialog or the user property notebook.

The arrow to the left of the icon shows whether the device is connected or disconnected. Input devices can only receive input files when they are connected. If the parent server for the input device does not respond when you attempt to connect a disconnected input device, RICOH ProcessDirector replaces the arrow to the left of the icon for the input device with the unable-to-connect icon. RICOH ProcessDirector connects the input device when its parent server is available.

The arrow to the right of the icon shows whether the input device is enabled or disabled; input devices can create jobs to be processed only when they are enabled. A solid green arrow indicates that the device is connected or enabled; a broken yellow arrow indicates that the device is disconnected or disabled.

To connect or disconnect the input device, click the arrow to the left of the input device. To enable or disable the input device, click the arrow to the right of the input device.

If there is a yellow bar next to the input device, the input device is disabled, disconnect, or disabled and disconnected. If there is a red bar next to the input device, the input device is in error.

To manage the columns that are displayed in the table, click the Gear menu button at the top right of the portlet. You can also right-click anywhere in the Input Devices table header row and select Manage Columns. By default, these columns are displayed in the portlet:

  • Input device name

    Shows the name of the input device.

  • Input files waiting

    Shows the number of input files that are currently waiting to be made into jobs.

  • Batching method

    Shows the Batching method that the input device uses.

  • Input device location

    The location, if any, that the input device is associated with.

  • Enabled status

    Shows whether the input device is enabled; input devices can create jobs to be processed only when they are enabled.

  • Connection status

    Shows whether the input device is connected; input devices can only receive input files when they are connected.

  • Device type

    Shows the input device type.

  • Input device description

    Shows the description of the input device.

Changing the column settings in the Graphic View also changes them in the List View.

Some of the columns might be hidden, depending on the size of the portlet. To see all the columns, maximize the portlet.

Only input devices that are associated with locations in the Locations to show property on your user preferences appear in the Input Devices table.

You can filter the list by typing any string in the filter field Funnel icon at the top of the Input Devices portlet. Input devices that contain the string in any property that is included in a column in the table are displayed.

To export entries in the Input Devices table into a single Comma-Separated Value (CSV) file, click the Gear menu button and select Export Table to CSV.

The exported list only contains entries for input devices that match all the filters that are set. For example, you type HotFolder in the filter field Funnel icon. The list in the CSV file contains only the entries for input devices with the word HotFolder in their names. The entries are sorted by input device name.

To add new input devices, administrators can click the Gear menu button at the top right of the portlet.

1.2.1.3.3.7 Printers portlet

The Printers portlet shows information about the printers that you have created.

You can do actions on the printers, such as enabling and disabling the printer and viewing printer properties. You can also show the web page for the printer and track job progress.

The Printers portlet on the Main page.

To do an action, click the check box to select it and use the buttons at the top of the portlet. As an alternative, you can right-click the row and select an action from the list.

The star icon indicates whether the printer is one of your favorite printers. If the star is bright blue, the printer is a favorite printer; if it is gray, it is not a favorite. To see all printers or just your favorite printers, click the star in the header row of the table.

The printers and their properties are displayed differently, depending on whether the portlet is open in the List View or the Graphic View. To switch between the List View and the Graphic View, set the Device portlets on Main property in the Preferences dialog or the user property notebook.

In the Graphic View, the Printer name column uses icons to represent the status of the printer, whether the printer is enabled, and whether the printer is one of your favorite printers. To see the web page for the printer, click the printer icon. To see the property notebook for the printer, click the printer name.

The arrow to the left of the printer icon shows whether the printer is enabled or disabled. A solid green arrow indicates that the printer is enabled; a broken yellow arrow indicates that the printer is disabled. To change the printer status from one to the other, click the arrow.

If the status indicator bar is yellow, the printer is not enabled and if it is red, the printer needs operator attention.

The progress bar in the % Printed column shows the percentage completed of a job that is currently printing. You only see the progress bar when the Print progress bar property is set to Yes on the System Settings dialog, and the printer is an AFP, PCLOut, Ricoh TotalFlow, or Ricoh PDF printer, and a job is currently printing.

  • To see the number of pages printed and the total page count, hover the mouse pointer over the progress bar.
  • If the progress bar is hidden, use Manage columns to add the % Printed property to the table.

To manage the columns that are displayed in the table, click the Gear menu button at the top right of the portlet and select Manage Columns. You can also right-click anywhere in the Printers table header row and select Manage Columns. By default, these columns are displayed in the portlet:

  • Printer name

    Shows the name of the printer.

  • % Printed

    Shows the progress of the job currently assigned to the printer.

  • Printer location

    The location, if any, that the printer is associated with.

  • Job size supported

    Shows the size of the jobs in sheets that can be scheduled to the printer.

  • Customer name

    Shows the customer name that is assigned to the printer.

  • Printer status

    Shows whether the printer is ready to use.

  • Enabled status

    Shows whether the printer is enabled; printers can print jobs only when they are enabled.

  • Current job number

    Shows the number of the job that is currently assigned to the printer.

  • Media supported

    Shows the media that the printer can use.

Changing the column settings in the Graphic View also changes them in the List View.

Only printers that are associated with locations in the Locations to show property on your user preferences appear in the Printers table.

You can filter the printers that are displayed in the table by typing any string in the filter field Funnel icon at the top of the Printers portlet. Printers that contain the string in any property that is included in a column in the table are displayed.

To export entries in the Printers table into a single Comma-Separated Value (CSV) file, click the Gear menu button and select Export Table to CSV.

The exported list only contains entries for printers that match all the filters that are set. For example, you type Ricoh PDF in the filter field Funnel icon. The list in the CSV file contains only the entries for printers of type Ricoh PDF. The entries are sorted by printer name.

1.2.1.3.3.8 Device Status portlet

The Device Status portlet shows a graphic representation of the devices in your system, using color to represent the current status of the devices.

The portlet always shows status for input devices and printers. If you install features that add different types of devices, they are added to the portlet. For example, the Inserter feature adds Inserter Controllers, while the Automated Verification feature adds Barcode Readers. When you hover over a device type, you see a legend that lists the statuses represented by the colored squares. Click View to open a table of all the devices of that type.

Device Status portlet, with the mouse pointer hovering over the Printers heading. A panel is open, displaying the Legend for printer devices.

The star icon indicates whether the portlet is displaying all devices or your favorite devices of each type. If the star is bright blue, the portlet is displaying your favorite devices of that type. If the star is gray, the portlet is displaying all devices of that type. To switch between displaying all devices and favorite devices, click the star.

Device status portlet, showing four types of devices: Input Devices, Printers, Inserter Controllers, and Barcode Readers.

To the right of the device type is a row of colored squares, one square for each device. The colors represent the current status of the device. Sometimes, a single color represents more than one device status.

Gray
Ready
Yellow
Disabled; Disconnected (input devices and barcode readers); Waiting to Connect; or Attention (barcode readers)
Blue
Printing
Red
Stopped; Needs attention; Disconnected (printers only); or Late (for expected work)

When you hover over a colored square, you see information about the device that the colored square represents.

Device Status portlet with the hover panel open.
  • Click View Log to open the log for that device.
  • Click View all devices in this state to open a table of devices of the same type that are in the same state. Only devices that are associated with locations in the Locations to show property on your user preferences appear in the table.
      Note:
    • You can open multiple device dialogs at the same time, one for each type of device.

In the dialog that opens, you can do the same actions in this dialog as you can on the Main and Administration pages.

You can move and resize the dialog, and leave it open while you use other portlets. However, the information in the dialog is not updated as jobs more through their workflows or other users interact with devices. Changes to the table (such as adding columns or applying filters) apply only to the dialog; they are not applied to the device tables on the Main or Administration pages.

To close the dialog, click the X in the upper right corner.

1.2.1.3.3.9 Jobs portlet

The Jobs portlet contains the Jobs table.

You can see detailed information about specific jobs in the RICOH ProcessDirector system and act on jobs using the Jobs table.

Only jobs that are associated with locations in the Locations to show property on your user property notebook appear in the Jobs table.

You can apply a filter using the System Summary portlet, by typing any string in the filter field Funnel icon, or by setting an Advanced filter.

  • System Summary portlet
    • To apply a filter, click text or numbers inside the portlet.
    • To remove a filter, click All.
  • Filter field
    • To apply a filter, enter some text. When you stop typing, the filter is applied.
    • To remove the filter, click the X at the right of the field.
  • Advanced filter
    • To apply a filter, specify the conditions that you want to use to filter the table and click Apply filter.
    • To enable or disable the filter, click the Advanced filter switch. Disabling the Advanced filter clears all of the conditions and refreshes the Jobs table.
    • To minimize or maximize the Advanced filter area, click the arrow to the left of the Advanced filter.
    • To show or hide the Advanced filter, click the Gear menu button and select Show Advanced Filter.

To export entries in the Jobs table into a single Comma-Separated Value (CSV) file, click the Gear menu button at the top of the portlet and select Export table to CSV.

The exported list only contains entries for jobs that match all the filters that are currently set. For example, if you select the Print link in the System Summary portlet, the list in the CSV file contains only the entries for jobs in the Print phase. The entries are sorted by job number. This function is useful if you want to track the set of jobs at the start of each shift or day.

To display a footer row that shows the totals of many numeric job properties, select some jobs and click the Gear menu button and select Show Totals Footer. The values of the properties you selected to show are summed for the selected jobs and the totals are displayed in the footer. To change what properties are displayed in the footer, right-click in the footer and select Choose Footer Properties. Make sure the properties you select are also included as columns in the Jobs table. To remove the footer, right-click in the footer and select Hide Totals Footer.

The Jobs table

You can do actions on jobs in the table by right-clicking a job or by selecting it and clicking one of the buttons at the top of the table:

  • To select a job, click the check box in the first column of the table or click anywhere in the row.
  • To clear the selection, click the check box or the row again.
  • To select multiple jobs, click the check box next to the jobs you want to select.
  • To select a range of jobs, click the check box next to a job, then hold Shift and click the check box next to the last job you want in the range.
  • To select all the jobs on the current page of the table, click the check box at the top of the column.
  • To sort the jobs according to one of the columns in the table, click the column heading. One click sorts the column into ascending order, two clicks sorts the column in descending order.

    Note:
  • You can click the job number to see the properties notebook for a job.

1.2.1.3.3.10 Job Status portlet

The Job Status portlet shows a graphical representation of the jobs in your system, using color to represent the phase and current state of the jobs.

The portlet displays two rows of colored stripes. The top row represents processing phases and the bottom row represents job states. In the image below, the purple stripe in the top row represents the Prepare phase and the lime green stripe represents the Print phase. The blue and yellow stripes under the purple stripe show the status of the jobs in the Prepare phase. The blue, red, and yellow stripes under the lime green stripe show the status of the jobs in the Prepare phase.

Job Status portlet
    Note:
  • The Job Status portlet does not show jobs that are in the Complete phase.

When you hover on the word Legend, you see a list of the colors, along with the phases and job state categories they represent.

Job Status portlet with Legend panel open.

The Job state category colors represent these job statuses:

Active
Assigned; Printing; Processing; Reading barcodes; Released; Spooling; or Spooled at printer
Error
Error; Error on printer; Duplicates detected; or No matching connector
Completed
Complete or Retained
Waiting
Creating; Deleting; Queued; Unassigned; Waiting; Manual, waiting; Manual, working; Stopped; Waiting for Acceptance; Waiting to reconcile; or Status changed on printer

When you hover on a colored stripe in the top row, you see information about all the jobs in that phase. The information includes the phase name and the number of jobs in the phase.

Job Status portlet with Phase information panel open.

When you hover on a colored stripe in the bottom row, you see information about all the jobs in that job state category within a specific phase. The information includes the phase and job state category name and the number of jobs in that phase and state.

Job Status portlet with Phase and State information panel open.

Click View when you hover over either stripe to open a table listing all jobs in that phase or phase and job state category.

Jobs window open on top of the user interface.

In the dialog that opens, you see a list of jobs in a table with the same columns as the Jobs portlet on the Main page. You can do the same actions in this dialog as you can on the Main page.

You can move and resize the dialog, and leave it open while you use other portlets. However, the information in the dialog is not updated as jobs more through their workflows. Changes to the table (such as adding columns or applying filters) apply only to the dialog; they are not applied to the Jobs table on the Main page.

To close the dialog, click the X in the upper right corner.

1.2.1.3.3.11 Submit Jobs portlet

The Submit Jobs portlet lets you upload files and submit the jobs to a hot folder or a workflow for processing.

You can drag and drop or browse for files to submit into an input device or workflow.

For each set of files that you submit, you specify which input device or workflow should process them.

    Note:
  • If files are uploading, do not reload the page or select the Back button in the browser. These actions stop the submission process.
  • Jobs can be submitted to a hot folder input device that is enabled and connected or to a workflow that is enabled. The input device or workflow must also be configured to accept jobs submitted using the portlet.

1.2.1.3.3.12 Deadlines portlet

The Deadlines portlet contains dots that show the number of jobs that have missed or are close to missing a deadline or checkpoint.

Hover over a dot to see a legend that lists the statuses represented by the dot. Click View all jobs in this state to open a table of all the jobs in that state.

In the dialog that opens, you see a list of jobs in a table with the same columns as the Jobs portlet on the Main page. You can do the same actions in this dialog as you can on the Main page.

You can move and resize the dialog, and leave it open while you use other portlets. However, the information in the dialog is not updated as jobs more through their workflows. Changes to the table (such as adding columns or applying filters) apply only to the dialog; they are not applied to the Jobs table on the Main page.

To close the dialog, click the X in the upper right corner.

If no jobs are late, the portlet shows a green checkmark.

1.2.1.3.3.13 Custom portlets

Custom portlets let you show information about RICOH ProcessDirector objects and their properties in a format that reflects the most important details of your operation in a way that makes sense to you.

RICOH ProcessDirector provides several styles of custom portlet for you to choose from.

For example:

  • If you want to see what forms are loaded on your printers and what state each printer is in, you can create a matrix portlet that displays printers, with a row for each location and a column for each state.
  • If you want to keep track of the jobs you have in process for each customer, you can create a tree portlet with a row for each customer. Under each customer, you can include a row for due dates.
  • If you want to display a count of the total number of pages printed or jobs due today, you can use a numeric portlet.

Matrix portlet

Matrix portlets look similar to the System Summary portlet. The key difference is that you choose the properties used for the column headers and row labels.

In the example below, the matrix portlet displays information about printers defined in RICOH ProcessDirector. The Property for rows is set to Printer location, so the first column shows all printer locations that exist in the system. The Property for columns is Printer status. The second column in the matrix shows the number of printers with the first status value in each location.

The other columns show the values of the Property for columns. Under the headings, the columns show the number of objects with that value in each row. The numbers in each column show how many printers have that status.

To include a row that displays the sum of each column, select Yes for Show totals row field.

If you show jobs in a matrix portlet, you can use the portlet to filter the Jobs table. Hovering over a property or a number, displays a pop-up window with summarized information. When you click a header or a number in the matrix, the Jobs portlet displays the jobs based on the properties you set for the portlet. You can display the information using a fixed portlet on the Main page or in a floating window.

Tree portlet

In the tree portlet, properties are stacked in hierarchies instead of spread out like a table. This arrangement lets you see the information more compactly.

When using the Tree style, select the hierarchy of properties that form the rows. The first column shows properties in a hierarchy that you select. You can add more columns to show more data.

In the example below, the tree portal shows information about jobs in the system. The jobs are first grouped on the Customer name. Under each customer, they are grouped by due date.

The same filtering functionality from the Matrix presentation applies to the Tree presentation. Clicking a word or number in each row filters the Jobs table. You can choose to display the information in a fixed portlet on the Main page or in a floating window.

Numeric portlet

A numeric portlet lets you show current counts of objects in the system, based on their properties. Each portlet can contain multiple entries, called indicators. The indicators can be associated with multiple types of objects.

When using the Numeric style, select the properties you want to count.

In the following example below, there is a numeric portlet for Jobs. The left indicator is filtered to show information about all jobs in the system that are due today. The right indicator applies an additional filter to show information only about the jobs due today that have moved to Retained state. Over the course of the day, the value from the right indicator increases as the jobs are printed. By showing the target number next to the current progress, an operator can easily see how much work is left.

1.2.1.3.4 Administration page

The Administration page of the RICOH ProcessDirector user interface provides navigation that administrators can use to view and change the properties of RICOH ProcessDirector objects.

    Note:
  • Always use the tabs to navigate in the user interface because using the browser's forward and back buttons can cause unexpected results.

The Administration page of the GUI

1.2.1.3.5 Reconcile Job dialog

The Reconcile Job dialog lets operators manually reconcile a job.

To see the Reconcile Job dialog, go to the Main page. In the Jobs table, right-click a job that is in the Waiting to reconcile state, and select Reconcile.

The Reconcile Job dialog of the user interface

1.2.1.3.6 Avanti Slingshot Settings Page

The Avanti Slingshot Settings page of the user interface lets you specify Avanti Slingshot server settings and displays a list of cost centers.

In the Avanti Slingshot Settings page, you can:

  • Set the Avanti URL that RICOH ProcessDirector communicates with.
  • View the list of Avanti Slingshot cost centers as defined in the Avanti Slingshot Connect configuration file.

1.2.1.3.7 Archive page

The Archive page of the user interface lets you retrieve jobs and documents that were stored in a repository.
You can:
  • Specify a repository and search options to locate a job or document to retrieve.
  • View the contents of the PDF or AFP job or document returned by the search, if the print data was stored in the repository.
  • Submit one or more jobs or documents to a workflow in RICOH ProcessDirector for additional processing, such as reprinting.
  • Export the properties and history information for one or more archive entries as a ZIP file containing two comma-delimited files (CSV).
  • View and export a PDF report that contains details and production history about one or more jobs or documents in a repository.
  • Save and reuse search criteria for frequently used searches.
  • Save a file from the repository to your workstation.
The FileCabinet page

1.2.1.3.8 Workflow page

You can use the Workflow page to create and edit your workflows, step templates, and step chains. Select the type of object you want to work with from the left navigation and select the object from the table.
The Workflow page of the user interface
    Note:
  • The star icon indicates whether the object is one of your favorite objects. If you see a blue star, the object is a favorite one; if it is gray, it is not a favorite. To see all objects or only your favorite objects, click the star in the table's header row.

1.2.1.3.8.1 Workflow Editor

The Workflow Editor page lets you create, edit, and view workflows.

A workflow consists of:

  • Steps grouped in phases
  • Step chains made up of connected steps
  • Connectors between steps and step chains
For each step and step chain, you see its icon and name. The total number of steps a step chain has is displayed on the step chain. If a connector has a conditional processing rule, you see the name of the rule.

The Workflow Editor with the PDFProduction workflow displayed.

To add processing steps to a workflow, use the buttons at the top right to open a list of steps templates or step chains, then drag and drop items into the workflow.

    Note:
  • In the Step Templates or Step Chains dialog, the star icon indicates whether the step template or step chain is one of your favorite objects. If you see a blue star, the step template or step chain is a favorite; if it is gray, it is not a favorite. To see all step templates or step chains or only your favorite ones, click the star in the table's header row.
  • If the workflow is large, you might zoom in and out to see more or fewer steps. Clicking the Map button opens a smaller representation of the workflow, with the portion currently displayed highlighted. The map can help orient you as to where you are in the workflow.

1.2.1.3.8.2 Workflow Editor Actions

To create a workflow corresponding to the processing steps that your jobs pass through, you can add steps and step chains to processing phases in the order that you want RICOH ProcessDirector to do them. Change the order or drag the steps to a new position. Delete any steps that you do not need. Set default values for some job properties as part of the workflow.
    Note:
  • When they are added to a workflow, step chains are treated like steps. In all of the actions below, references to steps apply to step chains as well.
Workflow editor actions
Action Description Shortcut keys
Add step To add a step, click Step Templates in the top right corner of the window to open the list of available step templates. Click a step template and drag it into the workflow editor. Place the step where you want it.
Show or hide the Step Templates
[Ctrl] + [E]
Add step chain To add a step chain, click Step Chains in the top right corner of the window to open the list of available step chains. Click a step chain and drag it into the workflow editor. Place the step chain where you want it.  
Add connector To add a connector between steps:
  1. Hover over the edge of the step. Click and hold a highlighted section (Image of connector handle) to make the connector appear.
  2. Drag the connector onto the step chain that you want the step chain to connect to. Wait until a section of the step chain is highlighted or your mouse is over the center of the circle, and release the mouse button. You can attach the connector to the top, bottom, or either side of the step.
 
Properties To change any other properties for a step, or connector, right-click it and select Properties.  
Associate a rule with a connector If the step has more than one outbound connector, you must specify the conditions that determine which branch a job should follow. You must also determine the order to use when evaluating the branches. The evaluation is done with rules set on each connector. To associate a rule with a connector:
  1. Right-click the connector and select Properties.
  2. Specify a conditional processing rule for the connector.
  3. Specify the Order of execution property value so that the conditions for the rule are tested in the correct order. For example, if a step is connected to three different steps, RICOH ProcessDirector first attempts to send each job through the connector with an Order of execution value of 1. If a job does not meet the conditions for that connector, RICOH ProcessDirector attempts to send the job through the connector with an Order of execution value of 2. If a job does not meet those conditions either, RICOH ProcessDirector attempts to send the job through the final connector. The order is shown in a dot next to the rule name on the connector label. If the job doesn’t meet the criteria for the last connector, job sits in a No matching connector state.

Step chains must have one entry point, a single step at the beginning of the step chain that all jobs process through. They can, however, have multiple endpoints, or steps with no outbound connector. When a step chain is placed in a workflow, it might be connected to one or more steps for jobs both entering and exiting the step chain. If the step chain has multiple endpoints, all of the end points continue processing following the outbound connector. If there are multiple outbound connectors, each endpoint is evaluated against the connectors following the order of execution and the job proceeds down the correct path.

 
Adding step on a connector If you need to add a step between two steps that are already connected, you can drop a step directly on the connector.

Adding a step on a single connector, splits the connector in two, one on each side of added step. When the connector is divided to insert the step, any rules that are set on the connector move to the incoming connector.

If a step has multiple outbound connectors, you can drop another step on one, some, or all of them. If you drop a step on a location where the connectors are merged to look like one line, you must select the branches that should include the step. A single connector becomes the inbound connector into the new step and a new outbound connector is created from the new step to each destination.

  • If the step is added only to the one branch, the rule logic moves to the incoming connector of the new step.
  • If the step is added to multiple branches, existing rules move to the output connectors of the new step.

Similarly, if a step has multiple inbound connectors and you drop the step on a location where the connectors are merged into one line, you must select the branches that should include the step. An inbound connector is created from each of the source steps to the new step and a new outbound connector line is created from the new step to the destination step. When the branch is divided to insert the step, existing rules are moved to the input connectors of the new step.

    Note:
  • The execution order of the connectors from the original source are preserved on the new connectors.
 
Replace one step with another To a replace a step, drag and drop the new step onto the one you want to replace. You see a confirmation message. Click OK.
    Note:
  • You can also replace a step with a step chain or replace a step chain with a step.
  • You can replace a step with a new step or step chain from Step Template or Step Chain window or with a disconnected step or step chain that is already in the Workflow Editor.
  • Rules associated with connectors are preserved, but the replaced step or step chain and associated properties are removed from the workflow.
 
Search To search the Workflow Editor for a specific step, click theSearch icon in the top right corner and enter the step name in the search field that appears.
    Note:
  • When you search in a workflow for a step, steps inside step chains are not shown. You can open a step chain and search for a step inside it.
 
Copy To copy a single step, right-click it and select Copy.
    Note:
  • When you copy an object, it replaces any object on your clipboard until you copy text or another object or you close the Workflow Editor.
[Ctrl] + [C]
Paste To paste a copied single step, right-click on a blank piece of workflow editor and select Paste.
    Note:
  • If you select an ineligible location in the Workflow Editor to paste the step, the paste action is grayed out in the menu.
  • If you do not have an eligible RICOH ProcessDirector object on the clipboard, the paste action is grayed out in the menu.
 
Delete To delete a step, or connector, right-click it and select Delete.

To delete a set of selected steps, right-click on the highlighted area and select Delete.

    Note:
  • Deleting a step that is connected to other steps also deletes the connectors.
[Del]
Undo To undo actions, right-click on the workflow editor and select Undo one or more times. [Ctrl] + [Z]
Redo To reverse an Undo action, right-click on the workflow editor and select Redo one or more times. [Ctrl] + [Y]
Select a set of steps To select a set of steps that are near each other, press and hold the Shift key. While holding Shift key, click on a blank space on the Workflow Editor and drag the mouse to draw a box around the steps, then release the mouse button. All the steps inside the box are selected.

To select a set of steps that are not near each other, press and hold the Ctrl key. While holding Ctrl key, click on the steps you want to select.

You can combine both selection methods to choose the desired steps.

To deselect one or more steps from your selection, press and hold the Ctrl key. While holding the Ctrl key, click on the steps you want to deselect.

    Note:
  • After the steps are selected, right-click on one of the highlighted steps to view available options.
 
Save as a step chain To save a set of steps as a step chain:
  1. Select the steps you want to save as a step chain.
  2. Right-click on the highlighted area, and select Save as Step Chain.
  3. Fill in the values and click OK.
    Note:
  • The Save as Step Chain action is not available if you included a step chain in the selection, or if the set of selected steps are not connected to make a valid step chain.
  • When the step chain is created, the set of selected steps are replaced on the Workflow Editor by the step chain.
  • If you undo this action, the steps are restored on the Workflow Editor, however the step chain object is not deleted. It is saved in the Step Chains list.
 
Change the order of steps To change the order of the steps, drag a step to a new position. The connectors reposition themselves as the step moves.  
Move a set of steps in the workflow To move a set of steps, select the group of steps. Move your mouse pointer inside the box and press the left mouse button. Drag the group to a new position and release the mouse button.  
Resize phase You can resize phases to fit more steps. Hover over the right end of the phase until the cursor changes then click and drag the phase bar until the phase is big enough for your needs.  
Repositioning the workflow in the window To reposition the workflow in the window, click the left mouse button and drag until you see the part of the workflow you want to work with or click the Map (Image of Map button) icon. In the Map window, a rectangle shows what part of the workflow is currently displayed.

Click and drag the rectangle to show different parts of the workflow. Click and drag the top of the Map window to move it to a different location on the screen. Click and drag the top right corner of the Map window to resize it.

Show or hide the Map
[Ctrl] + [M]
Zoom in or out To zoom in and out, use the mouse wheel, or the Ctrl + and Ctrl – keys. To use the Map, click and drag the circle in the lower right corner of the rectangle in the Map window. To restore the workflow to its default zoom (100%), right-click on the workflow editor and select Zoom to 100%. To restore the Map window and the workflow to its default zoom and location, click Reset in the Map window.
Zoom in
[Ctrl] + [+]
Zoom out
[Ctrl] + [-]
Zoom to 100%
[Ctrl] + [0]
Reset view
[Ctrl] + [D]
Save the workflow To save the workflow, right-click on the workflow editor and select Save workflow or Save workflow as.
    Note:
  • Saving the workflow does not check for missing required properties or connections. You can save the workflow, do other work in RICOH ProcessDirector, and return to complete your workflow later.
Save workflow
[Ctrl] + [S]
Save a workflow in image You can save a workflow in an image format to include in your internal reference material. To save the workflow as image, right-click on the workflow editor and select Save workflow as image.  
Enable When you are ready to use the workflow, enable it by clicking the Enable switch (Image of switch) to the left of the workflow name. RICOH ProcessDirector validates the workflow when you enable it. If any steps are not connected properly, RICOH ProcessDirector issues a message.  

1.2.1.4 Color and Grayscale Printing

Printing documents in full color or with very high-quality black and white (grayscale) images is more complex than printing black and white or spot-color documents. Understanding some of the principles of color and grayscale printing and how various products can fit into color and grayscale solutions can help you integrate color and grayscale printing with your current operations or expand to implement new color workflows.

1.2.1.4.1 AFP color and grayscale solutions

You can assemble printing products from Ricoh and other companies in different configurations to support Advanced Function Presentation (AFP) color and grayscale printing, including configurations that use the AFP Color Management Object Content Architecture (CMOCA) to provide optimal performance and color accuracy in high-speed color printing.
Color printing without explicit color management

You can include color images or specify colors for AFP objects in your print jobs and send them to an AFP color printer. The color images and objects print in color, based on the default settings in your print server and printer.

If you like the colors that the default color management settings provide, or if it is not essential that you print in exactly the right colors, you probably do not need to implement a full color management solution. However, if you want better control over the consistency and accuracy of your colors for devices, you might consider color management at some point in the future.

To understand some of the basic concepts about color printing, see:

Resources that document composition software includes inline

Most often, print bureaus use document composition software to generate highly customized and personalized color output. AFP color management is largely built into the document composition tools that support their processes. The software puts all the resources that the printer needs into the print job and sends it to a print server. The print server sends the print job to the printer, and the printer uses the resources as appropriate.

By using this method, you know that the required resources, including the resources required for color management, are available for any print job that is sent to the printer. However, including all the resources can make the print job very large, and moving large print jobs through your system might slow down system performance. Also, you might not be able to save resources that are downloaded with a print job on the printer so they can be reused without being downloaded later.

For more information about color printing, see:

For a list of the companies that participate in the AFP Consortium and support AFP color management in their products, see:

http://www.afpcinc.org

Resources stored and managed centrally

To take full advantage of the AFP CMOCA, you can store your color and image resources in a central resource library, and let your print system manage those resources. This option optimizes system performance by:

  • Creating some of the color management resources for you automatically
  • Reducing the number of color conversion resources that the system creates at print time by generating link color conversion color management resources in advance
  • Reducing the size of some images by removing embedded profiles when you store them, yet still retaining the association between the image and the profile
  • Letting you mark resources as capturable, so they can be saved on the printer and used in other print jobs without being downloaded again

For an introduction to the full AFP CMOCA and how you might implement it, see:

1.2.1.4.2 Color Printing Concepts

Color printing is significantly more complicated than black and white printing. If you understand some of the complexities, you can make the transition from black and white printing to grayscale or color printing more smoothly.

1.2.1.4.2.1 Color Spaces and ICC profiles

Presentation devices, such as computer monitors and printers, create colors differently. Because of these differences, colors must be described differently for each device. The different methods of describing colors are called color spaces. In addition, each device might have one or more International Color Consortium (ICC) profiles associated with it. ICC profiles are used when an image or another object is converted to the color space of a different device.

Each device has its own individual color space and range of colors that it can display or print. The color space specifies how color information is represented in an image when it is displayed on a particular device. As the image is passed from one device to the next, the color information about the image is converted from the color space of the source device to the color space of the destination device. Because color spaces do not exactly match between devices, some of the color information can be lost or modified in the conversion process.

A color space is a representation of the individual colors that can be combined to create other colors. Some color spaces that are relevant to printing are:

  • RGB

    In an RGB color space, red, green, and blue light are combined in different amounts and intensities to create different colors. RGB colors are often specified as single-byte integers numbered from 0 through 255. You can specify 256 levels of intensity for each of the three colors. For example:

    • R=0, G=0, B=0 yields black
    • R=255, G=255, B=255 yields white
    • R=251 , G=254 , B=141 yields a pale yellow
    • R=210, G=154, B=241 yields a light purple
    Devices such as monitors, digital cameras, and scanners generally use RGB color spaces to describe colors. Two standard implementations of RGB color spaces are sRGB, which is most often used for Web graphics, and Adobe RGB (1998), which we recommend for graphics that are printed.

  • CMYK

    In a CMYK color space, cyan (bright blue), magenta (bright red-pink), yellow, and black pigments are combined to create different colors. CMYK values are often represented as a percentage. The percentage represents the portion of a particular area of paper that is covered by ink or toner. For example:

    • C=0%, M=0%, Y=0%, K=100% yields black
    • C=0%, M=0%, Y=0%, K=0% yields a blank area on the page
    • C=1.6%, M=0%, Y=44.7%, K=.4% yields a pale yellow
    • C=17.6%, M=39.6%, Y=5.5%, K=5.5% yields a light purple
    Color printers use the CMYK color space; they are loaded with ink or toner in each color. When the printer places dots of the correct sizes next to and on top of each other on a page, your eye interprets them as the intended color.

    Implementations of the CMYK color space vary from printer to printer and from paper to paper. Because the original color space of most images is an RGB color space, it is best to leave images in an RGB color space so they retain their original characteristics. That way, your print server or printer has as much of the original color information as possible when it converts the images to the most appropriate CMYK color space for the printer and paper combination.

    If you save an image by using the CMYK color space, make sure that you either save an ICC profile for that color space or use a standard non-device specific CMYK color space like SWOP or Coated FOGRA27 and associate the appropriate ICC profile with the image.

    Note:
  • Both RGB and CMYK values can be expressed in different ways. For example, in the PostScript data stream, the values range from 0.0 to 1.0, while in some graphic arts programs they can be expressed in hexadecimal numbers or as percentages.

An ICC profile contains information for converting an image between a device-specific color space and a device-independent color space. A device-independent color space is a color space that does not depend on or relate to the characteristics of any particular device, but rather contains all colors for all gamuts. The ICC identified a specific profile connection space (PCS) as the target device-independent color space for all ICC profiles.

You can use an input ICC profile to translate color data created on one device (such as a digital camera) into the PCS. Then you can use an output ICC profile to convert from the PCS into the native color space of a different device (such as a printer). Converting images from one color space to another is process-intensive and can affect performance in your print system, although it is the best way to maintain consistent color for the devices in your system.

1.2.1.4.2.2 Gamut and Rendering Intent

Every device has a gamut, a range of colors or shades of colors that it can display or print. Some devices have larger gamuts than others; some devices have gamuts that are similar sizes, but that contain slightly different colors. When an image or a print job is created on a device with a gamut that is different from the printer, you can use a rendering intent to tell the printer how to adjust the colors that are outside the gamut of the printer.

The gamut of a printer is almost always significantly smaller than the gamut of a monitor, digital camera, or scanner. Images or graphics nearly always have to be adjusted to print appropriately because some of the colors that they require might be outside the gamut of the printer.

A rendering intent tells the printer how to adjust the image when it encounters colors that it cannot reproduce. Each rendering intent has different benefits and trade-offs, so you can choose one based on how the print output should look.

1.2.1.4.2.3 Color Mixing and Calibration

Four standard colors (cyan, magenta, yellow, and black) are blended to create all the colors in the gamut of a printer. A printer mixes colors by printing four layers of a page or an image, one in each color. If the printer registration is not set correctly, the images do not line up properly and the colors appear wrong. In addition, the printer must be calibrated to ensure that all its systems are functioning correctly and that it is in a known good state.

By using the color information described in its color space, each device determines the amount of cyan, magenta, yellow, or black to use. Dots of each color are printed in overlapping patterns that, when interpreted by your eyes, blend the colors appropriately. To ensure the colors are created accurately, the color planes must be perfectly aligned. If they are not, you might see moire patterns, unintended patterns in the printed images, or poorly blended colors, which are especially noticeable on the edges of your images.

Color printers must be calibrated regularly, in some cases daily, to ensure that the colors they produce are consistent. In addition, follow the recommended printhead maintenance procedures and schedule to ensure that the printer operates optimally. Even when a printer is calibrated correctly, its gamut is much smaller than that of any monitor, so images do not look the same when they are printed as they do when they are displayed on a monitor.

1.2.1.4.2.4 Halftones and Tone Transfer Curves

Halftones are used to convert images (such as photographs, drawings, logos, or charts) from the continuous tones that you see on a monitor into a pattern of dots that a printer can put on paper. Tone transfer curves are used to modify the values of a particular color component and thus adjust the look and feel of some of the colors. For example, you can apply a tone transfer curve to emphasize the brightest parts of an image.

Halftones and tone transfer curves are used with both color and grayscale print jobs.

There are several different kinds of halftones, including clustered-dot, stochastic, and error diffusion. For simplicity, this discussion only covers clustered-dot halftones.

Clustered-dot halftones are generally characterized by:

  • Line screen frequency

    Line screen frequency is a measure of the resolution of a halftone, expressed in lines per inch (lpi). A low line screen frequency, such as 80 lpi, creates coarser images because they use larger halftone dots. A high line screen frequency, such as 150 lpi, can produce higher quality images by using smaller halftone dots.

  • Halftone pattern

    Halftone dots are printed in various shapes and patterns. For example, dots can generally be round, elliptical, or square, and they can be arranged in slightly different orientations. The halftone pattern also describes how the size of the dot is increased to cover a larger percentage of the total area and yield darker colors. Different patterns might produce better results for some print jobs.

  • Rotation

    Lines of halftone dots do not run parallel with the top or side of the paper because that could cause unintended patterns to emerge, resulting in lower quality output.

    In addition, the dots for each of the four colors in a CMYK printer cannot all be printed at the same angle because they would overlap incorrectly and the colors would not appear as intended. Instead, the lines of dots are printed on the page at specific angles so your eye blends them appropriately.

    For example, the black layer of an image might be printed so the lines of dots run across the page at a 45 degree angle to the top of the paper, while the cyan layer is printed so that its lines of dots are at a 105 degree angle to the top of the paper.

Tone transfer curves are most often used to offset the effects of dot gain. Dot gain is the tendency for printed dots to be larger than intended, often because of the way ink reacts with paper. If the ink soaks into the paper and spreads out, the resulting dot is much larger (and possibly much lighter in color) than the printer intended it to be. Tone transfer curves can increase or reduce the amount of ink used in proportion to the dot gain.

1.2.1.4.2.5 File Size

Color print jobs can have a file size that is much larger than black and white print jobs. The larger file size can lead to longer processing times and increased traffic on your network.

Because color images must contain data about each layer of color, the file might contain three to four times more information than a grayscale file and over 24 times more information than a black and white file. In addition, ICC profiles are embedded in some file types (such as EPS, JPEG, and TIFF images). While ICC profiles by themselves might not be very large, they do increase the size of an image. If you only have one image repeated throughout a print job, and if you construct your job so the image is downloaded only once, the embedded profile is of little concern.

However, if you use a variety of different images, each with an embedded profile, or if you construct your print job so that each image is downloaded every time it appears, the embedded profiles can add unnecessary volume to the print job. If you plan to use a wide variety of color images, create or save them with the same color space so they all use the same ICC profile. You can also install color images in a resource library so they can be reused.

1.2.1.4.3 Grayscale Printing Concepts

With grayscale printing you can reproduce color images as high-quality black and white images by using many shades of gray to represent subtle variations in color and light. Printing solutions that produce high-quality grayscale output use color printing concepts with a black and white printer that supports them to achieve that effect.

Moving to grayscale printing might be a first step in a migration to full color printing. You can start to create color print jobs and print them on an existing printer until you are ready to invest in color printers. In addition, you can use a grayscale printer as a backup system for a full color printer.

Some color concepts are much less important in grayscale printing than they are in color printing:

  • The gamut of a black and white printer is much smaller than that of a color printer; essentially all the colors in an image must be adjusted.
  • The rendering intent you choose has little effect on the appearance of the image because the colors are already being changed significantly.
  • Page registration is less important. Because the printer only uses one color, you do not have to line up the color planes to create the correct color.
  • Paper characteristics have minimal effect on grayscale output; one output profile is usually adequate for all types of paper.

Other color concepts are more essential to grayscale printing.

Color spaces and ICC profiles

The color space of a black and white printer is much smaller than that of a color printer. Even so, printers that can print grayscale images have output ICC profiles, just like color printers. The ICC profiles for black and white printers map colors from the profile connection space (PCS) to shades of gray. Otherwise, the color conversion process is the same.

The print job should specify the appropriate input profile; if there is no input ICC profile, the printer uses a reasonable default. The printer has its own default ICC profile installed and available; it should be adequate for nearly all print jobs.

Halftones

Grayscale printers apply halftones to print jobs to print them; halftones let the printer produce many shades of gray and high-quality images. Generally, the most important characteristic to consider for halftones in grayscale printing is line screen frequency, expressed in lines per inch (lpi). Each printer supports a set of line screen frequencies natively; when you specify the desired line screen frequency in a print job, the printer chooses the available line screen frequency that best matches it.

Tone transfer curves

Tone transfer curves are used in grayscale printing to adjust the amount of toner that is used at different levels of gray, thus adjusting the appearance of images. You can use the appearance value of a tone transfer curve in grayscale printing to indicate how much the tone transfer curve should adjust the color values. Some sample appearance values could be:

  • Dark
  • Highlight Midtone
  • Standard

1.2.1.4.4 Color Management

Images, graphics, and photographs often appear different depending on the monitor or the printer you use. The colors printed by one printer might not match the colors printed on another printer, even if they came from the same source. If it is important that colors stay consistent from camera, scanner, or monitor to printer, you must use color management practices.

It is virtually impossible to accurately reproduce the colors that you see on your monitor on a printed page. Because printers typically have smaller color gamuts than other devices, some of the colors must always be adjusted when images are transformed for printing. With color management, you can control the adjustments so they are less noticeable than they might be if you use the default settings of your image creation software, print server, and printer.

Several factors play significant roles in color management, including ICC profiles, rendering intents, and paper characteristics.

1.2.1.4.4.1 ICC Profiles

The International Color Consortium (ICC) is an organization that has established open standards for color management. These standards help products work together by identifying a device-independent color space and defining the elements of an ICC profile.

The device-independent color space that the ICC defined is called the profile connection space (PCS). The PCS is a color space large enough to include all the color gamuts of different input, display, and output devices. An ICC profile contains methods that map the colors that a device can create or display to the values of the corresponding colors in the PCS. The ICC profile can be used to convert an image from a device-specific color space to the PCS, or from the PCS to a device-specific color space.

Product manufacturers create ICC profiles that you can use with their devices. For example, if you take a photograph with a digital camera, you can associate the photograph with the ICC profile for your camera. Then, when you want to print that photograph, the color management system converts the color data from the camera into the PCS. The printer then uses its ICC profile to convert the photograph data from the PCS into its color space, and prints the photograph as accurately as it can.

For more information about the ICC, ICC profiles, and the PCS, see the ICC Web site:

http://www.color.org
To visit this website, make sure you are on a system that is connected to the Internet.

Note: To access the website address, right-click on the link and select to open it in a new tab or window.

1.2.1.4.4.2 Rendering Intents

Rendering intents indicate what you want a printer to do with colors that are outside its gamut.

ICC profiles support these rendering intents:

  • Perceptual

    If an image includes any colors that are out-of-gamut for the printer, the printer adjusts all the colors in the image, even those that are already in the gamut of the printer, so they are all in-gamut and maintain their color relationships to each other. The result is an image that is visually pleasing, but is not colorimetrically accurate. The perceptual rendering intent is useful for general reproduction of images, particularly photographs.

  • Saturation

    If a print job includes colors that are out-of-gamut for the printer, the printer replaces the out-of-gamut color with the nearest color in the gamut. It also adjusts the in-gamut colors so that they are more vivid. Saturation is the least used rendering intent, but it is useful for business graphics, such as images that contain charts or diagrams.

  • Relative colorimetric

    If a print job includes colors that are out-of-gamut for the printer, the printer substitutes the nearest in-gamut color; in-gamut colors are not adjusted. Colors printed on papers with different media white points might not match visually. The media white point is the color of the paper that the print job is printed on. For example, if you print an image on white paper, on off-white paper, and on blue paper by using the relative colorimetric rendering intent, the printer uses the same amount of ink or toner for each one and the resulting color is technically the same. However, the images might seem different because your eyes adjust to the color of the background and interpret the color differently. This rendering intent is typically used for vector graphics.

  • Absolute colorimetric

    All colors are mapped by using the same method as the relative colorimetric rendering intent, however, all colors are adjusted for the media white point. For example, if you print an image on white paper, on off-white paper, and on blue paper by using the absolute colorimetric rendering intent, the printer adjusts the ink or toner used for each one. The resulting color is technically not same, but the images might look the same because of the way your eyes interpret them in relationship to the color of the paper. The absolute colorimetric rendering intent is typically used for logos.

1.2.1.4.4.3 Paper Characteristics

The paper that you use has a significant impact on the colors that you see. Even if you use the same ICC profile and the same printer, printing on a different paper can result in a very different color appearance.

Colors can change from paper to paper, particularly if you change from coated to uncoated paper or from sheet-fed to continuous forms paper. The changes can be so noticeable that printer manufacturers generally test and certify papers with certain characteristics for use with their printers. They also create different ICC profiles for their printers based on paper characteristics. Some ICC profiles can be used for groups of papers that have similar characteristics.

When you load paper, you set certain paper characteristics on the printer. When the printer chooses the correct device-specific output profile to use, it takes the characteristics into consideration. The paper characteristics are:

  • Media brightness

    The percentage of light that the paper reflects

  • Media color

    The color of the paper

  • Media finish

    The characteristics of the surface of the paper, such as: glossy, satin, matte

  • Media weight

    The basic weight of the paper

1.2.1.4.5 AFP Color Management

There are various ways to print color data with Advanced Function Presentation (AFP). However, to implement an AFP color printing solution with full color management, you must use color management resources (CMRs). We also recommend that you install all your color images as data objects and associate CMRs with them.

1.2.1.4.5.1 Color Management Resources

Color management resources (CMRs) are the foundation of color management in AFP print systems. They are AFP resources that provide all the color management information, such as ICC profiles and halftones, that an AFP system needs to process a print job and maintain consistent color from one device to another.

CMRs share some characteristics with other AFP resources, but are different in some important ways.

CMRs are similar to other AFP resources in these ways:

  • CMRs can be associated with elements of a print job at various levels of the hierarchy.

    Typical hierarchy rules apply, so CMRs specified at lower levels override those at the higher level. For example, a CMR set on a data object overrides a default CMR set on a print file.

  • CMRs can be included in a print job in an inline resource group and referenced in a form definition, page environment, object environment, or an include Object (IOB) structured field.
      Note:
    • CMRs can vary in size from several hundred bytes to several megabytes. If your print job uses relatively few CMRs, including them in the print file might not have an impact on the performance of your system. However, if your print job uses more than 10 CMRs, the size of the print job can increase so much that file transfer rates and network traffic are affected.
  • CMRs can be stored centrally in a resource library, so you do not need to include them in every print job.

    You can configure all your print servers so they can access the CMRs.

  • For the print server to find CMRs, the resource library must be listed in the AFP resource search path on the print server.

CMRs are different from other AFP resources in these ways:

  • You cannot copy CMRs into a resource library as you can other AFP resources.

    To store CMRs in a central resource library, you must install them by using an application such as RICOH AFP Resource Installer.

  • CMRs and data objects must be stored in resource libraries that have resource access tables (RATs).

    AFP Resource Installer creates the RAT when CMRs and data objects are installed. We recommend that CMRs and data objects be installed in separate resource libraries and that you store resources that do not require RATs (such as form definitions, page definitions, and overlays) in other resource libraries.

  • CMRs installed in a resource library can have names longer than 8 characters, and you can use the names in the print data stream.

    These names are created when you install the CMR by using AFP Resource Installer and are UTF-16BE encoded.

1.2.1.4.5.1.1 Types of CMRs

Different situations call for different types of CMRs. Some CMRs are created by product manufacturers so you can download and use them, while others are created by your printer or other color management software. If you have the appropriate information, you can also create CMRs yourself.

Some CMRs are used to interpret input files (similar to the function performed by ICC input profiles), while others are used to prepare the final print job output for a specific printer (similar to the function performed by ICC output profiles).

1.2.1.4.5.1.1.1 Color Conversion CMRs

Color conversion (CC) CMRs are used to convert colors to and from the ICC profile connection space (PCS), a device-independent color space. You can use them to prepare images for color or grayscale printing.

Color conversion CMRs are an essential element of any AFP color management system because they are ICC profiles encapsulated in AFP structures. The AFP structures add information that your color management system can use, but it leaves the ICC profile unaltered.

You can use color conversion CMRs to produce consistent colors on different devices. In a color system, they help ensure that the colors on your monitor are as close as possible to those that are printed. If you move the print job to a different printer, the colors are adjusted again to match the new printer.

In a grayscale system, color conversion CMRs map colors to appropriate shades of gray to produce high-quality black and white images.

Passthrough CMRs are color conversion CMRs that indicate that no color processing should be done if the color space of the presentation device is the same as the color space of the CMR. Passthrough CMRs contain no data.

1.2.1.4.5.1.1.2 Link Color Conversion CMRs

Link color conversion CMRs combine the processing information required to convert an image directly from the color space of an input device to the color space of the output device. Essentially, link color conversion CMRs replace a pair of color conversion CMRs.

Converting color images to and from the PCS takes a significant amount of processing resources, in part because the process includes two conversions. Link color conversion CMRs combine the two conversions and make them more efficient. The printer can use the link color conversion CMR to convert colors directly from the color space of the input device to the color space of the output device with the same color fidelity they would have if the printer did both of the conversions. As a result, link color conversion CMRs can improve system performance.

The two types of link color conversion CMRs are:

Link CMRs
Link (LK) CMRs are unique. You cannot create a link CMR yourself and you do not include references to link CMRs in your print jobs. The print system creates and uses link CMRs automatically.

If you use AFP Resource Installer, link CMRs are generated automatically when you create or install a color conversion CMR. As a result, your resource library always contains link CMRs for every combination of color conversion CMRs in audit (input) and instruction (output) processing modes. When link CMRs are created, AFP Resource Installer marks them as capturable, so the printer can save them to be used in other print jobs.

If you do not use AFP Resource Installer, some printers can create link CMRs when they process print jobs. For example, if you send a print job to an InfoPrint 5000, the printer controller looks at the audit color conversion CMRs that are specified. Then, the print controller looks at the link CMRs that it has available to find one that combines the audit color conversion CMR with the appropriate instruction color conversion CMR. If it does not find one, the print controller creates the link CMR and uses it. The print controller can be configured to save the link CMRs that it creates. However, the link CMRs are sometimes removed during normal operation, for example, if the printer runs out of storage or is shut down. If the link is removed, the printer must create a new link CMR the next time it is needed.

When a link CMR is created, the print system evaluates the conversion algorithms to and from the PCS. The system then combines the algorithms, so a data object can be converted directly from one color space to the other without actually being converted to the PCS.

Device link CMRs
Device link (DL) CMRs use an ICC device link profile to convert directly from an input color space to an output color space without reference to an audit-mode or instruction-mode CMR. An ICC device link profile is a special kind of ICC profile that is used to convert the input device color space to the color space of an output or display device. ICC device link profiles are not embedded in images.

You can create, install, and uninstall device link CMRs yourself. Device link CMRs are referenced in the MO:DCA data stream and take precedence over audit color conversion CMRs. A device link CMR specifies its own rendering intent, which is indicated in the header of the ICC device link profile. This rendering intent overrides any other rendering intent that is active.

The biggest advantage of using device link CMRs is that they preserve the black channel (K component) of the input color space when converting from CMYK to CMYK.

1.2.1.4.5.1.1.3 Halftone CMRs

Halftone (HT) CMRs carry the information that a printer uses to convert print jobs into a pattern of dots that it can put on paper. Halftone CMRs can be used with both color and grayscale print jobs.

Halftone CMRs generally specify the line screen frequency, halftone pattern, and rotation of the halftone that they carry. Some device-specific halftone CMRs also include the printer resolution.

A printer that uses AFP color management to print color or grayscale print jobs must use a halftone CMR to convert the print job into a format that the printer can reproduce in ink or toner. If a halftone CMR is not specified in the print job, the printer applies a default halftone CMR.

    Note:
  • If you send your color print jobs to an InfoPrint 5000 printer, halftones are applied by the print engine. As a result, the printer ignores halftone CMR requests.

You can associate device-specific halftone CMRs or generic halftone CMRs with print jobs:

  • If you know which printer is printing the job, you can associate a device-specific halftone CMR with the print job (or with AFP resources inside the print job). The printer uses the halftone CMR that you specify.
  • If you do not know which printer is printing the job, but you want to ensure that it uses a halftone CMR that has certain characteristics, such as a specific line screen frequency, you can associate a generic halftone CMR with the print job.
Because it is difficult to know which halftone CMRs should be used for the current conditions on the current printer, we recommend that you specify halftone CMRs generically and let the printer choose the most appropriate CMR that it has available.

Generic halftone CMRs

You can use generic halftone CMRs when you want to choose one or more characteristics of the halftone CMR for a print job, but you do not know exactly which halftone CMRs are available.

When a print job specifies a generic halftone CMR, the print server looks in the resource library for halftone CMRs that match the printer device type and model. If the print server finds an appropriate CMR, it sends the device-specific halftone CMR to the printer with the print job. If the print server does not find an appropriate halftone CMR, it sends the generic halftone CMR to the printer.

If a print job arrives at the printer requesting a generic halftone CMR, the printer compares the requested characteristics with the available device-specific halftone CMRs. If there is a match, the printer uses the selected device-specific halftone CMR when it processes the print job. If there is no match, the printer uses the halftone CMR whose line screen frequency value is closest to the one requested.

The Color Management Object Content Architecture (CMOCA) has defined a variety of generic halftone CMRs, which cover the most common line screen frequencies and halftone types. A print server that supports CMOCA can interpret generic halftone CMRs if it has device-specific halftone CMRs available to it in a resource library. If you use AFP Resource Installer, the generic halftone CMRs are installed in every resource library that you create and populate by using AFP Resource Installer.

Printers that support CMOCA should be able to interpret those generic CMRs and associate them with device-specific halftone CMRs.

1.2.1.4.5.1.1.4 Indexed CMRs

Indexed (IX) CMRs map indexed colors in the data to presentation device colors or colorant combinations.

Indexed CMRs provide rules about how to render indexed colors. Indexed CMRs apply to indexed colors that are specified by using the highlight color space. They do not apply to indexed colors found within PostScript or other non-IPDS data objects. For Indexed CMRs, both instruction and audit processing modes are valid. However, only indexed CMRs with an instruction processing mode are used; those with an audit processing mode are ignored. The tags in the indexed CMR let the CMR use various color spaces in the descriptions. These color spaces can be grayscale, named colorants, RGB, CMYK, or CIELAB.

1.2.1.4.5.1.1.5 Tone Transfer Curve CMRs

Tone transfer curve (TTC) CMRs are used to carry tone transfer curve information for an AFP print job, so you can modify the values of a particular color component and adjust the appearance of some of the colors by increasing or decreasing the amount of ink used to emphasize or reduce the effects of dot gain on the final output.

Like halftone CMRs, tone transfer curve CMRs are associated with print jobs specifically or generically. If they are specified generically, the print server looks in the resource library for tone transfer curve CMRs that match the printer device type and model. If the print server finds an appropriate CMR, it sends the device-specific tone transfer curve CMR to the printer with the print job. If the print server does not find an appropriate tone transfer curve CMR, it sends the generic tone transfer curve CMR to the printer.

If a print job arrives at the printer requesting a generic tone transfer curve CMR, the printer compares the requested characteristics with the device-specific tone transfer curve CMRs that it has available. If there is a match, the print server or printer uses the selected device-specific tone transfer curve CMR when it processes the print job. If the printer cannot find a good match for the generic tone transfer curve CMR, it ignores the request and uses its default tone transfer curve CMR.

The Color Management Object Content Architecture (CMOCA) defines several generic tone transfer curve CMRs with different appearance values. You can use the appearance values to specify how to print your job with regard to the reported dot gain of the printer.

Generic tone transfer curves can be used to select these appearance values:

Dark
The output is adjusted to show a dot gain of 33% for a 50% dot.
Accutone
The output is adjusted to show a dot gain of 22% for a 50% dot.
Highlight Midtone
The output is adjusted to show a dot gain of 14% for a 50% dot. This appearance is often used to emphasize the brightest part of an image.
Standard
The output is adjusted just enough to account for the effects of dot gain, effectively counteracting the dot gain.

If you use AFP Resource Installer, it installs the generic tone transfer curve CMRs on your system automatically.

1.2.1.4.5.1.2 CMR Processing Modes

CMR processing modes tell the print system how to apply a CMR to the print data it is associated with. You specify a CMR processing mode whenever you specify a CMR, although not all modes are valid for all CMR types.

1.2.1.4.5.1.2.1 Audit Processing Mode

CMRs with the audit processing mode refer to processing that has already been applied to a resource. In most cases, audit CMRs describe input data and are similar to ICC input profiles.

The audit processing mode is used primarily with color conversion CMRs. In audit processing mode, those CMRs indicate which ICC profile must be applied to convert the data into the profile connection space (PCS).

For example, to take a photograph with a digital camera and then include the photograph in an AFP print job, you can use AFP Resource Installer to:

  1. Create a color conversion CMR by using the ICC profile of your camera.
  2. Install your photograph in a resource library.
  3. Associate the color conversion CMR with the data object, indicating the audit processing mode.

Then, you create a print job that includes the data object. When processing the print job, the system uses the color conversion CMR to convert the colors in the image into the PCS. The colors can then be converted into the color space of the printer that is printing it.

1.2.1.4.5.1.2.2 Instruction Processing Mode

CMRs with the instruction processing mode refer to processing that is done to prepare the resource for a specific printer that uses a certain paper or another device. Generally, instruction CMRs refer to output data and are similar to ICC output profiles.

The instruction processing mode is used with color conversion, tone transfer curve, and halftone CMRs. In instruction processing mode, these CMRs indicate how the system must convert a resource so it prints correctly on the target printer. The manufacturer of your printer should provide ICC profiles or a variety of CMRs that you can use. Those ICC profiles and CMRs might be installed in the printer controller, included with the printer on a CD, or available for download from the manufacturer's Web site.

If you send a color AFP print job to a printer that supports AFP Color Management, color conversion and tone transfer curve CMRs in instruction processing mode can be associated with the job. When the printer processes the print job, it applies the CMRs in this order:

  1. Color conversion CMRs in audit processing mode to convert the resources into the ICC profile connection space (PCS).
  2. Color conversion and tone transfer curve CMRs in instruction processing mode to convert the resources into the color space of the printer.
  3. Halftone CMR in instruction processing mode to convert the job pages from their digital format into the pattern of dots that the printer can produce.

In some cases, CMRs that are usually used as instruction CMRs can be used as audit CMRs. For example, if you send a very large print job to a high-speed printer, the images in the print job are converted into the color space of that printer by using a color conversion CMR with the instruction processing mode. However, if you have to reprint part of the job on a different printer, the system must convert the print job into the color space of the second printer. In that case, the color conversion CMR of the first printer is used in the audit processing mode to move the images back into the PCS. Then, the system uses a color conversion CMR of the second printer in instruction mode to convert the images into its color space.

1.2.1.4.5.1.2.3 Link Processing Mode

CMRs with the link processing mode are used to link an input color space in the presentation data (sometimes defined by an audit CMR) to the output color space of the presentation device (sometimes defined by an instruction CMR). Only link (LK) and device link (DL) CMRs can be used in link processing mode.

Whenever you install or uninstall audit or instruction color conversion CMRs in your resource library by using AFP Resource Installer or a similar software product, the AFP Resource Installer automatically creates or deletes link (LK) CMRs for every combination of audit and instruction color conversion CMR.

When a print job calls for a given audit-instruction combination, the print server checks the resource library for a link (LK) CMR for that combination. If the print server finds an appropriate link CMR, it sends the CMR to the printer with the print job. Your printer can use the link (LK) CMRs whenever a print job indicates that it uses a particular combination of audit and instruction CMRs.

If you do not use AFP Resource Installer or a similar program to install your resources, your color printer must either create link (LK) CMRs while it processes your print jobs or convert the colors in your jobs twice, first from the original color space to the PCS and then from the PCS to the color space of the printer.

An InfoPrint 5000 printer creates link (LK) CMRs so it only has to do one conversion, and saves them so they can be used with other print jobs. However, the link (LK) CMRs are sometimes removed during normal operation, such as if the printer runs out of storage or is shut down.

1.2.1.4.5.1.3 CMR Creation and Installation

Device manufacturers and groups that support AFP color standards create CMRs that you can use in your color printing systems. You can also create CMRs yourself, based on your needs.

The AFP Consortium, the group that defined the AFP Color Management Object Content Architecture (CMOCA), identified a set of color conversion CMRs that are most often used in audit processing mode. The set includes color conversion CMRs for common color spaces, such as:

  • Adobe RGB (1998)
  • sRGB
  • SMPTE-C RGB
  • SWOP CMYK
The standard CMRs are included with AFP Resource Installer, although they are not installed by default. You can install the standard CMRs that you plan to use. In addition, AFP Resource Installer automatically installs all the generic halftone and tone transfer curve CMRs in any resource library you create.

If you need more CMRs, you can create them by using wizards provided in AFP Resource Installer. See the online help for details about the wizard.

If you use AFP Resource Installer to create a CMR, the software automatically installs the CMR in a resource library. You can also use AFP Resource Installer to install CMRs that you get from your printer manufacturer.

1.2.1.4.5.2 Data Objects

Presentation data objects contain a single type of data (such as GIF, JPEG, and TIFF images) and can be used in your print jobs. These data objects can be placed directly in a page or overlay or can be defined as resources and included in pages or overlays. Using a data object as a resource is more efficient when that object appears more than once in a print job; resources are downloaded to the printer just once and referenced as needed.

Data objects can either be included inline with a print job or installed in a resource library by using software such as AFP Resource Installer. If you install your data objects in a resource library, you can associate color conversion CMRs with them.

1.2.1.4.5.2.1 Types of Data Objects

Image data objects can be stored in a number of different formats, including AFPC JPEG Subset, EPS, GIF, IOCA, PDF, PNG, and TIFF. These image types are device-independent so they can be used by different systems and still be interpreted consistently.
  • AFPC JPEG Subset (JPEG)

    AFPC (AFP Consortium) JPEG Subset files, formerly called JPEG File Interchange Format (JFIF) files, are bitmap image files that are compressed by using Joint Photographic Experts Group (JPEG) compression. As a result, AFPC JPEG Subset files are most commonly referred to as JPEG files. JPEG files most commonly use the file extension .jpg, but can also use .jpeg, .jpe, .jfif, and .jif.

    JPEG compression deletes information that it considers unnecessary from images when it converts them. JPEG files vary from having small amounts of compression to having large amounts of compression. The more an image is compressed, the more information is lost. If the image is compressed only once, there usually is no noticeable effect on the image. However, if the image is compressed and decompressed repeatedly, the effects of deleting information become more noticeable.

    JPEG compression is commonly used for photographs, especially photographs that are transmitted or displayed on Web pages. The compression makes the files small enough to transmit on a network efficiently, but leaves enough information that the image is still visually appealing.

  • Encapsulated PostScript (EPS)

    EPS is a PostScript graphics file format that follows conventions that Adobe Systems defined. EPS files support embedded ICC profiles.

  • Graphics Interchange Format (GIF)

    GIF files are bitmap image files that are limited to a palette of 256 RGB colors. Because of the limited color range that it can contain, GIF is not a good format for reproducing photographs, but it is generally adequate for logos or charts. GIF images are widely used on the Internet because they are usually smaller than other image formats. GIF files use the file extension .gif.

  • Image Object Content Architecture (IOCA)

    IOCA is an architecture that provides a consistent way to represent images, including conventions and directions for processing and exchanging image information. The architecture defines image information independently of all data objects and environments in which it might exist and uses self-identifying terms; each field contains a description of itself along with its contents.

  • Portable Document Format (PDF)

    PDF is a standard file format that Adobe Systems developed.

    PDF files can be used and stored on various operating systems and contain all the required image and font data. Design attributes in a PDF are kept in a single compressed package.

      Note:
    • Single-page and multiple-page PDF files can be used as data objects in AFP print jobs.
  • Portable Network Graphics (PNG)

    PNG files are bitmap image files that support indexed colors, palette-based images with 24-bit RGB or 32-bit RGBA colors, grayscale images, an optional alpha channel, and lossless compression. PNG is used for transferring images on the Internet, but not for print graphics. PNG files use the file extension .png.

  • Tagged Image File Format (TIFF)

    TIFF files are bitmap image files that include headers to provide more information about the image. TIFF files use the file extensions .tif or .tiff.

    TIFF files support embedded ICC profiles. If an ICC profile is embedded in a file, the characteristics of the input color space are known whenever the file is used; however, the profiles increase the file size. When you save a file in the TIFF format, you can use various compression algorithms.

      Note:
    • Single-image and multiple-image TIFF files can be used as data objects in AFP print jobs.

Not all printers support all types of data objects.

The embedded ICC profiles in EPS, JPEG, and TIFF files contain the information that a printer uses to convert colors in the image from an input color space into the profile connection space (PCS). The input color space is either an industry-standard space or a custom space that describes the color reproduction capabilities of a device, such as a scanner, digital camera, monitor, or printer.

1.2.1.4.5.2.2 Data Object Creation and Installation

You can use a wide variety of software applications to create or manipulate images to include in print jobs. If you want to store them in central resource repositories, you can use AFP Resource Installer to install them.
Data object creation

Most types of data objects are images of some kind. Examples include: photographs taken with a digital camera; charts or diagrams generated by a software tool; and digital drawings created using graphics software. Regardless of how images are created, you generally need to manipulate them to include them in print jobs.

The changes include:

  • Convert the image into a file type that is appropriate for printing. For example, the file types that many graphics applications (such as Adobe Illustrator, CorelDRAW, and Corel Paint Shop Pro) use to store images while you work on them are not appropriate for printing. To use images that you create from any of those programs, you can save or export those files as a different file type, such as EPS, JPEG, or TIFF.
  • Make sure that your image files are associated with an appropriate color space or input profile. Follow the instructions provided with your graphics software to set up color management, including installing and using ICC profiles for digital cameras and monitors, and customizing color management settings. The instructions should also explain how to change the color profile that an image uses and how to save an image with an embedded profile.
  • Follow the tips and best practices provided in the other sections below for creating images and managing them as data object resources.

Data object installation

You can use AFP Resource Installer to install your images in a resource library. AFP Resource Installer includes wizards that can guide you through the process of installing an image as a data object. When you install an EPS, JPEG, or TIFF image with an embedded ICC profile by using AFP Resource Installer, you can choose how you want to handle the profile:

  • Leave the profile in the file without creating a CMR.
  • Leave the profile in the file, but also copy the profile and create a CMR from the copy. Associate the new CMR with the data object.
  • To reduce the file size, remove the profile from the file and make the profile into a CMR. Associate the new CMR with the data object.

1.2.1.4.5.3 Resource Library Management

If you store CMRs and data objects in central resource libraries, you must understand some of the characteristics of resource libraries to make sure that your resources are available when and where you need them.

Resource libraries that AFP Resource Installer creates use a resource access table (RAT) as the index of the resource library. The index is stored as a file in the library that it refers to. You must store CMRs in resource libraries that use a RAT. We recommend that you store data objects in resource libraries that use a RAT as well.

When you use AFP Resource Installer to create a resource library, it creates a RAT and stores it in the library. When you install a CMR or data object, AFP Resource Installer updates the RAT with information about the resource. When a print server looks in a resource library for a resource, it first looks in the RAT to see if the resource is listed.

The print server relies on the RAT; if it is incorrect, the print server cannot find resources in the resource library. As a result, you must always use AFP Resource Installer to manage your resource libraries, including to:

  • Add CMRs and data objects to a resource library.

    Do not copy CMRs or data objects directly into the resource libraries that AFP Resource Installer uses. If you copy CMRs or data objects into these resource libraries, the RAT is not updated so the print server cannot use it to find the CMRs or data objects.

  • Modify properties of data objects and CMRs listed in the RAT.

    Do not directly edit the RAT or any of the files in a resource library. Do not replace an existing version of a CMR or data object with a new version by copying the new version directly into the resource library; use AFP Resource Installer to update the resource.

  • Install CMRs or data objects in a different resource library or replicate a resource library in a different location.

    Do not copy CMRs or data objects from a resource library and store them in another location.

For more information about completing these tasks, see the AFP Resource Installer online help.

1.2.1.4.5.4 Tips and Best Practices

These general guidelines about creating and managing images and other color resources can improve the performance of your AFP color printing system.

1.2.1.4.5.4.1 Tips for images

To optimize the performance of your AFP color printing system, we recommend that you follow some guidelines for creating and including images in print jobs.

When you want to use color images in your print jobs:

  • Get the original electronic versions of images instead of scanning existing documents.

    Almost unnoticeable specks of color in the background of images that have been scanned can greatly increase the size of the image. If you must scan an image, use an image editing tool to clean up the background as much as possible.

  • Save all images in the same standard color space so you only need one input profile for all of them.

    Adobe RGB (1998) is the recommended color space for images that are to be printed.

  • Flatten multi-layer images (such as the ones you can create in graphics tools like Adobe Illustrator and Corel Paint Shop Pro) before including them in print jobs.

    Unflattened images are extremely large and more difficult to work with. Save a copy of the original image for future editing, but flatten the version that you include in your print job.

1.2.1.4.5.4.2 Tips for Resources

To optimize the performance of your AFP color printing system, we recommend that you follow some guidelines for managing color resources.

You can use AFP Resource Installer to:

  • Install all the CMRs for your printer in a resource library.
  • Install the data objects that you use frequently in a resource library.
  • Mark the CMRs and data objects that are reused regularly as non-private, capturable resources so they can be saved on the printer and used for other print jobs without being downloaded every time.
      Note:
    • This option is not advisable for secure resources, such as signature files.
  • Install CMRs and data objects in resource libraries that the print server can access, so they only need to be stored in one place and can be used by all print servers.
  • Associate audit color conversion CMRs with data objects that require color management, so the embedded profiles can be removed from the image files.

1.2.1.4.6 RICOH AFP color and grayscale products

Ricoh provides a variety of products that support AFP color and grayscale printing. They can be used in various combinations to create color workflow solutions.

The RICOH products that support AFP color management
The image shows the RICOH products that can be included in a color printing solution. The products are InfoPrint AFP Resource Installer, Page Printer Formatting Aid, InfoPrint Manager, RICOH ProcessDirector, InfoPrint 4100, and InfoPrint 5000.

1.2.1.4.6.1 Printers

Some RICOH printers support color or grayscale printing with full AFP color management, while others support AFP color printing without color management.

1.2.1.4.6.1.1 InfoPrint 5000

The InfoPrint 5000 is a full-color, high-speed, continuous forms Intelligent Printer Data Stream (IPDS) printer that supports AFP color management.

The InfoPrint 5000 uses piezo-electric drop-on-demand inkjet technology with water-based pigment inks that are designed to resist fading and smearing.

The InfoPrint 5000 receives AFP print jobs from RICOH print servers. When used as part of a full AFP color management system, the InfoPrint 5000 can receive color conversion, link, and tone transfer curve CMRs and apply them to print jobs. Because the printer engine applies its own halftones, it does not support halftone CMRs.

The InfoPrint 5000 can capture resources and store them in a repository in its controller so they can be reused in other print jobs. The printer only captures resources that are marked non-private and capturable using an application such as AFP Resource Installer.

You can also submit PostScript and Portable Document Format (PDF) jobs to hot folders on the InfoPrint 5000, but those print jobs are not processed using AFP color management.

1.2.1.4.6.1.2 InfoPrint 4100

The InfoPrint 4100 family of printers uses a laser, electrophotographic print technology and Advanced Function Presentation (AFP) licensed programs to create high-quality text and graphics output. InfoPrint 4100 printers with the InfoPrint POWER architecture and microcode release 15.4 or later support the AFP color management architecture and can be used to print very high-quality grayscale images.

The base level of AFP color management support in InfoPrint 4100 printers with the InfoPrint POWER architecture and microcode release 15.4 or later lets you apply color management to grayscale text, graphics (GOCA), bi-level images (IOCA FS10), and barcodes. To use color management functions with other types of objects, the AFP Color Emulation feature is required.

The AFP Color Emulation feature lets you print color objects in grayscale. When the feature is installed, AFP Color Management lets you natively print GIF, IOCA FS11, IOCA FS45, JPEG, and TIFF images in high-quality grayscale.

    Note:
  • Single-page PDF and EPS data objects are not supported on the InfoPrint 4100.

InfoPrint 4100 printers support these types of CMRs:

  • Color conversion
  • Link color conversion
  • Tone transfer curve
  • Halftone

For even better images on InfoPrint 4100 Models MS1, MD1, and MD2, you can also install the Image Enhancement feature. Benefits of this feature include:

  • Enhanced fusing technology to minimize toner distortion
  • Optimized developer unit for high coverage and high-density applications
  • Improved halftones tailored to new hardware and toner technology

1.2.1.4.6.1.3 InfoPrint 1xxx series

The InfoPrint 1xxx series of workgroup printers and multifunction devices includes a wide range of cut-sheet color and monochrome devices, although they do not support AFP Color Management.

For general office purposes, the InfoPrint 1000 series lets you manage color output efficiently and cost-effectively through advanced technologies such as access controls, confidential print, and data stream encryption. Through the 1000 family of printers, Ricoh offers output strategies and color printers that address diverse requirements for high quality, security, and cost.

1.2.1.4.6.2 RICOH AFP Resource Installer

RICOH AFP Resource Installer is a key element of an AFP color management system when resources are stored in central libraries. You can use it to create, install, and manage color management resources (CMRs) and data objects for use in your system.

AFP Resource Installer is a Java application that you install on a Windows workstation. You can use it to install and work with fonts in addition to CMRs and data objects.

You can use AFP Resource Installer to:

  • Create CMRs from existing data, including ICC profiles.

    You can use a wizard to guide you through the process.

  • Install CMRs, fonts, and data objects in resource libraries on the local system or on any system that you can access with FTP.
  • Associate CMRs with data objects, so data objects can be reproduced accurately on different printers.

    In some cases, you can reduce the file size of your images by removing the embedded color profile from the file and using an associated CMR.

  • Mark resources as capturable.

    Capturable resources can be captured and saved in the printer for use with other print jobs, which can help improve system performance. The print server queries the printer before it sends any resources; if the printer already has the resource, the print server does not have to send it.

  • Mark resources as private.

    Private resources cannot be captured in the printer and must be downloaded with every print job that uses them. For example, you can mark signature files used for company checks as private for security reasons.

When you use AFP Resource Installer to install a color conversion CMR, the software automatically creates link (LK) CMRs between the new color conversion CMR and the existing color conversion CMRs. When a print file references the new CMR, the print server automatically downloads the link CMRs that match the target device type and model and sends them to the printer with the print job. If one of those link CMRs is appropriate, the printer can use it instead of having to spend extra time creating a link CMR.

To let a print server use resources installed by AFP Resource Installer, you must add the path to the resource libraries to the AFP resource path in the server.

1.2.1.4.6.3 Print servers

RICOH print servers receive print jobs from various sources and prepare them to be sent to a printer. After print jobs have been prepared, the print server interacts with the printer to make sure that all the required resources are available, then sends the print job data to be printed.

Several different print servers are available. Although they provide much of the same function, they are appropriate for different environments.

1.2.1.4.6.3.1 RICOH InfoPrint Manager

RICOH InfoPrint Manager is a flexible and scalable print management solution for AIX, Linux, or Windows that provides many choices in expanding and managing your print environment. RICOH InfoPrint Manager can process print jobs that contain references to color management resources and interact with centralized resource libraries.

When RICOH InfoPrint Manager receives AFP or line data print jobs, it processes CMRs and data objects similar to the way it processes other AFP resources. You can add the resource libraries that you create using AFP Resource Installer to the Location of presentation object containers property (also called the resource-context-presentation-object-container attribute) of your actual destinations. Then, RICOH InfoPrint Manager can search those resource libraries to find data objects and CMRs when print jobs request them.

1.2.1.4.6.3.1.1 Enabling capture for CMRs

If the jobs that run through your system use the same CMRs, you might want to enable your actual destination to capture inline CMRs.
These inline CMRs must have an object identified (OID) so RICOH InfoPrint Manager can capture them.
From the RICOH InfoPrint Manager Administration GUI:
  1. Click on the actual destination and select Printer Properties.
  2. From the actual destination's Printer Properties notebook, click the Tuning tab.
  3. Find the Capture inline CMR resources radio button.
    If you can't see the Capture inline CMR resources radio button, click Show more.
  4. Scroll to the bottom of the screen and click the Yes radio button for the Capture inline CMR resources setting.

1.2.1.4.6.3.1.2 Page Printer Formatting Aid (PPFA)

PPFA is a feature of RICOH InfoPrint Manager that lets you create form definitions and page definitions for use with your AFP print jobs. You can use PPFA to associate CMRs with form definitions and page definitions for your color print jobs.

The form definitions and page definitions that you create using PPFA can be used in print jobs that are sent to RICOH InfoPrint Manager and RICOH ProcessDirector.

1.2.1.4.6.3.2 RICOH ProcessDirector

RICOH ProcessDirector is a database-driven print workflow system that lets you manage all aspects of your printing process. The server runs on Linux or Windows systems and is accessed using a Web browser-based interface. RICOH ProcessDirector can receive and process AFP print jobs that include AFP color management objects.

RICOH ProcessDirector can also receive line data print jobs that refer to CMRs and data objects and convert them into AFP using a step based on the ConvertLineDataJobIntoAFP step template.

RICOH ProcessDirector processes CMRs and data objects similar to the way it processes other AFP resources. You can add the resource libraries that you create using AFP Resource Installer to the AFP resource path property on a print job or in the job defaults for your workflows. Then, RICOH ProcessDirector can search those resource libraries to find data objects and CMRs when print jobs request them.

1.2.1.4.7 AFP color solution scenarios

AFP color solutions from Ricoh can be assembled in a variety of configurations based on your environment and needs.

1.2.1.4.7.1 Printing high-quality grayscale output on an InfoPrint 4100 printer

An insurance company wants to migrate to AFP color printing slowly, so they start the process by using AFP color management to print high-quality grayscale output on their InfoPrint 4100 printers.

The insurance company runs an in-house print shop that has four duplex InfoPrint 4100 lines. They use a document composition tool to create AFP print jobs and submit the jobs to InfoPrint Manager for Windows, which they use to balance the printing loads and keep all the printers running as much as possible.

They have decided that they want to add images to some of their output. To start, they want to add photographs of their insurance agents to the letterhead on letters to their clients. They are not ready to move into full color printing, so they want to print black and white images using their existing printers. Unfortunately, they have not been satisfied with the appearance of the images; they are too black and one-dimensional, so they look unprofessional.

The solution

The Ricoh team suggests these changes to improve image quality:

  • Upgrade the printer to use a controller with the InfoPrint POWER architecture with microcode release 15.4 or later.

    This update adds support for the AFP color management, which includes high-quality grayscale printing using halftones and tone transfer curves.

  • Purchase and install the AFP Color Emulation feature for the printer.
  • Use AFP Resource Installer to manage the images, including associating them with the correct halftones and tone transfer curves to create the best quality output.

Solution diagram for adding AFP Resource Installer and a resource library, and updating one InfoPrint 4100 printer line to use microcode release 15.4 and the AFP Color Emulation Feature.
The image shows a flowchart that shows the new system as described in the text.
Implementation

To implement the solution, the print shop works with their Ricoh representatives to upgrade one of their print lines to try the new function. They:

  • Upgrade the print controller to the microcode release 15.4 or later.
  • Install the AFP Color Emulation feature on the printer controller.
  • Install AFP Resource Installer.
  • Use AFP Resource Installer to:
    • Create and install the color conversion CMRs for the InfoPrint 4100 printer and for the digital camera used to take the photographs.
    • Choose the generic halftone and tone transfer curve CMRs to use with the InfoPrint 4100 based on the line screen frequency and appearance values that you want to use.
    • Install the photographs of the insurance agents in a resource library, then associate them with the appropriate CMRs.
  • Update the RICOH InfoPrint Manager destinations so they send the print jobs that contain photographs to the printer line that has the AFP Color Emulation feature installed.
  • Create print jobs that call the images using the names that they were given when they were installed.

1.2.1.4.7.2 Replacing pre-printed forms

A bank wants to reduce the amount of paper that it stores. If the bank eliminates some of the pre-printed forms that they use by printing some statements on a color printer, they can use the same type of plain paper for various applications.

Over the last five years, the bank has purchased ten smaller banks and is in negotiations for several others. The parent bank uses an AFP system to print statements in-house on pre-printed forms. All the pre-printed forms contain color logos. Some of them also contain background images or blocks of color that divide the page into regions. The existing system consists of:

  • RICOH InfoPrint Manager, including the Page Printer Formatting Aid (PPFA) feature
  • Three duplex InfoPrint 4000 lines
  • Two duplex InfoPrint 4100 lines
Print jobs are submitted as line data and RICOH InfoPrint Manager transforms them into AFP. AFP resources are stored in a central location. There are no color production printers in use.

The banks that were acquired handled printing in different ways. Some of them had their own print shops; some of them outsourced print to other companies. The print staff at the parent bank has spent a significant amount of time moving the printing operations of the acquired banks to their in-house print operation, starting with the ones that outsourced their print. Five of them have been converted. The print shop administrators are starting to face some interesting issues:

  • The increased workload for the in-house operation means that they need to increase their print capacity.
  • Each of the banks that the parent has purchased has maintained its own logo and branding. Each time one of the banks has been integrated with print operations, it has brought with it at least five different pre-printed forms that need to be ordered and stored.
  • Even though each kind of pre-printed form comes from the same vendor, the colors vary noticeably.
  • The acquired banks will eventually replace their old logos and forms with the logo and forms of the parent bank, but the dates are not yet planned.

With the increase in the number of forms that must be stored, space is becoming a problem. The team knows that they have to expand printing capacity, but they do not have space for a new duplex line. If they could eliminate some of the paper that they have to store, they could use that space for the new line.

The solution

The Ricoh team proposes an AFP color solution to:

  • Transform their pre-printed forms to simple color statements and eliminate the need for pre-printed forms, thus reducing the paper that needs to be stored.
  • Streamline the process of moving the acquired banks to the parent bank’s logo and forms.
  • Optimize resource management to maximize throughput.
  • Make the colors more uniform from job to job.

The solution adds a duplex InfoPrint 5000 line and AFP Resource Installer to the existing system and updates the other components to add AFP color support. The bank can choose which applications to move to the color workflow, taking into consideration the fact that the throughput of the InfoPrint 5000 line is less than that of an InfoPrint 4100 line. In addition, those print jobs cannot be run on the existing InfoPrint 4100 or InfoPrint 4000 printers, since those printers cannot print the required color elements.

As the printing staff becomes proficient in using the system, they can start to prepare more applications for an eventual move to color by migrating them to use the high-quality grayscale function available on their InfoPrint 4100 printers. Then, when they are ready to add another color line (either by eliminating more paper storage or by replacing one of the InfoPrint 4000 lines), they can move those print jobs to the color printers.

Solution diagram for adding RICOH AFP Resource Installer and an InfoPrint 5000 printer
The image shows a flowchart of the solution described in the text.
Implementation

To implement the color solution, the bank printing staff works with the Ricoh team through several phases:

  • Planning the color solution
    • Determine where the resource library should be located so that it is accessible to all the applications that need to use it.
    • Determine which types of resources can or should be saved on the printer for reuse. For example, signature files should probably not be saved on the printer; company logos and background images probably should be saved.
  • Installing and configuring the system
    • Install the InfoPrint 5000 printers.
    • Apply service updates to RICOH InfoPrint Manager and PPFA to add color support.
    • Install AFP Resource Installer.
  • Configuring resource management for optimal performance
    • Use AFP Resource Installer to install the CMRs for the InfoPrint 5000 printers.
    • Get the PDF file of the pre-printed form or use graphic art software to create a full page image to use as the background image.
    • Use AFP Resource Installer to install the PDF or image as a data object resource and associate a color conversion CMR with it.
    • Configure RICOH InfoPrint Manager to recognize the resource libraries that AFP Resource Installer uses and to send print jobs to the new printer.
    • Use PPFA to create a form definition and page definition that calls the new data object resource.

      Refer to the object using the ID that you specified when you installed it.

    • Copy any new form definitions or page definitions that you created into an existing resource library.
  • Testing system operations
    • Create a print job that calls the form definition and page definition, and that points to the new resource libraries.
    • Submit the print job.
    • Check the color output.

1.2.1.4.7.3 Eliminating physical inserts

A print service bureau wants to reduce the number of physical inserts that they have to add to envelopes by printing full color electronic inserts in blank areas on credit card statements.

The print service bureau prints statements and one-to-one advertising brochures for a variety of customers. The customers send their resources and print job data to the service bureau. The pre-press staff uses a document composition tool to create AFP jobs. The AFP print jobs are submitted to RICOH ProcessDirector, which sends them to ten duplex InfoPrint 4100 systems. After the jobs are printed, they go to post-processing to be folded, inserted, and mailed.

The service bureau asks all their customers to submit required resources with every print job; they do not store resources indefinitely. Many of their customers (such as credit card companies) include inserts in the envelope with their statements. Some problems with this arrangement are:

  • Inserters often ruin mailpieces, so they frequently have to reprint individual statements. Reprinting adds time and cost to the process.
  • Customers tend to ignore the inserts, separating them from the statement immediately after opening the envelope and discarding them.

The service bureau would like expand its offerings to include full-color variable-data printed using an AFP color solution. They also think that they can save time, money, and paper by reducing the complexity of the tasks that their inserters do. If the inserter only has to fold each statement and put it in an envelope (instead of adding two more sheets of paper, folding, and inserting), it has fewer opportunities for ruining mailpieces.

The solution

The service bureau works with the Ricoh team to create a solution based on its existing process and environment that will help their customers move away from using physical inserts for advertising and toward electronic inserts. They hope to eliminate one of their inserters by printing full color ads directly in blank areas or on sides of customer statements.

If a credit card company can identify data and rules that determine the characteristics of each customer, the electronic inserts can be targeted for each statement. For example, the bill could show an ad for a minivan, a sports car, or a motorcycle depending on the demographics of the customer.

Implementation

To take advantage of this new color capability, the service bureau makes a few changes to their workflow:

  • They add a duplex InfoPrint 5000 system and configure RICOH ProcessDirector to submit print jobs to it.
  • They give guidelines to their customers so that it includes guidelines for using color images and logos in addition to fonts and graphics.
  • They train the pre-press department is trained to use a graphics application for color profile management and image normalization.
  • They add a step to their process to make sure that their customers have followed the guidelines. If they have not, the pre-press staff adjusts the resolution and input color profiles to conform to the guidelines before they submit the print job.

1.2.1.4.8 Related publications

You can find more information about AFP color printing on the Web sites of Ricoh and the AFP Color Consortium.

For more information about the AFP color management and the Color Management Object Content Architecture, see:

  • AFP Color Management Architecture, G550-0526
  • Color Management Object Content Architecture Reference, S550-0511

These AFP Architecture reference books contain information about color management resources:

  • Mixed Object Document Content Architecture Reference, SC31-6802
  • Advanced Function Presentation: Programming Guide and Line Data Reference, S544-3884
  • IPDS Reference, S544-3417

To download or order these publications or, for more information about the activities and publications of the AFP Color Consortium, see the Consortium Web site:

http://afpcinc.org

For more information about the ICC, ICC profiles, and the PCS, see the ICC Web site: http://www.color.org

1.2.2 Installing and uninstalling

After installing RICOH ProcessDirector on the primary computer, test your installation. You can then install application servers, secondary servers, and other features or extensions.

1.2.2.1 Verifying the installation

If you have finished installing RICOH ProcessDirector and want to verify the installation, use this procedure to enable the Sample printer, submit a test job to the HotFolderPDF input device, and process the job.
This verification procedure only applies to new installations. When you upgrade an existing installation, RICOH ProcessDirector does not create a Sample printer.
To verify the installation:
  1. If you are not logged in to the RICOH ProcessDirector user interface, log in.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. On the command line, enter this command to copy a test file into the hot folder that the HotFolderPDF input device monitors:
    • cp /aiw/aiw1/testfiles/Demo.pdf /aiw/aiw1/System/hf/defaultPDF
  4. Wait a few seconds for the RICOH ProcessDirector user interface to refresh. If it does not refresh automatically, refresh your browser.You should see a job in the Jobs table on the Main page. The job's Phase should be Complete, and its State should be Retained.
  5. Right-click the job and select View Log. The log should show that the job printed. For example, if the job ID is 10000000, the log should show message AIWI0016I: 10000000 printed. The job does not print on a real printer.
    This verifies that RICOH ProcessDirector is installed correctly.
The PDF workflow processes jobs that are submitted to the HotFolderPDF input device. During the Prepare phase, the workflow runs a RunExternalProgram step. This step is an example of how you can integrate other programs into your workflow. The step produces a CSV file with information about the job. To see the type of information that you can access with a step in a workflow, look at the output in the CSV file. The file is in the /aiw/aiw1/samples directory. The file name is the job ID followed by info.csv. For example, 10000000.info.csv.

    Note:
  • Your software installs in trial mode. The trial license expires after 60 days.

1.2.2.2 Setting up application and secondary servers

After successfully installing the base product, you can set up application and secondary servers on other computers in your network.
Secondary servers run on Linux computers; application servers run on Windows computers.
    Note:
  • If you only want to create local secondary servers on the primary computer, you do not have to complete these procedures.
Secondary servers created on other computers use the Network File System (NFS) protocol to access the /aiw file system on the primary server. Application servers can use NFS or a different protocol to access the /aiw file system. Some configuration is required on both the primary computer and the secondary computers to enable that access.

After you configure the communication protocol between the computers, you install the Secondary Server feature or the Application Server and define the server object in RICOH ProcessDirector.

1.2.2.2.1 Installing remote secondary servers

Follow these procedures to install a Secondary Server feature on an Linux computer that is separate from your primary computer.

1.2.2.2.1.1 Preparing the primary computer

Before you install any application or remote secondary servers you must export the /aiw file system and create an application or secondary server object in RICOH ProcessDirector. If you plan to use NFS on an application server, you must also verify that an NFS server is installed and started on the primary computer. If you plan to use Samba on an application server, you do not need to install NFS.

After you configure NFS, Samba, or your preferred protocol, use the RICOH ProcessDirector user interface to add and enable the application or secondary server.

1.2.2.2.1.1.1 Configuring the primary server to use NFS

To use NFS on an application server, you must verify that an NFS server is installed and started on the primary computer so the /aiw filesystem is accessible.
To configure the primary server to use NFS:
  1. Verify that the NFS server on the primary computer is installed and started.
    On a SLES primary computer:
    1. In YaST, click Network Services NFS Server.
    2. Verify that Start is set and then click Next. You see that /aiw is one of the available directories.
    3. Click Finish.

    On a Red Hat, CentOS, or Rocky Linux primary computer:

    1. Open a command prompt and type this command:
      • systemctl list-unit-files | grep nfs
    2. In the results, verify that the nfs-server.service and nfs-lock.service services are listed. For supported Red Hat and Rocky Linux 8.x and 9.x versions, verify that rpc-statd.service is listed. If either one is not included in the list, use Yum to install it.
      Open a command prompt and type this command, replacing service with the name of the service or services to install:
      • yum install service
    3. Start or restart the nfs-server.service and nfs-lock.service services.
      For Red Hat 7.6 through latest 7.X, type these commands:
      • systemctl restart nfs-server.service
      • systemctl restart nfslock.service
      • systemctl enable nfs-lock.service
      • systemctl enable nfs-server.service
    For supported Red Hat and Rocky Linux 8.x and 9.x versions, type these commands:
    • systemctl restart nfs-server.service
    • systemctl restart rpc-statd.service
    • systemctl enable rpc-statd.service
    • systemctl enable nfs-server.service
  2. Update the exports file so the primary computer can connect to one or more secondary or application computers:
    1. Open /etc/exports in a file editor.
    2. Add lines to create exports for the secondary or application computers. Follow this format, replacing serverN with the host names of the secondary or application computers.
      • For a Linux secondary computer, use these parameters:
        • /aiw server1(rw,no_root_squash,sync)
      • For an application server, use these parameters:
        • /aiw server1(crossmnt,rw,no_root_squash,sync,no_subtree_check)
      • For multiple application or secondary servers, include each server as an entry on the same line.

        As an alternative, type a space and a backslash (\) to continue on another line:

        /aiw server1 \
        (crossmnt,rw,no_root_squash,sync,no_subtree_check) \
        server2(crossmnt,rw,no_root_squash,sync,no_subtree_check) \
        server3 (crossmnt,rw,no_root_squash,sync,no_subtree_check)

    3. Save the file and exit the editor.
  3. Restart the NFS server so it uses the updated file.
    • On SLES, type:
      • systemctl restart nfsserver
    • On Red Hat 7.6 through 7.X and CentOS, type:
      • service nfs restart
    • On supported Red Hat and Rocky Linux 8.x and 9.x versions, type:
      • systemctl restart nfs-server.service
  4. If your network does not have a Domain Name System (DNS) server, edit /etc/hosts on the primary computer to add the host name and IP address of the computer that is prepared for the application servers or Secondary Server feature.

1.2.2.2.1.1.2 Defining application and remote secondary servers

After you configure NFS, Samba, or your preferred protocol, you must create the application or secondary server in RICOH ProcessDirector.

To define the application or secondary server:

  1. Open a Web browser and enter http://hostname:15080/pd in the address bar replacing, hostname with the host name of the primary computer.
  2. Log in to RICOH ProcessDirector.
  3. Click the Administration tab.
  4. In the left pane, click Objects Servers.
  5. On the Servers page, click Add and choose the type of server you are creating.
  6. Specify a server name and the IP address or host name for the application/secondary computer. As an option, specify a description and values for the other properties of the server.
  7. Choose an option for the In general server pool field.
    Servers in the general server pool can run any step defined in any workflow.

    For a secondary server, you can specify either Yes or No. If you want the secondary server to run only specific steps, specify No in this field and then tune each step template that you want to run on the secondary server.

    For an application server, specify No for In general server pool.

      Note:
    • If any external steps send jobs to the application server, you must tune the step template appropriately.
  8. Click OK.
  9. In the left pane, click Objects Servers.
  10. Select the server and then click Enable.

1.2.2.2.1.2 Installing on Linux systems

You can install the RICOH ProcessDirector Secondary Server feature on a Linux system in your network.
    Important:
  • Secondary Server features are not required to have the same level of code as the base product. However, we recommend checking and upgrading the secondary server whenever the primary server is upgraded. To determine the level of code that is installed on either computer, enter this command:
    • echo $AIW_VERSION
  • Before you begin this procedure, make sure that you followed the steps from Preparing the primary computer.

To install the Secondary Server feature on a Linux system:

  1. Log in as the root user.
      Important:
    • You must log in as a user with UID 0. If you must log in as a different user, you can use sudo su - or su - to become the root user. However, do not use sudo or the su command in any other way to become the root user.
  2. Make sure that /etc/hosts on this computer has an entry for its IP address and the fully qualified host name.
  3. Open a command line and enter this command to make sure you are in the root directory:
    • cd /
  4. Insert the RICOH ProcessDirector Secondary Server feature DVD.
  5. To determine the name of the mount point, enter:
    • ls /media
    On some systems, the name of the mount point is the same as the name of the DVD.
      Note:
    • If you are using a Red Hat Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:
      • mount -t iso9660 -o remount, exec <mount_point>
      You must remount the drive for every DVD that you insert.
  6. Mount the drive, if necessary. Enter:
    • mount /media/mount_point
  7. Change directories so you can see the contents of the DVD. Enter these commands:
    • cd /media/mount_point
    • ls
    You see several scripts and directories, including a script called setup.
  8. To start the installer, enter: ./setup
    • ./setup IPPDs

    The installer starts and displays the Introduction screen. Select the appropriate language for the installer to use and then click OK.

      Note:
    • If the computer's operating system is a supported Red Hat-derived operating system and its language is Japanese, Simplified Chinese, or Traditional Chinese, choose English on the dropdown language menu. Japanese, Simplified Chinese, and Traditional Chinese characters do not display properly during a Red Hat installation of RICOH ProcessDirector.
  9. Follow the instructions in the installer.

    The installer verifies many of the prerequisites for the system. If it finds any problems, it lists them for you. You cannot proceed until you correct them. After you fix the issues, verify the prerequisites again by returning to the Prerequisite Verification window. Click Previous in the installer or type back in console mode, then continue with the installer.

      Important:
    • After you verify all the prerequisites, click Cancel to change a previous entry and begin the installation process again. Clicking the Previous button sometimes causes problems.

  10. Review and accept the license and maintenance agreements.
  11. Type the host name or fully qualified IP address of the primary computer and verify it.
  12. Enter the name of the RICOH ProcessDirector system user that you used on the primary computer. The default system user is aiw1.
      Note:
    • All Linux operating system user IDs and group names must be 1-8 characters because of a restriction in DB2. You cannot create a user ID that includes international characters (such as á, É, î, ñ, ô, ß) or double-byte characters.

    If the installer finds that the user already exists on the system, it asks if you want to use that user. If you did not create the user, choose No and enter a different name. If the installer does not find the user on the system, the installer creates it.

    Do not select the check box for Use system update file from another computer.

  13. Enter the values that you used on the primary computer for:
    • The security group to use as the primary group for the system user
    • The UID number for the user
    • The GID number for the group
    • The home directory for the system user

    The default values are shown in the installer.

    If you created the user and group before you started the installer, you are not asked for these values.

  14. Enter the same password that you used for the system user on the primary computer twice. Remember this password; you need it later when you have to log in as the system user. If you created the user before you started the installer, you are not asked for the password.
  15. Choose the language that you want the system user to use. This language determines the language used for some messages, even if you set the browser for the user interface to a different language.
  16. Review the pre-installation summary and click Install to start installing.
    The final window displays the URL for accessing the user interface in this format, where hostname is the host name of the primary computer:
    • http://hostname:15080/pd
  17. Click Done to complete the installation.
    The secondary server starts automatically.
  18. On the command line, type this command to return to the root directory:
    • cd /
  19. If you have installed from a DVD, eject the disc.
  20. Reboot the system.
      Note:
    • If you have an automated recovery mechanism for system outages, disable it before rebooting.
  21. To verify that the secondary server is running, enter this command on the command line:
    • ps -ef | grep Instance
    You should see an instance statement such as:
    • java com.ibm.aiw.instance.SecondaryInstance hostname

    If the software is not running, view the installation logs in the /opt/infoprint/ippd/logs directory. If this does not solve the problem, contact customer support.

  22. To make sure that the secondary server is connected to the primary server, log in to the RICOH ProcessDirector user interface and click Administration Objects Servers to verify that the Connection status column contains Connected.
After your secondary server is running, you must determine how it is used and change the properties of some objects accordingly. For example:
  • What printers and input devices do you want the secondary server to manage?

    Create or modify those devices so this secondary server is listed as their Parent server.

  • What step templates can run on this secondary server?

    Tune those step templates so that they can run on this secondary server.

  • What external programs on this secondary computer can be accessed using an external step?

    Set up the external program and configure a step based on the RunExternalProgram step template so it uses that program.

1.2.2.2.2 Creating a Docker container secondary server

Use this procedure to create a Docker container secondary server on a Linux system and connect it to your primary computer.
Before you begin this procedure, install Docker Engine 19.03 or above on the Linux computer that will host the container secondary server.
    Note:
  • On RICOH ProcessDirector for Linux, you can create Docker container secondary servers on the primary computer or on a separate Linux computer.

To create a Docker container secondary server:

  1. Contact Ricoh Software Support for assistance with this process.
    The Software Support team can help evaluate your system and determine whether this procedure needs to be modified to fit your needs.
  2. Download and install the Secondary Docker feature.
  3. If directed by Software Support, install the Secondary Server feature on the remote Linux computer that will host the Docker container secondary server.

    Follow the procedures outlined in Installing remote secondary servers . If you are installing a Docker container secondary server only on the primary computer, you do not have to install the Secondary Server feature nor configure NFS. Skip to step 7.

  4. If you did not install the Secondary Server feature:
    1. Configure NFS to communicate between the primary computer and the computer that will host the Docker container secondary server.

      Follow the procedure in Configuring the primary server to use NFS to set up NFS on the primary computer.

    2. On the computer that will host the Docker container secondary server, create this directory: /aiw, then mount it to the /aiw directory on the primary computer.
      Use this command: mount -t nfs primary computer IP address or hostname:/aiw /aiw
  5. On the computer that will host the Docker container secondary server:
    1. Create a Linux user ID with the same name as the RICOH ProcessDirector system user (aiw1 is the default). Add that user ID to the docker group.
    2. Change the ownership of the /aiw directory to the user you created.
  6. Log in to RICOH ProcessDirector.
  7. Create the server object to represent the Docker container secondary server.
    1. Click the Administration tab.
    2. In the left pane, click Objects Servers.
    3. On the Servers page, click Add Container secondary server
    4. Fill in the properties as appropriate.
    5. Click OK.
    RICOH ProcessDirector creates the server object and installs the container secondary server on the target system.
  8. When the installation process completes, start the container secondary servers. Log in to the computer that hosts the secondary container servers and run the command below.
      Note:
    • If you created the container secondary server on the primary computer, run the command on the primary computer.

      Replace directory with: /aiw

      The path_to_script is not required on the primary server.

    • If you created the container secondary server on a different computer, run the command from the secondary computer.

      On a secondary computer, you must provide the full path to the script on the primary computer, including the directory that is mounted to the /aiw directory on the primary server. In the command below, replace these values:

      • path_to_script

        The full path to the script on the primary server, including the mounted directory. If the mounted directory is /aiw (as in the procedure above), the value is: /aiw/aiw1/bin/

      • directory

        The full path to the directory that is mounted to the /aiw directory on the primary server. In the procedure above, this directory is also /aiw.

    • To start a specific container secondary server, replace [secondary_name] with the name of that server. Omit this value to start all of the container secondary servers present on the Linux computer.
    [path_to_script]containers.pl start directory[secondary_name]
    For example:
    • To start all the container secondary servers on the primary server:

      containers.pl start /aiw

    • To start one of four container secondary servers on a different computer:

      /aiw/aiw1/bin/containers.pl start /aiw secServContainer3

To stop the Docker container secondary servers, run this command on the computer that hosts them:

[path_to_script]containers.pl stop directory[secondary_name]

Follow the replacement instructions above for [path_to_script], directory and [secondary_name].

1.2.2.2.3 Preparing a Windows application server

When you install an application server on Windows, you are required to mount the /aiw file system from the primary computer so the Windows application server has write access to the /aiw file system as the system user (aiw1 is the default).
There are various ways to mount the /aiw file system on the primary computer from the application server. You can use any method to mount the file system. The procedures below use Samba and NFS file sharing as examples.

1.2.2.2.3.1 Connecting to the primary computer using Samba

To use Samba file sharing, you must configure Samba on the primary computer so the /aiw filesystem is accessible to the Windows application server. The share is then mounted on the Windows application server.
To connect to the primary computer using Samba:
  1. Log on to the primary computer as root.
  2. If Samba is not installed, install it.
  3. Configure Samba using a setup tool such as Yast. While the configuration procedure is similar between operating systems, commands or tools used might differ. Configure as follows:
    1. Enter the workgroup or domain name.
    2. Set RICOH ProcessDirector as a domain controller. RICOH ProcessDirector does not need to be set as a domain controller. This setting does not affect RICOH ProcessDirector functionality.
    3. Set Samba to start on boot.
    4. Share the /aiw drive as a share named aiw.
  4. Modify the smb.conf file located in /etc/samba/ to include lines similar to these:
    [global]
       workgroup = RPDWorkgroup
       passdb backend = tdbsam
       encrypt passwords = Yes
       restrict anonymous = 2
       domain logons = No
       domain master = No  
       security = user
       wins support = No
       ntlm auth = Yes
       min protocol = SMB2
       max protocol = SMB3
       client min protocol = SMB2
       client max protocol = SMB3
    
    [aiw]
        comment = RPD share
        inherit acls = Yes
        path = /aiw
        read only = No
        write list = root aiw1
        valid users = root aiw1
        force create mode = 0664
        force directory mode = 0775
        guest ok = No
    
      Note:
    • These settings are suggestions for the contents of smb.conf; they are not necessarily the exact settings you should use. The global section likely contains additional lines. Leave the additional lines in the file. Additional sections can be commented out or deleted to prevent other parts of the system from being shared through Samba.

      This configuration file must have read and write privileges from the Windows machine as the system user (aiw1 is the default).

    • You must enable the SMBv2 and SMBv3 protocols on the Samba server to avoid any connection errors.
  5. Optional: Add the following lines to the smb.conf under the [aiw] section to increase security:
    valid users = root aiw1
    hosts allow = windowspc
      Note:
    • Replace windowspc with the name of the application server and aiw1 with the system user ID if you do not use the default.
  6. Save the smb.conf file.
  7. Restart the Samba daemon.
  8. Run the command smbpasswd -a root and enter the password for root.
  9. Run the command smbpasswd -a system_user, where system_user is the system user ID (aiw1 is the default), and enter the password for the system user.
  10. On the application server, map the /aiw filesystem from the primary computer using the Map Network Drive dialog in Windows and this address for the server:
    \\<primary_server_hostname>\aiw
    To map the network drive from a command prompt, use this command:
    • net use <drive_letter>: \\primary_server_hostname\aiw

    To give read and write permission on the mapped Samba folder, use this command:

    • setsebool -P samba_export_all_rw 1

    Replace primary_server_hostname with the hostname or IP address of the primary computer.

  11. Test the configuration by creating a file in the drive_letter:\aiw1 directory and then deleting it.
  12. Note the name of the drive for use during the installation process.
  13. Continue with Installing application servers on Windows computers.

1.2.2.2.3.2 Connecting to the primary computer using NFS

To use NFS file sharing, you must configure NFS on the primary computer so the /aiw filesystem is accessible to the Windows application server. The share is then mounted on the Windows application server.
To connect to the primary computer using NFS:
  1. On the application server, verify File Services are installed for the Network File System:
    1. Press Windows Key+r to open the Run dialog box and type:
      appwiz.cpl. This opens the Programs and Features window.
    2. In the Program and Features window, click Turn Windows Features on or off.
    3. Follow the instructions in the features wizard to make sure that NFS is installed.
      • For Windows Server 2019, install NFS by selecting Features → Client for NFS.
      • For Windows 10 Pro or Enterprise, install NFS by selecting Services for NFS → Client for NFS.
          Note:
        • Client for NFS is only available on Windows 10 version 1703 or later.
  2. Add registry entries to configure NFS with the UID and GID used to access files:
    1. Log in to the primary computer.
    2. In a command prompt type id <system_user> where <system_user> is your system user ID (default aiw1).
    3. Note the UID and GID numbers and convert them to hexadecimal format.
      Note: The UID is the system user ID (default aiw1) and the GID is the system group ID (default aiwgrp1). They are specified in hexadecimal values in the registry, for example, the default UID of 32457 is 0x00007ec9, and the default GID of 32458 is 0x00007eca.
    4. On the application server, create a file named nfs.reg.
      Note:

      You can create nfs.reg, anywhere on your system.

      Make sure you have file extensions showing. If you do not display file extensions, the file is created as a text file, not a registry file.
    5. Edit nfs.reg so it contains the following contents:

      Windows Registry Editor Version 5.00
      
      [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ClientForNFS\CurrentVersion\Default]
      "AnonymousGID"=dword:<GID_hex>
      "AnonymousUID"=dword:<UID_hex>

    6. Replace <GID_hex> with the GID hexadecimal number starting after the 0x. For example, if the GID hexadecimal number is 0x00007eca, replace <GID_hex> with 00007eca.
    7. Replace <UID_hex> with the UID hexadecimal number starting after the 0x. For example, if the UID hexadecimal number is 0x00007ec9, replace <UID_hex> with 00007ec9.
    8. Save nfs.reg and close the file.
    9. Double-click nfs.reg to run the registry file, which adds the UID and GID values to the registry.
      Note: Make sure that the values in the registry file exactly match the instructions. Incorrect registry modification can damage your operating system.
    10. Delete nfs.reg from your system.
    11. Restart the NFS service by typing the following commands into a command prompt:
      nfsadmin client stop
      nfsadmin client start
      If you receive error messages when stopping or starting the NFS service, restart the application server computer.
  3. On the application server, map the /aiw filesystem from the primary computer using the Map Network Drive dialog in Windows and this address for the server:
    \\<primary_server_hostname>\aiw
      Note:
    • If the connection fails, map the filesystem manually. Open a Command Prompt, and type: mount primary_server_hostname:/aiw drive_letter.
  4. Test the configuration by creating a file in the <drive_letter>:\aiw1 directory and then deleting it.
  5. Note the name of the drive for use during the installation process.
  6. Continue with Installing application servers on Windows computers.

1.2.2.2.4 Installing application servers on Windows computers

After you have completed the prerequisite steps, you can install an application server on a Windows system in your network.
    Important:
  • The application server code level must match the base product code level on the primary computer.
  • After you verify all the prerequisites, click Cancel to change a previous entry and begin the installation process again. Clicking the Previous button sometimes causes problems.
To install an application server on a Windows computer:
  1. Log in as an administrator.
  2. Insert the RICOH ProcessDirector base product DVD in the drive.
  3. Use Windows Explorer to view the contents of the DVD and find appserver\setupIPPDs.exe.
  4. Double-click setupIPPDs.exe to start the installer.
  5. In the installer, do these steps:
    1. Select the appropriate language and click OK. You see a welcome window for the installation program.
    2. Review the information presented in each window and click Next until you reach the Choose installation folder window. Choose a directory to install the application server in and click Next.
        Note:
      • You cannot choose a directory with international characters (such as á, É, î, ñ, ô, ß) or double-byte characters anywhere in the directory path.
    3. Enter the drive letter that you used to mount the /aiw filesystem from the primary server.
      For example, to connect to the J drive type J:
    4. Click Next.
    5. In the Preinstallation summary window, review the information and click Install.
    6. Restart the computer to complete the installation.
  6. When the system restarts, log in using the user ID that you want to run RICOH ProcessDirector under.
  7. Optional: Make sure the connection between the application server and RICOH ProcessDirector is included in the local intranet zone. This step is important so that you can gather troubleshooting information in the future.
    1. Log in to the application server as the user that the service runs under.
    2. Select Start Internet Options Security Local Intranet
    3. Click Sites.
    4. Under Add this website to the zone type the drive letter that you used to map the connection between the application server and the RICOH ProcessDirector primary server. Include a colon after the drive letter. For example, this application server has drive R: mapped to the primary server, type: R:
    5. Click Add.
    6. Click Close.
    7. Click OK in the Internet properties dialog.
  8. Start the application server. Use the Start application server link in the RICOH ProcessDirector start menu folder.
  9. To make sure that the application server is connected to the primary server, log in to the RICOH ProcessDirector user interface and click Administration Objects Servers to verify that the Connection status column contains Connected.

1.2.2.2.5 Configuring an application server to run as a service

Application servers can be configured to run as Windows services. Windows services can be set up to start automatically when a user logs in to the system.

To configure an application server to run as a service:

  1. Make sure the application server is installed and functions correctly.
  2. Make sure the RICOH ProcessDirector is connected to the application server:
    1. Log in to RICOH ProcessDirector.
    2. Go to Administration Objects Servers and verify the application server is connected.
  3. Log in to the Windows computer that the application server is installed on.
  4. Stop the application server. Use the Stop application server link in the RICOH ProcessDirector start menu folder.
  5. Windows services do not automatically have access to mapped network drives. The mountaiwdata.bat file grants access to these mapped network drives. Edit the provided mountaiwdata.bat file to automatically mount the shared drive for the service:
    1. Go to C:\Program Files\Ricoh\ProcessDirector\bin.
    2. Make a copy of the file mountaiwdata_sample.bat and rename it to mountaiwdata.bat. If you are upgrading or reinstalling the system, already have the mountaiwdata.bat file, and want to keep your previous settings, you do not have to do this step.
    3. Open mountaiwdata.bat and include commands to mount the drive and map it to the drive letter that you have previously set up.

      For example, if you use Samba and Windows file sharing to map your drive, your BAT file contents might include commands such as:

      • net use /delete <drive_letter>:
      • net use <drive_letter>: \\<primary_host_name>\aiw /user:<primary_host_name>\aiw1 <password> /persistent:yes

      where <drive_letter> is your mapped application server drive, <primary_host_name> is the name of the server RICOH ProcessDirector is installed on, and <password> is your system password for the RICOH ProcessDirector system user ( aiw1 is the default system user).

      If you use NFS and Windows file sharing to map your drive, your BAT file contents might include commands such as:

      mount -o anon \\<primary_host_name>\aiw <drive_letter>

      where <primary_host_name> is the name of the server RICOH ProcessDirector is installed on and <drive_letter> is your mapped application server drive.

    4. Make sure that the drive is not currently mapped, then run mountaiwdata.bat. When it finishes, open Windows Explorer and make sure that the drive is mapped and connected.
  6. Install the application server service:
    1. Start a command prompt as an administrator. Even if you are logged on to your system as an administrator, you must start the command prompt by selecting Run as administrator from the right-click menu.
    2. Go to C:\Program Files\Ricoh \ProcessDirector\bin.
    3. Type aiwsvc install and press Enter. This installs the application server service.
    4. Open the Windows Services window and look for the Ricoh Process Director Application Server service to make sure the application service installed.
  7. Optional: Set the application server service to run as a local administrator user.
      Note:
    • The application server service can run as a local administrator user service or a LocalSystem service (default). If it runs as a LocalSystem service, a password is not required. If it runs as a local administrator service, Windows requires a password for the user.
    1. In the Windows Services window, right-click the Ricoh Process Director Application Server service and select Properties.
    2. In the Log On tab, select This Account and specify the user and password.
    3. Click OK.
  8. In the Windows Services control panel, right-click the Ricoh Process Director Application Server service and select Start.
  9. Verify the application server service has started. In the Windows Services control panel, the status should read Started. In RICOH ProcessDirector, go to Administration Objects Servers and verify the application server is connected and that the startup type is set to Automatic.

1.2.2.3 Installing features

After you install RICOH ProcessDirector or RICOH ProcessDirector Subscription, you can add features at any time.
You install most features using the Feature Manager, available on the Administration tab.

The RICOH Transform features cannot be installed using the Feature Manager.

    Important:
  • All features are installed in trial mode. To continue using a feature after the trial period, you purchase the feature and install a license key for it.

    To see whether a feature is running in trial mode and how many days remain for each feature in trial mode, go to the Licenses page of the Administration tab and look at the License state column.

  • The maintenance license for RICOH ProcessDirector includes maintenance for features. They do not have separate maintenance licenses.
  • Licenses for the RICOH ProcessDirector Subscription base product and its features expire when the base product subscription period is over.
  • If you intend to install the AFP Support feature, we recommend that you install it before or at the same time as your other features. If you install features that process documents (such as Archive) before you install AFP Support, RICOH ProcessDirector does not install the AFP versions of sample workflows supplied with those features.
  • The PDF Document Support feature has a two-part installation process. You install the RICOH ProcessDirector components on the primary computer using the Feature Manager. You install RICOH ProcessDirector Plug-in for Adobe Acrobat on a computer with Adobe Acrobat Pro installed.
  • When you install RICOH ProcessDirector, some configuration files in /aiw/aiw1/control_files/external programs are used by both the RICOH Transform and the Advanced Transform features. However, the Advanced Transform features supply a different sample version of the xform.cfg. That sample file includes parameters that are only used by the Advanced Transform features.

    After you install the Advanced Transforms, you must make those parameters available. Find the xform.cfg installed by the Advanced Transform features in /aiw/aiw1/samples/control_files/external programs . Compare it to the one installed by the base product in /aiw/aiw1/control_files/external programs . Manually merge any changes from the sample file into the base product file.

    If you are upgrading to a newer version, update the xform.cfg file as well as the profiles installed in /aiw/aiw1/cpt/profiles , such as mffafp.pro.

1.2.2.3.1 Verifying feature prerequisites

Before you install a new feature, make sure your system meets the minimum requirements.
  • Hardware requirements:
    • If you install the PDF Document Support feature, the RICOH ProcessDirector Plug-in for Adobe Acrobat must run on a Windows computer. See RICOH ProcessDirector: Installing Document Processing Features, G550-20312, for hardware requirements.
  • Other hardware requirements:
    • A minimum of 16 GB available RAM is required when you are using one or more document processing features, for example:
      • AFP Support
      • PDF Document Support
      • Archive
      • Automated Verification
      • Inserter
      • Postal Enablement
      • Preference Management

      Depending on the number of documents you process, you might need more RAM or free hard-drive space.

    • The RICOH ProcessDirector/opt file system:
      • Recommended size: 50 GB free space
      • Minimum size: 45 GB free space
    • The following features have more hardware requirements. These requirements are added to the requirements listed for the primary computer; they do not replace those requirements.
      • Advanced Transform feature
        • Minimum 1 GB more free hard-drive space allocated to the RICOH ProcessDirector/opt file system
        • Minimum 2 GB more free hard-drive space allocated to the /aiw/aiw1 file system
            Note:
          • Large jobs sometimes require more RAM to process efficiently.
      • See Preparing to install Ricoh Transform features for the RICOH Transform features minimum system requirements.
  • Software requirements:
    • PitStop Connect

      Enfocus PitStop Server 10 or higher on an application server that is configured to work with the primary server.

    • Ultimate Impostrip® Connect

      Ultimate Impostrip® Automation or Scalable on an application server that is configured to work with the primary server or on a separate Windows system.

        Note:
      • If your Windows computer runs in a language other than English, do not install Ultimate Impostrip® in the default install directory. The program does not work properly with non-English default install paths. We recommend installing Ultimate Impostrip® in C:\ImpostripOnDemand on non-English Windows computers.
    • Quadient Inspire Connect

      Quadient Inspire Designer V8 or higher.

    • The AFP Support feature includes RICOH Visual Workbench, a separate user interface that you can install on any Linux or Windows system in your network.

      Java 1.8 or later must be installed on the system that is used for RICOH Visual Workbench.

    • Avanti Slingshot Connect

      Avanti Slingshot with the JDF Integration add-on installed on an application server that is configured to work with the primary server.

1.2.2.3.2 Installing features using Feature Manager

After you install the base product, you can install features using the Feature Manager.
    Note:
  • If you have any RICOH Transform features installed, you must shut down the Transform Features application before you install any feature with Feature Manager. Restart the Transform Features application after the feature installation completes.
To install one or more features using Feature Manager:
  1. If one or more secondary servers are defined and started, stop all of the secondary servers.
  2. Log in as a user authorized to use Feature Manager.
  3. Click the Administration tab.
  4. In the left pane, choose Utilities Features.
    Some browsers might prevent opening the Feature Manager in a new tab due to the pop-up blockers. Verify your settings and allow Feature Manager to open in a new browser tab.
    If you see an error message, you must start Feature Manager manually:
    1. Log in to the primary server as the RICOH ProcessDirector system user (aiw1 is the default).
    2. Open a command prompt and type: startaiw -f
    3. Refresh the Feature Manager web page.
  5. If the feature that you want to install is not listed, you must import it.
  6. If the feature that you want to install is in the list, select the check box next to it.
  7. In the Available versions column for each feature, select the version of the feature you want to install.
  8. Click Install.
  9. Review the information in the confirmation window, specify a name for the Installation display name, then click OK to continue.
    The features are installed, then RICOH ProcessDirector restarts to finish the install process.
    Note: If one or more features fail to install, choose one of these options:
    • Click Try again to retry the installation. If the install fails a second time, click Restore this Installation to return to a stable state.
    • Click Restore this Installation to revert the system to the state it was in before this installation.

    If you cannot install a particular feature or restore an installation, contact Ricoh Software Support.

  10. Click DISMISS. The dialog closes and you see the login page.
  11. To complete the installation process, clear your browser cache.
    Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.
  12. Log in again.
  13. Restart any secondary servers that you stopped in step 1.

1.2.2.3.3 Restoring a previous installation of RICOH ProcessDirector

Reverting to any past installation lets you effectively uninstall recently added features, extensions, or updates.
You can use the restore action to go back to a version of RICOH ProcessDirector that was installed on a specific time and date. Use this action to return your system to a known-good state, in case the newly-installed features or extensions are damaged.
    Important:
  • When restoring an installation that removes a feature from the system, you must perform a cleanup before attempting to restore the installation. You must disable any objects added when the feature was installed. If there are features containing step templates and if the step templates are used in a workflow outside the provided samples, you must remove the step templates before removing the feature. Features that are removed are marked with the Remove label in the Restore Details tab of the Installation History dialog.

When you restore a previous installation of RICOH ProcessDirector to remove a feature, we recommend:

  • If a feature was just installed and not used, restore to a point before that feature was installed.
  • If the feature was used, request assistance from the Ricoh Software Support team.

To restore a previous installation:
  1. Log in as a user authorized to use Feature Manager.
  2. Click the Administration tab.
  3. In the left pane, choose Utilities Features.
  4. To launch the installations list, click Installations.
  5. Select an installation that you want to restore.
    The Installation Details tab shows a list of features, extensions, and files added with the selected installation. The Restore Details tab lists the features, extensions, and files modified or removed by the selected installation.
  6. To revert to the selected installation, click Restore.
  7. If one of the restore steps cannot be completed, click Try Again to retry.
  8. To restore the entire installation due to an error, click Restore this Installation to start again the restore process.
    Note:
  • The number of installations varies according to the value specified in the Installations to store field. If the value is 0, the installations list contains only the baseline installation.
  • Storing multiple installations uses more disk space and may increase the time to uninstall and restore the features and extensions.

1.2.2.3.4 Preparing to install RICOH Transform features

Before you install a RICOH Transform features, make sure your system meets the minimum requirements.
  • Hardware requirements:
    • Minimum of an extra 10 GB free hard-drive space.
    • An extra 1 GB RAM for every CPU core, but no less than 4 GB.

      For example, if the computer has:

      • One dual-core processor, it must have an extra 4 GB RAM.
      • Two quad-core processors, it must have an extra 8 GB RAM.
      • Three quad-core processors, it must have an extra 12 GB RAM.
      • Four quad-core processors, it must have an extra 16 GB RAM.

  • File systems for the primary computer:
    1 GB additional free space in the RICOH ProcessDirector/opt file system.
  • Required software:

    WorldType Fonts version 8.13 for RICOH SAP to AFP files to transform correctly when IS/3 support is enabled.

    Java Runtime Environment 1.4 or higher.

    glibc 2.18 or higher

  • System and network setup:
    1. Determine the number of nodes that the RICOH Transform features will use.
      This value is based on the number of processor cores in the computer where you want to install the Transform feature. The value is 2 or half of the cores in the computer, whichever is larger. For example, if the computer has:
      • One single-core processor, the number of nodes is 2.
      • One dual-core processor, the number of nodes is 2.
      • Two dual-core processors, the number of nodes is 2.
      • Two quad-core processors, the number of nodes is 4.
      • Four quad-core processors, the number of nodes is 8.
    2. In your firewall, open the ports that the Ricoh Transform feature uses.
      These ports must have LISTEN permission for the listed application on the computer where you want to install the Transform feature:
      • Port 6980 for /opt/infoprint/itm/clients/fdi/fdi.
      • Ports 6984 and 6985 for /opt/infoprint/itm/hn/feps.
      • Port 6986 for /opt/infoprint/itm/clients/coord/coord.
      • Port 6989 through 6989 + (N-1) for /opt/infoprint/itm/node1/node through /opt/infoprint/itm/nodeN/node.

        Where N is the total number of nodes that the RICOH Transform features will use, as described above.

        For example, if the total number of nodes is 2, give LISTEN permission to:

        • Port 6989 for /opt/infoprint/itm/node1/node
        • Port 6990 for /opt/infoprint/itm/node2/node

      These applications must be able to make outgoing connections to the ports indicated on any computer:

      • /opt/infoprint/itm/clients/fdi/fdi to port 6984.
      • /opt/infoprint/itm/hn/feps to port 6986.
      • /opt/infoprint/itm/clients/coord/coord to ports 6984 and 6986.
      • /opt/infoprint/itm/hn/pd/pdexec to port 6984.
      • /opt/infoprint/itm/node[1 to N]/node to port 6985.
      • /opt/infoprint/itm/node1/xforms/ctt_standalone/ctt_standalone through /opt/infoprint/itm/nodeN/xforms/ctt_standalone/ctt_standalone to port 6989 through port 6989 + (N -1).

        Where N is the total number of nodes that the RICOH Transform features will use, as described above.

        For example, if the total number of nodes is 2:

        • /opt/infoprint/itm/node1/xforms/ctt_standalone/ctt_standalone to port 6989
        • /opt/infoprint/itm/node2/xforms/ctt_standalone/ctt_standalone to port 6990

    3. Add additional system users and groups.
      One additional group and two additional users are required.

      The default users are ipsitm and ipsejz; the default group is itm.

1.2.2.3.5 Installing RICOH Transform features

Before you install any RICOH Transform features:
  • Make sure that your computer meets the additional hardware and software requirements specified. You can install one or more RICOH Transform features on the primary server or on another computer on your network.
  • Make sure that Security Enabled Linux (SELinux) is not blocking any processes residing in any of the subdirectories of /opt/infoprint/itm.
  • The AFP Support feature must be installed on the primary server even if the Transform feature is installed on a computer other than the primary server.
  • The RICOH Transform features are installed in trial mode. To continue using the RICOH Transform features after the trial period, you must purchase each transform that you want to use and a license key for it.
    Note:
  • This task does not apply to the Advanced Transform feature. If you are installing the Advanced Transform feature, use the instructions for installing features using Feature Manager.
To install a RICOH Transform features:
  1. Stop the base product.
  2. Log in as the root user.
      Important:
    • You must log in as a user with UID 0. Do not use sudo or the su command to become the root user.
  3. Insert the appropriate RICOH Transform features DVD.
      Note:
    • If you are using a Red Hat, CentOS, or Rocky Linux system, the drive might mount automatically. However, drives that are mounted automatically on those systems are set up so that you cannot run programs from the media. You must unmount the drive and mount it again with the exec option before you can continue. You can use this command:

      mount -t iso9660 -o remount, exec <mount_point>

      You must remount the drive for every CD or DVD that you insert.

    The media mount point is /media/cdrom.

  4. To determine the name of the media mount point, enter:
    • ls /media
    On some systems where the media is mounted automatically, the name of the mount point is the same as the name of the CD or DVD.
  5. On a SLES system, enter this command to mount the DVD drive:
    • mount /media/cdrom
  6. Enter this command to start the installation program:
    • /media/cdrom/setup
  7. Select the appropriate language for the installer to use and click OK.
  8. Reply to any prompts in the installer.
    When the installer asks you to choose a directory to install the transform in, you can choose a directory on any drive. However, you cannot choose a directory with international characters (such as á, É, î, ñ, ô, ß) or double-byte characters anywhere in the directory path.

    The installation program analyzes the system. If it reports any errors, follow the instructions to correct them.

    If the installation program finds an older version of the RICOH Transform features, you must uninstall it. All custom configurations or resources associated with the older version are also deleted.

    If this is the first RICOH Transform features installed, the program detects that the Transform Feature Base is not installed. Click Next to install it.

    The installation program checks for missing dependencies.After you install all of the

  9. Review the information in the Pre-Installation Summary window and click Install.
    When the installation program completes, it shows a summary, including information about accessing the user interface with a Web browser. The default password is nopassword.
  10. When the installer completes, click Done.
  11. Unmount and eject the DVD.
  12. If you have another RICOH Transform features to install, repeat this procedure beginning with the step to insert the appropriate RICOH Transform features DVD, described above. Make sure you install all the Transform features before you install the license key.
      Note:
    • When upgrading a transform feature, make sure that all transform features are at the same version. If the transform features are not at the same version, the transform feature you did not upgrade stops working.
    • When installing a new version of Transform Features over a previous version, make sure to uninstall first the previous version of Transform Features. Uninstalling Transform Features deletes the files stored in your installation folders.
      Important:
    • To install a language pack, enter this command: /media/cdrom/linux/features/install_tf_rpd_language_pack.sh

1.2.2.3.5.1 Logging into the Transform Features user interface

This section describes how to log into the Transform Features user interface.
To log in:
  1. Open a Web browser and enter this address:
    • http://target server host name or ip address:port determined at install/itm
    The default port number is 16080.
    For example, if a Transform Feature is installed on a host with TCP/IP address 127.0.0.1 with the default port, the address is: http://127.0.0.1:16080/itm.
  2. In the browser window, you see the Log in to the Transform Feature user interface page. Type the Transform Features password.
    The default password is nopassword.
  3. Click Log in.
    You see the Transform Features user interface main page.
      Note:
    • If you do not use the Transform Features user interface for 30 minutes or more, you must log in again.

    When you first log in to the Transform Features user interface, you see one transform server that has been added by default during the installation.

1.2.2.3.5.2 Installing the Transform Feature license keys

You can install a Transform Feature license key on a computer other than the primary computer using an installation program from the Transform Features directory.
To install a Transform Feature license key:
  1. Log in as an administrator or root user to the computer that the Transform Feature is installed on.
  2. Get the fingerprint for the computer.
    1. Open a command prompt.
    2. For Linux, navigate to the /opt/infoprint/itm/license_installer directory, and type:
      • ./GetFingerprint.sh
    3. For Windows, navigate to the drive:\Program Files\InfoPrint\InfoPrint Transform Features\license_installer directory, and type:
      • GetFingerprint.cmd
    The output of the command looks like this:

    • *1AW QLQ7 BQDZ RLRZ

      Note:
    • This fingerprint is required to generate the license key. Save the fingerprint for later.

  3. Get the license file.
    1. When you purchased the Transform Feature, Ricoh Production Print sent an email to the email address provided when the order was placed with the Entitlement Management System (EMS) - Entitlement Certificate in the subject line. This email contains an Entitlement ID (EID) and a link to the Entitlement Management System website.
    2. Open the Entitlement Management System website in your browser.
    3. In the Login Using list, select EID.
    4. Find the EID in the email and type or paste it into the EID field.
    5. Click Login.
    6. Select the license you want to activate and click Activate.
    7. In the Activate Product(s) window, enter the system fingerprint and click Generate.
        Note:
      • If you see an error message that the license could not be generated because checksum validation failed, you entered an incorrect system fingerprint.
    8. Select what you want to do with the license file:
      • Select Save to File to save the license file to your computer.
          Note:
        • Note the hostname and the fingerprint (without the *) when saving the license file.This is valuable information to have when recovering from a hard drive failure.
      • To add the license keys to an existing license file, select Append To File.
      • To email yourself a copy of the license file, select E-mail.
          Note:
        • Check the email address in the Contact field. If a copy of the email (including the license key file) should be sent to a different email address, click E-mail. Type the email address and click Send.
    9. Log out from the EMS website.
    10. If you received the license key file in an email, transfer it to the computer that the Transform Feature is installed on or a network location that is accessible to that computer.
  4. Install the license key.
    • For Linux:
      1. Open a command prompt.
      2. Navigate to the /opt/infoprint/itm/license_installer directory, and type ./install_license_keys.sh.
    • For Windows:
      1. In Windows Explorer, navigate to the drive:\Program Files\InfoPrint\InfoPrint Transform Features\license_installer directory.
      2. Double-click license_keys_installer.exe to run the license key installation program.

1.2.2.3.6 Adding or upgrading a feature using Import Package

You can use Feature Manager to add a new feature or upgrade an existing feature by downloading a feature package file, either from the Ricoh website or from a feature DVD, and then using the Import Package action.
You must save the feature package file to a location that can be accessed by using the primary computer.

If you download the feature package file from the Ricoh website, save it to a location that is accessible from RICOH ProcessDirector. This location can be on the primary computer, a workstation, or a network drive. Remember where you save the file so that you can browse to it from RICOH ProcessDirector. Additionally, you must extract the file in that location so the EPK file within the downloaded file can be seen.

If you receive the feature package file from a DVD, you need to locate the file on the DVD, copy it from the DVD onto the primary computer, and remember where you put it so you can browse to it.

To import a feature package using Import Package:
  1. If one or more secondary servers are defined and started, stop all of the secondary servers.
  2. Log in as an administrator or other user with authority to import packages.
  3. In the left pane, choose Utilities Features.
    If you see an error message, you must start Feature Manger manually:
    1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
    2. Open a command prompt and type: startaiw -f
    3. To complete the process, clear your browser cache.
      Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.
    4. Reload the Feature Manager web page.
    The Feature Manager page opens in a new browser tab.
  4. Click Import Package.
  5. In the Package to import field click Image of folder..
  6. Select the feature package EPK file for the feature you want to install and click Open.
    The import automatically begins.
  7. When the import finishes, the feature you installed or upgraded appears in the main Feature Manager window.
    The feature appears in the Feature Manager table selected.
  8. In the Available Versions column, use the list to select the version of the feature you want to install.
  9. Click Install.
  10. Review the information in the confirmation window, then click OK to continue.
    The feature is installed, then RICOH ProcessDirector is restarted to finish the install process.
  11. Click DISMISS to close the Feature Manager browser tab.
  12. To complete the process, clear your browser cache.
    Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.
  13. Log in again.

1.2.2.4 Installing RICOH ProcessDirector Plug-in for Adobe Acrobat

This section describes how to install and uninstall RICOH ProcessDirector Plug-in for Adobe Acrobat. The plug-in is included with the PDF Document Support feature.

Make sure the system on which you install RICOH ProcessDirector Plug-in for Adobe Acrobat meets the hardware and software requirements. If you have a previous version of RICOH ProcessDirector Plug-in for Adobe Acrobat on the system, uninstall it.

1.2.2.4.1 Hardware and software requirements for RICOH ProcessDirector Plug-in for Adobe Acrobat

This section describes the hardware and software requirements for the computer that you install RICOH ProcessDirector Plug-in for Adobe Acrobat on. The plug-in is included with the PDF Document Support feature.
Hardware requirements

The system hardware requirements for the computer that RICOH ProcessDirector Plug-in for Adobe Acrobat is installed on are:

  • Monitor resolution of 1024 by 768 pixels or higher
  • A minimum of 2 GB RAM

Depending on the number of documents you process, additional free hard-drive space and memory might be required.

Operating system and software requirements

RICOH ProcessDirector Plug-in for Adobe Acrobat requires one of these operating systems:

  • Windows 10
  • Windows 11 Pro
  • Windows Server 2016
  • Windows Server 2019
  • Windows Server 2022

RICOH ProcessDirector Plug-in for Adobe Acrobat requires this software:

  • Java Runtime Environment (JRE) 1.8 (Java Version 8)
    • You must install the JRE, not the Java Development Kit (JDK).
    • We strongly recommend using the 64-bit version of the JRE you choose.
    • RICOH ProcessDirector Plug-in for Adobe Acrobat supports both the Oracle Java and OpenJDK (Hotspot) JREs at Version 8.
      Note: Neither RICOH ProcessDirector nor the Plug-in install Java on your system. You must install a supported Java version for the Plug-in to use.

      If you install the OpenJDK JRE (Hotspot), you must choose the option to install with a custom setup, not the default setup. In the list of features to install, find JavaSoft (Oracle) registry keys and select the option to install that feature on the local hard drive.

  • Adobe Acrobat Pro 2020 or Pro DC
      Note:
    • Acrobat cannot be installed in a directory path that contains non-English Unicode characters.

1.2.2.4.2 Running the installation program

Follow these steps to install RICOH ProcessDirector Plug-in for Adobe Acrobat using the plug-in installer file that is copied to the primary computer during installation of the PDF Document Support feature.

The installer file that comes with the PDF Document Support feature is placed here:

  • On Windows: C:\aiw\aiw1\share\Ricoh-ProcessDirector-Plug-in-for-AdobeAcrobat-Setup.exe
  • On Linux: /aiw/aiw1/share/Ricoh-ProcessDirector-Plug-in-for-AdobeAcrobat-Setup.exe

To run the installation program:

  1. Download the installer file from the primary computer to the Windows computer that has Adobe Acrobat installed on it using the RICOH ProcessDirector user interface.
    1. On the client Windows computer, log in as an administrator.
    1. Log in to RICOH ProcessDirector as a member of the Administrator group.
    2. Click the Administration tab.
    3. In the left pane, choose Utilities Plug-in for Adobe Acrobat.
    4. Click RICOH ProcessDirector Plug-in for Adobe Acrobat.
      The browser's default file download process is used to transfer the file. You might have to choose where to store the file.
    5. Log out of RICOH ProcessDirector.
  2. Close all open applications that could be using Adobe Acrobat, Distiller, or Reader. Many Web browsers use Adobe Acrobat Reader, so make sure to close all Web browsers.
  3. Find the directory where you downloaded the installer file and double-click the file.
    The installer starts.
  4. Optional: For setup information including hardware and software requirements, click Setup Guide.
    Adobe Acrobat must be closed during the installation process. Print these instructions if you want to view them during installation.
  5. Follow the prompts to complete the installation.
  6. Depending on your current configuration, the installer might ask to update some Microsoft libraries.
  7. Verify the installation by opening a PDF file using Adobe Acrobat.
    • In the traditional view of Adobe Acrobat, check the menu bar. You should see the Ricoh menu.
    • In the new Adobe Acrobat experience (introduced in May 2023), select Menu Plug-ins. You should see a sub menu for Ricoh.
  8. If you cannot see the Ricoh menu or sub-menu, check the default values for these Adobe settings:
    1. Open the Preferences dialog:
      • In the traditional view, click Edit Preferences.
      • In the new Adobe Acrobat experience, select Menu Preferences.
    2. Select the General category.
    3. In the Application Startup section, make sure that Use only certified plug-ins is not selected.
    4. Select the Security (Enhanced) category.
    5. In the Sandbox Protections section, you might see an option called Enable Protected mode at startup. Make sure this option is not selected.

Before you start using the plug-in to enhance PDF files, open Adobe Acrobat and review the help for the RICOH ProcessDirector Plug-in for Adobe Acrobat. To open the help:

  • In the traditional view, click Ricoh Help
  • In the new Adobe Acrobat experience, select Menu Plug-ins Ricoh Help.

Review the topics about preferences, loading document properties, and adding the Plug-in icon to the Acrobat quick launch bar. These topics describe how to tailor the Plug-in to your environment.

1.2.2.4.3 Loading RICOH ProcessDirector document properties

To use RICOH ProcessDirector Plug-in for Adobe Acrobat to define text in a PDF file as a RICOH ProcessDirector document property, you must import the list of RICOH ProcessDirector document properties.
You must do this task:
  • After you install RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • After changes are made to property definition files, you have run the docCustom utility, and you have installed or upgraded the Custom Document Properties feature.
  1. Close Adobe Acrobat Professional.
  2. Retrieve the definitions.zip file from this directory on the RICOH ProcessDirector server that processes your PDF files:
    • Unix-based systems, /aiw/aiw1/share
    • Windows, C:\aiw\aiw1\share
    This file is generated when you install one of the document processing features and is updated when you run the docCustom utility and install or upgrade the Custom Document Properties feature.
    The definitions.zip file is downloaded when you download the plug-in installer from the Administration tab. After you make any changes to your custom document properties, you must manually download the definitions.zip file.
  3. On the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat, place the definitions.zip file in the <user_home_directory\AppData>\Roaming\InfoPrint\InfoPrintPlugin\ directory.

    For <user_home_directory\AppData>, substitute the name of the home directory application data directory for the current user.

      Note:
    • You can view the application data directory location for the current user by typing %appdata% in the Windows Run command line and clicking OK.

  4. Restart Adobe Acrobat Professional and click Ricoh Select to activate RICOH ProcessDirector Plug-in for Adobe Acrobat. The list of RICOH ProcessDirector document properties in the definitions.zip file is automatically imported into the areas of the plug-in that use document properties.
The definitions.zip file contains document properties and limited document properties. Limited document properties are not saved to a database, but they are stored in the document properties file that contains the property. For more information about both types of properties, see the topics related to document properties in the information center, for example see the topic on editing the sample document properties template.

1.2.2.4.4 Loading media objects

After installing RICOH ProcessDirector Plug-in for Adobe Acrobat, load RICOH ProcessDirector media objects. After you load them, you can use them to define media and finishing options for specific pages in a PDF file.

Whenever you change RICOH ProcessDirector media objects, do this task to load them into RICOH ProcessDirector Plug-in for Adobe Acrobat.

To load media objects:

  1. Close Adobe Acrobat Professional.
  2. On the RICOH ProcessDirector primary server, go to this directory:

    • /aiw/aiw1/share on Linux
    • C:\aiw\aiw1\share on Windows

  3. Copy the media.zip file to the <user_home_directory\AppData>\Roaming\InfoPrint\InfoPrintPlugin\ directory on the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat.

    For <user_home_directory\AppData>, substitute the name of the home directory application data directory for the current user.

      Note:
    • You can view the application data directory location for the current user by typing %appdata% in the Windows Run command line and clicking OK.
    • If the directory includes both a media.zip file and a media.xml file, RICOH ProcessDirector Plug-in for Adobe Acrobat uses the media.zip file to load the media objects.
    • The media files are not downloaded when you download the plug-in installer from the Administration tab.

  4. Restart Adobe Acrobat Professional and click Ricoh Select.

The media objects now are available in RICOH ProcessDirector Plug-in for Adobe Acrobat for defining media and finishing options.

If your RICOH ProcessDirector system includes the Preprinted Forms Replacement feature, the electronic forms defined for media objects also are available.

1.2.2.4.5 Uninstalling RICOH ProcessDirector Plug-in for Adobe Acrobat

If you need to uninstall RICOH ProcessDirector Plug-in for Adobe Acrobat, use your system's method to remove programs.
To uninstall RICOH ProcessDirector Plug-in for Adobe Acrobat:
  1. Close all instances of Adobe Acrobat.
  2. Log in to Windows as an administrator.
  3. Locate RICOH ProcessDirector Plug-in for Adobe Acrobat in your installed program list.
  4. Select it and remove it.

1.2.2.5 Downloading and installing license keys

If you have purchased RICOH ProcessDirector, RICOH ProcessDirector Subscription, or any feature, use this procedure to download license keys and install them.
Before you begin this procedure:
  • Install the product or feature in trial mode.
  • If you have not already purchased the software, contact your local Ricoh support representative or sales representative.

    After you purchase the software, Ricoh Production Print sends an email to the email address provided when the order was placed with the Entitlement Management System (EMS) - Entitlement Certificate in the subject line. This email contains an Entitlement ID (EID).

  • Follow all the steps in this procedure each time that you receive an email with an Entitlement ID for RICOH ProcessDirector components that you have purchased.

    You will receive a new Entitlement ID when you renew the subscription for RICOH ProcessDirector Subscription.

  • License keys are specific to the release of RICOH ProcessDirector or RICOH ProcessDirector Subscription that you have installed. Be sure that the version on the About dialog matches the information in the email.
  • This procedure for downloading and installing license keys does not apply to the Transform Features. See Installing the Transform Feature license keys for more information.
To download and install license keys:
  1. Open RICOH ProcessDirector.
  2. Click the (information icon) button at the right of the banner and select About.
  3. Click INSTALL LICENSES.
  4. Click the link to open the license activation website.
  5. On the Software Activation page, enter your EID and system fingerprnt.
    • Find the EID in the Ricoh-Entitlements email and type or paste it into the EID field.
    • Copy the system fingerprint from the Install Licenses dialog.
  6. Click Confirm Content.
  7. Select the license you want to activate and click Activate.
  8. After the license is activated, click Download License Key.
    The license key file is downloaded to your computer.
  9. Return to the Install Licenses dialog.
  10. In the Install licenses dialog, click and select the license file you want to install.
  11. Click Done.
  12. Restart RICOH ProcessDirector to complete the installation.
      Important:
    • If the trial period or subscription expires before you restart RICOH ProcessDirector, RICOH ProcessDirector shuts down.
The license keys for all purchased features are now installed on the primary computer. Any feature without a license key remains in trial mode until its trial period ends. If you purchase an additional feature, renew your subscription, or renew your maintenance on the product, repeat this process to install the new key.

When the trial period ends, the steps and objects that are supplied with the feature stop working, but remain on the system. Installing a license key after you purchase the feature activates the steps and objects without requiring a reinstall.

When a subscription expires, all of your objects remain in the system, but you cannot log in. Contact Ricoh software support for assistance with installing a new license on a system with an expired subscription.

1.2.2.6 Installing and configuring the pdpr script

If you are migrating from InfoPrint Manager and you use the pdpr command to submit jobs, you can install the RICOH ProcessDirector pdpr script on the computers that submit jobs and use the same command to send jobs to RICOH ProcessDirector.
The installation package for the pdpr script is copied to the primary computer when you install the base product. You can copy the installation package and install it on computers that submit jobs running these operating systems:
  • CentOS Linux 7.9 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • Rocky Linux 8.4 through latest 8.X
  • Rocky Linux 9.0 through latest 9.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
  • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64
  • Windows 7
      Note:
    • To install the pdpr script on a different operating system, contact your Ricoh support representative.
The pdpr script requires Perl to run. Before you install the pdpr script, make sure that a Perl interpreter is installed on the client systems.

The pdpr script uses a control file named pdpr.cfg to determine whether jobs are sent to InfoPrint Manager or to RICOH ProcessDirector. You can either store the control file on the same computer that you install the pdpr script on, or you can store it in a central location and let the pdpr script access it using FTP. The pdpr script uses an anonymous login to the FTP server, so the anonymous user must have read permission for the control file.

To get the most recent pdpr script, contact your Ricoh support representative.

To install and configure the pdpr script:

  1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default), or with a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
  2. Find the pdpr installer file: /aiw/aiw1/samples/pdpr/pdpr_installer.
  3. Copy the file to a temporary directory on the computer that runs the pdpr command.
  4. Log in to a client computer:
    • On a Linux-based client, log in as the root user and open a command prompt.
    • On a Windows client, log in as a user with administrator permission and open a command prompt.
  5. Change directories to the directory that contains pdpr_installer.
  6. Type: perl pdpr_installer
    The installer interface runs in the command prompt window.
  7. When the installer asks where you want to install the program, choose a different directory than the temporary directory that the pdpr_installer was copied in to.
      Important:
    • If you install into the temporary directory, the installation fails. You get an incomplete installation that has a pdpr directory instead of the pdpr script.
  8. Respond to the questions in the installer according to these definitions:
    Hostname or IP address of RICOH ProcessDirector server
    Fully qualified hostname or IP address of the computer that the primary server is installed on.
    Full FTP path for pdpr.cfg file
    If you want to store the pdpr.cfg file in a central location, the full path to the pdpr.cfg file. The value must end with the file name pdpr.cfg.

    If you plan to store the pdpr.cfg file on the same system as the pdpr script, do not type anything; press Enter and continue with the installer.

  9. Finalize the installation process:
    • If you are installing on a Linux client, log out and log back in so the changes can take effect.
    • If you are installing on a Windows client, restart the computer so the changes can take effect.
  10. To define rules for parsing the pdpr command and submitting jobs to RICOH ProcessDirector, edit the pdpr.cfg file.
    The file must contain one line for each rule that you define. Jobs are sent to an input device based on the last rule that they match. If the job does not meet the conditions of any of the rules, it is sent to InfoPrint Manager.

    Each line of the file follows this syntax:

    • FileName | LDName,regular_expression, input_device_name, [BOTH]

    Use FileName if you want to parse the file name of the input file to determine where to send the job. Use LDName to parse the value of the -d (InfoPrint Manager logical destination) option on the pdpr command to determine where to send the job.

    For example, the file might contain these lines:

    LDName, .*\.[Pp][Ss], InputPS
    FileName, .*\.[Aa][Ff][Pp], InputAFP

    The first line instructs the script to look at the -d option on the pdpr command. If the value specified for that option ends with .ps or .PS, the job is sent to the input device named InputPS. The second line instructs the script to look at the file name of the input file. If the file name ends with .afp or .AFP, the job is sent to the input device named InputAFP.

    If neither condition is met, the job is sent to InfoPrint Manager using the value stored in the PDHOST environment variable on the system.

    Add the BOTH parameter to the end of an entry to indicate that if the condition is satisfied, the job should be sent to both InfoPrint Manager and RICOH ProcessDirector. This is useful when you are initially configuring RICOH ProcessDirector to receive jobs from pdpr because you can test the RICOH ProcessDirector configuration while continuing to use InfoPrint Manager in your production environment.

Now you can configure RICOH ProcessDirector to receive jobs submitted with the pdpr script from all the client systems.

1.2.2.7 Uninstalling the base product, features, and extensions

You can use one command to uninstall the base product and all features and extensions (except Secondary Server features) at the same time. You cannot uninstall features or extensions individually.

To uninstall the base product and all features and extensions:

  1. Log in to the primary computer as the root user.
  2. Enter one of these commands:
    • If you are running the primary computer from a graphical user interface such as X Windows:
      • /opt/infoprint/ippd/_uninstall/ippd/removeIPPD -i gui
    • If you are running the primary computer from a terminal window:
      • /opt/infoprint/ippd/_uninstall/ippd/removeIPPD -i console
      Note:
    • If you see an error that the Java virtual machine cannot be found, enter this command, then try to run the command again:

      . ~aiw1/.profile

    RICOH ProcessDirector starts the program that guides you through the uninstallation process. Follow the instructions in the program.
  3. Click Uninstall to start the uninstallation process.
    You can choose to remove the system user (aiw1), the system group (aiwgrp1), and the database user (aiwclnt) and group (aiwdbgrp).
    When the uninstallation is complete, you either see a message that the uninstallation was successful or a message that there were errors and the location of the error log file.
  4. Click Done.
  5. The uninstallation program leaves behind part of the directory structure. To completely remove all files that the RICOH ProcessDirector installation program installed, remove any file systems that were created as part of the installation.
    File systems to remove include:
    • /aiw/aiw1/db2
    • /aiw/aiw1/db2_logs
    • /aiw
    • /opt/infoprint/ippd
    • /var/psf/segments
    • /var/psf
    • /var/aiw
      Important:
    • Do not remove the /opt/infoprint directory if RICOH InfoPrint XT or RICOH Transform Feature are installed on the server you are using.
  6. To remove the RICOH ProcessDirector databases and DB2 instance from a DB2 server on a different computer:
    1. Log in to that computer as the DB2 instance owner of the RICOH ProcessDirector database.
    2. Insert the RICOH ProcessDirector base product DVD in the drive.
    3. Go to the /scripts directory on the RICOH ProcessDirector base product DVD.
    4. Enter this command to run the uninstall script:
      • ./remoteDB2uninstall.sh
      Note:
    • remoteDB2uninstall.sh lets you choose whether to remove the RICOH ProcessDirector user IDs or user groups created by setupRemoteDB2.sh. It does not remove RICOH ProcessDirector user IDs or user groups that you created manually.
  7. To remove the Docker container when you are using RICOH ProcessDirector with a PostgreSQL database, you must first stop the Docker container and then remove it.
    1. Enter this command to stop the Docker container:
      docker stop container-name
    2. Enter this command to remove the Docker container:
      docker rm container-name
    3. Enter this command if you also want to remove the associated volumes:
      docker volume prune

      This command deletes all persistent data previously associated with containers that have now been removed.

    The container-name is rpd-aiwdb-postgres for the primary database and rpd-reports-postgres for the Reports database.
  8. Restart the primary computer.

1.2.2.8 Uninstalling an application server

To uninstall an application server from a Windows computer:
  1. Log in to the application server as an administrator.
  2. If the application server is installed on a Windows 11 Pro computer, before uninstalling the application server, you must add an environment variable to run the uninstall script. To add the environment variable:
    1. Click the Windows Start button and type Control Panel.
    2. Click Control Panel.
    3. Go to System and click Advanced system settings.
    4. Click Environment Variables in the System Properties dialog.
    5. Click New in the System variables section.
    6. Enter JAVA_TOOL_OPTIONS in the Variable name field.
    7. Enter "-Dos.name=Windows Server 2019" in the Variable value field.
    8. Click OK.
  3. Go to the directory where you installed RICOH ProcessDirector. If you accepted the default directory during installation, go to C:\Program Files\Ricoh\ProcessDirector.
  4. Go to _uninstall\ippds and run removeIPPDs.exe.
  5. Click Uninstall to start the uninstallation process.
    When the uninstallation is complete, you either see a message that the uninstallation was successful or a message that there were errors and the location of the error log file.
  6. Click Done.

1.2.2.9 Uninstalling Transform Features

If you want to uninstall Transform Features, you need to uninstall it from the server and the BladeCenter, as appropriate.

1.2.2.9.1 Uninstalling Transform Features from a server

This section describes the procedure for uninstalling Transform Features from a server.
To uninstall Transform Features from a server:
  1. For Linux, run this command from this path: /opt/infoprint/itm/_uninst/uninstall_itm.sh, and for Windows, specify the uninstall command from this path: install_path\_uninst\uninstall.exe
  2. To uninstall only a specific transform, for Linux, run this this command:
    /opt/infoprint/itm/_inst/feature/<transform_id>/_uninst/uninstall_tf_<transform_id>.sh where <transform_id> is the transform name.
  3. You see the Welcome to the uninstall program page.
  4. Click Next.
    You see the summary page stating that the installer will uninstall Transform Features.
  5. Click Uninstall.
    You see the page stating that Transform Features has successfully uninstalled.
  6. Click Finish to exit the wizard.
On Windows operating systems, Transform Features can also be uninstalled from the Control Panel.

1.2.2.9.2 Uninstalling Transform Features from a Linux server from the command line

This section describes how to uninstall Transform Features from the command line.
To uninstall Transform Features from a Linux server:
  1. Log in as a root (administrator) user.
  2. For a console uninstall, enter this command:
    /opt/infoprint/itm/_uninst/uninstall_itm.sh
  3. To uninstall only a specific transform, enter this command:
    /opt/infoprint/itm/_inst/feature/<transform_id>/_uninst/uninstall_tf_<transform_id>.sh where <transform_id> is the transform name.

1.2.2.9.3 Uninstalling Transform Features from a Windows server from the command line

This section describes how to uninstall Transform Features from the command line.
To uninstall Transform Features from a Windows server:
  1. Log in as an administrator user.
  2. For a console uninstall, enter this command:
    install_path\_uninst\uninstall.exe -i console
  3. For a silent uninstall (does not produce any output and does not require user input), enter this command:
    install_path\_uninst\uninstall.exe -i silent

1.2.3 Migrating and Updating

Upgrading is the process of updating RICOH ProcessDirector to a more recent release or service level. Migrating is the process of moving to RICOH ProcessDirector from a different Ricoh Production Print product.

This section provides information about:

  • Installing a product update for RICOH ProcessDirector.
  • Migrating objects from RICOH ProcessDirector on one computer to an installation on a different system.
  • Moving from one product to another, for example, from InfoPrint Transform Manager to RICOH ProcessDirector Transform features.

1.2.3.1 Installing a RICOH ProcessDirector product update

1.2.3.1.1 Preparing for the update

When you prepare your system for an update, you must determine how you want to update your system and what components you have installed, and then back up your system.

To prepare for an update:

  1. Decide how to update your system. You have two choices:
    • Download the full product ISO file for the most recent version of RICOH ProcessDirector.

      The ISO file includes a full update of the base product and all of the features. You install the update the same way that you initially installed the product.

      This option is the most efficient, because there is only one package to download and installed features are updated automatically.

        Note:
      • RICOH Transform features must be downloaded and installed separately.
    • Download the update packages for the base product and each of the features you have installed.

      Downloading individual update packages can be faster than downloading the full ISO file, as each package is significantly smaller than the ISO file. However, each package must be downloaded individually. If you have a large number of features to update, the process can take a long time.

      You can only install a product update on RICOH ProcessDirector systems at Version 3.6 or higher. If your software is below Version 3.6, use the full product ISO file or contact Software Support.

  2. If you have RICOH Transform features installed, log in to the Transform Feature user interface and open the About dialog. Note the transforms that you have installed.
  3. If you chose to use the full product ISO file, follow the instructions in chapters 3 and 4 of Ricoh ProcessDirector: Planning and Installing for downloading and installing the update.
  4. If you chose to install update packages, you must update the base product and all features that are currently installed.
    1. Log in as a user authorized to use Feature Manager.
    2. Click Administration.
    3. In the left pane, choose Utilities Features
      If you see an error message, you must start Feature Manger manually:
      • Log in to the primary computer as the default user and open a command prompt. Type: startaiw -f
      To complete the process, clear your browser cache and reload the Feature Manager web page.
    4. Make a list of all the features that have a version number In the Installed Version column.
      The Product Update feature contains the base product, so it must be updated.
  5. Back up the system. Type these commands.
    • zip -r aiwlib.zip /aiw/aiw1/lib/*
    • zip -r ext-xml.zip /opt/infoprint/ippd/extensions/**/extension.xml
      Note:
    • This procedure stops and starts your RICOH ProcessDirector server. Do this procedure at a scheduled maintenance time.

1.2.3.1.2 Downloading and installing update packages

Product updates for RICOH ProcessDirector can be downloaded from the Ricoh Software Web page.
    Note:
  • This procedure assumes that you are not using the primary computer to access an external Web page and download the update files.

    If you download the files directly to the primary computer, download the files to this directory:

    • /opt/infoprint/ippd/available

To download and install the update packages:
  1. In a web browser, open this page: https://dl.ricohsoftware.com/.
  2. Click Software Downloads, enter your Entitlement ID, and click Submit.
  3. Optional: If you have RICOH Transform features to update, find and click the names of those transforms to download them.
  4. Click View Related Files on the right side of the page.
  5. Click the title of each package that you want to download, starting with Ricoh ProcessDirector: Product Update Feature.
    Use the list of installed features that you made to determine which other packages to download.
  6. After each package downloads, validate its MD5 checksums to the value shown on the Web page. Use this command, substituting the name of the file for ProductUpdate.epk:
    • md5sum ProductUpdate.epk

    If the checksum does not match, download the file again.

  7. Log in to the primary server as the aiw1 user.
  8. Copy the EPK files into this directory on the primary computer:
    • /opt/infoprint/ippd/available
  9. Install the Product Update feature using Import Package.
  10. When the installation completes, RICOH ProcessDirector restarts. Use your browser to log in to the user interface. If an error occurs during the installation, contact Ricoh Software Support.
  11. If you downloaded other feature packages, use Feature Manager to install them.
  12. If you downloaded RICOH Transform features, mount and install each ISO file.
    For details about running the install program, refer to RICOH ProcessDirector: Planning and Installing, chapter 4.

1.2.3.2 Using the Migration Assistant

The Migration Assistant is a utility that helps you move objects from one RICOH ProcessDirector system to another.

Before you begin the process below, install RICOH ProcessDirector on a new computer. This computer is known as the target system. In addition, have the URL for the log in page of your existing RICOH ProcessDirector system and the user name of an RICOH ProcessDirector Administrator on that system. The existing system is the source system.

Note: The source and target systems can have different operating systems installed.
To use the Migration Assistant, follow these procedures to prepare your systems, run the Migration Assistant, and complete the process by doing the migration tasks that the Migration Assistant cannot handle.

1.2.3.2.1 Preparing to use the Migration Assistant

For a successful migration, we recommend taking some measures to prepare your systems to avoid difficult-to-solve problems that could lead to migration failure.
To prepare your systems for migration:
  1. Install RICOH ProcessDirector on the target system.
    1. Verify that your system meets the prerequisites.
    2. Follow the installation instructions just as you would for a new installation.
    3. Return to this procedure after you complete the process to install the base product.
    4. Log in to the version of RICOH ProcessDirector that you just installed. Use the User Name aiw and the Password aiw.

      When you change the password for this user, remember the new password. We recommend logging in as this user until the migration process is complete and all users are imported to the target system.

    5. Install the same features that you had on your old system and any new features that you have purchased. If an error occurs during the installation, contact Ricoh Software Support.
    6. Download and install license keys. RICOH ProcessDirector and all features install in trial mode. If the trial period expires before you install license keys, the software stops working.

      Note: You can install license keys after the migration process is complete if you prefer.
  2. If you are using the Preprinted Forms Replacement feature, export the media.zip file from your target system and copy it to the source system. Follow the instructions for Exporting media with electronic forms.
  3. When you import step resources, the files that they refer to are not included in the export package. Copy the files referenced in the step resources from the source system to the target system manually. You must copy the files to the target system before you start the Migration Assistant.
    1. To import all the step resources, copy the contents of /aiw/aiw1/StepResources from the source system into the same directory on the target system.
    2. To import specific step resources, open the XML file that you exported. Find the entry for each step resource that you exported and locate the StepResource.File property. In that value, find the name of the RSC file associated with that step resource. For example, in this value:
      <property name="StepResource.File" value="{&quot;fileName&quot; : 
      &quot;/aiw/aiw1/StepResources/
      1992052c6ef44a229b8b43d77232bf53.rsc1992052c6ef44a229b8b43d77232bf53.rsc
      &quot; , &quot,&quot;displayName&quot; : &quot;
      Ricoh_Export-2019-08-26_13-30-04.xml&quot;}"/>

      The file name is: 1992052c6ef44a229b8b43d77232bf53.rsc

    3. Find the file on the source system and copy it into the same directory on the target system.
  4. The Migration Assistant cannot migrate credentials of any kind. However, objects that require them fail to import if they do not exist on the target system. Export your Password, Session, and Static credentials from the source system now. Import them onto your target system before you start the Migration Assistant.
      Note:
    • Private Key credentials cannot be exported, because they must be created on the system where they are used. Objects that use private key credentials fail in the Migration Assistant and must be recreated manually afterwards.
  5. Prevent common issues that can result in migration failure:
    1. Take a snapshot or backup of both the source and target systems to avoid the risk of data loss.
        Note:
      • Using Migration Assistant to upgrade on a different computer does not affect the source system, preserving the data and configuration. We recommend backing up both systems as a safety measure.
    2. Make sure that the Product Update features are installed on both systems at the same level. In the Feature Manager, find the Product Update feature for both systems and compare the values in the Installed Version column.
        Note:
      • If the target system has a higher version, you have the opportunity to download the package during the migration. Then you can install the Product Update using Import Package on the source system Feature Manager page.
      • If the source system has a higher version, find the most recent product update package in: /opt/infoprint/ippd/available. The name of the package is: ProductUpdate-3.4.version_number.epk. Download the package, then log in to the target system. Open Feature Manager, import the package, then install it.

        For more information, see Adding or upgrading a feature using Import Package.

    3. Check file system capacity. For a successful migration, the target system should have at least as much available capacity as the source system.
    4. Disable any software that scans and locks files, such as antivirus and security software, that may interfere with installation or performance.

1.2.3.2.2 Running the Migration Assistant

With the Migration Assistant, objects are transferred from one RICOH ProcessDirector system to the other. This process significantly minimizes the likelihood of human error associated with the import of a large number of objects.
Before you begin, make sure you know the URL for the login page of the system you want to migrate from (source system). To proceed with migration, you need Administrator access for both the source and target systems.
    Note:
  • We recommend logging in to the target system using the aiw user, as your RICOH ProcessDirector user ID probably does not exist on the new system yet.
  • You can create a new administrator user to log in to the target system, but, if it exists on the source system, it is overwritten during migration.
To use the Migration Assistant:
  1. Log in to your RICOH ProcessDirector target system as aiw user.
  2. Click the Administration tab.
  3. In the left pane, click Utilities Migration Assistant.
  4. Select IMPORT FROM ANOTHER SYSTEM.
  5. Log in to the source system with an administrator user name and password.
      Note:
    • You must provide the full URL for the log in page of the source system.
  6. On the Verify page, make sure all the information presented is correct and click Continue.
  7. On the Prepare page, review the suggested actions to reduce the migration failure possibilities. For each step, you have the option to either complete or ignore it. Click Save and Continue to proceed with the migration.
    For example, in this step, you can make sure that the Product Update features are installed on both systems at the same level. In the Feature Manager, find the Product Update feature for both systems and compare the values in the Installed Version column.
    • If the target system has a higher version, click the download button in the Migration Assistant to save the package to your system. Then you can install the Product Update using Import Package on the source system.
    • If the source system has a higher version, find the most recent product update package in: /opt/infoprint/ippd/available. The name of the package is: ProductUpdate-3.4.version_number.epk. Download the package, then log in to the target system. Open Feature Manager, import the package, then install it.

      For more information, see Adding or upgrading a feature using Import Package.

  8. On the Features page, click CHECK FEATURES to compare the features installed on the systems. To proceed, make sure that both the source and target systems have the same features installed.
    If any features are missing, click Save and Continue. Review the features to install and click OK. Feature Manager opens so you can install the missing features. After the features are installed, log in to your RICOH ProcessDirector target system again and return to the Migration Assistant. When both systems contain the same features, click Continue to proceed with the migration.
      Note:
    • If you purchased one or more features for the first time, they can exist on the target system only.
    • If you worked with Ricoh's Advanced Solutions Practice to install additional functions on your source system, you must transfer those feature packages to your target system. Contact your Ricoh representative for assistance.
  9. On the Objects page, select to migrate all objects from your source system or specific objects.
    We recommend migrating all objects, but you can select which objects to migrate if you want to take this opportunity to remove some objects from your system. If you choose to selectively migrate objects, click the Select objects and choose the objects you want to migrate.

    The Migrate options let you overwrite any identically named objects on the target system with the corresponding objects from the source system.

  10. On the Settings page, select which previously configured system settings to migrate. These settings are configured in the Settings section of the Administration page. Choose the settings to import and click Save and Continue.
    Note: System Identification properties cannot be exported with General System settings and must be created on the system where they are used.
  11. Before proceeding with the migration process, review the configuration to import from the source system. If you need to change any choices, you can navigate to any step of setting up the migration elections by selecting Edit.
  12. When everything is confirmed, click START MIGRATION.
    The Migration Assistant starts to import objects and settings while displaying the progress. You can download the migration log file to review the details when any migration errors occur or the final version when the migration is complete.
  13. Download the ZIP file log if there are any errors that you need to review.
  14. After you download the ZIP file, click X button at the top of the page to exit the MIGRATION ASSISTENT.
    Note:
  • You can click X in the upper right corner of the window followed by SAVE CHANGES to save the progress at anytime during migration. In this way, you can return to complete the migration process from where you left off.
  • See Completing the upgrade process to complete the migration process.

1.2.3.2.3 Completing the upgrade process

After you upgrade RICOH ProcessDirector, you must do a few more steps to make the transition easier.
If you upgraded on the same computer, the upgrade process converts your objects to versions that are compatible with the new RICOH ProcessDirector version. All your existing users and groups exist, so your users can log in using the same names and they have the same authority levels. When you log in, you see all of your printers, input devices, and other objects.

If you upgraded on a different computer, you should be able to log in and see all the objects that you imported. However, there are still some manual steps required to finish the migration process.

To complete the upgrade process:

  1. If you upgraded to a different computer with Migration Assistant, take these actions:
    1. Re-enable any antivirus and security software that were disabled during the migration process.
    2. The Migration Assistant cannot import TLS configuration information; you must configure it on the new system again.
    3. If you migrated your primary server from one operating system to another (especially from Windows to Linux or vice-versa), check and update all paths used in your workflow steps.

      Make sure all directory paths are updated to the directory structure of the new system. If you are migrating from RICOH ProcessDirector AIX to Linux or Windows, this step is essential.

    4. Review the log for any errors, including objects that failed to import.
      Objects the use Private key credentials fail to import because the credentials do not exist. Recreate your private key credentials on the target system, then create those objects manually.
    5. Copy all your configuration files to the right locations, so your jobs can find them.

      Restore any configuration files that you store outside of the /aiw/aiw1 file system.

    6. Recreate the visual mechanisms used to help distinguish between RICOH ProcessDirector from another. Use the System identification settings on the System Settings page to set a background color or configure a tab in the banner.
    7. If you created a custom portlet on a RICOH ProcessDirector system prior to version 3.10.2, you cannot import it to a system with RICOH ProcessDirector version 3.12 or later. Create the custom portlet again on the source system.
    8. Update your secondary and application servers, then make sure the migrated objects can connect with the upgraded system.

      See Setting up application and secondary servers for more information.

        Note:
      • Verify that all input devices and printers connected to the secondary and application servers are functioning properly.
      • Verify that all applications running on these systems, such as Avanti, PitStop, and Ultimate Impostrip®, are able to connect.
    9. If you use the RICOH Supervisor Connect feature, the Migration Assistant copied some settings, but cannot complete the connection process.

      Refer to the procedure Setting up to send data to RICOH Supervisor to connect to RICOH Supervisor.

    10. If you use custom document properties that were created in RICOH ProcessDirector prior to version 3.11.2, copy /aiw/aiw1/config/docCustomDefinitions.xml to the target system and run the docCustom utility to activate them. Custom document properties created in RICOH ProcessDirector 3.11.2 using the Custom properties page migrate just as any other properties do.
    11. Before putting the new system into production, set the value for “Smallest job number” from System Setting to synchronize your job numbering.
  2. Update any secondary and application servers to the new level.
  3. Before they log in for the first time, tell your users to clear their browser cache.

    Information that is stored in the browser cache can cause errors when users try to use the newer level. Clearing the cache prevents those errors.

1.2.3.3 Moving to RICOH ProcessDirector from InfoPrint Manager

If you are familiar with the InfoPrint Manager print environment, moving to RICOH ProcessDirector might take some adjustment. The objects and tasks you can do in each system have different names, but many of the functions are similar. The information in this topic maps some of the InfoPrint Manager objects and tasks to similar concepts in RICOH ProcessDirector.
User interface

The first thing that you might notice is that there is only one user interface used to access RICOH ProcessDirector instead of the separate Operations and Administration interfaces that you use with InfoPrint Manager. However, the information and functions that you see in the user interface change based on the security group that the user name you use belongs to. If you log in using a user name that is in the Administrator group, you can access the Administration page of the user interface and do all the actions that are available. If you log in using a user name that is a member of the Supervisor group, you can access the Administration page, but you can only do a subset of the actions. If you log in as a member of the Operator or Monitor group, you do not see the Administration page on the interface.

Objects

An exact mapping does not exist between the objects in RICOH ProcessDirector and InfoPrint Manager, but there are many objects in a RICOH ProcessDirector system that are similar in function to objects in InfoPrint Manager.

InfoPrint Manager objects and similar RICOH ProcessDirector objects
InfoPrint Manager objects RICOH ProcessDirector objects
Logical destination, with or without an Initial Value Job (IVJ) Input device
MVS Download receiver Download input device

This type of input device is only available if the AFP Support feature is installed.

Actual destination Printer
Job Job
Hot folder attribute of a Logical Destination Hot folder input device
Auxiliary sheet Banner page
Transform object Steps created from the RunExternalStep step template
ResourceContext objects The value of the AFP Resource path property on a step, step template, or printer.

This property is only available if the AFP Support feature is installed.

Tasks

In RICOH ProcessDirector, you can do many of the same tasks that you can do using InfoPrint Manager.

InfoPrint Manager tasks and similar RICOH ProcessDirector tasks
InfoPrint Manager tasks RICOH ProcessDirector tasks
Create job and document defaults. Set the job default properties for each step that you add to a workflow.
Submit a job using the pdpr command. Follow the instructions for installing the pdpr script on the client system and configuring RICOH ProcessDirector to receive jobs from it. Submit the job as usual.
    Note:
  • The pdpr script in RICOH ProcessDirector does not accept all of the options that the pdpr command in InfoPrint Manager accepts. See the supported pdpr options information for details.
Receive a multi-dataset job as a single RICOH ProcessDirector job. Open the properties notebook for the Download input device. Click the Advanced tab. Set the Merge dataset property to Yes.

This function is only available if the AFP Support feature is installed.

Check job status. Use the Jobs table to find the job. Click the job number to open the properties notebook for the job. Click the Status tab.
View or change the media, number of copies, priority, and many other properties of a job. Use the Jobs table to find the job. Click the job number to open the properties notebook for the job.
Pause and resume a job. Right-click the job in the Jobs table and click Stop and Continue.
Interrupt a job. Right-click the job in the Jobs table and click Stop. Then, if the job is actively printing, select the option Stop now and remember the last page that prints.
Hold and release a job. Configure a workflow so that it stops processing jobs at a certain point in the workflow until an operator does an action to continue printing the job.
Change the page range to print. Right-click the job in the Jobs table and click Print Again, then select which pages to reprint.
Move a job to a different destination. Right-click the job in the Jobs table and click Schedule.
Make job first. Right-click the job in the Jobs table and click Promote.
Retain jobs. To retain all jobs that are processed using the same workflow for the same amount of time, create a step based on the RetainCompletedJobs step template and set the Retention period property. To retain a particular job for a longer or shorter period, change the value of the Retention period property for that job.
View retained jobs. In the System Summary portlet, click Complete.
Resubmit a retained job. Right-click the job in the Jobs table and click Print Again or Process Again.
Change the retention time for a job. Use the Jobs table to find the job. Click the job number to open the properties notebook for the job. Click the General tab. Change the value of the Retention period property for that job.
Cancel a job. Right-click the job or jobs in the Jobs table and click Delete.

If the job is actively printing, select the job in the Jobs table and click Stop, then select the option Stop now and discard the rest of the job.

Delete a job. Right-click the job or jobs in the Jobs table and click Delete.
View a job log. Right-click the job in the Jobs table and click View Log.
Set the number of error messages that causes jobs to end. To end all jobs that are processed using the same workflow after the same number of error messages, create a step based on the PrintJobs step template and set the Number of messages to stop job property. To end a particular job after more or fewer error messages, change the value of the Number of messages to stop job property for that job.

This function is only available for AFP printers, which are installed with the AFP Support feature.

Create a printer.

On the Administration page, click Devices Printers in the left pane and click Add.

View or change the properties of a printer. In the Printers portlet on the Main page, click the printer name.
Check printer status. Look in the Printers portlet. If the printer icon is light blue, the printer is ready; if the icon is red, the printer needs attention. If the arrow is blue, the printer is enabled; if it is yellow, the printer is disabled. For additional status, click the name of the printer to open the properties notebook for that printer. Click the Status tab.
Pause a printer. Right-click the printer in the Printers portlet and click Stop.
Forwardspace or backspace a printer. Use the Jump to action on the job that is printing on the printer.

This function is only available for AFP printers, which are installed with the AFP Support feature.

Shutdown a printer. In the Printers portlet on the Main page, right-click the printer and select Shutdown.
View a printer log. In the Printers portlet on the Main page, right-click the printer and select View log.
Create a directory to use as a hot folder. Make sure that the RICOH ProcessDirector system user (aiw1 is the default) in the RICOH ProcessDirector group (aiwgrp1 is the default) owns the directories that you specify as the Folder location and Staging location of Hot folder input devices. If you specify directories that do not already exist when you create a Hot folder input device, RICOH ProcessDirector creates them automatically with the correct ownership.
Filter the information that displays in the user interface.

Use the links in the System Summary portlet or the Printers portlet, or type in the Filter field image of the Filter icon at the top of the Jobs table.

Generate accounting information using user exits. The ainurpt7, ainurpt8, and ainurpt9 exits are included with RICOH ProcessDirector and can be set up to run as user exit programs.
Log job completion information using user exits. The ainuxjobcompletion exit is included with RICOH ProcessDirector and writes to the same log as InfoPrint Manager. You can tell which program wrote an entry by the printer name, because in log entries RICOH ProcessDirector appends aiw1 to the printer name as it appears in the RICOH ProcessDirector user interface.
Open online documentation.

Click the (information icon) button in the top right corner of any page and select Help.

1.2.3.4 Moving to the RICOH ProcessDirector Transform features from RICOH InfoPrint Transform Manager

If you have been using InfoPrint Transform Manager with RICOH ProcessDirector to transform print jobs, you must do these tasks to change to the RICOH ProcessDirector Transform features.
Important: You cannot configure RICOH ProcessDirector to work with the Transform features and with InfoPrint Transform Manager at the same time.

If you are moving to the Advanced Transform feature, you do not have to do this procedure. Follow the existing instructions for configuring the Advanced Transform features.

To move from InfoPrint Transform Manager to the RICOH ProcessDirector Transform features:

  1. Install one or more of the RICOH ProcessDirector Transform features on the computer where InfoPrint Transform Manager is installed.
    When you install the first Transform feature, you automatically uninstall InfoPrint Transform Manager.
  2. Return to the RICOH ProcessDirector user interface. Make sure that the Transform server IP address or host name system property on the System Settings page contains the values that you noted above.

1.2.4 Configuring the system

Configuration tasks for RICOH ProcessDirector include adding and setting properties for objects such as input devices, as well as more advanced tasks such as setting up external programs.

1.2.4.1 Setting system properties

System properties apply to the overall RICOH ProcessDirector environment, which includes the primary server and any application/secondary servers. Some of the properties apply to all the jobs that RICOH ProcessDirector creates.
To set system properties:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. Enter values for the properties that you want to change.
  4. Click SAVE.

1.2.4.2 Preparing for job submission

You can submit jobs to RICOH ProcessDirector using different mechanisms, such as the LPD protocol, FTP, SCP, file copying, or the Submit Jobs portlet on the Main page. Some preparation is necessary no matter which submission method you use. If you install the AFP Support feature, you can submit jobs using Download for z/OS or AFP Download Plus.

If you install the Web Services Enablement feature, you can use SOAP or REST web service connections to retrieve files from other applications and process them as jobs.

Job submission is how you get your input files into the directory that an input device monitors. The input device then creates a job, assigns it a workflow, and initiates the workflow.

1.2.4.2.1 Configuring to use Download for z/OS

Before Download for z/OS can send data sets from z/OS to the RICOH ProcessDirector system, an administrator must do configuration tasks on z/OS. The administrator also does corresponding tasks on the RICOH ProcessDirector system to configure the input devices that receive the data sets and to configure the workflows that the data sets are assigned to.
Before you begin this procedure, review the supplied workflows. If you find one that contains some or all the steps that you want to include in your workflow, you can copy it and modify it to meet your needs. The DownloadAFP and DownloadLineData workflows are recommended for use with Download for z/OS.

In addition, determine whether you can use one of the Download input devices that RICOH ProcessDirector provides or whether the installation requires a customized input device. RICOH ProcessDirector provides several Download input devices that you can use with only minor modifications or that you can copy to create a customized Download input device.

To configure to use Download for z/OS:
  1. On the RICOH ProcessDirector system, copy and modify a workflow that contains the processing steps that you want the jobs that are submitted by Download for z/OS to follow.

    To copy and modify one or more workflows:

    1. Click the Workflow tab.
    2. Right-click the workflow that you want to copy, and select Copy.
    3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    4. In the workflow editor, right-click each step and select Properties. Modify the properties as necessary.
    5. If the AFP resources (such as fonts, overlays, and page segments) required by the jobs that are processed through this workflow are not going to be sent inline with the input file, make sure that those resources are available to the RICOH ProcessDirector system. It is recommended that you move these resources to /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows) or /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows), so that they are available to all the components of RICOH ProcessDirector. If you cannot use those directories, you can set the AFP resource path property on one of the steps in the workflow to refer to the directory or directories that hold the resources.
        Note:
      • The AFP resource path can be set as a default job property on various step templates, including EnableRepositioning, CreatePageRanges, PrintJobs, and ConvertLineDataJobIntoAFP. You only need to set the value on one of the steps; the others inherit the value.
    6. When you are ready to use the new workflow, save and enable it by changing , the Save & Enable/Disable switch, to the On position.
    7. Repeat these steps if you want to create additional workflows.
  2. On the RICOH ProcessDirector system, configure an input device so that it assigns the correct workflow or types for the z/OS data sets that it receives. It is recommended that you copy and rename one of the supplied Download input devices, then verify or update the settings described below.
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Right-click the Download input device that you want to copy and select Copy.
        Note:
      • The new input device that RICOH ProcessDirector creates through the copy action is the same type as the copied input device. You cannot create a new Download input device by copying a hot folder or an LPD input device.
    4. In the left pane, click Show all tabs to display all the properties for this input device.
    5. Verify or update the values for these properties:
      Port number
      The port number that this input device uses to communicate with Download for z/OS. Make note of the port number that you specify so that you can use it in your routing control data set on z/OS. If InfoPrint Manager for Windows is also receiving jobs from this z/OS system, make sure you assign a port number that InfoPrint Manager is not using.
      Folder location
      The directory on the primary computer that receives data sets from Download for z/OS. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that Download for z/OS sends without filling the file system.
      Staging location
      The directory that RICOH ProcessDirector moves input files to before they are submitted as jobs. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that Download for z/OS sends without filling the file system. Remember that there might be two copies of an input file in the system at any time, one in the Folder location directory and one in the Staging location directory.
    6. If the input device needs to accept single or multiple data set jobs:
      1. Set the Submit step property to SubmitInputFiles and the Workflow property to ParentNoPrint.
      2. Determine how you want the input device to assign the workflow for each single job or child job. You can select one of these:
        • Set the Child workflow initialization step property to Not set and set the Child workflow property to the name of an existing workflow to assign the same workflow to every job that this input device processes.
        • Set the Child workflow initialization step property to SetJobTypeFromRules and use the Child workflow parsing rules property to specify the name of the control file that can set the workflow from a JCL parameter value.

          RICOH ProcessDirector provides a sample control file that uses the values of JCL parameters to set the workflow. The sample control file, called receive_jcl_jobtype.cfg, is installed in the /aiw/aiw1/samples/rules/ (Linux) or C:\aiw\aiw1\samples\rules\ (Windows) directory. You can copy that file to the /aiw/aiw1/control_files/rules/ (Linux) or C:\aiw\aiw1\control_files\rules\ (Windows) directory and modify it to meet your needs, then update the value of the Child workflow parsing rules property to point to your file.

        • Set the Child workflow initialization step property to SetJobTypeFromFileName and use the Child workflow pattern property to specify the string that RICOH ProcessDirector should look for in the input file name and use as the workflow name. If you use this method, you must make sure that a workflow with the corresponding name exists.

          Note:
        • If you want to merge multiple input data sets into a single job, specify Yes for the Merge multiple data sets property of the input device. If you are using RICOH ProcessDirector for Windows and merging data sets, you can use the Destination control file property to specify a file that contains a list of directories to search for AFP resources.

  3. On z/OS, use the Download for z/OS documentation to install and configure Download for z/OS. You might want to create several Download for z/OS functional subsystems (FSSs).
      Note:
    • When Download for z/OS is running in multiple dataset mode with Exit 15, each Download input device can receive jobs from only one Download for z/OS functional subsystem application (FSA).
  4. Set up the Download for z/OS Print Parameters Exit 15, either APSUX15 or APCUX15, as required for the installation. If RICOH ProcessDirector processes z/OS jobs that contain multiple data sets, the exit must pass the output-group identifier, OUTGRP, with the -opa parameter. The OUTGRP value is either FIRST, NEXT, LAST, or ONLY.
      Note:
    • IBM can customize the exit to meet unique requirements of the installation. Contact IBM for further information.
  5. Update the routing-control data set on z/OS to include the TCP/IP address of the parent server that is running the target input device. The routing-control data set must also specify the port numbers of the target input devices that you verified or updated in a previous step.
    These examples show RICOH ProcessDirector entries in the routing-control data set that send different types of data sets to different input devices on the RICOH ProcessDirector system:
    /**** RICOH PROCESSDIRECTOR ROUTING FOR LINE DATA
    DEST=PRT01,PRT02,       /* ALL DATA SETS WITH DESTINATION PRT01 PRT02
    CLASS=C,                /* AND A CLASS OF C
    IPADDR=9.99.176.136,    /* SEND TO RICOH PROCESSDIRECTOR AT THIS IP ADDRESS
    PORTNUM=7777;           /* AND THIS INPUT DEVICE PORT NUMBER
    
    /**** RICOH PROCESSDIRECTOR ROUTING FOR LINE DATA
    CLASS=A,               /* ALL DATA SETS WITH A CLASS OF A
    FORMS=BILLS,           /* AND WITH A FORMS VALUE OF BILLS
          RECEIPTS,        /* OR A FORMS VALUE OF RECEIPTS
    IPADDR=9.99.176.136,   /* SEND TO RICOH PROCESSDIRECTOR AT THIS IP ADDRESS
    PORTNUM=6001,          /* AND THIS INPUT DEVICE PORT NUMBER
    RETRY=3,               /* RETRY 3 TIMES IF TRANSMISSION FAILS
    RETRYINTV=60;          /* WAIT 60 SECONDS BETWEEN RETRY ATTEMPTS
    
    /**** RICOH PROCESSDIRECTOR ROUTING FOR POSTSCRIPT AND PDF
    DEST=PRT03,             /* ALL DATA SETS WITH DESTINATION PRT03
    CLASS=D,                /* AND A CLASS OF D
    IPADDR=9.99.176.136,    /* SEND TO RICOH PROCESSDIRECTOR AT THIS IP ADDRESS
    PORTNUM=8488,           /* AND THIS INPUT DEVICE PORT NUMBER
    SEND_REC_LENGTH=NO;     /* DO NOT PREPEND 2-BYTE LENGTH FIELD
    
  6. On z/OS, make any installation-specific modifications to the z/OS Download printer. For example, an administrator might assign a RICOH ProcessDirector-specific destination name to the printer. Then, jobs can use the DEST JCL parameter to request the RICOH ProcessDirector destination.
  7. Drain and restart the z/OS Download printer to use the updated routing-control data set.
  8. Submit and print jobs to verify that Download for z/OS can send data sets, without errors, as a standalone program.
  9. If in a previous step you created a control file that sets job scheduling properties such as Class, Form, or Destination based on the JCL parameters of the job, make sure that the corresponding scheduling properties are set on the target printers in RICOH ProcessDirector. If the scheduling properties do not match, the jobs cannot be scheduled to those printers.
  10. On the RICOH ProcessDirector system, make sure that the input devices that correspond to the routing-control data set entries are connected and enabled.
  11. On the z/OS system, submit jobs to RICOH ProcessDirector. If errors occur, correct the errors that messages from z/OS or RICOH ProcessDirector identify.

1.2.4.2.2 Configuring to use AFP Download Plus

Before AFP Download Plus can send data sets from z/OS to the RICOH ProcessDirector system, an administrator must do configuration tasks on z/OS. The administrator also does corresponding tasks on the RICOH ProcessDirector system to configure the input devices that receive the data sets and to configure the workflows that the data sets are assigned to.

Before you begin this procedure, review the supplied workflows. If you find one that contains some or all the steps that you want to include in your workflow, you can copy it and modify it to meet your needs. The DownloadAFP and DownloadLineData workflows are recommended for use with AFP Download Plus.

In addition, determine whether you can use one of the Download input devices that RICOH ProcessDirector provides or whether the installation requires a customized input device. RICOH ProcessDirector provides several Download input devices that you can use with only minor modifications or that you can copy to create a customized Download input device.

To configure to use AFP Download Plus:
  1. On the RICOH ProcessDirector system, copy and modify a workflow that contains the processing steps that you want the jobs that are submitted by AFP Download Plus to follow.

    To copy and modify one or more workflows:

    1. Click the Workflow tab.
    2. Right-click the workflow that you want to copy and select Copy.
      We recommend using the DownloadAFP and DownloadLineData workflows with AFP Download Plus.
    3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    4. In the workflow editor, right-click each step and select Properties. Modify the properties as necessary.
    5. If the AFP resources (such as fonts, overlays, and page segments) required by the jobs that are processed through this workflow are not going to be sent inline with the input file, make sure that those resources are available to the RICOH ProcessDirector system. We recommend that you move these resources to /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows) or /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows), so that they are available to all the components of RICOH ProcessDirector. If you cannot use those directories, you can set the AFP resource path property on one of the steps in the workflow to refer to the directory or directories that hold the resources.
        Note:
      • The AFP resource path can be set as a default job property on various step templates, including EnableRepositioning, CreatePageRanges, PrintJobs, and ConvertLineDataJobIntoAFP. You need to set the value on only one of the steps; the others inherit the value.
    6. To save and enable the workflow, change , the Save & Enable/Disable switch, to the On position.
    7. Repeat these steps if you want to create an additional workflow.
  2. On the RICOH ProcessDirector system, configure an input device so that it assigns the correct workflow or workflows for the z/OS data sets that it receives. We recommend that you copy and rename one of the supplied Download input devices, then verify or update the settings described below.
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Right-click the Download input device that you want to copy and select Copy.
        Note:
      • The new input device that RICOH ProcessDirector creates through the copy action is the same type as the copied input device. You cannot create a new Download input device by copying a hot folder or an LPD input device.
    4. In the left pane, click Show all tabs to display all the properties for this input device.
    5. Verify or update the values for these properties:
      Port number
      The port number that this input device uses to communicate with AFP Download Plus. Make note of the port number that you specify so that you can use it in your routing control data set on z/OS. If InfoPrint Manager for Windows is also receiving jobs from this z/OS system, make sure you assign a port number that InfoPrint Manager is not using.
      Folder location
      The directory on the primary computer that receives data sets from AFP Download Plus. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that AFP Download Plus sends without filling the file system.
      Staging location
      The directory that RICOH ProcessDirector moves input files to before they are submitted as jobs. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that AFP Download Plus sends without filling the file system. Remember that there might be two copies of an input file in the system at any time, one in the Folder location directory and one in the Staging location directory.
      Report errors
      Lets RICOH ProcessDirector report internal processing errors to AFP Download Plus for assistance with problem determination. To use this function, set this property to Yes.
      Send return code to host
      Controls some aspects of communication between RICOH ProcessDirector and the host system that submits jobs to this input device. Yes means the input device does not complete the transmission from the host system until after it checks the return code that the exit program or script reports.
      • If the return code is zero, the input device reports success to the mainframe and ends the transmission.
      • If the return code is any other value, the input device reports failure to the mainframe and ends the transmission.
      No means that RICOH ProcessDirector ends the transmission with the host system without checking or reporting the return code.
    6. If the input device needs to accept single or multiple data set jobs:
      1. Set the Submit step property to SubmitInputFiles and the Workflow property to ParentNoPrint.
      2. Determine how you want the input device to assign the workflow for each single job or child job. You can select one of these:
        • Set the Child workflow initialization step property to Not set and set the Child workflow property to the name of an existing workflow to assign the same workflow to every job that this input device processes.
        • Set the Child workflow initialization step property to SetJobTypeFromRules and use the Child workflow parsing rules property to specify the name of the control file that can set the workflow from a JCL parameter value.

          RICOH ProcessDirector provides a sample control file that uses the values of JCL parameters to set the workflow. The sample control file, called receive_jcl_jobtype.cfg, is installed in the /aiw/aiw1/samples/rules/ (Linux) or C:\aiw\aiw1\samples\rules\ (Windows) directory. You can copy that file to the /aiw/aiw1/control_files/rules/ (Linux) or C:\aiw\aiw1\control_files\rules\ (Windows) directory and modify it to meet your needs, then update the value of the Child workflow parsing rules property to point to your file.

        • Set the Child workflow initialization step property to SetJobTypeFromFileName and use the Child workflow pattern property to specify the string that RICOH ProcessDirector should look for in the input file name and use as the workflow name. If you use this method, you must make sure that a workflow with the corresponding name exists.
  3. On z/OS, use the AFP Download Plus documentation to install AFP Download Plus. Configure the AFP Download Plus sender to send jobs to RICOH ProcessDirector using the configuration information provided in Print Services Facility for z/OS: AFP Download Plus (S550-0433).
    When you define the JES work-selection criteria for each FSA, include:
    • On the IPADDR parameter, the TCP/IP address of the parent server that is running the target input devices.
    • On the PORTNO parameter, the port numbers of the target input devices.
  4. Start the AFP Download Plus sender and FSAs.
  5. If in a previous step you created a control file that sets job scheduling properties such as Class, Form, or Destination based on the JCL parameters of the job, make sure that the corresponding scheduling properties are set on the target printers in RICOH ProcessDirector. If the scheduling properties do not match, the jobs cannot be automatically scheduled to those printers.
  6. On the RICOH ProcessDirector system, make sure that the input devices that you created to receive jobs from AFP Download Plus are connected and enabled.
  7. On the z/OS system, submit jobs to RICOH ProcessDirector. If errors occur, correct the errors that messages from z/OS or RICOH ProcessDirector identify.

1.2.4.2.3 Configuring to use the LPD protocol

Before a user can use the line printer daemon (LPD) protocol to submit jobs to the RICOH ProcessDirector system, an administrator must do configuration tasks on the RICOH ProcessDirector system to configure the input devices that receive the jobs, to configure the workflows that the jobs are assigned to, and to define the hosts that can use the LPD protocol to submit jobs to RICOH ProcessDirector. The administrator might also have to do some configuration tasks on these hosts.
Before you begin this procedure, review the supplied workflows. If you find one that contains some or all the steps that you want to include in your workflow, you can copy it and modify it to meet your needs.

In addition, determine whether you can use one of the LPD input devices that RICOH ProcessDirector provides or whether the installation requires a customized input device. RICOH ProcessDirector provides LPD input devices that you can use with only minor modifications or that you can copy to create a customized LPD input device.

To configure to use the LPD protocol:
  1. If any LPD daemons or processes that do not belong to RICOH ProcessDirector (for example, the Common UNIX Printing System [CUPS] LPD daemon) are running on the same system as the parent server for the input device, stop them.
    • On SUSE Linux, start YaST, then click System Network Services to find the LPD services.
    • On Red Hat 6.7 through latest 6.X, choose System Administration Services to find the LPD services.
    • On Red Hat 7.1 through latest 7.X, choose Applications Utilities Terminal and use this command: systemctl list-units --type service --all.

      To stop an LPD service, use this command: systemctl stop <LPD_service>.

      Important:
    • Do not uninstall CUPS.
  2. If the parent server of the input device is defined on a Linux computer, update the system setting to specify the hosts that can submit jobs using the LPD protocol.
    1. Click the Administration tab.
    2. In the left pane, click Settings System.
    3. In the Hosts allowed to submit LPD jobs field, type the allowed host names or IP addresses.
      Separate host names and IP addresses with semicolons.
        Note:
      • You can use wild cards in host names and IP addresses (for example, *.acmeproducts.com or 192.*). A value of * means that all hosts are allowed to submit jobs. Values that contain only numbers, decimal points, and wild cards are compared to IP addresses. Values that contain wild cards and at least one alphabetic character are compared to host names. An empty value means that no hosts are allowed to submit jobs.
      • The default value is *.
      • You cannot submit jobs to LPD input devices from the primary computer.
      • If you experience long wait times or missing jobs, set the LPD host entries to IP addresses or fully qualified host names (such as hostserver.co.acmeproducts.com instead of *.acmeproducts.com).
    4. Click SAVE.
  3. On each system that you authorized to submit LPD jobs, determine if the print command lets you specify a server name. If it does not, do one of the following steps to create a print queue on the system to send jobs to the LPD input device.
      Note:
    • The LPR client that is supplied with the base operating system in some versions of Windows and that is available as an optional feature of other versions lets you specify a server name. If you use this LPR client or an equivalent, you do not have to create a print queue on Windows.
  4. To create a print queue on SLES 12.0:
    1. Log in as the root user.
    2. Start YaST.
    3. Click Hardware Printer. With Printer Configurations highlighted, click Add. Click Connection Wizard, and then select Line Printer Daemon (LPD) Protocol.
    4. In the IP Address or Host Name field, type the host name or IP address of the system where the LPD input device is defined.
    5. Type the name of the LPD input device in the Queue Name field, and click OK.
    6. In the Set Arbitrary Name field, type the name of the LPD input device. This name must be unique on this Linux system. Although LPD input device names are case-sensitive, Linux does not allow you to define multiple LPD input device names that are alike except for case. For example, you cannot define one LPD input device called HotFolderLPD and another called hotfolderlpd.
    7. Click OK.
  5. To create a print queue on Red Hat 6.7 through latest 6.X:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications System Tools Terminal.
    3. In the terminal window, type system-config-printer.
    4. Select Printer on the New drop-down menu.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the system where the LPD input device is defined.
    7. Type the name of the LPD input device in the Queue field, and then click Forward.
    8. In the New Printer window, click Forward.
    9. Click Forward again.
    10. Type a name for the LPD input device in the Printer Name field.
    11. Click Apply.
  6. To create a print queue on Red Hat 7.1 through latest 7.X:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications Utilities Terminal.
    3. In the terminal window, type system-config-printer.
    4. Select Printer on the Add drop-down menu.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the system where the LPD input device is defined.
    7. Type the name of the LPD input device in the Queue field, and then click Forward.
    8. In the New Printer window, click Forward.
    9. Click Forward again.
    10. Type a name for the LPD input device in the Printer Name field.
    11. Click Apply.
  7. On the RICOH ProcessDirector system, copy and modify a workflow that contains the processing steps that you want the jobs that are submitted using the LPD protocol to follow.

    To copy and modify one or more workflows:

    1. Click the Workflow tab.
    2. Right-click the workflow that you want to copy, and click Copy.
    3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    4. Right-click each step and select Properties. Modify the properties as necessary.
      Remove ${Job.InputFile} from the Job name property in the SetJobPropsFromTextFile step.
    5. If you have the AFP Support feature installed and the AFP resources (such as fonts, overlays, and page segments) required by the jobs that are processed through this workflow are not going to be sent inline with the input file, make sure that those resources are available to the RICOH ProcessDirector system. We recommend that you move these resources to /aiw/aiw1/resources or /usr/lpp/psf/reslib, so that they are available to all the components of RICOH ProcessDirector. If you cannot use those directories, you can set the AFP resource path property on one of the steps in the workflow to refer to the directory or directories that hold the resources.
        Note:
      • The AFP resource path can be set as a default job property on various step templates, including EnableRepositioning, PrintJobs, and ConvertLineDataJobIntoAFP. You only need to set the value on one of the steps; the others inherit the value.
    6. To use the workflow, save and enable it by changing , the Save & Enable/Disable switch, to the On position.
    7. Repeat these steps if you want to create additional workflows.
  8. On the RICOH ProcessDirector system, configure an input device so that it assigns the correct workflow or workflows for the input files that it receives. We recommend that you copy and rename one of the supplied LPD input devices, then verify or update the settings described below.
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Right-click the input device that you want to copy and select Copy.
        Note:
      • The new input device is the same type as the copied input device. For example, you cannot create a new LPD input device by copying a hot folder.
    4. In the left pane, click Show all tabs to display all the properties for this input device.
    5. Verify or update the values for these properties:
      Input device name
      Make sure that the input device name does not include any spaces. The LPR client cannot process names with spaces.

      It is best to limit the input device name to 8 characters. Depending on the print command that you use, you might have to create a print queue on the sending system with the same name as the input device. Some systems truncate print queue names to 8 characters.

      Folder location
      The directory on the primary computer that receives jobs from authorized hosts. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that the LPR client sends without filling the file system.
      Staging location
      The directory that RICOH ProcessDirector moves input files to before they are submitted as jobs. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that the LPR client sends without filling the file system. Remember that there might be two copies of an input file in the system at any time, one in the Folder location directory and one in the Staging location directory.
      Parent server
      The RICOH ProcessDirector server where the files will be received; for example, a submitter would specify this server name on the lpr or lprafp command. The server specified here must be configured to accept jobs over the LPD protocol.
    6. To assign workflows to jobs, with either single or multiple input files:
        Note:
      • Input devices with a Linux parent server cannot create a parent job with multiple children. Instead, one parent job and one child job are created for each input file.
      1. Set the Submit step property to SubmitInputFiles and the Workflow property to ParentNoPrint.
      2. Determine how you want the input device to assign the workflow for each single job or child job. You can select one of these:
        • Set the Child workflow initialization step property to SetJobTypeFromRules and use the Child workflow parsing rules property to specify the name of the control file that can set the workflow from a value of an option of the print command.

          RICOH ProcessDirector provides two sample control files that are used to set the workflow. The sample control files, called receive_lpd_jobtype.cfg and receive_lpd_pdf_jobtype.cfg, are installed in the /aiw/aiw1/samples/rules/ directory. You can copy one of the files to the /aiw/aiw1/control_files/rules/ directory and modify it to meet your needs, then update the value of the Child workflow parsing rules property to point to your file.

        • Set the Child workflow initialization step property to SetJobTypeFromFileName and use the Child workflow pattern property to specify the string that RICOH ProcessDirector should look for in the input file name and use as the workflow name. If you use this method, you must make sure that a workflow with the corresponding name exists.
  9. If the control file that you created in the previous step sets job scheduling properties such as Media or Job size based on the values of options of the print command, make sure that the corresponding scheduling properties are set on the target printers in RICOH ProcessDirector. If the scheduling properties do not match, the jobs are not automatically scheduled to those printers.
  10. Make sure that the LPD input devices are connected and enabled.
      Note:
    • The LPD input device does not return status information in response to the lpq command.
  11. From a host system that you authorized, submit some test jobs. If errors occur, correct the errors that messages from the host system or RICOH ProcessDirector identify.

1.2.4.2.4 Configuring to use the pdpr command

If you are migrating from InfoPrint Manager to RICOH ProcessDirector and you use the pdpr command to submit jobs, you can configure RICOH ProcessDirector to continue receiving jobs from the same pdpr command.
The pdpr command in RICOH ProcessDirector is a script that is packaged in a self-extracting Perl script. The script must be installed on all client computers that submit jobs with pdpr. Before you configure the primary server, follow the instructions to install the script on your client computers and configure them correctly, including making updates to the pdpr.cfg file.
The pdpr script in RICOH ProcessDirector creates an lprafp command to submit jobs, adding flags to send supported job property values to the primary server. As a result, the configuration on the primary server is similar to the configuration steps for configuring to use the LPD protocol.

To configure to use the pdpr command:

  1. If any LPD daemons or processes that do not belong to RICOH ProcessDirector (for example, the Common UNIX Printing System [CUPS] LPD daemon) are running on the primary computer (or on a secondary computer that is the parent server of LPD input devices), stop them:
    • On SUSE Linux, start YaST, then click System Network Services to find the LPD services.
    • On Red Hat or a Red Hat-derived operating system, access Terminal and use this command: systemctl list-units --type service --all.

      To stop an LPD service, use this command: systemctl stop <LPD_service>.

      Important:
    • Do not uninstall CUPS.
  2. Open RICOH ProcessDirector.
  3. Click the Administration tab.
  4. In the left pane, click Settings System.
  5. Make sure that all the computers that you installed the pdpr script on are listed in the Hosts allowed to submit LPD jobs property.
  6. Create LPD input devices to receive jobs from the pdpr script. Make sure the name of the input devices match the names that you used in the rules you created in the pdpr.cfg file.

    When you submit a job using pdpr, the pdpr options are converted to options on the lprafp command. The LPD input device uses the file listed in the Child workflow parsing rules property to map options on the lprafp command to RICOH ProcessDirector properties.

    The default value for the Child workflow parsing rules property is the path to the sample receive_lpd_jobtype.cfg or receive_lpd_pdf_jobtype.cfg file. This file contains mappings for most of the lprafp command options that RICOH ProcessDirector supports. You can update or copy the file to add more mappings if needed.

1.2.4.2.5 Preparing for FTP or SCP clients

To get a job into a workflow, an application can copy or send the input file into a hot folder using a variety of methods, including File Transfer Protocol (FTP), Secure Copy Protocol (SCP), and RICOH ProcessDirector Web services.

For security reasons, many administrators disable FTP on their Linux systems. For file transfers, they use SCP instead. Some makers of FTP software are aware of this practice and have added functions to their FTP clients to let them try to use FTP first. If FTP fails, the software tries other methods, including SCP.

For RICOH ProcessDirector, it does not matter which protocol you use to transfer the data files to the input device directory. The most important thing, regardless of the mechanism you use, is to make sure that the job is submitted using a user ID and password that have the correct permissions to let RICOH ProcessDirector access the file.

During installation, RICOH ProcessDirector creates a RICOH ProcessDirector group ( aiwgrp1 is the default) and gives the RICOH ProcessDirector system user ( aiw1 is the default) authority to this group. You can assign the group and system user names or use the defaults. Any user who is in the RICOH ProcessDirector group can access files that RICOH ProcessDirector creates. If you have users with user IDs on the primary computer who need to work directly with RICOH ProcessDirector files (such as users who submit jobs using FTP or SCP), you must add their user IDs to the RICOH ProcessDirector group. Be sure to use the RICOH ProcessDirector group name as an additional group for your users, not as their default group.

When you explain how to submit jobs using FTP (if you have FTP enabled on your system) or an FTP client that uses SCP, tell your job submitters that they must be logged in with a user ID that is a member of the RICOH ProcessDirector group. If they use any other user ID, RICOH ProcessDirector does not have the correct access permissions set on the input file and cannot process the job. The job stays in Error state in the Receive phase until it is deleted and resubmitted correctly.

1.2.4.2.6 Configuring to use JDF job tickets

Before you can submit jobs with JDF tickets, you must configure the input devices that receive the jobs. You also must configure the workflows that the jobs are assigned to. Printers defined as Ricoh PDF printers can manage PDF jobs with JDF tickets better than printers defined as Passthrough or Custom PDF printers can.

If you have Kodak printers that accept PDF, you can send some JDF information to the printer in the KDK data stream recommended by the manufacturer. The Cut Sheet Support for Kodak feature is required.

If you have Xerox printers that accept PDF, you can send some JDF information in the XPIF or XRX data streams recommended by the manufacturer. The Cut Sheet Support for Xerox feature is required.

Before you begin this procedure, review the supplied workflows to see if any of them contain some or all the steps that you want to include. If you find a good workflow, you can copy it and modify it to meet your needs. The workflow must contain a step based on the SetJobPropsFromTextFile step template.

    Note:
  • This step template can use an optional jobID.overrides.jdf file to set more properties on the job.

In addition, determine whether you can use a hot folder input device that RICOH ProcessDirector provides or whether the installation requires a customized input device. RICOH ProcessDirector provides several hot folder input devices that you can use with only minor modifications or that you can copy to create a customized hot folder input device.

Finally, decide which batching method you want to use. The JDF, List, and Pattern batching methods are all suitable for jobs with JDF job tickets.

To configure to use JDF job tickets:
  1. Copy and modify a workflow that contains the processing steps that you want the jobs that are submitted with JDF job tickets to follow:
    1. Click the Workflow tab.
    2. Right-click the workflow that you want to copy and select Copy.
    3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    4. Right-click each step and select Properties. Modify the properties as necessary.
    5. Save and enable the workflow by changing , the Save & Enable/Disable switch, to the On position.
    6. Repeat these steps if you want to create more workflows.
  2. On the RICOH ProcessDirector system, configure an input device so that it assigns the correct workflow for JDF job tickets. We recommend that you copy and rename the supplied HotFolderJDF input device, then verify or update the settings described in the following steps.
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Right-click the HotFolderJDF input device and select Copy.
    4. In the left pane, click Show all to display all the properties for this input device.
    5. Verify or update the values for these properties:
      Workflow
      ParentNoPrint
      Child workflow
      The workflow that is appropriate for the data files in the job.
        Note:
      • If you use the List batching method, select a workflow that includes a step based on the WaitForGroup step template before the PrintJobs step. These steps ensure that the jobs print in order.
      • If you use overrides files, select a workflow that includes a step based on the SetJobPropsFromTextFile step template.
      Data patterns
      One or more pattern-matching strings. The strings define the characters in the name of the data file to match with the names of other files that arrive in the hot folder. If you specify more than one data pattern, the file is considered a match if it matches any pattern. The data pattern is a regular expression.

      If the value of the Create .zip file property is Yes, only files that match the data pattern are included in the .zip file.

      Submit step
      SubmitInputFiles
    6. Verify or update the values for these properties, depending on the batching method that you want to use:
      Property Value when the batching method is JDF Value when the batching method is List Value when the batching method is Pattern
      JDF patterns A pattern that matches some part of the name of your job tickets. For HotFolderJDF, the default value is the regular expression .*\jdf$.    
      List patterns   A pattern that matches some part of the file name of your list files. By default, this value is the regular expression .*lst$.  
      Overrides patterns A pattern that matches some part of the file name of your overrides files. For some supplied hot folder input devices, this value is the regular expression .*oth$. A pattern that matches some part of the file name of your overrides files. For some supplied hot folder input devices, this value is the regular expression .*oth$.  
      Create .zip file
      • Yes: all input files that match the value set in the Data patterns property are combined as a .zip file and submitted as a single job. If the job ticket specifies different settings for different input files and the Create .zip file property is set to Yes, the settings for the first input file name in the job ticket are used for all input files.
      • No: all input files are submitted as child jobs.
      • Yes: all input files that match the value set in the Data patterns property are combined as a .zip file and submitted as a single job. If the job ticket specifies different settings for different input files and the Create .zip file property is set to Yes, the settings for the first input file name in the job ticket are used for all input files.
      • No: all input files are submitted as child jobs.
      No
      File pattern (1 value for each type of input file)     A pattern-matching string that defines a particular type of input file, for example, .*jdf$ for a job ticket or .*pdf$ for a print file.
      Spool file usage (1 value for each type of input file)     A value that identifies what the input file is used for, for example, ticket for a job ticket or print for a print file.
      Spool file type (1 value for each type of input file)     The file extension for the input file.
      File pattern required (1 value for each type of input file)     Whether the job must contain this type of input file.
      File pattern sequence (1 value for each type of input file)     If two or more File pattern values are the same, or if two or more File pattern properties are associated with the same Spool file usage and Spool file type values, the order in which the set of values is applied.
  3. Make sure that the new input device is connected and enabled.
  4. Submit jobs to the new input device. If errors occur, correct the errors that messages from RICOH ProcessDirector or any application that it calls identify.

1.2.4.2.6.1 Locating files

Applications that submit jobs with JDF job tickets can either send the files along with the job ticket, or leave the files in another location on the network. The job ticket is not required to list the files that the job contains. However, if the job ticket does list the files, it can use either relative path names or absolute path names.

Regardless of how RICOH ProcessDirector finds the files, it copies them into the location specified in the Folder location property of the hot folder input device (if they are not there already) and starts to process the job. RICOH ProcessDirector does not automatically delete all the files that are used in jobs that are submitted with JDF job tickets. It only deletes the files in the Folder location. It does not delete files that are in subfolders of the Folder location or that are on other file systems. You must plan to delete the files that are left in the those locations as part of your system maintenance.

Not listing files in JDF

If the job ticket does not list the files, RICOH ProcessDirector expects to receive the job ticket and all the files in the location specified in the Folder location property of the hot folder input device. If any of the files are missing, RICOH ProcessDirector continues to wait for them.

In this case, you must use the List batching method and submit a list file with the job.

Listing files using relative path names

If the job ticket lists the files using relative path names, RICOH ProcessDirector expects to find all the files in subfolders of the Folder location; they cannot be in parallel folders or on any other file systems. For example, if the job ticket includes the file path printfiles/test.pdf, the hot folder expects to find the file in: [folder location]/printfiles/test.pdf.

  • You can use these formats for a relative path name:
    dir/filename
    filename
  • These formats are supported but not recommended:
    file://dir/filename
    file://dir\filename
    dir\filename
    file://./dir/filename
    file://.\dir\filename
    ./dir/filename
    .\dir\filename

In RICOH ProcessDirectorfile:// is equivalent to file:///. RICOH ProcessDirector does not permit a host name or an IP address after the second forward slash (/).

Listing files using absolute path names

If the job ticket lists the files using absolute path names, the files can be anywhere on your network that is accessible from the RICOH ProcessDirector primary server. RICOH ProcessDirector uses the absolute path statements in conjunction with a mapping file to find the files. A mapping file is a file that matches the file paths in the job ticket to file paths on mounted file systems. The mapping file is stored on the primary server. Only one mapping file is needed for a primary server; it can list as many file paths as needed.

When RICOH ProcessDirector looks for the files listed in the job ticket with absolute paths, it looks in each location listed in the mapping file until it finds them. If it reaches the end of the mapping file without finding the files, it looks for files received in the Folder location. If it still does not find the files, it waits and checks again at the next poll interval.

  • You can use these formats for an absolute path name:
    file://hostname/drive:/dir/filename
    Omit drive: for files on systems that do not use drive letters.
  • These formats are supported but not recommended:
    file:///drive:\dir\filename
    file://drive:/dir/filename
    file://drive:\dir\filename
    drive:\dir\filename
    drive:/dir/filename

    In RICOH ProcessDirectorfile:// is equivalent to file:///. RICOH ProcessDirector does not permit a host name or an IP address after the second forward slash (/).

  • These formats are not supported:
    file://IP_address/drive:/dir/filename
    file://localhost/drive:/dir/filename
    
    Note:
  • You need a file system mapping file if the file paths include identical directory names but have different formats. For example, if the job ticket specifies file:\\\C:\myfiles\testfiles\test1.pdf and the actual file path is /myfiles/testfiles/test1.pdf, you must create a file system mapping file to convert the file path from Windows to Linux format.
  • You need a file system mapping file if the file paths include identical directory names but have different drives. For example, if the job ticket specifies file:\\\D:\myfiles\testfiles\test1.pdf and the actual file path is file:\\\C:\myfiles\testfiles\test1.pdf, you must create a file system mapping file to convert the file path from the D drive to the C drive. The mapping looks like this:
    D:\;C:\

1.2.4.2.6.2 Using a mapping file to find input files

If you use a Job Definition Format (JDF) job ticket to submit jobs to a Hot folder device, you do not have to copy all the input files to the Hot folder. When the job ticket is placed in the Hot folder, RICOH ProcessDirector reads it and searches for the input files that it lists.

If the file paths in the job ticket do not match the directory names on a mounted file system, RICOH ProcessDirector uses a file system mapping file to search for the input files.

RICOH ProcessDirector provides a sample file system mapping file, system_map.cfg, in /aiw/aiw1/samples/config/. You can copy and edit this file as necessary. Copy the file to the /aiw/aiw1/control_files/config/ directory before customizing it. Comments in the sample file explain the file format.

To specify the file system mapping file:

  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the File system mapping file field, type the file path of the mapping file.
  4. Click SAVE.

You do not have to restart the system.

1.2.4.2.6.3 Setting job properties from the JDF job ticket

RICOH ProcessDirector can use the values that it supports in the JDF job ticket to set job properties.

RICOH ProcessDirector supports functions defined in the JDF Specification that the system requires, including a subset of the JDF Integrated Digital Printing Interoperability Conformance Specification (IDP ICS) and the associated Application Note. The IDP ICS is based on the JDF combined digital printing process, which is intended for integrated digital printers.

RICOH ProcessDirector does not support all possible values in the JDF job ticket. If RICOH ProcessDirector cannot use a value to set a job property, it will remove unsupported values from the job ticket.

    Note:
  • The IdentifyPDFDocuments step can receive multiple sets of PDF files and job tickets. The step combines them into a single PDF file and a single job ticket. When the step creates the combined job ticket, it includes only values that RICOH ProcessDirector supports. It does not include unsupported values in the combined job ticket. The IdentifyPDFDocuments step is provided by the PDF Document Support feature.

After the property values are set, RICOH ProcessDirector stores the job ticket with the job files. If the job ticket is requested by a step, RICOH ProcessDirector updates the job ticket with the most current job property values in its database and sends the job ticket to the application called by the step. When the application returns the JDF job ticket, RICOH ProcessDirector updates any supported job property values that have changed, and these can be seen in the job property notebook in RICOH ProcessDirector.

The value of the Media property is a special case, because it depends on the setting for Media Matching:

  • If Media Matching is set to Use media product ID or media name, RICOH ProcessDirector uses one of these media names as the value of the Media property for a job:
    • The name of the media object with the matching product ID specified in the job ticket.
    • The name of the media specified in the job ticket.

    RICOH ProcessDirector first checks whether the job ticket specifies a media product ID. If it does, RICOH ProcessDirector looks for a system media object with the same product ID. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job. If RICOH ProcessDirector does not find a match, it looks for a media object with the media name specified in the JDF job ticket. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job.

  • If Media Matching is set to Use the properties selected below, RICOH ProcessDirector uses the media properties (such as size) listed in the job ticket to search the existing system media objects and find one that matches. When it finds an appropriate media object, the name of that object is set as the value of the Media property for the job.

    You can choose the properties that are used for Media Matching based on the needs of your installation.

    If more than one media object matches, RICOH ProcessDirector tries to determine which one is the best match based on the rest of the media properties in the job ticket, including the name of the media. If the system cannot determine the best match or if no media objects match, the job goes to Error state. You can use the Correct Media action on the job to select the media and move the job out of Error state.

If a job ticket specifies values for media and stapling, you can view and change them in the job properties notebook. On the Scheduling tab, the Media required property lists the media values for both the job and any page exceptions. The Stapling required property shows whether stapling is required. You can set the job values in the Media and Staple properties on the Scheduling tab. You can change the page values on the Page Exception tab using the Page exceptions action.

If a job ticket specifies values for sides exceptions, you can view them using the Page Exceptions action on the job. You cannot change the Sides page exceptions.

Available punching and stapling options vary from printer to printer. You can configure some RICOH ProcessDirector printers to be punch-capable or staple-capable, but you cannot configure their finishing patterns for punching or stapling. Therefore, RICOH ProcessDirector might schedule a job to a printer that does not support the punch or staple patterns that you requested. When this happens, the printer applies its best equivalent punch or staple pattern.

1.2.4.2.7 Preparing to submit jobs using web services

RICOH ProcessDirector provides a REST web service utility that you can use to submit jobs. If you can configure your application to use REST web services, you can use the submitFile utility to submit a file to a workflow or hot folder.
Depending on the requirements of your web service application, you need either a Curl command or Request URL to invoke the web service. Use the RICOH ProcessDirector REST API documentation to determine the correct syntax.

To prepare to submit a job using a web service:

  1. Decide how RICOH ProcessDirector receives the file for processing.
    You can submit a file to RICOH ProcessDirector using a hot folder input device or you can submit directly to a workflow.
    • Submit files directly to a workflow when there is only one input file per job or you do not need to use the batching functions available in RICOH ProcessDirector.
    • Submit files to hot folders when you want to use the batching functions in RICOH ProcessDirector. You can only submit one file at a time with the web service. If a job has multiple input files, including job tickets, list files, or other resources, you must invoke the web service for each file.

      Note the name of the workflow or hot folder.

  2. Evaluate your web service application and see what information the application requires to submit a file to RICOH ProcessDirector.
    The RICOH ProcessDirector REST API documentation provides both a Curl command and a Request URL. Either can be used depending on what your web service application requires.
  3. Use the RICOH ProcessDirector REST API documentation for the submitFile utility to help create the web service calls to submit your file.
    Open a web browser and enter your RICOH ProcessDirector hostname or IP address into the address bar. Add /restapi/ to the end of your hostname or IP address to access the REST API documentation. For example: http://hostname:15080/restapi/.

    Open the util section and find POST /util/ submitFile/{objectType}/{name}.

  4. Update your web service application with the command or URL that you developed in previous step. Use the application to submit one or more files to RICOH ProcessDirector.
  5. Verify that your web service application is configured correctly to submit a file to RICOH ProcessDirector.
    • If you submit to a hot folder, verify that the file is in the folder location in the hot folder. Connect and disable the hot folder if you want to check that the files are received in the correct directory without actually submitting the job. If you want the input device to submit the job, make sure it is both enabled and connected when your application submits the file.
    • If you submit to a workflow, verify that a job is created with the file you submitted. Make sure the workflow is enabled when you submit the file.

1.2.4.2.8 Preparing to submit batch jobs

Hot folder and SFTP input devices can submit every file they receive as a separate job, or they can group files together to create larger jobs, called batch jobs. The simplest batch jobs contain only data files. More complex batch jobs include files that set job properties and files that locate files that list the other files in the job.

Before you submit batch jobs, you must determine the kind of files that your jobs include and the appropriate batching method.

    Note:
  • Only hot folder and SFTP input devices can submit batch jobs. Web services input devices cannot.

1.2.4.2.8.1 Batching methods

The way that hot folder and SFTP input devices submit jobs is determined by the Batching method property of the input device.

By default, using any batching method except None causes an input device to create jobs as groups that use the parent/child structure. A parent job contains no data; it is a container that maintains the relationship between other jobs. Those jobs are child jobs. Each input file that a batching method includes in a group becomes a child job.

    Note:
  • If you set the Create .zip file property of an input device to Yes, the input device does not create groups of jobs that use the parent/child structure. Instead, the input device gathers all the input files in the group and creates a ZIP file to hold them. The ZIP file is submitted as a single job. You must have a step in the workflow that unzips the file unless the other steps can process a file in ZIP file format.
  • You can submit all the input files in an input device with the Batch all action on the input device as long as the Batching method is not JDF or Pattern. The Batch all action does not wait for the Polling interval to be reached before creating the jobs.

1.2.4.2.8.1.1 Batch

When the batching method is Batch, the input device submits one or more files as a group, based on the files that an operator selects.

The Batch batching method prevents the input device from submitting jobs immediately. The input device receives files but does nothing until an operator selects one or more data files and clicks Make batch. The input device creates a list file that contains the names of all the data files and submits the job.

When you use the Batch batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the data files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Data patterns: A pattern that matches some part of the file name of your files. For hot folder and SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.2.4.2.8.1.2 JDF

When the batching method is JDF, the hot folder or SFTP input device submits one or more files as a group, based on the contents of the job ticket.

The hot folder or SFTP input device looks for a job ticket containing a list of all the files that make up the job. When the hot folder or SFTP input device finds a job ticket, it reads the ticket and looks for all the files; as soon as it finds all the files, it submits them as a single job. The files print in the order specified in the job ticket.

The file name of the job ticket must match the pattern specified in the JDF patterns property. The default pattern matches files that have the extension .jdf.

The list of files in the job ticket might look like this:

myfile1.pdf
myfile2.pdf
myfile3.pdf
another.pdf

The job ticket might also contain information that is used to set job properties.

When you use the JDF batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs. If the job ticket specifies different settings for different input files and the Create .zip file property is set to Yes, the settings for the first input file name in the job ticket are used for all input files.
  • JDF patterns: A pattern that matches some part of the file name of your job tickets.

    For all input devices except HotFolderJDF the default value is null. For HotFolderJDF this value is the regular expression .*\jdf$.

  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.2.4.2.8.1.3 List

When the batching method is List, the hot folder or SFTP input device submits one or more files as a group, based on the contents of a list file that is received by the input device.

The hot folder or SFTP input device looks for a text-based list file containing a list of all the files that make up the job. When the hot folder or SFTP input device finds a list file, it reads the list and looks for all the files; as soon as it finds all the files, it submits them as a single job. The files print in the order specified in the list file.

The list file must meet these criteria:

  • The file name must match the pattern specified in the List patterns property. The default pattern matches files that have the extension .lst.
  • Each file in the print job must be on a separate line in the list file.
  • The file names listed in the list file must include only file names, not path information; all files must be in the same directory.
The contents of the list file might look like this:
afpinput1.afp
afpinput2.afp
afpinput3.afp
inputfile.afp

When you use the List batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • List patterns: A pattern that matches some part of the file name of your list files.

    By default, this value is the regular expression .*lst$.

  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

    If a print file is listed in the list file, but the file name does not match the Data patterns value, the input device does not identify the file as a print file. Because a listed print file appears to be missing, the input device waits for it and does not create the job.

  • Overrides patterns: if you use overrides files, a pattern that matches some part of the file name of your overrides files.

1.2.4.2.8.1.4 None

When the batching method is None, the hot folder or SFTP input device submits every file as a separate print job.

1.2.4.2.8.1.5 Number

When the batching method is Number, the hot folder or SFTP input device submits a specific number of files as a group. Only files that match the Data patterns property of the hot folder or SFTP input device are counted and submitted.

The hot folder or SFTP input device parses the file name and determines if it matches the value of the Data patterns property. If the name matches the pattern, the hot folder or SFTP input device counts the file. When the number of files reaches the value set for the Number of files to batch property, the hot folder or SFTP input device submits the files as a single group.

When you use the Number batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Number of files to batch: The number of files that the hot folder or SFTP input device waits to receive before submitting the files as a single group.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.2.4.2.8.1.6 Number of sets

When the batching method is Number of sets, the hot folder or SFTP input device submits one or more jobs after a specific number of sets of files are received. Only complete sets of files are counted and submitted.

For a set to be complete, all of these conditions must be true:

  • A file matching the value in the Data patterns property is present.
  • If a value is entered for the Overrides patterns or JDF patterns properties, a file matching one or both of those values is present.
  • If there are any entries specified for File patterns, a file matching each value is present.

When the number of complete sets reaches the value set for the Number of files to batch property, the hot folder or SFTP input device submits the sets as a group with one set in each child job. If the Create .zip file property is set to Yes, a single job containing all of the files in all of the sets is submitted in ZIP file format.

When you use the Number of sets batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all of the files are combined as a ZIP file and submitted as a single job. If this value is set to No, each set is submitted as a child job.
  • Number of files to batch: The number of sets that the hot folder or SFTP input device waits to receive before submitting them as a single group.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.
  • File Patterns: A collection of patterns that can define files that are required to be included in a set.
  • JDF patterns: One or more pattern-matching strings used to identify Job Definition Format (JDF) job tickets. If this property has a value specified, a JDF job ticket is required for the set to be complete.
  • Overrides patterns: One or more pattern-matching strings used to identify files that contain values for job properties.

1.2.4.2.8.1.7 Pages

When the batching method is Pages, the hot folder or SFTP input device submits one or more PDF files as a group, based on the number of pages in the files that are received by the input device. This method is only valid for PDF files.

The hot folder or SFTP input device examines PDF files as they arrive and determines how many pages they contain. The hot folder or SFTP input device maintains a count of the total number of PDF pages currently in the input device. When the total number of PDF pages matches or exceeds the value set for the Number of pages to batch property, the hot folder or SFTP input device submits a group of files.

The PDF file that makes the total number of pages exceed the value set for the Number of pages to batch property is only included in the group if the Exceed pages to batch property is set to Yes. If the Exceed pages to batch property is set to No, this PDF file remains in the hot folder or SFTP input device as the first set of pages for the next batch.

If a single file contains more pages than the value set for the Number of pages to batch property and the Exceed pages to batch property is set to Yes, the file is submitted for printing, either as a batch with the rest of the PDF files that are waiting to print or as a batch that contains only one file. However, if the Exceed pages to batch property is set to No, the file cannot be submitted. Processing for the hot folder or SFTP input device stops until that input file is deleted, the value of the Number of pages to batch property is increased to at least the number of pages in the file, or the Exceed pages to batch property is changed to Yes so the file can be submitted.

    Note:
  • The Pages batching method does not support encrypted or password-protected PDF files. If an encrypted or password-protected PDF file is submitted to a hot folder or SFTP input device that uses the Pages batching method, RICOH ProcessDirector issues an error message because it cannot open the file to count the number of pages.

When you use the Pages batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Number of pages to batch: the number of pages that the hot folder or SFTP input device waits to receive before submitting the files as a single group.
  • Exceed pages to batch: If this property is set to Yes, a PDF file that contains enough pages to make the total number of pages in the hot folder or SFTP input device exceed the value set for Number of pages to batch property will be submitted with the rest of the files. If this property is set to No, this file will remain in the hot folder or SFTP input device as the first set of pages for the next batch.
  • Data patterns: a pattern that matches PDF file names, such as .*pdf$ or .*PDF$.

1.2.4.2.8.1.8 Pages in sets

When the batching method is Pages in sets, the hot folder or SFTP input device submits one or more jobs after a set of PDF files with a specified page count is received by the in put device. This method is only valid for PDF files.

For a set to be complete, all of these conditions must be true:

  • A file matching the value in the Data patterns property is present.
  • If a value is entered for the Overrides patterns or JDF patterns properties, a file matching one or both of those values is present.
  • If there are any entries specified for File patterns, a file matching each value is present.

The hot folder or SFTP input device examines the PDF files as they arrive and determines how many pages they contain. The hot folder or SFTP input device maintains a count of the total number of PDF pages in complete sets currently in the input device. When the total number of PDF pages in complete sets matches or exceeds the value set for the Number of pages to batch property, the hot folder or SFTP input device submits the sets as a group with one set in each child job. If the Create .zip file property is set to Yes, a single job containing all of the files in all of the sets is submitted in ZIP file format.

The set containing a PDF file that makes the total number of pages exceed the value set for the Number of pages to batch property is only included in the group if the Exceed pages to batch property is set to Yes. If the Exceed pages to batch property is set to No, this set remains in the hot folder or SFTP input device as the first set for the next batch.

If a single set contains more pages than the value set for the Number of pages to batch property and the Exceed pages to batch property is set to Yes, the set is submitted for printing, either as a batch with the rest of the sets that are waiting to print or as a batch that contains only one data file. However, if the Exceed pages to batch property is set to No, the set cannot be submitted. Processing for the hot folder or SFTP input device stops until that input file is deleted, the value of the Number of pages to batch property is increased to at least the number of pages in the set, or the Exceed pages to batch property is changed to Yes so the set can be submitted.

    Note:
  • The Pages in sets batching method does not support sets with encrypted or password-protected PDF files. If a set with an encrypted or password-protected PDF file is submitted to a hot folder or SFTP input device that uses the Pages in sets batching method, RICOH ProcessDirector issues an error message because it cannot open the file to count the number of pages.

When you use the Pages in sets batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all of the files are combined as a ZIP file and submitted as a single job. If this value is set to No, each set is submitted as a child job.
  • Number of pages to batch: The number of pages that the hot folder or SFTP input device waits to receive before submitting the files as a single group.
  • Exceed pages to batch: If this property is set to Yes, a PDF file that contains enough pages to make the total number of pages in the hot folder or SFTP input device exceed the value set for Number of pages to batch property will be submitted with the rest of the files. If this property is set to No, this file will remain in the hot folder or SFTP input device as the first set of pages for the next batch.
  • Data patterns: A pattern that matches PDF file names, such as .*pdf$ or .*PDF$.
  • File Patterns: A collection of patterns that can define files that are required to be included in a set.
  • JDF patterns: One or more pattern-matching strings used to identify Job Definition Format (JDF) job tickets. If this property has a value specified, a JDF job ticket is required for the set to be complete.
  • Overrides patterns: One or more pattern-matching strings used to identify files that contain values for job properties.

1.2.4.2.8.1.9 Pattern

When the batching method is Pattern, the hot folder or SFTP input device copies one print file and its related files to the spool file directory for the job as soon as it has all the required files. All these files must match the values set for the Data patterns property and the properties on the Batching tab of the input device properties notebook.

When you use the Pattern batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: No

For example, you might want to send a JDF job ticket file along with an overrides file and a data file for a job. If a job ticket input file ends in .jdf and should have spool file usage "overrides" and spool file type "jdf", you can associate those three patterns with each other. Using RICOH ProcessDirector regular expression syntax, you define a series of input file name patterns that a hot folder or SFTP input device will recognize and include in the new job it creates. This table shows a simple example of files that can be processed together using pattern-matching.

Data pattern File pattern File usage File type Spool file type Example matching file name Example spool file name Notes
.*$ .*jdf$ overrides Other jdf abc000317.jdf /aiw/aiw1/spool/default/10000143/10000143.overrides.jdf JDF job ticket
.*$ .*oth$ overrides Other txt abc00317.oth /aiw/aiw1/spool/default/10000143/10000143.overrides.txt Overrides file
.*$ .*pdf$ print Data pdf abc00317.pdf /aiw/aiw1/spool/default/10000143/1000143.print.pdf PDF file

You can use the Data patterns property and the File Patterns property to create precise file name and file type matches. If you want to use parts of the pattern from the Data patterns field as part of a file pattern, surround those parts of the Data patterns expression in parentheses, forming a backreference that you express in the File Patterns field with a backslash and a number. This table shows the results of pattern matching using a backreference:

Tab Field Value Description
Batching Data patterns (.*)\.pdf The expression (.*) defines a backreference to the data file name without the extension. When a data file name matches this pattern, all the characters that match (.*) are assigned to backreference \1.
Batching File pattern \1\.jdf Matches the data file name, but changes the extension to .jdf. Job1.pdf and Job1.jdf are considered a match and are included in the job, but Job2.jdf does not match.

In a more complex example:

Tab Field Value Description
Batching Data patterns (abc)(def)\.pdf,.*-(12)-.*\.pdf

The data file must match one of these two comma-separated patterns.

Data pattern 1: \1 = abc and \2 = def

The expressions (abc) and (def) define backreferences to the data file name. The extension must be .pdf.

A data file that matches pattern 1 is abcdef.pdf.

Data pattern 2: \1 = 12

The expression (12) defines a backreference requiring that the data file is for the month of December (assuming the date format of a data file is year-month-day. The extension must be .pdf.

A data file that matches pattern 2 is 2011-12-02.pdf.

Batching Overrides patterns \1\.oth

The overrides file must be named abc.oth to match data pattern 1.

Batching File pattern 2011-(\1)\.jdf

The file 2011-12.jdf matches data pattern 2.

File usage overrides
File type jdf
Required Yes
Sequence 1
Batching File pattern \2\1\.jdf

The file defabc.jdf matches data pattern 1.

File usage overrides
File type jdf
Required Yes
Sequence 2
Batching File pattern \1\.txt

The file 12.txt matches data pattern 2.

File usage file
File type txt
Required No
Sequence 3

To edit the Batching tab:

  • To add a file pattern, type values in the fields on the Batching tab, and click Add. Type values in the fields and click Save.
  • To remove a file pattern, select the checkbox for that file pattern and click Remove.
  • To edit a file pattern, select the checkbox for that file pattern and click Edit. The values display in the file pattern entry fields; change them as needed and click Save.
  • If you create two file patterns that are the same, or if a pattern's file type and usage match another pattern's file type and usage, a warning message displays, but you can still add the pattern. The first file pattern encountered is processed, based on the value of the Sequence property.
  • To cancel a change, click Cancel. The system cancels the last unsaved change.

Keep these tips in mind as you set up patterns on the Batching tab:

  • We recommend that you define your patterns carefully, especially for required files, so that only one file matches the specified pattern. It is not possible to specify that more than one file must match a pattern; as soon as one required file matches the pattern, the system considers the requirement met, and will start processing the job when at least one matching required file for each defined pattern is present in the hot folder or SFTP input device.
  • Remember to click OK to save your changes before leaving the page. If you leave the page without saving your changes, the changes are discarded.
  • The rules that you specify in the table are processed in sequence order (from top to bottom); if any conflicting rows exist in your table, the first pattern in the sequence will be used.
  • When you use the Pattern batching method, use these guidelines for the fields in the Advanced tab:
    • Use the Overrides pattern field in the Advanced tab, not in the Batching tab.
    • Do not use the JDF patterns field in the Advanced tab; define those patterns in the Batching tab.

1.2.4.2.8.1.10 Sets by time

When the batching method is Sets by time, the hot folder or SFTP input device submits one or more jobs containing complete sets of files that arrive within a specified time period. The time period is determined by the values set for the Batching start date, Batching start time, Batching interval, and Batching date or Frequency properties.

For a set to be complete, all of these conditions must be true:

  • A file matching the value in the Data patterns property is present.
  • If a value is entered for the Overrides patterns or JDF patterns properties, a file matching one or both of those values is present.
  • If there are any entries specified for File patterns, a file matching each value is present.

The hot folder or SFTP input device waits until the date and time specified in the Batching start date and Batching start time properties, then submits one or more complete sets of input files at a specific time or time interval determined by the values set for the Batching interval and Batching date or Frequency properties. The hot folder or SFTP input device submits the sets as a group with one set in each child job. If the Create .zip file property is set to Yes, a single job containing all of the files in all of the sets is submitted in ZIP file format. The files print in the order specified by their Last modified timestamp.

    Note:
  • If complete sets of files exist in the hot folder or SFTP input device prior to the initial date and time set in the Batching start date and Batching start time properties, those sets will be included in the first batch submitted by the input device.
  • For the Batching start time property, use the time zone of your browser. The value is displayed based on the time zone of the computer that you use to open the user interface, but it is stored in a generic format. The hot folder or SFTP input device interprets the generic time format based on the time zone of its parent server and creates batches at the specified time.

When you use the Sets by time batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all of the files are combined as a ZIP file and submitted as a single job. If this value is set to No, each set is submitted as a child job.
  • Batching start date: The date when the input device begins to use the Sets by time batching method.
  • Batching start time: The time when the input device begins to use the Sets by time batching method.
  • Batching interval: The time interval used to determine when or how often to submit a group of files.
  • Batching date or Frequency: Used with the Batching interval property, this property specifies exact values for when or how often to submit a group of files.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.
  • File Patterns: A collection of patterns that can define files that are required to be included in a set.
  • JDF patterns: One or more pattern-matching strings used to identify Job Definition Format (JDF) job tickets. If this property has a value specified, a JDF job ticket is required for the set to be complete.
  • Overrides patterns: One or more pattern-matching strings used to identify files that contain values for job properties.

1.2.4.2.8.1.11 Time

When the batching method is Time, the hot folder or SFTP input device submits one or more files as a group. Only files that match the Data patterns property and that arrive during the time period determined by the values set for the Batching start date, Batching start time, Batching interval, and Batching date or Frequency properties are submitted.

The hot folder or SFTP input device waits until the date and time specified in the Batching start date and Batching start time properties, then submits one or more groups of input files at a specific time or time interval determined by the values set for the Batching interval and Batching date or Frequency properties. The files print in the order specified by their Last modified timestamp.

    Note:
  • If files exist in the hot folder or SFTP input device prior to the initial date and time set in the Batching start date and Batching start time properties, those files will be included in the first batch submitted by the input device.
  • For the Batching start time property, use the time zone of your browser. The value is displayed based on the time zone of the computer that you use to open the user interface, but it is stored in a generic format. The hot folder or SFTP input device interprets the generic time format based on the time zone of its parent server and creates batches at the specified time.

When you use the Time batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Batching start date: The date when the input device begins to use the Time batching method.
  • Batching start time: The time when the input device begins to use the Time batching method.
  • Batching interval: The time interval used to determine when or how often to submit a group of files.
  • Batching date or Frequency: Used with the Batching interval property, this property specifies exact values for when or how often to submit a group of files.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.2.4.2.8.1.12 Overrides files

When you create a workflow, you can set default values for many job properties. However, those default values might not be appropriate for every job. If you want to send different values with a print job, you can use an overrides file.

An overrides file is a text file that contains property and value pairs for job properties; it can be submitted with a print file. When the job is sent to a workflow, the SetJobPropsFromTextFile step can use the information in the overrides file to replace the default values.

The overrides file must meet these criteria:

  • The overrides file must arrive in the hot folder or SFTP input device after the print file.
  • You must create a separate overrides file for each print file in the job.
  • The file name must match the pattern specified in the Overrides patterns property. The default pattern matches files that have the extension .oth.
  • Each property and value pair must be on a separate line.
  • For hot folder or SFTP input devices, each pair must be expressed as: database property name=value, with no spaces before or after the equal sign (=).
    Note: Overrides files that are used with Download input devices follow a different format and requires the AFP Support feature to be installed.

You can use either of these formats for an overrides file:

  • Use the RICOH ProcessDirector database names for the properties, and list each property and value on a separate line. For example:
    Job.Duplex=Yes
    Job.CustomerName=BankName
    Job.Location=Boulder
  • If the AFP Support feature is installed and the overrides arrive in JCL format from a Download input device, the receive_jcl_jobtype.cfg file is configured to interpret JCL format. The mainframe program creates the overrides file in JCL format.

To submit one or more print files and their accompanying overrides files in the same job, you must use the List batching method and submit a list file with the job. The list file contains the name of each print and overrides file; a print file must be listed before the associated overrides file. The list file might look like this:

input1.pdf
values.oth
input2.pdf
morevalues.oth
input3.pdf
values3.oth
inputfile.pdf
inputfile.oth

Use the RICOH ProcessDirector database names for the properties, and list each property and value on a separate line. For example:

Job.Duplex=Yes
Job.CustomerName=BankName

1.2.4.2.8.1.13 List files

You can use list files to process multiple files with or without a JDF job ticket or to process overrides files with files.

The limitations of using a list file with a job ticket include:

  • The files must be submitted with the job ticket; they cannot be located on another system and accessed using a mapping file.
  • All the files must be submitted directly to the Folder location, not to a subfolder.

If you use a list file, you must use the List batching method.

You can use list files in these ways:

  • If the job ticket does not include the names of all the input files, the list file can include them along with the name of the job ticket file. When all the files are present, the job is submitted.
  • You can create a generic job ticket, which uses placeholder file names instead of real file names, so you can reuse the ticket with different jobs. The list file contains the names of the specific files that are used for the job. The order of the file names in the list file must correspond to the placeholder file names in the job ticket; the first file listed in the list file must correspond to the first placeholder file listed in the job ticket.

    For example, if your application prints various booklets that all contain four files (a front cover, a fly leaf, the body of the booklet, and a back cover), you can create a job ticket that includes four files in the order that they should print:

    frontcover.pdf
    flyleaf.pdf
    bookletbody.pdf
    backcover.pdf
    Note: In this case, the job ticket must include only file names without any path information.

    For each booklet, you can then create a list file that lists the specific files in the same order:

    • Booklet 1 list file contains:
      booklet1fc.pdf
      booklet1fl.pdf
      booklet1body.pdf
      booklet1bc.pdf
    • Booklet 2 list file contains:
      booklet2fc.pdf
      booklet2fl.pdf
      booklet2body.pdf
      booklet2bc.pdf

  • You can create a list file that contains the name of the input file or files and the overrides files that are associated with them. The name of the overrides file must appear immediately after the input file that it is associated with in the list. The names of the input files and overrides files are case-sensitive and each file name must be on a separate line. Do not include directory information with the file name. For example, the list file might contain this information:
    input1.pdf
    prop1.oth
    input2.pdf
    prop.oth
    input3.pdf
    duplex.oth
    input4.pdf
    inputfiles.oth

1.2.4.2.9 Preparing to receive XML

How you receive and process XML files depends on the information in the files and what you want to do with the information.

Before you do these tasks, read the usage scenario and examples for processing orders in an XML file. Those topics give examples for the steps in this topic.

To prepare to receive XML:
  1. Evaluate the XML files that provide input to the process. Make sure that you understand what information the files contain and how the information is organized.

    If possible, ask the XML provider for the XML Schema Definition (XSD).

  2. Decide how to process the XML files in RICOH ProcessDirector. These step templates manipulate XML:

    • A step based on the CreateJobsFromXML step template creates jobs from elements in an XML file that match an XPath expression. The step submits the jobs to a workflow.
    • A step based on the ApplyXSLTransform step template transforms XML into a file that specifies the values of RICOH ProcessDirector job or document properties. The step also transforms XML into another XML format.

    You can use steps based on other step templates, such as RunExternalProgram, to manipulate XML files.

  3. To extract values for RICOH ProcessDirector job and document properties, identify the XML elements and attributes that supply values for the properties.
      Note:
    • The PDF Document Support feature or AFP Support feature is required to use document properties.
  4. Decide how many CreateJobsFromXML steps are required to process the XML.

    When you create the workflows that process XML files, you decide which workflow receives the new jobs output by each CreateJobsFromXML step. You also decide whether the new jobs are child jobs.

    For example:

    • Your XML file contains multiple orders, and each order contains multiple items. A hot folder input device receives the XML files and processes them with the first workflow.

      A CreateJobsFromXML step in the first workflow creates a job for each order and submits the jobs to a second workflow. That workflow extracts information about the order.

      A CreateJobsFromXML step in the second workflow creates a job for each item in the order and submits them as child jobs to a third workflow. The third workflow processes the item jobs.

    • Your XML file contains a list of book titles and the PDF files required to print each book. An input device receives requests to print one or more copies of a book on the list and assigns the job to a workflow.

      Using the book title in the request, a CreateJobsFromXML step in the workflow creates an XML job with the PDF files required to print the book. The step submits the job to a second workflow.

      A CreateJobsFromXML step in the second workflow creates an XML job for each PDF file (one for the cover and another for the text). The step submits the jobs as child jobs to a third workflow. The third workflow prints the cover and text jobs.

    • Your XML file contains a list of document properties to add to the document properties file for a job.

      An ApplyXSLTransform step transforms the XML into a comma-separated values file that the workflow uses as a property conditions file. The workflow does not have a CreateJobsFromXML step.

      A SetDocPropsFromConditions step reads the property conditions file and sets the document properties based on the values supplied in the XML file.

  5. For each CreateJobsFromXML step, define the XPath expression required to create jobs from elements in the XML input file.
    Usually, the workflow that receives jobs from a CreateJobsFromXML step has an ApplyXSLTransform step to transform elements in the XML into RICOH ProcessDirector job or document properties.
  6. For each ApplyXSLTransform step, use a third-party XSLT tool (such as Altova MapForce) to create an XSLT style sheet.
    • To transform XML elements into RICOH ProcessDirector job properties in an overrides file, see the sample XSLT style sheet for processing orders in an XML file.

      Make the output file for the ApplyXSLTransform step ${getFileName(overrides,text,write)}.

    • After you install a document processing feature, see the information center topic for adding a step to transform XML elements into RICOH ProcessDirector document properties.
  7. Decide how to receive XML files for processing.
    You can submit XML files to a hot folder input device or place an XML file at a location where the RICOH ProcessDirector server retrieves it.

    For example:

    • If your XML file contains multiple orders, and each order contains multiple items, submit the XML files to a hot folder input device.
    • If your XML file contains a list of book titles and the PDF files required to print each book, place the file at a convenient location. Update the file whenever the book titles and print files change.

      When a CreateJobsFromXML step runs, it uses an XPath expression to create an XML job from information in the list.

  8. If you place an XML file at a location from which the RICOH ProcessDirector server retrieves it, decide how to submit jobs to the workflow.

    One way is to submit an overrides file to a hot folder. The overrides file triggers the hot folder to create a job and submit it to the workflow.

    To use an overrides file as a trigger, set these properties when you define the hot folder:

    • Set the Completion method property to Trigger.
    • Specify the same pattern value for both the Trigger patterns and Overrides patterns properties.

You now have the information, XPath expressions, and XSLT style sheets required to define workflows to process XML.

1.2.4.2.10 Preparing to receive JSON

After you receive a JSON file, you convert it to XML. How you process the XML files depends on the information in the JSON files and what you want to do with the information.
To prepare to receive JSON:
  1. Evaluate the JSON files that provide input to the process. Make sure that you understand what information the files contain and how the information is organized.

    If possible, ask the JSON provider for the JSON Schema.

  2. Decide how to process the XML files that you convert the JSON files into. RICOH ProcessDirector provides two step templates that manipulate XML:
    • A step based on the CreateJobsFromXML step template creates jobs from elements in an XML file that match an XPath expression. The step submits the jobs to a workflow.
    • A step based on the ApplyXSLTransform step template transforms XML into a file that specifies the values of RICOH ProcessDirector job or document properties. The step also transforms XML into another XML format.

    For more information, see the related task about preparing to receive XML.

  3. Decide how to receive JSON files for processing.
    You can submit JSON files to a hot folder input device or place a JSON file at a location from which the RICOH ProcessDirector server retrieves it.
    For example:
    • If your JSON file contains multiple orders, and each order contains multiple items, submit the JSON files to a hot folder input device.
    • If your JSON file contains a list of book titles and the PDF files required to print each book, place the file at a convenient location. Update the file whenever the book titles and print files change.
  4. If you submit JSON files to a hot folder, place a step based on the ConvertJSONToXML step template after the SetJobPropsFromTextFile and DetectInputDataStream steps.
    Use the default values for the JSON input file and XML output file.
  5. If you place a JSON file at a location from which it is retrieved, place a ConvertJSONToXML step before the first step that processes XML.
    For example, place the ConvertJSONToXML step before the CreateJobsFromXML or ApplyXSLTransform step.
    Specify the property values for the step:
    • For the JSON input file property, specify the directory path and name of the file with the JSON.
    • For the XML output file property, specify the directory path and name of the XML file that you want RICOH ProcessDirector to create.
  6. Compare the output file with the input file to see how RICOH ProcessDirector converted JSON into XML.

1.2.4.2.11 Configuring to submit jobs from the Main page

You can submit jobs to RICOH ProcessDirector using the Submit Jobs portlet on the Main page.
Jobs can be submitted to an hot folder input device that is enabled and connected or to a workflow that is enabled. The input device or workflow must also be configured to accept jobs submitted using the portlet.
To submit jobs from the Main page:
  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
    1. Right-click the hot folder input device that can receive jobs submitted from the Submit Jobs portlet and select Properties.
    2. Set the Accept job submission property to Yes.
    3. Repeat for other hot folders as needed.
  3. Click the Workflow tab.
    1. Right-click the workflow that can receive jobs submitted from the Submit Jobs portlet and select Properties.
    2. Set the Accept job submission property to Yes.
    3. Repeat for other workflows as needed.

1.2.4.2.12 Submitting jobs in the Submit Job portlet

RICOH ProcessDirector provides different mechanisms to submit jobs, including a portlet on the Main page.
Before you begin, make sure that you have permission to use the Submit Jobs portlet, and the hot folder is enabled and connected or the workflow is enabled.
To submit jobs in the Submit Job portlet:
  1. To add the Submit jobs portlet on the Main page, hover over the Main tab until the menu appears, then select Submit Jobs.
  2. To browse for files, click and select the files that you want to submit for processing. Or, you can select the files from your computer, hold down the mouse button, drag and drop onto the Submit Jobs portlet. Release the mouse button when the Submit Jobs portlet area turns blue.
  3. To send a job to a specific input device, select Submit to Input device. From the drop-down list, select which input device to process your jobs.
  4. To send a job to a specific workflow, select Submit to Workflow. From the drop-down list, select which workflow to process your jobs.
  5. Click OK.
  6. Repeat for other files as needed.
  7. To clear the contents of the Submit Jobs portlet, click Dismiss.

1.2.4.3 Importing WSDL files

A Web Service Description Language (WSDL) file describes how a SOAP web service is called, including the parameters it accepts and the data structures it returns. You import WSDL files for all SOAP web services that you call to communicate with an application. RICOH ProcessDirector creates SOAP request objects from SOAP operations in each WSDL file.
RICOH ProcessDirector SOAP web service input devices, notifications, and CallSOAPService steps call SOAP web services. Before you define a RICOH ProcessDirector object or step that calls a SOAP web service, import the WSDL file associated with the SOAP web service.
    Note:
  • SOAP web service input devices and notifications are included in the Web Services Enablement feature.

To import WSDL files:

  1. Download to your computer all the WSDL files required to make calls to SOAP web services provided by the application.
  2. In the RICOH ProcessDirector user interface, click the Administration tab.
  3. In the left pane, click System Import WSDL.
  4. In the left pane, click Utilities Import WSDL.
  5. Type a value for the WSDL prefix property.

    RICOH ProcessDirector prepends this value and a hyphen to the name of each SOAP request object that it creates.

    For example, the WSDL file contains 2 SOAP requests: GetOrdersByDate and GetOrdersByOrderNumber. Type DigitalStore in the WSDL prefix field. After you import the WSDL file, the names of the 2 SOAP request objects are DigitalStore-GetOrdersByDate and DigitalStore-GetOrdersByOrderNumber.
  6. Click Browse () and select a WSDL file that you downloaded to your computer.
    The name of the WSDL file appears following the Browse button (), for example, Orders.xml.
  7. Click Import.
    An informational message shows the names of the SOAP request objects that RICOH ProcessDirector created.

    RICOH ProcessDirector uses the value of the WSDL prefix property as the name of the WSDL file. The extension is wsdl-number where number is a 13–digit number. For example: DigitalStore.wsdl-1234567890123. RICOH ProcessDirector places the WSDL file in the /aiw/aiw1/wsdl directory (Linux) or the C:\aiw\aiw1\wsdl directory (Windows).

  8. To import another WSDL file, repeat these steps.
  9. When you finish importing WSDL files, click Close.
The SOAP request objects that you import become selections for the SOAP request property. You set a value for that property when you define a SOAP web service input device, a SOAP web service notification, or a CallSOAPService step.

You cannot edit or delete a SOAP request object.

1.2.4.4 Preparing to retrieve REST web services input

To retrieve input from a REST web service for an application, identify the parameters used to call the REST web service. Test the exchange of data between RICOH ProcessDirector and the application. Then define and configure a REST web service input device.
To prepare to retrieve REST web services input:
  1. Learn the requirements for communication with the REST web service for the application:
    • The values for authenticating with the application
    • The values for requesting data from the REST web service
    • The format of the data provided in the response

    Refer to the documentation for the application or consult with the company that hosts the application.

  2. To prepare RICOH ProcessDirector to communicate with the application, do these tasks:
    • If the application requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.
    • If your environment requires a proxy server to communicate with web services, set up the system to use it.

    For more information, see the related tasks.

  3. Run a manual test that authenticates with the application and requests a response from the REST web service. Verify that the web service returns the response that you want.
    Many browsers have plug-ins, such as Boomerang for Google Chrome, that test web service calls to REST clients.
  4. Decide how you want the REST web service input device to create jobs from the data in the response returned by the web service.
    • Every time the input device receives a response, it can create a job containing all XML or JSON data in the response.
    • The input device can examine the response using an XPath or JSONPath expression.

      If the input device finds XML elements or JSON objects specified by the expression, it creates a job for each matching element or object. Each job contains the matching element or object and all the elements or objects nested within it. If the input device finds two or more elements or objects, it can create independent jobs or child jobs.

      If the input device does not find matching elements, it does not create a job.

  5. Define a REST web service input device:
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Click Add REST web service.
    As an alternative, you can copy the supplied RestfulWebServiceSample REST web service input device.
  6. On the General tab:
    • Type a name for the input device.
    • Set the Polling interval property to the time that you want the input device to wait between web service calls.
    • After you define a workflow to process the XML or JSON jobs, set the Child workflow property to the name of that workflow.
    • Enter values for other properties that you want to set.
  7. On the Request tab:
    1. Set the Request URL property to the URL of the web service that returns data that RICOH ProcessDirector uses to create one or more jobs.
    2. Set the Request method and Request content type properties to the values required by the web service.
    3. For the value of the Request payload property, specify the body of the web services request that the input device submits to the application.
      To specify a credential or token and a time range that matches the value of the Polling interval property, use symbols for these properties:
      Database name of property User interface name of property Remarks
      WebService.Credential None RICOH ProcessDirector stores the web service credential or token in this property.
      WebService.CurrentRequestTime None RICOH ProcessDirector sets the value of this property at the start of the polling interval.
      WebService.LastSuccessRequestTime Status tab: Time of last successful request When the input device successfully communicates with the application, RICOH ProcessDirector sets the value of this property to match the value of the WebService.CurrentRequestTime property. A successful communication results in a response code 200, even if no data is received that RICOH ProcessDirector can use to create jobs.
        Note:
      • These three job properties are used as example XML values for the Request payload property and as example JSON values for the Request parameters property. The requirements of the web service determine which properties you use to submit these and other values.

      In this XML example, the payload includes these elements: <Token>, <TimeRange>, <Start>, and <End>. The values of three elements are symbols:

      <Token>${WebService.Credential}</Token><TimeRange> <Start>${WebService.LastSuccessRequestTime}</Start> <End>${WebService.CurrentRequestTime}</End></TimeRange>

      The input device resolves the symbols when it polls for input.

    4. Set the values for the Request header and Request parameters properties, as required.
      Each header field or parameter is a keyword/value pair. Each pair must appear on a separate line and must be separated using a colon (:) or equals sign (=).

      The keyword and value can be multiple words. RICOH ProcessDirector uses the first colon or equals sign on each line to split the words into the keyword/value pair.

      This example contains three parameters: token, start, and end. The value of each keyword is a RICOH ProcessDirector symbol. Each symbol contains one of these properties: WebService.Credential, WebService.LastSuccessRequestTime, and WebService.CurrentRequestTime.

      token:${WebService.Credential}start:${WebService.LastSuccessRequestTime}end:${WebService.CurrentRequestTime}

      The input device resolves the symbols when it polls for input.

    5. Select a value for the Create job from response property to specify how the input device creates jobs from the input:
      • To create a job every time the input device receives a response, select Always.
      • To examine the XML or JSON in the response and create a job each time that an XML element or JSON object is found, select Only when response pattern matches.
    6. If you selected Only when response pattern matches:
      • Set the Response pattern to match property to the XPath expression that identifies the XML element or to the JSONPath expression that identifies the JSON object.
      • Set the Create child jobs property to Yes if you want to create child jobs when the input device finds two or more matches. The input device also creates a parent job without any data. If the input device finds one match, it creates an independent job.
      • Set the Create child jobs property to No if you want to create independent jobs regardless of how many matches the input device finds.
    7. If your environment requires a proxy server to communicate with web services, set the Use proxy property to the correct proxy server.
    8. Set the Time zone offset property to the offset in hours between Coordinated Universal Time (UTC) and the time zone used by the web service.
      For example, if the web service uses Pacific Standard Time, set the property to -8.
        Note:
      • Make sure that you change this property when a location that hosts the web service changes between standard and daylight savings time. Otherwise, during the lost or gained hour, you can lose the data that RICOH ProcessDirector uses to create jobs.
      • If the web service uses UTC, enter 0 or leave the field blank.
  8. On the Authentication tab, specify the values required to authenticate with the application.
    For more information, see the related task about authenticating with a REST web service.

    If the application does not require authentication, leave all the Authentication properties blank.

  9. Optional: On the Advanced tab, specify any optional properties for your environment.
  10. When you finish, click OK.

When you finish setting up your input devices, notifications, and workflows, test the exchange of data between RICOH ProcessDirector and the application.

Example

Examine the supplied RestfulWebServiceSample REST web service input device.

1.2.4.4.1 Using a REST web service to authenticate with an application

REST web service input device and notification objects can use a REST web service to authenticate with an application. RICOH ProcessDirector supports both API key and session authentication. Input device objects authenticate when they poll for input. Notification objects authenticate when they send status to the application.

For API key authentication, you put an authorization code in a Static credential property or define an HTTP user ID and password. The input device or notification passes the authorization code or the HTTP user ID and password to the web service that exchanges data. The web service then authenticates with the application and returns a response.

For session authentication, you put authentication credentials (user ID and password) and other values in a set of authentication request properties. The input device or notification first calls a REST web service to authenticate with the application. After a successful authentication, the web service returns a token to the input device or notification. The input device or notification then transmits the token in the call to the web service that exchanges data.

  • If the application allows one session per user, set up your input devices and notifications to call the web services with different user IDs and passwords.
  • Session authentication occurs with every web service call and logging out is not required. Make sure that the length of the session for each set of credentials is shorter than the time between calls to the web service. For example, the session for an input device expires after 10 minutes. When you configure the input device, specify a polling interval greater than 10 minutes.

To get an API key or authentication credentials for an application, contact the company that hosts the application. For format and syntax requirements, refer to the documentation of the application.

To use a REST web service to authenticate:
  1. Click the Authentication tab on the REST web service input device or notification.
  2. Follow the instructions for the type of authentication that the application requires:
    • For API key authentication, specify the authentication code as the value of the Static credential property.

      Leave all the other properties blank. You have completed this procedure.

    • For session authentication, leave the Static credential property blank. Go to the next step and specify the other properties.
  3. Set the Authentication request URL property to the URL that RICOH ProcessDirector uses to authenticate with the application.
  4. Specify the authentication credentials by entering values required by the application in one or more of these properties: Authentication request payload, Authentication request header, and Authentication request parameters.
    • For the value of the Request payload property, specify the body (if any) of the authorization request that is submitted to the application.

      In these examples, the payload includes three XML elements: <Credentials>, <Name>, and <Password>. The value of the <Password> element is a symbol that uses the Authentication request password property.

      This example uses the Authentication request password property for input devices:

      <Credentials> <Name>myname</Name> <Password>${WebService.AuthRequestPwd}</Password></Credentials>

      This example uses the Authentication request password property for notifications:

      <Credentials> <Name>myname</Name> <Password>${WSNotification.WebService.AuthRequestPwd}</Password></Credentials>

      The input device or notification resolves the symbol when it sends the authentication request.

    • Set the values for the Request header and Request parameters properties, as required.

      Each header field or parameter is a keyword/value pair. Each pair must appear on a separate line and must be separated using a colon (:) or equals sign (=).

      The keyword and value can be multiple words. RICOH ProcessDirector uses the first colon or equals sign on each line to split the words into the keyword/value pair.

      These examples contain two parameters: name and pwd. The value of the pwd keyword is a symbol that uses the Authentication request password property.

      This example uses the Authentication request password property for input devices:

      name:mynamepwd:${WebService.AuthRequestPwd}

      This example uses the Authentication request password property for notifications:

      name:mynamepwd:${WSNotification.WebService.AuthRequestPwd}

      The symbol is resolved when the authentication request is sent.

  5. Set the Request method and Request content type properties to the values required by the web service.
  6. Set the Authentication response attribute property to the XPath expression that identifies the credential for the session in the response from the web service.
  7. Set the Authentication request password property to the password for your account with the application.
    The password is encrypted when it is stored in RICOH ProcessDirector.
For both API key and session authentication, RICOH ProcessDirector stores the static credential or token returned from the application in a property.
  • For input devices, the property is WebService.Credential.
  • For notifications, the property is WSNotification.WebService.Credential.

When you specify values on the Request tab for a web service input device or notification, you specify the WebService.Credential or WSNotification.WebService.Credential property as a symbol.

RICOH ProcessDirector substitutes the value of the static credential or token for the symbol when it transmits the request to a web service.

Now that you have specified the values required to authenticate with the application, complete the steps for defining and configuring the input device or notification. Return to one of these topics:
  • Preparing to retrieve REST web services input.
  • Preparing to send status to a REST web service.

1.2.4.5 Preparing to retrieve SOAP web services input

To retrieve input from a SOAP web service for an application, identify the parameters used to call the SOAP web service. Test the exchange of data between RICOH ProcessDirector and the application. Then define and configure a SOAP web service input device.
To prepare to retrieve SOAP web services input:
  1. Learn the requirements for communication with the SOAP web service for the application:
    • The values for authenticating with the application
    • The values for requesting data from the SOAP web service
    • The format of the data provided in the response

    Refer to the documentation for the application or consult with the company that hosts the application.

  2. To prepare RICOH ProcessDirector to communicate with the application, do these tasks:
    • If the application requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.
    • If your environment requires a proxy server to communicate with web services, set up the system to use it.
    • Import WSDL files for all the web services that you plan to call.

      RICOH ProcessDirector creates SOAP request objects from SOAP operations in the WSDL file. You specify a prefix that RICOH ProcessDirector adds to the names of the SOAP operations when it creates the objects. A SOAP request object lets RICOH ProcessDirector determine the SOAP version and other information required to make a correct call to the web service.

    For more information, see the related tasks.

  3. Run a manual test that authenticates with the application and requests a response from the SOAP web service. Verify that the web service returns the response that you want.
    Many browsers have plug-ins, such as Boomerang for Google Chrome, that test web service calls to SOAP clients.
  4. Decide how you want the SOAP web service input device to create jobs from the data in the response returned by the web service.
    • Every time the input device receives a response, it can create a job containing all XML data in the response.
    • The input device can examine the response using an XPath expression.

      If the input device finds XML elements specified by the expression, it creates a job for each matching element. Each job contains the matching element and all the elements nested within it. If the input device finds two or more elements, it can create independent jobs or child jobs.

      If the input device does not find matching elements, it does not create a job.

  5. Define a SOAP web service input device:
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Click Add SOAP web service.
  6. On the General tab:
    • Type a name for the input device.
    • Set the Polling interval property to the time that you want the input device to wait between web service calls.
    • After you define a workflow to process the XML jobs, set the Child workflow property to the name of that workflow.
    • Enter values for other properties that you want to set.
  7. On the Request tab:
    1. Set the Request URL property to the URL of the web service that returns data that RICOH ProcessDirector uses to create one or more jobs.
    2. For the value of the Request payload property, specify the body of the web services request that the input device submits to the application.
      To specify a credential or token and a time range that matches the value of the Polling interval property, use symbols for these properties:
      Database name of property User interface name of property Remarks
      WebService.Credential None RICOH ProcessDirector stores the web service credential or token in this property.
      WebService.CurrentRequestTime None RICOH ProcessDirector sets the value of this property at the start of the polling interval.
      WebService.LastSuccessRequestTime Status tab: Time of last successful request When the input device successfully communicates with the application, RICOH ProcessDirector sets the value of this property to match the value of the WebService.CurrentRequestTime property. A successful communication results in a response code 200, even if no data is received that RICOH ProcessDirector can use to create jobs.

      In this example, the payload includes these elements: <Token>, <TimeRange>, <Start>, and <End>. The value of each element is a symbol:

      <Token>${WebService.Credential}</Token><TimeRange> <Start>${WebService.LastSuccessRequestTime}</Start> <End>${WebService.CurrentRequestTime}</End></TimeRange>

      The input device resolves the symbols when it polls for XML input.

    3. Set the SOAP request property to the SOAP request that RICOH ProcessDirector created when you imported the WSDL file.
      For example, you want to use the GetOrdersByDate SOAP request. You prepended PrintShop to the names of the SOAP requests when you imported them. Select PrintShop-GetOrdersByDate.
    4. Select a value for the Create job from response property to specify how the input device creates jobs from the input:
      • To create a job every time the input device receives a response, select Always.
      • To examine the XML in the response and create a job each time that an XML element is found, select Only when response pattern matches.
    5. If you selected Only when response pattern matches:
      • Set the Response pattern to match property to the XPath expression that identifies the XML element that you want to use for each job.

        For example, you want one job for each order, and the data in the response contains an order element. Enter the XPath expression that represents the order element in the XML.

      • Set the Create child jobs property to Yes if you want to create child jobs when the input device finds two or more matches. The input device also creates a parent job without any data. If the input device finds one match, it creates an independent job.
      • Set the Create child jobs property to No if you want to create independent jobs regardless of how many matches the input device finds.
    6. If your environment requires a proxy server to communicate with web services, set the Use proxy property to the correct proxy server.
    7. Set the Time zone offset property to the offset in hours between Coordinated Universal Time (UTC) and the time zone used by the web service.
      For example, if the web service uses Pacific Standard Time, set the property to -8.
        Note:
      • Make sure that you change this property when a location that hosts the web service changes between standard and daylight savings time. Otherwise, during the lost or gained hour, you can lose the data that RICOH ProcessDirector uses to create jobs.
      • If the web service uses UTC, enter 0 or leave the field blank.
  8. On the Authentication tab, specify the values required to authenticate with the application.
    For more information, see the related task about authenticating with a SOAP web service.

    If the application does not require authentication, leave all the Authentication properties blank.

  9. Optional: On the Advanced tab, specify any optional properties for your environment.
  10. When you finish, click OK.

When you finish setting up your input devices, notifications, and workflows, test the exchange of data between RICOH ProcessDirector and the application.

Example

The supplied RestfulWebServiceSample REST web service input device is similar to a SOAP web service input device. The MarcomCentral Connect feature includes a supplied SOAP web service input device.

1.2.4.5.1 Using a SOAP web service to authenticate with an application

SOAP web service input device and notification objects can use a SOAP web service to authenticate with an application. RICOH ProcessDirector supports both API key and session authentication. Input device objects authenticate when they poll for input. Notification objects authenticate when they send status to the application.

For API key authentication, you put an authorization code in a Static credential property or define an HTTP user ID and password. The authorization code or the HTTP user ID and password is sent to the web service that exchanges data. The web service then authenticates with the application and returns a response.

For session authentication, you put authentication credentials (user ID and password) and other values in a set of authentication request properties. The input device or notification first calls a SOAP web service to authenticate with the application. After a successful authentication, the web service returns a token to the input device or notification. The token is transmitted in the call to the web service that exchanges data.

  • If the application allows one session per user, set up your objects to call the web services with different user IDs and passwords.
  • Session authentication occurs with every web service call and logging out is not required. Make sure that the length of the session for each set of credentials is shorter than the time between calls to the web service. For example, the session for an input device expires after 10 minutes. When you configure the input device, specify a polling interval greater than 10 minutes.

To get an API key or authentication credentials for an application, contact the company that hosts the application. For format and syntax requirements, refer to the documentation of the application.

To use a SOAP web service to authenticate:
  1. Click the Authentication tab on the SOAP web service input device or notification.
  2. Follow the instructions for the type of authentication that the application requires:
    • For API key authentication, specify the authentication code as the value of the Static credential property.

      Leave all the other properties blank. You have completed this procedure.

    • For session authentication, leave the Static credential property blank. Go to the next step and specify the other properties.
  3. Set the Authentication request URL property to the URL that RICOH ProcessDirector uses to authenticate with the application.
    If the application requires authentication credentials in the URL, specify them using the required format and syntax.
  4. For the value of the Authentication request payload property, specify the body of the web services request that the input device or notification submits to the application for authentication.
    In these examples, the payload includes three elements: <Credentials>, <Name>, and <Password>. The value of the <Password> element is a symbol that uses the Authentication request password property.

    This example uses the Authentication request password property for input devices:

    <Credentials> <Name>myname</Name> <Password>${WebService.AuthRequestPwd}</Password></Credentials>

    This example uses the Authentication request password property for notifications:

    <Credentials> <Name>myname</Name> <Password>${WSNotification.WebService.AuthRequestPwd}</Password></Credentials>

    The symbol is resolved when the authentication request is sent.

  5. Set the Authentication SOAP request property to the SOAP request that RICOH ProcessDirector created when you imported the WSDL file.
    For example, you want to use the AuthenticateUser SOAP request. You prepended PrintShop to the names of the SOAP requests when you imported them. Select PrintShop-AuthenticateUser.
  6. Set the Authentication response attribute property to the XPath expression that identifies the credential for the session in the response from the web service.
  7. Set the Authentication request password property to the password for your account with the application.
    The password is encrypted when it is stored in RICOH ProcessDirector.
For both API key and session authentication, RICOH ProcessDirector stores the static credential or token returned from the application in a property.
  • For input devices, the property is WebService.Credential.
  • For notifications, the property is WSNotification.WebService.Credential.

When you specify values on the Request tab for a SOAP web service input device or notification, you specify the WebService.Credential or WSNotification.WebService.Credential property as a symbol.

RICOH ProcessDirector substitutes the value of the static credential or token for the symbol when it transmits the request to the web service.

Now that you have specified the values required to authenticate with the application, complete the steps for defining and configuring the input device or notification. Return to one of these topics:
  • Preparing to retrieve SOAP web services input.
  • Preparing to send status to a SOAP web service.

1.2.4.6 Defining input devices

Input devices are the RICOH ProcessDirector objects through which RICOH ProcessDirector receives jobs.

RICOH ProcessDirector provides several input devices. You can make minor modifications to the properties of any of these input devices and use them in the installation. You can also copy them to create new input devices.

Note: If you plan to create Download input devices and you want to receive messages from the Download daemon in a language that is different from the language that you chose when you installed the RICOH ProcessDirector server, set the Device language property of the input device to the appropriate language.

1.2.4.6.1 Using supplied input devices

RICOH ProcessDirector provides several predefined input devices. If your print environment is simple and does not require many input devices, you can modify the properties of the predefined input devices and use them in your environment.

To modify and use a supplied input device:

  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
  3. Select the input device that you want to modify.
  4. Click Properties.
  5. On all the tabs, change the required and optional properties that need to be adjusted to match your environment. Each input device must have a unique path for its Folder location and Staging location properties.
      Note:
    • If you have the AFP Support feature installed and submit jobs to Download input devices:
      • More than one Download input device can use the same port number, but you can only enable one of the input devices with the common port number at any time.
      • When Download for z/OS is running in multiple data set mode with Exit 15, each Download input device can receive jobs from only one Download for z/OS functional subsystem application (FSA).
  6. Determine how you want the input device to assign the workflow for each job.
    When using SubmitInputFiles as the submit step for the input device, you can select one of these:
    • Set the Child workflow initialization step property to Not set and set the Child workflow property to the name of an existing workflow to assign the same workflow to every job that this input device processes.
    • Set the Child workflow initialization step property to SetJobTypeFromRules and use the Child workflow parsing rules property to specify the name of the control file that can set the workflow from a value of an option of the print command.

      RICOH ProcessDirector provides a sample control file that is used to set the workflow: receive_lpd_pdf_jobtype.cfg. The AFP Support feature provides these sample control files that are used to set the workflow: receive_jcl_jobtype.cfg and receive_lpd_jobtype.cfg. The sample control files are installed in the /aiw/aiw1/samples/rules/ directory. You can copy a sample control file to the /aiw/aiw1/control_files/rules/ directory and modify it to meet your needs, then update the value of the Child workflow parsing rules property to point to your file.

    • Set the Child workflow initialization step property to SetJobTypeFromFileName and use the Child workflow pattern property to specify the string that RICOH ProcessDirector should look for in the input file name and use as the workflow name. If you use this method, you must make sure that a workflow with the corresponding name exists.
  7. Click OK.
  8. To use the modified input device, select it and click Enable, then select it again and click Connect.

1.2.4.6.2 Copying input devices

You can copy an input device so you can use it as a template for creating another input device. Copying input devices can save you time, especially when you need to create several input devices with similar properties.
To copy an input device:
  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
  3. Right-click the input device that you want to copy and select Copy.
      Note:
    • The new input device that RICOH ProcessDirector creates through the copy action is the same type as the copied input device.
  4. On all the tabs, fill in the required and optional properties that need to be adjusted to match your environment.
      Note:
    • For LPD input devices, it is best to limit the input device name to 8 characters. Depending on the print command that you use, you might have to create a print queue on the sending system with the same name as the input device. Some systems truncate print queue names to 8 characters.
    • For Hot folder input devices, RICOH ProcessDirector creates the directories that you specify as the Folder location and Staging location if they do not already exist. If they do exist, make sure that the RICOH ProcessDirector system user ( aiw1 is the default) in the RICOH ProcessDirector group ( aiwgrp1 is the default) owns these directories.
  5. Determine how you want the input device to assign the workflow for each job.
    When using SubmitInputFiles as the submit step for the input device, you can select one of these:
    • Set the Child workflow initialization step property to Not set and set the Child workflow property to the name of an existing workflow to assign the same workflow to every job that this input device processes.
    • Set the Child workflow initialization step property to SetJobTypeFromRules and use the Child workflow parsing rules property to specify the name of the control file that can set the workflow from a value of an option of the print command.

      RICOH ProcessDirector provides a sample control file that is used to set the workflow: receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, or receive_lpd_pdf_jobtype.cfg. The sample control file is installed in the /aiw/aiw1/samples/rules/ directory. You can copy that file to the /aiw/aiw1/control_files/rules/ directory and modify it to meet your needs, then update the value of the Child workflow parsing rules property to point to your file.

    • Set the Child workflow initialization step property to SetJobTypeFromFileName and use the Child workflow pattern property to specify the string that RICOH ProcessDirector should look for in the input file name and use as the workflow name. If you use this method, you must make sure that a workflow with the corresponding name exists.
  6. Click OK.
  7. To use the new input device, right-click it and select Enable and Connect.

1.2.4.6.3 Creating input devices

When you need an input device that has very different properties from existing input devices, you can create a new one.
To create an input device:
  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
  3. Click Add and choose the type of input device you want to create.
  4. On all the tabs, fill in the required and optional properties that need to be adjusted to match your environment.
      Note:
    • For LPD input devices, it is best to limit the input device name to 8 characters. Depending on the print command that you use, you might have to create a print queue on the sending system with the same name as the input device. Some systems truncate print queue names to 8 characters.
    • For input devices, RICOH ProcessDirector creates the directories that you specify as the Folder location and Staging location if they do not already exist. If they do exist, make sure that the RICOH ProcessDirector system user ( aiw1 is the default) in the RICOH ProcessDirector group ( aiwgrp1 is the default) owns these directories.
  5. Determine how you want the input device to assign the workflow for each job.
    When using SubmitInputFiles as the submit step for the input device, you can select one of these:
    • Set the Child workflow initialization step property to Not set and set the Child workflow property to the name of an existing workflow to assign the same workflow to every job that this input device processes.
    • Set the Child workflow initialization step property to SetJobTypeFromRules and use the Child workflow parsing rules property to specify the name of the control file that can set the workflow from a value of an option of the print command.

      RICOH ProcessDirector provides a sample control file that is used to set the workflow: receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, or receive_lpd_pdf_jobtype.cfg. The sample control file is installed in the /aiw/aiw1/samples/rules/ directory. You can copy that file to the /aiw/aiw1/control_files/rules/ directory and modify it to meet your needs, then update the value of the Child workflow parsing rules property to point to your file.

    • Set the Child workflow initialization step property to SetJobTypeFromFileName and use the Child workflow pattern property to specify the string that RICOH ProcessDirector should look for in the input file name and use as the workflow name. If you use this method, you must make sure that a workflow with the corresponding name exists.
  6. Click OK.
  7. To use the new input device, select it and click Enable, then select it again and click Connect.

1.2.4.6.4 Setting up hot folder input devices to process batch jobs

To set up a hot folder input device to process batch jobs, you must configure it to use the appropriate batching method and to recognize the input files.
    Note:
  • All batching methods submit input files when some criteria is met, such as several files are received, a time of day is reached, or a list of expected files arrives. Sometimes, you want to submit the input files before that criteria is met and before the current polling interval ends.

    For example, you have one hour until the end of your shift and there are 3857 input files waiting. The input device uses the Number batching method and submits jobs when there are 5000 input files waiting. You can use the Batch all action for the input device to submit those 3857 files immediately, instead of waiting for more files.

    You cannot use the Batch all action with the JDF or Pattern batching method.

To set up a hot folder input device to process batch jobs:

  1. Create and save any files that are needed for processing, such as JDF job tickets, list files, or overrides files, or make sure that your process generates these files as needed.
  2. Log in to RICOH ProcessDirector.
  3. In the Input Devices portlet, find the input device that you want to use to process batch jobs.
  4. Right-click the input device and select Properties.
  5. In the left pane, click Show all tabs to fully expand the notebook.
  6. For any batching method, set these input device properties as follows:
    Workflow
    ParentNoPrint.
    Child workflow
    The workflow that is appropriate for the print files in the job.
      Note:
    • If you use the List batching method, to be sure that the jobs print in order, select a workflow that includes a step based on the WaitForGroup step template before the PrintJobs step.
    • If you use overrides files, select a workflow that includes a step based on the SetJobPropsFromTextFile step template.
    Data patterns
    One or more pattern-matching strings that define which characters in the data file should be matched with the other file names that might arrive in the input device. If you specify more than one data pattern, the file is considered a match if it matches any pattern. The data pattern is a regular expression.
    Submit step
    SubmitInputFiles
  7. Set these input device properties depending on your batching method:
    JDF
    JDF patterns
    A pattern that matches some part of the name of your job tickets. By default for all input devices except HotFolderJDF this value is null. For HotFolderJDF this value is the regular expression .*\jdf$.
    List
    List patterns
    A pattern that matches some part of the file name of your list files. By default, this value is the regular expression .*lst$.
    Overrides patterns (optional)
    A pattern that matches some part of the file name of your overrides files.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property and that are included in a list file are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs.
    Number and Number of sets
    Number of files to batch
    The number of files or complete sets that the input device should wait to receive before submitting them as a single group.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs. This property is not available for the Number of sets batching method.
    Pages and Pages in sets
    Exceed pages to batch
    • Yes: A PDF file or complete set of PDF files that contains enough pages to make the total number of pages in the input device exceed the value set for Number of pages to batch is submitted with the rest of the files.
    • No: This file or set remains in the input device as the first set of pages for the next batch.
    Number of pages to batch
    The number of pages that the input device should wait to receive before submitting the files or complete sets as a single group.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs. This property is not available for the Pages in sets batching method.
    Time and Sets by time
    Batching start date
    The date when the input device should begin to use this batching method.
    Batching start time
    The time when the input device should begin to use this batching method.
    Batching interval
    The time interval that the input device should use to determine when or how often to submit a job.
    Batch date or Frequency
    Used with the Batching interval property, specifies exact values for when or how often to submit a job.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs. This property is not available for the Sets by time batching method.
    Pattern
    Data pattern
    One or more pattern-matching strings that define which characters in the data file should be matched with the other file names that might arrive in the input device. If you specify more than one data pattern, the file is considered a match if it matches any pattern. The data pattern is a regular expression.
    File pattern (one value for each type of input file)
    A pattern-matching string that defines a particular type of input file, for example, .*jdf$ for a job ticket.
    Spool file usage (one value for each type of input file)
    A value that identifies what the input file is used for, for example, ticket for a job ticket or print for a print file.
    Spool file type (one value for each type of input file)
    The file extension for the input file.
    File pattern required (one value for each type of input file)
    Whether the job must contain this type of input file.

    The job starts to process when all the required files are present. Make sure any optional files are already in the input device before the required files; otherwise they will not be included in the job.

    File pattern sequence (one value for each type of input file)
    If two or more File pattern values are the same, or if two or more File pattern properties are associated with the same Spool file usage and Spool file type values, the order in which the set of values is applied.
  8. Click OK.
    If the input device is enabled and connected, you see a confirmation window asking you if you want to disable and disconnect the input device. To save your changes, the input device must be disabled and disconnected.
  9. To use the input device, select it and click Enable and Connect.
After you configure an input device to use a batching method, make sure that the input files you submit are appropriate for the batching method selected. Unidentified input files remain in the staging location for the input device with a status of Waiting.

1.2.4.6.5 Defining input devices for use with transform features

You can define a Hot folder input device that you can use to receive input files that need to be sent to the RICOH Transform features or to the Advanced Transform feature for conversion into a different data stream.

Before you begin, make sure you have defined a workflow that sends jobs to be transformed.

Note: You must install the AFP Support feature to use the RICOH Transform features to receive jobs from Download for z/OS or AFP Download Plus.

To define an input device for use with the RICOH Transform features or the Advanced Transform feature:

  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
  3. Right-click the HotFolderTransform input device and select Copy.
    If the jobs that need to be transformed are submitted using AFP Download Plus or Download for z/OS, copy the DownloadAFP input device instead.
  4. Type a name and a description for the new input device.
  5. On the General tab, find the entry field for the Child workflow property and select the workflow that you created to send jobs to be transformed.
  6. Click the Batching tab.
  7. Find the Data patterns property. Make sure that the value of this property lets RICOH ProcessDirector identify the files that it should send to be transformed.
    For example, if the files are in PDF format and have .PDF extensions, set the Data patterns property to .*PDF$.
  8. Click OK.
  9. To use the new input device, right-click it and select Enable and Connect.

1.2.4.7 Defining printer objects

Printer objects represent the printers in your environment that receive print jobs from RICOH ProcessDirector.
These types of printer objects can receive jobs from RICOH ProcessDirector:
  • Ricoh PDF printer
  • Ricoh TotalFlow printer
  • Custom PDF printer
  • Passthrough printer
  • Kodak PDF printer
    • Available if the Cut Sheet Support for Kodak feature is installed.
  • Xerox PDF printer
    • Available if the Cut Sheet Support for Xerox feature is installed.
  • AFP printer
    • Available if the AFP Support feature is installed.
  • PCLOut printer
    • Available if the AFP Support feature is installed.

Optional features add more types of printer objects.

Jobs are assigned to the printers using scheduling properties. Scheduling properties are job and printer properties that RICOH ProcessDirector compares to determine whether a job can be sent to a printer. The table shows the default job scheduling properties and their corresponding printer properties. If all the scheduling properties match, the job can be scheduled to the printer. Scheduling properties are added or deleted from this list by editing a scheduling properties configuration file.

    Note:
  • A blank value for a job scheduling property matches all values for the corresponding printer property. A blank value for a printer scheduling property matches all values for the corresponding job scheduling property.

Scheduling properties
Job property Printer property
Binding, with Perfect selected Perfect binding capable
Binding, with Ring or Ring and punch selected Ring binding capable
Customer name Customer name
Fold options Folding capable
Job size (sheets) Printer job size (sheets) supported
Media Media supported
PLE Media Media supported
Output bin Output bins available
Output format Output format
Punch Punch capable
Requested location Printer location
Staple Staple capable
PLE Staple Staple capable

The AFP Support feature provides these additional scheduling properties:

AFP scheduling properties
Job property Printer property
Job class Printer class
Job destination Printer destination
Job form Printer form

RICOH ProcessDirector can get status on the job while it is printing by communicating directly with AFP printers and Ricoh PDF printers.

For Passthrough and PCLOut printers, RICOH ProcessDirector runs a command that is defined for the printer and monitors the response to the command. RICOH ProcessDirector cannot report status of the job that it sent.

Different printer types generate different output to send to the printer.

  • Ricoh PDF printers can print PDF data and JDF job tickets or PostScript data.
  • Ricoh TotalFlow printers do no conversions and print PDF data streams. They produce a MIME package containing the PDF data and JDF job ticket.
  • Custom PDF printers convert PDF to PostScript.
  • Passthrough printers do no conversions and usually print data streams such as PostScript, PDF, and PCL.
  • AFP printers use the Print Services Facility (PSF) printer driver to convert AFP print jobs into their Intelligent Printer Data Stream (IPDS) format.
  • PCLOut printers use the PSF printer driver to convert AFP print jobs into their IPDS format. Then they convert the IPDS format into Printer Command Language (PCL) format.
  • Kodak PDF and Xerox PDF printer objects represent printers that can print PDF files. They print jobs in PDF format, including jobs that have been converted to PDF format.

Another way to print is to define a workflow that copies the print file to a directory defined as a hot folder for a printer. You do not need to define a printer object in this case because the workflow does not usually contain a PrintJobs step. Jobs that are processed with that kind of workflow do not use scheduling properties because scheduling applies only to the PrintJobs step.

1.2.4.7.1 Defining Ricoh PDF printer objects

Ricoh PDF printer objects represent specific models of RICOH printers. The Printer server for all Ricoh PDF printers must be a Linux primary or secondary server or a Windows application server.

If you have a printer that uses TotalFlow Print Server, follow the instructions in the help system for configuring to send jobs to a printer that uses TotalFlow Print Server.

Jobs are assigned to Ricoh PDF printers using these scheduling properties: Customer name, Job size, Location, Media, Output bin, Output format, Folding, Perfect binding, Ring binding, Punch, and Staple. The AFP Support feature adds Class, Destination, and Form to the scheduling properties. Other scheduling properties may be defined in a configuration file.

Both Ricoh PDF printer objects and Passthrough printer objects can print jobs in PDF format. Ricoh PDF printer objects support more functions such as reporting job progress. If Ricoh PDF printer objects support your printer model, we recommend that you define a Ricoh PDF printer object rather than a Passthrough printer object.

To define a Ricoh PDF printer object:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. Click Add Ricoh PDF Printer.
  4. On the General tab, fill in values for all the required fields.
      Note:
    • Select a Linux primary or secondary server or a Windows application server as the Printer server.
    • The printer driver reports status information in the language that you selected when you installed the RICOH ProcessDirector server. To receive messages from this printer in a different language, set the Printer language property appropriately.
    • SNMP returns the printer serial number when RICOH ProcessDirector establishes a connection to the printer. RICOH ProcessDirector checks the Serial number property to make sure that the printer is one of the models supported as Ricoh PDF printers.
    • The default value for the Job status polling interval property is 10 seconds. If you want to reduce the traffic on your network, you can increase the interval between RICOH ProcessDirector requests to the printer for job status.
  5. On the Scheduling tab, enter the values that you want RICOH ProcessDirector to use to assign jobs to this printer. Leave the values blank or Not set for any properties that you do not want to use for scheduling. Those values match any values specified by the corresponding job scheduling properties.
    If you want to schedule jobs to a printer based on media, keep these items in mind when you set the Media supported property:
    • If you choose specific media, only jobs that use that media can be scheduled to this printer.
    • If you choose Ready media objects, only jobs that require the media that is currently loaded in the printer can be scheduled to the printer.
    • If you choose All media, all jobs can be scheduled to the printer, regardless of what media is loaded.
  6. Click OK.
      Note:
    • RICOH ProcessDirector creates a separate Java virtual machine on the Linux primary or secondary server or on the application server to run Ricoh PDF printers. Some computer security software notifies users when Java virtual machines are created.
    • Supported RICOH printers work with RICOH or EFI Fiery printer controllers. Both Ricoh and EFI Fiery controllers return information to RICOH ProcessDirector. For RICOH controllers, the % Printed property shows the percentage of pages printed. For EFI Fiery controllers, the % Printed property shows the job transmission status. Print progress is complete when EFI Fiery controllers have queued an entire job for printing. EFI Fiery controllers can be configured to print queued jobs in the order received or to hold them for later printing.
    • Use the Data stream to send property to choose whether to send PDF files and JDF job tickets or to send PostScript data to the printer.

      Only Ricoh PDF printers that have TotalFlow Print Server or an EFI Fiery control unit support JDF/PDF. For a list of control units that support this data stream, see the Ricoh PDF printer readme. After you add a Ricoh PDF printer on a Linux primary or secondary server, the readme file is in the /aiw/aiw1/pc directory. After you add a Ricoh PDF printer on an application server, the readme file is in the C:\Program Files (x86)\Ricoh\ProcessDirector\pc directory.

1.2.4.7.2 Defining AFP printer devices

AFP printer devices represent Intelligent Printer Data Stream (IPDS) printers. They print jobs in AFP format, including jobs that have been converted to AFP format.
To define an AFP printer device:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. Click Add AFP Printer.
  4. On the General tab, fill in values for all the required fields.
    If you set up a secondary server that you want to use to drive this AFP printer, set these properties:
    • Printer server: The secondary server name
    • Copy to secondary server: Yes
    • Destination directory on secondary server: The location on the secondary server file system where you want RICOH ProcessDirector to write print files.
  5. On the Scheduling tab, set values for the properties that you want to use to schedule jobs to this printer. If you leave values blank, they match any value that is set in the corresponding job scheduling properties.

    For example, set these properties to schedule jobs based on media, output bins, and punching and stapling functions of the printer:

    • Media supported

      If you choose specific media, only jobs that use that media can be scheduled to this printer. If you choose Ready media objects, only jobs that require the media that is currently loaded in the printer can be scheduled to the printer. If you choose All media, all jobs can be scheduled to the printer, regardless of what media is actually loaded.

    • Output bins available

      Any output bin that can be installed on the printer is considered available, although on some printers you cannot install all the output bins at the same time.

    • Punch capable
    • Staple capable

  6. On all the tabs, fill in values for any of the optional fields.
      Note:
    • The default value for the Inactivity timer property is 300 seconds, so RICOH ProcessDirector releases the connection to the printer after approximately 5 minutes of inactivity. To maintain the connection between RICOH ProcessDirector and the printer even when it is not actively printing, change that value to 9999.
    • If the Share printer connection property is Yes, the printer driver component of RICOH ProcessDirector releases control of the printer after a period of inactivity so that the same physical printer can receive jobs from another input source, such as a hot folder. The IPDS printer connection timer property determines how long to wait before releasing control. The IPDS printer connection timer property must be less than the Inactivity timer property. If the IPDS printer connection timer property is greater than the Inactivity timer property, RICOH ProcessDirector drops the connection before it can share the printer.
    • The default is that the printer driver reports status information in the language that you selected when you installed the RICOH ProcessDirector server. To receive messages from this printer in a different language, set the Printer language property appropriately.
    • The default value for the Font fidelity property is Continue printing. Do not change this default if IPDS resolution is set to Automatic at the printer console.
    • For the InfoPrint 3000, 4000, 4100, and 5000, make sure that the SNMP agent is enabled on the printer console and that the Use SNMP property is Yes, so that SNMP can configure the printer.
      Note: For migrated printers, Use SNMP is Yes by default.
  7. Click OK.

1.2.4.7.3 Defining PCLOut printer devices

PCLOut printer devices represent Printer Command Language (PCL) printers. They print jobs that are submitted in AFP format and converted to PCL format.
You cannot use the RICOH ProcessDirector actions Jump and Continue with jobs that are submitted to PCLOut printers. You can only use the Stop action on a job that is printing on a PCLOut printer if you request the action while the Print Services Facility (PSF) printer driver is transforming the job to PCL.

To define a PCLOut printer device:

  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. Click Add PCLOut Printer.
  4. On the General tab, fill in values for all the required fields.
  5. On the Scheduling tab, set values for the properties that you want to use to schedule jobs to this printer. If you leave values blank, they match any value that is set in the corresponding job scheduling properties.
    For example, set these properties to schedule jobs based on media, output bins, and punching and stapling functions of the printer:
    • Media supported

      If you choose specific media, only jobs that use that media can be scheduled to this printer. If you choose Ready media objects, only jobs that require the media that is currently loaded in the printer can be scheduled to the printer. If you choose All media, all jobs can be scheduled to the printer, regardless of what media is actually loaded.

    • Output bins available

      Any output bin that can be installed on the printer is considered available, although on some printers you cannot install all the output bins at the same time.

    • Punch capable
    • Staple capable
  6. On the SNMP tab, make sure that the Use SNMP and Get tray information from printer properties are set to Yes.
  7. On the remaining tabs, fill in values for any of the optional fields:
    1. The default is that the printer driver reports status information in the language that you selected when you installed the RICOH ProcessDirector server. To receive messages from this printer in a different language, set the Printer language property appropriately.
    2. If you want the printer to print duplex jobs, set the Duplex property to Yes. PCLOut printers do not honor duplex settings specified in the Duplex job property.
  8. Click OK.
  9. Configure the media settings for the printer.
    1. From the Printers panel, select the new printer.
    2. Click Actions Show Trays.
    3. Select each tray individually and click Set tray media. Choose the media loaded in that tray and click OK.
      If the Media does not exist, you can create it.
  10. If the system that you selected as the Parent server of the PCLOut printer is a Linux system, create a print queue with the same name as the PCLOut printer.
    • On a Red Hat 6.7 through latest 6.X Linux system:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications System Tools Terminal.
    3. In the terminal window, type system-config-printer.
    4. Select Printer on the New drop-down menu.
        Note:
      • If you receive an Adjust Firewall notification, you can choose to adjust now or later.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the physical printer.
    7. Type PASS in the Queue field, and then click Forward.
    8. In the New Printer window, select the printer manufacturer name and then click Forward.
    9. In the Models list, select the printer model and then click Forward.
    10. If you see the Installable Options page, choose the hardware options that are installed on your printer and click Forward.
    11. Type a name for the printer in the Printer Name field. This must match the printer name you used in the Printer Command property when you defined the PCLOut printer in RICOH ProcessDirector.
    12. Click Apply.
    • On a Red Hat 7.1 through latest 7.X Linux system:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications Utilities Terminal.
    3. In the terminal window, type system-config-printer.
    4. Select Printer on the Add drop-down menu.
        Note:
      • If you receive an Adjust Firewall notification, you can choose to adjust now or later.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the physical printer.
    7. Type PASS in the Queue field, and then click Forward.
    8. In the New Printer window, select the printer manufacturer name and then click Forward.
    9. Click Forward again.
    10. Type a name for the LPD input device in the Printer Name field.
    11. Click Apply.
    • On a Linux SLES 12.0 system:
    1. Log in to the operating system as the root user.
    2. Start YaST.
    3. Click Hardware Printer. With Printer Configurations highlighted, click Add. Click Connection Wizard, and then select Line Printer Daemon (LPD) Protocol.
    4. In the IP Address or Host Name field, type the host name or IP address of the physical printer.
    5. Type PASS in the Queue Name field. Select the printer manufacturer, and click OK.
    6. In the Set Arbitrary Name field, type the name of the PCLOut printer. This name must be unique on this Linux system. Although printer names are case-sensitive, Linux does not allow you to define multiple printer names that are alike except for case. For example, you cannot define one printer device called OfficePrinter and another called officeprinter.
    7. Select a printer driver, then click OK.
Examples of the Printer command property

You can set the Printer command property of a PCLOut printer called officeprinter to either of these commands.

lpr -P officeprinter
lprafp -pofficeprinter

    Note:
  • PCLOut printers do not support RICOH ProcessDirector symbols such as ${Job.Name} in the PCLOut printer command.

1.2.4.7.4 Defining Passthrough printer objects

Passthrough printer objects represent printers that can print jobs in formats such as PCL, PostScript, and PDF. Jobs are assigned to Passthrough printers using these scheduling properties: Customer name, Job size, Location, Media, Output bin, Output format, Punch, Folding, Binding, and Staple. The AFP Support feature adds Class, Destination, and Form to the scheduling properties. Other scheduling properties may be defined in a configuration file. For Passthrough printers, RICOH ProcessDirector runs a command that is defined for the printer. RICOH ProcessDirector monitors the response to the command, but cannot report status of the job that it sent.
To define a Passthrough printer object:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. Click Add Passthrough Printer.
  4. On the General tab, fill in values for all the required fields.
      Note:
    • The value of the Printer command property depends on the print commands that are available on your system. Use the value of the Printer name property as the value of the printer option of the command.
    • Because Passthrough printers cannot automatically determine the values of job properties, you must pass them to the printer. You can pass the values of job properties in either of these ways:
      • By using symbols or RICOH ProcessDirector methods in the value of the required Printer command property, or in a script named in that value
      • In a file that you specify as the value of the optional Control file template property, only if the printer command uses a control file.
  5. On the Scheduling tab, enter the values that you want RICOH ProcessDirector to use to assign jobs to this printer. Leave the values blank or Not set for any properties that should not be used for scheduling. Those values match any values specified by the corresponding job scheduling properties.
    If you want to schedule jobs to a printer based on media, keep these items in mind when you set the Media supported property:
    • If you choose specific media, only jobs that use that media can be scheduled to this printer.
    • If you choose Ready media objects, only jobs that require the media that is currently loaded in the printer can be scheduled to the printer.
    • If you choose All media, all jobs can be scheduled to the printer, regardless of what media is loaded.
  6. Click OK.
  7. If the parent server of the Passthrough printer runs Red Hat 6.7 through latest 6.X, create a print queue with the same name as the Passthrough printer:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications System Tools Terminal.
    3. In the terminal window, type: system-config-printer
    4. Select Printer on the New drop-down menu.
        Note:
      • If you receive an Adjust Firewall notification, you can choose to adjust now or later.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the physical printer.
    7. Type PASS in the Queue field, and then click Forward.
    8. In the New Printer window, select the printer manufacturer name and then click Forward.
    9. In the Models list, select the printer model and then click Forward.
    10. If you see the Installable Options page, choose the hardware options that are installed on your printer and click Forward.
    11. Type a name for the printer in the Printer Name field. This name must match the printer name you used in the Printer Command property in the step 4.
    12. Click Apply.
  8. If the parent server of the Passthrough printer runs Red Hat 7.1 through latest 7.X, create a print queue with the same name as the Passthrough printer:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications Utilities Terminal.
    3. In the terminal window, type: system-config-printer
    4. Select Printer in the New list.
        Note:
      • If you receive an Adjust Firewall notification, you can choose to adjust now or later.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the physical printer.
    7. Type PASS in the Queue field, and then click Forward.
    8. In the New Printer window, select the printer manufacturer name and then click Forward.
    9. In the Models list, select the printer model and then click Forward.
    10. If you see the Installable Options page, choose the hardware options that are installed on your printer and click Forward.
    11. Type a name for the printer in the Printer Name field. The name must match the printer name you used in the Printer Command property in the step 4.
    12. Click Apply.
  9. If the parent server of the Passthrough printer runs SLES 11.0, create a print queue with the same name as the Passthrough printer:
    1. Log in to the operating system as the root user.
    2. Start YaST.
    3. Click Hardware Printer. With Printer Configurations highlighted, click Add. Click Connection Wizard, and then select Line Printer Daemon (LPD) Protocol.
    4. In the IP Address or Host Name field, type the host name or IP address of the physical printer.
    5. Type PASS in the Queue Name field. Select the printer manufacturer, and click OK.
    6. In the Set Name field, type the name of the Passthrough printer. This name must be unique on this Linux system. Although printer names are case-sensitive, Linux does not allow you to define multiple printer names that are alike except for case. For example, you cannot define one printer object called OfficePrinter and another called officeprinter.
    7. Select a printer driver, then click OK.
  10. If the parent server of the Passthrough printer runs SLES 12.0, create a print queue with the same name as the Passthrough printer:
    1. Log in to the operating system as the root user.
    2. Start YaST.
    3. Click Hardware Printer. With Printer Configurations highlighted, click Add. Click Connection Wizard, and then select Line Printer Daemon (LPD) Protocol.
    4. In the IP Address or Host Name field, type the host name or IP address of the physical printer.
    5. Type PASS in the Queue Name field. Select the printer manufacturer, and click OK.
    6. In the Set Arbitrary Name field, type the name of the Passthrough printer. This name must be unique on this Linux system. Although printer names are case-sensitive, Linux does not allow you to define multiple printer names that are alike except for case. For example, you cannot define one printer object called OfficePrinter and another called officeprinter.
    7. Select a printer driver, then click OK.
Examples of the Printer command property

You can set the Printer command property of a Passthrough printer to use an lpr command. These commands set the value of the -# flag to the value of the Job.Copies property of the job that is being printed. Both use the getCurrentFile method to return the file name and path of the file in the job spool directory that is in the specified data format. Substitute the name of the printer for printerName.

lpr -P printerName -#${Job.Copies} ${getCurrentFile(pdf)}
lprpdf -pprinterName -#${Job.Copies} ${getCurrentFile(pdf)}}

If the requested data format is PDF, and if the spool ID for the job is 1000006, the file name resolves to /aiw/aiw1/spool/default/1000006/1000006.print.pdf. If the name of the printer is officeprinter and the value of the Job.Copies property for this job is 2, the printer command resolves to:

lpr -P officeprinter -#2 /aiw/aiw1/spool/default/1000006/1000006.print.pdf

Or

lprpdf -pofficeprinter -#2 /aiw/aiw1/spool/default/1000006/1000006.print.pdf
    Note:
  • Printers support different lpr options, so the printer might not honor all options requested.

1.2.4.7.5 Defining Xerox PDF printer devices

Xerox PDF printer devices represent specific models of Xerox printers that can print PDF files using XRX and XPIF (Xerox Printing Instruction Format) tickets. Jobs are assigned to Xerox PDF printers using scheduling properties.
Both Xerox PDF printer devices and Passthrough printer devices can print jobs in PDF format. Xerox PDF printer devices support more functions such as sending values for media and finishing to the printer. If Xerox PDF printer devices support your printer model, we recommend that you define a Xerox PDF printer device rather than a Passthrough printer device.
To define a Xerox PDF printer device:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. Click Add Xerox PDF Printer.
  4. On the General tab, fill in values for all the required fields.
      Note:
    • You must select a printer driver that works with your printer type. Refer to your printer driver’s configuration information for the software version.
    • The printer driver reports status information in the language that you selected when you installed the RICOH ProcessDirector server. To receive messages from this printer in a different language, set the Printer language property appropriately.
  5. On the Scheduling tab, enter the values that you want RICOH ProcessDirector to use to assign jobs to this printer. Leave the values blank or Not set for any properties that should not be used for scheduling. Those values match any values specified by the corresponding job scheduling properties.
    If you want to schedule jobs to a printer based on media, keep these items in mind when you set the Media supported property:
    • If you choose specific media, only jobs that use that media can be scheduled to this printer.
    • If you choose Ready media objects, only jobs that require the media that is currently loaded in the printer can be scheduled to the printer.
    • If you choose All media, all jobs can be scheduled to the printer, regardless of what media is actually loaded.
  6. Click OK.

1.2.4.7.6 Defining Kodak PDF printer devices

Kodak PDF printer devices represent specific models of Kodak printers that can print PDF or Postscript files. Jobs are assigned to Kodak PDF printers using scheduling properties.
Both Kodak PDF printer devices and Passthrough printer devices can print jobs in PDF or Postscript format. Kodak PDF printer devices support more functions such as sending values for media and finishing to the printer. If Kodak PDF printer devices support your printer model, we recommend that you define a Kodak PDF printer device rather than a Passthrough printer device.
To define a Kodak PDF printer device:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. Click Add Kodak PDF Printer.
  4. On the General tab, fill in values for all the required fields.
      Note:
    • The printer driver reports status information in the language that you selected when you installed the RICOH ProcessDirector server. To receive messages from this printer in a different language, set the Printer language property appropriately.
  5. On the Scheduling tab, enter the values that you want RICOH ProcessDirector to use to assign jobs to this printer. Leave the values blank or Not set for any properties that should not be used for scheduling. Those values match any values specified by the corresponding job scheduling properties.
    If you want to schedule jobs to a printer based on media, keep these items in mind when you set the Media supported property:
    • If you choose specific media, only jobs that use that media can be scheduled to this printer.
    • If you choose Ready media objects, only jobs that require the media that is currently loaded in the printer can be scheduled to the printer.
    • If you choose All media, all jobs can be scheduled to the printer, regardless of what media is actually loaded.
  6. Click OK.

1.2.4.7.7 Defining Custom PDF printers

You define a Custom PDF printer when you want to print to a PostScript printer that is not on the list of supported Ricoh PDF printers. These printers include some Ricoh PostScript printers and PostScript printers from other manufacturers. Any printer with a PostScript Printer Description (PPD) file that describes its features and capabilities can be a Custom PDF printer.

Before you define a Custom PDF printer, talk to your Ricoh support representative about your PostScript printer.

Your Ricoh support representative sends you a custom printer definition file that lets RICOH ProcessDirector create device-specific PostScript for your printer. After you receive the file, you import the file. RICOH ProcessDirector puts it on a server. Then you define a Custom PDF printer object. One example of a custom PDF printer is the Kyocera TASKalfa Pro 15000c.

1.2.4.7.7.1 Importing a custom printer definition file

After you get a custom printer definition file from your Ricoh support representative, you import the file. RICOH ProcessDirector puts it on a server.
To import a custom printer definition file:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. Click Add Custom PDF Printer .
  4. On the General tab, select the printer server that you want to define the custom PDF printer on. Then click Import file. The RICOH Printer Connector page opens in a new browser tab.
  5. On the RICOH Printer Connector page, click Import Custom Printer Definition File.
  6. Navigate to the file you want to import, and select it.
    RICOH ProcessDirector installs the file on the printer server.

1.2.4.7.7.2 Defining Custom PDF printer objects

Custom PDF printer objects represent specific models of PostScript printers that are not on the list of supported Ricoh PDF printers. These printers include some Ricoh PostScript printers and PostScript printers from other manufacturers. The Printer server for Custom PDF printers must be a Linux primary or secondary server or a Windows application server.

Jobs are assigned to Custom PDF printers using these scheduling properties: Customer name, Job size, Location, Media, Output bin, Output format, Folding, Perfect binding, Ring binding, Punch, and Staple. If the AFP Support feature is installed, these additional scheduling properties are available: Class, Destination, Form. Other scheduling properties may be defined in a configuration file.

Both Custom PDF and Passthrough printer objects can print jobs in PDF format. Custom PDF printer objects make device-specific PostScript that is based on the contents of the PostScript Printer Description (PPD) file provided by the manufacturer.

Before you define a Custom PDF printer object, you must get a custom printer definition file from your Ricoh support representative. This file lets RICOH ProcessDirector create device-specific PostScript for your printer.

To define a Custom PDF printer object:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. To define a Custom PDF printer object that uses the same custom printer definition file as an existing Custom PDF printer object, right-click the existing object and select Copy.
    To define the first Custom PDF printer object that uses a custom printer definition file:
    1. Click Add Custom PDF Printer.
    2. In the Printer server list, select the server where you want to define a Custom PDF printer device.
    3. Click Import file and the Ricoh Printer Connector page opens in a new browser tab.
    4. On the Ricoh Printer Connector page, click Import Custom Printer Definition file.
    5. Navigate to the file you want to import, and select it. RICOH ProcessDirector installs the file on the printer server.
    6. In the Custom printer type field, type the name of the custom printer definition file that you imported. Do not type the file extension. For example, if you want to use KM_1250.gpz, type KM_1250.

      RICOH ProcessDirector supports custom printer definition files with GPZ and ZIP extensions.

  4. On the General tab, fill in values for all the required fields.
      Note:
    • Select a Linux primary or secondary server or a Windows application server as the Printer server. If you just imported a custom printer definition file for this printer, specify the same printer server as the one you imported the file onto.
    • The printer driver reports status information in the language that you selected when you installed the RICOH ProcessDirector server. To receive messages from this printer in a different language, set the Printer language property appropriately.
    • SNMP returns the printer serial number when RICOH ProcessDirector establishes a connection to the printer. RICOH ProcessDirector checks the Serial number property to make sure that the printer is one of the models supported as Custom PDF printers.
    • The default value for the Job status polling interval property is 10 seconds. If you want to reduce the traffic on your network, you can increase the interval between RICOH ProcessDirector requests to the printer for job status.
  5. On the Scheduling tab, enter the values that you want RICOH ProcessDirector to use to assign jobs to this printer. Leave the values blank or Not set for any properties that are not used for scheduling. Those values match any values specified by the corresponding job scheduling properties.
    If you want to schedule jobs to a printer based on media, keep these items in mind when you set the Media supported property:
    • If you choose specific media, only jobs that use that media can be scheduled to this printer.
    • If you choose Ready media objects, only jobs that require the media that is currently loaded in the printer can be scheduled to the printer.
    • If you choose All media, all jobs can be scheduled to the printer, regardless of what media is loaded.
  6. Click OK.
      Note:
    • RICOH ProcessDirector creates a separate Java virtual machine on the Linux primary or secondary server or on the application server to run Custom PDF printers. Some computer security software notifies users when Java virtual machines are created.

1.2.4.7.8 Configuring to send jobs to a printer that uses RICOH TotalFlow Print server

Sending print jobs to a Ricoh TotalFlow printer requires specific configuration steps on the printer and in RICOH ProcessDirector.

A printer that uses RICOH TotalFlow Print server can receive various types of print jobs. The type of job you plan to send determines the type of printer object that you create in RICOH ProcessDirector and the configuration settings that you use on the printer itself.

Data Stream Printer/Control Unit RICOH ProcessDirector Printer Type
AFP Any AFP
PDF VC40000, VC60000, or VC70000 RICOH TotalFlow
RICOH Cutsheet printer that is supported by RICOH ProcessDirector

RICOH PDF Printer
RICOH Cutsheet printer that is not in the supported printer list RICOH TotalFlow
Other Any Passthrough

PDF jobs can be controlled either using RICOH ProcessDirector or at the printer using TotalFlow Print Server.

  • When RICOH ProcessDirector is set up to control the printer, the PDF jobs are sent to the printer and printed in the order in which RICOH ProcessDirector sent them.
  • When TotalFlow Print Server is set up to control the printer, RICOH ProcessDirector spools the PDF jobs to the printer. The operator uses the TotalFlow Print Server console to release the jobs to the printer.

    In this case, the job remains in the Spooled at printer state in RICOH ProcessDirector. If a user moves the job from the Active Jobs state to the Inactive Jobs state on the printer console or deletes the job from the printer, RICOH ProcessDirector changes the state of the job to Status changed on printer. An operator can use the Print again or Restart step action to send the job to the printer again. Or, if the job printed successfully, the operator can use the Go to next step action, to continue processing the job through the workflow.

    If RICOH ProcessDirector is restarted when jobs are in the Spooled at printer state, RICOH ProcessDirector changes the state of the jobs to Error. The jobs might have already printed.

    If the Merge banner pages into PDF print file property is set to No, the header page, PDF job, and trailer page are spooled at the printer as separate files. The printer could print the files out of sequence. To avoid this problem, set the property to Yes, do not print banner pages, or move the files at the same time. For example, move the files to the Inactive Jobs state or the Active Jobs state at the same time.

1.2.4.7.8.1 Setting up a RICOH TotalFlow Print server to connect with RICOH ProcessDirector

The RICOH TotalFlow Print server requires different settings depending on the type of printer you are defining to RICOH ProcessDirector. Follow the appropriate steps for the printer type you are using.
  1. Log in to RICOH TotalFlow Print server as a user with administrator privileges.
  2. Click Configuration.
  3. In the left pane, click DFENetwork.
  4. Find Network Services, and look for the correct protocol in the Protocol type list:
    • For Ricoh PDF and Ricoh TotalFlow printers, enable JMF.
    • For AFP printers, enable IPDS TCP/IP.
    • For Passthrough printers, enable either LPR or Hot Folder depending on how you are setting up the Passthrough printer.
  5. For Ricoh PDF and Ricoh TotalFlow printers:
    1. Find Ethernet Adapters.
    2. Select a card and click Edit.
    3. In the list of properties, find the fields IP address of primary DNS server and IP address of secondary DNS server. If they do not contain values, get the correct values from your network administrator and enter them. Click OK.
  6. For all printer types other than AFP printers, in the left pane, click Workflow → Virtual Printers.
  7. Select the virtual printer that you plan to use with RICOH ProcessDirector and click Edit.
  8. Click the Protocols tab.
  9. In the list of Supported submission methods, make sure the correct protocol is enabled.
    • For Ricoh PDF and Ricoh TotalFlow printers, enable JMF.
    • For Passthrough printers, enable the method that you plan to use, such as LPR, Hot Folder, or FTP.
  10. Click OK.

1.2.4.7.8.2 Defining a Ricoh TotalFlow printer to send jobs to RICOH TotalFlow Print server

Define a Ricoh PDF printer to represent a cut sheet printer that has the RICOH TotalFlow Print server console and is on the list of supported printers.
To send PDF jobs to a printer that uses a Ricoh PDF printer:
  1. Log in to RICOH ProcessDirector.
  2. Click the Administration tab.
  3. In the left pane, click Devices → Printers.
  4. Click Add → Ricoh PDF Printer.
  5. Set these values as indicated:
    • Type of printer

      The type or model of printer you are connecting to.

    • Use SNMP

      Make sure that this value is set to Yes.

  6. Click OK.
  7. Continue with the procedure for Configuring media for a Ricoh TotalFlow printer .

1.2.4.7.8.3 Defining a Ricoh TotalFlow printer to send jobs to RICOH TotalFlow Print server

Define a Ricoh TotalFlow printer to represent a Ricoh Pro VC40000, Ricoh Pro VC60000, Ricoh Pro VC70000, or a Ricoh cut sheet printer that uses RICOH TotalFlow Print server, but that is not in the supported printers list for Ricoh PDF printers.
To send PDF jobs to a printer that uses RICOH TotalFlow Print server but that cannot be defined as a Ricoh PDF printer:
  1. Log in to RICOH ProcessDirector.
  2. Click the Administration tab.
  3. In the left pane, click Devices → Printers.
  4. Click Add →Ricoh TotalFlow printer.
  5. Set these values as indicated:
    • Virtual Printer name

      The name of the virtual printer that you created on the Ricoh TotalFlow printer. This value is case-sensitive.

    • URL of the Ricoh TotalFlow printer

      The full URL of the printer that uses RICOH TotalFlow Print server. The value must be in this format, where hostname is the hostname or IP address of the printer:

      http://hostname/webJmf/Device1

      This URL is case-sensitive. You cannot use the https:// prefix.

    • Use SNMP

      Make sure that this value is set to Yes.

  6. Click OK.
  7. Continue with the procedure for Configuring media for a Ricoh TotalFlow printer .

1.2.4.7.8.4 Defining an AFP Printer to send jobs to RICOH TotalFlow Print server

Define an AFP printer that uses a RICOH TotalFlow Print server.
To send AFP jobs to a printer that uses RICOH TotalFlow Print server:
  1. Log in to RICOH ProcessDirector as a user authorized to create printers.
  2. Make sure that the AFP Support feature is installed.
  3. Click the Administration tab.
  4. In the left pane, click Devices → Printers.
  5. Click Add → AFP Printer.
  6. On the General tab, fill in values for all the required fields.
  7. Continue with the procedure for Configuring media for a Ricoh TotalFlow printer .

1.2.4.7.8.5 Sending other types of jobs to a printer that uses RICOH TotalFlow Print server

To send other types of jobs, such as PostScript, to a printer that uses RICOH TotalFlow Print server, you can either copy the jobs to a printer hot folder or use an LPR command.
  1. Click the Administration tab.
  2. In the left pane, click Devices → Printers.
  3. Click Add → Passthrough Printer.
  4. On the General tab, fill in values for all the required fields.
  5. To copy the job to a printer hot folder, update the Printer command property with a command that copies the print file to the correct location on the printer that uses RICOH TotalFlow Print server.
  6. To send the job using an LPR command, update the Printer command property with the appropriate command. For example, you could use a command such as:

    • lpr -P virtualprt1 ${getFileName(print,ps,read)}

  7. Continue with the procedure for Configuring media for a Ricoh TotalFlow printer .

1.2.4.7.8.6 Configuring media for a Ricoh TotalFlow printer

RICOH ProcessDirector can detect the paper that is loaded on a Ricoh TotalFlow printer and can be configured to create media objects automatically to represent that paper. Then, it can use media as a scheduling criteria and only schedule jobs to the printer when the correct paper is loaded. However, you must do more configuration to make sure that the media names are the same on the printer and in RICOH ProcessDirector.

    Note:
  • RICOH ProcessDirector can only detect the paper that is currently loaded. It does not import the entire paper catalog.

To configure media for a Ricoh TotalFlow printer:
  1. Load paper on the printer.
  2. In RICOH ProcessDirector, click the Administration tab.
  3. In the left pane, click Media Media Settings.
  4. In the Media Matching section, make sure that the Use the properties selected below option is selected.

    This setting lets RICOH ProcessDirector use the media values reported by the printer over SNMP to determine what media is loaded. If the values do not match any existing media objects, RICOH ProcessDirector creates media objects automatically.

      Note:
    • If your jobs specify media by product ID or name, you can change the Media Matching setting back to Use media product ID or media name after you complete this procedure.

  5. Select the properties that you use to schedule jobs to printers based on the media that is ready. For example, if your job tickets specify media using paper width and weight, select Media width and Media weight.
    This setting has no effect on the media properties that the Ricoh TotalFlow printer reports to RICOH ProcessDirector. The printer always reports all media properties that are set.
  6. Click SAVE.
  7. In the left pane, click Devices Printers.
  8. Find and right-click the Ricoh TotalFlow printer. Select Properties.
  9. Click the SNMP tab.
  10. Make sure the Use SNMP property is set to Yes. If it is not, change that value to Yes.
  11. Make sure the Get tray information from printer property is set to Yes.
  12. Click OK
  13. Right-click the Ricoh TotalFlow printer and select Show Trays.

    RICOH ProcessDirector connects with the printer and retrieves information about the media that is loaded. It compares the values for width, length, weight, color, and type to the media objects that exist in RICOH ProcessDirector. If no media exists with those values, it creates a media object with that information.

      Note:
    • If the Media to use property of the printer is set to System, RICOH ProcessDirector creates a system media object. If the Media to use property is set to Printer, RICOH ProcessDirector creates a printer media object.
    • RICOH ProcessDirector does not get the media name from the printer. A new name is derived from the properties of the media. In the next step, you change the media name in RICOH ProcessDirector so that it matches the name in the printer paper catalog.

  14. Click CLOSE.
  15. In the left pane, select Media Printer Media or Media System Media, depending on the value of the Media to use property for the Ricoh TotalFlow printer.
  16. Right-click the media that was created and select Rename.
  17. Enter the name that the Ricoh TotalFlow printer paper catalog for this media uses.
    Only include the name from the media catalog. When you click OK, RICOH ProcessDirector adds the name of the printer and a period to the beginning of the media name.
  18. Click OK.
  19. Click the media that you renamed.
  20. Find the Send media name in job ticket property and change it to Yes.
  21. Click OK.
  22. If you changed the Media Matching setting from Use media product ID or media name to Use the properties selected below, click Media Media Settings and change it back, then click OK.
Now, RICOH ProcessDirector only schedules jobs to the Ricoh TotalFlow printer when the Requested media value for a job matches the Media ready value on the printer.

1.2.4.7.8.7 Configuring SNMP for printers

Simple Network Management Protocol (SNMP) can be used by RICOH ProcessDirector to connect to a printer. RICOH ProcessDirector supports the following versions: SNMP v1 and SNMP v3.
When using SNMP v1 as a security protocol, communication between RICOH ProcessDirector and a printer is based on the network TCP/IP address or the host name of the printer.

For enhanced security protocol, with three different security levels based on authentication and encryption, use SNMP v3.

To configure SNMP credentials:
  1. Click the Administration tab.
  2. In the left pane, click Devices Printers.
  3. In the Printers table, right-click the printer and select Properties.
  4. On the SNMP tab, select one of the available SNMP versions.
    Make sure the Use SNMP and Get tray properties on the SNMP tab are both set to Yes.

    If you are using SNMP v1, all the settings corresponding to SNMP v3 are grayed out.

  5. You need to specify the TCP/IP address or the hostname of the printer for both SNMP versions.
  6. For SNMP v3, three different levels of security are available: minimum, medium, and maximum.
    1. For all SNMP v3 security levels, specify the SNMP user name that RICOH ProcessDirector uses to connect to the printer.
    2. If you use Medium or Maximum security levels, select the authentication type protocol used on the printer and enter the SNMP password for authorization.
    3. If you use the Maximum security level, select the encryption type protocol and enter the Privacy password.
  7. By selecting the Allow fallback option for SNMP v3, if RICOH ProcessDirector fails to connect to the printer, a new attempt is made using SNMP v1.
  8. Click OK.
    Note:
  • RICOH ProcessDirector does not support SNMP v3 to connect to Kodak PDF and Xerox PDF printers.
  • If you use SNMP v3, make sure the security settings are the same on the printer and in RICOH ProcessDirector.

1.2.4.8 Creating barcode formats

You can create a barcode format object for each barcode that has a different format. The barcode format identifies the values of job and document properties in the barcode.
For example, you create a barcode format for the barcode that identifies each document in a job. The operator then uses the Barcode scan action in the Documents portlet to scan this barcode on a document that was damaged during or after a process, such as insertion. The operator uses the values of job and document properties in the barcode to find the document in the system and reprint it.

Before you can create a barcode format that identifies the values of RICOH ProcessDirector custom document properties, those properties must be defined in the Database properties section of the docCustomDefinitions.xml file. If the properties are defined in the Limited properties section, edit the file to move the properties to the Database properties section.

To create a barcode format:
  1. Click the Administration tab.
  2. In the left pane, click Objects Barcode Formats.
  3. Click Add.
  4. Enter a name for the barcode format.
    The operator selects the name of the barcode format from a list of barcode formats, so enter a name that is meaningful to the operator (for example, PitneyBowes barcode or Verification barcode).
  5. To add the values of one or more properties to the barcode format:
    1. Click Add.
      The Add Barcode Format Property window is displayed.
    2. In the Property field, select the job or document property whose value you want to add.

      Some job and document properties have the same name. In the list, job properties are identified by (Job) after the property name.

      If you have the Automated Verification feature, you must include Job number and Sequence in child job in the barcode format.

      If you have the Inserter feature and the barcode contains a value for Document number, you do not need to include any other property in the barcode format.

    3. In the Property start field, specify the starting position of the property value in the barcode.
      The first character in the barcode is position 1.

      The barcode format must match how the camera or barcode scanner hardware is configured. If the barcode scanner is configured to read the value of only one property in the barcode, specify that this value starts in position 1 of the barcode. For example, the value of the Document number property starts in position 10 in the full barcode, but the barcode scanner is configured to read only characters 10 through 25. Specify that the value of the Document number property starts in position 1.

    4. In the Property length field, specify the length of the property value in the barcode.
      If you selected the Job number property and the barcode could be placed on the documents in a child job, make sure that you specify a length that accounts for the job number (eight characters), the period, and the number after the period (one or more characters).
    5. Make sure the Comparison type field is set to Equals.
      The Prefix value was useful for finding a set of documents where the value of the selected document property starts with a common prefix. The preferred method for this type of document search is to search by property and use the Like or Contains comparison to define your desired range of values.
    6. Click OK.
    7. Repeat these steps for each property value that you want to add.
    8. To see the property values in positional order, sort the table by the Property start column.
  6. Optional: To delete a property value from the barcode format:
    1. In the property table, right-click the property whose value you want to delete and select Delete.
    2. In the confirmation dialog, click OK.
  7. Optional: To modify the start or length of a property value in the barcode format:
    1. In the property table, right-click the property whose value you want to modify and click Properties.
    2. Make the appropriate changes.
    3. Click OK.
  8. Click OK.
Example
Barcode format for Automated Verification
Job numbers for parent jobs always have eight digits. You expect some jobs to go through the reprint path up to nine times. You must account for a job numbered 99999999.9, so you need 10 characters.

No job has more than 99999 documents.

The camera or barcode scanner reads the Job number property in position 1. The Sequence in child job property immediately follows the Job number property.

For the Job number property, specify:

  • Property start=1
  • Property length=10
  • Comparison type=Equals

For the Sequence in child job property, specify:

  • Property start=11
  • Property length=5
  • Comparison type=Equals

1.2.4.9 Configuring the system to use inserters

Inserters are devices that insert printed documents and additional inserts (such as marketing materials) into envelopes. You can create workflows that can help you automate the insertion of documents. The system can write and send an inserter control file for each job to the inserter controller, read the inserter results file for each job, and automatically (or with operator control) reprint any documents that were damaged during insertion.

Configuration tasks for inserters include:

  • Configuring inserter controllers
  • Creating rules that describe the inserter control files and inserter results files
  • Using scripts to transfer inserter control files and results files
  • Defining inserter controller objects
  • Creating barcode format objects
  • Configuring workflows
  • Customizing inserter document properties
  • Enhancing your print files

1.2.4.9.1 Configuring access to files on the computer that runs the inserter controller

To access the file system of an inserter controller, which resides on a computer other than the one where RICOH ProcessDirector is installed, you give RICOH ProcessDirector access to a directory on that computer by mapping the directory as a network drive. Every time RICOH ProcessDirector starts, it needs to connect to the mapped drive.
To configure access to files on the computer that runs the inserter controller:
  • If the RICOH ProcessDirector primary server is installed on a Linux computer, set up the shared drive so that it is always mounted when the primary server starts.
  • If the RICOH ProcessDirector primary server is installed on a Windows computer:
    1. Set up the shared drive from the inserter controller rather than from the primary server.
    2. Edit the C:\aiw\aiw1\bin\mountDrives.bat file, which ensures that the mapped network drive is mounted whenever RICOH ProcessDirector starts.
      For information about creating and editing the BAT file, see the topic about mapping network drives in the RICOH ProcessDirector information center.

1.2.4.9.2 Configuring inserter controllers

You must configure the inserter controllers in your installation to communicate with RICOH ProcessDirector.

1.2.4.9.2.1 Configuring inserter controllers to communicate with RICOH ProcessDirector

File-based inserter controllers must read control files from RICOH ProcessDirector, and inserter controllers that write results files must send the results files to RICOH ProcessDirector.

RICOH ProcessDirector can send inserter control files to any directory on the primary computer or to any directory on a separate computer, such as the computer where the inserter controller runs. You must configure the inserter controller to read the control file for each job from this directory.

RICOH ProcessDirector can receive inserter results files from any directory on the primary computer or from any directory on a separate computer. You must configure the inserter controller to write its results files to this directory. The directory for the inserter results files can be different from the directory for inserter control files.

For example, if the inserter controller runs on a Windows system, you can create two shared directories on the Windows system—one directory for inserter control files and another for inserter results files.

When you create the inserter controller object, you specify commands in these properties:

  • Send command: The command or script to send inserter control files to the inserter controller
  • Receive command: The command or script to receive job-specific results files from the inserter controller
  • Polling command: The command or script to receive non-job-specific results files (such as Gunther results files) from the inserter controller

In the commands, you specify the directories where inserter control files are written and inserter results files are received. If the directories are on a separate computer from RICOH ProcessDirector, login credentials to that computer must be included in the command.

For information about the parameters in which you specify the directory name and login information, see the related task topic for using supplied scripts.

1.2.4.9.2.2 Configuring inserter controllers to write results files

You must configure the inserter controller to write results files that contain the information that RICOH ProcessDirector needs to identify the job and the documents in the job.

The requirements differ, depending on whether the results files are job-specific (one results file for each job) or non-job-specific:

  • Job-specific results files: The file name of each results file must be unique for each job in the system associated with the inserter controller. We recommend that the file name of the results file contain the value of a job property whose value is unique for each job in the system, such as the Job number or Inserter job name property. (By default, the inserter job name is the job number; however, you can specify another value in the Inserter job name property.) For example, if the job number is 10001023, the name of the results file could be 10001023 or Kern10001023.

      Note:
    • RICOH ProcessDirector can put the value of the Job number or Inserter job name property in the filename of the inserter control file that it sends to the inserter controller. When you create the inserter controller object, you specify the file name of the inserter control file in the Send command property, and the file name of the results file in the Receive command property.

    Each record in the results file must contain the value of one of these document properties to identify the document to which the record applies:

    • Document number
    • Insert sequence
      Note:
    • RICOH ProcessDirector can put the values of the Document number and Insert sequence properties for each document in the inserter control file.

      Note:
    • The Quadient Inserter Express feature only supports job-specific results files.
  • Non-job-specific results files: Each record must contain the value of this document property to identify the document to which the record applies:
    • Document number
    RICOH ProcessDirector requires the document number because the document number is unique for each document in the system.
      Note:
    • RICOH ProcessDirector can include the Document number property for each document in the inserter control file or, for non-file-based inserters (such as Gunther inserters), in a barcode on the first page of each document.

1.2.4.9.3 Using inserter document properties in workflows

The inserter features provide several document properties that you can use.

You can create rules files that put the values of supplied and custom document properties in inserter control files. For example, you want to tell the inserter controller which inserter bins deliver inserts for each document in a job. If each document contains values for inserter bins, you map the values to the Bin triggers document property. Then, you add the Bin triggers property to the rules file for the inserter control file.

Inserter operators can use the supplied and custom document properties to identify damaged documents that need to be reprinted during manual reconciliation. For example, you map the customer name in each document to the Mail recipient document property. When the inserter damages a mailpiece, your inserter operator uses the Mail recipient property to find and reprint the document associated with the customer name that shows in the address window.

Inserter document properties lists the document properties supplied with the inserter features.

Inserter document properties
Property (field name) Property (database name) Description Type Length (characters)
Bin triggers Doc.Insert.BinTriggers Identifies which inserter bins deliver inserts for the document. For example, YYYYYNNNNN or 1111100000 can mean that bins 1 through 5 deliver inserts, and bins 6 through 10 do not. You can use this property in the rules file for the inserter control file to control which bins deliver inserts. character 64
Divert indicator Doc.Insert.DivertBin Specifies the number of the inserter output bin to which the document is diverted after insertion. (Diverting a document to a special output bin lets the operator manually inspect it for quality or treat it in a special way.) You can use this property in the rules file for the inserter control file to control whether the document is diverted. character 64
Mail recipient Doc.Insert.MailRecipient Specifies the name of the person to whom this document is mailed. Inserter operators can use this property to find documents to mark for reprint during manual reconciliation. character 64
Original barcode Doc.Insert.OriginalBarCode Contains the data in the original barcode that controls insertion of the document. You can use the value of this property in the Enhance AFP control file (for AFP files) or a Build PDF control file (for PDF files) to include the original barcode data in any new barcodes that you create to control insertion. character 256

For PDF files, use RICOH ProcessDirector Plug-in for Adobe Acrobat to map data in documents to inserter document properties and to save the control files that RICOH ProcessDirector uses. For more information, see the topics related to RICOH ProcessDirector Plug-in for Adobe Acrobat.

For AFP files, use the AFP Indexer and Document Property Designer modes of RICOH Visual Workbench to map data in documents to inserter document properties. Use RICOH Visual Workbench to save the control files that RICOH ProcessDirector uses. For more information, see the topics related to RICOH Visual Workbench, AFP Indexer, and Document Property Designer.

1.2.4.9.4 Enhancing files for insertion

Most files that contain documents need to be enhanced before they can be processed for insertion. The files must contain page groups that identify the documents (mailpieces). In addition, the barcodes that control insertion must contain specific information that identifies the documents, such as the document number or the insert sequence number of the document.
You can also configure RICOH ProcessDirector banner pages to print information related to insertion on each job's header and trailer page.

1.2.4.9.4.1 Identifying documents for insertion

Print jobs for insertion must contain page groups that identify the individual documents (mailpieces) in the job. For example, a bank-statement application produces a file with hundreds of individual customer statements. You must identify each customer statement as an individual document before the inserter can insert each statement in an envelope.

For PDF files, use the Define Page Group function in RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see the topics related to RICOH ProcessDirector Plug-in for Adobe Acrobat.

For AFP files, use the AFP Indexer mode of RICOH Visual Workbench. For more information, see the topics related to RICOH Visual Workbench and AFP Indexer.

1.2.4.9.4.2 Creating barcodes for insertion

You can place a barcode on each document to control insertion. If the documents have inserter control marks, the barcode supplements or replaces them.

In the barcodes, you can include the values of RICOH ProcessDirector job and document properties. In addition, you can include these values:

  • Number of the current sheet (the first sheet in the page group is 1 and so on)
  • Total number of sheets in the document

Properties to include in a barcode for insertion lists some of the properties that you can include in barcodes.

Properties to include in a barcode for insertion
Property (field name) Property (database name) Required Description Length (characters)
Document number Doc.ID Yes if the inserter does not write a job-specific results file (such as Gunther inserters). A unique number that identifies the document in the system. RICOH ProcessDirector assigns this number. 16
Insert sequence Doc.Insert.Sequence Yes if the inserter requires that the barcode contain the sequence number of the document in the job. The numeric position of the document in the job. RICOH ProcessDirector assigns this number. 8
Job number Job.ID No A unique number that identifies the job in the system. RICOH ProcessDirector assigns this number. 8
Inserter job name Job.Inserter.JobID No The name that the inserter uses for the job. 255
Bin triggers Doc.Insert.BinTriggers No The inserter bins that should deliver inserts for the document. Y or 1 in a bin position can mean that the bin should deliver an insert. N or 0 can mean that the bin should not deliver an insert. 64

To create barcodes for insertion:
  • For PDF files:
    1. Use the Hide Area function in RICOH ProcessDirector Plug-in for Adobe Acrobat to hide existing inserter control marks.
    2. Use the Add Barcode function to create a barcode.

    For more information, see the topics related to RICOH ProcessDirector Plug-in for Adobe Acrobat.

  • For AFP files:
    1. Create an Enhance AFP control file.

      You can use the sample Enhance AFP control file named enhanceAfp.cfg in /opt/infoprint/ippd/extensions/doc/samples (Linux) or C:\Program Files\Ricoh\ProcessDirector\extensions\doc\samples (Windows) to create a new control file. You can also use the AFP Enhancer mode in RICOH Visual Workbench to create a new control file.

    2. Edit the Enhance AFP control file to create a barcode.
        Note:
      • AFP Editor also creates barcodes. However, it supports values only for the current page in each document and the total number of pages in each document. If you want to include the values of document properties (such as Document number and Insert sequence) in the barcode, you must use Enhance AFP to create the barcode.

      If you are using the AFP Enhancer mode in RICOH Visual Workbench to edit an existing control file, you must load the RICOH Visual Workbench first.

    3. When you configure your workflows for insertion, specify the name of the Enhance AFP control file in the step based on the BuildAFPFromDocuments step template.

      For information about Enhance AFP, see the White Paper: Using the Enhance AFP Function publication in the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/).

1.2.4.9.4.3 Configuring banner pages for insertion

You can configure the banner pages for jobs to print the values of RICOH ProcessDirector properties related to insertion.

For example, on the job header page you want to print the name of the inserter that the operator loads the job on and the names of the material to load in each inserter bin. These values are contained in inserter job properties.

Properties related to insertion for job header and trailer pages lists some job properties related to insertion that you can include in banner pages.

Properties related to insertion for job header and trailer pages
Property (field name) Property (database name) Description
Inserter job name Job.Inserter.JobID The name that the inserter uses for the job. The default value is the RICOH ProcessDirector job number.
Inserter controller Job.InserterSystem.ID The name of the inserter controller object associated with the job.
Inserter name Job.Inserter.ID The name of the inserter for the job.
Load plan Job.Insert.LoadPlan.ID The name of the load plan associated with the job.
Load plan comment Job.Insert.LoadPlan.Comment The number of inserter bins followed by a list of the names of the materials in the load plan that the operator should load into each inserter bin.

You can include the values of many other properties on banner pages in addition to the properties listed in the table. The banner page property configuration files, installed in /aiw/aiw1/control_files/banner_pages/, define the job properties, printer properties, and system settings that you can include on banner pages. You can edit these files to add other properties.

  • For AFP jobs, edit the banner_page_property_values.cfg file.

    For information about updating properties for AFP banner pages, see the RICOH ProcessDirector information center.

  • For PDF jobs, edit the header.jrxml and trailer.jrxml files.

To include inserter job properties (such as Job.Inserter.JobID) on banner pages, you add the properties to the banner page property configuration file.

1.2.4.9.5 Creating rules for inserter control files

RICOH ProcessDirector can create an inserter control file for each job and send it to the inserter controller before the job is inserted. Because the format and content of inserter control files vary for each inserter manufacturer, you create rules files that tell RICOH ProcessDirector how to create the inserter control file.

You create these files:

  • Rules file: Defines the fields in each record (except for the header record) of the inserter control file and specifies the value to put in each field of the record. This file is required. RICOH ProcessDirector uses the rules file to write the inserter control file records. RICOH ProcessDirector writes one record for each document in the document properties file. The records follow the header record (if any). Typically, this process creates one record for each document in a job.
  • Header rules file: Defines the fields in the header record and specifies the value to put in each field of the record. RICOH ProcessDirector uses the header rules file to write the header record at the top of the inserter control file. Typically, RICOH ProcessDirector creates one header record in an inserter control file. Some inserters generate several XML elements in the header, but these elements occur only once in the XML output file. This file is required only if the inserter control file format specifies a header record.

Some inserter controllers use two inserter control files for each job. In this case, you create a second rules file and header rules file for the second inserter control file.

The rules file defines the position of each field in a record and specifies the value to put in each field. In each field, RICOH ProcessDirector can put a fixed value (such as blanks or zeroes) or the value of a RICOH ProcessDirector property. For information about which property values you can include in inserter control files, see the related Reference topic.

RICOH ProcessDirector provides sample rules files for several inserter manufacturers that you can copy and customize for your installation. Sample rules files for inserter control files shows the sample RICOH ProcessDirector rules files in the inserter directory:

  • /aiw/aiw1/samples/control_files/inserter (Linux)

  • C:\aiw\aiw1\samples\control_files\inserter (Windows)

If you have the full Inserter feature, you can use any of the sample inserter rules files listed. If you have the Quadient Inserter Express feature, you can only use the sample Quadient rules files.

Sample rules files for inserter control files
Inserter manufacturer Rules file Header rules file
Bowe BOWE.icf.halFile.dsc BOWE.icf.halFile.header.dsc
Bowe with JetVision camera systems JET.icf.dsc None (no header record)
Bowe Bell & Howell BBH.icf.idFile.dsc None (no header record)
Gunther None (no control file used) None (no control file used)
Inserters with Ironsides camera systems
IRON.icf.kicFile.dsc
IRON.icf.jdfFile.dsc
None (no header record)
Kern KERN.icf.kicFile.dsc None (no header record)
Pitney Bowes PB.icf.inputFile.dsc PB.icf.inputFile.header.dsc
Quadient quadient.jaf.inputfile.dsc quadient.jaf.inputfile.header.dsc

To create rules files for inserter control files:
  1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
  2. Navigate to the inserter directory:
    • /aiw/aiw1/samples/control_files/inserter (Linux)
    • C:\aiw\aiw1\samples\control_files\inserter (Windows)
  3. Copy all the sample rules files for your inserters to the /aiw/aiw1/config/fbi/ directory.

    We recommend this directory because files in this directory are backed up when you do an aiwbackup process.

    For example, to copy all the sample rules files for Pitney Bowes inserters:

    • On Linux, enter this command:

      cp /aiw/aiw1/samples/control_files/inserter/PB.icf.inputFile.* /aiw/aiw1/config/fbi/
    • On Windows, use Windows Explorer to copy and paste these files:

      • PB.icf.inputFile.dsc

      • PB.icf.inputFile.header.dsc

  4. Open the sample rules files with a text editor. Compare the sample rules files with the inserter manufacturer specifications and make any necessary changes.
    For information about the syntax of the rules files, see the related Reference topics.
  5. Save the files. You can keep the same file names or change them. The file name extension must be .dsc.
When you create the inserter controller object, specify the full path names of the rules files you created in these properties on the Control File tab and, if necessary, on the Second Control File tab:
  • Rules file
  • Header rules file

1.2.4.9.6 Creating rules for inserter results files

Inserter results files contain the results of insertion. You configure RICOH ProcessDirector to read the inserter results file for each job and use the information in it to determine the status of documents after insertion and which documents need to be reprinted. Because the format and content of inserter results files can vary, you create rules files that tell RICOH ProcessDirector how to parse (analyze) the fields in each record and how to map the information in the fields to RICOH ProcessDirector job and document property values.
The rules files are:
  • Parsing rules file: Defines the fields in each record of the inserter results file. This file is required.
  • Job-properties rules file: Specifies how to set RICOH ProcessDirector job-property values. If the inserter results files are job-specific, this file is required. However, the file can be empty if you do not need to set any job properties. If the inserter results files are not job-specific (such as Gunther results files), this file is not allowed.
  • Document-properties rules file: Specifies how to set RICOH ProcessDirector document-property values. This file is required.
For information about which properties you can set in the rules files, see the related Reference topic.

RICOH ProcessDirector provides sample rules files for several inserter manufacturers that you can copy and customize for your installation. Sample rules files for inserter results files shows the sample rules files in the inserter directory:

  • /aiw/aiw1/samples/control_files/inserter (Linux)

  • C:\aiw\aiw1\samples\control_files\inserter (Windows)

If you have the full Inserter feature, you can use any of the sample inserter rules files listed. If you have the Quadient Inserter Express Feature, you can only use the sample Quadient rules files.

Sample rules files for inserter results files
Inserter manufacturer Parsing rules Document-properties rules Job-properties rules
Bowe BOWE.icf_results.mslFile.dsc BOWE.icf_results.process.doc.dsc BOWE.icf_results.process.job.dsc
Bowe with JetVision camera systems JET.icf_results.flatFile.dsc JET.icf_results.process.doc.dsc JET.icf_results.process.job.dsc
Bowe Bell & Howell BBH.icf_results.idFile.dsc BBH.icf_results.process.doc.dsc BBH.icf_results.process.job.dsc
Gunther GUN.icf_results.logFile.dsc GUN.icf_results.process.doc.dsc None (not supported)
Inserters with Ironsides camera systems IRON.icf_results.dsc IRON.icf_results.process.doc.dsc IRON.icf_results.process.job.dsc
Kern KERN.icf_results.outputFile.dsc KERN.icf_results.process.doc.dsc KERN.icf_results.process.job.dsc
Pitney Bowes PB.icf_results.outputFile.dsc PB.icf_results.process.doc.dsc PB.icf_results.process.job.dsc
Quadient quadient.jrf_results.outputfile.dsc quadient.jrf_results.process.doc.dsc quadient.jrf_results.process.job.dsc

To create rules files for inserter results files:
  1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
  2. Navigate to the inserter directory:
    • /aiw/aiw1/samples/control_files/inserter (Linux)
    • C:\aiw\aiw1\samples\control_files\inserter (Windows)
  3. Copy all the sample rules files for your inserters to the /aiw/aiw1/config/fbi/ directory.

    We recommend this directory because files in this directory are backed up when you do an aiwbackup process.

    For example, to copy all the sample rules files for Pitney Bowes inserters:

    • On Linux, enter this command:

      cp /aiw/aiw1/samples/control_files/inserter/PB.icf_results.*.dsc /aiw/aiw1/config/fbi/

    • On Windows, use Windows Explorer to copy and paste these files:

      • PB.icf_results.outputFile.dsc

      • PB.icf_results.process.doc.dsc

      • PB.icf_results.process.job.dsc

  4. Open the sample rules files with a text editor. Compare the sample rules files with the inserter manufacturer specifications and make any necessary changes.
    For information about the syntax of the rules files and the document properties and job properties that you can set in the rules files, see the related Reference topics.
  5. Save the files. You can keep the same file names or change them.
    The file name extension must be .dsc.
When you create the inserter controller object, specify the full path names of the rules files you created in these properties on the Results File tab:
  • Parsing rules file
  • Document-properties rules file
  • Job-properties rules file

1.2.4.9.7 Using scripts to send inserter control files and receive results files

RICOH ProcessDirector provides scripts that you can use to send inserter control files to the inserter controller, and to receive inserter results files from the inserter controller.
    Note:
  • You can use your own script instead of one of the scripts that RICOH ProcessDirector provides. However, the script that you use must accept the same parameters as the RICOH ProcessDirector scripts. For information about all the parameters that the scripts accept, see the prologs of the scripts in directory /aiw/aiw1/bin.

When you create an inserter controller object, you specify the script and its parameters in these properties:

  • Control File tab: Send command
  • Second Control File tab: Send command
  • Results File tab: Receive command
  • Results File tab: Polling command
You can specify different scripts in each property.

Scripts to transfer inserter files in /aiw/aiw1/bin lists the supplied scripts in directory /aiw/aiw1/bin.

Scripts to transfer inserter files in /aiw/aiw1/bin
Script Description

copy_file.sh (Linux)

copy_file.pl (Windows)

Copies the inserter control file from the RICOH ProcessDirector spool directory to another directory on the same computer.

Copies the inserter results file or files from a directory on the primary computer to a staging directory.

move_file.sh (Linux)

move_file.pl (Windows)

Moves the inserter control file from the RICOH ProcessDirector spool directory to another directory on the same computer.

Moves the inserter results file or files from a directory on the primary computer to a staging directory.

ftp_file.sh (supported on Linux only)

Uses the File Transfer Protocol (FTP) to send the inserter control file from the RICOH ProcessDirector spool directory to a directory on a separate computer.

Uses the File Transfer Protocol (FTP) to receive the inserter results file (or files) from a directory on a separate computer and store the file in a staging directory on the primary computer.

    Note:
  • To use this script, the FTP command must be installed. To check if the command is installed, enter which ftp on the UNIX or Linux command line.

scp_file.sh (supported on Linux only)

Uses the Secure Copy Protocol (SCP) to send the inserter control file from the RICOH ProcessDirector spool directory to a directory on a separate computer.

Uses the Secure Copy Protocol (SCP) to receive the inserter results file (or files) from a directory on a separate computer and store the file in a staging directory on the primary computer.

    Note:
  • To use this script, the Secure Shell and SCP commands must be installed. To check if the commands are installed, enter which ssh and which scp on the UNIX or Linux command line.

sftp_file.sh (supported on Linux only)

Uses the Secure File Transfer Protocol (SFTP) to send the inserter control file from the RICOH ProcessDirector spool directory to a directory on a separate computer.

Uses the Secure File Transfer Protocol (SFTP) to receive the inserter results file (or files) from a directory on a separate computer and store the file in a staging directory on the primary computer.

    Note:
  • To use this script, the Secure Shell and SFTP commands must be installed. To check if the commands are installed, enter which ssh and which sftp on the UNIX or Linux command line.

Parameters to send inserter control files to the inserter controller lists the parameters that you can specify on the supplied scripts to send inserter control files from RICOH ProcessDirector to the inserter controller. Brackets indicate optional parameters.

Parameters to send inserter control files to the inserter controller
Script Parameters to send inserter control files to the inserter controller (Send command)

copy_file.sh (Linux)

copy_file.pl (Windows)

-d destination_directory/filename 
[-p file_permissions]
[-v]

ftp_file.sh (supported on Linux only)

-d destination_directory/filename 
-h host
[-p file_permissions]
-u user_id 
[-v]
-w password 
-x put

scp_file.sh (supported on Linux only)

-d destination_directory/filename 
-h host
[-p file_permissions]
-u user_id 
[-v]
-x put

sftp_file.sh (supported on Linux only)

-d destination_directory/filename 
-h host
[-p file_permissions]
-u user_id 
[-v]
-x put
    Note:
  • Do not specify any parameters in addition to the ones shown in this table. For example, do not specify the -s parameter to identify the source directory and filename.
-d destination_directory/filename
Specifies the destination directory and file name of the inserter control file. In the file name, you can use a RICOH ProcessDirector symbol to include the value of a RICOH ProcessDirector property in the file name. For example, the ${Job.Inserter.JobID} symbol obtains the value of the Inserter job name property.
-h host
Specifies the host name of the separate computer.
-u user_id
Specifies the login name on the separate computer.
-v
Specifies the verbose mode to help troubleshoot problems. This parameter is optional.
-w password
Specifies the login password on the separate computer.
-p file_permissions
Specifies the permissions, in octal format, to set (using the UNIX chmod command) on the inserter control file in the destination directory. This parameter is optional. If it is omitted, the script does not set any permissions.
-x put
Indicates that the inserter control file is to be sent from RICOH ProcessDirector to another system.

Parameters to receive inserter results files to RICOH ProcessDirector lists the parameters that you can specify on the supplied scripts to receive inserter results files from the inserter controller to RICOH ProcessDirector. Brackets indicate optional parameters.

Parameters to receive inserter results files to RICOH ProcessDirector
Script Parameters to receive inserter results files (Receive command) Parameters to receive all inserter results files in a directory (Polling command)

copy_file.sh (Linux)

copy_file.pl (Windows)

-s source_directory/filename -s source_directory/*

ftp_file.sh (supported on Linux only)

-h host
-s source_directory/filename
-u user_id
[-v]
-w password
-x get 
-h host
-s source_directory/*
-u user_id
[-v]
-w password
-x get 

scp_file.sh (supported on Linux only)

-h host
-s source_directory/filename
-u user_id
[-v]
-x get 
-h host
-s source_directory/*
-u user_id
[-v]
-x get 

sftp_file.sh (supported on Linux only)

-h host
-s source_directory/filename
-u user_id
[-v]
-x get 
-h host
-s source_directory/*
-u user_id
[-v]
-x get 
    Note:
  • Do not specify any parameters in addition to the ones shown in this table. For example, do not specify the -d parameter to identify the destination directory.
-h host
Specifies the host name of the separate computer.
-u user_id
Specifies the login name on the separate computer.
-v
Specifies the verbose mode to help troubleshoot problems. This parameter is optional.
-w password
Specifies the login password on the separate computer.
-s source_directory/filename
Specifies the source directory and file name of the inserter results file. The file name can use a RICOH ProcessDirector symbol to include the value of a RICOH ProcessDirector property in the file name. For example, the ${Job.Inserter.JobID} symbol obtains the value of the Inserter job name property.
-s source_directory/*
Specifies the source directory that contains the inserter results files. The asterisk (*) in the file name specifies all files in the directory. Enclose the entire parameter value in quotation marks.
-x get
Indicates that RICOH ProcessDirector is to receive the inserter results file or files from another computer.

Examples

These examples show the scripts that you can specify in the Send command property of the inserter controller to send the inserter control file for a job from RICOH ProcessDirector to the inserter controller.

copy_file.sh -d /inserter/input/${Job.Inserter.JobID}.icf -p 644ftp_file.sh -x put -h sys1 -u user1 -w pass1 -d /inserter/input/${Job.Inserter.JobID}.icf -p 644scp_file.sh -x put -h sys1 -u user1 -w pass1 -d /inserter/input/${Job.Inserter.JobID}.icf -p 644sftp_file.sh -x put -h sys1 -u user1 -d /inserter/input/${Job.Inserter.JobID}.icf -p 644

These examples show commands that you can specify in the Receive command property of the inserter controller to receive the inserter results file for a job from the inserter controller to RICOH ProcessDirector:

copy_file.sh -s /inserter/output/${Job.Inserter.JobID}.icfftp_file.sh -x get -h sys1 -u user1 -w pass1 -s /inserter/output/${Job.Inserter.JobID}.icfscp_file.sh -x get -h sys1 -u user1 -w pass1 -s /inserter/output/${Job.Inserter.JobID}.icfsftp_file.sh -x get -h sys1 -u user1 -s /inserter/output/${Job.Inserter.JobID}.icf

These examples show commands that you can specify in the Polling command property of the inserter controller to receive all the inserter results file in a directory from the inserter controller to RICOH ProcessDirector:

copy_file.sh -s "/inserter/output/*.icf"ftp_file.sh -x get -h sys1 -u user1 -w pass1 -s "/inserter/output/*.icf"scp_file.sh -x get -h sys1 -u user1 -w pass1 -s "/inserter/output/*.icf"sftp_file.sh -x get -h sys1 -u user1 -s "/inserter/output/*.icf"

1.2.4.9.8 Defining inserter controller objects

Inserter controller objects are the RICOH ProcessDirector objects that represent the inserter controllers in your installation. The inserter controller runs on another computer (for example, a Windows computer) and can manage one or more inserter devices.
You define at least one inserter controller object for each inserter controller. To specify different inserter controller properties, you create more than one inserter controller object to represent one inserter controller. After you create an inserter controller object, you associate the appropriate inserter controller object with jobs.

RICOH ProcessDirector provides sample inserter controller objects for several inserter manufacturers. You copy the supplied inserter controller object for your inserter manufacturer and modify its properties. If a different inserter manufacturer makes the inserters in your installation, you create a new inserter controller object.

To modify the properties of the inserter controller object for your environment, or to create a new inserter controller object, you need information about the inserter controller:
  • What reprint method does the inserter controller support: open-loop or closed-loop?
  • If the inserter controller uses a control file to control insertion:
    • What is the format of the inserter control file: fixed-length record (FLR), comma-delimited (DEL), or XML? For FLR format, what encoding is used (ASCII or UTF-8)?
    • Does the inserter control file require a header record?
    • Which script should RICOH ProcessDirector use to send the inserter control files to the inserter controller?
    • What are the full path names of the rules file (or files) that you have created to write inserter control files?
  • If the inserter controller writes results files after inserting jobs:
    • Does the inserter controller write a job-specific results file (that is, one results file for each job)?
    • What is the format of the inserter results file: fixed-length record (FLR) or comma-delimited (DEL)?
    • Which script should RICOH ProcessDirector use to transfer inserter results file (or files) to RICOH ProcessDirector?
    • What are the full path names of the rules files that you have created to interpret results files?

1.2.4.9.8.1 Using supplied inserter controller objects

RICOH ProcessDirector provides inserter controller objects for several inserter manufacturers. You copy the sample inserter controller object for your inserters and modify its properties.
Supplied inserter controller objects lists the inserter controller objects that RICOH ProcessDirector provides.
Supplied inserter controller objects
Inserter manufacturer Inserter controller name
Bowe BoweSample
Bowe with JetVision camera systems JetVisionSample
Bowe Bell & Howell BoweBellHowellSample
Gunther GuntherSample
Inserters with Ironsides camera systems IronsidesSample
Kern KernSample
Pitney Bowes PitneySample
Quadient QuadientSample
To use a supplied inserter controller object:
  1. Click the Administration tab.
  2. Click Devices Inserter Controllers.
  3. Right-click the inserter controller that you want to copy and select Copy.
    Copy the supplied object so that you can change the name of the object and also refer to the original sample object if necessary.
  4. On all the tabs, fill in the required properties and any optional properties.
      Note:
    • If the inserter controller is file-based (that is, the inserter controller uses control files), specify the properties on the Control File tab. If the inserter controller uses two control files for each job, also specify the properties on the Second Control File tab.
    • If the inserter controller is not file-based, clear the default values in the properties on the Control File tab.
    • If the inserter controller writes results files:
      • Specify the properties on the Results File tab.
      • If the inserter results files are job-specific, specify a Receive command on the Results File tab.
      • If the inserter results files are not job-specific (such as Gunther results files), specify a Polling command on the Results File tab. Also, in the Completion method property on the General tab, select Manual because RICOH ProcessDirector cannot automatically determine when a job has finished insertion.
      • Specify the rules files on the Results File tab.
    • If the results file for a job identifies only the documents that need to be reprinted:
      • In the Default insert status property on the General tab, select OK because documents that are not identified in the results file do not need to be reprinted.
    • If the inserter controller does not write results files:
      • Clear the default values in the properties on the Results File tab.
      • In the Completion method property on the General tab, select Manual because RICOH ProcessDirector cannot automatically determine when a job has finished insertion.
      • In the Default insert status property on the General tab, select OK so that on the Reconcile Job page, the operator needs to mark only the documents that need to be reprinted.
  5. Click OK.
  6. To use the new inserter controller, select it and click Enable.

1.2.4.9.8.2 Creating inserter controllers

If RICOH ProcessDirector does not supply an inserter controller object for your inserter controllers, you can create one.
To create an inserter controller:
  1. Click the Administration tab.
  2. Click Devices Inserter Controllers.
  3. Click Add ().
  4. On all the tabs, fill in the required properties and any optional properties.
      Note:
    • If the inserter controller is file-based (that is, the inserter controller uses control files), specify the properties on the Control File tab. If the inserter controller uses two control files for each job, also specify the properties on the Second Control File tab.
    • If the inserter controller is not file-based, clear the default values in the properties on the Control File tab.
    • If the inserter controller writes results files:
      • Specify the properties on the Results File tab.
      • If the inserter results files are job-specific, specify a Receive command on the Results File tab.
      • If the inserter results files are not job-specific (such as Gunther results files), specify a Polling command on the Results File tab. Also, in the Completion method property on the General tab, select Manual because RICOH ProcessDirector cannot automatically determine when a job has finished insertion.
      • Specify the rules files on the Results File tab.
    • If the results file for a job identifies only the documents that need to be reprinted:
      • In the Default insert status property on the General tab, select OK because documents that are not identified in the results file do not need to be reprinted.
    • If the inserter controller does not write results files:
      • Clear the default values in the properties on the Results File tab.
      • In the Completion method property on the General tab, select Manual because RICOH ProcessDirector cannot automatically determine when a job has finished insertion.
      • In the Default insert status property on the General tab, select OK so that on the Reconcile Job page, the operator needs to mark only the documents that need to be reprinted.
  5. Click OK.
  6. To use the new inserter controller, select it and click Enable.

1.2.4.9.8.3 Associating inserter controller objects with jobs

You can associate an inserter controller object with jobs. Each job can have one associated inserter controller object.

RICOH ProcessDirector uses the inserter controller object for the job to:

  • Write the inserter control file for the job and send it to the inserter controller.
  • Receive the inserter results file for the job from the inserter controller and interpret it.

To associate an inserter controller object with jobs, you specify the name of the inserter controller object in the Inserter controller job property. You can specify this property in a step based on the WriteInserterControlFile or InsertJobs step template.

If you change the Inserter controller property for a job that is already in the system, use the Process Again action to reprocess the job starting at the step based on the WriteInserterControlFile step template (if one exists) or from the step based on the InsertJobs step template.

To associate an inserter controller object with jobs:
  1. Click the Workflow tab.
  2. Click the name of the workflow that the jobs use.
    The workflow must contain a step based on the WriteInserterControlFile or InsertJobs step template.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Right-click the step based on the WriteInserterControlFile or InsertJobs step template, and select Properties.
  5. On the Insert tab, select the inserter controller object for the Inserter controller property.
  6. Click OK.
  7. Save and enable the workflow.

1.2.4.9.9 Running the QuadientInserterSample workflow

The Quadient Inserter feature provides a sample workflow that you can examine and run to understand how the feature works. The sample includes two input devices, QuadientInserterSimulator and QuadientInserterFolder, an inserter controller sample, and two workflows, QuadientInserterSample and QuadientInserterSimulator.
The sample objects used in this workflow are:
  • Inserter controller: QuadientSample

  • Input device: QuadientInserterSimulator

  • Input device: QuadientInserterFolder

  • Workflow: QuadientInserterSample

  • Workflow: QuadientInserterSimulator

You can review the properties for each object before you start the procedure to see how they interact.

To run the sample workflow:

  1. Click the Main tab.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. In the Inserters controllers portlet, right-click the QuadientSample inserter controller and select Enable.
  4. In the Input Devices portlet, right-click the QuadientInserterFolder input device and select Enable and Connect.
    The first time you try this procedure, RICOH ProcessDirector immediately submits the QuadientInserter.pdf job to the QuadientInserterSample workflow. When the job is initially submitted, it moves through the main steps of the workflow until it reaches the Reconcile step.
  5. When the job enters the Waiting to reconcile state, right-click the job and select Reconcile.
  6. On the Reconcile job dialog, click on the number in the Need action box at the top of the dialog.
  7. Select all of the documents in the table and select Reprint.
    You see Reprint in the Requested action column in the Documents table.
  8. Click OK to complete reconciliation.
  9. On the Complete Reconcile Action dialog, select the Sample printer and click OK.
    RICOH ProcessDirector creates a child job that contains the documents to be reprinted. The job number of the child job is the original job number with a numeric suffix (for example, 10000001.1). The child job starts processing from the first step in the QuadientInserterSample workflow. Because the child job has already been processed into documents, it follows the Reprints path through the workflow and returns to the Reconcile step.
  10. When the child job enters the Waiting to reconcile state, right-click the child job and select Reconcile.
  11. On the Reconcile job dialog, note that the Need Action box contains no documents. Click OK to complete reconciliation.
If you want to run the example again, you must copy the sample file to the hot folder again. The path for the QuadientInserter.pdf sample file is aiw/aiw1/testfiles directory.

1.2.4.9.10 PDF workflows for the Inserter feature

The full Inserter feature provides sample workflows that contain the steps required to receive and prepare jobs for insertion, print them, send inserter control files to the inserter controller, read inserter results files, and reconcile jobs after they have completed insertion. You copy and edit these workflows for your environment, or you add the steps in the sample workflows to your existing workflows.
    Note:
  • If you have customized phase names in your system, the phase names in this topic might not match the names in your system.
  • If you have the Quadient Inserter Express feature, sample workflows are provided. To run the sample workflows, see Running the QuadientInserterSample workflow.

If the inserter controller specifies the open-loop reprint method, two workflows are required:

  • Original workflow: This workflow is assigned to jobs entering the system. It contains steps in the Receive and Prepare phases.
  • Production workflow: This workflow contains steps in the Assemble, Print, Insert, and Complete phases.
Two workflows are required when you use the open-loop reprint method because RICOH ProcessDirector creates a child job that contains the documents to be reprinted. The child job starts processing at the beginning of the production workflow. Therefore, the production workflow should contain only the steps that are needed to process the child job.

If the inserter controller specifies the closed-loop reprint method, only one workflow is required. The workflow includes all steps from the Receive phase through the Complete phase. Using two workflows is an option. For example, use two workflows if many jobs use common processing steps in the Receive, Prepare, and Assemble phases, but different processing steps in the Print, Insert, and Complete phases.

The Inserter feature provides these PDF workflows:

  • ReceivePDFInsert_I: Contains steps in the Receive and Prepare phases. In the Assemble phase, it changes to the PrintPDFInsert_I workflow.
  • PrintPDFInsert_I: Contains steps in the Assemble, Print, Insert, and Complete phases. It does not contain steps to write and send inserter control files.
  • ReceivePDFInsert_II: Contains steps in the Receive and Prepare phases. In the Assemble phase, it changes to the PrintPDFInsert_II workflow.
  • PrintPDFInsert_II: Contains steps in the Assemble, Print, Insert, and Complete phases. It contains steps to write and send inserter control files (required for file-based inserters).
    Note:
  • Use the ReceivePDFInsert_I and PrintPDFInsert_I workflows only for inserters that do not require inserter control files.

The table Steps in the original workflow lists the required and optional steps related to insertion in the original workflow.

Steps in the original workflow
Step template Required Brief description Notes
Receive phase
SetJobPropsFromTextFile Yes Set job properties using a text file that accompanies the input file.  
DetectInputDataStream No (see Notes) Detect the format of the input data stream. This step is required if the SetJobPropsFromTextFile step does not specify the format of the input data stream.
Prepare phase
CountPages Yes Map pages to physical sheets.  
IdentifyPDFDocuments Yes Identify documents, map document data to document properties, and create the document properties file.  
WriteDocumentsToDatabase Yes Write the documents in the job to the database. This step assigns the unique Document ID that is used to track the document.
Assemble phase
ChangeJobType Yes (see Notes) Change to a new workflow. If you create only one workflow, do not include this step, and include all steps shown in the production workflow in this workflow.
Print phase
Insert phase
Complete phase
RemoveJobs No   Jobs do not go through this step if the ChangeJobType step is in the workflow.
Steps in the production workflow lists the required and optional steps for insertion in the production workflow.
Steps in the production workflow
Step template Required Brief description Notes
Receive phase
SetJobPropsFromTextFile Yes Set job properties using a text file that accompanies the input file. Job properties that the original workflow set remain set. A step or rules processing in the production workflow can set new job properties. However, it cannot change the values of job properties that were set in the original workflow.
Prepare phase
Assemble phase
SetInsertProperties Yes Set inserter document properties.  
BuildPDFFromDocuments Yes Build a PDF job. Also, apply modifications in the RICOH ProcessDirector Plug-in for Adobe Acrobat control files. The RICOH ProcessDirector Plug-in for Adobe Acrobat control files can hide existing inserter control information (such as OMR marks) and create new barcodes and OMR marks for insertion.
Print phase
CountPages Yes Map pages to physical sheets.  
CreatePageRanges Yes Enable reprinting of a portion of the job.  
PrintJobs Yes Send the job to the printer.  
Insert phase
WriteInserterControlFile No (see Notes) Write an inserter control file for the job. This step is required for file-based inserters.

If the inserter operator loads jobs before they have finished printing, move the WriteInserterControlFile and SendInserterControlFile step before the PrintJobs step.

SendInserterControlFile No (see Notes) Send the inserter control file to the inserter controller. This step is required for file-based inserters.
InsertJobs Yes Process the job for insertion. Select the inserter controller in this step. Also, specify the inserter job name if it is different from the RICOH ProcessDirector job number.
Reconcile Yes Determine which documents to reprint. Select manual or automatic reconciliation in this step. Also, select the printer to reprint any documents that are damaged after insertion.
CreateInserterReprints Yes Reprint documents in the same job (closed-loop reprint method), or create a child job that contains the documents to be reprinted (open-loop reprint method).  
Complete phase
RetainCompletedJobs No Keep the job in the system for the specified retention period.  
RemoveJobs Yes Remove the job from the system.  

1.2.4.9.11 AFP workflows for the Inserter feature

The full Inserter feature provides sample workflows that contain the steps required to receive and prepare jobs for insertion, print them, send inserter control files to the inserter controller, read inserter results files, and reconcile jobs after they have completed insertion. You copy and edit these workflows for your environment. Or, you add the steps in the workflows to your existing workflows.
    Note:
  • If you have customized phase names in your system, the phase names in this topic might not match the names in your system.

If the inserter controller specifies the open-loop reprint method, two workflows are required:

  • Original workflow: This workflow is assigned to jobs entering the system. It contains steps in the Receive and Prepare phases.
  • Production workflow: This workflow contains steps in the Assemble, Print, Insert, and Complete phases.
Two workflows are required when you use the open-loop reprint method because RICOH ProcessDirector creates a child job that contains the documents to be reprinted. The child job starts processing at the beginning of the production workflow. Therefore, the production workflow should contain only the steps that are needed to process the child job.

If the inserter controller specifies the closed-loop reprint method, only one workflow is required. The workflow includes all steps from the Receive phase through the Complete phase. Using two workflows is an option. For example, use two workflows if many jobs use common processing steps in the Receive, Prepare, and Assemble phases, but different processing steps in the Print, Insert, and Complete phases.

The Inserter feature provides these AFP workflows:

  • ReceiveInsert_I: Contains steps in the Receive and Prepare phases. In the Assemble phase, it changes to the PrintInsert_I workflow.
  • PrintInsert_I: Contains steps in the Assemble, Print, Insert, and Complete phases. It does not contain steps to write and send inserter control files.
  • ReceiveInsert_II: Contains steps in the Receive and Prepare phases. In the Assemble phase, it changes to the PrintInsert_II workflow.
  • PrintInsert_II: Contains steps in the Assemble, Print, Insert, and Complete phases. It contains steps to write and send inserter control files (required for file-based inserters).
    Note:
  • Use the ReceiveInsert_I and PrintInsert_I workflows only for inserters that do not require inserter control files.

This table lists the required and optional steps related to insertion in the original workflow.

Steps in the original workflow
Step template Required Brief description Notes
Receive phase
SetJobPropsFromTextFile Yes Set job properties using a text file that accompanies the input file.  
DetectInputDataStream No (see Notes) Detect the format of the input data stream. This step is required if the SetJobPropsFromTextFile step does not specify the format of the input data stream.
Prepare phase
ConvertLineDataJobIntoAFP No (see Notes) Convert line data into AFP format. This step is required if the input files contain line data or mixed-mode data.
IndexAFP No (see Notes) Create AFP page groups and index tags. This step is required if the input AFP files do not already contain AFP page groups that define the document (mailpiece) boundaries. Use the AFP Indexer mode of RICOH Visual Workbench.
EditAFP No Create barcodes and hidden areas. This step can create barcodes such as Intelligent Mail (IMB) barcodes. The AFP Editor feature provides this step template.
    Note:
  • To create barcodes for insertion that contain document properties, specify an Enhance AFP control file in the BuildAFPFromDocuments step.
UseInlineFormDefinition No (see Notes) Use an inline form definition if one exists. This step is required for jobs that use inline form definitions. However, you can include this step even if some jobs do not contain inline form definitions.
EnableRepositioning Yes Map logical pages to physical sheets.  
IdentifyDocuments Yes Map index tags to document properties and create the document properties file.  
WriteDocumentsToDatabase Yes Write the documents in the job to the database. This step assigns the unique Document ID that is used to track the document.
Assemble phase
ChangeJobType Yes (see Notes) Change to a new workflow. If you create only one workflow, do not include this step, and include all steps shown in the production workflow in this workflow.
Print phase
Insert phase
Complete phase
RemoveJobs No   Jobs do not go through this step if the ChangeJobType step is in the workflow.

This table below lists required and optional steps related to insertion in the production workflow.

Steps in the production workflow
Step template Required Brief description Notes
Receive phase
SetJobPropsFromTextFile Yes Set job properties using a text file that accompanies the input file. Job properties that the original workflow set remain set. A step or rules processing in the production workflow can set new job properties. However, it cannot change the values of job properties that were set in the original workflow.
Prepare phase
Assemble phase
SetInsertProperties Yes Set inserter document properties.  
BuildAFPFromDocuments Yes Build an AFP job. Also, apply modifications in the Enhance AFP control file. The Enhance AFP control file can hide existing inserter control information (such as OMR marks) and create new barcodes for insertion.
Print phase
UseInlineFormDefinition No (see Notes) Use an inline form definition if one exists. This step is required if jobs contain inline form definitions even if this step is also in the original workflow.
EnableRepositioning Yes Map logical pages to physical sheets.  
CreatePageRanges Yes Enable reprinting of a portion of the job.  
PrintJobs Yes Send the job to the printer.  
Insert phase
WriteInserterControlFile No (see Notes) Write an inserter control file for the job. This step is required for file-based inserters.

If the inserter operator loads jobs before they have finished printing, move the WriteInserterControlFile and SendInserterControlFile step before the PrintJobs step.

SendInserterControlFile No (see Notes) Send the inserter control file to the inserter controller. This step is required for file-based inserters.
InsertJobs Yes Process the job for insertion. Select the inserter controller in this step. Also, specify the inserter job name if it is different from the RICOH ProcessDirector job number.
Reconcile Yes Determine which documents to reprint. Select manual or automatic reconciliation in this step. Also, select the printer to reprint any documents that are damaged after insertion.
CreateInserterReprints Yes Reprint documents in the same job (closed-loop reprint method), or create a child job that contains the documents to be reprinted (open-loop reprint method).  
Complete phase
RetainCompletedJobs No Keep the job in the system for the specified retention period.  
RemoveJobs Yes Remove the job from the system.  

1.2.4.10 Configuring media

RICOH ProcessDirector has several media settings that you can use to help standardize the media names across printers. For Ricoh PDF Printers, you can also configure RICOH ProcessDirector to use product IDs to match media. After you configure media, the media requested by a job can be reliably matched with media available in the printer selected to print the job.

1.2.4.10.1 Defining media objects

Media objects represent the paper, forms, or envelopes that jobs are printed on. RICOH ProcessDirector uses them to schedule jobs to printers.

RICOH ProcessDirector has two types of media object:

  • System media

    Represents the media that is specified for jobs and that can be used for all printers.

  • Printer media

    Represents the media that is used with a specific printer.

System media and printer media might have different names for the same physical media. If the media names are different, you can create a media mapping to indicate that they represent the same physical media. For most printer types, you set the Media to use property to specify which media names to send to that printer with jobs.

RICOH ProcessDirector can create media objects automatically if your printer can detect media information. RICOH ProcessDirector also provides several system media objects. You can make modifications to the properties of any of these media objects and use them in the installation. You can also copy them to create new media objects.

1.2.4.10.1.1 Creating media objects automatically

If you are using a Ricoh PDF printer or if your printers can detect media information and send it over SNMP or JMF, you can have RICOH ProcessDirector create media objects automatically. The only printer type that cannot detect media information is a PCLOut printer. PCLOut printers come with the AFP Support feature.

For all printer types, RICOH ProcessDirector can use SNMP to retrieve media that is loaded in the printer. If RICOH ProcessDirector does not receive all the information that you specify in the Media Matching section of the Media Settings page, you have to update the media object by adding the missing information. For example, if you use size, color, and weight values to identify media, but your printer only provides a size value, you must add the color and weight values.

For Ricoh TotalFlow printers, RICOH ProcessDirector currently only requests media using SNMP, not JMF.

For Ricoh PDF printers, RICOH ProcessDirector automatically requests the media information from the printer using JMF. Based on the type and version of the controller on the printer, up to three media lists can be returned: standard media, catalog media, and loaded media. RICOH ProcessDirector compares the media in the lists to existing media objects by name. For names that match, RICOH ProcessDirector updates the properties of the media object to the values returned from the printer. For names that do not match, RICOH ProcessDirector creates a media object.

    Note:
  • Some printer models allow characters in their media names that are not supported in RICOH ProcessDirector media names, such as ? and #. When RICOH ProcessDirector finds one of those characters in a media name, it replaces the character with an underscore.

Using JMF, RICOH ProcessDirector can retrieve more media property values that are defined on the printer and supported by RICOH ProcessDirector. If a loaded media list is not returned from the printer, RICOH ProcessDirector requests the loaded media information using SNMP. To determine what media lists your printer model returns, see the readme file on the primary computer in /aiw/aiw1/pc .

The media lists are updated when there is a change on the printer, such as if new media is loaded or if the media catalog on the printer is updated. When the list updates, any changes made in the media objects in RICOH ProcessDirector are overwritten by the most recent information from the printer. If your printers are defined as Ricoh PDF printers, we recommend managing media on the printer instead of in RICOH ProcessDirector.

After you create your media objects, RICOH ProcessDirector can use them to match the available printer media input trays with the media requested for a job.

If you are using SNMP or your printer does not send loaded media lists using JMF, use this procedure to create media objects. If you are initially populating your media list, repeat this procedure loading in all the media you use.

To create media objects automatically:
  1. Click the Administration tab.
  2. In the left pane, click Media Media Settings.
  3. In the Media Matching section, click Use media product ID or media name if the printer schedules by product ID or name, or Use the properties selected below if the printer schedules by properties.
  4. If you select Use the properties selected below, select the properties that you use to distinguish media.
    For example, select Media color and Media weight if you distinguish media based on color and weight.
  5. Click SAVE.
  6. In the input trays, load media that you want RICOH ProcessDirector to create media objects for.
  7. If you are creating media objects for a new printer, define the printer device.
    Make sure the Use SNMP and Get tray information from printer properties are set to Yes.
    RICOH ProcessDirector attempts to create media objects for all media loaded in the input trays.
  8. In the Printers table, right-click the printer and select Show Trays.
    If the printer reported all the properties you selected to distinguish media, the Tray Media column shows the names of the media objects that were created. Continue with step 10.
  9. If the printer did not report all the properties you selected to distinguish media, no media objects are created. You can manually create printer media objects and set them as available in trays.
    1. Click Add Media.
    2. Type a media name.
    3. Fill in the required and optional properties to distinguish the media.
    4. Click OK.
    5. Right-click the tray that this media is loaded in and select Set tray media.
    6. In the Tray Media list, select the media that you just created and click OK.
    7. Repeat for other media objects that need to be updated.
    8. Click CLOSE.
  10. If the printer reports all the properties that you use to distinguish media, load more media that you want to create RICOH ProcessDirector media objects for.
  11. If you have two or more printers, create media objects for each printer.
  12. Examine any media objects created by RICOH ProcessDirector. Change the name of the media object to something your operators understand:
    1. On the Administration page, click Media System Media or Media Printer Media.
    2. Right-click the media object and select Rename.
    3. Type a new name and click OK.
    Only include the name from the media catalog. When you click OK, RICOH ProcessDirector adds the name of the printer and a period to the beginning of the media name.
  13. If you load the same media in different printers and RICOH ProcessDirector creates different printer media objects, you can map all of them to the same system media object. To map printer media to system media:
    1. On the Administration page, click Media Media Mapping.
    2. Click Add.
    3. Select the system media that you want to map.
    4. Select the printer and printer media to associate with the system media.
    5. Click OK.
    6. Repeat for each printer media.
Now you can schedule print jobs based on media ready in the printer. If your printer can send information to RICOH ProcessDirector over SNMP or JMF, you can configure the printer to schedule jobs that automatically match the media loaded in the printer.

1.2.4.10.1.2 Creating media objects manually

When you need a media object that has several different properties from the supplied or existing media objects, you can create a new one.
To create a media object manually:
  1. Click the Administration tab.
  2. In the left pane, click Media System Media or Media Printer Media.
  3. Click Add.
  4. Fill in the required and optional properties that need to be adjusted to match your environment.
  5. Click OK.
Note: You can export entries in the Media table to a Comma-Separated Values (CSV) file. Click the Gear menu button in the top right corner of the page and select Export table to CSV. The exported list only contains entries for media that match all the filters that are set. For example, you type A4 in the filter field Funnel icon. The list in the CSV file contains only the entries for media with A4 in the media name, description, or type details. The entries are sorted by media name.

1.2.4.10.1.3 Using supplied media objects

RICOH ProcessDirector provides several predefined system media objects. You can modify the properties of the predefined media objects and use them in your environment.

To modify and use a supplied media object:

  1. Click the Administration tab.
  2. In the left pane, click Media System Media.
  3. Right-click the media object that you want to modify and select Properties.
  4. Change the required and optional properties that need to be adjusted to match your environment.
  5. Click OK.

1.2.4.10.1.4 Copying media objects

You can copy a media object so you can use it as a template for creating another media object. Copying media objects can save you time, especially when you need to create several media objects with similar properties.
To copy a media object:
  1. Click the Administration tab.
  2. In the left pane, click Media System Media or Media Printer Media.
  3. Right-click the media object that you want to copy and select Copy.
  4. Fill in the required and optional properties that need to be adjusted to match your environment.
    If you copy a printer media, you can change the printer that the media is associated with. When you save the media, the name of the new printer is added to the front of the Media name. We recommend removing the original printer name from the Media name value.
  5. Click OK.

1.2.4.10.1.5 Using media with electronic forms

Media objects can include electronic forms. Electronic forms let you print jobs that previously required preprinted forms on plain paper. You associate a PDF page representing the electronic equivalent of preprinted form data with each side of a media object.

The electronic form properties of media objects are used only when jobs go through a step based on the CombinePDFWithForm or CombineAFPWithForm step template. These steps combine electronic forms with PDF or AFP job data.

1.2.4.10.2 Setting tolerances for media objects

Setting tolerance values for media size, media weight, and recycled content lets RICOH ProcessDirector account for small differences in the values that different printers report for the same media.

When new media is loaded in a printer’s input tray, RICOH ProcessDirector compares the media values to existing media objects. Property values for media height, width, weight, and recycled content are considered an exact match if they are within specified tolerances. If the values do not match any existing objects, RICOH ProcessDirector adds a new media object with those values. If you are using a Ricoh PDF printer that returns media information in JMF, tolerance values are not considered when comparing media objects.

To set tolerances for media objects:
  1. Determine the size, weight, and recycled content values for different media objects that you want RICOH ProcessDirector to recognize as the same media object.
    For example, one printer reports the weight of plain letter paper as 81 gsm. Another printer reports 80 gsm. A third printer reports 83 gsm. If the media object’s Media weight property is 81 gsm, set the Weight tolerance property to at least 2 gsm. RICOH ProcessDirector then specifies the same plain letter media for all three printers.
  2. Click the Administration tab.
  3. In the left pane, click Media Media Settings.
  4. Type values for Size tolerance, Weight tolerance, and Recycled content tolerance.
  5. Click SAVE.

1.2.4.10.3 Configuring printers to automatically match media

If your printer can detect media information and send it over SNMP or JMF, you can have RICOH ProcessDirector automatically match the media requested by a job with the media ready in the input trays for your printers.
Automatically matching media is useful only for printer controllers with direct print queues. If a controller queues jobs for later printing, the media in the printer’s input trays might change between the time when the job is sent to the print queue and when the job is printed.

This procedure does not apply to PCLOut printers. PCLOut printers come with the AFP Support feature.

To configure a printer to automatically match media:
  1. Automatically define all the media objects you need.
    If your printer cannot send RICOH ProcessDirector all the information needed to create your media objects, you cannot configure the printer to automatically match media.
  2. Turn on automatic media matching:
    1. In the Printers portlet, select the printer. Click Actions Properties.
    2. In the left pane, click Show all tabs to expand the notebook.
    3. If the printer is using SNMP to detect media information, make sure the Use SNMP and Get tray information from printer properties on the SNMP tab are both set to Yes.
      Skip this step if you are configuring a Ricoh PDF printer that supports using JMF to detect media information. RICOH ProcessDirector uses JMF with those printers.
    4. In the Scheduling area, set the Media supported property to Ready media objects.
      This setting limits the media that the printer supports to only that media that is loaded on the printer.
    5. In the Printers portlet, select the printer. Click Actions Show Trays.
When RICOH ProcessDirector sends a job to a printer, the printer examines the media properties specified for the job. If media in an input tray matches the properties, the printer prints the job.

1.2.4.10.4 Media detection

Media detection refers to two actions that RICOH ProcessDirector must take when it sends jobs to cut sheet printers: determining what media a job should be printed on and determining what media is loaded in a printer. When RICOH ProcessDirector establishes that information, it can schedule jobs correctly.

RICOH ProcessDirector uses media objects to detect and match media. Like printer objects, media objects are representations of physical objects outside of the system. Each media object represents a type of paper, transparency, or other substance that your printers can print on. You can define media objects for each type of media that you use in your environment. RICOH ProcessDirector uses those media objects to map the media requested by a job with the physical media that is loaded in the printer.

RICOH ProcessDirector has two types of media object:

  • System media

    Represents media that is specified for jobs and that can be used for all printers.

  • Printer media

    Represents the media that is used with a specific printer.

System media and printer media might have different names for the same physical media. If the media names are different, you can create a media mapping to indicate that they represent the same physical media. For most printer types, you set the Media to use property to specify which media names to send to that printer with jobs.

When a job is submitted with a job ticket, the job ticket usually includes information about the media that the job should be printed on. That information can include the name of the requested media, as well as properties of the media, such as size and color. The media detection method determines how the system interprets that information to set the Media property for the job.

The media detection method also affects how the Media ready property for a printer is set. If a printer supports SNMP or JMF, it can send information about the media loaded in its trays to RICOH ProcessDirector. The system compares that information with existing media objects to find one that matches. When it finds a match, the name of the matching media object is used for the value of the Media ready property. If none of the existing media objects match, RICOH ProcessDirector creates a new one with the specified values and uses its name as the value of the Media ready property. If the Media to use property is set to Printer, RICOH ProcessDirector creates printer media; if it is set to System, RICOH ProcessDirector creates system media

RICOH ProcessDirector provides two methods of media detection:

  • Automated

    This option uses one or more media properties specified in the job ticket to determine the value of the Media property for the job. RICOH ProcessDirector evaluates the property values in the job ticket and finds a media object with the same values. The name of the matching media object is stored as the value of the Media property.

    If more than one media object matches the specified properties, RICOH ProcessDirector uses additional logic to choose the most appropriate value.

    In addition, this option lets RICOH ProcessDirector use SNMP or JMF to set the Media ready property for printers based on the properties of the media, and create media objects if needed.

  • Manual

    This option uses the name of the media specified in the job ticket as the value of the Media property for a job, without checking any other media properties.

    You must use the Show Trays action on the printer object to specify the media loaded in the printer.

    If your printers do not support SNMP or JMF, you must use the manual method.

When the Media property for a job and the Media ready property for printers are set, RICOH ProcessDirector can use its regular scheduling process to send a job to the appropriate printer.

1.2.4.10.5 Configuring to send media product IDs to Ricoh PDF printers

If the control unit of a Ricoh PDF printer can use product IDs to select media, you can configure RICOH ProcessDirector to send product IDs.
Because RICOH ProcessDirector sends product IDs in JDF job tickets, the Data stream to send property for the Ricoh PDF printer object must be set to JDF/PDF.
To configure to send media product IDs to Ricoh PDF printers:
  • If the Media to use property for your printer is set to Printer, set the product ID values on the printer media objects:
    1. Click the Administration tab.
    2. In the left pane, click Media Printer Media.
    3. Right-click the first media object that you want to assign a product ID, and select Properties.
    4. Type a value for the Product ID property.
    5. Click OK.
    6. Repeat these steps for each printer media object that you want to assign a product ID.
  • If the Media to use property for your Ricoh PDF printers is set to System and all of them use the same product IDs to match media, assign a product ID to each system media object:
    1. Click the Administration tab.
    2. In the left pane, click Media System Media.
    3. Right-click the first media object that you want to assign a product ID, and select Properties.
    4. Type a value for the Product ID property.
    5. Click OK.
    6. Repeat these steps for each system media object that you want to assign a product ID.
  • If the Media to use property for your Ricoh PDF printers is set to System and some of them use different product IDs to match media, create a mediamap.cfg file. Use an editor that saves text in UTF-8 format:
    1. On the first line, type the Printer name value, a comma, the Media name for the media object, a comma, and the Product ID value for the media object.

      For example, if the printer name is RicohPro9110, the media name is A4 Blue, and the media product ID is 39872, type:

      • RicohPro9110,A4 Blue,39872

    2. On the next line, type another set of values for Printer name, Media name, and Product ID.

      For example: RicohPro9110,A4 Yellow,39865

      For ease of reference, we recommend that you keep all the lines for each printer together in the file.

    3. After you type the lines required to list the media names and product IDs for the first printer, type the lines required for the next printer.

      This mediamap.cfg file maps three media names to product IDs for the Ricoh Pro 9110 printer. The file maps four media names to product IDs for the Ricoh Pro 8120 printer:

      • RicohPro9110,A4 Blue,39872
      • RicohPro9110,A4 Yellow,39865
      • RicohPro9110,A4 White,39798
      • RicohPro8120,A4 Blue,239872
      • RicohPro8120,A4 Ivory,239823
      • RicohPro8120,A4 White,239805
      • RicohPro8120,A4 Recycled,239910

    4. Name the file mediamap.cfg and save it in the /aiw/aiw1/config directory as a text file in UTF-8 format.

1.2.4.11 Defining locations

Locations represent the places where printers are located.

1.2.4.11.1 Creating locations

You can create locations for objects. For example, create locations to represent the different rooms, buildings, or sites where your printers and the objects associated with them are located. RICOH ProcessDirector does not provide predefined locations.
To create a location:
  1. Click the Administration tab.
  2. In the left pane, click Objects Locations.
  3. Click Add.
  4. Fill in the properties.
  5. Click OK.

After you define your locations, set the Location property for the objects that you can manage using locations.

    Note:
  • You can export entries in the Locations table to a Comma-Separated Values (CSV) file. Click the Gear menu button in the top right corner of the page and select Export table to CSV. The exported list only contains entries for locations that match all the filters that are set. For example, you type New York in the filter field Funnel icon. The list in the CSV file contains only the entries for locations with New York in the location name or description. The entries are sorted by location name.

1.2.4.11.2 Copying locations

You can copy a location so you can use it as a template for creating another location. Copying locations can save you time, especially when you need to create several locations with similar properties.
To copy a location:
  1. Click the Administration tab.
  2. In the left pane, click Objects Locations.
  3. Right-click the location that you want to copy and select Copy.
  4. Fill in the properties.
  5. Click OK.
After you define your locations, set the Location property for the objects that you can manage using locations.

1.2.4.12 Preparing to use workflows

A workflow defines a set of steps that a job follows through the system. When you define a workflow, you specify what phases and, within those phases, what steps the job passes through during processing.

1.2.4.12.1 Creating a workflow

RICOH ProcessDirector provides several sample workflows. To create a workflow, you can modify one of these workflows or, to create a workflow that is similar to an existing workflow, you can copy the existing workflow and edit it. Also, you can create a new workflow that has only two steps, SetJobPropsFromTextFile and RemoveJobs, with a connector between them.

We recommend that you plan your workflow before you create it. Outline the processing steps that your jobs pass through, and make sure that the step templates required to create those steps exist. If any of the step templates that you need do not exist, create them before you create the workflow.

To create a workflow corresponding to the processing steps that your jobs pass through, you can add steps to processing phases in the order that you want RICOH ProcessDirector to do them.

Step chains must have one entry point, a single step at the beginning of the step chain that all jobs process through. They can, however, have multiple endpoints, or steps with no outbound connector. When a step chain is placed in a workflow, it might be connected to one or more steps for jobs both entering and exiting the step chain. If the step chain has multiple endpoints, all of the end points continue processing following the outbound connector. If there are multiple outbound connectors, each endpoint is evaluated against the connectors following the order of execution and the job proceeds down the correct path.

    Note:
  • We strongly recommend that all workflows begin with a SetJobPropsFromTextFile step and end with a RemoveJobs step.
  • When they are added to a workflow, step chains are treated like steps. In all of the actions below, references to steps apply to step chains as well.
  • If files for data streams that a workflow does not support can enter the workflow, we recommend these best practices:
    • Add a DetectInputDataStream step after the SetJobPropsFromTextFile step.
    • After the DetectInputDataStream step, add a branch with 1 step: FailWithMessage. Set the value of the Failure message property to Unexpected datastream encountered. On the connector from the DetectInputDataStream step to the next step in the workflow, set a conditional processing rule that defines the input data streams. For example, specify that the Input data stream property equals PDF.
To create a workflow:
  1. Click the Workflow tab.
  2. In the left pane, click Workflows.
  3. Right-click a workflow that you want to use as a model and select Copy.
      Note:
    • If you want to start with a workflow that has two steps, SetJobPropsFromTextFile and RemoveJobs, with a connector between them, click Add.
  4. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    You see the workflow's steps in the workflow editor.
  5. Review the steps in each phase of the workflow.
    The default processing phases in the base product are Receive, Prepare, Print, and Complete. Some features add other phases such as Assemble or Insert.
      Note:
    • The default phase names can be changed to match the functions that you perform in that phase.
  6. Delete any steps that you do not need. Select the step and press the Delete key or right-click the step and select Delete.
  7. Add each new step or step chain:
    1. To add a step, click Step Templates in the top right corner of the workflow editor; to add a step chain, click Step Chains in the top right corner of the workflow editor.
        Note:
      • To include a step template or a step chain in your favorites list, click the gray star next to that item. It turns blue.
      • To see only your favorite step templates or step chains, click the star in the table's header row.
    2. Click a step template or step chain and drag it into the workflow editor. Place the step where you want it. If you add a step on a connector, the connector will divide in two, one from the source to the new step and one to the destination step. The execution order of the connectors from the original source are preserved on the new connectors.
      • If you drop the step on top of a connector, the connector divides into two parts and the step is included in the workflow at that point.
      • If you drop a step directly on top of another step, the dropped step replaces the existing step after you confirm that action. The existing step is removed from the workflow.
      • To add another instance of an existing step in the workflow, right-click it and select Copy. Position your mouse where you want to place the step, right-click and select Paste.
        Note:
      • You can use the same name for more than one step.

        When you add a step with the same name as an existing step in the same processing phase, RICOH ProcessDirector assigns the new step a Step identifier property value. The value has a number at the end of the step name, for example, AssignJobValues2.

        Each time you add another step with the same name in the same phase, RICOH ProcessDirector increments the number by one, for example, AssignJobValues3. You see the Step identifier property value in the step and job properties notebooks, messages, and system logs.

  8. Connect the steps:
    1. Hover over the edge of the step that sends jobs to the new step. Click and hold a highlighted section () to make the connector appear.
    2. Drag the connector onto the step that receives jobs from the new step and release the mouse button.
        Note:
      • You can attach the connector to the top, bottom, either side of the step, or release over the center of the circle.
        Important:
      • If a step uses conditional processing, RICOH ProcessDirector uses the values specified in the Order of execution property of each connector to determine which connector to try first.

        If a step sends jobs to three different steps, RICOH ProcessDirector first attempts to send each job through the connector with an Order of execution value of 1. If a job does not meet the conditions for that connector, RICOH ProcessDirector attempts to send the job through the connector with an Order of execution value of 2. If a job does not meet those conditions either, RICOH ProcessDirector attempts to send the job through the next connector in the execution order.

        If a connector processes all jobs that do not meet the conditions specified by the other connectors, make sure that connector has the highest Order of execution value.

  9. Optional: To change the layout of the steps, click a step and drag it to a new position in the Workflow Editor. The connectors reposition themselves as the step moves.
  10. Optional: To change the order of the steps, click the arrowhead on a connector and move it to a different step. Repeat until all of the connectors follow the new route through your steps. Then, rearrange the steps on the Workflow Editor to match the progression of steps.
  11. Optional: To select a set of steps that are contiguous, press and hold the Shift key and drag your mouse to draw a box around the steps you want to select. Release the mouse button.

    To select a set of steps that are not contiguous, press and hold the Ctrl key. While holding Ctrl key, click on the steps you want to select.

    • To save a selected group of connected steps as a step chain, right-click on the highlighted area, and select Save as Step Chain.
    • To move the selected group, press the left mouse button down inside the box and drag the group to where you want to place it and lift the mouse button up.
    • To delete the selected group, press the Delete key or right-click inside the box to bring up the context menu and select Delete.
  12. Specify property values for each step:
    1. Right-click the step and select Properties.
    2. On each tab in the properties notebook, fill in or edit values for any required properties.
      An asterisk, *, indicates that a property is required.
    3. Fill in or edit values for any optional properties that you plan to use.
      You can also specify default values for job properties without editing each step, using the Manage job defaults action. Right-click on the Workflow editor and select Manage job defaults.
    4. When you are finished, click OK.
        Note:
      • RICOH ProcessDirector remembers the values that you enter for each step but does not save them until you save the workflow.
  13. If a step sends jobs to multiple steps, right-click each connector from the sending step to a receiving step, and select Properties. Specify a conditional processing rule for the connector, and click OK.
  14. Save the workflow by selecting Save workflow from the More menu to the left of the workflow name. You can save an incomplete workflow.
  15. When you are ready to use the workflow, enable it by selecting Enable workflow from the More menu to the left of the workflow name.
    RICOH ProcessDirector validates the workflow when you enable it. To be valid, only one step must start the workflow. That step does not receive jobs from other steps. All other steps must have connections through which they receive jobs.
      Note:
    • Alert (Alert icon) icons show steps that do not meet the requirements.

1.2.4.12.2 Adding conditional processing to a workflow

You can add conditional processing to a workflow by specifying rules for the connectors between steps. For example, a rule might specify jobs with fewer than 20 pages. The connector with that rule sends jobs to steps that request a cut sheet printer. Another connector sends all other jobs to steps that request a continuous forms printer.

We recommend that you plan your conditional processing before you specify rules. Outline the conditions that apply to each processing path. When a step sends jobs to different steps based on conditions, make sure that the conditional processing rules cover all jobs that the step receives.

When a step uses conditional processing to send different jobs to different steps, the connectors should have mutually exclusive rules. If you send all jobs that do not meet the conditions for the other connectors through a connector with a rule that has no conditions, make sure that connector has the highest value for its Order of execution property of all the connectors exiting the step.

To add conditional processing to a workflow:
  1. Click the Workflow tab.
  2. Click the name of the workflow with connectors that need conditional processing rules.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Right-click the connector and select Properties.
  5. Give the connector a conditional processing rule:
    • To define a new rule, type a Rule name.

      We recommend giving the rule a very short name that describes the processing. You see the name next to the connector on the workflow editor

    • To use an existing rule, select it on the Rule template to use list.
        Note:
      • To use an existing rule as a template for a new rule, select it. Change the name of the rule, its conditions, or both.
      • You can have multiple rules with the same name. Rules with the same name can have different conditions, and rules with different names can have the same conditions. If you assign a rule to multiple connectors and then change the conditions for the rule assigned to one connector, the conditions for the rule assigned to the other connectors do not change.
  6. If the rule has multiple conditions, specify whether All, Any, or a combination of the conditions apply to the connector.
  7. Specify the first condition using the Property field, the Comparison field, and the Value field.
    Property values are case-sensitive.
      Important:
    • The Comparison value is not (!=) does not process jobs that have no value for the specified property. To process these jobs, select the Comparison value Not set.
    For example, you want to send jobs with fewer than 20 pages to steps that request a cut sheet printer. Select the Total pages property, the less than (<) comparison, and type 20 for the value. You see a description of the rule in the Summary area: Job.TotalPages < 20.
  8. To specify another condition, click Add () and use the Property, Comparison, and Value fields.
    To delete a condition, click Delete ().
  9. When you finish specifying conditions, click OK.
  10. Repeat the procedure described above to give rules to other connectors that send jobs from the same step.
    If one of the connectors does not need a rule because it processes all jobs that do not meet the conditions specified by the other connectors, we recommend that you define a rule with a name but no conditions. Use the name to describe the processing, for example: else. Make sure this connector has the highest value for its Order of execution property of all the connectors exiting the step, so the conditions on all the other connectors are evaluated before this one. The order of execution is displayed on the label on the connector before the value of the Rule name.
  11. Go to another step with connectors to multiple steps, and repeat the procedure described above.
  12. When you finish, select Save workflow from the More menu to the left of the workflow name.
      Note:
    • If a rule is not assigned to a connector, RICOH ProcessDirector deletes the rule when you close the workflow.
  13. Enable the workflow and test it to make sure that the conditional processing works in the way you expect. Submit jobs that are sent through all the paths.
Examples
Conditional processing by total pages in a job
You want to process jobs with fewer than 20 pages differently from jobs with 20 pages or more. Jobs with fewer than 20 pages could be printed simplex on a cut sheet printer with ring binding. Jobs with 20 pages or more could be printed duplex on a continuous forms printer with perfect binding. This example describes conditional processing in the sample PDFProduction workflow.

Use conditional processing with connectors to two steps, AssignJobValues and AssignJobValues2:

  • Create the connector to the AssignJobValues step. In the Connector Property, change the Order of execution value to 1. Then give the connector a rule with one condition: Total pages < 20. Name the rule: < 20pg.
  • Create the connector to the AssignJobValues2 step. In the Connector Property, change the Order of execution value to 2. Then give the connector a rule with no conditions. Name the rule: else.

When you send jobs through the PDFProduction workflow, RICOH ProcessDirector first checks to see if the job has fewer than 20 pages. If it does, RICOH ProcessDirector sends the job through the < 20pg connector to the AssignJobValues step. If the job has 20 or more pages, RICOH ProcessDirector sends the job through the else connector to the AssignJobValues2 step.

    Note:
  • If you create the connector with the else rule and the Order of execution value for the connector is 1, RICOH ProcessDirector sends all jobs through that connector. No jobs are sent through the connector with the < 20pg rule.

In the sample PDFProduction workflow, the AssignJobValues step sets the Custom 1 job property to Small job. The AssignJobValues2 step sets the Custom 1 job property to Large job.

To print jobs with fewer than 20 pages simplex on a cut sheet printer with ring binding, use the AssignJobValues step to set the Binding property value to Ring, the Duplex property value to No, and the Requested printer property value to the name of a cut sheet printer. To print jobs with 20 pages or more duplex on a continuous forms printer with perfect binding, use the AssignJobValues2 step to set the Binding property value to Perfect, the Duplex property value to Yes, and the Requested printer property value to the name of a continuous forms printer.

Conditional processing by customer name
You want to process jobs for customer A in one way and jobs for customers B and C in another way. You also want RICOH ProcessDirector to issue an error message when a job for customer D enters the workflow by mistake. The FailWithMessage step issues an error message.

Use conditional processing with connectors to three steps:

  • Give the connector to the step for customer A a rule with one condition: Customer name = A. Name the rule A.
  • Give the connector to the step for customers B and C a rule with two conditions:
    • Customer name = B
    • Customer name = C
    Specify that Any of the conditions apply. Name the rule B or C.
  • Create the connector to the FailWithMessage step and set its Order of execution value to 3. Give the connector a rule with no conditions. Name the rule: else.

Example of workflow steps with conditional processing by customer

Conditional processing by customer name and duplexed printing
You want to process duplex jobs for customer A and B on a high quality printer and duplex jobs for customers C and D on a standard quality printer. Jobs that do not require duplex printing are all printed on the same printer.

Use conditional processing with connectors to three steps:

  • On the first connector, define these conditions:
    1. Customer name = A
    2. Customer name = B
    3. Duplex = Yes

    Do one of these:

    • Select Custom, and in the text box, type: (1 OR 2) AND 3. Name the rule (A or B) and duplex, and set the Order of execution value to 1.

    This connector sends the job to an AssignJobValues step that sets the Requested printer property to a high quality duplex printer.

  • On the second connector, define these conditions:
    1. Customer name = C
    2. Customer name = D
    3. Duplex = Yes

    Do one of these:

    • Select Custom, and in the text box, type: (1 OR 2) AND 3. Name the rule (C or D) and duplex, and set the Order of execution value to 2.

    This connector sends the job to an AssignJobValues step that sets the Requested printer property to a standard quality duplex printer.

  • On the third connector, define this condition: Duplex = No

    Name the rule Simplex and set the Order of execution value to 3.

    This connector sends the job to an AssignJobValues step that sets the Requested printer property to the printer used for simplex jobs.

1.2.4.12.3 Renaming a step in a workflow

You can rename a step in a workflow if needed.

When you rename a step, the property values of that step and its connectors remain unchanged. Any jobs that are currently processing in the step go into an Error state. We recommend that you remove as many jobs as possible that use this workflow before you rename a step to avoid complications.

To rename a step in a workflow:
  1. Click the Workflow tab.
  2. Click the name of a workflow with the step that needs to be renamed.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, right-click the step you want to rename and select Properties.
  5. Enter a new name for the step in the Step name property.
  6. Click OK.
  7. Save and enable the workflow.
Jobs that were processing in the workflow when one or more steps are renamed might need to be processed again if they encounter errors.

1.2.4.12.4 Creating a step chain

If you use the same set of connected steps in many of your workflows, you can create a step chain with those steps to use in your workflows.
To create a step chain:
  • Create a step chain manually:
    1. Click the Workflow tab.
    2. In the left pane, click Step Chains.
    3. Click Add.
    4. Fill in values for all the required fields and click CONTINUE.
    5. In the step chain editor, add and connect the steps you want to use.
    6. To save the step chain, click the menu in the upper left corner and select Save step chain.
    7. To exit the step chain editor, click the X in the upper right corner.
  • Create a step chain from steps in an existing workflow
    1. Click the Workflow tab.
    2. In the left pane, click Workflows.
    3. Open the workflow that contains the steps you want to make into a step chain.
    4. Press the Shift key and drag your mouse to draw a box around the steps you want to include in the step chain.
    5. If you want to remove some steps from the selection or add other steps that cannot be included in the box, use Ctrl click or Shift click to deselect them.
    6. Right-click inside the box to bring up the context menu and select Save as step chain.
    Note:
  • After you create a step chain and place it in a workflow, changes made to that step chain are not applied to the step chain in the workflow.

1.2.4.12.5 Copying step templates

RICOH ProcessDirector provides step templates that you can use to create custom step templates. You can then use the custom step templates to define steps that you can add to workflows.
For example, you might want to have a manual step that many workflows use for a quality check. You can copy the ManualStepWithAutoStart step template to create a new step template called QualityCheck. Then, you can add steps to your workflows based on the QualityCheck step template.
    Note:
  • Some step templates, such as PrintJobs and RemoveJobs, cannot be copied. You see an error message if you try to copy them.

To copy a step template:

  1. Click the Workflow tab.
  2. In the left pane, click Step templates.
  3. Right-click the step template that you want to copy and select Copy.
  4. On all the tabs, fill in the required and optional properties.
  5. Click OK.

1.2.4.12.6 Setting job defaults in a workflow

When RICOH ProcessDirector assigns a workflow to a job, the SetJobPropsFromTextFIle step processes all of the steps in the workflow and assigns values to job properties set by those steps. Those values are used throughout the workflow unless an AssignJobValues step or a step that can set job properties from a file changes them, such as SetDocPropsFromConditions.

When creating or editing a workflow, it is sometimes difficult to find which step sets a job property so that you can set the default value you want. You can use the Manage job defaults action to display a list of all of the job properties set in the workflow along with the values set on the steps.

Some job properties are not associated with steps and their values can only be set in files. For example, the Common Properties feature adds several useful job properties, such as Company Name, but a step template does not set the properties. You can change the default property values in a workflow with the Manage job defaults action.

Another use for this action is if you want to use the value of a job property to decide which branch to follow in a workflow. However, you want to set the value based on another property in a step before the branch. You do not want a default value assigned when the job is first received. You can use the Manage job defaults action to remove the job property from the list of properties assigned a value at the start of the workflow.

To change the default property values for a workflow:

  1. Click the Workflow tab.
  2. Click the name of a workflow you want to change default property values for.
  3. Right-click on the workflow editor and select Manage job defaults.
  4. Find the property you want to change and specify the new value.
    If the property is not in the list, use the Add a property field to select the property and its value.
  5. Optional: To remove the value from a property in the list, hover over the property in the list and select the X that appears to the right of the value field twice.
  6. After you complete your changes, click OK.
    A list of the changes you made is displayed.
  7. Check that the changes are what you intended and click OK.
    Note:
  • Changes made on the Manage Job Defaults dialog are also shown on the property notebook for the steps that include the properties.
  • You cannot set positional job properties using the Manage job defaults action.
  • If you added a property that is not associated with any step in the workflow, the property and its value are shown on the Added tab of the job property notebook.
  • If the Process again action is used to restart a job to the beginning of the workflow, the job defaults specified for any properties added or deleted by the Manage job defaults action are set.

1.2.4.12.7 Tuning step templates

Tuning a step template lets you specify how much system resource the step requires for processing. You can also specify which computers can run the steps created from the step template.

Before you do this procedure, make sure that any application or secondary servers that you want to use for step processing are enabled and connected. Note whether your computers are general-usage or restricted-usage computers.

Step templates that let RICOH ProcessDirector access applications on other computers must be tuned to run on the server that those applications are installed on.

The RunExternalProgram and RunHotFolderApplication step templates (and any copies of them) can be tuned to run on the primary server, an application server, or a secondary server.

If the RICOH ProcessDirector primary computer is a Linux system, step templates installed by some features must be tuned to run on application servers. These step templates (and any copies of them) must be tuned to run on application servers:

  • RunPitStopOnJob

Some step templates installed by features (including document processing features) can only run on the primary server. If your environment includes RICOH ProcessDirector application or secondary servers, you must tune these step templates to run only on the primary server:

  • CreateInserterReprints
  • CreateJobsFromDocuments
  • CreateReprints
  • GroupDocuments
  • InsertJobs
  • ReadBarcodeData
  • ReadDocumentsFromDatabase
  • ReadDocumentsFromParent
  • SendInserterControlFile
  • SetDocPropsFromConditions
  • SetInsertProperties
  • SetJobPropsFromOriginal
  • UpdateDocumentsInDatabase
  • WaitForDocumentCompletion
  • WriteDocumentsToDatabase
  • WriteInserterControlFile
  • WritePropsToReportsDatabase

To tune a step template:

  1. Click the Workflow tab.
  2. In the left pane, click Step Templates.
  3. Click the name of the step template that you want to tune.
  4. Click the Tuning tab.
  5. In the Servers to use section, specify whether steps based on this step template run on any available server in the general pool, or if the steps are restricted to selected servers.
      Note:
    • Depending on the step template that you selected, you might be able to further classify where the step runs by operating system type. The available operating systems are displayed in the Server operating systems list.

      For example, you might have an external program that runs only on a specific operating system such as Windows. However, you have a combination of a Linux primary server and Windows RICOH ProcessDirector application servers in the general-usage server pool. This causes RICOH ProcessDirector to display both Linux and Windows in the operating system list. In this case, click Run on servers in general server pool, deselect Linux, and select Windows.

    • The operating system list lets you select more than one operating system.
  6. In the Concurrent step limit section, specify where the limits are set for the number of steps created from the step template that can run at the same time.
  7. Click OK.

1.2.4.12.8 Creating step resources

A step resource identifies a file that is used by a workflow step for its processing. Some step templates allow you to specify a file for the step to use when processing jobs. Some of these files might be created on your workstation but need to be available to the workflow when it processes jobs. You can view, retrieve, and replace the file by editing the step resource object.
To create a step resource:
  1. Click the Workflow tab.
  2. In the left pane, click Step Resources.
  3. Click Add .
  4. In the File name property, click the folder icon to browse the folders on your computer and select the file to upload. When you have selected the file, click Open. A progress indicator displays while the file is uploaded.
  5. Fill in any other values as needed. An asterisk, *, indicates that a property is required.
  6. To see information about any of the properties, click the question mark () icon next to the property name.
  7. When you finish, click OK.
Usage notes:
  1. After you create the step resource, you can view or download the file by clicking on the link in the File name property. A browser setting determines if the file opens or is downloaded to your computer.
  2. To use the step resource, open the workflow that contains the step that uses the file. For example, the IdentifyPDFDocuments step template has a property named Identify PDF control file. To associate the step resource with the property, right-click the step and select Properties. Click PDF and select the file from the list of step resources in the Identify PDF control file field.

1.2.4.12.9 Hints for using step templates

These hints for using step templates help you choose the steps to place in a workflow, order the steps in the correct sequence, and take advantage of conditional processing capabilities. The Workflow Editor does not validate workflows to make sure that steps are in the correct sequence or that conditional processing rules work.
Sample workflows for learning how to order steps

RICOH ProcessDirector includes several sample workflows and others are supplied with features, such as Archive or Inserter. We strongly recommend that you study the order of the steps in the sample workflows, especially the more complicated workflows, before you create your own.

First and last steps in a workflow

We strongly recommend that you make the first step in a workflow SetJobPropsFromTextFile and the last step RemoveJobs. When workflow receives a job, SetJobPropsFromTextFile reads all the steps in the workflow and initializes the values for the job properties with the defaults on those steps.

    Note:
  • The AssignJobValues step sets property values but does not assign property values from all the steps in a workflow. Because SetJobPropsFromTextFile considers all steps, it is a better choice for the first step.

The RemoveJobs step not only deletes data files from the system but also cleans up database entries for a job.

We recommend that you put a RetainCompletedJobs step before the RemoveJobs step. If your workflow does not have a RetainCompletedJobs step, jobs disappear from the system as soon as they complete the step before the RemoveJobs step.

Property values for multiple steps based on the same step template

You can place steps based on step templates with positional properties in a workflow multiple times, and their properties can take different values when each step is used. The RunExternalProgram step template is an example. Two different RunExternalProgram steps can run two different external programs.

You can also place steps based on step templates that do not have positional properties in a workflow multiple times. When you change the value of one step’s properties, the values of the properties for the other steps change. The PrintJobs and RetainCompletedJobs step templates are examples.

  • Two different PrintJobs steps can only have one Requested printer property value. If you want two different branches of a conditional workflow to print to a different printer, you must place a step based on the AssignJobValues step template before each PrintJobs step. Set the values you want for each branch of the conditional workflow on each AssignJobValues step. The value of the Requested printer property in each AssignJobValues step overrides the Requested printer property value in the two PrintJobs steps.
  • Two RetainCompletedJobs steps can only have one Retention period property value. Use AssignJobValues steps to set different Retention period property values before the RetainCompletedJobs step.
    Note:
  • If a job moves through multiple workflows in your production print process, you can use AssignJobValues steps in one workflow to set property values for steps such as PrintJobs in another workflow. You cannot see the property value in the job’s properties notebook while the job is in the first workflow because the step at which the property is set is not in the first workflow. As soon as the job transfers to the second workflow, you can see the property value in the job’s properties notebook.

To see whether a property on a step template is positional, click the icon and check the Usage notes in the help.

Different data streams in one conditional workflow

If you want to use different branches of a conditional workflow for jobs in different data streams, such as PDF and AFP, make sure that the Input data stream property is set properly before the job reaches the conditional processing by data stream. The DetectInputDataStream step sets the value of the Input data stream property.

If your workflow only processes one data stream, you can omit the DetectInputDataStream step and set the value of the Input data stream property on the SetJobPropsFromTextFile step at the start of the workflow.

If you do not set the value of the Input data stream property, RICOH ProcessDirector might set the value to Unknown. If a connector has a rule that checks the value of the Input data stream property, your workflow might give unexpected results when it processes jobs in Unknown data streams.

Steps for reprinting partial jobs

The CreatePageRanges step generates a subset AFP or PDF print file when you select the Print again function and specify less than the whole job. To work, CreatePagesRanges needs information about the number of pages in the job. Steps based on the EnableRepositioning and CountPages step templates can be used for this purpose but must be placed before the CreatePageRanges step in the workflow. You only need one of them. If your job is indexed AFP, use EnableRepositioning. Otherwise, use CountPages. If your jobs are neither AFP nor PDF, do not use any of the three steps.

Step to keep related child jobs together

In some cases, your original job may end up as several child jobs that you want to keep together at critical points in the workflow such as printing. Place a WaitForRelatedJobs step before the step that needs all the child jobs together. The WaitForRelatedJobs step stops processing until all the child jobs reach that point in the workflow.

Step templates that cannot be copied or deleted

Some step templates, such as PrintJobs and RemoveJobs, are protected by the system. They cannot be copied or deleted. Although you might want to set the Requested printer property value in the PrintJobs step template to one type of printer and then copy the PrintJobs step template and set the value in the copy to another type of printer, you cannot do that. Use two steps based on the AssignJobValues step template to set different property values and pass them to the PrintJobs step in the workflow.

Step for notification of jobs that stop in a conditional workflow

If you want to write a message to the job log when a job stops in a step because the conditional processing in a workflow is not designed correctly, add a step based on the FailWithMessage step template as the last conditional branch of a step. When a job arrives at the FailWithMessage step, RICOH ProcessDirector writes the message that you specify with the FailWithMessage step.

If you do not have a FailWithMessage step and a job does not meet any of the conditions to go to another step, the job stays in the step in a No matching connector state.

Steps available to the Process again function

Each step in a workflow has a Step restart type property. The default value is General. If a step has any Step restart type property value except None, you can choose the step when you use the Process again function on a job. RICOH ProcessDirector saves the input print file to each step at which you can restart a job. If you want to reduce the number of copies of large files that you keep in the system, set the Step restart type property value to None on some steps. Operators can still process jobs again, but they might have to restart the job at an earlier step in the workflow.

    Note:
  • Only steps that have been run for a job can be processed again. Depending on the step and attributes, a job that is processed again might take a different path through the workflow.
  • If you edit a workflow with active jobs in it, you must start over at the beginning of the workflow to restart the job.

Steps available to the Print again function

We recommend setting the Step restart type property value to Print on the CreatePageRanges step. When an operator uses the Print again function for a job, RICOH ProcessDirector starts the reprinting process at the first step in the workflow with a Step restart type property value of Print. If you do not set the Step restart type property value on at least one step to Print, you cannot use Print again. RICOH ProcessDirector does not set the Step restart type property value to Print by default.

Steps available to the Override error function

If you use a step that puts a job in error, you can use the Override error function to move the job out of the error state manually. Set the value of the Allow error override property to Yes. For example, the VerifyPrintedSheetCount step puts a job in error if the count does not match. When the Allow error override property is set to Yes, an operator can force a job to continue through the workflow even though the printed sheet count has not been verified.

Additional information on step templates

Several step templates have relationships to other step templates. Each step template has a reference topic in the Supplied step templates section of the information center. See the usage notes in those topics to understand the relationships before using the step templates in a workflow.

1.2.4.12.10 Adding a step that makes a job wait

You can add a step based on the Wait step template to a workflow to cause a job to wait a set amount of time or until a specified time to continue processing.

There are various reasons to use the Wait step to pause a job. For example, you could:

  • Create a workflow that processes a job up to the point where a cancel decision is required from the customer.

    You can set the wait period to the deadline for receiving the cancellation order and then have the job released automatically if the cancellation order does not arrive.

  • Create a workflow that pauses a job until a pull list arrives.

    Your customer often sends requests to suppress printing of some documents in a job. You have set a deadline of 9 AM with your customer to have a pull list delivered that you can use to suppress printing of some documents. You can put a Wait step in the workflow just before the SetDocPropsFromList step that reads the pull list to automate processing.

  • Create a workflow that waits until an optimum time to send email documents to a third-party email service.

    You might want to wait until after regular working hours to send a large number of email documents to the service to have them sent out overnight. Insert the Wait step just ahead of the EmailDocuments step in the workflow.

To define a workflow with a Wait step:

  1. Click the Workflow tab.
  2. Right-click a workflow that you want to use as a model, and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Review the steps that are included in the workflow and the default values that they set.
  5. Determine where in the workflow you want the waiting period to occur. Add a step based on the Wait step template to the workflow in the appropriate place and set values for the job properties.
    You can set either a specific time for the wait period to end or a length of time for the wait period. You can use these properties to control the waiting period:
    • Use the Wait for property to designate a time period for the job to wait before processing continues.
    • Use the Wait until property to set a specific time when the waiting period expires and processing resumes.
    • Set the time zone with the Time zone property. The Time zone applies only if you use the Wait until property. The default value for the property is the time zone of the server that RICOH ProcessDirector is installed on.
    • If you set values for both Wait until and Wait for, the step calculates the end time for each option. You can choose whether to move the job to the next step when the first end time is reached or when the last end time is reached.

      For example, a workflow contains a Wait step with these settings:

      • Wait until: 12:00 PM
      • Time zone: Eastern Standard Time (EST)
      • Wait for: 3 hours

      A job reaches that step at 10:00 AM EST. The step determines that the two possible end times are:

      • Wait until: 12:00 PM EST
      • Wait for: 3 hours (1:00 PM EST)

      If Complete step after is set to First occurs, the job moves to the next step at 12:00 EST. If Complete step after is set to Last occurs, the job moves to the next step at 1:00 PM EST.

      To see the calculated time when the waiting period for a job ends, check the Wait step ends property on the Wait tab of the job property notebook.

  6. Save the workflow.

1.2.4.12.11 Assigning workflows

When an input file enters the RICOH ProcessDirector system, one of the first actions that the input device does is to assign a workflow to it. After the input device assigns the workflow, the job can begin to move through the processing steps. There are several methods through which the input device can assign the workflow. You configure the method to meet the requirements of the installation.

Use one of these methods to assign the workflow:

  • The easiest way to assign a workflow to a job is to use the Child workflow property on the input device. When you set the Child workflow on an input device, the device assigns that workflow to every job that it processes. All input devices that RICOH ProcessDirector supplies use this method to assign the workflow for the data sets or input files that they receive.
      Note:
    • Jobs that consist of multiple input files are processed as child jobs of the parent job that groups them. The parent job takes the workflow that is set by the Workflow property on the input device, while the child jobs take the workflow that is set by the Child workflow property on the input device.
  • You can set the workflow for a job using a Child workflow initialization step on the input device. If you select this method, all jobs that arrive on the input device pass through the initialization step you specify; the initialization step assigns the workflow. If your jobs have multiple input files, also set the Workflow initialization step property. Parent jobs pass through that initialization step to have their workflow assigned. RICOH ProcessDirector provides these step templates that you can use for a workflow initialization step:
    • The SetJobTypeFromRules step template points to a control file that the input device can use to determine the workflow. The control file lists job parameters that accompany jobs when they are submitted, such as LPR control file parameters, and their corresponding RICOH ProcessDirector properties. For example, you could edit the control file to map the value of the Copies LPR parameter to the value of the Child workflow property. You specify the control file that the input device uses with the Child workflow parsing rules property on the input device.
    • The SetJobTypeFromFileName step template parses the file name of the input file to determine what workflow to assign. To use this step, you specify text that always appears in the name of a certain type of input file and map it to a workflow. Use the Child workflow pattern property to define the string you want to use for the workflow.

      Make sure that you have created and enabled workflows with names that correspond to the strings you specify. These strings are case-sensitive.

  • You can set both the Child workflow and the Child workflow initialization step properties for an input device. If the Child workflow initialization step property is set, the step tries to set the workflow using that method. If the step cannot set the workflow, it assigns the workflow that the Child workflow property specifies. If that property has no value, RICOH ProcessDirector issues an error message. You can also set both the Workflow and the Workflow initialization step properties for an input device to assign the workflow for parent jobs. RICOH ProcessDirector uses the same assignment hierarchy.

1.2.4.12.12 Associating service policies with workflows

You can associate a service policy with one or more workflows. The service policy calculates the planned checkpoints and the SLA deadline for all jobs that use the workflow. Each workflow can have one associated service policy. To measure the performance of jobs using an SLA deadline, you must also identify an SLA target step for the workflow.

If more than one service policy applies to a workflow, you might need to create additional workflows. For example, if you have created two service policies – one for jobs from client ABC and another for jobs from client XYZ – and both clients use workflow PDF, you could create another PDF workflow. The workflows can have identical properties except for the associated service policy. You might, for example, name the two workflows PDF.ABC and PDF.XYZ.

If you change which service policy is associated with a workflow, RICOH ProcessDirector uses the new service policy to set the checkpoints and deadline for new jobs that arrive in the system. It does not use the new service policy for existing jobs unless you use the Process Again action to reprocess a job from the first step.

If you delete a no-service period, checkpoint and deadline times for jobs that are already in the system do not change, even if they were set using that no-service period. To reset the checkpoint times, you must reprocess the job from the beginning.

If a workflow or an authorized user changes the Adjusted arrival time property for a job, RICOH ProcessDirector recalculates the checkpoints for the job. Depending on the service policy, sometimes the checkpoints and the deadline change:

  • If the service policy specifies the Cutoff adjustment method and a start time that is later than the old adjusted arrival time and earlier than the new adjusted arrival time, the checkpoints change from the day of the old adjusted arrival time to the day after the new adjusted arrival time.
  • If the service policy specifies the Cutoff adjustment method and a start time that is later than both the old and new adjusted arrival times, the checkpoints remain the same.
  • If the service policy specifies Elapsed time as the Deadline calculation method, the SLA deadline is recalculated from the Adjusted arrival time.
  • If the service policy specifies Specific time as the Deadline calculation method, the SLA deadline is not recalculated.

To associate a service policy with a workflow:
  1. Click the Workflow tab.
  2. Optional: Right-click the name of the workflow and select Disable.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  3. Right-click the name of the workflow and select Properties.
  4. In the Service policy property, select the service policy.
  5. In the SLA target step property, select the step that represents the ultimate goal of the SLA.
    For example, if the SLA relies on printing the job by a given time, select the PrintJobs step. If the SLA relies on delivering the printed output to another department for inserting, you can create a manual step called DeliverToInserter and select that step as the SLA target step.
  6. Click OK.
  7. Save and enable the workflow.

1.2.4.12.13 Replacing your control files with the sample files

When you install a new version of RICOH ProcessDirector, the installer automatically adds new sample control files to the /aiw/aiw1/samples directory and copies them to your control files directory, /aiw/aiw1/control_files. It does not overwrite any of your customized control files in /aiw/aiw1/control_files. You can use the copyConfigurationFiles script to install the default control files or to overwrite your customized control files.

Replacing your control files requires Perl to run. Before replacing your control files, make sure a Perl interpreter is installed.

To replace your control files with the sample files:
  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. On the command line, enter this command:
    • /opt/infoprint/ippd/bin/copyConfigurationFiles.pl

    You can add these optional parameters to the copyConfigurationFiles command:

    • [-r [-b]] [-w forceReplaceFile] [samplesDirectoryconfigurationFilesDirectory] [[-o differencesOutputFile] [-c]] [-v] [-help]
    -r
    The script overwrites existing files in the /aiw/aiw1/control_files directory.
    -b
    The script backs up each file it replaces. The backup files are called replaced_file.bak. It does not back up files unless they are being replaced by a different version of that file.
    -w forceReplaceFile
    The script overwrites a specific set of files. List the file paths to overwrite in the forceReplaceFile file.
    samplesDirectory
    The directory where the sample files are located. The default is /aiw/aiw1/samples.
    configurationFilesDirectory
    The directory where the control files are located. The default is /aiw/aiw1/control_files.
    -o differencesOutputFile
    The script writes any file names where there are different versions of a file in the samples and control_files directories. The different version file names are written to the differencesOutputFile file.
    -c
    The script compares the files in the /aiw/aiw1/samples and /aiw/aiw1/control_files directories and prints a list of which files are in both directories but have different content. Running the script with this parameter does not do the normal copying and replacing.
    -v
    The script displays additional file information while copying files.
    -help
    The script displays help and syntax information.

New versions of RICOH ProcessDirector might add new functions that require updated control files. To move your customized content from the old control files to the new control files:

  1. Generate a list of which files have new versions. Enter this command:
    • copyConfigurationFiles.pl -o /tmp/differencesOutputFile
  2. Copy the new control files. Enter this command: copyConfigurationFiles.pl -r -b -w /tmp/differencesOutputFile

    Specifying the -b option means the script backs up files before overwriting them.

  3. Copy your customized content from the replaced_file.bak backup files to the corresponding control file.

1.2.4.12.14 Workflows for printing

You can define a workflow that lets you track a job that contains PDF data through the system.
The primary function of a PDF workflow depends upon the target printer.
  • If the target printer is a Ricoh PDF printer, the workflow can send a job and a job ticket to the printer. The printer uses the information contained in the JDF job ticket to complete the job, which lets the user view real-time status and job progress.
  • If the target printer supports LPD or another protocol, the workflow can use the PrintJobs step to send a job to a printer that uses that protocol. The PrintJobs step uses job properties to schedule the job to an appropriate printer. If more than one printer can print the job, the PrintJobs step balances printer loads.
  • If the target printer receives jobs or JDF job tickets through hot folders, the workflow can send the job to a Passthrough printer device. The printer device has a Printer command property that copies the job into a hot folder that is associated with the printer.
  • If the target printer is a Kodak printer, the PrintJobs step can send the PDF file, with inserted KDK commands, to the printer. The Cut Sheet Support for Kodak feature is required.
  • If the target printer is a Xerox printer, the PrintJobs step can send the PDF file, with inserted XRX or XPIF commands, to the printer. The Cut Sheet Support for Xerox feature is required.
  • If the target printer is a custom PDF printer, the PrintJobs step converts the PDF file to PostScript and sends a PostScript data stream to the printer. The data stream can contain device-specific PostScript commands.

Another function of the workflow can be to combine small PDF files into one larger file. Adding the BuildPDFFromZIP step to a PDF workflow lets you concatenate PDF files contained in a .zip file into a larger PDF file. The smaller files are added to the new file in the order they are in the .zip file. The hot folder input device that processed the input file can create the .zip file. Alternatively, you can package the files as a .zip file before they are submitted.

1.2.4.12.14.1 Defining a workflow to print a job

To print a job on a printer, you must create a workflow that uses the PrintJobs step.
To define the workflow:
  1. Click the Workflow tab.
  2. Right-click an appropriate workflow, such as PDF, and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Right-click the PrintJobs step and select Properties.
  5. In the Scheduling tab, select a value for the Requested printer property.
    • If you know which printer you want to print the job, select it from the list.
    • If you want to schedule the job manually, select Not set. The job does not print until someone uses the Schedule action to assign the job to a printer.
    • If you want RICOH ProcessDirector to assign the job to the first available printer that matches the scheduling properties, select Any printer. RICOH ProcessDirector uses properties such as Job size, Customer name, Media, and Finishing options to determine which printers match the job's requirements when the job reaches the PrintJobs step.
      Note:
    • If you have more than one PrintJobs step in a workflow because you want to set the Requested printer using conditional rules, leave the Requested printer property on the PrintJobs step as Any printer and put an AssignJobValues step on each branch in the workflow. Use the AssignJobValues step to set the Requested printer value as needed for each branch.
  6. If the value of the Create .zip file property for the hot folder input device that assigns jobs to this workflow is set to Yes, add a step based on the BuildPDFFromZIP step template to the workflow before the first step that expects PDF input (for example, CreatePageRanges or PrintJobs ):
    1. In the workflow editor, click Step Templates in the top right corner of the window.
    2. Click the BuildPDFFromZip step template and drag it into the workflow editor. Place the step where you want it.
    3. If you want to rename the step, right-click the step. Select Properties, and then click General. For the Name property, type a name for the new step and click OK.
    4. Connect the step to the other steps.
  7. Save the workflow.

1.2.4.12.14.2 Defining a workflow to copy a file to a printer hot folder

You can define a workflow that accepts a print job in a format such as PDF or PostScript or a JDF job ticket and copies it to a hot folder that is associated with a printer.
To define a workflow to copy a file to a printer hot folder:
  1. Click the Workflow tab.
  2. Right-click the PDF workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Right-click the PrintJobs step and select Delete.
  5. If you plan to send PostScript jobs to this workflow, delete the CountPages and CreatePageRanges steps.
  6. Add a CopyToFolder step to the Print phase
  7. Connect the CopyToFolder step to the RetainCompletedJobs step.
    1. Hover over the edge of the CopyToFolder step. Click and hold a highlighted section () to make the connector appear.
    2. Drag the connector onto the RetainCompletedJobs step.
  8. Connect the CopyToFolder step to the step on its left ( CreatePageRanges for PDF workflows or RunExternalProgram for PostScript).
  9. Right-click the CopyToFolder step and select Properties.
  10. Click External.
  11. Delete the contents of the External Command property and replace it with one of these commands.

    To copy a print file:

    • cp ${getCurrentFile(${Job.InputDatastream})} destinationHotFolder/${Job.ID}

    To copy a JDF job ticket:

    • cp ${getFileName(overrides,jdf,read)} destinationHotFolder/${Job.ID}

    In this text, replace destinationHotFolder with the name of the directory that the printer uses as a hot folder.
  12. Click OK.
  13. Save the workflow.
If you also define an AFP printer device to represent the same physical printer, set these properties for the AFP printer device:
  • Set the Share printer connection property to Yes.
  • Set the IPDS printer connection timer property to a lesser value than the Inactivity timer property. If the IPDS printer connection timer property is greater than the Inactivity timer property, RICOH ProcessDirector drops the connection to the printer before it can share the printer with the hot folder.

1.2.4.12.14.3 Defining a workflow to print to a Passthrough Printer

You can define a workflow that accepts a print job in PDF or PostScript format and sends it to a Passthrough printer.
To define a workflow to print to a Passthrough printer:
  1. Click the Workflow tab.
  2. Right-click the PDF workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. If the new workflow does not process PDF jobs, right-click the CreatePageRanges step, and select Delete.
    Do not delete this step if the new workflow processes PDF jobs. It is needed to reprint a range of pages in PDF jobs.
  5. Connect the RunExternalProgram step to the PrintJobs step.
  6. Right-click the PrintJobs step, and select Properties.
  7. In the Scheduling tab, change the values of the Binding, Fold options, Requested location, Media, Output bin, Punch, and Staple properties to match the scheduling properties of the Passthrough printer that you want to print on. If you have the AFP Support feature installed, change the values of the Job class, Job form, and Job destination properties as well. Other scheduling properties may be defined in a configuration file.
  8. If the workflow processes PDF files and the value of the Create .zip file property for the hot folder that assigns jobs to this workflow is set to Yes, add a step based on the BuildPDFFromZIP step template to the workflow before the first step that expects PDF input (for example, CreatePageRanges or PrintJobs ).
  9. Click OK.
  10. Save the workflow.

1.2.4.12.14.4 Printing PDF and PostScript files on the InfoPrint 5000 printer Models AS1 and AD1/2

To send PDF and PostScript files to the hot folders on the InfoPrint 5000 printer Models AS1 and AD1/2 with RICOH ProcessDirector for Linux, you can set up a workflow that uses the CopyToFolder step.

To send PDF and PostScript files to an InfoPrint 5000 hot folder, you must:

  • Verify that the Samba open source client is installed on your primary system.
  • Define a workflow that includes a CopyToFolder step.
  • Make sure that your primary Linux system is connected to the InfoPrint 5000 printer.

1.2.4.12.14.4.1 Verifying that Samba open source client is installed

To print to an InfoPrint 5000 printer hot folder from RICOH ProcessDirector for Linux requires the Samba open source client.
To verify that the Samba open source client is installed:
  1. Log in to the primary server as root.
  2. Enter this command:
    • >smbclient -L printername -N
  3. You see results similar to these:
    Domain=[WORKGROUP] OS=[Unix] Server=[Samba 3.0.22-ibm-SLES10]
            Sharename       Type      Comment
            ---------       ----      -------
            Duplex          Disk
            IPC$            IPC       IPC Service (INFOPRINT 5000)
            ADMIN$          IPC       IPC Service (INFOPRINT 5000)
    
    Domain=[WORKGROUP] OS=[Unix] Server=[Samba 3.0.22-ibm-SLES10]
            Server               Comment
            ---------            -------
            printer3             INFOPRINT 5000
    

    The presence of the Sharename of Duplex indicates that at least one hot folder is enabled on the InfoPrint 5000 printer.

  4. If Samba is not installed, contact your system administrator.

1.2.4.12.14.4.2 Defining a workflow to submit a file to an InfoPrint 5000 hot folder

To submit a print job to a hot folder on an InfoPrint 5000, you must create a workflow that uses the CopyToFolder step.
To define the workflow:
  1. Click the Workflow tab.
  2. Right-click the OutputPDF workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Find and right-click the TransformJobIntoPDF step.
  5. Select Delete. You see a confirmation message. Click Yes.
  6. Connect the DetectInputDataStream step to the CopyToFolder step:
    1. Hover over the DetectInputDataStream step. Click and hold a highlighted section () to make the connector appear.
    2. Drag the connector onto the CopyToFolder step, wait until a section of the step is highlighted, and release the mouse button.
  7. Right-click the CopyToFolder step and select Properties.
  8. Click External.
  9. Delete the contents of the External Command property and replace it with a one of these commands:
    • If you want to submit a print file to the hot folder, the command should look like this:
      • cp ${getCurrentFile(${Job.InputDatastream})} /mnt/destinationHotFolder/${Job.ID}

      Replace destinationHotFolder with the name of the directory that the InfoPrint 5000 printer uses as a hot folder.

        Note:
      • When you use this command, you cannot send the number of copies (or other job properties) to the printer. You must specify the number of copies on the printer.

    • If you want to submit a MIME package (containing a PDF file and a JDF job ticket), which specifies the number of copies to print, the command should look like this:
      • cp ${getFileName(print,mjm,read)} /mnt/destinationHotFolder/${Job.ID}

      Replace destinationHotFolder with the name of the directory that the InfoPrint 5000 printer uses as a hot folder.

        Note:
      • Copying a MIME package requires InfoPrint 5000 Code Level V2.9.112 or later.

  10. Click OK.
  11. Save and enable the workflow.

1.2.4.12.14.4.3 Connecting to the InfoPrint 5000 hot folder

To copy files into a hot folder on an InfoPrint 5000, that hot folder must be mounted to the RICOH ProcessDirector primary server.
You can mount the hot folder using the smbmount command.
    Note:
  • If either RICOH ProcessDirector or the InfoPrint 5000 printer is shut down, you need to re-issue the smbmount command.
To issue a smbmount command:
  1. Log in to the primary RICOH ProcessDirector as root.
  2. Enter this command for Model AS1:
    • >smbmount //printerIPAddress/simplex /mnt -o guest,fmask=777
  3. Enter this command for Model AD1/2:
    • >smbmount //printerIPAddress/duplex /mnt -o guest,fmask=777
  4. To view the enabled hot folders, list the contents of the shared directory:
    • >ls -al /mnt

1.2.4.12.15 Holding jobs

If you do not want jobs to move through their workflow without human intervention, you can configure the workflows to hold jobs at a given point. You can then have the operators do an action to release the jobs.

For example, if operators have to load different forms for each job, they can release jobs after they have loaded the correct forms on the printer.

To hold jobs, do one of these:

  • Set the Requested printer property on a step based on the PrintJobs step template to Not set, so that all jobs that pass through that workflow receive that value.

    The default is that the Requested printer property is set to Any printer. As a result, jobs are automatically scheduled to the first available printer whose scheduling properties match the values for the associated job properties. However, if Requested printer property is set to Not set, the jobs wait for an operator to use the Schedule Job action to assign them to a printer. After the job has been scheduled, the Requested printer property is set and the job moves through the rest of its processing steps.

  • Set the Stop when entering phase property on a step that is based on the SetJobPropsFromTextFile step template. When you add one of those steps to a workflow, you select a phase as the value of the Stop when entering phase property. When a job reaches that phase, it stops and waits without going through any of the processing steps in that phase.

    If a job is stopped at the beginning of a phase, an operator can use the Continue action to resume processing of the job. The operator must also make sure that the scheduling properties for the job match the scheduling properties for at least one printer and that the Requested printer property is set to Any printer or to a specific printer so the job can be scheduled for printing.

    For example, if you select the Print phase, a job moves through all the processing steps specified for the Receive and Prepare phases. Then it moves to the Print phase, but it waits before starting any steps. The job state changes to Stopped. An operator can right-click the job and select Continue to start processing again.

  • Include a manual step in a workflow, so that jobs have to wait for an operator to indicate that the job is ready to move to the next processing step.

    For example, you can create a step based on the ManualStepWithAutoStart step template and name it Enter Purchase Order Number, then add it to the Prepare phase of a workflow. When a job arrives at this step, its status changes to Manual, Working. An operator can edit the job properties to enter the purchase order number and then right-click the job and select Manual complete to complete the step and release the job.

1.2.4.12.16 External steps

RICOH ProcessDirector lets you add steps that run a program outside of RICOH ProcessDirector. The external program can do special job-processing tasks and it can run on the same computer that has the RICOH ProcessDirector base product installed. It can also run on a Linux system that has a RICOH ProcessDirector secondary server feature installed, or on a Windows system that has an application server installed on it.

Because the processing is external to the processing that the RICOH ProcessDirector-provided steps do, this type of processing is called an external step.

External steps can access files in the spool directory for the job. When RICOH ProcessDirector creates a job from an input file, it creates a unique spool directory. The spool directory contains a copy of the input file and other files that provide information about the job. External steps can call programs that update existing files in the spool directory and write new files to the directory.

The default spool directory for a job is /aiw/aiw1/spool/default/JobNumber (JobNumber is the spool ID that RICOH ProcessDirector assigns to the job).

On an application server, the spool directory is mounted on the drive that you chose when you installed the application server. The default is Z:\aiw1\spool\default\JobNumber.

You can also create additional spool directories. These spool directories have names in this format: /aiw/aiw1/spool/SpoolName/JobNumber (SpoolName is the subdirectory name that the authorized user defined).

The programs that the external steps call can also create child jobs. The spool directory contains a /aiw/aiw1/spool/default/JobNumber/children subdirectory or a /aiw/aiw1/spool/SpoolName/JobNumber/children directory that external program can use to write its child jobs and their associated files. After it detects the child jobs and files, RICOH ProcessDirector can continue to process them.

1.2.4.12.16.1 Setting up external programs

Before you start the configuration tasks for an external step, you need to set up the external program that the external step calls.
Install the external program and, if applicable, the application/secondary server software before you start this procedure.

Important points to remember when you install the base product or application/secondary servers and the other application:

  • When you install the RICOH ProcessDirector software on a Linux system, the installation program creates the RICOH ProcessDirector system user (aiw1 is the default). When you verify the operation of an external program that runs on a Linux system, use the RICOH ProcessDirector system user to do your verification testing.
  • RICOH ProcessDirector does not automatically create a system user account for RICOH ProcessDirector on a Windows application server. The installation program prompts for the name of the user account to use as the RICOH ProcessDirector user. Verify the operation of the external program from the user account for the RICOH ProcessDirector user on the Windows application server.
  • When the RICOH ProcessDirector primary computer is a Linux system, make sure that the RICOH ProcessDirector system user and the user that the other application uses have the appropriate permissions for the directories and file systems that they use.
  • Make sure that the RICOH ProcessDirector system user can find and execute the other application. Use one of these methods:
    • Include the full path to the application in the command that you create.
    • Add the application to the PATH environment variable for the RICOH ProcessDirector system user.

      This option works best if the other application runs on the same system as the primary server. If the application runs on an application or secondary server, this option only works if you mount the directory that the other application is installed in.

    • Create a symbolic link to the other application, storing the link in /aiw/aiw1/bin.

      Storing a symbolic link in that directory provides some important benefits. RICOH ProcessDirector adds that directory to the PATH environment variable when it creates the RICOH ProcessDirector system user, so the application can be recognized without separately editing the PATH. The directory is not deleted when you apply service, although some of the files in it might be updated. The link file should not be affected.

      In addition, application and secondary servers can access this directory. As a result, they can also use the symbolic link to locate the external application if it is located within the /aiw file system. The external application cannot run on both a Linux primary computer and a Windows application server.

To set up the external program:

  1. Use the documentation for the external program and verify that it runs without errors as a standalone program.
  2. If you plan to use RunExternalProgram:
    1. Log on to the computer that the application runs on as the RICOH ProcessDirector system user or as the Windows user ID that the application server runs under.
    2. Compose the command that you can use to invoke the program from the command line and use it to submit an input file to the program.
      Record the command that works correctly so you can use it as the model when you configure your step template.
    3. Create a control file template for the step to use.

      If the external program reads the property values that it requires from a parameter file that accompanies the print file, the RunExternalProgram step can build that file. To generate the file, the step uses a control file template. To create the control file template:

      1. Make a copy of a parameter file that the application can use.
      2. Replace all of the property values in the file with the RICOH ProcessDirector symbol notation representation of the property. If the value is the file name for a file in the job, replace it with the appropriate RICOH ProcessDirector method call to determine the file name.

        During processing, the step uses the template to build the parameter file by resolving all the references and filling in the values for the current job.

      3. Copy the control file template into a directory in the RICOH ProcessDirector shared file system (/aiw/aiw1/.)In that location, all servers that are connected to the primary server can access the file.

        Sample control file templates for external programs are installed in /aiw/aiw1/samples/external_programs/. You can copy these files to the /aiw/aiw1/control_files/external_programs/ directory and customize them, or add your own control files to the /aiw/aiw1/control_files/external_programs/ directory. Note the directory location of your control file template.

      4. On a Linux system, verify that the file permissions for the control file template provide access for the other class of system users. For example, set the permissions for the control file template to 666.
      5. Make sure one external command passes the control file in the parameter it expects (the -o option for including additional job properties, for example).

    4. On a Linux system, create a symbolic link to the application on the primary computer:
      1. Log on to the system that the RICOH ProcessDirector base product runs on as the RICOH ProcessDirector system user.
      2. Use the stopaiw command to stop the primary server.
      3. Use this command to create the symbolic link:
        ln -s application_file /aiw/aiw1/bin/link_file
        Replace application_file with the full path to the executable file for the application, and replace link_file with the name of the symbolic link file you want to create. The executable file must be located within the /aiw file system.
      4. Use the startaiw command to start the primary server.
  3. If you plan to use RunHotFolderApplication:
    1. Log on to the primary computer as the RICOH ProcessDirector system user.
    2. Copy or transfer a sample print file into the input folder for the application.
    3. Check the other application to make sure that it starts to process the file.
    4. Monitor the output folder for the resulting file. When it arrives, copy or transfer it to another directory, then verify that it is correct.
    5. Navigate to the directory that holds the log files for the other application and make sure that you can open and view the log files.

1.2.4.12.16.2 Setting up step templates for external steps

You create a step template that contains the command that calls the external program. Then, you tune the step template so that it will run on the Linux or Windows system on which the external program is installed.

1.2.4.12.16.2.1 Setting up step templates for external steps that use the command line or control files

Use this process to set up a step template for external steps that use the command line or a control file to pass parameters between RICOH ProcessDirector and the external program.
To set up a step template for an external step:
  1. Click the Workflow tab.
  2. In the left pane, click Step templates.
  3. Right-click the RunExternalProgram step template and select Copy.
  4. Specify a name and description for the new step template.
  5. Click External.
  6. Update the External command property.
    This is the actual command and any command-line parameters that RICOH ProcessDirector issues to run the external program. The command string can include RICOH ProcessDirector symbol notation:
    • In this example, the Linux cp command only copies the JobNumber.print.pdf file from the spool directory for the job when the source file is newer than the destination file:
      cp -u ${getAbsoluteFileName(print, pdf, read)} /tmp/jobarchives
        Note:
      • ${getAbsoluteFileName(print, pdf, read)} is the RICOH ProcessDirector symbol formula that returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, an error occurs.
    • In this example, the external program myprogram reads the JobNumber.print.pdf file from the spool directory and writes an updated version of the file to the spool directory using redirection:
      myprogram -i ${getFileName(print, pdf, read)} > ${getFileName(print, pdf, write)}
        Note:
      • ${getFileName(print, pdf, read)} is the RICOH ProcessDirector symbol formula that returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, RICOH ProcessDirector returns the name of the input file for the job, which is JobNumber.print.unknown. If that file does not exist in the spool directory, an error occurs.
    • In this example, the external program auditstatistics reads the JobNumber.overrides.text file from the spool directory and writes a new statistics file JobNumber.statistics.text to the spool directory:
      auditstatistics inputfile=${getFileName(overrides, text, read)} outputfile=${getFileName(statistics, text, write)}
    • In this example, the external program line2afp uses a separate parameter file for which a corresponding RICOH ProcessDirector control file exists if the AFP Support feature is installed. The control file specifies a RICOH ProcessDirector method that instructs the external program to write its output to the spool directory:
      line2afp parmdd=${getControlFileName()}
        Note:
      • ${getControlFileName()} is the RICOH ProcessDirector symbol formula that returns the name of the resolved control file. RICOH ProcessDirector generates the control file from the control file template that you specify.
      • The control file can use the getChildFileName method to return the name of a child file so that the external program can write a file to the children subdirectory in the spool directory. The external program must write the file names of child-job files in this format:
        JobNumber.UsageType.DataType.n,Job.JobType=WorkflowName
        WorkflowName is the name of the workflow that the child job requires. The workflow must exist and it must be enabled.
      • When you add a step based on the RunExternalProgram step template to a workflow, the properties that show [Receive] in the job defaults change to reflect the actual phase to which you add the step.
    • In this example, the external step uses the Windows copy command to write a copy of the JobNumber.print.pdf file from the spool directory to an archive directory on the Windows system:
      copy ${getAbsoluteFileName(print,pdf,read)} d:\archive\pdf
        Note:
      • The Windows system must have either the base product or an application server installed. The application server must be connected to the primary server.
      • Specify the Windows directory by using the native Windows format for the directory name.
      • Use native Windows commands instead of SFU commands where appropriate; for example, use the copy command instead of the cp command. Not all SFU commands are available on Windows systems.
      • Depending on the command, a directory on the Windows system might not need to exist. The command can create the directory on the Windows system.
      • Make sure that you tune the step template to only run on a Windows application server. Because of the different formats for directory names on Linux, a step based on this step template will fail if RICOH ProcessDirector tries to run the step on a non-Windows system.
  7. If you created a control file template for use with the external program, update the External control file template property. Set the value to the directory location and name of the control file template. If the external program only receives its parameters as command line arguments, delete any value for this property.
  8. Update the Valid return codes property.
    In this context, a valid return code is any return code from the external program that does not require a user action. Separate multiple return-code numbers with commas. For any return code from the external program that the value for this property does not include, RICOH ProcessDirector moves the job to the error state. It also issues a message in the log for the job to alert you to a problem that the external program reported.

    For example, if the value of the valid-return-codes property is 0,4, and the external program finishes with a return code of 16, RICOH ProcessDirector issues a message similar to this:

    AIWI6073E External step cp /aiw/aiw1/spool/default/10000016/10000016.print.unknown /archive/directory finished with a return code of 16, which is a defined as an error.

  9. If the installation has specific language requirements, you can also instruct the external program to return messages in a language that it supports. The list for the External program language property lists the languages that RICOH ProcessDirector supports.
  10. Click OK.
  11. Update any settings on the Tuning tab to run the step on the computers where the external program is installed.
  12. Right-click the new step template and select Enable .

1.2.4.12.16.2.2 Setting up step templates for external steps that use hot folders

Use this process to set up a step template for external steps that use hot folders to pass input and output between RICOH ProcessDirector and the external program.
To set up a step template for an external step:
  1. Click the Workflow tab.
  2. In the left pane, click Step templates.
  3. Right-click the RunHotFolderApplication step template and select Copy.
  4. Specify a name and description for the new step template.
  5. Click Hot Folder.
  6. Update the Sending folder property.
    The value of this property is the name of the input hot folder for the external program. RICOH ProcessDirector places the job in this folder to submit it to the external program.
      Note:
    • The value must be the name of a folder that exists. RICOH ProcessDirector does not create the folder.
    • The folder must be accessible to both RICOH ProcessDirector and the external program. It can be:
      • In the RICOH ProcessDirector shared file system, /aiw/aiw1/, on the computer that has the primary server installed.
      • In a file system that is shared using file sharing software, such as Samba.
    • Even if the folder is on a Windows system, specify the path using Linux format. For example, if the folder is C:\Sending, type /Sending.
    • If this value is null, no file is copied and the step waits.
  7. Update the File to send property.
    The value of this property is a symbol formula that resolves to the name of the file that RICOH ProcessDirector sends to the external program.
      Note:
    • The default value is getAbsoluteFileName(print, pdf, read), which returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, an error occurs.
  8. Update the Retrieval folder property.
    The value of this property is the name of the output hot folder for the external program. RICOH ProcessDirector retrieves the job from this folder after the external program has processed it.
      Note:
    • The value must be the name of a folder that already exists. RICOH ProcessDirector does not create the folder.
    • The folder must be accessible to both RICOH ProcessDirector and the external program. It can be:
      • In the RICOH ProcessDirector shared file system, /aiw/aiw1/, on the computer that has the primary server installed.
      • In a file system that is shared using file sharing software, such as Samba.
    • Even if the folder is on a Windows system, specify the path using Linux format. For example, if the folder is C:\Retrieval, type /Retrieval.
    • When you set the Clean up retrieval folder property to No, the file that the step retrieves can be in the retrieval folder when a job arrives at the step. The step retrieves the file and puts the file specified by the File to send property in the sending folder. The step then sends the job and the retrieved file to the next step in the workflow. The step does not wait for a new file to be placed in the retrieval folder.
  9. Update the Retrieval pattern property.

    The value of this property is the pattern-matching string that RICOH ProcessDirector uses to identify the output files to retrieve from the output hot folder of an external program.

    For example, the value ${Job.ID}.* matches any file whose file name is the same as the job ID, with any file extension.

  10. Update the Retrieved file property.
    The value of this property is a symbol formula that resolves to the name that RICOH ProcessDirector uses to rename the retrieved file.
  11. Update the Clean up retrieval folder property.

    When a job enters the step, this value tells RICOH ProcessDirector whether to remove any file in the retrieval folder whose file name matches the Retrieval pattern.

  12. Update the Application log file property.
    The value of this property is the folder where the external program writes log files. This value can be blank.
  13. Update the Poll interval property.
    The value of this property is the interval in seconds at which RICOH ProcessDirector checks the output hot folder for completed jobs.
  14. Update the File size verification count property.
    The value of this property is the number of times that RICOH ProcessDirector polls the output hot folder and finds a file that has not changed in size. RICOH ProcessDirector then decides that the file is complete.
  15. Update the Timeout interval property.
    The value of this property is the time limit in minutes for retrieving a job from the output hot folder of an external program. If the job has not been received or is not complete when the time limit is reached, the job is in error.
      Note:
    • Make the timeout interval longer than the poll interval times the file verification count.
    • If the timeout interval is 0, RICOH ProcessDirector waits forever.
  16. Click OK.
  17. Update any settings on the Tuning tab to run the step on the computers where the external program is installed.
  18. Select the new step template and click Enable.

1.2.4.12.16.3 Setting up workflows for external steps

After you create a step template to call an external program and tune the step template to run on the server that the external program is installed on, you add a step that is based on the step template to a workflow. You then assign the workflow to an input device, or use another method to assign the workflow to specific jobs.
To set up a workflow for an external step:
  1. Click the Workflow tab.
  2. Determine whether you can use a copy of an existing workflow or if you need a new workflow. Do one of these:
    • Right-click one of the workflows and select Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    • Click Add and specify a name and description for the new workflow.
  3. To add the external step:
    1. In the workflow editor, click Step Templates in the top right corner of the window.
    2. Click the external step and drag it into the workflow editor. Place the step where you want it.
    3. If you want to rename the step, right-click the step. Select Properties, and then click General. For the Step name property, type a name for the new step and click OK.
  4. Edit the properties for processing behavior as needed.
  5. Connect the step to other steps.
    The external step can use conditional processing to receive a job from multiple steps and send it to multiple steps. You can attach rules with conditions to the connectors, and you can set job properties for different branches of the workflow by adding steps based on the AssignJobValues step template.
  6. Add or update the other steps in the workflow if necessary. A workflow can contain more than one step that calls an external program.
  7. Save and enable the workflow.
  8. Test the external program.

1.2.4.12.16.4 Testing external step processing

After you set up step templates for external steps and add steps to workflows, configure the method of workflow assignment and run test jobs before you run any production jobs.
To test external step processing through RICOH ProcessDirector:
  1. Determine how you want to assign the workflow that contains the external step to jobs and configure the input device.
  2. Submit a job to the input device, and view the log for the job after processing completes.
  3. If the job did not complete its processing and is in an error state, or if processing was successful but the results were not as expected, use the messages in the log to correct the problem.

1.2.4.12.17 Defining a workflow with preview printing

To print sample pages from a job so you can verify the output before you print the entire job, you must define a workflow that includes one or more steps based on the PreviewPrint step template.

There are various ways to use preview printing and corresponding methods for creating workflows. For example, you could:

  • Create a workflow with one PreviewPrint step and configure it so operators check the preview print every time the step runs.

    If the output is not acceptable, the operators can change property settings for the job and use the Process Again action to do the preview print again.

  • Create a workflow with multiple PreviewPrint steps and configure it so some of the preview prints are accepted automatically.

    Operators can compare all the output and adjust the job properties to match the preview print that is most acceptable, then let the job continue processing with the next step.

  • Create a preflight workflow that includes multiple PreviewPrint steps with some of the preview prints accepted automatically, with or without a PrintJobs step. Then, create other workflows that correspond to the properties used in each PreviewPrint step.

    Operators can compare the preview print output and choose which one is most acceptable. Then, they can accept the preview print and choose to continue processing the job either in the same workflow or in one of the other workflows.

You can choose the method that best matches your process.

To define a workflow with preview printing:

  1. Click the Workflow tab.
  2. Right-click a workflow that you want to use as a model and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Review the steps that are included in the workflow and the default values that they set.
  5. Add one or more steps based on the PreviewPrint step template to the workflow in the appropriate places and set the job property defaults.
    If you add more than one PreviewPrint step, you can set the Accept preview print automatically property to Yes to have some of the steps accepted without intervention.
  6. Add any other steps that you want to include in this workflow, including steps that change output options between steps based on the PreviewPrint step template.
  7. Save and enable the workflow.

1.2.4.12.18 Setting up a workflow that uses a Reformat step restart type

To move jobs from one printer to another, you might need to reformat the jobs. For example, a job is formatted to print 2-up on a continuous forms printer, but you need to move the job to a cut sheet printer where the data should be formatted 1-up. Scheduling the job to the printer is not enough because the data in the job must be reformatted to print correctly on the printer. You must set up the workflow to reformat the job for the printer.
After you set up the workflow, an operator can use the Output format scheduling property to make jobs match a printer. When the operator uses the Schedule jobs page to change the Output format of a job, the job is sent to the step that has a Reformat step restart type. From that step, the job is sent through the workflow path that runs the correct steps for the selected Output format.

Before you set up a workflow, identify the reformatting required. Your workflow needs a conditional processing path for each Output format value that is used by your printers.

The Output format scheduling property has five values. Because the values only schedule jobs to printers, you can assign them to any job formatting process. This list gives a suggested use for each value:

  • A to Z for PDF

    You might assign the A to Z for PDF value to roll-to-fold PDF printers and to jobs that you format for those printers.

  • Z to A for PDF

    You might assign the Z to A for PDF value to roll-to-roll PDF printers and to jobs that you format for those printers.

  • A to Z for AFP

    You might assign the A to Z for AFP value to roll-to-fold AFP printers and to jobs that you format for those printers.

  • Z to A for AFP

    You might assign the Z to A for AFP value to roll-to-roll AFP printers and to jobs that you format for those printers.

  • Transform

    You might assign the Transform value to Postscript printers and to jobs in any data stream that you format for those printers.

To set up a workflow that uses a Reformat step restart type:

  1. Assign Output format values to your printers:
    1. In the Printers portlet, right-click a printer and select Properties.
    2. On the Scheduling tab, set a value for the Output format property.
  2. Click the Workflow tab.
  3. Click the name of the workflow you want to modify.
  4. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  5. Set the Output format value for the jobs in the workflow.
    For example:
    • Set a value for Output format in an overrides file.
    • On the AssignJobValues step, select Output format as a value for the Values to set property and then select a value for Output format.
    • On the PrintJobs step, set a value for Output format.
  6. Set the Step restart type to Reformat on the step that sends jobs through connectors to the branches that reformat the jobs for printers with different Output format values.
    If you need to add a step to the workflow for this purpose, you might use the ContinueToNextStep step template.
      Important:
    • Your workflow should have only one step with a Reformat step restart type. If multiple steps have this step restart type, the job moves to error state when an operator makes the Output format value for the job match the Output format value for the printer.
  7. Add conditional processing to the workflow to do the reformatting.
    Depending on your needs, the conditional processing might be simple or complicated.

    Steps such as ReversePDFPageOrder, PreparePDFOutputForFinishing, or ReverseOutputOrder (for AFP jobs) can be used to reorder the pages in a job. Place the steps that reformat the job after the step with the Reformat restart type, and add conditional processing for each type of job that you are reformatting.

    If the Output format of the job is Transform and you have an appropriate Transform feature installed, steps such as TransformJobIntoPDF, TransformJobIntoAFP, or TransformWIthAdvancedFeature can be used to transform the job into the correct data stream for the printer.

    The example at the end of this procedure shows how to modify a simple PDF workflow to reformat jobs.

  8. Save and enable the workflow.
  9. Test the workflow to make sure that jobs with each Output format value follow the proper path through the workflow and are reformatted for the requested printer.
Example: Modifying a simple workflow that sends jobs to a roll-to-fold PDF printer

The workflow has these steps:

  • SetJobPropsFromTextFile
  • DetectInputDataStream
  • CountPages
  • CreatePageRanges
  • PrintJobs
  • RetainCompletedJobs
  • RemoveJobs

To reformat the PDF jobs for a roll-to-roll PDF printer:

  1. Assign the A to Z for PDF value for Output format to your roll-to-fold printer.
  2. Assign the Z to A for PDF value for Output format to your roll-to-roll printer.
  3. Set the Output format value for the jobs in the workflow to A to Z for PDF.
  4. Between the CountPages and CreatePageRanges steps, add a Continue step based on the ContinueToNextStep step template.
  5. On the Continue step, set Step restart type to Reformat.
  6. Add a rule with one condition on the connector between the Continue and CreatePageRanges steps: Output format = A to Z for PDF. Name the rule If Roll to Fold.
  7. Add a disconnected step based on the ReversePDFPageOrder step under the If Roll to Fold connector. Connect the new step to the Continue and CreatePageRanges steps.
  8. Add a rule with one condition on the connector between the Continue and ReversePDFPageOrder steps: Output format = Z to A for PDF. Name the rule If Roll to Roll.
  9. On the PrintJobs step, set Requested printer to Not set.

    This setting keeps RICOH ProcessDirector from automatically sending the jobs to a specific printer.

  10. Save and enable the workflow.
  11. Run jobs through the workflow:
    1. Enable the workflow.
    2. Enable and connect the input device that sends jobs to the workflow.
    3. Submit a job formatted for a roll-to-fold printer to the workflow.

      The job should print on the roll-to-fold printer.

    4. Disable the roll-to-fold printer.
    5. Submit another job formatted for a roll-to-fold printer to the workflow.

      When the job reaches the PrintJobs step, it should stop.

    6. Select the job in the Jobs table and click Schedule.
    7. Select the roll-to-roll printer and click Make Jobs match printer.
    8. Click OK.

      The job should return to the Continue step, go through the If Roll to Roll branch, and print on the roll-to-roll printer.

1.2.4.12.19 Adding steps to process deleted jobs

You can add steps to your workflow that process deleted jobs before removing them from the system.

For example, you can add steps that record information about the jobs for audit purposes before they leave the system.

To add steps to process deleted jobs:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Add the steps that process the deleted jobs.

    If you want to process all jobs before you delete them, you can add the steps between the RetainCompletedJobs step and the RemoveJobs step.

      Important:
    • Make sure that you include a RemoveJobs step. Without that step, the jobs remain in the system.

  5. Set the Step restart type to Delete on the first step that processes the deleted jobs.

    For example, you add 3 steps, in this order, to process deleted jobs: WriteJobLog, CopyToFolder, and RemoveJobs. Set the Step restart type to Delete on the WriteJobLog step.

      Important:
    • Do not give more than one step in your workflow a Delete step restart type. If you do, RICOH ProcessDirector sends deleted jobs to the first step in the workflow with a restart type of Delete.

  6. Save and enable the workflow.
When an operator deletes a job, RICOH ProcessDirector sends it to the step with a restart type of Delete.

1.2.4.12.20 Adding steps to encrypt PDF files

You can add steps to your workflow that add password protection to PDF files and that restrict the actions that can be done to the PDF files.
For example, you might need to send a sample of a job to your customer. If the job contains sensitive data, you can add a step based on the EncryptPDF step template to encrypt the sample before you send it.

When you encrypt a PDF file, you can specify one or two passwords. The Owner password is the master password. It completely unlocks the file, so the recipient can read it, fill in form fields, and even edit the contents of the file. RICOH ProcessDirector steps need the level of access provided by the Owner password when they process jobs, because they often make changes to those PDF files.

The User password is a more limited password. It unlocks the file so that it can be read, but not edited in any way. This password is only needed if both of these statements are true:

  • The recipient must enter a password to open the file to read it.
  • The recipient must be prohibited from changing the document, such as by filling in forms or editing the contents.

If the file does not contain secure information, you can encrypt it so that it can be opened without a password, but require the Owner password for editing functions.

To add steps to encrypt PDF files:

  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Add the EncryptPDF step to process the PDF files.
    Most workflow steps cannot process encrypted PDF files. Choose where you place this step carefully to prevent a workflow error. For example, if you are delivering an encrypted PDF file as a final document, you should place the step as close to the end of the workflow as possible. If you are sending the encrypted PDF file as a preview to the customer, it can be placed earlier in the workflow. Make sure to save the encrypted PDF file to a location other than the spool directory.
  5. Enter the Owner password you want to set for the file and select the Password-protected actions level.
  6. If the Password-protected actions level is set to Edit, Fill, Read and you want the recipient to type a password to open the file, enter a User password. If the Password-protected actions level is set to Edit or Edit, Fill, a User password is not required.
  7. If the remaining steps in the workflow do not need to open the PDF file, you can use the default value for the Encrypted PDF file property. The job default, ${JobID.print.pdf}, replaces the spool file for the job. To keep the unencrypted version of the file in the spool directory for further processing, specify a different value for the Encrypted PDF file property, such as: ${getFileName(encrypted, pdf, write)}
  8. Save and enable the workflow.

1.2.4.12.21 Adding steps to decrypt PDF files

When RICOH ProcessDirector receives an encrypted PDF file, the file must be decrypted before it can be processed.
For example, you can add a step at the beginning of your workflow to process password-protected PDF files.

When you encrypt a PDF file, you can specify one or two passwords. The Owner password is the master password. It completely unlocks the file, so the recipient can read it, fill in form fields, and even edit the contents of the file. RICOH ProcessDirector steps need the level of access provided by the Owner password when they process jobs, because they often make changes to those PDF files.

The User password is a more limited password. It unlocks the file so that it can be read, but not edited in any way.

If the file does not contain secure information, you can encrypt it so that it can be opened without a password, but require the Owner password for editing functions.

To add steps to decrypt PDF files:

  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name. If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Add a step based on the DecryptPDF step template to process the encrypted PDF files.
    Make sure to add the step before the first step in the workflow that needs to open the PDF file to prevent any processing errors. Most workflow steps cannot process encrypted PDF files.
  5. Enter the Owner password that was used when the PDF file was encrypted.
    If the password changes with every job, you must provide a way for the operator to enter the password for each job. You can add a manual step to the workflow before the DecryptPDF step and give it a name like EnterOwnerPassword. During processing, the job stops at that step. The operator can open the job property notebook and enter the Owner password in the Enhance PDF tab. Then the operator can complete the manual step so the password is available when the DecryptPDF step runs.
  6. Verify the location of the output file. By default, the decrypted PDF file becomes the print file in the spool directory of the job.
  7. Save and enable the workflow.

1.2.4.12.22 Defining workflows to process XML

To process XML jobs, you define one or more workflows that manipulate the XML.

Before you define XML workflows:

  • Read the usage scenario for processing orders in an XML file. That scenario uses four workflows to process XML.
  • Evaluate the XML files that provide input to the process and decide how many workflows are required to process the XML. See the related topic about preparing to receive XML.

If your company uses a proxy server and your workflow has a DownloadFile step, set up RICOH ProcessDirector to use the proxy server.

To define workflows to process XML:
  1. On the Workflow page, add the first workflow.
  2. After the SetJobPropsFromTextFile step, add a step based on the DetectInputDataStream step template.
  3. If the workflow creates jobs from XML, add one or more steps based on the CreateJobsFromXML step template.

    Set these properties:

    • For the XML input file property:
      • Use the default value if the XML file is in the spool directory for the job.
      • Specify the directory path and file name if the XML file is at another location.
    • For the XPath expression to create jobs property, specify the XPath expression that you defined for the step.
    • For the Workflow for new jobs property, select the workflow that the CreateJobsFromXML step submits the new jobs to.
    • For the Create as child job property:
      • To create child jobs, select Yes.

        For example, create child jobs for items in an order.

      • To create independent jobs, select No.

        For example, do not create child jobs for independent orders.

    • For Stop when no matching elements:
      • Select Yes if every XML input file has one or more elements that match the XPath expression. You want the job to go into error when the step does not find any elements that match.

        For example, a CreateJobsFromXML step creates an XML job for each order in an XML input file. Every XML input file has one or more orders. You want the job to go into error when the step does not find any order elements.

      • Select No if some XML input files have no elements that match the XPath expression. You want the job to continue to the next step in the workflow when the step does not find any elements that match.

        For example, a CreateJobsFromXML step creates an XML job for each print item in an order. Orders can have print items, promotional items, or both. You want the job to continue to the next step in the workflow when the step does not find any matching elements for print items.

    • For the Name for new job property, specify the value to use for the Name property of the jobs that the step creates.

  4. If the workflow converts XML data to another format, add one or more steps based on the ApplyXSLTransform step template.
    As a guideline, add an ApplyXSLTransform step to the workflow that a CreateJobsFromXML step submits jobs to.

    The ApplyXSLTransform step can convert XML elements into RICOH ProcessDirector job or document properties that other steps in the workflow use.

  5. To use a URL to download files for processing, add a step based on the DownloadFile step template.
  6. Add the steps required for your process.

    For example, add the steps required to process PDF files.

  7. Save the workflow.
  8. To add the next workflow, repeat the steps for adding the first workflow.
  9. When you finish adding workflows, test them.

1.2.4.12.23 Defining an error path in a workflow

You can add a branch in your workflow so that if a job goes into error state, the job continues processing in another path in the workflow instead of staying in the Error state. You can define a branch out of any step in the workflow.
To define an error path in a workflow:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Find the step you want to create an error path for.
  5. Add the step that you want the error branch to take.
  6. Draw a connector from the step where the error could occur to the step that you want to execute when the error happens.
  7. Right-click the connector you just drew and select Properties.
  8. Add a rule for when the job goes into error:
    1. Type the Rule name to define the new rule.
      We recommend giving the rule a name that identifies the branch as an error path, such as If error. You see the name next to the connector on the workflow editor
    2. To specify the condition to test for the error state, set Property to Current job state, Comparison to is (=), and Value to Error.
        Note:
      • Error is the only value for the Current job state property that can be used in a rule.
    3. Make sure that the Order of execution value is set appropriately for the error path. If other conditions are met before the error path, the job might not take the path you intended.
  9. Add any other conditions that you want to use to evaluate when to take the error path.
  10. Click OK.
  11. Repeat this procedure to add more error paths. Multiple error paths can exist in one workflow.
  12. Save and enable the workflow.
  13. Enable the workflow and test it to make sure that the rules in the branch work in the way you expect. Submit jobs that are sent through all the paths. When a job takes the error path, it moves out of the Error state, so you must find another way to look for jobs instead of searching for the Error state.
      Note:
    • When the job goes into the Error state, files in the /tmp directory under the spool directory for the job are moved to an /error directory. When they are moved, the step name and phase name are prepended to the file names.

1.2.4.12.24 Calling a REST web service from a workflow

To call a REST web service, identify the parameters used to call the REST web service. Test the exchange of data between RICOH ProcessDirector and the application. Then add a step based on the CallRESTService step template to the workflow.
To call a REST web service from a workflow:
  1. Learn the requirements for communication with the REST web service for the application:
    • The values for authenticating with the application
    • The values for requesting data from the REST web service
    • The format of the data provided in the response

    Refer to the documentation for the application or consult with the company that hosts the application.

  2. To prepare RICOH ProcessDirector to communicate with the application, do these tasks:
    • If the application requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.
    • If your environment requires a proxy server to communicate with web services, set up the system to use it.

    For more information, see the related tasks.

  3. Run a manual test that authenticates with the application and requests a response from the REST web service. Verify that the web service returns the response that you want.
    Many browsers have plug-ins, such as Boomerang for Google Chrome, that test web service calls to REST clients.
  4. If the web service includes a payload, decide how you want to provide that information:
    • You can enter the payload as the value of the Request payload property.
    • You can store the payload in a text file that the CallRESTService step can access during job processing.
  5. Click the Workflow tab.
  6. Click the name of the workflow you want to modify.
  7. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  8. Review the steps that are included in the workflow and the default values that they set.
  9. Add a step based on the CallRESTService step template to the workflow in the appropriate place.
  10. Set values for the job properties.
    1. Set the Request URL property to the URL of the web service that the step calls.
      The URL can use either the HTTP or HTTPS protocol.
    2. Set the Request method property to the value required by the web service.
    3. Set the Password property to the password that the step provides to the REST web service to authenticate with the application.
      You enter the password as the value of this property. To provide the password to the REST web service, specify the Job.WebService.Password property as a symbol in the Request payload, Request header, or Request parameters property: ${Job.WebService.Password}. To determine which property to use, refer to the documentation of the web service.
    4. Set the Request payload type property:
      • To specify the body of the web services request as the value of the Request payload property, select TEXT.
      • To specify the body of the web services request in a text file that the CallRESTService step can access during job processing, select FILE.
        Note:
      • If you do not specify a payload, RICOH ProcessDirector ignores the value of this property.
    5. If the web service includes a payload, set the Request payload property:
      • If you set the Request payload type property to TEXT, enter the payload as the value of this property.
      • If you set the Request payload type property to FILE, enter the full directory path, name, and extension of the text file as the value of this property.

        Enter the payload as the content of the text file.

      To send the password in the payload, specify the Job.WebService.Password property as a symbol.

      In this XML example, order ID is stored as the value of the Custom 3 job property ( Job.Info.Attr3). The payload includes the password as the value of the <Token> element and order ID as the value of the <OrderID> element:

      <Token>${Job.WebService.Password}</Token><OrderID>${Job.Info.Attr3}</OrderID>

      The step resolves the symbols when it calls the REST web service.

    6. Set the values for the Request header and Request parameters properties, as required.

      Each header field or parameter is a keyword/value pair. Each pair must appear on a separate line and must be separated using a colon (:) or equals sign (=).

      The keyword and value can be multiple words. RICOH ProcessDirector uses the first colon or equals sign on each line to split the words into the keyword/value pair.

      This example contains two parameters: token and orderId. The value of each keyword is a RICOH ProcessDirector symbol. Each symbol contains one of these properties: Job.WebService.Password and Job.Info.Attr3.

      token:${Job.WebService.Password}orderId:${Job.Info.Attr3}

      The step resolves the symbols when it calls the REST web service.

    7. If your environment requires a proxy server to communicate with web services, set the Use proxy property to the correct proxy server.
    8. Set the Response file property to the full directory path and name of the file that RICOH ProcessDirector uses to store the response from the application.
      Typically this value is ${getFileName(print,json,write)} or ${getFileName(print,xml,write)}, depending on the type of response that the application returns.
      After the response is stored in the file, other steps in the workflow can process the response.
  11. When you finish, click OK.
  12. Save and enable the workflow.

When you finish setting up your workflows, test the exchange of data between RICOH ProcessDirector and the application.

Example

The Web Services Enablement feature includes a supplied RestfulWebServiceWF workflow with a CallRESTService step.

1.2.4.12.25 Calling a SOAP web service from a workflow

To call a SOAP web service, identify the parameters used to call the SOAP web service. Test the exchange of data between RICOH ProcessDirector and the application. Then add a step based on the CallSOAPService step template to the workflow.
To call a SOAP web service from a workflow:
  1. Learn the requirements for communication with the SOAP web service for the application:
    • The values for authenticating with the application
    • The values for requesting data from the SOAP web service
    • The format of the data provided in the response

    Refer to the documentation for the application or consult with the company that hosts the application.

  2. To prepare RICOH ProcessDirector to communicate with the application, do these tasks:
    • If the application requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.
    • If your environment requires a proxy server to communicate with web services, set up the system to use it.
    • Import WSDL files for all the web services that you plan to call.

      RICOH ProcessDirector creates SOAP request objects from SOAP operations in the WSDL file. You specify a prefix that RICOH ProcessDirector adds to the names of the SOAP operations when it creates the objects. A SOAP request object lets RICOH ProcessDirector determine the SOAP version and other information required to make a correct call to the web service.

    For more information, see the related tasks.

  3. Run a manual test that authenticates with the application and requests a response from the SOAP web service. Verify that the web service returns the response that you want.
    Many browsers have plug-ins, such as Boomerang for Google Chrome, that test web service calls to SOAP clients.
  4. Decide how you want to specify the request:
    • You can enter the payload as the value of the Request payload property.
    • You can store the payload in a text file that the CallSOAPService step can access during job processing.
  5. Click the Workflow tab.
  6. Click the name of the workflow you want to modify.
  7. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  8. Review the steps that are included in the workflow and the default values that they set.
  9. Add a step based on the CallSOAPService step template to the workflow in the appropriate place.
  10. Set values for the job properties.
    1. Set the Request URL property to the URL of the web service that the step calls.
      The URL can use either the HTTP or HTTPS protocol.
    2. Set the Password property to the password that the step provides to the SOAP web service to authenticate with the application.
      You enter the password as the value of this property. To provide the password to the SOAP web service, specify the Job.WebService.Password property as a symbol in the Request payload or Request URL property: ${Job.WebService.Password}. To determine which property to use, refer to the documentation of the web service.
    3. Set the Request payload type property:
      • To specify the body of the web services request as the value of the Request payload property, select TEXT.
      • To specify the body of the web services request in a text file that the CallSOAPService step can access during job processing, select FILE.
    4. Set the Request payload property:
      • If you set the Request payload type property to TEXT, enter the payload as the value of this property.
      • If you set the Request payload type property to FILE, enter the full directory path, name, and extension of the text file as the value of this property.

        Enter the payload in the text file.

      To send the password in the payload, specify the Job.WebService.Password property as a symbol.

      In this example, order ID is stored as the value of the Custom 3 job property ( Job.Info.Attr3). The payload includes the password as the value of the <Token> element and order ID as the value of the <OrderID> element:

      <Token>${Job.WebService.Password}</Token><OrderID>${Job.Info.Attr3}</OrderID>

      The step resolves the symbols when it calls the SOAP web service.

    5. If your environment requires a proxy server to communicate with web services, set the Use proxy property to the correct proxy server.
    6. Set the Response file property to the full directory path and name of the file that RICOH ProcessDirector uses to store the response from the application.
      Typically this value is ${getFileName(print,xml,write)}.
      After the response is stored in the file, other steps in the workflow can process the response.
    7. Set the SOAP request property to the SOAP request that RICOH ProcessDirector created when you imported the WSDL file.

      For example, you want to use the GetOrdersByDate SOAP request. You prepended PrintShop to the names of the SOAP requests when you imported them. Select PrintShop-GetOrdersByDate.

  11. When you finish, click OK.
  12. Save and enable the workflow.

When you finish setting up your workflows, test the exchange of data between RICOH ProcessDirector and the application.

Example

The MarcomCentral Connect feature includes two supplied workflows with CallSOAPService steps.

1.2.4.12.26 Defining a workflow that sends jobs to be transformed

To send print jobs to the RICOH ProcessDirector Transforms or the Advanced Transforms to be converted to a different data stream, you must define a workflow that includes one or more data stream conversion steps.

Before you begin, determine which data stream formats you want to use with RICOH ProcessDirector and what program you plan to use to convert the data streams. The RICOH ProcessDirector Transforms use different step templates than the Advanced Transforms. You can only use the RICOH ProcessDirector Transforms if the AFP Support feature is installed.

These workflows supplied with the AFP Support feature include steps that send jobs to the RICOH ProcessDirector Transforms:
Transform
Includes the TransformJobIntoAFP step.
OutputPDF
Includes the TransformJobIntoPDF step.

Both steps look at the values of the Input data stream and Transform output data stream properties to determine which transform to use.

Both workflows include a step based on the DetectInputDatastream step template, which they use to determine the value of the Input data stream property. To use this workflow to process specific file formats, you can set a default value for the Input data stream property on the TransformJobIntoAFP or TransformJobIntoPDF step when you add it to the workflow. If you set a value on the step, you can delete the DetectInputDataStream step from the workflow.

The Advanced Transform feature provides the OutputAFP workflow, which includes steps based on the TransformWithAdvancedFeature and DetectInputDatastream step templates.

The DetectInputDatastream step determines the value of the Input data stream property for the job. In the supplied workflow, the value of the Transform input stream property in the TransformWithAdvancedFeature step is set to Use current, which causes the transform to use the value of the Input data stream property as transform input stream. As a result, this workflow accepts any input data stream and converts it to the data stream indicated in the Transform output stream property. In this case, that value is AFP.

The TransformWithAdvancedFeature step template can be configured to accept various input data streams and create various output data streams, depending on the advanced transforms that you have installed. If you want to convert job to a different data stream, when you can copy the workflow, rename it, and change the value of the Transform output stream property. For example, if you want to accept any input data stream and convert it to PostScript, you could rename the workflow OutputPS and change the value of the Transform output stream property to PS.

To define a workflow that sends jobs to be transformed:

  1. Click the Workflow tab.
  2. Right-click one of Transform, OutputPDF, or OutputAFP workflows, and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Review the steps that are included in the workflow and the default values that they set.
  5. Add any other steps that you want to include in this workflow.
  6. Save the workflow.

1.2.4.12.27 Defining workflows or printers that use a color mapping table

You can specify the color mapping table used to print jobs at the job level or at the printer level.
  • To specify the color mapping table for an individual job, set the Color mapping table job property to the file name of the color mapping table.
  • To specify the color mapping table that a printer uses for jobs that do not have a value for the Color mapping table job property, set the Color mapping table printer property to the file name of the color mapping table.

1.2.4.12.28 Defining a workflow to print AFP data to a PCL printer

You can define a workflow that accepts a print job in AFP format and sends it to a PCLOut printer. You cannot send PCL data to a PCLOut printer; you must send PCL print jobs to Passthrough printers.
To define a workflow to print AFP data to a PCLOut printer:
  1. Click the Workflow tab.
  2. Right-click the AFP workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. In the workflow editor, right-click the PrintJobs step and select Properties.
  5. In the Scheduling tab, change the values of the Binding, Fold options, Job class, Job form, Job destination, Requested location, Media, Output bin, Punch, and Staple properties to match the scheduling properties of the PCLOut printer that you want to print on. Other scheduling properties may be defined in a configuration file.
  6. Select the name of the PCLOut printer from the Requested printer list.
  7. Click OK.
  8. Save and enable the workflow.

1.2.4.12.28.1 Processing concerns when using PCLOut printers

There are specific limitations to the support available when sending AFP jobs to PCLOut printers.

PCLOut printers only support sending these data streams to the printer:

  • PCL4
  • PCL5
  • PCL5c

Note: PCL4 does not support printing graphics. If you need to print graphics, you must configure the PCLOut printer to output PCL5 or PCL5c.

PCLOut printers convert jobs on a job-by-job basis. They do not create and save AFP resources (such as fonts, overlays, or page segments) from previous jobs. In addition, if the print jobs include the page overlays or page segments, they are rendered after all the other objects are processed. This might cause issues when the order of the overlapping objects is critical.

PCLOut printers do not support:

  • Using any printer-resident resources
  • Reusing printer resources (including fonts) from one job to the next
  • Selecting output bins
  • Using custom media sizes
  • Using BCOCA BCD2 subset
  • Using GOCA Mapping Control Options, except for the Position and Trim options
  • Using default color mixing rules for foreground and background
  • Generating PCL6
  • Using full IS/3
  • Duplex printing specified anywhere other than on the Duplex property of a PCLOut printer object
  • Printing color IOCA images
  • Using RICOH ProcessDirector symbols such as ${Job.Name} in the PCLOut printer command

How PCLOut printers use fonts

You must install one of these supported font types on your system so they can be used by the PCLOut printer:

  • 300 pel AFP fonts
  • Relative-Metric AFP fonts
  • AFP Outline fonts
  • True Type/Open Type fonts

Because the PCL Secondary transfers data to the PCL printer character-by-character during job processing, you cannot examine the PCL data the same way you might examine standard text or PCL data. As a result, you cannot scan the output data for certain text strings.

PCLOut printer objects cannot:

  • Communicate with the printer to see if the job completes printing
  • Query fonts in the printer after the job has been sent to the printer

Barcodes supported
PCLOut printers only support these barcode types:
  • X'01' - 3-of-9 code X'01' and X'02'
  • X'02' - MSI X'01' through X'09'
  • X'03' - UPC/CGPC, Version A X'00'
  • X'05' - UPC/CGPC, Version E X'00'
  • X'06' - UPC–Two-digit Supplemental X'00', X'01', and X'02'
  • X'07' - UPC–Five-digit Supplemental X'00', X'01', and X'02'
  • X'08' - EAN 8 (includes JAN short) X'00'
  • X'09' - EAN 13 (includes JAN standard) X'00'
  • X'0A' - Industrial 2-of-5 X'01' and X'02'
  • X'0B' - Matrix 2-of-5 X'01' and X'02'
  • X'0C' - Interleaved 2-of-5 X'01' and X'02'
  • X'0D' - Codabar: modifier X'01' and X'02'
  • X'11' - Code 128: modifier X'02', X'03’, and X’04’
  • X'16' - EAN Two-digit Supplemental X'00' and X'01'
  • X'17' - EAN Five-digit Supplemental X'00' and X'01'
  • X'18' - POSTNET: modifier X'00' through X'04'
  • X’1A’ - Royal Mail Postal
  • X'1B’ - Japan Postal
  • X’1C’ - DataMatrix
  • X’1D’ - MaxiCode
  • X’1E’ - PDF417
  • X’1F’ - Australia Post Bar Code, modifier X'00' through X'08'
  • X’20’ - QR Code
  • X’21’ - Code 93
  • X'22' - USPS Four-State (Intelligent Mail): modifier X'00' through X'03'
  • X'23' - Royal Mail RED TAG: modifier X'00'
  • X'24' - GS1 DataBar
  • X'25' - Royal Mail Mailmark

1.2.4.12.29 Workflow to print jobs created in the Documents table

To print jobs that you create from documents in the Documents table, define a workflow that contains steps to create a job from the document, print the job, and do any other processing steps required. You select the workflow in the Workflow field on the Create a Job page when you use the Create Job action.
    Note:
  • Documents from different jobs cannot be combined to create a single new job. If you choose documents from three different jobs and use the Create Job action, three new jobs are created.

Workflows that process jobs created in the documents table must contain certain step templates. Some of those step templates are included with the base product and others are installed with document processing features. Instead of defining a new workflow, you can use one of the supplied workflows that are installed by the document processing features, such as PrintInsert_1, PrintDocuments, and SortPDF. Compare the steps included in those workflows to the required steps below. Add and change steps as needed to make sure that the workflow contains the required steps and the steps needed to process your jobs.

The steps that must be included in a workflow that processes jobs created from documents in the documents table are:

  • SetJobPropsFromTextFile

    Sets job properties using a text file that accompanies the input file. The value of the Input datastream property must be set correctly on this step, so that it matches the data stream of the documents in the job.

    In the Job name property, type text such as Reprint Job or ${Job.ID} to set the job name equal to the job number. Do not type ${Job.InputFile} to set the job name equal to the name of the input file, because no input file exists for jobs created from the documents table.

  • BuildAFPFromDocuments (Required only for AFP jobs processed by RICOH ProcessDirector.)

    Builds a job from documents. If you use the Enhance AFP function to create a control file, this step uses that control file to modify the documents.

  • BuildPDFFromDocuments (Required only for PDF jobs.)

    Builds a job from documents. If you use RICOH ProcessDirector Plug-in for Adobe Acrobat to create a control file, this step uses that control file to modify the documents.

  • EnableRepositioning (Required only for AFP jobs processed by RICOH ProcessDirector.)

    Maps logical pages to physical sheets.

  • CreatePageRanges

    Prepares the job so that parts of it can be reprinted instead of reprinting the entire job.

  • PrintJobs

    Sends the job to the printer.

  • RemoveJobs

    Removes the job from the system.

You can add other steps to the workflow as needed, including steps provided by the document processing features, such as:

  • CreateReprints
  • InsertJobs
  • ReadBarcodeData
  • Reconcile
  • SortDocuments
.

1.2.4.12.30 Adding a step to convert XML elements into document properties

You can add a step based on the ApplyXSLTransform step template to a workflow to convert XML elements and their attributes into RICOH ProcessDirector document properties.
The PDF Document Support feature or AFP Support feature is required to work with document properties.
To add a step to convert XML elements into document properties:
  1. Evaluate the XML files that provide input to the process. Make sure that you understand what information the files contain and how the information is organized.
    If possible, ask the XML provider for the XML Schema Definition (XSD).
  2. To extract values for RICOH ProcessDirector document properties, identify the XML elements and attributes that supply values for the properties.
  3. Use an XSLT tool (such as Altova MapForce) to create an XSLT style sheet.
    You can convert XML elements into document properties in a property conditions file or in other files.
  4. Click the Workflow tab.
  5. Right-click a workflow that you want to use as a model and select Copy.
  6. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  7. Review the steps that are included in the workflow and the default values that they set.
  8. Determine where in the workflow you want to convert the XML elements into document properties.
    If you want to convert XML elements into document properties in a property conditions file, place the ApplyXSLTransform step before the SetDocPropsFromConditions step that uses the file.
  9. Add the ApplyXSLTransform step to the workflow in the appropriate place and set values for the step properties:
    • For the XML input file property, specify the directory path and name of the XML file.
    • For the XSLT file property, specify the XSLT style sheet that you defined for the step.
    • For the Output file property, specify the directory path and name of the file that you want RICOH ProcessDirector to create.

      For example, you want RICOH ProcessDirector to create a DocPropConditions.csv file in the spool directory for the job. Specify ${getFileName(DocPropConditions,csv,write)}. For the Property conditions file property of the SetDocPropsFromConditions step, specify ${getFileName(DocPropConditions,csv,read)}.

  10. Save and enable the workflow.

1.2.4.12.31 Grouping child jobs

Hot folder input devices can generate child jobs if they are configured to use a batching method. LPD input devices can receive multiple input files on a print command. However, LPD input devices with a Linux parent server cannot create parent jobs with multiple children. As a result, one parent job and one child job are created for each input file. If the AFP Support feature is installed, Download input devices can create child jobs from multi-dataset jobs received from Download for z/OS and AFP Download Plus, or the input devices can merge the jobs into a single job.
Child jobs created by any of these methods are independent of one another and they do not process in any particular order. To treat these jobs as a group of dependent jobs, you can configure a workflow and an input device that keep child jobs together as they progress through the workflow.

RICOH ProcessDirector provides the WaitForGroup step template to support this function.

To group child jobs:

  1. Click the Workflow tab.
  2. Create or update a workflow to use as the child workflow.
  3. If there are any processing steps where all the jobs in the group must be present, such as when the group of jobs requires manual processing, include a step that is based on the WaitForGroup step template. Put this step immediately before the step that requires all the jobs in the group.
    For example, put this step immediately before the PrintJobs step. RICOH ProcessDirector does not move the jobs to the next step until all the jobs in the group have completed the previous step. You can include as many WaitForGroup steps as required.
  4. Save and enable the workflow.
  5. Click the Main tab.
  6. In the Input Devices portlet, click the name of the input device that you want to use for this task.
  7. In the left pane, click Show all tabs to fully expand the notebook.
  8. Set the Workflow property to ParentNoPrint.
  9. Set the Child workflow property to the workflow that includes the step that is based on the WaitForGroup step template.
  10. Set the Submit step property to SubmitInputFiles.
  11. If the input device is a Hot folder device, set the Batching method property to a value other than None, and set values for other properties as required.
  12. Verify that the values of the pattern properties in the Advanced area meet the requirements of the jobs.
  13. Click OK.
    Note: If the input device is enabled and connected, you see a message that asks if you want to disable and disconnect the device.
  14. Select the input device and click Enable, then select it again and click Connect.
When the SubmitInputFiles step creates the child jobs, it assigns a process group ID and a number that represents the position of the job within the group. To see all jobs that belong to a specific process group, select one of the child jobs and click Actions Groups Show Group. RICOH ProcessDirector updates the jobs table to show all the jobs that are members of the same group as the selected job. This action is only available in the legacy user interface.

When you select an action to do on one or more jobs in a group, RICOH ProcessDirector prompts you to include the other files in the group as well.

You can also remove jobs from a group through Actions Groups Remove from Group and add jobs to a group with Actions Groups Add to Group. This action is only available in the legacy user interface.

1.2.4.12.32 Configuring steps to identify documents in AFP files

After you have linked document or job properties to index tags in a sample AFP file, you must configure the step that determines values for document or job properties in production AFP files. The step names the Visual Workbench control file that contains information about how properties are linked to index tags.

Steps that calculate values for properties are based on the IdentifyDocuments step template. Some RICOH ProcessDirector features provide workflows containing an IdentifyDocuments step. If you use any of those supplied workflows, you can configure the IdentifyDocuments step in the workflow to specify the name of the Visual Workbench control file. These are examples of workflows supplied with RICOH ProcessDirector features:

  • ReceiveInsert_I (provided with the Inserter feature)
  • SortAFP
  • SortSplitAFP
  • VerifySample (provided with the Automated Verification feature)

If you add an IdentifyDocuments step to another workflow, keep these tips in mind:

  • The same control file is used for the IndexAFP step, the EditAFP step, and the IdentifyDocuments step.
  • The IdentifyDocuments step must be after the IndexAFP step, if it is present, and all steps that update the AFP file.

To configure a step that identifies documents in AFP files:

  1. Click the Workflow tab.
  2. Copy a workflow that contains the IdentifyDocuments step.
  3. Right-click the IdentifyDocuments step and select Properties.
  4. If necessary, change the properties for the step in the right side of the window.
  5. If you previously linked properties to index tags, this step is required. Otherwise, it is optional. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains information about how properties are linked to index tags, or use symbol notation to refer to it. RICOH Visual Workbench created this control file when you linked properties to index tags. The default extension for control files is .ctl. If you do not specify a control file, IdentifyDocuments uses any page group information that is already in the AFP file to identify documents, and no index tags in the AFP file are mapped to document properties.
  6. If the input AFP file does not already contain index tags and you use the AFP Indexer mode of RICOH Visual Workbench, add the IndexAFP step before the IdentifyDocuments step.
  7. Click OK.
  8. Save and enable the workflow.

1.2.4.12.33 Adding steps to index AFP files

After you create page groups and index tags in a sample AFP file using RICOH Visual Workbench, you must add a step to one or more workflows to create page groups and index tags in production AFP files that use the workflows. The step names the Visual Workbench control file that contains definitions for the page groups and index tags.

You can base the step on the IndexAFP step template. If AFP Editor is installed, you can base the step on the EditAFP step template. If Whitespace Manager is installed, you can base the step on the FillWhiteSpace step template.

If you base the step on the IndexAFP step template, place the step before the EnableRepositioning step so that you can use the Print again action to reprint a page group.

If you base the step on the EditAFP or FillWhiteSpace step template, position the step relative to these steps if they are present:

  • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step)
  • After a step that converts Xerox data to AFP format
  • Before the EnableRepositioning step
  • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step)
  • Before the PrintJobs step
    Note:
  • You can use the IndexAFP step template to enhance the AFP files that the RICOH ProcessDirectorTransform Features create.

To add a step to index AFP files:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
    If you prefer to modify a copy of the workflow, right click it and choose Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name. If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Select one of these step templates:
    • IndexAFP: This step template creates page groups and index tags in AFP files.
    • EditAFP: This step template can create page groups and index tags before it creates barcodes, text, and hidden areas in AFP files.
    • FillWhiteSpace: This step template can create page groups, index tags, barcodes, text, and hidden areas before it fills defined white space with content in production AFP files.
      Note:
    1. The same Visual Workbench control file must contain the definitions for page groups, index tags, barcodes, hidden areas, and white space.
    2. The EditAFP step template is available only if AFP Editor is installed.
    3. The FillWhiteSpace step template is available only if Whitespace Manager is installed.
    4. Select the EditAFP step template only if the IndexAFP step and the EditAFP step can be done consecutively in the same phase. Otherwise, add the steps separately.
  6. Drag one of the steps into the workflow editor.
  7. Connect the step to other steps.
  8. Right-click the step and select Properties.
  9. If necessary, change the General properties.
  10. Click AFP.
  11. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains the definitions to create the page groups and index tags.
      Note:
    • This control file is not the same as an index object file that the ConvertLineDataJobIntoAFP step might create.
    • If you want to use the same workflow for input files that require different control files, you can use symbolic notation for the name of the control file. For example, if you have two input files, abc.afp and xyz, with corresponding control files, abc.afp.ctl and xyz.ctl, and you want to use the same workflow for both files, you can use ${Job.InputFile}.ctl as the control file in the Visual Workbench control file field. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the Visual Workbench control file to the name of the input file plus the .ctl extension.
  12. If you selected the EditAFP step template, select Yes in the Index first field.
  13. Click OK.
  14. Save and enable the workflow.

1.2.4.12.34 Adding steps to edit AFP files

After you create barcodes, text, or hidden areas in a sample AFP file using RICOH Visual Workbench, you must add a step to one or more workflows to create barcodes, text, or hidden areas in production AFP files that use the workflows. The step names the Visual Workbench control file that contains the definitions for the barcodes, text, or hidden areas.
You can base the step on the EditAFP step template. When you configure the step, you can choose to first create any page groups and index tags that are defined in the same control file. The barcodes, text, and hidden areas can depend on the page groups or index tags defined in the control file being created first.

Position the step relative to these steps if they are present:

  • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step)
  • After a step that converts Xerox data to AFP format
  • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step)
  • Before the EnableRepositioning step if you configure the EditAFP step to create page groups and index tags
  • Before the PrintJobs step
  • After a step based on the IndexAFP step template (unless using Index first)
  • After a step that changes the property values in the barcode
    Note:
  • If you created fixed-length page groups with the IndexAFP step template, you can use the EditAFP step template to enhance AFP files that the RICOH ProcessDirectorTransform Features create.

To add a step to edit AFP files:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
    If you prefer to modify a copy of the workflow, right click it and choose Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name. If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Select the EditAFP step template and drag it into the workflow editor. Place the step where you want it.
  6. Connect the EditAFP step to other steps.
  7. Right-click the step and select Properties.
  8. If necessary, change the General properties.
  9. Click AFP.
  10. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains the definitions to create the page groups, index tags, barcodes, text, and hidden areas.
      Note:
    • If you want to use the same workflow for input files that require different control files, you can use symbolic notation for the name of the control file. For example, if you have two input files, abc.afp and xyz, with corresponding control files, abc.afp.ctl and xyz.ctl, and you want to use the same workflow for both files, you can use ${Job.InputFile}.ctl as the control file in the Visual Workbench control file field. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the Visual Workbench control file to the name of the input file plus the .ctl extension.
  11. If the control file contains definitions to create page groups and index tags, you might want to select Yes in the Index first field.
      Note:
    • Do not select Index first if the IndexAFP step and the EditAFP step run in different phases. For example, if a barcode contains the document sequence and another step in the workflow sorts the documents in a different order, you might put the IndexAFP step in the Prepare phase and then put the EditAFP step after the build step in the Assemble phase.
  12. If you select Yes in the Index first field, remove any step from the workflow that is based on the IndexAFP step template because the Index first option and the IndexAFP step provide the same function. (It is more efficient to select Yes in the Index first field than to run an IndexAFP step.)
  13. Click OK.
  14. Save and enable the workflow.

1.2.4.12.35 Adding steps to fill white space in AFP files

After you define white space in a sample AFP file using RICOH Visual Workbench, you must add a step to one or more workflows to fill the white space with content in production AFP files that use the workflows. The step names the Visual Workbench control file that contains the definitions for the white space.
You can base the step on the FillWhiteSpace step template. When you configure the step and AFP Indexer, AFP Editor, or both are installed, you can choose to first create any page groups, index tags, barcodes, hidden areas, and text that are defined in the same control file before filling the white space areas. The white space areas are often dependent on the page groups, index tags, and other items being created first.

Position the step relative to these steps if they are present:

  • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step).
  • After a step that converts Xerox data to AFP format.
  • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step).
  • Before the EnableRepositioning step if you configure the FillWhiteSpace step to create page groups and index tags, text, or both.
  • Before the PrintJobs step.
  • After a step based on the IndexAFP or EditAFP step template (unless using Index first or Edit first).
    Note:
  • If you created fixed-length page groups with the IndexAFP step template, you can use the FillWhiteSpace step template to fill white space with content in AFP files that the RICOH ProcessDirectorTransform Features create.

To add a step to fill white space with content in AFP files:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
    If you prefer to modify a copy of the workflow, right click it and choose Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name. If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Select the FillWhiteSpace step template and drag it into the workflow editor. Place the step where you want it.
  6. Connect the FillWhiteSpace step to other steps.
  7. Right-click the step and select Properties.
  8. If necessary, change the General properties.
  9. Click AFP.
  10. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains the white space definitions.
      Note:
    • If you want to use the workflow for input files that require different control files, you can use symbolic notation for the name of the control file. For example, if you have two input files, abc.afp and xyz, with corresponding control files, abc.afp.ctl and xyz.ctl, and you want to use the same workflow for both files, you can use ${Job.InputFile}.ctl as the control file in the Visual Workbench control file field. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the Visual Workbench control file to the name of the input file plus the .ctl extension.
  11. If the control file contains definitions to create page groups and index tags, you might want to select Yes in the Index first field.
      Note:
    • Do not select Index first if the IndexAFP step and the FillWhiteSpace step run in different phases. For example, you might need to put the IndexAFP step in the Prepare phase and the FillWhiteSpace step in the Assemble phase after the EditAFP step (or select Edit first).
    • If you select Yes in the Index first field, remove any step from the workflow that is based on the IndexAFP step template because the Index first option and the IndexAFP step provide the same function. (It is more efficient to select Yes in the Index first field than to run an IndexAFP step.)
  12. If the control file contains definitions to create barcodes, hidden areas, or text, you might want to select Yes in the Edit first field.
      Note:
    • The Edit first field applies only if AFP Editor is installed. If you select Yes and the AFP Editor is not installed, RICOH ProcessDirector does not edit the job.
    • If you select Yes in the Edit first field, remove any step from the workflow that is based on the EditAFP step template because the Edit first option and the EditAFP step provide the same function. (It is more efficient to select Yes in the Edit first field than to run an EditAFP step.)
  13. Click OK.
  14. Save and enable the workflow.

1.2.4.13 Copying objects from another system

To reuse objects from another RICOH ProcessDirector system, you can use the other system to export them. On this RICOH ProcessDirector system, you can import the objects rather than recreating them manually.
You can export and import objects such as input devices, workflows, printers, media objects, notifications, servers, step templates, user names, groups, and locations. You can also export and import some objects added by features or extensions.
    Important:
  • We recommend using the Migration Assistant when upgrading to a different computer to copy objects from one system to another. For additional information see Using the Migration Assistant.
  • Do not import objects added by a feature or extension that is not installed on this system.
  • Before you import an object that has the same name as an existing object of the same type, make sure that the existing object is disabled. If the object is an input device, also make sure that it is disconnected. When you import the new object, the existing object is updated to match the new one.
  • Before you import an input device or printer whose Parent server property has any value other than System, make sure that the parent server has been added as a secondary server. Make sure that the secondary server has been enabled and connected to the primary server.
  • If you are using the Preprinted Forms Replacement feature, export the media.zip file before you import media objects with electronic forms. Follow the instructions in the help system for exporting media objects with electronic forms.
  • When you import step resources, the files that they refer to are not included in the export package. Copy the files referenced in the step resources from the export system to the import system manually. You must copy the files to the import system before you import the step resource objects.
    • To import all the step resources, copy the contents of /aiw/aiw1/StepResources from the export system into the same directory on the import system.
    • To import specific step resources, open the XML file that you exported. Find the entry for each step resource that you exported and locate the StepResource.File property. In that value, find the name of the RSC file associated with that step resource. For example, in this value:
      • <property name="StepResource.File" value="{&quot;fileName&quot; : &quot;/aiw/aiw1/StepResources/ 1992052c6ef44a229b8b43d77232bf53.rsc1992052c6ef44a229b8b43d77232bf53.rsc&quot; , &quot,&quot;displayName&quot; : &quot;Ricoh_Export-2019-08-26_13-30-04.xml&quot;}"/>

      The file name is: 1992052c6ef44a229b8b43d77232bf53.rsc

      Find the file on the export system and copy it into the same directory on the import system.

  • You can export objects from a primary server running on one operating system and import them on a primary server running on a different operating system.

    If you export objects from Windows and import them on Linux, you need to manually update the paths for the paths or the configuration files.

To copy objects from another system:

  1. Click the Administration tab.
  2. In the left pane, click Utilities Import Objects.
  3. In the File to import field, click to select the XML file that contains the properties of exported objects.
    The default name of this file is Ricoh_Export_timestamp.xml. The administrator who exported the objects might have given the file a different name.
      Note:
    • If you exported media objects with electronic forms, the name of the file is media.xml. It is in this directory:
      • /aiw/aiw1
    The file is automatically examined, and the objects are evaluated. If there are issues with any objects in the file, you see a dialog that lists the import errors and warnings. Close the dialog and all the objects appear in the Objects to import table. Objects with errors or warnings are marked with an icon.

    Repeat this step for all the files you want to import. Objects from additional files are added to the table, so they can all be added at the same time.

  4. Review the objects in the list. Select any object marked with a warning or error symbol and click Details to see additional information about the warning or error. Follow the instructions in the description to resolve problems. You cannot import objects that are marked as errors.
  5. Select the objects that you want to import.
  6. Optional: To make sure that you do not update objects that exist, click Deselect existing objects.
  7. Click Import.
    If the Import button is disabled, one or more selected objects are marked with the error icon. Click Deselect error objects to clear the selection for those objects and click Import again. The objects without errors are imported.

    Return to the error objects to resolve the issues and try to import them again.

    Note:
  • Credential objects might be contained in the file you import if they were included as references in workflows, step templates, input devices, or transmitter objects. The imported credential objects cannot be used until you re-enter values for the User name and Password properties on the imported system.
  • If an imported workflow refers to a step that does not exist on this system, RICOH ProcessDirector replaces the step with a placeholder step named ReplacedStep. The original step name and step template name are available in the Step properties. The ReplacedStep acts like the ContinueToNextStep step template, so it simply passes the job to the next processing step without changing it.
  • Contact your local Ricoh support representative if you receive an error message for step templates not containing a reference to an extension when importing objects.

1.2.4.14 Creating and activating custom properties

If none of the existing job or document properties meet your specific needs, you can define custom properties that are tailored to your specifications. After these properties are activated, you can use them just as you would any other job or document property.
Important: We recommend to not recreate any document properties that have been defined in the docCustomDefinitions.xml file.
To create and activate a custom property:
  1. Click the Administration tab.
  2. In the left pane, click Objects Custom properties.
  3. Click Add.
  4. Select either Document Property or Job Property.
  5. Configure the custom property by setting all the values.
    To find more information about the custom properties values, click the ? button next to a field.
      Important:
    • The third section of the database name must be different for each custom property. For example, you cannot use both Doc.Custom.Test and Job.Custom.Test. You must change one of the database names to use something unique, such as Doc.Custom.Test1.
  6. To activate the custom property, click the switch at the top of the dialog.
      Note:
    • All custom properties must be activated before they can be used in steps, workflows, input devices, jobs, and so on.
  7. To save the changes and close the dialog, click OK.
    Important: When activating or deactivating a custom property, we recommend doing these actions:
    • Log out of RICOH ProcessDirector.
    • Refresh the browser window and clear your browser cache.
    • Log in to RICOH ProcessDirector.
  8. Test the property using different scenarios in a testing environment.
    We recommend trying the new property in a small number of places that represent your intended usage, to ensure that the property functions as you intend it to.
    While you can deactivate a custom property to change its configuration, that process affects existing uses of the property. When a custom property is deactivated, all connections to any objects where the custom property was added are lost. The custom property is removed from any objects it was previously connected to. Any commands or processes based on the custom property might not function properly. For example, connector rules that use the property fail to evaluate correctly.
    After you make your changes, you reactivate the custom property. You need to add the custom property to the objects it was removed from.
Note: When the custom property is reactivated:
  • The property is not added back to jobs that it was removed from.
  • Processes and commands that include the property should start to function correctly again.

1.2.4.15 Applying custom values

You can easily apply values that your Ricoh support representative provides for customizing the system, such as custom halftone names and printer models.

To apply custom values:

  1. Click the Administration tab.
  2. In the left pane, click System Update.
  3. Click Browse and select the XML file that contains the custom values.
  4. Select the items that you want to update.
  5. Click Update.

1.2.4.16 AFP resources in RICOH ProcessDirector

Whenever you view or print an Advanced Function Presentation (AFP) file or convert a line data job to AFP, RICOH ProcessDirector most likely encounters references to AFP resources such as overlays, page segments, and fonts. If those resources are sent inline with the job, RICOH ProcessDirector uses the inline resources. If they are not inline, RICOH ProcessDirector must know where to find them on your system to be able to display, print, or convert the job correctly.

Two kinds of resource libraries exist: those that use a resource access table (RAT) and those that do not use a RAT. A resource access table is an index of a resource library. The index is stored as a file in the library that it refers to. Color Management Resources (CMRs) and data objects must be stored in resource libraries that use a RAT. Other resources, such as form definitions, page definitions, and overlays, can be stored in resource libraries that do not use a RAT.

You can configure RICOH ProcessDirector to use resources that are stored on any system in your network, as long as RICOH ProcessDirector can access the system that they reside on. However, it is recommended that you move all your resources to the default resource directory on your RICOH ProcessDirector primary computer. By storing them in that directory, all the RICOH ProcessDirector components, including any application/secondary servers that you install on different computers, can find them with no additional configuration.

The default resource directory is /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows). RICOH ProcessDirector does not make any changes to that directory during updates, so you do not have to reload the resources when you install an update.

The easiest way to move your file to the default directory is to use FTP. Create any subdirectories that you want to use under /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows) and use an FTP client to move the resources into them. Make sure that you transfer the files as binary data, not as text. If you prefer not to move the resources to the default directory, you can create a different directory on the system and FTP the resources to that location instead.

    Note:
  • RICOH ProcessDirector also searches for resources in /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows), but it is not recommended that you store your resources there because they could be overwritten if we provide a resource file with the same name as your resource file.

If you cannot move your resources onto the primary computer, leave them where they are:

  • On Linux, NFS-mount a directory on your primary computer to that computer. To do this option, install NFS server and client software, which is available from a variety of vendors.
  • On Windows, map a folder on the computer with the resources as a network drive on the primary computer. To use this option, configure RICOH ProcessDirector to map the network drive whenever RICOH ProcessDirector starts. For information about mapping network drives on a Windows computer, see the RICOH ProcessDirector information center.
The main drawback to leaving your resources where they are is the system generates a significant amount of network traffic as it retrieves the resources. The increase in traffic and time needed to retrieve the resources could reduce printer performance.

If you are migrating from InfoPrint Manager on Windows to RICOH ProcessDirector on Linux, be aware that Linux is case-sensitive. As a result, RICOH ProcessDirector looks for resource names in the case that is specified in the job. Windows is not case-sensitive; therefore, jobs that printed with InfoPrint Manager might have referred to resources in a different case than the actual resource names found on Windows. If you copy resources from your Windows system to Linux, make sure that the resource names match the case specified in your jobs.

If the print or conversion step is configured to run on a secondary computer rather than the primary computer, the directory that contains the resources must be available to that secondary computer. The default is that RICOH ProcessDirector mounts the /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows) directory from the primary to the secondary computer. If you are using other directories to store resources, you may need to NFS-mount your secondary computer directly to those directories as well.

If you use a step based on the TransformJobIntoPDF step template and want to specify a form definition for the RICOH AFP to PDF transform to use, be aware that the RICOH ProcessDirector Transforms and InfoPrint Transform Manager look for AFP resources only in a directory named reslib under the path that they are installed in. They do not use the AFP resource path that you specify for the other RICOH ProcessDirector steps. If a form definition with the name you specify in RICOH ProcessDirector exists in the reslib directory but is not identical to the one that RICOH ProcessDirector can access in its AFP resource path, you might see different results when you view the file in RICOH ProcessDirector than when you print the output of the RICOH AFP to PDF transform.

After you have decided where your resources are to be stored and have either moved them or mounted the appropriate directories, you must identify the resource locations to RICOH ProcessDirector.

1.2.4.16.1 Identifying AFP resource directories to RICOH ProcessDirector

If any of your AFP resources (such as fonts, form definitions, page segments, and overlays) are neither sent inline with the job nor in the default resource directory, you must configure your workflows so that RICOH ProcessDirector knows where to find those resources during processing. In addition, you might want to add those directories to existing step templates and printers.
You can identify locations of your AFP resources to RICOH ProcessDirector using the AFP resource path property of a job or a printer. The AFP resource path property is set to the directory path that identifies the location of your AFP resources. If you have more than one directory path to list, type a colon (:) between them.
    Note:
  • On a Windows machine, if you store data or resources on a mapped network drive, contact Software support for help configuring your system to find and use them. For information about mapping network drives on a Windows computer, see the RICOH ProcessDirector Information Center.

When one of the components needs a resource, RICOH ProcessDirector searches for it in these locations, in order:

  1. Inline in the job.
  2. In the paths listed in the AFP resource path property of the job. This property can be set in the workflow or as a default job property on a step template. RICOH ProcessDirector looks at the directories in the order that you list them in the property value.
  3. If the print step requests the resource, in the paths listed in the AFP resource path property of the printer. RICOH ProcessDirector looks at the directories in the order that you list them in the property value.
  4. In the /aiw/aiw1/resources or /usr/lpp/psf/reslib

To identify AFP resource directories to RICOH ProcessDirector:

  1. Edit your existing workflows so that RICOH ProcessDirector can find the AFP resources that your jobs require:
    1. Click the Workflow tab.
    2. Click the name of the workflow that you want to edit.
    3. Disable the workflow by clicking the switch to the left of the workflow name.
      If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
    4. In the workflow editor, click Step Templates in the top right corner of the window, and drag one of these steps into the editor:
      • ConvertLineDataJobIntoAFP
      • EnableRepositioning
      • PrintJobs
      AFP resource path is one of the default job properties on all these steps.
    5. Right-click the step, and select Properties.
    6. Click AFP.
    7. Find the AFP resource path property and type the path to the directory (or directories) where you copied your AFP resources.
        Note:
      • Changing this property in one of the steps that specify it changes it in all the steps for this workflow.
    8. Click OK.
    9. Save the workflow.
    10. Repeat this step for all the workflows that process AFP jobs and for any of the supplied workflows that you might copy to create new workflows in the future.
  2. Optional: Set the AFP resource path property on any existing step templates that you might use in the future to create new workflows.
    The only supplied step templates that have AFP resource path as a default job property are ConvertLineDataJobIntoAFP, EnableRepositioning, and PrintJobs. Do these steps on each of those step templates and any copies of them that you have created:
    1. In the Workflow tab, click Step Templates in the top right corner of the window.
    2. Right-click the step template that you want to edit and select Properties.
    3. Click AFP.
    4. Find the AFP resource path property and type the path to the directory (or directories) that you copied your AFP resources into.
    5. Click OK.
    6. Repeat this step for all the step templates that you want to edit.
  3. Optional: Set the AFP resource path property on any printers that you have created.
    If you set this property on a printer, it is only used when the job is printed, not when it is viewed or converted, and it is only used after RICOH ProcessDirector has already searched the resource paths that are set on the workflow.

    If your AFP resources include special MICR fonts or secure page segments (such as signatures) that are stored separately from other AFP resources, you might want to specify those directories only on the AFP resource path property for the printer or printers that might print jobs that use those resources.

    1. In the left pane, click Devices Printers.
    2. Select the printer that you want to edit.
    3. Click Disable.
    4. Select the printer again and click Properties.
    5. Click AFP.
    6. Find the AFP resource path property and type the path to the directory (or directories) that you copied your AFP resources into.
    7. Click OK.
    8. Repeat this step for all the printers that you want to edit.

1.2.4.16.2 Search order for AFP resource extensions

Print files refer to AFP resources by their names, without including a file type extension. However, resource files often have extensions added to them. When a component of RICOH ProcessDirector requests a resource, it uses the inline resource if the job includes one. Otherwise, it first looks for a file that matches the resource name without an extension. If it cannot find one, it adds one extension after another to the file name and searches for the resource using the new name.

Extensions are added to resource file names in a specific order based on the type of resource that is requested. Sometimes, different components add extensions in different orders.

These components in RICOH ProcessDirector request AFP resources: the AFP viewer, the printer driver (PSF), and the line data to AFP transform.

AFP viewer

The configuration file for the AFP viewer, /opt/infoprint/ippd/afpviewer/a2pxopts.cfg (Linux)C:\Program Files\Ricoh\afpviewer\a2pxopts.cfg (Windows), lets you specify file extensions for page segments, overlays, form definitions, JPEG files, GIF files, TIFF files, character sets, code pages, and coded fonts. The viewer searches for files in the order that you specify the extensions.

Note: On Linux file extensions are case-sensitive.

The configuration file that is installed with RICOH ProcessDirector contains these statements that set extensions for resources:

PageSegExt=*.,*.psg,*.PSG
OverlayExt=*.,*.oly,*.OLY
FormDefExt=*.,*.fde,*.FDE
JFIFEXT=*.,*.DOR,*.png, *.png,*.jfif,*.jpeg
GIFEXT=*.,*.DOR,*.png,*.png
TIFFEXT=*.,*.DOR,*.tif,*.TIF,*.tiff,*.TIFF
CHARSETEXT =*.,*.240,*.300,*.OLN,*.oln,*.Oln,*.fnt
CODEPAGEEXT =*.,*.fnt
CODEDFONTEXT =*.,*.fnt
For example, the configuration file sets the extensions for page segments to no extension (*.), .psg, and .PSG. To use different extensions, you can add other values by separating them with commas. For example, you can specify that no extension, .psg, .PSG, .300, and .600 should be searched as page segment extensions in that order if you change the page segment line to PageSegExt=*.,*.psg,*.PSG,*.300,*.600.

To comment out a line, insert the # character at the beginning of the line.

If there is no entry in the configuration file for a resource type, the AFP viewer looks for files with these extensions:

  • .jfif for JPEG files
  • .png for GIF files
  • .tif for TIFF files
  • No extension for other resource types

Printer driver and line data transform

For most types of resources, the printer driver and the line data transform use the same list of file extensions for each type of resource and they search in the same order. However, they use slightly different methods to search for data object resources and for most font resources. The line data transform uses the same list of extensions for all font-related resources that it works with except TrueType and OpenType fonts.

This table lists the file extensions that these components associate with each type of resource and the order in which they apply them.

Note: On Linux all file extensions must be in uppercase.

When you install Color Management Resources (CMRs), data objects, True Type fonts, and Open Type fonts using InfoPrint AFP Resource Installer, you give each object a name. Jobs refer to those types of objects using that name. To find the object, RICOH ProcessDirector searches the directories specified in the AFP resource path to find a directory that contains a resource access table (RAT). Then RICOH ProcessDirector searches the RAT to find the fully qualified file name and directory location for the resource. If the name is not listed in the RAT, RICOH ProcessDirector moves to the next location listed in the AFP resource path.

File extensions that the printer driver and the line data transform add to resource names, listed by resource type
AFP resource type File extensions that the printer driver adds File extensions that the line data transform adds
BCOCA objects (barcodes) No file extension No file extension
Code pages
  1. ECP
  2. No file extension
  3. FONT3820
  4. FONT38PP
  5. CDP
  6. FONT300
  1. ECP
  2. No file extension
  3. 240
  4. 300
  5. FONT300
  6. FONT3820
  7. FONT38PP
  8. CDP
  9. CFT
  10. OLN
  11. FONTOLN
  12. FIL
Coded fonts
  1. No file extension
  2. FONT3820
  3. FONT38PP
  4. CFT
  5. FONT300
  1. No file extension
  2. 240
  3. 300
  4. FONT300
  5. FONT3820
  6. FONT38PP
  7. CDP
  8. CFT
  9. OLN
  10. FONTOLN
  11. FIL
Color mapping table
  1. No file extension
  2. SETUP
  3. SET
  1. No file extension
  2. SETUP
  3. SET
Font character sets, 240-pel resolution
  1. No file extension
  2. 240
  3. FONT3820
  4. FONT38PP
  5. FIL
  1. No file extension
  2. 240
  3. 300
  4. FONT300
  5. FONT3820
  6. FONT38PP
  7. CDP
  8. CFT
  9. OLN
  10. FONTOLN
  11. FIL
Font character sets, 300-pel resolution
  1. 300
  2. FONT300
  3. No file extension
  1. No file extension
  2. 240
  3. 300
  4. FONT300
  5. FONT3820
  6. FONT38PP
  7. CDP
  8. CFT
  9. OLN
  10. FONTOLN
  11. FIL
Fonts, outline
  1. OLN
  2. FONTOLN
  1. No file extension
  2. 240
  3. 300
  4. FONT300
  5. FONT3820
  6. FONT38PP
  7. CDP
  8. CFT
  9. OLN
  10. FONTOLN
  11. FIL
Form definitions
  1. No file extension
  2. FDEF3820
  3. FDEF38PP
  4. FDE
  5. FIL
  1. No file extension
  2. FDEF3820
  3. FDEF38PP
  4. FDE
  5. FIL
GOCA objects (graphics) No file extension No file extension
IOCA objects (IO images) No file extension No file extension
MO:DCA objects
  1. No file extension
  2. OBJ
  3. OBJECT
  1. No file extension
  2. OBJ
  3. OBJECT
Overlays
  1. No file extension
  2. OVLY3820
  3. OVLY38PP
  4. OVL
  5. OLY
  6. OVR
  1. No file extension
  2. OVLY3820
  3. OVLY38PP
  4. OVL
  5. OLY
  6. OVR
Page definitions Not applicable
  1. No file extension
  2. PDEF3820
  3. PDEF38PP
  4. PDE
Page segments
  1. No file extension
  2. PSEG3820
  3. PSEG38PP
  4. PSG
  5. PSE
  1. No file extension
  2. PSEG3820
  3. PSEG38PP
  4. PSG
  5. PSE
Setup data
  1. No file extension
  2. SETUP
  3. SET
  4. COMSETUP
  1. No file extension
  2. SETUP
  3. SET
  4. COMSETUP

1.2.4.16.3 Job properties and AFP form definitions

RICOH ProcessDirector job properties can specify some of the same options as the form definition used for the job. If a job property and form definition conflict, these rules determine which value to use.

Values set for these job properties override the values in any form definition used for the job, inline or external:

  • Duplex
  • Media
  • Output bin

If the job contains an inline form definition or medium map, RICOH ProcessDirector ignores the values set for these job properties. If the job uses an external form definition, RICOH ProcessDirector uses the values set for these job properties and generates a new form definition that replaces the external form definition. If the original external form definition contains options that RICOH ProcessDirector does not set, RICOH ProcessDirector uses its default values for those options.

  • Punch
  • Staple

1.2.4.16.4 Color mapping table source and output files

A color mapping table is a printer resource object that defines a translation from certain Mixed Object Document Content Architecture (MO:DCA) structured fields to new color structured fields that newer printers use.

Use color mapping tables to adjust highlight and OCA colors on printers such as the InfoPrint 5000. You can also use a color mapping table to map highlight colors into richer colors on a color printer like the InfoPrint Color 130 Plus printer. To apply color to black and white documents, you must create color mapping table source and object files using the AFP architecture reference.

You can define translations from non-color fields to color, old color fields to new color fields, and from new color fields to different new color fields. Therefore, you can use existing applications and documents with new color fields without changing the applications or documents. You can use various color mappings with a single document to print the document using color in different ways without changing the original document.

The cmt utility creates color mapping tables from configuration files. It lets you create color mappings in a variety of different color modes that are defined through the ColorSpace parameter. For example, you can use the Highlight value when adjusting highlight and OCA colors on printers such as the InfoPrint 5000 and InfoPrint C900 AFP.

The sample configuration file, /usr/lpp/psf/config/cmt.cfg (Linux)C:\Program Files (x86)\InfoPrint\PSF\config\cmt.cfg (Windows), contains user-defined specifications. The cmt utility created a MO:DCA sample color mapping table, named cmtsampl, from the sample configuration file.

1.2.4.16.4.1 Parts of a color mapping table

A color mapping table consists of a base part, a set of source groups, and a set of target groups. The base part identifies the color mapping table with a type of reset or normal.

The simplest possible color mapping table is a reset color mapping table, which tells the printer not to do any transformations on the color information found in the document. A reset color mapping table does not have any source or target groups; all other color mapping tables have at least one source and one target group.

1.2.4.16.4.1.1 Using source groups

Each source group has an identification (ID) number from 1 through 127, which is used to match the source group with a corresponding target group.

You can have unique ID numbers; or, if you want to map several source groups to a single target group, you can use the same ID number for multiple source groups. The cmt utility generates pairs of sources and targets, then assigns increasing, sequential IDs to each pair.

You must classify each source group as one of these input color spaces:

Highlight color
Use highlight color when your existing documents describe color in terms of the percent to be covered and the percent to be shaded for a color number. The colors are device-dependent. For example, if your printer allows the use of three colors for highlighting, specify percent coverage and percent shading for colors 1, 2, or 3. The printer setup determines the actual colors.
Standard Object Content Architecture (OCA)
Standard OCA uses defined combinations of red, green, and blue to create blue, red, pink, magenta, green, turquoise (cyan), and yellow. Standard OCA also defines several defaults such as white on a black medium, black on a white medium, and the same color as the medium. The medium could be, for example, paper or a display.
GOCA pattern fill
GOCA pattern fill defines patterns for filling areas that you might want to map to colors with a color mapping table.
For more information about these color spaces, see Mixed Object Document Content Architecture Reference.

You can use a color mapping table to choose specific object types to map, such as:

  • Object area
  • IM image data
  • PTOCA data
  • Page presentation space
  • GOCA data
  • Overlay presentation space
  • BCOCA data
  • IOCA data (bi-level, FS10)
  • All PTOCA, GOCA, BCOCA, IOCA, FS10, and IM object data
  • All objects, object areas, and presentation spaces
After you choose the color spaces and object types that you want to map, you can specify exact values for the fields that you want to map.

1.2.4.16.4.1.2 Using target groups

Each target group has an identification (ID) number from 1 through 127, which is used to match the target group with one or more corresponding source groups.

The cmt utility generates pairs of sources and targets, then assigns increasing, sequential IDs to each pair.

You must classify each target group as one of these output color spaces:

  • RGB
  • CMYK
  • Highlight
  • CIELAB
The color spaces defined in the matching source groups are transformed to this color space. Your actual hardware determines your available choices. For example, if your printer supports only highlight color, your target group must use highlight color.

You can specify exact values for output colors. For example, if your printer supports three highlight colors, you can specify colors 1, 2, or 3 with coverage and shading percentages that your printer supports.

1.2.4.16.4.2 Creating a color mapping table (example)

This example shows how to create a color mapping table to print an Advanced Function Presentation (AFP) file that contains pie charts in the color green.

The pie chart appears as a series of horizontal lines. As explained in the chapter Graphic primitives and attributes in Graphics Objects Content Architecture for Advanced Function Presentation Reference, these horizontal lines are created by a Pattern Output Primitive with a hexadecimal value of '0B'(11).

To turn these horizontal lines into a shade of green when using a ColorSpace source group of GOCA to map to a target group value of RGB, specify a low value for red (12), a high value for green (252), and a value under 50 for blue (42) to provide a clear contrast.

  1. Change to the /usr/lpp/psf/config (Linux) C:\Program Files (x86)\InfoPrint\PSF\config (Windows) directory:
    For Linux:
    cd /usr/lpp/psf/config
    For Windows:
    cd C:\Program Files (x86)\InfoPrint\PSF\config
  2. Copy the sample color mapping table configuration file to a file you can customize for your own purposes:
    For Linux:
    cp cmt.cfg pie1.cfg
    For Windows:
    copy cmt.cfg pie1.cfg
  3. Edit the pie1.cfg file:
    1. Add these lines between the BeginSourceDef: and EndSourceDef: keywords:
      	ColorSpace: GOCA
      	ColorValue: 11
      	ObjectType: GOCAData
    2. Add these lines between the BeginTargetDef: and EndTargetDef: keywords:
      	ColorSpace: RGB
      	ColorValue: 12 252 42
    3. Save the pie1.cfg file.
  4. Run the cmt utility to create the color mapping table object file that will be used when you submit the job for printing:
    cmt -i pie1.cfg -o pie1.set
  5. Run the cmt utility again to verify your color mapping table values:
    cmt -i pie1.set -o pie2.cfg
  6. Compare pie1.cfg and pie2.cfg.
    If your color mapping table values are valid, they should be the same.

1.2.4.17 Setting up user exit programs

RICOH ProcessDirector can call user exit programs that can modify the AFP print file for a job before or after it prints. Authorized users can modify and compile the sample exit programs that RICOH ProcessDirector provides or they can write their own. RICOH ProcessDirector provides sample exit programs in the /usr/lpp/psf/exits (Linux) or C:\Program Files (x86)\Ricoh\PSF\exits (Windows) directory.
The sample job completion user exit writes job statistics to the /Ricoh/var/psf/ (Linux) or \PSF\var\psf\ (Windows) jobcompletion.log file. In the log entries, RICOH ProcessDirector appends aiw1 to the printer name as it appears in the RICOH ProcessDirector user interface.

To set up a user exit program:

  1. In the Printers Portlet, select the printer that you want to assign a user exit program to.
  2. Click Disable.
  3. Select the printer again and click Properties.
  4. In the properties notebook for the printer, click Exits.
  5. Enable the types of user exit programs that you want the printer to call by setting one or both of these properties to Yes:
    • Enable input data exit

      This exit program modifies the contents of the AFP print file before RICOH ProcessDirector sends the print file to the printer.

    • Enable job completion exit

      This exit program modifies the contents of the AFP print file after the printer reports that the job has printed.

  6. Specify the name of the compiled version of the user exit program for one or both of these properties:
    • Input data exit program
    • Job completion exit program
      Note:
    • If the compiled version of the user exit program resides in the /usr/lpp/psf/bin (Linux) or C:\Program Files (x86)\Ricoh\PSF\bin (Windows) directory, you do not need to include the path. If it resides in a different location, you can specify a path with the program name. The value for the combined path and program name can be up to 255 characters.
  7. Click OK.
  8. Select the printer and click Enable.

1.2.4.18 Banner pages

Banner pages can be printed at the beginning and end of a job to help distinguish one job from the next. If the AFP Support feature is installed, AFP print jobs can also include banner pages between copies of a multi-copy job. Banner pages usually include identifying information about the jobs, such as the job ID, file name, and the time the job was submitted.

1.2.4.18.1 AFP banner pages

AFP banner pages include header, trailer, and separator pages. They can be used (in any combination) with AFP print jobs printed to AFP printer objects. You can change the contents and appearance of those banner pages, as well as the fonts used to print them.

1.2.4.18.1.1 Setting up AFP printers to print banner pages

RICOH ProcessDirector can print these types of banner pages with an AFP job: header pages, separator pages, and trailer pages. Header pages print before the first data pages of a job. Separator pages print between copies of a multi-copy job. Trailer pages print after the last data pages of a job.
The default is for a printer to print only header pages.

To set up a printer to print banner pages:

  1. In the Printers Portlet, find the printer that you want to use to print jobs with banner pages. If the printer is enabled, right-click it and select Disable.
  2. Click the printer name to open the properties notebook.
  3. In the properties notebook, click Banner Pages to display the banner page properties for the printer.
  4. To select the types of banner pages that you want to print, set Enable header pages, Enable separator pages, or Enable trailer pages to Yes.
  5. To use a form definition other than the default for any of the types of banner pages, change Header page form definition, Separator page form definition, or Trailer page form definition to indicate the form definition that you want to use.
      Note:
    • The form definition that you specify must be in one of these directories:
      • A directory that the AFP resource path property for the printer specifies
      • /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows)
      • /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows)
    • The default form definition that RICOH ProcessDirector uses includes a box pattern overlaid on the banner page. Specify a different form definition if you do not want the box pattern. For example, form definition F1A00010 does not include the box pattern.
  6. To print page edge marks (also called mark forms) on banner pages for identification purposes, set Header page edge marks, Separator page edge marks, or Trailer page edge marks to Yes.
  7. To print specialized versions of banner pages to match hardware characteristics of the printer, change Banner page type.
    Note: Configuration files to format the content of AFP banner pages are only available in the portrait orientation. Setting the Banner page property to Wide does not change the banner pages to landscape orientation.
  8. Click OK.
  9. Right-click the printer and select Enable.
  10. Repeat these steps for any other printers that you want to set up to print banner pages with jobs.
Note: For header and trailer pages to print, the values for the Header copies and Trailer copies properties for the job must be set to 1 or greater. If the values for those job properties are set to 0, the printer does not print a header page or a trailer page for a specific job, even though these types of banner pages are enabled on the printer.

1.2.4.18.1.2 Updating properties for AFP banner pages

For jobs sent to AFP printers, you can update the banner_page_property_values.cfg configuration file for the properties that banner pages can use. The configuration file defines the elements that can print on banner pages, including properties of jobs, printers, load plans, and other objects, system settings, and text strings. A sample banner_page_code_page_mapping.cfg file is installed in /aiw/aiw1/samples/banner_pages/ and in /aiw/aiw1/control_files/banner_pages/ .
Note: Updates might overwrite files in the /aiw/aiw1/samples/banner_pages/ directory, but they do not overwrite files in the /aiw/aiw1/control_files/banner_pages/ directory. We recommend copying sample files into the /aiw/aiw1/control_files/banner_pages/ directory and making all your changes in the copied file.
When RICOH ProcessDirector assigns a job to a printer, it generates the jobnumber.banner_attributes.txt file in the spool directory for the job. This file contains the properties notebook names and job-specific resolved values for all the properties that the banner_page_property_values.cfg file contains.
To update the properties for AFP banner pages:
  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Navigate to /aiw/aiw1/control_files/banner_pages/ .
  3. Open the banner_page_property_values.cfg file with a text editor.
  4. Add entries to or delete entries from the file, as required for the installation.
    Each entry in the file has two lines. The first line contains text strings and database property names, separated by commas. Database property names are delimited with brackets ([]). The second line expresses the first line as a symbol formula. For example:
    • This example defines a job property. The symbol name is the same as the job property name.
      [Job.Copies]
      ${Job.Copies}
      
    • This example defines a printer property:
      [Printer.AFP.Overlay]
      ${Printer.AFP.Overlay}
      
    • This example defines a system setting:
      [WorkflowSystem.Transform.ServerAddress]
      ${WorkflowSystem.Transform.ServerAddress}
    • This example defines a barcode that includes an initial text string, two job properties, and a final text string:
      SO,[Job.ID],[Job.TotalSheets],2009
      ${Customer.BarCode}
      
    • This example defines a property of the load plan associated with the job. The ampersand (&) indicates that the properties are nested.
      &[Job.Insert.LoadPlan.ID] [LoadPlan.Media]
      ${Job.Insert.LoadPlan.ID} ${LoadPlan.Media}
    • This example defines a single instance of a job property that can have different values for different phases and steps. The example resolves to one value:
      [Job.External.Command.Prepare.RunExternalProgram]
      $[Job.External.Command.Prepare.RunExternalProgram]
    • This example defines all instances of a job property that can have different values for different phases and steps. This example can resolve to several values:
      [Job.External.Command]
      $[Job.External.Command]

    When RICOH ProcessDirector assigns a job to a printer and generates the jobnumber.banner_attributes.txt file, it resolves entries from the configuration file. Depending on settings in the individual banner-page configuration files, such as /aiw/aiw1/control_files/banner_pages/header.cfg , it can resolve entries like this:

    [Job.Copies.Value]
    1
    [Job.Copies.NameAndValue]
    Job copies requested: 1
    
    [Customer.BarCode.Value]
    SO10000007112009
    [Customer.BarCode.NameAndValue]
    SO: SO Job number: 10000007 Total sheets: 11 2009: 2009
    
    &[Job.Insert.LoadPlan.ID] [LoadPlan.Media.Value]
    A4

  5. Save the configuration file. All the properties that the file defines are now available to use with AFP banner pages.

1.2.4.18.1.3 Updating the coded font and code page mappings for AFP banner pages

For jobs sent to AFP printers, you can update the banner_page_code_page_mapping.cfg configuration file to add custom coded font and code page mappings to use with banner pages. If you create your own coded fonts, you specify them in this file so that RICOH ProcessDirector can use them. A sample banner_page_code_page_mapping.cfg file is installed in /aiw/aiw1/samples/banner_pages/ (Linux) or C:\aiw\aiw1\samples\banner_pages\ (Windows) and in /aiw/aiw1/control_files/banner_pages/ (Linux) or C:\aiw\aiw1\control_files\banner_pages\ (Windows).
Note: Updates might overwrite files in the /aiw/aiw1/samples/banner_pages/ directory, but they do not overwrite files in the /aiw/aiw1/control_files/banner_pages/ directory. We recommend copying sample files into the /aiw/aiw1/control_files/banner_pages/ directory and making all your changes in the copied file.

Any coded fonts that you create must be in one of these directories so that RICOH ProcessDirector can locate and use them:

  • The directory that the AFP resource path property for the job associated with the banner page specifies
  • /aiw/aiw1/resources
  • /usr/lpp/psf/reslib
To update coded font and code page mappings for AFP banner pages:
  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Navigate to /aiw/aiw1/control_files/banner_pages/ .
  3. Open the banner_page_code_page_mapping.cfg file with a text editor.
    Lines that begin with a number sign (#) are comments that contain information and instructions.
  4. Add your custom coded font and code page mappings to the section near the top of the file for user-defined information. Use this format:
    AFPCodedFontName=JavaCodePage
  5. Save the configuration file. You can now use your custom coded fonts with banner pages.
Note: Make sure that any coded fonts that you define in the configuration file support the Intelligent Printer Data Stream (IPDS) resolution of the printer that will print the banner page. Depending on the printer model, you can also set the resolution at the printer to AUTO. For more information, see the documentation for the printer.

1.2.4.18.1.4 Obtaining and using coded fonts for Japanese AFP banner pages

RICOH ProcessDirector supports AFP banner pages that use double-byte character set (DBCS) characters in Japanese. You can install Japanese DBCS-coded fonts from CDs that RICOH ProcessDirector provides.
To use coded fonts for Japanese AFP banner pages:
  1. Install fonts from these CDs on the primary computer:
    AFP Outline Fonts (LCD4-5683)
    These fonts can be used on Linux and Windows. They include fonts for Japanese, Korean, Simplified Chinese, and Traditional Chinese.
    WorldType Fonts (LCD4-5684)
    These are OpenType and TrueType fonts in Microsoft Unicode format.
  2. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  3. In the documentation for the fonts that you installed, find the installation location of the Japanese DBCS-coded font or fonts that you want to use. For example, find XZAE26F.
  4. Copy the DBCS-coded fonts to this directory on any RICOH ProcessDirector primary computer from which you will print banner pages that include Japanese characters: /usr/lpp/psf/reslib
  5. Navigate to /aiw/aiw1/control_files/banner_pages/ .
  6. Open the banner_page_code_page_mapping.cfg file with a text editor. Map the coded fonts that you copied to their corresponding Java code pages. Most of the Japanese DBCS-coded fonts map to the IBM930 or IBM939 code page. For example, add this mapping:
    XZE26F=IBM939
  7. Save the configuration file.
  8. Determine the control file or files that you want to update to support AFP banner pages with Japanese characters. Update any lines in the files for which you want to use Japanese DBCS-coded fonts. You also need to change the entry for the single-byte coded font in the previous field. The single-byte coded font must use an EBCDIC code page that is a subset of the code page for the DBCS-coded font. For example, change this line:
    Field301 Class;JobTicketField;[Job.Class.NameAndValue];X0PCLR12;;4.50;3.34375;0
    to:
    Field301 Class;JobTicketField;[Job.Class.NameAndValue];X0CR51;XZE26F;4.50;3.34375;0
  9. Save the configuration file. You can now print banner pages that include Japanese fonts.
Note: The printer that prints the banner pages must support DBCS characters.

1.2.4.18.1.5 Changing the appearance of AFP banner pages

After an AFP printer is set up to print banner pages, each job must specify what the banner page for the job should look like. A control file defines the appearance of the banner page. The control file might be set by the workflow, but you can change the banner-page control file for an individual job after it is in the system.
RICOH ProcessDirector provides twelve control files for various types of AFP banner pages. The set of control files includes one configuration file for each type of banner page: header, separator, and trailer. It also includes control files for four printer hardware configurations: generic, narrow format, wide format, and impact printer.

The control files are installed in /aiw/aiw1/samples/banner_pages/ on the primary computer. They use AFP coded fonts that RICOH ProcessDirector provides. You can use the control files as they are or you can change them to meet your needs.

Note: RICOH ProcessDirector also lets you specify your own coded fonts for use with AFP banner pages. If you want to use your own coded fonts, review the information in the related task about mapping coded fonts before you do this procedure.

To change the appearance of AFP banner pages:

  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Navigate to /aiw/aiw1/samples/banner_pages/ .
  3. Determine the control file that you want to edit and copy it to the /aiw/aiw1/control_files/banner_pages/ directory.
    Note: Updates might overwrite files in the /aiw/aiw1/samples/banner_pages/ directory, but they do not overwrite files in the /aiw/aiw1/control_files/banner_pages/ directory. We recommend copying sample files into the /aiw/aiw1/control_files/banner_pages/ directory and making all your changes in the copied file.
  4. Open the copied control file with a text editor.
    Lines that begin with an asterisk (*) are comments that contain information and instructions. Lines that control the information that prints on the banner page and the placement of the information use this format:
    FieldX FieldName;FieldType;[TicketKey];CodedFontForSingleByteChars;
    CodedFontForDoubleByteChars;InchesFromLeft;InchesFromTop;Rotation
    All fields of the line that follow the field identifier are separated by semicolons (;). You cannot omit any of the fields in the line, except for the CodedFontForDoubleByteChars field.

    These are examples of various banner page entries for banner page text strings and values:

    Field304 Customer;JobTicketField;[Job.CustomerName.NameAndValue];X0CR5M;XZE26F; 4.50;4.234375;0
    or
    Field304 Customer;JobTicketField;[Job.CustomerName.NameAndValue];X0PCLR12;; 4.50;4.234375;0
    
    Field402 PrintDate;ExitData;ExtDate;X0CR5M;XZE26F;2.250;6.34375;0
    Field510 Dept1234;Literal;Department 1234 statistics;X0CR5M;XZE26F;2.55;2.234375;0

    Note: You can also include barcodes on banner pages for properties that have numeric values. Because the format of barcode entries in the control file is different, specifying barcodes on AFP banner pages is a separate task. See the related task links.
  5. Save the modified control file.
Now, you can set the Header page configuration file, Trailer page configuration file, or Separator page configuration file property on a workflow or on an individual job to refer to the control file that you created or edited:
  • On a workflow, these properties are set by the PrintJobs step
  • On an individual job, these properties are set on the Banner Pages tab of the properties notebook for the job

1.2.4.18.1.6 Printing barcodes on AFP banner pages

You can print barcodes that represent the values of job properties, printer properties, and system settings on banner pages. For jobs sent to AFP printers, you configure RICOH ProcessDirector to print the barcodes by adding or modifying entries in the control files installed in /aiw/aiw1/samples/banner_pages/ and /aiw/aiw1/control_files/banner_pages/ , such as header.cfg.
Note: Updates might overwrite files in the /aiw/aiw1/samples/banner_pages/ directory, but they do not overwrite files in the /aiw/aiw1/control_files/banner_pages/ directory. We recommend copying sample files into the /aiw/aiw1/control_files/banner_pages/ directory and making all your changes in the copied file.

Before you start this procedure, make sure you understand how to change the appearance of AFP banner pages.

To print a barcode on an AFP banner page:
  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Navigate to /aiw/aiw1/control_files/banner_pages/ .
  3. Determine the control file that you want to add or modify barcode information for, and open the file with a text editor.

    Lines that cause RICOH ProcessDirector to print barcodes on AFP banner pages use this format:

    FieldX FieldName;FieldType;[key];;;InchesFromLeft;InchesFromTop;Rotation;BarcodeType;
    Height;Modifier;Asterisk;HRI;ModuleWidth;WideNarrowRatio;RowSize;NumberOfRows
    All fields of the line that follow the field identifier are separated by semicolons (;). You cannot omit any of the fields except the ModuleWidth, WideNarrowRatio, RowSize, and NumberOfRows fields.

    These are examples of barcode entries in banner-page control files:

    Field2 Barcode;JobTicketField;[JobID];;;2.25;1.0;0;3of9;0.625;1;no;none;;;;
    
    Field100 Barcode2;JobTicketField;[Job.ID.Value];;;0.950;8.35;0;3of9;0.625;1;no;below;;;;;

  4. Save the control file.

When you send jobs to this printer, make sure the correct configuration file values are specified for the Header page configuration file, Separator page configuration file, and Trailer page configuration file properties. You can set these values as job defaults on the workflow or on the job itself.

1.2.4.18.2 PDF banner pages

PDF header pages and trailer pages can be used with PDF jobs. They can also be used with jobs in other data streams, but only if the printer they are sent to supports printing PDF files. You can change the contents and appearance of PDF banner pages, and the fonts used to print them.

If you print a PDF 2.0 file with banner pages, the file is converted to PDF 1.7 format which is required for the banner pages.

1.2.4.18.2.1 Setting up Ricoh PDF or Custom PDF printers to print PDF banner pages

RICOH ProcessDirector can print PDF header pages and trailer pages for a job sent to a Ricoh PDF or Custom PDF printer. Header pages print before the first data pages of a job. Trailer pages print after the last data pages of a job.
To set up a Ricoh PDF or Custom PDF printer to print PDF banner pages:
  1. In the Printers Portlet, find the Ricoh PDF or Custom PDF printer that you want to use to print jobs with PDF banner pages. If the printer is enabled, right-click it and select Disable.
  2. Open the properties notebook by clicking the printer name.
  3. Display the banner page properties for the printer by clicking the Banner Pages tab.
  4. Make sure that the desired banner pages are enabled for your printer:
    • To use header pages, set the Enable header pages property to Yes.
    • To use trailer pages, set the Enable trailer pages property to Yes.
  5. Specify values for the Merge banner pages into PDF print file and Banner page input tray properties.
  6. Click OK.
  7. Right-click the printer and select Enable.
  8. Repeat these steps for any other Ricoh PDF or Custom PDF printers that you want to set up to print banner pages with jobs.
    Note:
  • For header and trailer pages to print, the values of the Header copies and Trailer copies properties for the job must be set to 1 or greater. If the values of those job properties are set to 0, the printer does not print a header page or a trailer page for a specific job, even if these types of banner pages are enabled on the printer.
  • If the Ricoh PDF or Custom PDF printer is on an application server, you must change the values of the Header page configuration file and Trailer page configuration file properties for the job. Those properties must specify the drive letter that the application server uses to connect to the /aiw directory on the primary computer. For example, the application server uses Z: to connect, and the file path to the header page configuration file on the primary computer is /aiw/aiw1/control_files/banner_pages/header.jrxml. This value must specify Z:\aiw1\control_files\banner_pages\header.jrxml.
  • To make sure that a job and its banner pages print together, set the Merge banner pages into PDF print file property to Yes. If you set it to No, another job sent to the printer at the same time can print between the job and its banner pages.
  • You can set the Merge banner pages into PDF print file property to Yes for jobs that include page exceptions for sides, media, and stapling when your printer supports these page exceptions. If you have other finishing options in the JDF job ticket, such as punching or binding, set the property to No.
  • If you print a PDF 2.0 file with banner pages, the file is converted to PDF 1.7 format which is required for the banner pages.

1.2.4.18.2.2 Setting up Passthrough printers to print PDF banner pages

RICOH ProcessDirector can print PDF header pages and trailer pages for a job sent to a Passthrough printer. Header pages print before the first data pages of a job. Trailer pages print after the last data pages of a job.
To set up a Passthrough printer to print PDF banner pages:
  1. In the Printers Portlet, find the Passthrough printer that you want to use to print jobs with PDF banner pages. If the printer is enabled, right-click it and select Disable.
  2. Click the printer name to open the properties notebook for the printer.
  3. Click the Banner Pages tab to display the banner page properties for the printer.
  4. Enable the appropriate banner pages:
    • To use header pages, set the Enable header pages property to Yes.
    • To use trailer pages, set the Enable trailer pages property to Yes.
  5. Specify a value for the Merge banner pages into PDF print file property.
    If you select No, update the Printer command property on the General tab so it includes multiple lpr commands. You must include one lpr command for the job and one for each type of banner page that is enabled. Enter the commands in the order that the pages should print in. For example, to print a header page, a PDF job, and a trailer page, use this command:

    lpr -P printerName ${getFileName(header,pdf,read)} && lpr -P printerName ${getCurrentFile(pdf)} && lpr -P printerName ${getFileName(trailer,pdf,read)}

  6. Click OK.
  7. Right-click the printer and select Enable.
  8. Repeat these steps for any other Passthrough printers that you want to set up to print banner pages with jobs.
    Note:
  • You can only print these banner pages on a printer device that supports the PDF data stream.
  • For header and trailer pages to print, the values of the Header copies and Trailer copies properties for the job must be set to 1 or greater. If the values of those job properties are set to 0, the printer does not print a header page or a trailer page for a specific job, even if these types of banner pages are enabled on the printer.
  • If you request header or trailer pages in the printer command, the value for the Header copies or Trailer copies property must be set to 1 or greater or the job does not print correctly.
  • To make sure that a job and its banner pages print together, set the Merge banner pages into PDF print file property to Yes. If you set it to No, another job sent to the printer at the same time might print between the job and its banner pages.
  • If you print a PDF 2.0 file with banner pages, the file is converted to PDF 1.7 format which is required for the banner pages.

1.2.4.18.2.3 Setting up workflows to print PDF banner pages

You can update existing workflows to print PDF banner pages or create new ones.
To set up a workflow to print PDF banner pages:
  1. Click the Workflow tab.
  2. Right-click an existing workflow that processes PDF jobs and select Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue. If none of your existing workflows are appropriate, do this:
    1. Right-click the PDF workflow, and select Copy.
    2. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    3. If the new workflow does not process PDF jobs, right-click the CountPages step, and select Delete. Connect the DetectInputDataStream step to the RunExternalProgram step. Right-click the CreatePageRanges step, and select Delete. Connect the RunExternalProgram step to the PrintJobs step.
      Do not delete these steps if the new workflow processes PDF jobs. These steps are needed to reprint a range of pages in PDF jobs.
    4. If the new workflow processes PDF jobs and the value of the Create .zip file property for the hot folder that assigns jobs to this workflow is set to Yes, add a step based on the BuildPDFFromZIP step template to the workflow before the first step that expects PDF input (for example, EnableRepositioning, CreatePageRanges, or PrintJobs ). Update the properties.
  3. Right-click the PrintJobs step and select Properties.
  4. Change the values of the Binding, Fold options, Job class, Job form, Job destination, Requested location, Media, Output bin, Punch, and Staple properties to match the scheduling properties of the printer that you want to print on.
  5. Change the values of these banner page copies properties as needed.
    • Header copies

      Set this value to 1 or greater to print one or more header pages before a job or to 0 to omit the header page.

    • Trailer copies

      Set this value to 1 or greater to print one or more trailer pages after a job or to 0 to omit the header page.

    • Separator copies

      This value is ignored. Printers that are defined on application servers or primary servers do not support printing separator pages.

  6. Change the values of the banner page configuration file properties as needed. The default values for the Header page configuration file and Trailer page configuration file properties refer to configuration files for PDF banner pages.

    To use the supplied configuration files for header and trailer pages on a printer defined on the application server, you must specify the drive letter of the application server that the printer is running on and the file path to the header and trainer configuration files. For example, the application server uses Z: to connect to the primary computer’s /aiw directory, and the file paths to the configuration files on the primary computer are /aiw/aiw1/control_files/banner_pages/header.jrxml and /aiw/aiw1/control_files/banner_pages/trailer.jrxml. Change the values to:

    • Header page configuration file: Z:\aiw1\control_files\banner_pages\header.jrxml
    • Trailer page configuration file: Z:\aiw1\control_files\banner_pages\trailer.jrxml

    To use the supplied configuration files for header and trailer pages on a Passthrough printer, change the values to:

    • Header page configuration file: /aiw/aiw1/control_files/banner_pages/header.jrxml
    • Trailer page configuration file: /aiw/aiw1/control_files/banner_pages/trailer.jrxml

  7. Click OK.
  8. Save the workflow.

1.2.4.18.2.4 Formatting PDF banner pages

You can change the formatting for PDF banner pages that RICOH ProcessDirector produces and sends to printers.

PDF banner pages use configuration files in the JRXML format. RICOH ProcessDirector provides sample JRXML files, but you can use customized files instead. The Jaspersoft® Studio application is open source software that helps you create JRXML files. You can download Jaspersoft Studio from https://community.jaspersoft.com/project/jaspersoft-studio and install the application on any supported workstation.

When you have created the JRXML files, copy them to the /aiw/aiw1/control_files/banner_pages/ directory on the primary computer and update the Header page configuration file and Trailer page configuration file properties for jobs that are sent to printers to use the new files.

    Note:
  • If you use specific fonts in your JRXML files, make sure that the fonts are available on your server.

    If a specific font is not available, find a compatible font and update the JRXML to use it instead. For example, if you installed DejaVu fonts and need a font that is compatible with Lucida Sans, open a command prompt and type:

    fc-match "Lucida Sans"

    Update the JRXML with the compatible font.

1.2.4.18.2.5 Setting up Kodak PDF printers to print PDF banner pages

Kodak PDF printers can print PDF header pages and trailer pages for a job. Header pages print before the first data pages of a job. Trailer pages print after the last data pages of a job.
To set up a Kodak PDF printer to print PDF banner pages:
  1. In the Printers Portlet, find the Kodak PDF printer that you want to use to print jobs with PDF banner pages. If the printer is enabled, right-click it and select Disable.
  2. Click the printer name to open the properties notebook.
  3. Click the Banner Pages tab to display the banner page properties for the printer.
  4. Make sure that the desired banner pages are enabled for your printer:
    • To use header pages, set the Enable header pages property to Yes.
    • To use trailer pages, set the Enable trailer pages property to Yes.
  5. Specify values for the Merge banner pages into PDF print file and Banner page input tray properties.
  6. Click OK.
  7. Right-click the printer and select Enable.
  8. Repeat these steps for any other Kodak PDF printers that you want to set up to print banner pages with jobs.
    Note:
  • For header and trailer pages to print, the values of the Header copies and Trailer copies properties for the job must be set to 1 or greater. If the values of those job properties are set to 0, the printer does not print a header page or a trailer page for a specific job, even if these types of banner pages are enabled on the printer.
  • To make sure that a job and its banner pages print together, set the Merge banner pages into PDF print file property to Yes. If you set it to No, another job sent to the printer at the same time might print between the job and its banner pages.
  • If your job includes job-level stapling, the header page and trailer page are not merged to ensure that the job is stapled.
  • You can set the Merge banner pages into PDF print file property to Yes for jobs that include page exceptions for sides and media if your printer supports these page exception. If you have other finishing options for your job, such as punching, set the property to No. If you are using Postscript, set the property to No.
  • If you print a PDF 2.0 file with banner pages, the file is converted to PDF 1.7 format which is required for the banner pages.

1.2.4.18.2.6 Setting up Xerox PDF printers to print PDF banner pages

Xerox PDF printers can print PDF header pages and trailer pages for a job. Header pages print before the first data pages of a job. Trailer pages print after the last data pages of a job.
To set up a Xerox PDF printer to print PDF banner pages:
  1. In the Printers Portlet, find the Xerox PDF printer that you want to use to print jobs with PDF banner pages. If the printer is enabled, right-click it and select Disable.
  2. Click the printer name to open the properties notebook.
  3. Click the Banner Pages tab to display the banner page properties for the printer.
  4. Make sure that the desired banner pages are enabled for your printer:
    • To use header pages, set the Enable header pages property to Yes.
    • To use trailer pages, set the Enable trailer pages property to Yes.
  5. Specify values for the Merge banner pages into PDF print file and Banner page input tray properties.
  6. Click OK.
  7. Right-click the printer and select Enable.
  8. Repeat these steps for any other Xerox PDF printers that you want to set up to print banner pages with jobs.
    Note:
  • For header and trailer pages to print, the values of the Header copies and Trailer copies properties for the job must be set to 1 or greater. If the values of those job properties are set to 0, the printer does not print a header page or a trailer page for a specific job, even if these types of banner pages are enabled on the printer.
  • To make sure that a job and its banner pages print together, set the Merge banner pages into PDF print file property to Yes. If you set it to No, another job sent to the printer at the same time might print between the job and its banner pages.
  • If your job includes job-level stapling, the header page and trailer page are not merged to ensure that the job is stapled.
  • You can set the Merge banner pages into PDF print file property to Yes for jobs that include page exceptions for sides, media, and stapling if your printer supports these page exceptions. If you have other finishing options for your job, set the property to No.
  • If you print a PDF 2.0 file with banner pages, the file is converted to PDF 1.7 format which is required for the banner pages.

1.2.4.19 Email and progress updates

You can send an email during job processing, with the SendEmail step or with a notification object.

The SendEmail step sends an email when the job reaches that step and can include a job or part of a job as an attachment. The email can include an update about a job's progress through the system.

A notification object sends an email when certain input device, job or printer events happen to notify users of the status of a input device, job or printer.

1.2.4.19.1 Configuring to send email during processing

You can configure RICOH ProcessDirector to send email as a step in a workflow, or send email notifications when input device, printer or job events occur.
You must install the PDF Document Support feature to use the EmailDocuments step. You can use the EmailDocuments step to send emails with individual documents as attachments.

You must have an email server installed and configured to let RICOH ProcessDirector send email with it.

To configure to send email:
  1. Collect this information about your SMTP server:
    • Network IP address or fully-qualified host name
    • TCP port number (the standard port for SMTP is 25)
    • Type of security (SSL, TLS, or none) and the TCP port that the secure connection uses
        Note:
      • RICOH ProcessDirector supports SSL v3 and TLS v1.2 connections without certificate authentication.
  2. If the SMTP server requires a user ID and password, create them on your SMTP server so RICOH ProcessDirector can log in to the SMTP server to send email.
  3. Use the information from the previous steps to configure the RICOH ProcessDirector system properties for the SMTP server.
    1. Click the Administration tab.
    2. In the left pane, click Setting System.
    3. On the Email/SMTP section, define the values for all SMTP and Email properties that RICOH ProcessDirector uses to communicate with the SMTP server.
        Note:
      • You can also use the Alternate SMTP properties to communicate with the SMTP server if the SMTP server type property is set to Alternate for the SendEmail or EmailDocuments step template. You cannot use the Alternate SMTP properties for email notifications.
You can now add the SendEmail or EmailDocuments step template to your workflows to send an email at different points during job processing, or define notification objects to send emails when input device, printer or job events occur.

1.2.4.19.2 Emailing files during job processing

You can use the SendEmail step template to email a job, a page range from a job, or any other file to one or more email addresses as part of the job's workflow. If you have the PDF Document Support feature installed, you can use the EmailDocuments step template to email documents from the job as part of the workflow.

You can add the SendEmail step to a workflow and configure it to send email with one or more attachments. When the job reaches that step, the step retrieves the files requested, attaches them to an email, and sends the email to the specified addresses. If you set the Attach ZIP file property to Yes, the step packages all of the attachments in a ZIP file and attaches it to the email.

You can use this function in various situations:

  • If the workflow uses an external formatting program to reformat jobs, you can send pages from the reformatted job to your customer for approval.
  • If your customer wants to archive jobs in their own system, you can send jobs to them after they have printed.
  • If you have Service Level Agreements (SLAs) with your customers, you can send notifications to them (including sample pages from jobs) when key steps complete.

You can use the EmailDocuments step to send individual PDF documents from the job as attachments to an email. For example, you can send each customer's statement to a separate email address by specifying the ${Doc.EmailAddress} property in the Recipient address field on the step. Using individual customer email addresses is useful if the job produces output such as customer statements or insurance policy updates.

To use either the SendEmail or EmailDocuments step, you must configure your system to connect to an SMTP server. If you send some email from one email server and some email from a different email server, you can configure a default SMTP server and an Alternate SMTP server for the system. When you add either step to a workflow, you can choose which SMTP server to use.

    Note:
  • You cannot use the Alternate SMTP server for email notifications. Notifications are sent through the default SMTP server.

1.2.4.19.3 Emailing documents during job processing

You can email PDF documents by adding a step based on the EmailDocuments step template to a workflow.

You must provide an email address for each document and store the email address in a document property. You can use the Doc.EmailAddress document property, or you can define a custom document property in the docCustomDefinitions.xml file. After you define a custom document property, run the docCustom utility and update the Custom Document Properties feature.

  • If each document contains the email address of the document recipient, you can use the Define Document Property function in RICOH ProcessDirector Plug-in for Adobe Acrobat to specify the email address data that you want to extract from each document in a job.
  • If you have the Preference Management feature installed, you can map email addresses in an external file to the document property for each document in the job.

You must have an SMTP server installed and configured to let RICOH ProcessDirector send email. RICOH ProcessDirector lets you connect to two SMTP servers. You might use the default SMTP server properties to connect to an internal SMTP server and the alternate SMTP server properties to connect to an email service provider.

To configure RICOH ProcessDirector to email documents during job processing:
  1. Make a copy of an existing workflow or create a new workflow.
  2. Add a step based on the EmailDocuments step template to the workflow after the BuildPDFFromDocuments step and before any step that reorders documents at the job level, such as ReversePDFPageOrder or PreparePDFOutputForFinishing.
    You can place the EmailDocuments step after steps that reorder documents at the document level, such as GroupDocuments, SortDocuments, and SplitDocuments.

    For jobs that email and print documents, a typical step order is:

    • IdentifyPDFDocuments
    • SortDocuments
    • BuildPDFFromDocuments
    • EmailDocuments
    • PreparePDFOutputForFinishing
    • PrintJobs

    If you add a step to keep a copy of the job file in the spool directory to use for extracting documents to email, you can place the EmailDocuments step after a step that reorders documents at the job level. For example, you can place a step based on the SnapshotJobFile step template after the BuildPDFFromDocuments step and before the step that reorders documents:

    • IdentifyPDFDocuments
    • SortDocuments
    • BuildPDFFromDocuments
    • SnapshotJobFile
    • PreparePDFOutputForFinishing
    • PrintJobs
    • EmailDocuments

      Important:
    • If you do not follow these recommendations for step placement, the EmailDocuments step could send a document to the incorrect email address without recording an error.

  3. Connect the step to the other steps in the workflow.
    If you want to print some documents and email others, add conditional processing to the workflow or create child workflows.

    For example, you can:

    • Add conditional processing for parent and child jobs at the start of the workflow (for example, after a SetJobPropsFromTextFile step). Define a rule for the branch that receives the parent jobs: Job number Unlike *.*. Child jobs, which have a decimal point in their job number, go to the branch for child jobs.
    • Define a Doc.Custom.EmailPreference document property with values of Yes and No.
    • Use a step based on the GroupDocuments step template to group the documents based on the value of the Doc.Custom.EmailPreference document property.
    • Use a step based on the CreateJobsFromDocuments step template to create a separate child job for each group.
    • Use a step based on the SetDocPropsFromConditions step template at the start of the branch for child jobs. The step assigns a value to a job property based on the value of the Doc.Custom.EmailPreference document property.

      The property conditions file might set the value of the Custom 1 job property (database property name Job.Info.Attr1) to email or print:

      Doc.Custom.EmailPreference,Job.Info.Attr1
      =Yes,email
      =No,print

    • Send the child jobs to separate email and print branches of the branch for child jobs by defining rules on the branches:
      • Custom 1 = email for the branch with the EmailDocuments step.
      • Custom 1 = print for the branch with the PrintJobs step.

  4. Specify property values for the EmailDocuments step:
    1. Set a value for the Recipient address property.
      For example, you want to email each document to the email address in the Doc.EmailAddress document property. Set the value to ${Doc.EmailAddress}.
    2. Set a value for the SMTP server type property.
      For example, you want to send documents to an external SMTP server that has been configured with the Alternate SMTP server properties. Set the value to Alternate.
    3. Set the Attach document property to Yes.
    4. Set a value for the Source file for attachment property.
      Examples:
      • You want to attach a document from the current PDF file in the job's spool directory. Use the default value: ${getFileName(print,pdf,read)}.
      • You want to attach a document from a PDF file that you saved with a SnapshotJobFile step. If you set the value of the Snapshot file descriptor property on the SnapshotJobFile step to email, use this value: ${getFileName(email,pdf,read)}.
    5. Set a value for the Subject property, the Message property, or both.
      For example, you extracted the customer name from each document by defining a Doc.Custom.CustomerName document property. You can set the value of either property to Statement for ${Doc.Custom.CustomerName}.
    6. Fill in or edit values for any other optional properties that you plan to use.
  5. After you save and enable your workflow, test the workflow to make sure that it is working properly:
    1. Create a test job with a small number of documents. They should have valid email addresses that you want to test with.
    2. Send the job through the workflow and make sure that the correct document is sent to each email address.
When the EmailDocuments step sends a document to the SMTP server, it sets the Email created property value to Yes in the document property file. If the step does not send a document, it sets the property value to No.
    Note:
  • RICOH ProcessDirector does not receive information from the SMTP server about sending email or successful delivery to recipients.

1.2.4.19.4 Setting up the system to use an alternate email server

You can set RICOH ProcessDirector to use an alternate email server to send jobs or documents instead of using the default server.
RICOH ProcessDirector sends email using several mechanisms:
  • Notifications

    Emails created by notifications must use the default email server.

  • Jobs

    Jobs or pages from jobs are sent by the SendEmail step in a workflow.

  • Documents

    You must install the PDF Document Support feature to use the EmailDocuments step. Emails with documents attached are created by an EmailDocuments step in a workflow.

Emails sent by workflows might contain more sensitive data or be larger in volume (many separate document emails from a large job). Specifying an alternate email server allows you to route those types of emails differently than the notification emails.

To set up the system to use an alternate email server:

  1. Click the Administration tab.
  2. Select Settings System and scroll down to the Email/SMTP section.
  3. In the Alternate SMTP server field, type the address of your SMTP server.
  4. In the Alternate SMTP port field, type the port number for the alternate SMTP server. Check with your network administrator to make sure this port is open.
  5. In the Alternate SMTP user name field, type the user name that RICOH ProcessDirector uses if it has to log in to the alternate SMTP server.
      Note:
    • You might have multiple user names for your SMTP account, for example, one for administrator and one only for outbound emails. Make sure you select the correct user name to use for outbound emails.
  6. In the Alternate SMTP password field, type the password for the SMTP user name that you entered above.
  7. Optional: Depending on the type of security that the SMTP server uses, fill in the correct field for the port, Alternate email SSL port or Alternate email TLS port. This port is used to create a secure and encrypted link between the alternate SMTP server and RICOH ProcessDirector. Check with your network administrator to make sure this port is open.
      Note:
    • Depending on how your SMTP server is set up, either an SSL port, TLS port, or neither port are used. An SSL port and TLS port cannot be used at the same time. Check your alternate SMTP server settings to make sure which port is used.
  8. Click SAVE.

1.2.4.19.5 Progress updates

You can use the SendEmail step template or a notification object to send updates about the progress of jobs as they move through their workflows.

If you configure the system settings so the primary server can connect with an SMTP server, you can add the SendEmail step to workflows or create a notification object and configure it to send an email to one or more email addresses. When the job reaches that step or a specific job or printer event occurs, an email is sent to the specified email addresses.

When you add the step to a workflow, you can specify the subject line and the message text to include in the email. You can use symbol formulas in both the title and the message, so you can include job property values specific to the job in those fields.

For example, you can add the SendEmail step immediately after the PrintJobs step and send an email to the supervisor of the finishing line or bindery, so they know that the job is ready for them.

If you have service level agreements (SLAs) with your customers, you can add several SendEmail steps to a workflow for a particular customer. Each step can email the customer so they know when the job was ready to print, when it finished printing, and when it finished inserting.

When you add a notification object, you can specify the subject line, the message text to include in the email, the event that causes the system to send the notification, and the conditions that determine when the notification email is sent.

For example, you can set up one notification object to monitor when a printer enters the Needs attention state and send a notification email to one group if the printer problem occurs between 8:00 and 12:00. You can define a different notification object to send the same email to a different user if the printer problem occurs after 12:00.

    Note:
  • The SendEmail step only sends an email when the job reaches the step. If the job stops processing because of an error, notifications are not sent.
  • A notification object only sends an email when a specific event occurs and any conditions defined for the notification are met.
  • You can use an alternate SMTP server if the Alternate SMTP properties are set and the SMTP server type property is set to Alternate for the SendEmail step. All notifications, however, are sent through the default SMTP server.

1.2.4.20 Setting up the system to use a proxy server

You can configure RICOH ProcessDirector to connect to one or two proxy servers for communication with applications outside of your network.

Consult with your IT team to determine whether RICOH ProcessDirector must be configured to use proxy servers.

Input devices, steps, and notifications that communicate with other applications using web services each have a Use proxy property. Use this property to set which proxy server the objects use to send requests.

To set up the system to use a proxy server:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. Select the Proxy server tab.
  4. Fill in the properties for the first proxy server.
  5. Optional: Fill in the properties for the second proxy server.
  6. Click OK.
  7. Optional: For each step, input device, or notification that communicates with an application outside of your network using a web service, specify the appropriate proxy server in the Use proxy property of that object.

1.2.4.21 Notifications

You can configure these types of notifications and use the copy function to create additional notifications.

1.2.4.21.1 Email notifications

You can configure email notifications by doing the tasks described in this section.

After the initial configuration is complete, you should test your email notifications to make sure they work as you expect them to.

1.2.4.21.1.1 Changing your email address

Users defined in the RICOH ProcessDirector system can change their own email addresses.
To change your email address:
  1. Click the user icon in the top right corner and select Preferences.
  2. Enter the email address where you want to receive notifications in the Email address field.
    The value must match the format of a valid email address: username@mycompany.com
  3. Click OK.

1.2.4.21.1.2 Setting up email notifications

You can configure RICOH ProcessDirector to notify users by email when specific input device, printer or job events occur.
To set up an email notification:
  1. Make sure that you have an email server installed and that it is configured to let RICOH ProcessDirector send emails with it.
    All notifications use the default SMTP server only. You cannot use the alternate SMTP server.
  2. Make sure any users who you want to receive a notification have an email address specified in their User property notebook .
  3. Create one or more notification objects, one for every type of event that you want to be notified about.
  4. After you create a notification object, you can send a test email.
    To send a test email:
    1. Click the Administration tab.
    2. In the left pane, click Objects Notifications.
    3. Select the notification object that you want to test.
    4. Click Actions Send test email.
        Note:
      • The test email has the word TEST in the Subject line to indicate it is a test email. It has placeholders in the Subject and Message text for the inserts you specified, such as the input device, printer or job name.
  5. After the test completes successfully, enable the notification object.

1.2.4.21.1.3 Creating email notifications

You can use notifications to send emails to selected users when specific input device, job or printer events occur. You can create one email notification for each combination of event and recipients. For example, you can create one notification to send emails to the first shift operators when a printer enters an error state and another notification to send a slightly different email message to the second shift operators when the same printer event occurs.
To create an email notification:
  1. Click the Administration tab.
  2. In the left pane, click Objects Notifications.
  3. Click Add Email.
  4. Enter a name for the notification.
  5. Select the type of object to be monitored.
    You can only use one type of Event type for each notification.
  6. In the Recipient address field, enter the email addresses or the name of a RICOH ProcessDirector group of users you want to receive this notification mail.
  7. In the Subject line field, enter the subject for the notification message.
  8. In the Message field, enter the message that is sent to the users.
      Note:
    • In the Subject line and Message fields, you can have variable information inserted in the text using symbolic notation such as ${Printer.ID}.
  9. Optional: Specify the maximum number of messages that are sent in the time period that you specify.
  10. Optional: Specify that you want to attach the input device, printer or job log.
  11. In the Event tab:
    1. Select the property, the action, and the value to monitor.
    2. To define an additional event, click + to the right of any event.
    3. To delete an event, click - to the right of the event you want to delete.
  12. In the Conditions tab:
    1. Select the property and the value that must be satisfied before any notifications are sent.
    2. To define an additional condition, click + to the right of any event.
      Select Any, All, or Custom to specify how the conditions are combined.
    3. To delete a condition, click - to the right of the condition you want to delete.
  13. Click OK.
Example
A notification that notifies members of the Supervisor group when a job goes into an error state in the PDF or Billing workflow

For the General tab:

  • The Event type is Job.
  • The Recipient address is Supervisor.
  • The Subject line is Problem with job.
  • The Attach log is Yes to send the job log.
  • The Message is Job ${Job.Name} in workflow ${Job.JobType} has encountered an error.
      Note:
    • In the email message, the two symbolic references are filled in with the job name and the workflow for the job with the error.

For the Event tab:

  • The property is Job state.
  • The action is Changes to.
  • The value is Error.

For the Conditions tab:

  • Any is selected.
  • The first property is Child job type.
  • The comparison is =.
  • Value is PDF.
  • The second property is Child job type.
  • The comparison is =.
  • The value is Billing.

To understand the difference of where the parentheses are placed, consider this example:

  1. Input data stream = PDF
  2. Input data stream = PostScript
  3. Requested printer = Ricoh901C

If you specify ( 1 OR 2 ) AND 3 for the combination rules, the condition are met when:

  • The input data stream is PDF and the requested printer is Ricoh 901C.
  • The input data stream is Postscript and the requested printer is Ricoh 901C.

If you specify 1 OR ( 2 AND 3 ), the conditions are met when:

  • The input data stream is PDF. Any printer can be requested.
  • The input data stream is Postscript and the requested printer is Ricoh 901C.

1.2.4.21.2 History record notifications

You can configure history record notifications by doing the tasks described in this section.

After the initial configuration is complete, you should test your history record notifications to make sure they work as you expect them to.

1.2.4.21.2.1 Defining history record notifications

You can use notifications to create records to be saved as part of job history. You can define history record notifications to capture timestamps of job state changes as a job is processed in its workflow.
To define a history record notification:
  1. Click the Administration tab.
  2. In the left pane, click Objects Notifications.
  3. Click Add History Record.
  4. On the General tab, enter a name for the notification.
  5. On the Event tab:
    1. Select the property, the action, and the value to monitor.
      History record notifications can monitor only the Current job state property.
    2. To define an additional event, click the plus sign () to the right of any event. Events are combined with an OR so that a history record is written when any one of the events occurs.
    3. To delete an event, click the minus sign () to the right of the event you want to delete.
  6. On the Conditions tab:
    1. Select the property and the value that must be satisfied before any history record is recorded.
    2. To define an additional condition, click the plus sign () to the right of any condition.
      Select Any, All, or Custom to specify how the conditions are combined.
    3. To delete a condition, click the minus sign () to the right of the condition you want to delete.
  7. Click OK.

1.2.4.21.3 Copying notification objects

You can copy a notification and use it as a template for creating another notification. Copying notifications can save you time, especially when you need to create several notifications with similar properties.
To copy a notification:
  1. Click the Administration tab.
  2. In the left pane, click Objects Notifications.
  3. Right-click the name of the notification object that you want to copy, and select Copy.
  4. Fill in the properties.
  5. Click OK.

1.2.4.22 Web service notifications

You can configure REST and SOAP web service notifications.

1.2.4.22.1 Preparing to send status to REST web services

You can use notification objects to send status to a REST web service for an application. For example, you can create a notification object to monitor when a job enters the RetainCompletedJobs step in a workflow that processes orders. When that event happens, the notification object can send the application information about the job, such as the order number and customer name.
To prepare to send status to REST web services:
  1. Learn the requirements for communication with the REST web service for the application:
    • The values for authenticating with the application
    • The values for requesting data from the REST web service
    • The format of the data provided in the response

    Refer to the documentation for the application or consult with the company that hosts the application.

  2. To prepare RICOH ProcessDirector to communicate with the application, do these tasks:
    • If the application requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.
    • If your environment requires a proxy server to communicate with web services, set up the system to use it.

    For more information, see the related tasks.

  3. Run a manual test that authenticates with the application and requests a response from the REST web service. Verify that the web service returns the response that you want.
    Many browsers have plug-ins, such as Boomerang for Google Chrome, that test web service calls to REST clients.
  4. Decide on the event that you want to trigger the notification and the conditions that determine when the notification calls the web service.
    If you want to send a notification for an event that occurs only when a specific workflow processes a job, specify that workflow as a condition.
  5. Define a REST web service notification:
    1. Click the Administration tab.
    2. In the left pane, click Objects Notifications.
    3. Click Add REST Web Service Notification.
    As an alternative, you can copy the supplied RestfulWebServiceSampleNotify REST web service notification.
  6. On the General tab, type a name for the notification.
  7. On the Request tab:
    1. Set the Request URL property to the URL of the web service that you want to notify.
    2. Set the Request method property to the value required by the web service.
    3. For the value of the Request payload property, specify the body of the web services request that the input device submits to the application.
      In this XML example, the payload contains two XML elements: <Token> and <OrderNumber>.

      <Token>${WSNotification.WebService.Credential}</Token> <OrderNumber>${Job.Info.Attr1}</OrderNumber>

      The value for each element is a RICOH ProcessDirector symbol containing a property. If you are using a web service to authenticate with the application, include the WSNotification.WebService.Credential property in a symbol. Replace the other element and property with the elements and properties that you want to send to the application. The notification resolves the symbols when it sends status to the REST web service.

    4. Set the values for the Request header and Request parameters properties, as required.
      Each header field or parameter is a keyword/value pair. Each pair must appear on a separate line and must be separated using a colon (:) or equals sign (=).

      The keyword and value can be multiple words. RICOH ProcessDirector uses the first colon or equals sign on each line to split the words into the keyword/value pair.

      This example contains three parameters: token, orderNumber, and customerName. The value of each keyword is a RICOH ProcessDirector symbol. Each symbol contains one of these properties: WSNotification.WebService.Credential, Job.Info.Attr1, and Job.CustomerName.

      token:${WSNotification.WebService.Credential}orderNumber:${Job.Info.Attr1}customerName:${Job.CustomerName}

      The input device resolves the symbols when it sends status to the REST web service.

    5. If your environment requires a proxy server to communicate with web services, set the Use proxy property to the correct proxy server.
  8. On the Authentication tab, specify the values required to authenticate with the application.
    For more information, see the related task about authenticating with a REST web service.

    If the application does not require authentication, leave all the Authentication properties blank.

  9. On the Event tab:
    1. Choose the type of object to be monitored.
    2. Select the property, the action, and the value to monitor.
    3. To define another event, click + to the right of any event.
    4. To delete an event, click - to the right of the event you want to delete.
    For example, to send a notification when the state of a job changes to Retained, select Current job state, Changes to, and Retained.
  10. On the Conditions tab:
    1. Select the property and the value that must be satisfied before any notifications are sent.
    2. To define another condition, click + to the right of any event.
      To specify how the conditions are combined, select Any, All, or Custom.
    3. To delete a condition, click - to the right of the condition you want to delete.
    For example, to send a notification only when a child job is in the ProcessWebOrders workflow, specify two conditions:
    • Workflow = ProcessWebOrders
    • Job number like*.*

    To apply the conditions only when a job meets both of them, select All.

  11. When you finish, click OK.

When you finish setting up your input devices, notifications, and workflows, test the exchange of data between RICOH ProcessDirector and the application.

Example

Examine the supplied RestfulWebServiceSampleNotify REST web service notification.

1.2.4.22.2 Preparing to send status to a SOAP web service

You can use notification objects to send status to a SOAP web service for an application. For example, you can create a notification object to monitor when a job enters the RetainCompletedJobs step in a workflow that processes orders. When that event happens, the notification object can send the application information about the job, such as the order number and customer name.
To prepare to send status to a SOAP web service:
  1. Learn the requirements for communication with the SOAP web service for the application:
    • The values for authenticating with the application
    • The values for requesting data from the SOAP web service
    • The format of the data provided in the response

    Refer to the documentation for the application or consult with the company that hosts the application.

  2. To prepare RICOH ProcessDirector to communicate with the application, do these tasks:
    • If the application requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.
    • If your environment requires a proxy server to communicate with web services, set up the system to use it.
    • Import WSDL files for all the web services that you plan to call.

      RICOH ProcessDirector creates SOAP request objects from SOAP operations in the WSDL file. You specify a prefix that RICOH ProcessDirector adds to the names of the SOAP operations when it creates the objects. A SOAP request object lets RICOH ProcessDirector determine the SOAP version and other information required to make a correct call to the web service.

    For more information, see the related tasks.

  3. Run a manual test that authenticates with the application and requests a response from the SOAP web service. Verify that the web service returns the response that you want.
    Many browsers have plug-ins, such as Boomerang for Google Chrome, that test web service calls to SOAP clients.
  4. Decide on the event that you want to trigger the notification and the conditions that determine when the notification calls the web service.
    If you want to send a notification for an event that occurs only when a specific workflow processes a job, specify that workflow as a condition.
  5. Define a SOAP web service notification:
    1. Click the Administration tab.
    2. In the left pane, click Objects Notifications.
    3. Click Add SOAP Web Service Notification.
  6. On the General tab, type a name for the notification.
  7. On the Request tab:
    1. Set the Request URL property to the URL of the web service that you want to notify.
    2. For the value of the Request payload property, specify the body of the web services request that the notification submits to the application.
      In this example, the payload contains two XML elements: <Token> and <OrderNumber>.

      <Token>${WS.Notification.WebService.Credential}</Token> <OrderNumber>${Job.Info.Attr1}</OrderNumber>

      The value for each element is a RICOH ProcessDirector symbol containing a property. If you are using a web service to authenticate with the application, include the WSNotification.WebService.Credential property in a symbol. Replace the other element and property with the elements and properties that you want to send to the application. The notification resolves the symbols when it sends status to the SOAP web service.

    3. Set the SOAP request property to the SOAP request that RICOH ProcessDirector created when you imported the WSDL file.
      For example, you want to use the CloseoutOrderByNumber SOAP request. You prepended PrintShop to the names of the SOAP requests when you imported them. Select PrintShop-CloseoutOrderByNumber.
    4. If your environment requires a proxy server to communicate with web services, set the Use proxy property to the correct proxy server.
  8. On the Authentication tab, specify the values required to authenticate with the application.
    For more information, see the related task about authenticating with a SOAP web service.

    If the application does not require authentication, leave all the Authentication properties blank.

  9. On the Event tab:
    1. Choose the type of object to be monitored.
    2. Select the property, the action, and the value to monitor.
    3. To define another event, click + to the right of any event.
    4. To delete an event, click - to the right of the event you want to delete.
    For example, to send a notification when the state of a job changes to Retained, select Current job state, Changes to, and Retained.
  10. On the Conditions tab:
    1. Select the property and the value that must be satisfied before any notifications are sent.
    2. To define another condition, click + to the right of any event.
      To specify how the conditions are combined, select Any, All, or Custom.
    3. To delete a condition, click - to the right of the condition you want to delete.
    For example, to send a notification only when a child job is in the ProcessWebOrders workflow, specify two conditions:
    • Workflow = ProcessWebOrders
    • Job number like*.*

    To apply the conditions only when a job meets both of them, select All.

  11. When you finish, click OK.

When you finish setting up your input devices, notifications, and workflows, test the exchange of data between RICOH ProcessDirector and the application.

Example

The supplied RestfulWebServiceSampleNorify REST web service notification is similar to a SOAP web service notification. The MarcomCentral Connect feature includes a supplied SOAP web service notification.

1.2.4.23 Configuring control files for job audit information

RICOH ProcessDirector creates audit files that provide information about a specific job when it deletes the job from the system. Control files that use RICOH ProcessDirector symbol notation determine the values that RICOH ProcessDirector writes to the audit files for a job.
To configure control files for job audit information:
  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Navigate to /aiw/aiw1/samples/audit/.
  3. Copy the control file you want to modify to the /aiw/aiw1/control_files/audit/ directory.
  4. Use an editor, such as vi, to open the control file whose content you want to view or modify:
    Audit control file for jobs Purpose
    job_info_properties.cfg Defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.job_info_properties.cfg.csv audit file in the /aiw/aiw1/audit/Job directory. If the AFP Support feature is installed, records JCL information about jobs that are sent through Download for z/OS or AFP Download Plus.
    job_properties.cfg Defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.job_properties.cfg.csv audit file. Records basic job information for all jobs.
    line2afp_properties.cfg Defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.line2afp_properties.cfg.csv audit file. Records information that is specific to jobs whose workflow includes a step that uses line2afp to convert the job to the AFP format. This file is provided by the AFP Support feature.
    print_properties.cfg Defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.print_properties.cfg.csv audit file. Records information that is specific to jobs whose workflow includes a print step.
    transform_properties.cfg Defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.transform_properties.cfg audit file. Records processing information that is specific to jobs whose workflow includes a step that calls a data transform program.
  5. Review the properties that the control file specifies, and either add or delete properties as required. Initially specify the properties by their RICOH ProcessDirector database names in a comma-separated string. The second string that repeats the job properties and that includes quotation marks, delimits the comma-separated value string in the resulting audit file. These are examples of the strings formats in the job_properties.cfg file, and how the audit information displays in the resulting jobnumber.yy-mm-dd_hh-mm-ss.job_properties.cfg.csv audit file:
    Job.ID,Job.CustomerName,Job.Description
    "Job.ID","Job.CustomerName","Job.Description"
    
    Job.ID,Job.CustomerName,Job.Description
    "10000021.8","IBM","Monthly workload statistics"
  6. Save the changed file to the /aiw/aiw1/control_files/audit/ directory and close the file.
  7. To prevent an audit file from being written, delete the corresponding control file from the /aiw/aiw1/control_files/audit/ directory.

1.2.4.24 Configuring to send jobs to Ultimate Impostrip®

To send jobs to Ultimate Impostrip®, you must configure the Ultimate Impostrip® program, the primary computer, and some system settings, then tune the RunImpostripOnJob step template and add it to a workflow.
    Note:
  • If Ultimate Impostrip® is installed on a Windows computer running in a language other than English, do not install Ultimate Impostrip® in the default install directory. The program does not work properly with non-English default install paths. We recommend installing Ultimate Impostrip® in C:\ImpostripOnDemand on non-English Windows computers.

To configure to send jobs to Ultimate Impostrip®:

  • Configure Ultimate Impostrip®.
    1. Log in to the computer that Ultimate Impostrip® is installed on and launch the application.
    2. In the XML Configurator section, deselect Using First File Name as Output Name for XML Redirection Job (if it is available) and select Enable XML Ticket Input Folder, then click OK or SAVE.
    3. In the Hot Folders section, define the impositioning options for all hot folders that you want RICOH ProcessDirector to use.
    4. Select the hot folder you want to configure and find the Output section.
    5. Make sure that PDF or PDF Output is selected and click Save.
    6. Repeat the two previous steps for all hot folders that you want RICOH ProcessDirector to use.
  • Share folders and mount drives between Ultimate Impostrip® and RICOH ProcessDirector:
    1. On the Windows computer where Ultimate Impostrip® is installed, share the folder that Ultimate Impostrip® is installed in.
      On an English system, the default installation folder is:
      • Legacy Version: C:\Program Files (x86)\Ultimate Technographics\ImpostripOnDemand
      • New Generation: C:\Program Files\Ultimate Technographics\Ultimate Impostrip
    2. Name the share UltimateImpostrip. Do not include spaces in the share name.
      Make sure the permission level is Read/Write.
    3. On the RICOH ProcessDirector primary computer, mount the primary computer to the directory that holds the Ultimate Impostrip® program.
        Note:
      • Skip this step if you are using Ultimate Impostrip® New Generation (Version 2019 1.0 or newer) and it runs on a RICOH ProcessDirector application server.
      On the primary server, use a command similar to this example, substituting the name of Windows system for server_name and the name of the user that RICOH ProcessDirector uses to access the system for user:
      mount -t cifs -o username=user,uid=32457,gid=32458 //server_name/UltimateImpostrip /mnt/Ultimate
    4. Open the /etc/exports file in a file editor.
    5. Review the contents of the file to see if it includes an entry for the system that Ultimate Impostrip® is installed on. If you do not see an entry for that system, add a line to the file in this format:
      /aiw server_name(crossmnt,rw,no_root_squash,sync,no_subtree_check)

      Save and close the file. Restart NFS to have the updated file take effect.

    6. Return to the Windows computer where Ultimate Impostrip® is installed and open Windows File Explorer.
    7. Map a network drive to the /aiw file system on the primary computer. Use this address for the server: \\primary_server_hostname\aiw
    8. Test the configuration by creating a file in the drive_letter:\aiw1 directory, verifying that you can see it in the mounted directory, and then deleting it.
  • Update RICOH ProcessDirector system settings.
    1. Log in to RICOH ProcessDirector.
    2. Click the Administration tab.
    3. In the left pane, click Settings Ultimate Impostrip® Settings.
    4. In the General section, choose how RICOH ProcessDirector retrieves the list of Ultimate Impostrip® hot folders that can receive print jobs.
      The option you choose depends on the version of Ultimate Impostrip® you have installed. If you use version 10 or older, select Use .ini file. If you use version 2019 1.0 or newer, select Use URL.
    5. If you choose Use .ini file, enter the full path to the Ultimate Impostrip® initialization file on the system that Ultimate Impostrip® is installed on.
      The initialization file contains the name of the directory that RICOH ProcessDirector uses as a Sending folder if one is not provided on the step. It also contains a list of Ultimate Impostrip® input hot folders that correspond to different impositioning combinations.
        Note:
      • If the mount is set as explained above, use /mnt/Ultimate/IMPressJM.ini.
      • When this directory is specified, users can select from a list of Ultimate Impostrip® input hot folders to perform the appropriate impositioning on the job.
    6. If you chose Use URL, enter the URL of the Ultimate Impostrip® server, including the port number.
    7. Verify that the Ultimate Impostrip® configuration is set correctly. Scroll to the bottom of the page to see the Ultimate Impostrip® Hot Folders table. Click Update to show the available hot folders. Make sure all the hot folders you expect to see are included in the list.
    8. In the Mapping section, specify what type of Windows system Ultimate Impostrip® is installed on: a system that a RICOH ProcessDirector server runs on or a Windows system with no RICOH ProcessDirector server installed.
    9. If you chose Other Windows system, fill in the paths for the directories that exchange files between the Ultimate Impostrip® host server and the RICOH ProcessDirector primary computer.
      • XML Ticket Hot Folder

        If the mount is configured as explained above, enter the directory path that is appropriate for your version of Ultimate Impostrip® under RICOH ProcessDirector:

        • Legacy Version: /mnt/Ultimate/XmlInput
        • New Generation: /mnt/Ultimate/xml_redirection

      • Print spool directory

        Enter this value under Ultimate Impostrip®, replacing drive_letter with the letter of the network drive that you mapped above:

        drive_letter:\aiw1\spool

    10. Click SAVE.
  • Tune the RunImpostripOnJob step template to run on the correct server.
    1. Click the Workflow tab.
    2. In the left pane, click Step Templates.
    3. Right-click the RunImpostripOnJob step template and select Properties.
    4. On the Tuning tab:
      • If Ultimate Impostrip® is installed on an application server, under Servers to use, select Run on specific servers, then select the correct application server.
      • If Ultimate Impostrip® is installed on a different Windows computer, under Servers to use, select Run on specific servers, then select System.
  • Add the RunImpostripOnJob step template to a workflow.
    1. Click the Workflow tab.
    2. Select the workflow that you want to copy and click Copy workflow.
    3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    4. In the workflow editor, click Step Templates in the top right corner of the window.
    5. Drag the RunImpostripOnJob step into position and make sure it is connected to the workflow.
    6. Right-click the step and select Properties to see the properties and job defaults.
    7. Update the properties as needed. Refer to the ? help for additional information about each property.
    8. Click OK.
    9. Save the workflow.

1.2.4.25 Setting up datastream transforms

You can configure RICOH ProcessDirector to transform input data files to formats that your printers can print.

1.2.4.25.1 Transforming line data to AFP

RICOH ProcessDirector includes a transform that you can use to convert line data into an Advanced Function Presentation (AFP) format.

You can run the transform to complete a variety of tasks, including:

  • Convert line data and mixed mode data into the AFP data stream, a device-independent data stream that you can use to exchange documents between different platforms.
  • Index a document to enhance your ability to view, archive, or retrieve individual pages or groups of pages from large documents.
  • Retrieve and package the AFP resources needed to print or view a document and place them in a separate file. This lets you print and view an exact version of a document at any time.

The transform uses a page definition when it composes the data. Page definitions specify various characteristics of the page, including:

  • The printable area of the page
  • The maximum number of lines that can print on a page
  • The beginning print position on the page
  • The printing direction: across, up, or down the page
  • The page presentation: portrait or landscape
  • The fonts used to print each line of the page

You can use one of the page definitions that RICOH ProcessDirector provides or you can provide your own.

1.2.4.25.1.1 Configuring line data transform steps

You can incorporate the line data transform into a workflow by adding a ConvertLineDataJobIntoAFP step, then configuring it appropriately. These workflows include the ConvertLineDataJobIntoAFP step: LineData and DownloadLineData.
To configure a line data transform step, you must define or edit a workflow that includes the step. If you define a workflow, use the ConvertLineDataJobIntoAFP step template to add a step to the workflow.
After you have created a ConvertLineDataJobIntoAFP step, you can edit the job default properties that it sets.

To configure a line data transform step:

  1. Click the Workflow tab.
  2. Click the name of the workflow that you want to edit.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Right-click the ConvertLineDataJobIntoAFP step and select Properties.
    You see the properties for the step.
  5. Edit the properties of the step as needed.
      Note:
    • Click the Open embedded assistance icon to open descriptions for the properties.

    For additional assistance determining the correct values for the fields, particularly in creating the external control file template, the valid return codes, and the .parmdd parameter file, see AFP Conversion and Indexing Facility User's Guide (G550-1342).

    The default file that displays in the External control file template field is only a sample file. You must edit it to fit your environment. During processing, RICOH ProcessDirector uses the template to create a control file for each job that passes through the step.

  6. When you finish editing the properties, click OK.
  7. Save and enable the workflow.

1.2.4.25.1.2 Configuring to use inline resources with line data jobs

If you submit line data jobs with inline resources to a workflow that uses the ConvertLineDataJobIntoAFP step, most inline resources are ignored. To recognize and use other inline resources, you must update the ConvertLineDataJobIntoAFP step.
The inline resources are ignored because the value of the Resource type property for the ConvertLineDataJobIntoAFP step of the workflow contains these values: Form definition, Fonts, Inline. The value Inline indicates that RICOH ProcessDirector keeps all inline form definitions and fonts (the other values in the list) and does not write any other inline resources from the data stream to the output file. As a result, even if AFP Download Plus or Download for z/OS includes page definitions or other resources inline with the job, RICOH ProcessDirector does not write them to the output file. To keep additional inline resources, you must update the value of the Resource type property for the ConvertLineDataJobIntoAFP step in the workflow.

To configure to use inline resources with a line data print job:

  1. Click the Workflow tab.
  2. Click the name of the workflow that you want to edit, for example, DownloadLineData.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Right-click the ConvertLineDataJobIntoAFP step and select Properties.
  5. Click AFP.
    In the Resource type field, you see a list of resources with Inline and Form definition selected.
  6. Add other types of inline resources to the Resource type by holding the Ctrl key and selecting the types of resources in the list.
  7. Click OK.
  8. To save and enable the workflow, change , the Save & Enable/Disable switch, to the On position.

1.2.4.25.2 Activating the Adobe PDF Print Engine conversion program

You can use either the Adobe PDF Print Engine (APPE) or Configurable PostScript Interpreter (CPSI) conversion program to transform PDF data to AFP.
    Note:
  • If your primary server runs Red Hat 6.x or SLES 11, use CPSI to convert PDF data. APPE is not supported on those operating systems.

We recommend using APPE for these reasons:

  • Direct conversion of PDF data to AFP.

    CPSI first converts PDF data to PostScript, and then converts PostScript data to AFP.

  • Support for modern PDF capabilities such as transparency and drop shadows.
  • Better performance for color jobs.

By default, the TransformJobIntoAFP step uses CPSI to convert PDF data to AFP.

To activate the Adobe PDF Print Engine conversion program:

  1. Click the Workflow tab.
  2. Click the name of a workflow that includes the TransformJobIntoAFP step.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Click the name of the workflow.
  5. Right-click the TransformJobIntoAFP step and select Properties.
  6. On the External tab, find the External control file template property.
  7. Change the value of the property from /aiw/aiw1/control_files/external_programs/prepare_transform.cfg to /aiw/aiw1/control_files/external_programs/prepare_transform_APPE.cfg.
    Both control files convert PostScript, PCL, and SAP data to AFP.
  8. Click OK.
  9. Save and enable the workflow.

1.2.4.25.3 Setting up user exit programs

RICOH ProcessDirector can call user exit programs that can modify the AFP print file for a job before or after it prints. Authorized users can modify and compile the sample exit programs that RICOH ProcessDirector provides or they can write their own. RICOH ProcessDirector provides sample exit programs in the /usr/lpp/psf/exits (Linux) or C:\Program Files (x86)\Ricoh\PSF\exits (Windows) directory.
The sample job completion user exit writes job statistics to the /Ricoh/var/psf/ (Linux) or \PSF\var\psf\ (Windows) jobcompletion.log file. In the log entries, RICOH ProcessDirector appends aiw1 to the printer name as it appears in the RICOH ProcessDirector user interface.

To set up a user exit program:

  1. In the Printers Portlet, select the printer that you want to assign a user exit program to.
  2. Click Disable.
  3. Select the printer again and click Properties.
  4. In the properties notebook for the printer, click Exits.
  5. Enable the types of user exit programs that you want the printer to call by setting one or both of these properties to Yes:
    • Enable input data exit

      This exit program modifies the contents of the AFP print file before RICOH ProcessDirector sends the print file to the printer.

    • Enable job completion exit

      This exit program modifies the contents of the AFP print file after the printer reports that the job has printed.

  6. Specify the name of the compiled version of the user exit program for one or both of these properties:
    • Input data exit program
    • Job completion exit program
      Note:
    • If the compiled version of the user exit program resides in the /usr/lpp/psf/bin (Linux) or C:\Program Files (x86)\Ricoh\PSF\bin (Windows) directory, you do not need to include the path. If it resides in a different location, you can specify a path with the program name. The value for the combined path and program name can be up to 255 characters.
  7. Click OK.
  8. Select the printer and click Enable.

1.2.4.25.4 Configuring for the RICOH Transform features

If you have installed one or more of the RICOH Transform features, you can configure RICOH ProcessDirector to use these features.
The AFP Support feature must be installed before you can perform this procedure.
    Note:
  • This procedure is for use with the RICOH Transform features, such as RICOH PostScript/PDF to AFP, RICOH SAP to AFP, RICOH PCL to AFP, and RICOH AFP to PDF, not the Advanced Transform feature.

You can install the RICOH Transform features on the primary computer or on another computer. The Secondary Server feature is not required if you install the RICOH Transform featurese on a computer other than the primary computer.

After you have identified the Transform Features to RICOH ProcessDirector, you can define an input device that receives jobs to be transformed and a workflow that sends jobs to be converted.

To configure for the RICOH Transform features:

  1. Log in to the InfoPrint Manager Transform Feature user interface.
  2. Record the IP address or host name and port number of the transform server you want RICOH ProcessDirector to use.
    The Transform Features can be configured to run on multiple servers. Only the primary transform server is added to RICOH ProcessDirector.
  3. Log in to RICOH ProcessDirector.
  4. Click the Administration tab.
  5. In the left pane, click Settings System.
  6. Make sure that the Transform server IP address or host name property is the IP address or host name of the computer where the transform feature is installed.
    If the with the transform feature has two network cards, it has two IP addresses, but RICOH ProcessDirector uses only one. Make sure that the property is set to the correct IP address.
  7. Make sure that the Transform server port number property matches the port number that is configured for the computer where the transform feature is installed.
  8. Click SAVE.
  9. Edit the TransformJobIntoAFP or TransformJobIntoPDF step template to set job property defaults.

1.2.4.25.5 Configuring for the Advanced Transform feature

If you have installed one or more input and output transforms for the Advanced Transform feature, you can create workflows that use those transforms.
Installation of the Advanced Transform feature is not complete until you install license keys for the input and output transforms that you want to use.

1.2.4.25.5.1 Creating workflows that use input and output transforms

After you install one or more input and output transforms for the Advanced Transform feature, you can create workflows that use those transforms.
To create workflows that use input and output transforms:
  1. Click the Workflow tab.
  2. Create workflows for each transform that you want to support:
    1. In the Workflow tab, right-click a workflow that you want to use as a model and select Copy.
    2. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    3. Add a step based on the TransformWithAdvancedFeature step template to the workflow.
    4. Right-click the step and select Properties.
    5. Click Transform, and update the Transform input stream and Transform output stream properties appropriately.
      If the workflow processes jobs in various datastreams, set Transform input stream to Use current. This setting is also appropriate for jobs that contain multiple data types, such as AFP print jobs that include images or PDF files in object containers.
    6. Update the properties for the other steps in the workflow with the values that you need.
    7. Save and enable the workflow by changing , the Save & Enable/Disable switch, to the On position.

1.2.4.25.5.2 Creating a workflow that transforms AFP or PostScript input to PDF output with media information

If you have installed the Advanced Transform feature, you can create a workflow that transforms AFP or PostScript input into PDF output. The transform also generates a JDF job ticket that has media information, including page exceptions.
To create this workflow, you must have at least one of the following input transforms for the Advanced Transform feature:
  • InputAFP
  • InputPS

To create the workflow, you must also have the OutputPDF output transform.

When the TransformToPDFWithMediaInfo step in the workflow generates the JDF job ticket, it uses the media names in the AFP or PostScript input, for example, TRAY1. The media names in the JDF job ticket must match the names of RICOH ProcessDirector media objects. You can use any of these methods to make the media names match:

  • You can change the media names in the AFP or PostScript input.
  • You can create RICOH ProcessDirector media objects with the same names as the media names in the AFP or PostScript input.
  • You can create a media mapping file that maps the media names in the AFP or PostScript input to the names of RICOH ProcessDirector media objects.

If any media name in the JDF job ticket is not defined as a RICOH ProcessDirector media object when the TransformToPDFWithMediaInfo step finishes processing a job, the job goes into the error state. The Reason for wait status value is No matching media.

To create a workflow that transforms AFP or PostScript input to PDF output with media information:
  1. Click the Workflow tab.
  2. Right-click a workflow that you want to use as a model and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Add a step based on the TransformToPDFWithMediaInfo step template to the workflow.
    1. Make sure that you update the value of the Transform input stream property appropriately.
    2. To map the media names in the AFP or PostScript input to the names of RICOH ProcessDirector media objects, create a media mapping file.

      For information about creating a media mapping file, see the related task topic.

    3. If you created a media mapping file, specify the full path and name of the file as the value of the Path to media mapping file property.
    4. If you are retrieving media information from an AFP data stream, edit the value of the Media information command property. Add the -enablefdp argument between the input argument, -i, and the type argument, -type.

      This example shows the edited command:

      perl ${AIWDATA}/bin/callxform.pl -C ${getControlFileName()} -i ${getCurrentFile(${Job.Transform.InputStream})} -enablefdp -type xif -loglevel I -logdate -logtime -logdir ${Job.SpoolFileStem}tmp -logfile ${Job.ID}.xif.log -verbose -relaxed -msg.add PSI3002 -remove abcefhilnoprst01234

      If you are retrieving media information from a PostScript data stream, the command works without any edits.

    5. Update the other properties for the step with the values that you need.
  5. Update the properties for the other steps in the workflow with the values that you need.
  6. Save the workflow.
  7. Enable the workflow and test it.

1.2.4.25.5.2.1 Mapping AFP or PostScript media names to RICOH ProcessDirector media names

You can create a media mapping file to map media names in the AFP or PostScript input to RICOH ProcessDirector media names. A step based on the TransformToPDFWithMediaInfo step template uses the file when it transforms AFP or PostScript input into PDF output. The step creates a PDF file for the job and a JDF job ticket with media information, including page exceptions.

To map AFP or PostScript media names to RICOH ProcessDirector media names:

  1. Use a text editor to create the media mapping file.

    If RICOH ProcessDirector media names include Unicode characters, create the file with an editor that saves text in UTF-8 format.

  2. On the first line, type the media name in the AFP or PostScript input followed by an equals sign (=) and the corresponding RICOH ProcessDirector media name.
  3. Type each remaining media name in the AFP or PostScript input, one per line, followed by an equals sign (=) and the corresponding RICOH ProcessDirector media name.
  4. You can add comment lines to the file. Start each comment line with a pound sign (#).

    For example, you can add this comment as the first line in the file:

    # AFPorPSmedia=RPDmedia

  5. Save the file.
  6. Specify the full path and name of the file as the value of the Path to media mapping file property of the TransformToPDFWithMediaInfo step.

This example maps four AFP or PostScript media names (A4, Letter, TRAY1, and TRAY2) to four RICOH ProcessDirector media names:

# AFPorPSmedia=RPDmedia
A4=A4 Plain
Letter=Letter Color
TRAY1=Letter Preprinted
TRAY2=A3 Plain

If the file maps the same AFP or PostScript media name to different RICOH ProcessDirector media names, the system uses the last mapping of the AFP or PostScript media name. The RICOH ProcessDirector media name in the last mapping replaces the AFP or PostScript media name in the JDF file.

If any media name in the JDF job ticket is not defined as a media object in RICOH ProcessDirector, the job goes into the error state. The Reason for wait status value is No matching media.

1.2.4.26 Setting up Deadline Tracker

After you read the Deadline Tracker overview topics, set up Deadline Tracker by doing the configuration tasks described in this section.

After the initial configuration is complete, test your Deadline Tracker workflows to make sure they work as you expect them to.

1.2.4.26.1 Defining expected work

Expected work represents jobs that are expected to arrive before a specific time or during a particular interval. You set up expected work objects and associate them with input devices so the input devices can monitor for the work that is supposed to arrive and warn you when that work is late.
To define expected work:
  1. Click the Administration tab.
  2. In the left pane, click Objects Expected Work.
  3. Click Add.

    After you add your first expected work object, you can copy it instead of adding an object.

  4. Fill in values for the required and optional properties.
    To see information about any of the properties, click the Question mark icon icon next to the property name.
  5. Click OK.
  6. Associate the expected work object with one or more input devices:
    1. Disable and disconnect the input device.
    2. Open the property notebook for the input device.
    3. On the General tab, find the Associated expected work property and choose one or more expected work objects.
    4. Click OK.
    5. Enable and connect the input device.

      The input device does not start monitoring for expected work until the start date and time that you selected when you created the expected work object. After that date and time, the input device starts monitoring and reporting status at the chosen intervals.

You can export entries in the Expected work table to a Comma-Separated Values (CSV) file. Click the Gear menu button in the top right corner of the page and select Export table to CSV. The exported list contains only entries for expected work objects that match all the filters that are set. For example, you type statements in the filter field Funnel icon. The list in the CSV file contains only the entries for expected work with statements in the expected work name or description. The entries are sorted by expected work name.
    Note:
  • You can set up a notification object to send an email when expected work for an input device is late.
  • If you have the Web Service Enablement feature, you can set up a notification object to issue a SOAP or REST web service call when expected work for an input device is late.

1.2.4.26.2 Setting deadlines for jobs

You can set a deadline for each job that enters a workflow. To create a deadline, you add a step based on the SetDeadline step template to a workflow, specify a deadline date and time (or an offset from another date and time), and select the step that the job must complete to meet the deadline.

Setting a deadline for a job is different from setting an SLA target step. If the SLA target step does not complete in the specified time, the SLA outcome is changed to Missed and cannot be reset for the job. Deadlines are used to track the progress of a job and report outcomes. If you want to monitor progress at different point in a workflow, you can set multiple deadlines for the same job. The Deadline outcome reflects the result of the most recent deadline and is reset whenever a new deadline is set. For example, you set a deadline of 3:00 to finish the print step and 5:00 to finish an insertion step. At some point, a job misses the print deadline by 5 minutes, but it still meets the insertion deadline. The final value of the Deadline outcome property is Met even though a previous deadline (for print) was missed.

If you choose to set both an SLA target step and a deadline set by a SetDeadline step in the same workflow, we recommend that you select the same step for the SLA target step and the last Deadline step. With that configuration, you can track to the deadline step to give operators time to recover if the job falls behind, but also record the final SLA outcome for the job.

You must decide how many SetDeadline steps you need and where to place them in your workflow. A workflow can have multiple deadlines, but only one deadline is active for a job at any time as the job moves through the workflow.

No-service periods are not included when calculating predicted completion times but they are used when setting SLA outcome.

    Note:
  • The Change Deadline action lets you set or change a deadline for a job, even if the workflow does not include a SetDeadline step.

To set a deadline for each job that enters a workflow:
  1. Click the Workflow tab.
  2. Click the name of the workflow.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Select the SetDeadline step template and drag it into the workflow editor. Place the step where you want it.
    Keep these considerations in mind:
    • If you want to set a deadline as soon as a job enters the workflow, place the step near the beginning of the workflow, for example, after the DetectInputDataStream step.
    • If you want to set a deadline that starts when a step processes a job, place the SetDeadline step before the step that processes the job. Make the deadline relative to the Current time property.
    • If the workflow processes child jobs and you want them to inherit the deadline from the parent job, make sure that all the child jobs are processed by the SetDeadline step that sets the value of the Inherit deadline from parent job property to Yes.
    • For conditional workflows, you can create connectors with conditional processing rules that compare the Deadline, Deadline step, Deadline outcome, and Predicted outcome properties to specified values. If you want RICOH ProcessDirector to evaluate these conditions for the jobs in the workflow, the jobs must complete a SetDeadline step before they reach the connectors.
  6. Right-click the new SetDeadline step and select Properties.
  7. Click Deadline. Do these steps:
    1. Set the Deadline step property by selecting the step that a job must complete to meet its deadline.
      For example, if the job must be printed by a certain time to meet its deadline, select the PrintJobs step.
    2. Set the Deadline date property, which specifies the settings used to set the date for the deadline.
      If you select Relative to property value, you can select any property that has a timestamp for a value. Specify an offset to the timestamp to set the deadline time. The property that you select should have a timestamp value set when the SetDeadline step runs. Until a timestamp value is set for the property, RICOH ProcessDirector cannot tell you if a job is on schedule to make its deadline.
        Important:
      • Do not select the Deadline property.
    3. Set the properties that specify the deadline time.
    4. Set the Inherit deadline from parent job property to specify whether a child job inherits a deadline from its parent job.
    5. If a workflow has two or more SetDeadline steps, set the Override existing deadline property.
      If you set this property to Yes, the deadline set by this step overrides an existing deadline set by another SetDeadline step. If you set the property to No, the workflow does not set this deadline if another deadline is active.
        Note:
      • Setting this property to No is useful in a conditional workflow when steps from one branch arrive at the SetDeadline step with a deadline already set and steps from another branch arrive at the SetDeadline step without a deadline.
    6. When you finish, click OK.
  8. Repeat these steps for each SetDeadline step that you place in the workflow.
  9. Save and enable the workflow.

1.2.4.26.3 Setting estimated durations for steps in a workflow

You can set the estimated durations for each step in a workflow and use these values to track the progress of jobs through the workflow. Using the estimated durations, the system provides a predicted completion time. The system also provides a predicted path of the job.
Before you do this procedure:
  • Decide which steps need estimated durations. We recommend that you set estimated durations for all the steps in a workflow through the last step that you want to track. You can set an estimated duration of 1 second for a step like DetectInputDataStream, which takes almost no time to complete. You should always specify estimated durations for steps like RunExternalProgram and PrintJobs, which can take a long time to process. In general, steps that process PDF documents, like ReversePDFPageOrder and PreparePDFOutputForFinishing, can take a long time. You should also set estimated durations for manual steps.
      Note:
    • If you are tracking to a schedule and a deadline, we recommend that you give the step that you select as the Deadline step an estimated duration. The estimated duration helps RICOH ProcessDirector track the Predicted outcome for the jobs in the workflow.
  • Make sure you account for the total time required by a step. For example, you have a 100-page per minute printer. You can estimate the duration of the PrintJobs step for that printer in pages per minute. When you account for paper and toner changes, the actual print speed in your environment might be 50 pages per minute. Set the estimated duration to the actual print speed: 50 pages per minute.
  • To determine how long a step takes to process, you can look at the start and stop times for the step in the job log. Filter on state changes to see each job’s processing time.
  • The last time-sensitive step in your workflow should be the last step with an estimated duration. If the last time-sensitive step is PrintJobs, make that the last step with an estimated duration. Do not set an estimated duration for a step like RetainCompletedJobs.
To set estimated durations for the steps in a workflow:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Right-click in the workflow editor and select Estimated durations.
  5. Select one or more steps that you want to set an estimated duration for. Do these steps:
    1. For the Volume and Volume unit properties, specify the number of jobs or pages that are used to calculate the estimated duration.
      If the estimated duration is for one job, type 1 and select Job(s). If the estimated duration is for 100 pages, type 100 and select Page(s).
    2. For the Time and Time unit properties, specify the estimated duration.
      If the estimated duration is five minutes, type 5 and select minutes. If the estimated duration is two hours, type 2 and select hours.
    3. Set the value for the Include property to Yes.
      If you do not want to include the estimated duration for the step in the calculation of the estimated duration for the job, set the property to No.
    4. If you updated the property values for multiple steps using Edit Multiple, click Apply to Selected to apply the changes.
    5. Repeat for these steps for each step that you want to set an estimated duration for.
      If you have multiple copies of a long-running step in a workflow and you want their estimates to be the same, sort the table by the Step template column so that all those steps are together. Select the steps and use the Edit multiple area to set the properties for all the steps at once.
    6. When you finish, click OK.
  6. Save the workflow.
After you have set estimated durations for steps, you can you can set up one or more email notifications that watch for the Tracking status or Predicted outcome properties for a job to Behind schedule or May miss and send an email to one or more users to alert them that a job is in danger of missing its schedule.

1.2.4.26.4 Setting up service policies

Service policies define checkpoints and a deadline for jobs. Checkpoints help you see if jobs are on schedule to meet the performance commitments in a service level agreement (SLA); the SLA deadline represents the ultimate goal of the SLA.
RICOH ProcessDirector provides sample service policies that you can use. You can also create your own service policies.
To set up service policies:
  1. Create one or more service policies.
  2. If a service policy specifies that RICOH ProcessDirector is to adjust job checkpoints for no-service periods, create one or more no-service periods.
  3. Associate each service policy with one or more workflows.

1.2.4.26.4.1 Using supplied service policies

RICOH ProcessDirector provides these predefined service policies: 3-day cutoff and 24 hour. You can change the properties of the supplied service policies and use them in your installation. Or, you can delete them if they are not useful.
To use a supplied service policy:
  1. Click the Administration tab.
  2. In the left pane, click Objects Service Policies.
  3. Right-click the service policy that you want to use and select Properties.
  4. In the properties notebook, click the tabs to see different properties, or click Show all to display all the properties on a single page. To see information about any of the properties, click the Question mark icon icon next to the property name.
  5. Make the appropriate changes.
  6. Click OK.
  7. Assign the service policy to one or more workflows.

1.2.4.26.4.2 Creating service policies

You can create service policies to define job checkpoints. Job checkpoints let you track the progress of jobs as they flow through the system to see if the jobs are on schedule to meet the performance commitments in a service level agreement (SLA). Service policies are not used when tracking to a schedule based on estimated durations or to a deadline set by a SetDeadline step or the Change Deadline action.

You can create a service policy for each performance commitment. For example, you can create one service policy for jobs that need to be printed in 1 day, and another service policy for jobs that need to be printed in 2 days.

The service policy contains the time zone where jobs are printed. If jobs can be printed in different time zones, you can copy the service policy to create service policies for the other time zones. For example, create one service policy for the US/Eastern time zone, and then copy it to create another service policy for the US/Mountain time zone.

To create a service policy:
  1. Click the Administration tab.
  2. In the left pane, click Objects Service Policies.
  3. Click Add.
  4. On all the tabs, fill in the required and optional properties. To see information about any of the properties, click the Question mark icon icon next to the property name.
  5. Click OK.

1.2.4.26.4.3 Copying service policies

You can copy a service policy so you can use it as a template for creating another service policy. Copying service policies can save you time, especially if you need to create several service policies with similar properties.
To copy a service policy:
  1. Click the Administration tab.
  2. In the left pane, click Objects Service Policies.
  3. Right-click the service policy that you want to copy and select Copy.
  4. On all the tabs, fill in the required and optional properties that you want to change. To see information about any of the properties, click the Question mark icon icon next to the property name.
  5. Click OK.

1.2.4.26.4.4 Associating service policies with workflows

You can associate a service policy with one or more workflows. The service policy calculates the planned checkpoints and the SLA deadline for all jobs that use the workflow. Each workflow can have one associated service policy. To measure the performance of jobs using an SLA deadline, you must also identify an SLA target step for the workflow.

If more than one service policy applies to a workflow, you might need to create additional workflows. For example, if you have created two service policies – one for jobs from client ABC and another for jobs from client XYZ – and both clients use workflow PDF, you could create another PDF workflow. The workflows can have identical properties except for the associated service policy. You might, for example, name the two workflows PDF.ABC and PDF.XYZ.

If you change which service policy is associated with a workflow, RICOH ProcessDirector uses the new service policy to set the checkpoints and deadline for new jobs that arrive in the system. It does not use the new service policy for existing jobs unless you use the Process Again action to reprocess a job from the first step.

If you delete a no-service period, checkpoint and deadline times for jobs that are already in the system do not change, even if they were set using that no-service period. To reset the checkpoint times, you must reprocess the job from the beginning.

If a workflow or an authorized user changes the Adjusted arrival time property for a job, RICOH ProcessDirector recalculates the checkpoints for the job. Depending on the service policy, sometimes the checkpoints and the deadline change:

  • If the service policy specifies the Cutoff adjustment method and a start time that is later than the old adjusted arrival time and earlier than the new adjusted arrival time, the checkpoints change from the day of the old adjusted arrival time to the day after the new adjusted arrival time.
  • If the service policy specifies the Cutoff adjustment method and a start time that is later than both the old and new adjusted arrival times, the checkpoints remain the same.
  • If the service policy specifies Elapsed time as the Deadline calculation method, the SLA deadline is recalculated from the Adjusted arrival time.
  • If the service policy specifies Specific time as the Deadline calculation method, the SLA deadline is not recalculated.

To associate a service policy with a workflow:
  1. Click the Workflow tab.
  2. Optional: Right-click the name of the workflow and select Disable.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  3. Right-click the name of the workflow and select Properties.
  4. In the Service policy property, select the service policy.
  5. In the SLA target step property, select the step that represents the ultimate goal of the SLA.
    For example, if the SLA relies on printing the job by a given time, select the PrintJobs step. If the SLA relies on delivering the printed output to another department for inserting, you can create a manual step called DeliverToInserter and select that step as the SLA target step.
  6. Click OK.
  7. Save and enable the workflow.

1.2.4.26.5 Setting up no-service periods

No-service periods define the periods of time when your installation does not provide services (for example, holidays and weekends). Each service policy specifies whether all the no-service periods apply to the service policy.
Note: No-service periods are not considered for deadlines set with the SetDeadline step in a workflow or the Change Deadline action on the job.
RICOH ProcessDirector provides sample no-service periods that you can use. You can also create your own no-service periods.

Each no-service period describes one period of time (for example, one holiday). All the no-service periods work together as one unit.

A service policy can specify whether all the no-service periods apply to the policy. However, a service policy cannot specify which no-service periods apply.

To set up no-service periods:
  1. Create one or more no-service periods, one for each time period.
  2. In each service policy, specify whether to adjust planned checkpoints for the no-service periods.

1.2.4.26.5.1 Using supplied no-service periods

RICOH ProcessDirector provides these predefined no-service periods: Every Saturday, Every Sunday, and January 1. You can change the properties of the supplied no-service periods and use them in your installation. Or, you can delete them if they are not useful.

In each service policy, you must specify whether the no-service periods apply. If they apply, RICOH ProcessDirector adjusts the planned checkpoints of jobs so that they do not occur during the no-service periods.

To use a supplied no-service period:
  1. Click the Administration tab.
  2. In the left pane, click Objects No-Service Periods.
  3. Select the supplied no-service period and click Properties, or click the no-service period name.
  4. In the properties notebook, make the appropriate changes. To see information about any of the properties, click the Question mark icon icon next to the property name.
    Notice that the Year property in all supplied no-service periods is 2006. To use the no-service period, change the Year property to the current year or leave the Year property blank if the no-service period applies to all years.
  5. Click OK.

1.2.4.26.5.2 Creating no-service periods

You can create a no-service period for each time when your installation does not provide services (for example, a holiday).
The service policy specifies whether all the no-service periods apply to the service policy. If they apply, RICOH ProcessDirector adjusts the planned checkpoints of jobs so that they do not occur during the no-service periods.

All the no-service periods work together as one unit. A service policy can specify whether all the no-service periods apply to the policy. However, a service policy cannot specify which no-service periods apply.

If a no-service period applies to every day of a month or year, you can select All in the Day property. However, if a no-service period applies to every day of a week, you must create one no-service period for each day. For example, if no service is provided:

  • From 16:00 to 23:59 every day of the year, create 1 no-service period object and select All in the Day property.
  • For one week in a year, create 7 no-service period objects: one for each date.

To create a no-service period:
  1. Click the Administration tab.
  2. In the left pane, click Objects No-Service Periods.
  3. Click Add.
  4. Fill in the required and optional properties. To see information about any of the properties, click the Question mark icon icon next to the property name.
  5. Click OK.
      Note:
    • No-service periods are not considered for deadlines set with the SetDeadline step in a workflow or the Change Deadline action on the job.

1.2.4.27 Configuring to use Reports

After you read the Reports overview and usage scenario, configure to use Reports by doing the tasks described in this section.

After the initial configuration is complete, test your data collection to the Reports database tables to verify that the data you expect is being collected.

1.2.4.27.1 Configuring to connect to the Reports database

RICOH ProcessDirector stores the data collected by data collectors and WritePropsToReportsDatabase steps in a PostgreSQL database.

The easiest way to set up the Reports database is to use the instance of PostgreSQL installed with RICOH ProcessDirector. If you choose this option, at the end of this procedure, the application creates a new PostgreSQL database system and database to store the collected data.

Note: If you use IBM DB2 as your main database, you must install Docker Engine on your primary computer to use this option. The PostgreSQL database provided with RICOH ProcessDirector comes in a Docker container. If you do not want to install Docker Engine, you can use a PostgreSQL database installed independently.

If you cannot or do not want to use the PostgreSQL provided with RICOH ProcessDirector, you can install your own PostgreSQL. This instance can be installed on the primary computer or on another computer in your network. If you choose this option, create a PostgreSQL database system, a database, and a database user ID before you start this procedure. Make sure the correct ports are open to permit communication between the systems.

To change the database after it is created, such as to move it to a different server or to connect to a centrally managed PostgreSQL database in your production environment, you must create the new database outside of RICOH ProcessDirector. Then, you can update the database settings in RICOH ProcessDirector to connect to the new database.

To configure to connect to the Reports database:
  1. Click the Administration tab.
  2. In the left pane, click Reports Database Settings.
  3. Set the PostgreSQLserver IP address or host name property to communicate with the database.

    • If you are using the PostgreSQL provided by RICOH ProcessDirector, set the value to: localhost
    • If you are using a PostgreSQL outside of RICOH ProcessDirector, set the value to the IP address or host name of the system the database is installed on.

      Note: Even if you install this database on the primary computer, do not set the value to localhost. Use the IP address of the primary computer.

  4. Review the current values for the other properties and make any required updates.
    To see information about any of the properties, click the question mark button next to the property name.
  5. Click SAVE.
      Note:
    • RICOH ProcessDirector does not collect data during job processing until you enable data collection and also enable one or more Data Collectors or add a WritePropsToReportsDatabase step to a workflow.
  6. When you are certain that the database settings are correct, click the Data Collection switch at the top of the Database Settings page and click Save to enable data collection.

    If you use the RICOH ProcessDirector PostgreSQL, the first time you enable data collection, the database is created using the property values that you specified. If you use a different PostgreSQL, the application connects to the database you created.

    Disabling data collection disconnects RICOH ProcessDirector from the database. Enabling data collection re-establishes the connection.

    Note:
  • Updating properties on this page does not update the database. You must use PostgreSQL metacommands or another interface to make changes to the database, then update these properties to match.

    For example, your corporate guidelines require all passwords to be reset every 90 days. To update the password that RICOH ProcessDirector uses to access the PostgreSQL database, you must:

    1. Update the password in the database using metacommands or a separate user interface.
    2. Update the password on the Database Settings page.

1.2.4.27.2 Configuring data collectors

You can use data collectors to capture property values and store them in tables in the Reports database. Each property is stored in a column in the database table specified in each data collector.
Before you do the steps in this procedure, determine which property values to capture and when to capture them.
    Note:
  • If you are only collecting information by adding steps to your workflow, you do not have to configure the data collectors to capture job and printer properties.

You can configure each data collector to store the values for different properties. When enabled, the data collectors run at different times during job processing or when certain actions are executed. You can configure these data collectors:

  • Job Step Duration

    Captures information about how long each step was in the queued and processing states, as well as the total duration for each step to complete processing. The Job Step Duration data collector can also collect job properties at the completion of each step and when the workflow completes.

  • Job Step Progress

    Captures job properties at the start and completion of each step in the workflow.

  • Job Print Status

    Captures job and printer properties when a job starts printing, when it finishes printing successfully, and when a job stops printing due to an error.

  • Printer Status

    Captures printer properties each time that the Enabled status or Printer status changes for any printer.

  • User Actions on Barcode Readers

    Captures the barcode reader and user properties when a user does an action on a barcode reader.

  • User Actions on Input Devices

    Captures the input device and user properties when a user does an action on an input device.

  • User Actions on Inserters

    Captures the inserter controller and user properties when a user does an action on an inserter.

  • User Actions on Jobs

    Captures the job and user properties when a user action does an action on a job.

  • User Actions on Printers

    Captures the printer and user properties when a user does an action on a printer.

  • User Actions on Users

    Captures the user and target user properties when a user does an action on a target user.

  • Workflow Step Collector

    Removes the expired entries collected during the WritePropsToReportsDatabase step.

To configure data collectors:
  1. Click the Administration tab.
  2. In the left pane, click Reports Data Collectors.
  3. Select one of the data collectors provided with RICOH ProcessDirector.
  4. Review the current values for the properties and make any required updates.
    To see information about any of the properties, click the question mark button next to the property name.
  5. When all the settings are configured correctly, click the switch at the top of the dialog to enable the data collector.
    The data capture starts when a data collection event occurs, for example, a job enters a step, printing starts, or the printer status changes when an input device is enabled.
      Note:
    • Data collection must be enabled for data collectors to store information in the database. If you enable one or more data collectors while data collection is disabled, the data collectors do nothing. When the data collection is enabled, enabled data collectors start to capture data when a data collection event occurs, for example, a job enters a step, printing starts, the printer status changes, or when an input device is enabled.
  6. Click OK.

1.2.4.27.3 Adding steps that store property values in the Reports database

You can add steps to your workflows to capture job and document property values and store them in the Reports database.
Before you do the steps in this procedure, determine which job and document properties you want to capture and when you want to capture them. The properties you select should relate to the type of reports you want to generate from the data.
To add steps that capture property values in a PostgreSQL database:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Add the WritePropsToReportsDatabase step to the workflow.
  5. Right-click the step and select Properties.
  6. Click the Reports tab.
  7. In the Job properties to write and Document properties to write fields, select the property values that you want to store in the PostgreSQL database.
      Note:
    • Some property values are blank until after a certain point in a workflow. For example, a job does not have a value for Assigned to printer (Job.Print.AssignPrintTime) until the job is sent to the printer in the PrintJobs step. If you store Assigned to printer to the PostgreSQL database before the PrintJobs step runs, the property is present in the database table, but the value is blank.
  8. To include a label in the database for the information that the step stores, enter a value for Event type.
  9. Fill in values for the other properties as needed.
    You must use different table names for the Document properties table and Job properties table properties. The values you use must also be different from the Database table names specified in the data collectors.
  10. Click OK.
  11. Optional: If you want to collect data at other points in the workflow, add another WritePropsToReportsDatabase step and update its properties.
  12. Save and enable the workflow.

1.2.4.27.4 Configuring to extract data to a remote server

If you need to send data collected in the Reports database to another application that does not support the REST protocol, you can use PostgreSQL commands to extract the data following this procedure.
To configure to extract data to a remote server:
  1. Log in to the primary server.
  2. Go to this directory:
    • /aiw/aiw1/data (Linux)
    • C:\aiw\aiw1\data (Windows)
      Note:
    • RICOH ProcessDirector does not create the data directory until you start capturing data in the PostgreSQL database.
  3. Open the pg_hba.conf file in a text editor.
  4. Find the comment line for IPv4 local connections:

    # IPv4 local connections:

      Note:
    • RICOH ProcessDirector does not support IPv6 connections for saving data to remote PostgreSQL servers.

  5. Add a line with the IP address and subnet of the remote server.

    For example, to extract data from the PostgreSQL database to an application on a computer at IP address 172.0.0.2 and subnet mask 32, enter the third line shown in this example:

    # IPv4 local connections:
    host  all         all         127.0.0.1/32        trust
    host  all         all         172.0.0.2/32        trust 

    On lines 2 and 3 in the example:

    • The first value specifies the type of connection: host is a plain or SSL-encrypted TCP/IP socket.
    • The second value specifies the databases that users can access.
    • The third value specifies the users who can access the databases.
    • The fifth value specifies the security: trust lets any local user extract data from the database as any PostgreSQL user, including the database super user.

    For information about the choices for each value, see the comments in the pg_hba.conf file.

  6. Open the postgresql.conf file in a text editor.
  7. In the connections and authentication section, find the #listen_addresses line.
  8. To instruct PostgreSQL to listen for notification events on all connections, remove the comment sign (#) and change the ‘localhost’ value to ‘*’.

    listen_addresses = '*'
    For added security, you can specify a comma-separated list of IP addresses instead of *.

  9. Save the file and exit the text editor.
  10. Stop the PostgreSQL database.
    Note: The sample commands use the default values from the Database Settings for the user name, password, and port number. If you changed any of those values, use your values in the command.
    Open a command prompt and type this command:
    • on a Windows server:
      • \aiw\aiw1\bin\postgresql\Windows\pgsql\bin\pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

        or

      • <RPD Install Directory>\PostgreSQL\bin\pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace
    • on a Linux server:
      • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

        or

      • /usr/pgsql-14/bin/pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace
  11. Start the PostgreSQL database.
    • on a Windows server:
      • \aiw\aiw1\bin\postgresql\Windows\pgsql\bin\pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

        or

      • <RPD Install Directory>\PostgreSQL\bin\pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace
    • on a Linux server:
      • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

        or

      • /usr/pgsql-14/bin/pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace
    1. Log in to RICOH ProcessDirector
    2. Click the Administration tab.
    3. In the left pane, click Reports Data Collectors .
    4. In the upper right corner, if the database status is Not connected, refresh your browser to change it to Connected.

1.2.4.27.5 Uploading data using data transmitters

You can use data transmitters to extract property values captured and stored by data collectors in the Reports database, then send them to another application.
Data transmitters query the PostgreSQL database, gather the required information, and use the REST protocol to send it to another application. The data transmitter creates a comma-separated value (CSV) file that contains the property values.

Before you do the steps in this procedure, determine which database tables to extract and when and how often you want to extract the information.

Important: This procedure applies only to REST Transmitters. To upload data for RICOH Supervisor, see Setting up to send data to RICOH Supervisor.

You can configure each data transmitter to extract and send values from different tables. When enabled, the data transmitters run according to a schedule.

To upload data using data transmitters:
  1. Learn the requirements for communication with the REST web service for the application:
    • How to authenticate with the application
    • The values to specify for the REST authentication and transmission requests
    • The format of the data expected in the response
  2. To prepare RICOH ProcessDirector to communicate with the application, do these tasks:
    • If the application requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.
    • If your environment requires a proxy server to communicate with web services, set up the system to use it.
  3. Set up a credential object to use with the data transmitter. Data transmitter objects use Static or Session credentials to authenticate with the application.
  4. Define a data transmitter object:
    1. Click the Administration tab.
    2. In the left pane, click Reports Data Transmitters.
    3. Click Add and select REST Transmitter.
  5. Review the current values for the properties and make any required updates on all the tabs.
    To see information about any of the properties, click the question mark button next to the property name.
  6. When all the settings are configured correctly, click the switch at the top of the General tab to enable the data transmitter.
      Note:
    • Data transmitters must be enabled to extract and send data. If you enable one or more data transmitters while data collection is disabled or no data has been stored in the selected database tables, the data transmitters do nothing. When the data transmitters and data collectors are enabled, if data collectors start to capture data, the data transmitters start to send information on the specified schedule.
    • You can create and enable a data transmitter even when the data collectors are disabled.
    • If the data collector was never enabled and there is no data stored in the selected database tables, an error message is displayed.
  7. Click OK.
  8. Use the one-time transmission function to test the exchange of information between RICOH ProcessDirector and the application.
    1. In Reports Data Transmitters, right-click the transmitter and select One-time Transmission.
    2. To test data transmission, select the Specific Range option and fill in the values for the start and end date.
    3. Click OK.
  9. If the transmission is successful, check the receiving application to be sure that the data arrived as you expected it to. Or, if the transmission fails, right-click the data transmitter and select View Log to see information about which tables failed and why.

1.2.4.27.6 Removing expired data from the Reports database

Data collectors store valuable information about your printing operations. However, at some point, the information is no longer useful and can be deleted. You can create a schedule for removing expired data from your database tables.

Depending on how long you want to keep the data collected by each data collector, you must set up a retention period. When the retention period expires, the data is not deleted immediately. The expired data is deleted during the next scheduled process for removing expired entries.

The automatic process of removing the expired entries is scheduled to start at a specific date and time. You can also select how often this automatic process runs, by setting an interval and a frequency.

To remove expired data from the Reports database:
  1. Click the Administration tab.
  2. In the left pane, click Reports Data Collectors.
    To check or set the retention period for the data collectors:
    1. Click one of the data collectors.
    2. Find Remove expired entries and set the value to On.
    3. Set the retention period for the database entries.
    4. Click OK.
    5. Repeat the steps for the remaining data collectors.
  3. In the left pane, click Reports Database Settings to set the automatic schedule for removing all expired database entries.
  4. Use the Interval and Frequency properties to set how often to run the automatic process of removing the expired database entries.
  5. Use the Start date and time property to select when to start the schedule.
  6. Click SAVE.
Example:

You create reports on the first work day of each month and want to remove expired information from the database on the fifth day of each month. To avoid increased processing load on your system, you want to run that process at 1:00 AM. To set up a schedule for removing expired database entries once a month:

  • Set a retention period for the individual collectors. After the retention period, the database entries are only marked as expired.
  • On the Database Settings page, set the Removal Schedule:
    • Set the Interval to Month.
    • Set the Frequency (months) to Every month.
    • Set Start date and time to the fifth day of the next calendar month and the time to 1:00 AM.

1.2.4.28 Setting up to send data to RICOH Supervisor

The RICOH Supervisor settings let you configure the system to send data to RICOH Supervisor.

The data that you send to RICOH Supervisor must be stored in the Reports database by the RICOH ProcessDirector data collectors. Before you do this procedure, you need to configure the Reports feature, including setting up data collectors and workflow steps to gather the data that you want to send to RICOH Supervisor. The data collected by the data collectors before setting up a RICOH Supervisor data transmitter can be used in RICOH Supervisor after the transmission is enabled.

    Note:
  • Make sure that you have enabled data capturing in Reports Database Settings and for each data collector you want to collect data.

To create a connection to RICOH Supervisor and to transmit data, you must complete a series of steps. The data connection requires you to create a credential and a data transmitter. The credential uses an authentication code to create a certificate that authenticates with RICOH Account Administration for access to Ricoh cloud applications. To get access to RICOH Account Administration, contact the system administrator for RICOH Supervisor.

After you create a certificate that authenticates RICOH ProcessDirector to Ricoh cloud, you must create a RICOH Supervisor data transmitter that enables the data transmission.

    Important:
  • Only one Ricoh cloud credential and one RICOH Supervisor data transmitter can be created for sending data to RICOH Supervisor.

To set up to send data to RICOH Supervisor:

  1. Click the Administration tab.
  2. In the left pane, click Settings RICOH Supervisor.
  3. Go to Settings and set the values for these properties:
    1. Select the time zone for the RICOH ProcessDirector primary computer from the Primary computer time zone list.
    2. Enter the name of the RICOH ProcessDirector system in the System display name field. The name identifies your RICOH ProcessDirector system in RICOH Supervisor.
    3. If you choose to use a proxy server, make sure that the proxy server is configured on the System Settings page.
    4. Click Save settings.
  4. In the Credential section, click Add icon, the Add icon, to create a Ricoh cloud credential. A new dialog opens to set up the credential:
    1. Fill in the fields in the General section.
    2. In the Certificate section, click Generate code. RICOH Account Administration opens in a new tab.
    3. Log in to RICOH Account Administration and copy the code.
    4. Return to RICOH ProcessDirector and paste the generated code into the One-time code field.
    5. Click OK to generate the certificate and save the credential.
  5. In the Data Transmitter section, click Add icon, the Add icon, to create a new RICOH Supervisor data transmitter. A new dialog opens to set up the data transmitter:
    1. Review the current values for the properties and make any required updates on all the tabs. To see information about any of the properties, click the question mark button next to the property name.
    2. When all the settings are configured correctly, click the switch at the top of the General tab to enable the data transmitter.
    3. Click OK.
If all settings are configured correctly, you should see a green check mark in front of every section. The first data transmission occurs on the schedule you set. The first transmission could take a while to complete, even if only a small amount of data is sent. The upper right corner of the RICOH Supervisor Settings page shows the status of the connection and the date and time of the last successful transmission.

1.2.4.28.1 Hints for using RICOH ProcessDirector data in RICOH Supervisor

After you configure data collectors and data transmitters, your challenge is to create dashboards and widgets in RICOH Supervisor to use that data. Here are some suggestions to make that process easier.
Familiarize yourself with the data that is sent to RICOH Supervisor

Before you start to work with RICOH ProcessDirector data in RICOH Supervisor dashboards, we recommend downloading the RICOH ProcessDirector CSV files that are sent to RICOH Supervisor and analyze the data that is collected. In the CSV files, you can see the column headers and data contained in the columns, how many entries are recorded, and how the data is collected overall. Download and open a CSV file for each type of data collector that you enable.

Duplicate and invalid entries

In the CSV files that you downloaded, you probably noticed that some values are recorded in each row of the table without changing. In other cases, some cells are empty for the early steps in a workflow, but filled in later. Both of these situations might require you to use formulas and filters in your widgets in RICOH Supervisor.

For example, the Job Step Progress data collector records data in the job_history table at the beginning and end of each step in the workflow. Properties do not always change from step to step, so many of those property values are identical from row to row. Look at the CSV file for the Job Step Progress data collector and follow how each column changes from row to row.

By default, the Job Step Progress data collector records values for Cumulative pages stacked and Cumulative sheets stacked. Those properties do not have values until after the PrintJobs step. But, for every step after the PrintJobs step, the values are recorded again without changing. The value only changes if the job passes through the PrintJobs step again, for example, if you have to reprint part of the job.

To include one of those values in a widget, be sure that you do not include the values from mulitple steps. RICOH Supervisor will add the values together and therefore provide incorrect results. Use a formula or filter to be sure that you only include values from one row in the database table.

If there are invalid entries, the rows might contain N\A. You can apply a widget filter to filter out these N\A rows to make the widget more easily readable and understandable.

For example, to create a report that shows how many jobs meet their SLA and how many miss their SLA each week, we can consider two factors in this report. The first factor is that not all jobs have an SLA. The second factor is that several data records are available for jobs before the SLA outcome is determined.

If you notice N\A values in the chart, you can add a widget filter to filter out the N\A values. Adding a widget filter results in a more meaningful chart that is easier to read and understand.

RICOH Supervisor dashboard filters only apply to a set of widgets

You can apply dashboard filters only to the widgets that were not configured as independent widgets. The widgets that have the Dashboard Filters option turned off are not affected by the filters applied to a dashboard. These independent widgets can be configured to use their own filter.

Time reported for collecting

The time displayed under the Data as of ... field at the top of the RICOH Supervisor dashboard is the time of the last update recorded from the internal database. It is not the latest update of the data collected by the RICOH ProcessDirector data collectors. The data collected by the RICOH ProcessDirector data collectors is updated based on the RICOH ProcessDirector transmission schedule. The RICOH ProcessDirector transmission date is always older than the time reported in RICOH Supervisor under Data as of .... To get the transmission data as transmitted by RICOH ProcessDirector, go to RICOH Supervisor Data Collectors Software Connectors and select the data transmitter from the list.

Different time zone

If you are using RICOH Supervisor in a different time zone than the RICOH ProcessDirector primary server, use Convert times to time zone from RICOH ProcessDirector. To access and change the values of the current time zone, log in to RICOH ProcessDirector, then go to Administration Settings RICOH Supervisor Convert times to time zone.

Sending jobs containing PDF and PostScript files to an InfoPrint 5000 printer

When RICOH ProcessDirector sends a job containing a PDF or PostScript file to an InfoPrint 5000 printer, the information received from the printer regarding the printing process might be different than the actual data on the printer. The data displayed in RICOH Supervisor might be different than what is reported on the actual printer.

1.2.4.29 Setting up RICOH ProcessDirector and Avanti Slingshot to exchange information

After you read the Avanti Slingshot Connect overview topics, you can set up RICOH ProcessDirector and Slingshot to exchange information about orders, jobs, and job processing. Do the configuration tasks described in this section.

You can configure RICOH ProcessDirector and Slingshot so that orders originate in Slingshot. For each order, Slingshot submits one or more PDF jobs to RICOH ProcessDirector with a JDF job ticket. Do these tasks:

  • Configure Slingshot to submit jobs to RICOH ProcessDirector.

  • Set up a RICOH ProcessDirector hot folder input device to process Slingshot jobs.

Alternatively, you can configure RICOH ProcessDirector and Slingshot so that print jobs originate in RICOH ProcessDirector. For each job, RICOH ProcessDirector sends order information to Slingshot. Do this task:

  • Modify a workflow to send order information to Slingshot.

For both configurations, do these tasks:

  • Define Avanti Slingshot Connect cost centers.

  • Assign cost centers and job color to report to printers.

  • Send job status information to Slingshot.

  • Modify a workflow so that it sends job information to Slingshot.

After the initial configuration is complete, test it to make sure that RICOH ProcessDirector and Avanti Slingshot exchange information correctly.

1.2.4.29.1 Configuring Slingshot to submit jobs to RICOH ProcessDirector

Avanti Slingshot uses JDF Types to submit jobs to RICOH ProcessDirector. You create a JDF Type and assign it to each printer device that prints RICOH ProcessDirector jobs.

If your Avanti support representative created the JDF Types required to submit Slingshot jobs to RICOH ProcessDirector, you can use these instructions to create more JDF Types.

RICOH ProcessDirector can receive one or more PDF files with each JDF job ticket. When RICOH ProcessDirector receives multiple PDF files, it creates a separate job for each of them.

Slingshot can submit PDF files to RICOH ProcessDirector by including them in the MIME package or putting a link to them in the JDF job ticket. We recommend configuring Slingshot to submit PDF files to RICOH ProcessDirector in the MIME package.

If Slingshot puts a link to PDF files in the JDF job ticket, make sure that the RICOH ProcessDirector system user has authority to read them. The default system user is aiw1.

When receiving jobs from Slingshot, RICOH ProcessDirector checks whether the MIME package includes PDF files. If the package does not include any PDF files, RICOH ProcessDirector checks the JDF job ticket for a link to the files.

RICOH ProcessDirector requires JDF that does not contain any nested JDF nodes.

    Note:
  • For a typical implementation of Slingshot, you do these steps to exchange information with RICOH ProcessDirector. Your implementation of Slingshot can have steps that differ from these steps.

To configure Slingshot to submit jobs:
  1. Create a JDF Type.
    1. Log in to the Avanti Slingshot client.
    2. Navigate to System Setup General and double-click JDF Type.
    3. Click New (New icon).
    4. In the JDF Type Code field, type a name such as RPD Sender. Fill in other values as needed.
    5. On the JDF/JMF Options tab, specify these JDF Output Options:
      • Click the PDF check box for File Types to Send.

      • If Slingshot sends PDF files to RICOH ProcessDirector in the MIME package, click the Copy to hot folder check box for Attached Files.

        If Slingshot sends a link to PDF files in the JDF job ticket, make sure that Copy to hot folder is not checked.

      • Click the check box for Use Combined JDF Format.

      • Make sure that Include All Job Sections is not checked.

          Note:
        • The settings for Use Combined JDF Format and Include All Job Sections produce JDF that does not contain any nested JDF nodes.

      • Click the check box for Send JDF via MIME.

    6. For JMF Messages, click the check boxes for all the options.
    7. On the Connection Options tab:
      • For JMF HTTP URL, enter this URL:

        http://yourserver:15080/aiwservices/v1/jmf

        Replace yourserver with the IP address or hostname of your RICOH ProcessDirector server.

      • For JMF Return HTTP URL, enter the value provided by your Avanti support representative.

    8. Click Save Record (Save Record icon).
    If you want to send jobs to different RICOH ProcessDirector servers, you can create multiple JDF Types.
  2. Attach the JDF Type to the estimating standard for each printer device that prints RICOH ProcessDirector jobs.
    1. Navigate to System Setup Estimating and double-click My Estimating Standards.
    2. In Table View, find the printer device that you want to attach the JDF Type to.
      The name of the device is in the Description column.
    3. Display Detail View by clicking the arrow to the left of the device.
    4. Click Edit (Edit icon).
    5. Select the JDF Type on the JDF Type list.
    6. Click Save Record (Save Record icon).

1.2.4.29.2 Setting up a hot folder input device to process Slingshot jobs

A hot folder input device that processes jobs submitted by Avanti Slingshot must have the same name as the Line Item specified on the Slingshot sales order and must use the JDF Batching method.

To set up a hot folder input device to process Slingshot jobs:

  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
  3. Right-click the HotFolderJDF input device and select Copy.
  4. In the Input device name property, type the name of the Slingshot Line Item.
  5. Specify values for the Folder location and Staging location properties.
    Each hot folder must specify unique values for these two properties.
  6. Set these properties as follows:
    Workflow
    ParentNoPrint
    Child workflow
    The workflow that is appropriate for the print files in the job.
    Submit step
    SubmitInputFiles
    Note: If you copy an input device other than HotFolderJDF, make sure that the value of the Batching method property is JDF.
  7. Fill in or edit other values that you need.
  8. Click OK.
  9. To use the input device, select it and click Enable and Connect.
After you configure an input device to use the JDF Batching method, do not submit input files to the device if they are not identified by a job ticket. Unidentified input files indefinitely remain in the staging location for the input device with a status of Waiting.

1.2.4.29.3 Modifying a workflow to send order information to Slingshot

To send order information to Avanti Slingshot, contact your Avanti support representative. Learn the values required to call the Slingshot web service that receives order information from RICOH ProcessDirector. Then add a step based on the CreateOrderInSlingshot step template to your workflow.
Work with your Avanti support representative to configure Slingshot to create orders for jobs received from RICOH ProcessDirector.
To modify a workflow to send order information to Slingshot:
  1. Learn the values required to authenticate with Slingshot and call the REST web service that receives order information.
  2. Get the XML file containing the order information that RICOH ProcessDirector sends to Slingshot.

    Contact your Avanti support representative to get the file and your RICOH ProcessDirector support representative to make sure that the XML works with RICOH ProcessDirector.

  3. To prepare RICOH ProcessDirector to communicate with Slingshot, do these tasks:

    • If Slingshot requires a security certificate, install the certificate on the RICOH ProcessDirector primary computer.

    • If your environment requires a proxy server to communicate with web services, set up the system to use it.

    For more information, see the related tasks.

  4. Click the Workflow tab.
  5. Click the name of the workflow you want to modify.
  6. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  7. Add a step based on the CreateOrderInSlingshot step template to the workflow in the appropriate place.
      Note:
    • Run this step on a job one time only.

    • You can put this step in a workflow multiple times. Make sure that each step is in a separate branch so that the steps do not process the same job.

    • When you restart a job after Slingshot has created an order for it, make sure that a CreateJobInSlingshot step does not process the job.

    • Slingshot returns a status code 500 error when it receives the same job number more than once.

    • You can run this step on parent or child jobs. Orders created in Slingshot from parent or child jobs do not retain the relationship between parent and children.

  8. Set values for the job properties.
    1. Set the Request URL property to the URL of the Slingshot web service that creates an order for each job received from RICOH ProcessDirector.

      Your Avanti support representative supplies the URL.

    2. Set the Request payload property to the full directory path and name of the file containing the XML order information that RICOH ProcessDirector sends to Slingshot.
    3. Set the value of the Request parameters property.

      Work with your Avanti representative to fill in values for the SenderID, Username, and Password parameters. The value of the RequestType parameter does not change.

    4. If your environment requires a proxy server to communicate with web services, set the Use proxy property to the correct proxy server.
    5. If your Avanti support representative gives you a password for the Password property, type it in the field.
  9. When you finish setting values for the properties, click OK.
  10. Save and enable the workflow.

After you set up your RICOH ProcessDirector workflow and configure Slingshot, test the creation of orders in Slingshot. If the XML in the file containing the order information is correct, the RICOH ProcessDirector Job ID matches the Slingshot Order ID.

If you have not configured RICOH ProcessDirector to report job processing information to Slingshot:

  • Define Avanti Slingshot Connect cost centers.
  • Modify your workflow. To report the time a job spends in various steps to a cost center, set values for the Slingshot cost center and Slingshot milestone status properties of the steps.
For more information about defining cost centers and modifying your workflow, see the information center.

1.2.4.29.4 Defining Avanti Slingshot Connect cost centers

Avanti Slingshot Connect cost centers are essential for allocating the costs of time and materials. Entries in the avanti.cfg file in RICOH ProcessDirector are tied to objects in the Avanti Slingshot system where the cost allocation occurs. You must use the External Device ID for each cost center in the avanti.cfg file. If you use the name of the cost center and that name is different from the External Device ID that is defined in Slingshot, RICOH ProcessDirector cannot report data correctly. The entries in the avanti.cfg file are known as cost centers in RICOH ProcessDirector and are called External Device IDs in the Avanti Slingshot system. These IDs let RICOH ProcessDirector correctly allocate information to the Avanti Slingshot cost centers.
Note: Before you do this, look in System Setup Organization Operation Category in Avanti Slingshot to make sure that all of your cost centers have External Device IDs defined.

To define the cost centers for RICOH ProcessDirector:

  1. Navigate to the avanti.cfg file: /aiw/aiw1/config/avanti.cfg on Unix-based operating systems and C:\aiw\aiw1\config\avanti.cfg on Windows.
  2. Open the file in a text editor.
  3. Enter the values that match the External Device IDs defined for cost centers in Avanti Slingshot. Type each entry on a separate line.
    The cost center values are case-sensitive.
  4. Save the avanti.cfg file and exit the text editor.
    The new values that you have entered are available as Slingshot cost centers the next time you access RICOH ProcessDirector.

1.2.4.29.5 Assigning a cost center and job color to report to a printer

For Avanti Slingshot to account correctly for the time a job spends on a RICOH ProcessDirector printer, you must assign a cost center to the printer. Using the printer cost center, RICOH ProcessDirector reports the total pages or sheets printed on specific media by name and by product ID (if a Product ID value is specified for the media). RICOH ProcessDirector also reports whether all the pages in a job were printed in full color or only in a single color ink or toner, usually black.

The cost centers are defined in the avanti.cfg file.

To assign a cost center and job color to report to a printer:

  1. In the Printers portlet, right-click the printer and select Properties.
  2. On the Avanti Slingshot tab, select a value for the Slingshot cost center property.
  3. For the Job color to report property:

    • Select Black for a black and white printer or a color printer set to print only with black ink or toner.

    • Select Color for a color printer set to print in full color.

    • Select From job for Ricoh TotalFlow printers, especially if jobs are printed in a combination of single-color and full color pages.

    Note: This property does not control whether the printer prints in full color or only with black ink or toner. The property is used only to report the ink or toner information to Avanti Slingshot.

  4. Select a value for the Print unit to report property.
    The value selected is always used to calculate media volume. However, it is only used for job color if the Job color to report property is set to Black or Color.
  5. Click OK.

When an Avanti Slingshot job runs in RICOH ProcessDirector, the amount of time each job spends on the printer is reported to the correct cost center in the Avanti Slingshot system. The start time on the printer is when the job state changes to Assigned. The complete time is when the job state changes to Complete.

When each job finishes printing, RICOH ProcessDirector reports the total pages or sheets printed on specific media by name and by product ID (when specified). RICOH ProcessDirector also reports whether all the pages were printed in full color or only with a single (usually black) ink or toner.

    Note:
  • If you assign a value to the Slingshot cost center property for a printer, do not include the PrintJobs step in a series of steps that send cost center information to Avanti Slingshot.

1.2.4.29.6 Configuring to send job color information to Slingshot

You can send information about the color of the ink or toner used to print a job from RICOH ProcessDirector to Slingshot.
The ink or toner information that you can send to Slingshot varies based on the type of RICOH ProcessDirector printer object you define:
  • For Ricoh TotalFlow printer objects: RICOH ProcessDirector retrieves the values for number of full color and single-color pages printed in a job from RICOH TotalFlow Print server.
  • For other printer objects: RICOH ProcessDirector reports that all pages of the job were printed in black or in full color.
To configure to send job color information to Slingshot:
  • For Ricoh TotalFlow printer objects:
    1. Open the property notebook for the printer and click the Avanti Slingshot tab.
    2. Make sure the Job color to report value is set to From job.
  • For all other printer objects:
    The recommended method is to create two printer objects that represent the printer. One object prints jobs that are printed in full process color and the other prints jobs that use only black ink or toner. Then, modify your workflows to send jobs through the correct printer object.
    1. Define two printer objects to represent the printer. Use the same property values for both except for Name and Job color to report.
    2. Edit any workflows that might process jobs containing either color or black pages to send color jobs to the printer object with Job color to report set to Color and send jobs with only black pages to the printer object with Job color to report set to Black.
      • Use a custom job property, such as Custom 1, to assign jobs a value of Black or Color.

        For example, you can use a SetJobPropsFromTextFile step or an AssignJobValues step to set the value of the Custom 1 job property.

      • To set the value for the Requested printer job property, make a branch in the workflow before the PrintJobs step.
        • On one branch, add a rule that says when the value of Custom 1 is Black, use an AssignJobValues step to set the value of Requested printer to the printer object whose Job color to report property is set to Black.
        • On the other branch, add a rule that says when the value of Custom 1 is Color, use an AssignJobValues step to set the value of Requested printer to the printer object whose Job color to report property is set to Color.
        Note: You cannot use the Job color to report property to schedule jobs to printers.

1.2.4.29.7 Sending ink usage data to Avanti Slingshot

You can configure RICOH ProcessDirector to collect ink usage data for jobs sent to specific printers. The data collected is sent back to Avanti Slingshot, along with the ink loaded in the printer for that specific job.
When a Ricoh continuous form printer is set up in RICOH ProcessDirector, you can specify which ink is loaded in the printer, using the names defined in Avanti Slingshot. Then, when the ink usage data is sent back to Avanti Slingshot in the job ticket, the ink names match. To see the ink settings, the printer must be added as a Ricoh TotalFlow Printer.
To send ink usage data to Avanti Slingshot:
  1. Make sure that the printer you want to use for collecting the ink usage is defined in RICOH ProcessDirector as a Ricoh TotalFlow Printer.
  2. Find the names of the ink used on this printer in the Avanti Slingshot client:
    1. Log in to the Avanti Slingshot client.
    2. In the left pane, go to Inventory Items.
    3. In the Item - Table View panel, go to the Item Class list and select Inks.
    4. Identify the ink according to the item code and copy either the inventory item code from the Item Code field or the text from the Description 1 field.
  3. Update the Ricoh TotalFlow printer with the names set in Avanti Slingshot:
    1. Log in to RICOH ProcessDirector.
    2. Go to Administration Printers.
    3. Right-click an existing Ricoh TotalFlow Printer and select Properties.
    4. Go to the Avanti Slingshot section and fill in the ink names found in Avanti Slingshot under the Item Code or Description 1 fields.
      For example, if for the black ink, the name in Avanti Slingshot under Description 1 is Black-RPD, you must enter the same ink name in the Black ink field from Ink Property Mapping under Avanti Slingshot in RICOH ProcessDirector. You can also match the ink names according to the values in the Item Code field, but if the item code is not found, does not exist, or the field is empty, matching the ink names is done according to the Description 1 field.
  4. To test if the configuration is correct, send a job to this printer to Avanti Slingshot. Compare the values sent from RICOH ProcessDirector with the ones received in Avanti Slinghsot:
    1. Log in to RICOH ProcessDirector
    2. Right-click the job in the Jobs portlet and select View log.
    3. Find the ink information message and look for the ink name and amount value.
    4. Log in to the Avanti Slingshot client.
    5. Go to Production Job View to select the job.
    6. In the Materials tab, look for the ink values under the Used column and compare with the values displayed in the job log in RICOH ProcessDirector.

1.2.4.29.8 Sending job status information to Avanti Slingshot

To send job status information between Avanti Slingshot and RICOH ProcessDirector, you must define the URL of the Avanti Slingshot system to RICOH ProcessDirector.
    Note:
  • For a typical implementation of Slingshot, you do these steps to exchange information with RICOH ProcessDirector. Your implementation of Slingshot can have steps that differ from these steps.
  1. Log in to the Avanti Slingshot Client.
  2. Navigate to System Setup General and double-click JDF type.
  3. Select the Connection Options tab.
  4. In the JMF HTTP URL field, specify the URL for the RICOH ProcessDirector server: http://yourserver:15080/aiwservices/v1/jmf
    Replace yourserver with the IP address or hostname of your RICOH ProcessDirector server.
  5. Copy the URL from the JMF Return HTTP URL field to the clipboard. The JMF Return HTTP URL looks similar to http://AvantiServer:8081/servoy-service/rest_ws/avanti_jdf/jmf_inbound_processing/params?Username=UserName&Password=password
  6. Log in to RICOH ProcessDirector.
  7. Navigate to Administration Settings Avanti Slingshot
  8. Paste the URL from the JMF Return HTTP URL field into the Avanti URL field and click OK.
      Important:
    • If you change the Avanti Slingshot client password, you must update the JMF Return HTTP URL with the new password and copy the JMF Return HTTP URL into the Avanti URL field in RICOH ProcessDirector. For example, if you updated your password to MyPassword, and your current URL is http://AvantiServer:8081/servoy-service/rest_ws/avanti_jdf/jmf_inbound_processing/params?Username=UserName&Password=password, change Password=password at the end of the URL to Password=MyPassword.

1.2.4.29.9 Modifying a workflow to send job information to Slingshot

To send Avanti Slingshot the time required for the job to complete a single step or a series of steps, you must specify the Slingshot cost center and the milestone status for the single step or for the first and last steps in the series. By associating one or more steps with a cost center, you identify all the time spent on processing by the cost center.
You do not need to associate all steps with Slingshot cost centers.

When you choose the steps to modify in a workflow, make sure that a job goes through one step with a Slingshot milestone status property value of Complete for each Slingshot cost center that you want to report information to.

Before you modify a workflow, define the Avanti Slingshot Connect cost centers.

To modify a workflow to send information to Slingshot:
  1. Click the Workflow tab.
  2. Click the name of the workflow.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. For each single step whose job information you want to send to Slingshot (one-to-one mapping of step to cost center):
    1. Right-click the step and select Properties.
    2. For the Slingshot cost center property, select the Slingshot cost center that you want to report job information to.
    3. For the Slingshot milestone status property, select Complete.
    4. Click OK.
  5. For each series of steps whose job information you want to send to Slingshot:
    1. Right-click the first step in the series and select Properties.
    2. For the Slingshot cost center property, select the Slingshot cost center that you want to report job information to.
    3. For the Slingshot milestone status property, select In progress.
    4. Click OK.
        Note:
      • For the steps between the first and last steps in the series, you do not need to set the Slingshot cost center and Slingshot milestone status properties. RICOH ProcessDirector reports the time a job spends in these steps to the Slingshot cost center even if you do not set the properties.
    5. Right-click the last step in the series and select Properties.
    6. For the Slingshot cost center property, select the same Slingshot cost center that you selected for the first step.
    7. For the Slingshot milestone status property, select Complete.
    8. Click OK.
  6. Save and enable the workflow.
  7. When the workflow processes a job, check to see if the job information is sent to the specified cost center in Slingshot.
      Note:
    • For a typical implementation of Slingshot, you do these steps to exchange information with RICOH ProcessDirector. Your implementation of Slingshot can have steps that differ from these steps.
    1. Log in to the Avanti Slingshot client.
    2. Navigate to System Setup General Integration Log.
    3. For the Slingshot job, you should see Export entries in the Type column for the JDF Type that Slingshot uses to send jobs to RICOH ProcessDirector.
    4. If RICOH ProcessDirector successfully imports the job, you should see Import entries in the Type column with HTTP in the Method column, Updating Job in the Purpose column, and Processing inbound JMF Status File for job in the Result Details column.
    5. On the Integration Log, click the arrow to the left of a Slingshot job.
    6. Click Edit (Edit icon) to display the job record in Detail View.
    7. Review the Troubleshooting Details.
      You should see processing information about the Slingshot cost center assigned to the RICOH ProcessDirector workflow steps or printer.
        Note:
      • The External Device ID for the Slingshot cost center has the same name as the Avanti Slingshot Connect cost center.
    8. Navigate to CRM Jobs.
    9. Select the Slingshot job.
    10. Click the Cost Summary tab.
      You should see values in the Actual column.
    11. Click the Milestones tab.
      You should see tasks for the Slingshot cost centers with check marks in the Done column.

1.2.4.30 Setting up the Quadient Inspire Connect feature

After you read the Quadient Inspire Connect overview topics, you can set up Quadient Inspire Connect by doing the configuration tasks described in this section.
After the initial configuration is complete, test your Quadient Inspire Connect workflows to make sure they work as you expect them to.

1.2.4.30.1 Setting up step templates to send jobs to Quadient Inspire Designer

Copy and customize the ComposeAFP and ComposePDF to send jobs to Quadient Inspire Designer for processing.
To set up a step template to send jobs to Quadient Inspire Designer:
  1. Click the Workflow tab.
  2. In the left pane, click Step Templates.
  3. Right-click the ComposeAFP or ComposePDF step template and select Copy.
  4. On the Copy page, review and update these fields:
    • Data files
    • Data modules
    • Fixed data files
    • Fixed data modules
    • Quadient JOB file
    • External command
    • WFD file
  5. Click OK.

1.2.4.30.2 Configuring to work with Quadient Inspire Designer for AFP print jobs

Quadient Inspire Connect makes it easier to configure workflows that interact with Quadient Inspire Designer to generate or reformat AFP print jobs.

Before you create RICOH ProcessDirector objects and start to configure them, make sure that Quadient Inspire Designer is listed in the PATH environment variable for the aiw1 user. If you cannot edit the PATH, you must include the full path to Quadient Inspire Designer in the External command property wherever it appears.

Each workflow requires these system objects:

  1. An appropriate input device

    We recommend that you copy one of the hot folder input devices supplied with the feature: HotFolderReformatAFP, HotFolderComposeAFPDataSubmitted, or HotFolderComposeAFPDataRetrieved. All of those input devices have their Batching method set to List. If you plan to submit only a WFD file as a print job, change the Batching method to None.

  2. A step based on the ComposeAFP step template.
  3. A workflow that includes that step.

1.2.4.30.2.1 Defining a workflow to send AFP jobs to Quadient Inspire Designer

Copy and customize one of the AFP workflows to create a workflow that sends jobs to Quadient Inspire Designer.
These AFP workflows are available when the Quadient Inspire Connect and AFP Support features are installed. These workflows include:
  • ComposeAFPDataRetrieved

    Use this workflow when you want to send a WFD file and one or more raw data files to Quadient Inspire Designer and generate new AFP files as part of your workflow and you want to store the data files in an external location.

    This workflow expects you to submit the WFD file listed in the ComposeAFP step template. The workflow creates an overrides file from the values of the Data files and Data modules properties. Data files are not submitted as part of the job; the workflow expects to find the files in the locations listed in the overrides file.

  • ComposeAFPDataSubmitted

    Use this workflow when you want to send a WFD file and one raw data file to Quadient Inspire Designer and generate new AFP files as part of your workflow and you want to submit the data file as part of the print job.

    This workflow expects you to submit a WFD file and the data file.

      Note:
    • You can only submit one data file as part of a print job. If the job requires more than one data file, you must store the data files in another location and use the ComposeAFPDataRetrieved workflow instead.
  • ReformatAFP

    Use this workflow when you have an existing AFP file that you want to send to Quadient Inspire Designer to be reformatted or otherwise modified.

    This workflow expects you to submit a WFD file and, optionally, an existing AFP file.

To define a workflow to send jobs to Quadient Inspire Designer:

  1. Click the Workflow tab.
  2. Right-click the appropriate workflow from the list and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Find the ComposeAFP step template:
    • If you copied the supplied ComposeAFP step template and renamed it, delete ComposeAFP and add your new step template to the workflow.
    • If you modified the supplied ComposeAFP step template without copying it, delete this version of ComposeAFP and add the modified version to the workflow.
  5. Right-click the ComposeAPF step and select Properties to display the job default values. Update any values that are different for this workflow.
  6. Click OK.
  7. Add and update any other step templates that the workflow requires.
  8. Save and enable the workflow.

1.2.4.30.3 Configuring to work with Quadient Inspire Designer for PDF print jobs

Quadient Inspire Connect makes it easier to configure workflows that interact with Quadient Inspire Designer to generate or reformat PDF print jobs.

Before you create RICOH ProcessDirector objects and start to configure them, make sure that Quadient Inspire Designer is listed in the PATH environment variable for the aiw1 user. If you cannot edit the PATH, you must include the full path to Quadient Inspire Designer in the External command property wherever it appears.

Each workflow requires these system objects:

  1. An appropriate hot folder input device:

    For a workflow that uses a WFD and one or more raw data files to generate a PDF file, set these hot folder Batching properties:

    • Batching method: List
    • Data patterns: .*wfd$

    • List patterns: .*lst$

    • Overrides patterns: a pattern that matches the extensions of the raw files you expect to use.

    For a workflow that accepts a WFD and a PDF file, then sends them to Quadient Inspire Designer to be reformatted or modified, set these hot folder Batching properties:

    • Batching method: Pattern
    • Data patterns: .*pdf$

    • File pattern: .*wfd$

    • Spool file usage: gmc

    • File pattern required: Yes

    • Spool file type: wfd

    • File pattern sequence: 1

    Note: After adding the values for File pattern, Spool file usage, File pattern required, Spool file type, and File pattern sequence, make sure you click the Add button.

  2. A step based on the ComposePDF step template.
  3. A workflow that includes that step.

1.2.4.30.3.1 Defining a workflow to send PDF jobs to Quadient Inspire Designer

Copy and customize one of the PDF workflows to create a workflow that sends jobs to Quadient Inspire Designer.

To define a workflow to send jobs to Quadient Inspire Designer:

  1. Click the Workflow tab.
  2. Right-click the PDF workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Find the ComposePDF step template and add it to the Receive phase before the OptimizePDF step.
  6. Right-click the ComposePDF step and select Properties.
  7. Update any values that are different for this workflow.
    • For a workflow that accepts a WFD and one or more raw data files to generate a PDF file, we recommend these settings:
      Property Value
      External program language Not set
      External command PNetTC ${Job.GMC.WFDFileLocation} ${Job.GMC.SetupDataFiles} -o MyOutput1 -e PDF -f ${getFileName(print, pdf, write)}
      WFD file ${getFileName(print, unknown, read)}
      Data modules -difDataInput1
      Fixed data modules Not Set
      External program code page UTF8
      Valid return codes 0,2
      Data files ${getFileName(overrides, text, read)}
      Fixed data files Not set
      Quadient JOB file Not set
    • For a workflow that accepts a WFD and a PDF file, then sends them to Quadient Inspire Designer to be reformatted or modified, we recommend these settings:
      Property Value
      External program language Not set
      External command PNetTC ${Job.GMC.WFDFileLocation} ${Job.GMC.SetupDataFiles} -o MyOutput1 -e PDF -f ${getFileName(print, pdf, write)}
      WFD file ${getFileName(gmc, wfd, read)}
      Data modules -PDFinParamInput1
      Fixed data modules Not Set
      External program code page UTF8
      Valid return codes 0,2
      Data files ${getFileName(print, pdf, read)}
      Fixed data files Not set
      Quadient JOB file Not set
  8. Click OK.
  9. Add and update any other step templates that the workflow requires.
  10. Save the workflow.

1.2.4.31 Setting up to use electronic forms

After you read the Preprinted Forms Replacement overview topics, set up to use electronic forms by doing the configuration tasks described in this section.

After the configuration is complete, test your workflows that combine electronic forms with job data to make sure that they work as you expect them to.

1.2.4.31.1 Adding electronic forms to media objects

Electronic forms are pages in PDF files that you add to media objects. The CombinePDFWithForm or CombineAFPWithForm step combines the PDF page data with PDF or AFP job data to create a print file that you can print on plain paper.
When you choose pages in PDF files to use as electronic forms, we recommend that the page size matches the page size of the job data.

To make a page in a multiple-page PDF file into an electronic form, you do not need to save the page as a separate PDF file. You can specify the multiple-page PDF file when you add the electronic form to the media object. Then you select a page in the file.

To add electronic forms to media objects:
  1. Click the Administration tab.
  2. In the left pane, click Objects Media.
  3. Right-click a media object and select Properties.
  4. To add an electronic form to the front or back side of the media:
    1. Click the Folder button for the Front of form or Back of form property.
    2. Go to the PDF file that contains the page that you want to use as an electronic form for the side that you selected. Then click Open.
    3. Select the page in the file by typing its number in the Use page field.
    4. Click Create form.

      To view the form, click the blue link Front of form or Back of form.

      To delete the form, click x to the right of the blue link.

    5. To add an electronic form to the other side of the media, repeat the steps.
  5. Set a value for the Media name for printing property based on how you want the CombinePDFWithForm or CombineAFPWithForm step to process jobs that request this media.

    Take your Management Information System (MIS) reporting needs into account. Consider how you want to track and charge for the media.

    • To leave occurrences of this media name for the entire job and for any page exceptions, select Current name.
    • To remove all occurrences of this media name from the entire job and from any page exceptions, select None.

      Selecting this value does not affect any occurrences of other media names.

    • To replace all occurrences of this media name for the entire job and for any page exceptions, select Selected. Then select a media name from the list of names for all media objects.

      Selecting this value does not affect any occurrences of other media names.

  6. Click OK.
The media object is now ready to use with the CombinePDFWithForm or CombineAFPWithForm step when an incoming job requests the media by name.

1.2.4.31.2 Running the sample workflow that uses electronic forms to print jobs

The ElectronicFormJobSample workflow demonstrates how to combine electronic forms with data in PDF files for jobs. The sample workflow prints some jobs by combining electronic forms with data. It prints other jobs on preprinted forms. The workflow is installed with the Preprinted Forms Replacement feature.

The workflow includes two branches:

  • The [1] Electronic branch sends jobs with Electronic in the job name through the CombinePDFWithForm step, which combines the electronic forms with the data. The jobs then go to the CountPages step. When the jobs reach the PrintJobs step, they are printed on plain paper.
  • The [2] Preprinted branch sends jobs that do not have Electronic in the job name directly to the CountPages step. Those jobs bypass the CombinePDFWithForm step and are printed on preprinted forms.

The sample objects and files used in this workflow include:

  • Workflow: ElectronicFormJobSample
  • Input device: ElectronicFormJobFolder
  • Media object: ElectronicFrontAndBack
  • PDF files:
    • ElectronicJob.pdf
    • PreprintedJob.pdf

    These simplex jobs, which are identical except for their job names, have 500 pages of variable name and address data with a letter salutation.

    The printed output of both jobs is 500 customer letters with information about a rewards program on the front and footnotes on the back.

    The sample workflow processes the PreprintedJob.pdf file as a simplex job that prints on the preprinted form that the ElectronicFrontAndBack media object represents. The preprinted form has the static text of the customer letter on the front side and the static text of the footnotes on the back side.

    The sample workflow processes the ElectronicJob.pdf file by converting it from a simplex job to a duplex job that prints on plain paper. The sample workflow creates the front pages of the duplex job by combining an electronic form with the variable name and address data. The electronic form has the static text of the customer letter. The sample workflow creates the back pages of the duplex job by adding an electronic form with the static text of the footnotes.

To run the sample workflow:

  1. Click the Main tab.
  2. In the Input Devices portlet, right-click the ElectronicFormJobFolder hot folder and select Enable and Connect.

    The first time that you enable and connect the hot folder, RICOH ProcessDirector submits the ElectronicJob.pdf and PreprintedJob.pdf jobs to the ElectronicFormJobSample workflow.

    The jobs move through the workflow and stop at the PrintJobs step. Both jobs are in the Device unavailable state, waiting for the Sample printer to be enabled.

  3. Review the ElectronicFrontAndBack media object.
    1. Click the Administration tab.
    2. In the left pane, click Objects Media.
    3. Right-click the ElectronicFrontAndBack media object and select Properties.
    4. To view the electronic form for the front of the media, click the blue Front of form link.

      The PDF page used for the front of the form opens in a new browser tab.

    5. When you are finished viewing the form, close the tab.
    6. To view the electronic form for the back of the media, click the blue Back of form link.

      The PDF page used for the back of the form opens in a new browser tab.

    7. When you are finished viewing the form, close the tab.
    8. Look at the value of the Media name for printing property.
      The property is set to None.
  4. Review the PreprintedJob.pdf job.
    1. Right-click the job and select View.

      You see 500 pages of variable name and address data with a letter salutation.

    2. Click Close.
    3. Right-click the job and select Properties.
    4. Click the General tab.

      Duplex is set to No.

    5. Click the Scheduling tab.

      The Media value is ElectronicFrontAndBack.

  5. Review the ElectronicJob.pdf job.
    1. Right-click the job and select View.

      You see 1,000 pages: 500 customized letters with variable name and address data and static text about a rewards program on the front. On the back of the letter are footnotes with static text.

    2. Click Close.
    3. Right-click the job and select Properties.
    4. Click the General tab.

      Duplex is set to Yes.

    5. Click the Scheduling tab.

      The Media value is Not set.

    The ElectronicJob.pdf job entered the workflow with the same property values as the PreprintedJob.pdf job:

    • Duplex was set to No.
    • Media was set to ElectronicFrontAndBack.

    When the CombinePDFWithForm step processed the ElectronicJob.pdf job, it combined the forms with the data and changed the job from simplex to duplex.

    Because the Media name for printing property on the ElectronicFrontAndBack media object is set to None, the CombinePDFWithForm step removed the ElectronicFrontAndBack media name from the job. Setting the property to None causes the job to print on whatever paper is used when jobs do not specify media.

1.2.4.31.3 Running the sample workflow that uses electronic forms to print jobs with documents

The ElectronicFormDocSample workflow demonstrates how to combine electronic forms with data in PDF files for jobs that contain documents. The sample workflow prints some jobs by combining electronic forms with data. It prints other jobs on preprinted forms. The workflow is installed with the Preprinted Forms Replacement feature.

The workflow includes two branches:

  • The [1] Electronic branch sends jobs with Electronic in the job name through the CombinePDFWithForm step, which combines the electronic forms with the data. The jobs then go to the CountPages step. When the jobs reach the PrintJobs step, they are printed on plain paper.
  • The [2] Preprinted branch sends jobs that do not have Electronic in the job name directly to the CountPages step. Those jobs bypass the CombinePDFWithForm step and are printed on preprinted forms.

The sample objects and files used in this workflow include:

  • Workflow: ElectronicFormDocSample
  • Input device: ElectronicFormDocFolder
  • Media objects:
    • SummaryAndDetails

      This media object specifies electronic forms for the first sheet of a statement with a summary on the front and details on the back.

    • DetailsDuplex

      This media object specifies electronic forms for sheets with statement details on both sides.

    • DetailsAndOffers

      This media object specifies electronic forms for the last sheet of a statement with details on the front and offers on the back.

  • PDF files:
    • ElectronicDoc.pdf
    • PreprintedDoc.pdf

    These 866-page duplex jobs, which are identical except for their job names, contain 300 documents. Each document consists of a customer statement with two, four, or six pages. All documents have a statement summary page followed by one to four pages of transaction details. If the last page of a document does not have transaction details, offers are included on the last page.

  • Control file for the IdentifyPDFDocuments and BuildPDFFromDocuments steps: ElectronicForm.ctl

    This control file contains the page-exception data for the documents in the jobs.

To run the sample workflow:

  1. Click the Main tab.
  2. In the Input Devices portlet, right-click the ElectronicFormDocFolder hot folder and select Enable and Connect.

    The first time that you enable and connect the hot folder, RICOH ProcessDirector submits the ElectronicDoc.pdf and PreprintedDoc.pdf jobs to the ElectronicFormDocSample workflow.

    The jobs move through the workflow and stop at the PrintJobs step. Both jobs are in the Device unavailable state, waiting for the Sample printer to be enabled.

  3. Review the SummaryAndDetails, DetailsDuplex, and DetailsAndOffers media objects.
    1. Click the Administration tab.
    2. In the left pane, click Objects Media.
    3. Right-click the SummaryAndDetails media object and select Properties.
    4. To view the electronic form for the front side, which contains the static portion of the statement summary page, click the blue Front of form link.

      The PDF page used for the front of the form opens in a new browser tab.

    5. When you are finished viewing the form, close the tab.
    6. To view the electronic form for the back side, which contains the static portion of the statement details page, click the blue Back of form link.

      The PDF page used for the back of the form opens in a new browser tab.

    7. When you are finished viewing the form, close the tab.
    8. Look at the value of the Media name for printing property.

      The property is set to Current name.

    9. Right-click the DetailsDuplex media object and select Properties.
    10. View the electronic forms for the front and back of the media.

      Both forms contain the static portion of the statement details page.

    11. Look at the value of the Media name for printing property.

      The property is set to Current name.

    12. Right-click the DetailsAndOffers media object and select Properties.
    13. View the electronic forms for the front and back of the media.

      The form for the front side contains the static portion of the statement details page. The form for the back side contains a page of offers (with static content).

    14. Look at the value of the Media name for printing property.

      The property is set to Selected: Letter Plain.

  4. Review the PreprintedDoc.pdf job.
    1. Right-click the job and select View.

      You see an 866-page job with 300 documents. Each document contains a customer statement with two, four, or six pages. You see only the variable data for the statement summary and transaction details.

    2. Click Close.
    3. Right-click the job and select Page Exceptions.

      You see a list of 265 page exceptions, for all the pages of all the documents in the job. The job requires three preprinted forms.

      • Most page exceptions are for SummaryAndDetails media, which is used for the first two pages of each statement.
      • If a statement has four pages with a summary page and two pages of transaction details, DetailsAndOffers media is used for pages 3–4.
      • If a statement has four pages with a summary page and three pages of transaction details, DetailsDuplex media is used for pages 3–4.
      • If a statement has six pages with a summary page and four pages of transaction details, DetailsDuplex media is used for pages 3–4. DetailsAndOffers media is used for pages 5–6.

  5. Review the ElectronicDoc.pdf job.
    1. Right-click the job and select View.

      You see an 866-page job with 300 documents. Each document contains a customer statement with two, four, or six pages. You see both the variable and static data for the statement summary and the transaction details. If the last page of a document does not have any transaction details, you see the offers.

      • Look at pages 1–4, the first document in the job. The electronic forms for the front and back of the SummaryAndDetails media have been combined with pages 1–2. The electronic forms for the front and back of the DetailsAndOffers media have been combined with pages 3–4.
      • Look at pages 5–6, the second document in the job. The electronic forms for the front and back of the SummaryAndDetails media have been combined with those pages.
      • Look at pages 301–304, a four-page statement with a summary page and three pages of transaction details. The electronic forms for the front and back of the SummaryAndDetails media have been combined with pages 301–302. The electronic forms for the front and back of the DetailsDuplex media have been combined with pages 303–304.
      • Look at pages 305–310, a six-page statement with a summary page and four pages of transaction details. The electronic forms for the front and back of the SummaryAndDetails media have been combined with pages 305–306. The electronic forms for the front and back of the DetailsDuplex media have been combined with pages 307–308. The electronic forms for the front and back of the DetailsAndOffers media have been combined with pages 309–310.

    2. Click Close.
    3. Right-click the job and select Page Exceptions.

      You see a list of 265 page exceptions, for all the pages of all the documents in the job.

      You see SummaryAndDetails and DetailsDuplex in the list because their Media name for printing property is set to Current name. The CombinePDFWithForm step combines the electronic forms for SummaryAndDetails and DetailsDuplex media with the data and but does not change the media names.

      You see LetterPlain in the list because the Media name for printing property of the DetailsAndOffers media is set to Selected: Letter Plain. The CombinePDFWithForm step combines the electronic forms for DetailsAndOffers media with the data and changes the DetailsAndOffers media name to LetterPlain.

    Keeping the SummaryAndDetails and DetailsDuplex media names associated with jobs lets a print shop use a different paper for those sheets. The print shop can also report paper costs to its management information system using those media names.

1.2.4.31.4 Modifying a workflow to use electronic forms with PDF jobs

You can add a step based on the CombinePDFWithForm step template to a workflow to combine an electronic form with data for PDF jobs.
Before you add the step to the workflow, review the preprinted forms used to print jobs that the workflow processes. Add electronic forms to the media objects for the preprinted forms that you want to print on plain paper. You do not have to define electronic forms for all the preprinted forms used by the workflow. You can define electronic forms only for the preprinted forms that you want to replace.
To modify a workflow to use electronic forms with PDF jobs:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Review the steps in the workflow and decide where you want to add the CombinePDFWithForm step.

    To modify a simple workflow that processes PDF jobs, you could put a CombinePDFWithForm step after the OptimizePDF step and before the CountPages step.

    To modify a workflow that processes PDF jobs that contain documents, you could put a CombinePDFWithForm step after the BuildPDFFromDocuments step.

  5. Add the CombinePDFWithForm step to the workflow in the appropriate place.
  6. Unless you have special processing requirements, use the default values for the Combined PDF file and JDF output file properties of the step.

    If you specify other values, the combined PDF file does not become the current print file used by subsequent steps. Similarly, the JDF file produced by the step does not become the JDF file used for subsequent steps.

  7. If you plan to use a printer that does not support Sides page exceptions in JDF job tickets, set the Simple sheet processing property to Insert blank back pages. If your printer can process Sides page exceptions, select Add Sides page exceptions to JDF, which will prevent any usage charges your printer vendor might charge for blank back sides on duplex jobs.
  8. Optional: Add a branch that bypasses the CombinePDFWithForm step to process jobs that are not ready to use electronic forms. Jobs print on preprinted forms when they go through that branch. When you add the branch, the same workflow can process the jobs that are ready to use electronic forms and the jobs that are not ready.

    To send the jobs to different branches based on whether they use electronic forms, set a rule on one of the branches. For example, if you want jobs with a Customer name of Acme or Pinnacle to use electronic forms, you could set this rule on the branch with the CombinePDFWithForm step:

    • Job.CustomerName = 'Acme' OR Job.CustomerName = 'Pinnacle'

    Jobs with a Customer name of Bank10 or Standard bypass the CombinePDFWithForm step and continue to print on preprinted forms.

  9. Save and enable the workflow.
  10. Test the workflow to make sure that it works properly.

    Check the jobs that the CombinePDFWithForm step processes to make sure that they print on the media specified by the Media name for printing property of the media object.

When a media object includes a form for the back of the media, the CombinePDFWithForm step changes simplex jobs that require the media to duplex. For example, a simplex job has four pages. The PLE Media property specifies Form12 for page 3. The Form12 media object specifies an electronic form for the back of the media.

When the step processes the job:

  • It converts the job to duplex.
  • It adds three blank pages, one each after pages 1, 2, and 4.
  • It adds a page with the data for Form12 after page 3.

When a media object includes a form for the back of the media and the JDF job ticket associated with the job specifies simplex for the job but includes page exceptions for some duplex pages, the CombinePDFWithForm step changes simplex jobs that require the media to duplex. For example, a simplex job has four pages. The PLE Media property specifies Form99 for pages 2 and 3. The Form99 media object specifies an electronic form for the back of the media.

When the step processes the job:

If the Simplex sheet processing property is set to Insert blank back pages, the step:

  1. Converts the job to duplex.
  2. Adds one blank page after page 1.
  3. Adds a page with the data for Form99 on the backs of pages 2 and 3.

    The back of page 3 has the data from page 4 and the data for Form99.

If the Simplex sheet processing property is set to Add Sides page exceptions to JDF, the step:

  1. Does not change the Duplex property for the job from Simplex.
  2. Adds a new duplex side page exception for page 2 in the JDF.
  3. Adds a page with the data for Form99 on the backs of pages 2 and 3.

1.2.4.31.5 Modifying a workflow to use electronic forms with AFP jobs

You can add a step based on the CombineAFPWithForm step template to a workflow to combine an electronic form with data for AFP jobs.

The step adds PDF pages as medium overlays to medium maps and creates an inline form definition containing those medium maps.

    Note:
  • The CombineAFPWithForm step template is available when the Preprinted Forms Replacement, PDF Document Support, and AFP Support features are installed.
  • The step ignores any values set for the Media and PLE Media job properties.
  • You cannot add an electronic form to a side of a sheet when the side already has eight medium overlays.

Before you add the step to the workflow:

  • Review the printers used to print jobs that the workflow processes. The output of the step can be printed only on AFP printers that support PDF object containers in AFP data.
  • Review the preprinted forms used to print jobs that the workflow processes. Add electronic forms to the media objects for the preprinted forms that you want to print on plain paper. You do not have to define electronic forms for all the preprinted forms used by the workflow. You can define electronic forms only for the preprinted forms that you want to replace.
  • Review the medium maps used to print jobs that the workflow processes. If the medium maps specify tray numbers, define a tray mapping file that replaces tray numbers with media names.

    To create the file, use an editor that saves text in UTF-8 format:

    • Map each tray to a RICOH ProcessDirector media name on a separate line.
    • Start each line with traytomedia, a space, the tray number, and a colon (:).
    • After the colon, put the RICOH ProcessDirector media name enclosed in quotation marks.

      White space on either side of the colon is optional.

      This example maps two trays to RICOH ProcessDirector media names:

      traytomedia 1 : "Letter Preprinted"
      traytomedia 2 : "A3"

      Make sure that the case of the RICOH ProcessDirector media name matches the case of the media name in the medium map. Letter Blue and LETTER BLUE do not match.

      If you specify a media name that is not a RICOH ProcessDirector media object, the step ignores the media name. The tray number remains in the medium map.

    • Save the mapping in a text file in UTF-8 format.

      For example, you could give the file a CFG extension and save it in a subdirectory of the /aiw/aiw1/control_files directory (Linux) or the C:\aiw\aiw1\control_files directory (Windows).

To modify a workflow to use electronic forms with AFP jobs:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Review the steps in the workflow and decide where you want to add the CombineAFPWithForm step.

    If your workflow has an afpnorm command in a step based on the RunExternalProgram step template, put the CombineAFPWithForm step after the RunExternalProgram step. You can use the afpnorm command to insert IMM structured fields before the first page of every document in an AFP file.

    To modify a simple workflow that processes AFP jobs, you could put a CombineAFPWithForm step after the UseInlineFormDefinition step (if it exists) and before the EnableRepositioning step.

    To modify a workflow that processes AFP jobs that contain documents, you could put a CombineAFPWithForm step after the BuildAFPFromDocuments step and before the EnableRepositioning step.

  5. Add the CombineAFPWithForm step to the workflow in the appropriate place.
  6. Set the properties for the step:
    • Unless you have special processing requirements, use the default value for the Combined AFP file property.

      If you specify another value, the combined AFP file does not become the current print file used by subsequent steps.

    • If you defined a tray mapping file, set the value of the Tray mapping file property to the full path and name of the file.

      You can use RICOH ProcessDirector symbol notation for the name of the file. See the example at the end of this procedure.

  7. Optional: Add a branch that bypasses the CombineAFPWithForm step to process jobs that are not ready to use electronic forms. Jobs print on preprinted forms when they go through that branch. When you add the branch, the same workflow can process the jobs that are ready to use electronic forms and the jobs that are not ready.

    To send the jobs to different branches based on whether they use electronic forms, set a rule on one of the branches. For example, if you want jobs with a Customer name of Acme or Pinnacle to use electronic forms, you could set this rule on the branch with the CombineAFPWithForm step:

    • Job.CustomerName = 'Acme' OR Job.CustomerName = 'Pinnacle'

    Jobs with a Customer name of Bank10 or Standard bypass the CombineAFPWithForm step and continue to print on preprinted forms.

  8. Save the workflow.
  9. Enable the workflow and test it to make sure that it works properly.

    Check the jobs that the CombineAFPWithForm step processes to make sure that they print on the media specified by the Media name for printing property of the media object.

The CombineAFPWithForm step can process AFP jobs that use an inline form definition or an external form definition. The step creates a combined AFP file that uses an inline form definition. If the AFP job uses an external form definition, the step embeds the changed form definition with new medium maps inline in the combined AFP file.

When a media object includes an electronic form for the back side, and the medium map specifies simplex printing, the CombineAFPWithForm step modifies the medium map:

  • It converts simplex to duplex.
  • It turns on the Constant Back flag.
  • It wraps the PDF file for the requested electronic form in an overlay and assigns the overlay to the back of the media.

Using a different tray mapping file for each printer

In this example, you want to use a different tray mapping file for each printer that can be requested for AFP jobs.

Name each file with the value of the Requested printer property (database name Job.RequestedPrinter) and a CFG extension.

Store the files in the tray_mapping subdirectory of the control_files directory.

Set this value for the Tray mapping file property:

  • /aiw/aiw1/control_files/tray_mapping/${Job.RequestedPrinter}.cfg on Linux
  • C:\aiw\aiw1\control_files\tray_mapping\${Job.RequestedPrinter}.cfg on Windows

1.2.4.32 Configuring document processing features

To configure document processing features, you define the custom document properties you need and then update them to make them available to the system. Using RICOH ProcessDirector Plug-in for Adobe Acrobat for PDF files or RICOH Visual Workbench for AFP files, you set up to use documents in your PDF or AFP jobs. You configure your PDF or AFP workflows to process documents. Finally, you make adjustments to maximize document processing performance on your system.

The workflow configuration topics in this section apply to the PDF Document Support and AFP Support features, which add basic document processing functions. To configure workflows for specialized needs, such as archiving document information in a repository, see the configuration information for the feature that adds the specialized functions and objects. Examples of these document processing features are:

  • Archive
  • Automated Verification
  • Inserter
  • Postal Enablement
  • Preference Management

If you get unexpected results when you process a PDF 2.0 file with a step based on the IdentifyPDFDocuments step, do one of these:

  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.
  • Place a step based on the OptimizePDF step template in the workflow before the IdentifyPDFDocuments step.

1.2.4.32.1 Defining custom document properties

You use custom document properties to extract data from each document in a job. First you define the custom document properties in RICOH ProcessDirector, and then you map data in the documents to the document properties. As a job goes through the workflow, the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files) extracts the data.

Identify data that you want to extract from documents. If RICOH ProcessDirector supplies an appropriate document property, use it instead of defining a custom document property.

For example, you want to extract account number, customer name, email address, and statement date from each document in a job. RICOH ProcessDirector supplies a document property, Email address, for extracting email addresses. You define custom document properties for account number, customer name, and statement date.

    Note:
  • If you use custom document properties, starting with Version 3.11.2, you can create them on the Administration tab, using Objects Custom Properties.

    You can choose the database name and the label that displays in property notebooks and column headings. You can also choose what kind of data to store in the property, and the default access that the different user groups have for the property, without adding them to the docCustomDefinitions.xml file.

    For more information, see the topics Custom job and document properties and Creating and activating custom properties.

  • If you already have custom document properties defined in a docCustomDefinitions.xml file, you can continue to use them. Do not re-create them from the Administration tab. Only use that tab to create new job or document properties.
  • If you want to use the new function made available in RICOH ProcessDirector in Version 3.11.2 to create a custom property:
To define custom document properties:
  1. Choose the type of custom document property:
    • Database property
    • Limited property

    For more information about each type of custom document property and how to define them, see the topic about the docCustomDefinitions.xml file in the information center.

  2. Choose a database (internal) name for the custom document property.

    For example, define a custom document property with the database name Doc.Custom.AccountNumber.

      Note:
    • We recommend that the database names of your custom document properties start with Doc.Custom. If you do not use this naming convention, verify that none of your custom document properties have the same database name as a document property supplied with RICOH ProcessDirector.

    • Do not use a number immediately after the period (.) in the database name. For example, the database name Doc.3rdLineAddress is not valid.
    • Do not delete custom document properties after you add them to the docCustomDefinitions.xml file.

    • Do not change the name (database name), dataType, or dbType of a custom document property. The system lets you change caption (user interface name), shortCaption, description, and access.

  3. Choose a user interface name (caption) for the custom document property.

    For example, define a custom document property with the user interface name Account number.

      Note:
    • We recommend that you do not define a custom document property with the same user interface name as a document property supplied by RICOH ProcessDirector.
  4. Choose a datatype (dataType) for the custom document property.

    Examples include String, Integer, IntegerNonNeg, and Timestamp.

  5. For database properties:
    1. Choose a database type (dbType).

      For the String datatype, database types are char, varchar, and long varchar.

      For the Integer datatype, database types are smallint, bigint, and integer.

      For the Timestamp datatype, the database type is Timestamp.

    2. Choose the level of access that users have to the custom document property:

      • attrWriteAdmin

        Members of the Administrator security group have write access. Members of the Monitor, Operator, and Supervisor security groups have read access.

      • attrWriteAdminSuper

        Supervisors and Administrators have write access. Monitors and Operators have read access.

      • attrWriteAdminSuperOper

        Operators, Supervisors, and Administrators have write access. Monitors have read access.

      If you do not specify an access level, Administrators have write access. Monitors, Operators, and Supervisors have read access.

        Note:
      • If you created your own security groups, they receive the same access to custom document properties as the RICOH ProcessDirector security groups that you copied to create your groups.

    3. Choose a short caption.

      The short caption is displayed in table column headings.

      For example, define a custom document property with the short caption Acct Nmbr.

    4. Choose a description.

      The user interface displays the description as help for the custom document property.

      For example, define a custom document property with the description Customer account number.

  6. Edit the document properties configuration file:
    • The first time that you define custom document properties, make a copy of the supplied sample file. Go to this directory:
      • /aiw/aiw1/samples/config on Linux

      • C:\aiw\aiw1\samples\config on Windows

    • When you define more document properties, make a copy of the active file. Go to this directory:
      • /aiw/aiw1/config on Linux

      • C:\aiw\aiw1\config on Windows

  7. Copy the docCustomDefinitions.xml file to a working directory, and edit the file.

    Keep a backup copy of the edited file for recovery purposes.

    For example, these lines add two database document properties with the database names Doc.Custom.AccountNumber and Doc.Custom.StatementDate to the file:

    <docProperty name="Doc.Custom.AccountNumber"
       datatype="String"
       dbType="varchar (32)"
       access="attrWriteAdmin"
       shortCaption="Acount number"
       caption="Account number"
       description="Customer account number"/>
    
    <docProperty name="Doc.Custom.StatementDate"
       datatype="Timestamp"
       dbType="Timestamp"
       access="attrWriteAdmin"
       shortCaption="Statement date"
       caption="Statement date"
       description="The date the statement was created"/>
      Note:
    • The name line defines the database name. The caption line defines the user interface name.

    These lines add two limited document properties with the internal names Doc.Custom.SSNumber and Doc.Custom.CheckAmt to the file:

    <limitedProperties>
    
       <docProperty name="Doc.Custom.SSNumber"
          datatype="String"
          caption="Social Security number"/>
    
       <docProperty name="Doc.Custom.CheckAmt"
          datatype="String"
          caption="Check total"/>
    
    </limitedProperties>
  8. Use an XML editor to validate your syntax.
  9. Copy the edited file to:
    • /aiw/aiw1/config/docCustomDefinitions.xml (Linux)
    • C:\aiw\aiw1\config\docCustomDefinitions.xml (Windows)
  10. To have any new document properties display correctly on the user interface, edit the docCustomDefinitions.properties file for one or more languages. If you do not define labels for the new properties in this file, you will only see database names for the properties on the user interface. See Naming custom document properties in more than one language for the steps to edit the file.
  11. Make the custom document properties that you have defined available to RICOH ProcessDirector:
    1. Run the docCustom utility.
      The first time that you run the docCustom utility, it creates the Custom Document Properties feature and adds it to Feature Manager. When you run the utility again, it adds an updated Custom Document Properties feature to Feature Manager.
    2. Use Feature Manager to install or update the Custom Document Properties feature.
  12. Load the RICOH ProcessDirector updated custom document properties to the tool you use to configure document properties:
    • If you have the PDF Document Support feature, load RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.

      For more information, see the related topic in the information center.

    • If you have the AFP Support feature, use one of these methods to start RICOH Visual Workbench:
      • Start RICOH Visual Workbench from the RICOH ProcessDirector server.

      • Replace the RICOH Visual Workbench application on your desktop:

        • Delete the VisualWorkbench.zip file and all of the unzipped files.

        • Download the VisualWorkbench.zip file from the RICOH ProcessDirector user interface.

        • Unzip the file, and start the new RICOH Visual Workbench desktop application.

      The document properties are loaded automatically.

1.2.4.32.2 Naming custom document properties in more than one language

To define user interface names and descriptive information for your custom document properties in more than one language, you edit a language-specific version of the docCustomDefinitions.properties file for each language. After you update your custom document properties, RICOH ProcessDirector displays the user interface names and descriptive information for the custom document properties in each language.

In a single-language environment, the preferred method of defining user interface text for custom document properties is to use the caption and description attributes of the docProperty element in the docCustomDefinitions.xml file. If you are using a single language and all custom document property descriptive text is defined in docCustomDefinitions.xml, do not edit the docCustomDefinitions.properties file.

To name custom document properties in more than one language:

  1. Make a working copy of the docCustomDefinitions.properties file for each language:
    • The first time that you name custom document properties in more than one language, make one copy of the sample docCustomDefinitions.properties file for each language except your default language. Navigate to this directory:

      • /aiw/aiw1/samples/config on Linux

      • C:\aiw\aiw1\samples\config on Windows

      Copy the docCustomDefinitions.properties file to a working directory.

      Name each file docCustomDefinitions_language.properties. For example:

      • docCustomDefinitions_de.properties (German)

      • docCustomDefinitions_en.properties (English)

      • docCustomDefinitions_es.properties (Spanish)

      • docCustomDefinitions_fr.properties (French)

      • docCustomDefinitions_it.properties (Italian)

      • docCustomDefinitions_ja.properties (Japanese)

      • docCustomDefinitions_pt.properties (Brazilian Portuguese)

        Important:
      • Do not create a docCustomDefinitions_language.properties file for your default language.

      • Make sure each file is owned by the RICOH ProcessDirector system user and group (aiw1 and aiwgrp1 are the defaults).

    • When you name additional document properties in more than one language, navigate to this directory:

      • /aiw/aiw1/config on Linux

      • C:\aiw\aiw1\config on Windows

      Copy each docCustomDefinitions_language.properties file to a working directory.

  2. Edit each file to add your new custom document properties.

    The entry for each custom document property has three lines:

    • Short caption

    • User interface name

    • Description

    These lines add two custom document properties with the database names Doc.Custom.AccountNumber and Doc.Custom.StatementDate to the docCustomDefinitions_es.properties file:

    Doc.Custom.AccountNumber.Short=Número de cuentaDoc.Custom.AccountNumber=Número de cuentaDoc.Custom.AccountNumber.Description=Número de cuenta del clienteDoc.Custom.StatementDate.Short=Fecha de extractoDoc.Custom.StatementDate=Fecha de extractoDoc.Custom.StatementDate.Description=Fecha en que se creó el extracto

    Keep a backup copy of each edited file for recovery purposes.

  3. If you did not create the file in Latin-1 or Unicode format, run the native2ascii utility to convert the file to Unicode Latin-1 format.

    • On Linux, the native2ascii utility is at /opt/infoprint/ippd/jre/bin.

    • On Windows, the native2ascii.exe utility is at C:\Program Files\Ricoh\ProcessDirector\jre\bin.

    For more information, see the related topic about considerations for a system with more than one language in the information center.

  4. Make sure that each docCustomDefinitions_language.properties file uses the ISO-8859-1 character encoding format (codepage).
    If your files use a different format, such as Shift JIS or UTF-8, convert them to ISO-8859-1 format before placing them in the configuration directory.
  5. Copy each edited file to the configuration directory:
    • /aiw/aiw1/config on Linux
    • C:\aiw\aiw1\config on Windows
      Important:
    • Do not delete the docCustomDefinitions.properties file. The system requires a file with that name in the configuration directory.
  6. Make the custom document properties that you have named in multiple languages available to RICOH ProcessDirector:
    1. Run the docCustom utility.
      The first time that you run the docCustom utility, it creates the Custom Document Properties feature and adds it to Feature Manager. When you run the utility again, it adds an updated Custom Document Properties feature to Feature Manager.
    2. Use Feature Manager to install or update the Custom Document Properties feature.
  7. Load the RICOH ProcessDirector updated custom document properties to the tool you use to configure document properties:
    • If you have the PDF Document Support feature, load RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.

      For more information, see the related topic in the information center.

    • If you have the AFP Support feature, use one of these methods to start RICOH Visual Workbench:
      • Start RICOH Visual Workbench from the RICOH ProcessDirector server.

      • Replace the RICOH Visual Workbench application on your desktop:

        • Delete the VisualWorkbench.zip file and all of the unzipped files.

        • Download the VisualWorkbench.zip file from the RICOH ProcessDirector user interface.

        • Unzip the file, and start the new RICOH Visual Workbench desktop application.

      The document properties are loaded automatically.

1.2.4.32.2.1 Considerations for a system with more than one language

If you are using a language other than English on your system, or if you want to let users see user interface text for custom document properties in more than one language, you might need to do these tasks.
Identifying the code page in docCustomDefinitions.xml

At the top of the docCustomDefinitions.xml file, make sure you correctly identify the code page so that the file can be processed correctly when you update configuration files. Here are some examples of valid code page declarations:

  • <?xml version="1.0" encoding="UTF-8"?> (specified in the sample file)
  • <?xml version="1.0" encoding="iso-8859-1"?> (Latin-1)
  • <?xml version="1.0" encoding="shift_jis"?> (Japanese)

Making sure the document properties names files are in ISO-8859-1 format

The docCustomDefinitions.properties file and docCustomDefinitions_language.properties files must contain only Latin-1 or Unicode-encoded (\udddd notation) characters. If you created your docCustomDefinitions.properties and docCustomDefinitions_language.properties files in a different format (such as Shift JIS or UTF-8), you must convert each file to ISO-8859-1 before placing it in the /aiw/aiw1/config (UNIX-based operating systems) or C:\aiw\aiw1\config (Windows) directory. Although you can convert the files using whatever method you choose, this section describes one possible method: using the native2ascii utility.

The native2ascii utility converts text to Unicode Latin-1. It is shipped with RICOH ProcessDirector.

  • On Linux, the native2ascii utility is at /opt/infoprint/ippd/jre/bin.
  • On Windows, the native2ascii.exe utility is at C:\Program Files\Ricoh\ProcessDirector\jre\bin.

The utility is also provided with the Java Development Kit, which you can download from this site:

http://www.oracle.com/technetwork/java/javase/downloads

Instructions for using the utility (for Java 6) are here:

http://download.oracle.com/javase/6/docs/technotes/tools/#intl

For example, to convert a UTF-8 file named docCustomDefinitions-UTF8.properties, you can use this command:

native2ascii -encoding UTF-8 docCustomDefinitions-UTF8.properties > docCustomDefinitions.properties

1.2.4.32.3 Updating custom document properties

Whenever you define new custom document properties or name custom document properties in more than one language, you update custom document properties to make your changes available to RICOH ProcessDirector.
    Note:
  • Only use this procedure for custom document properties defined in the docCustomDefinitions.xml file. If you created custom properties using the Administration tab, this procedure is not required.
Before doing this task, verify that the syntax in the docCustomDefinitions.xml file is correct.
To update custom document properties:
  1. Log in to the primary server as the RICOH ProcessDirector system user.
    • For Linux, aiw1 is the default.
    • For Windows, log in to the Administrator account.
  2. Open a command line.
  3. Change directories.
    • For Linux, use cd /aiw/aiw1/bin.
    • For Windows, use cd C:\aiw\aiw1\bin.
  4. Enter this command to run the utility:
    docCustom
    The Custom Document Properties feature EPK file is created and available in the Feature Manager.
  5. Close the command line.
  6. Log in to RICOH ProcessDirector.
  7. Click the Administration tab.
  8. In the left pane, click Utilities Features.
  9. Select the check box for the Custom Document Properties feature.
  10. In the Available versions column for each feature, select the version of the feature you want to install.
  11. Click Install.
  12. Review the information in the confirmation window, then click OK to continue.
    The features are installed, then RICOH ProcessDirector is restarted to finish the install process.
  13. Click DISMISS to close the Feature Manager browser tab.
  14. Check that your new document properties are defined on the system:
    1. Log in to RICOH ProcessDirector.
    2. In the Documents portlet on the Main page, click By property.
    3. Click the Edit () button.
    4. Scroll through the Property list to see if it includes your new properties.

If you have the PDF Document Support feature installed and you change document property names in RICOH ProcessDirector, load a new document properties list into RICOH ProcessDirector Plug-in for Adobe Acrobat.

If you have the AFP Support feature installed and you change document property names in RICOH ProcessDirector, access RICOH Visual Workbench from the RICOH ProcessDirector user interface. New document properties are loaded to RICOH Visual Workbench when it opens on your workstation.

1.2.4.32.4 Maximizing the performance of document properties files

To maximize the performance of document properties files, you edit the document properties template file. The template file determines which properties go into the document properties file for a job. The template file lets you control the number of document properties to be used, as well as the order of the columns in the document properties file. If you need to maximize performance on your system by assigning only a subset of document properties, make sure that any properties needed by your workflow steps are listed in the document properties template file.
The document properties template file contains the database names of document properties. Steps based on the ReadDocumentsFromDatabase step template use the content of the document properties template file to create the document properties file.

Using a document properties template file is optional, but recommended if you need to maximize performance. If you do not use it, all document properties are included in the generated document properties file.

The document properties template file must include all the properties needed by steps that process the document properties file. In addition, the document properties template file must include certain properties, depending on the step that is using the template file. These properties are required by CreateAFPJobsFromDocuments, BuildAFPFromDocuments, and BuildPDFFromDocuments:

  • Doc.ChildJobID (*)
  • Doc.OriginalJobID (*)
  • Doc.OriginalSequence (*)
  • Doc.SequenceInChild (*)
  • Doc.OriginalSheets
  • Doc.DataOffset (for AFP jobs only)
  • Doc.DataLen (for AFP jobs only)

You do not need to define the Doc.ID property or the properties marked with an asterisk (*) in the document property template; the system automatically includes them in the document properties file. Steps based on the WriteDocumentsToDatabase step template define Doc.ID; IdentifyDocuments and IdentifyPDFDocuments define the others.

If you have the Inserter feature and you edit the sample document properties template file, include these Inserter document properties in the template if they are relevant to your workflow:

  • Doc.Insert.BinTriggers
  • Doc.Insert.DivertBin
  • Doc.Insert.RecipientName
  • Doc.Insert.OriginalBarCode

You can use more than one document properties template file in one RICOH ProcessDirector system.

To edit a document properties template file:

  1. The sample document properties template file named docPropTemplate.txt is in the /path/extensions/doc/samples directory. For example, on Linux, the path is /opt/infoprint/ippd. On Windows, the path is C:\Program Files\Ricoh\ProcessDirector. Copy the sample file to the location where you want to store it. You specify the path to this file in the ReadDocumentsFromDatabase step.
  2. Edit the file to contain the properties that you want to use for step processing by a specific workflow.
    Keep these tips in mind:
    • Add the custom document properties that are important for the job. For example, if the workflow will sort the documents in postal code order, make sure the Postal Code document property is included in the template file.
    • Include only the necessary properties. Limiting the number of properties improves performance and reduces the amount of storage space needed to store the document property data.
    • You can include all entries on a single line with a space or a tab character between each property, or you can place each entry on a separate line.
    • You can include job properties in the document properties template file.
  3. Optional: Create additional document properties template files.
    For example, if you copy the PrintDocuments workflow multiple times and want to manipulate a different set of document properties for each of the new workflows, create a document properties template file for each new workflow.

1.2.4.32.5 Configuring AFP Support for documents

To configure the AFP Support feature for documents, you set up to use documents in AFP jobs, and you configure your AFP workflows to process documents.

The functions in RICOH Visual Workbench let you set up to use documents in AFP jobs. For example, you define how to identify the documents.

The functions on the RICOH ProcessDirector Workflow page let you configure your AFP workflows to process documents. For example, you add steps that identify documents and build AFP files from the documents. Other steps let you sort, split, and group documents and pull documents from a job.

1.2.4.32.5.1 Setting up to use documents in AFP jobs

To use documents in AFP jobs, you define how to identify the documents, map data in the documents to RICOH ProcessDirector document properties, and add markup to the documents. Finally, you save the setup information in Enhance AFP and RICOH Visual Workbench control files.
You map data in the documents to document properties supplied with RICOH ProcessDirector or to custom document properties that you define. Define the custom document properties before you use the Document Property Designer mode of RICOH Visual Workbench.
Note: This procedure gives general setup instructions. For detailed instructions, see the related topics.
To set up to use documents in AFP jobs:
  1. Open an AFP file in RICOH Visual Workbench.
  2. Use the AFP Indexer mode of RICOH Visual Workbench to create page groups, which identify the start of each document in a job.

    You define triggers that specify document boundaries, or you create fixed-length page groups.

  3. Use the AFP Indexer mode to create index tags for the data that you map to document properties.
  4. Use the Document Property Designer (DPD) mode to link each document property to indexed data in the documents:
    1. Double-click the document property name at the bottom of the window.
    2. Supply the requested information in the Define Link Options dialog.

      When a document property is linked to an index tag, the value of the document property is the same as the value of the indexed data.

  5. Add markup:
    1. Create an Enhance AFP control file to define where to place AFP data on a page.

      Use the AFP Enhancer mode to create barcodes, add text, and mask text or graphics by creating hidden areas (cover blocks).

      Note: The AFP Editor feature also lets you create barcodes, add text, and mask text or graphics by creating hidden areas. AFP Editor is not supplied with RICOH ProcessDirector. You must purchase the feature.
    2. Use the Whitespace Manager feature to define available areas of white space in AFP files and then fill the white space with content, such as images and text. You base the content on rules that you define. Whitespace Manager is not supplied with RICOH ProcessDirector. You must purchase the feature.
  6. If you created an Enhance AFP control file:
    1. Click Tools Export EnhanceAFP Control File.
    2. Send or copy the file to a directory on the primary computer that the RICOH ProcessDirector system user has access to.
  7. Click File Save Control File to save the RICOH Visual Workbench control file.

    The RICOH Visual Workbench control file contains AFP Indexer and Document Property Designer definitions. If you have AFP Editor or Whitespace Manager, the control file also contains those definitions.

  8. Send or copy the RICOH Visual Workbench control file to a directory on the primary computer that the RICOH ProcessDirector system user has access to.
When you create workflows that process AFP jobs containing documents:
  • Specify the name of the Enhance AFP control file in each step based on the BuildAFPFromDocuments step template.

  • Specify the name of the Visual Workbench control file in each step based on the IdentifyDocuments or IndexAFP step template.

  • If you have AFP Editor, specify the name of the Visual Workbench control file in each step based on the EditAFP step template.

  • If you have Whitespace Manager, specify the name of the Visual Workbench control file in each step based on the FillWhiteSpace step template.

1.2.4.32.5.2 Configuring steps to identify documents in AFP files

After you have linked document or job properties to index tags in a sample AFP file, you must configure the step that determines values for document or job properties in production AFP files. The step names the Visual Workbench control file that contains information about how properties are linked to index tags.

Steps that calculate values for properties are based on the IdentifyDocuments step template. Some RICOH ProcessDirector features provide workflows containing an IdentifyDocuments step. If you use any of those supplied workflows, you can configure the IdentifyDocuments step in the workflow to specify the name of the Visual Workbench control file. These are examples of workflows supplied with RICOH ProcessDirector features:

  • ReceiveInsert_I (provided with the Inserter feature)
  • SortAFP
  • SortSplitAFP
  • VerifySample (provided with the Automated Verification feature)

If you add an IdentifyDocuments step to another workflow, keep these tips in mind:

  • The same control file is used for the IndexAFP step, the EditAFP step, and the IdentifyDocuments step.
  • The IdentifyDocuments step must be after the IndexAFP step, if it is present, and all steps that update the AFP file.

To configure a step that identifies documents in AFP files:

  1. Click the Workflow tab.
  2. Copy a workflow that contains the IdentifyDocuments step.
  3. Right-click the IdentifyDocuments step and select Properties.
  4. If necessary, change the properties for the step in the right side of the window.
  5. If you previously linked properties to index tags, this step is required. Otherwise, it is optional. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains information about how properties are linked to index tags, or use symbol notation to refer to it. RICOH Visual Workbench created this control file when you linked properties to index tags. The default extension for control files is .ctl. If you do not specify a control file, IdentifyDocuments uses any page group information that is already in the AFP file to identify documents, and no index tags in the AFP file are mapped to document properties.
  6. If the input AFP file does not already contain index tags and you use the AFP Indexer mode of RICOH Visual Workbench, add the IndexAFP step before the IdentifyDocuments step.
  7. Click OK.
  8. Save and enable the workflow.

1.2.4.32.5.3 Workflow to split AFP jobs by size

The AFP Support feature includes step templates that you can use to split a job into smaller jobs so that, for example, they can be printed on separate printers.

To split a job without fragmenting any of its documents across two jobs, you must identify the boundaries of the documents in the job. To do that, you must define page groups in the AFP file, either when you create the job, or by using a step based on the IndexAFP step template, provided with the AFP Support feature.

The IdentifyDocuments step applies the rules that you defined in Document Property Designer to create the document property file for the original job. The SplitDocuments step determines which documents are placed into each child job, and updates the document properties file with that information.

Now you can choose a method for building the new AFP files for the child jobs:

  • You can use a CreateJobsFromDocuments step, which makes document properties files for the child jobs but does not create AFP files. In this implementation, you must include a BuildAFPFromDocuments step in the workflow assigned to the child jobs. BuildAFPFromDocuments creates the AFP file with all the documents in the correct order. We recommend this method. Because BuildAFPFromDocuments is defined in the child workflow, the step runs in parallel for all the child jobs. This parallel processing can cause the overall job to complete faster, although the existence of several parallel processes might lead to database contention issues in rare cases.
  • You can add a CreateAFPJobsFromDocuments step in the Assemble phase of this workflow. If you choose this method, all the AFP files for all the child jobs are built sequentially.

    We do not recommend this method if you have the Inserter feature and the inserter controller specifies the open-loop reprint method. You must add the BuildAFPFromDocuments step in the child workflow for the open-loop reprint method; so, adding the CreateAFPJobsFromDocuments step in the original workflow causes duplicate processing, and degrades system performance.

The original workflow does not have any steps in the Print phase because the child workflow controls printing. After all the child jobs complete, the parent job goes to the next step in the original workflow.

The child workflow should begin with steps based on these two step templates: SetJobPropsFromTextFile and SetJobPropsFromOriginal. SetJobPropsFromTextFile sets values for job properties from the steps of the child workflow. SetJobPropsFromOriginal copies the values that were set in the original workflow to become the values for those properties in the child workflow. Then if you chose to run the building of the child AFP files in parallel by including a CreateJobsFromDocuments step in the original workflow, you need to use a BuildAFPFromDocuments step in the child workflow.

    Note:
  • If you have customized phase names in your system, the phase names in the tables might not match the names in your system.
Splitting jobs by size, using CreateJobsFromDocuments
Parent/child Phase Step
Parent Receive SetJobPropsFromTextFile

In the Input data stream field, select AFP.

Prepare UseInlineFormDefinition
IndexAFP
EnableRepositioning
IdentifyDocuments
Assemble SplitDocuments
CreateJobsFromDocuments
Complete RetainCompletedJobs
RemoveJobs
Child Receive SetJobPropsFromTextFile
SetJobPropsFromOriginal
Assemble BuildAFPFromDocuments
Print EnableRepositioning
CreatePageRanges
PrintJobs
Complete RetainCompletedJobs
RemoveJobs

Splitting jobs by size, using CreateAFPJobsFromDocuments
Parent/child Phase Step
Parent Receive SetJobPropsFromTextFile

In the Input data stream field, select AFP.

Prepare UseInlineFormDefinition
IndexAFP
EnableRepositioning
IdentifyDocuments
Assemble SplitDocuments
CreateAFPJobsFromDocuments
Complete RetainCompletedJobs
RemoveJobs
Child Receive SetJobPropsFromTextFile
SetJobPropsFromOriginal
Print EnableRepositioning
CreatePageRanges
PrintJobs
Complete RetainCompletedJobs
RemoveJobs

1.2.4.32.5.4 Workflow to split jobs by document property

Instead of splitting an AFP job into several jobs using job size as the criterion, you might want to use the value of a document property, such as country or sales region. In this scenario, you use a step based on the GroupDocuments step template instead of on the SplitDocuments step template. Each group of documents becomes a separate child job.

You can use a step based on the GroupDocuments step template to gather all the documents of one group into a single child job. You can use up to six grouping criteria to create child jobs. Each child job contains only the members of a group, such as all statements for each of five cities in each of 10 countries.

These tables summarize the recommended workflow configuration using CreateJobsFromDocuments, and an alternate workflow configuration using CreateAFPJobsFromDocuments.

    Note:
  • If you have customized phase names in your system, the phase names in the tables might not match the names in your system.
Splitting jobs by document property, using CreateJobsFromDocuments
Parent/child Phase Step
Parent Receive SetJobPropsFromTextFile

In the Input data stream field, select AFP.

Prepare UseInlineFormDefinition
IndexAFP
EnableRepositioning
IdentifyDocuments
Assemble GroupDocuments
CreateJobsFromDocuments
Complete RetainCompletedJobs
RemoveJobs
Child Receive SetJobPropsFromTextFile
SetJobPropsFromOriginal
Assemble BuildAFPFromDocuments
Print EnableRepositioning
CreatePageRanges
PrintJobs
Complete RetainCompletedJobs
RemoveJobs

Splitting jobs by document property, using CreateAFPJobsFromDocuments
Parent/child Phase Step
Parent Receive SetJobPropsFromTextFile
Prepare UseInlineFormDefinition
IndexAFP
IdentifyDocuments
Assemble GroupDocuments
CreateAFPJobsFromDocuments
Complete RetainCompletedJobs
RemoveJobs
Child Receive SetJobPropsFromTextFile
SetJobPropsFromOriginal
Print EnableRepositioning
CreatePageRanges
PrintJobs
Complete RetainCompletedJobs
RemoveJobs

1.2.4.32.6 Working with sample AFP files

You can use RICOH Visual Workbench to enhance a sample AFP file.

The sample AFP file should be representative of production AFP files that users submit to RICOH ProcessDirector for processing. RICOH ProcessDirector can then make the same enhancements to production AFP files when it prepares them for processing.

To enhance AFP files, first you open a sample AFP file in RICOH Visual Workbench and make enhancements to it. RICOH Visual Workbench adds information about the enhancements to a control file. Then, you add a step that names the control file to the workflows for production AFP files that are similar to the sample AFP file. RICOH ProcessDirector uses the information in the control file to enhance the production AFP files in the same way you enhanced the sample AFP file.

1.2.4.32.6.1 Installing RICOH Visual Workbench

Install RICOH Visual Workbench 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 RICOH Visual Workbench on systems running Java 1.8 or higher and any of these operating systems:

  • Windows 10 Pro or Enterprise 64-bit
  • Windows 11 Pro
  • Windows Server 2016 64-bit
  • Windows Server 2019 64-bit
  • Windows Server 2022 64-bit
  • CentOS Linux 7.7 through latest 7.X for x86_64
  • Red Hat 7.6 through latest 7.X
  • Red Hat 8.1 through latest 8.X
  • SUSE Linux Enterprise Server (SLES) 12.0 with Service Pack 4 or above for x86_64
  • SUSE Linux Enterprise Server (SLES) 15.0 with Service Pack 1 or above for x86_64

To install RICOH Visual Workbench:

  1. Log in to RICOH ProcessDirector.
  2. Open Administration Utilities Visual Workbench
  3. Click RICOH Visual Workbench 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 RICOH Visual Workbench.
    A collection of folders and files are stored in the location you specify. The installation is complete.
  5. To start RICOH Visual Workbench:
    • 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.2.4.32.6.2 Displaying sample AFP files

You can open a sample AFP file in RICOH Visual Workbench. 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 RICOH Visual Workbench at a time. If an AFP file is already open, RICOH Visual Workbench 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 RICOH Visual Workbench, or you might need to modify RICOH Visual Workbench 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 RICOH Visual Workbench (Resources Specify Resource Directories).
    • If the AFP file refers to custom AFP fonts, create custom font-mappings in RICOH Visual Workbench.
  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.2.4.32.6.3 Creating and updating control files

When you open a sample AFP file to enhance it, RICOH Visual Workbench can either create a control file or update a control file that you created previously. The control file contains definitions that tell RICOH ProcessDirector 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.

You control which definitions in the control file RICOH ProcessDirector uses when it enhances production AFP files. For example, a control file might contain definitions that AFP Indexer created (such as definitions to add index tags) and definitions that AFP Editor created (such as definitions to add bar codes). If you want to add index tags but no bar codes to some production AFP files, you would add an IndexAFP step to the workflow. If you want to add index tags and bar codes to other production AFP files, you would add an IndexAFP step and an EditAFP step to the workflow (or you could add only an EditAFP step and select the Index first option for the step).

To create or update a Visual Workbench control file:
  1. In RICOH Visual Workbench, 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.
      Note: If you want to use the same workflow for input files that require different control files, you must use a control file name that corresponds to a job property that can be referenced with symbolic notation. For example, if you have two input files, abc.afp and xyz, you can use ${Job.InputFile}.ctl as the control file as long as the control files are named, abc.afp.ctl and xyz.ctl.
    • To save an updated control file with the same name, click File Save control file.

1.2.4.32.6.4 Identifying AFP resource directories

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

You can specify as many resource directories to RICOH Visual Workbench as necessary.

RICOH Visual Workbench 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 RICOH Visual Workbench, in the order the directories are specified
  3. Default resource directories, in this order:
    1. /aiw/aiw1/resources (on Linux) or C:\aiw\aiw1\resources (on Windows)
    2. /usr/lpp/psf/reslib (on Linux) or C:\usr\lpp\psf\reslib (on Windows)
    3. /usr/lpp/afpfonts (on Linux) or C:\usr\lpp\afpfonts (on Windows) fonts only
    4. /usr/lpp/psf/fontlib (on Linux) or C:\usr\lpp\psf/fontlib (on Windows) fonts only
If you have mapped an AFP font to a Java font in a customized font-mapping file, RICOH Visual Workbench 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, RICOH Visual Workbench uses the resource directories that you had specified, if any, the last time you worked with that AFP file using the same control file.

    Note:
  • For accurate results when you use AFP Indexer, specify the same AFP resource directories that are in the AFP resource path property in RICOH ProcessDirector. (This property is typically specified in the PrintJobs step in the workflows that the production AFP jobs use.)

To identify AFP resource directories:
  1. In RICOH Visual Workbench, 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.2.4.32.6.5 Mapping fonts for AFP files

If RICOH Visual Workbench 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 RICOH Visual Workbench 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 RICOH Visual Workbench, you can change the character set mapping.

AFP font mappings can be located in multiple places. RICOH Visual Workbench looks for font mappings in this order:

  1. Job font mappings in the Visual Workbench 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 RICOH Visual Workbench:

  • 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 RICOH Visual Workbench 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.2.4.32.6.5.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 RICOH Visual Workbench provides in directory /aiw/aiw1/lib/AVE/resources.

The mappings in the font-mapping files are used to display all AFP files in RICOH Visual Workbench unless an AFP font is mapped to a Java font in the Visual Workbench control file.

To use font-mapping files to map an AFP font to a Java font:
  1. Log in to the computer as the RICOH ProcessDirector system user (aiw1 is the default), or with a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
    You can also log in as the root user.
  2. Navigate to the /aiw/aiw1/lib/AVE/resources directory.
  3. 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.
  4. 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.2.4.32.6.5.2 Creating font mappings from text blocks

When RICOH Visual Workbench 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 RICOH Visual Workbench.

To create a font mapping from a text block:
  1. In RICOH Visual Workbench, 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 RICOH Visual Workbench 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 RICOH Visual Workbench 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.2.4.32.6.5.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 RICOH Visual Workbench, 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.2.4.32.6.5.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 RICOH Visual Workbench to use a different default code page. However, when you use an existing control file, RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.6 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 RICOH Visual Workbench, 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.2.4.32.6.7 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 RICOH Visual Workbench 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 RICOH Visual Workbench so that RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.8 Specifying a form definition

You can specify whether RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.9 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 RICOH Visual Workbench, 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.
      RICOH Visual Workbench 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.

      RICOH Visual Workbench runs the filters in order, from top to bottom.
  6. To save your changes, click Apply.

1.2.4.32.6.10 Creating barcodes with AFP Enhancer

AFP Enhancer lets you create barcodes in AFP files.

The barcode must be a consistent size and in a consistent position on every page. 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. Start at the top-left corner of the page and measure the distance to the top-left corner of the barcode area. The horizontal distance is the X position; the vertical distance is the Y position. For BCOCA barcode objects, also measure the width and height of the area to determine where to place the bottom-right corner. The X position of the bottom-right corner is the X position of the top-left corner plus the width. The Y position of the bottom-left corner is the Y position of the top-left corner plus the height.

Note: In RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To create a barcode:
  1. In RICOH Visual Workbench, 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. If you want the barcode to include data from a document property and an index tag is not mapped to the document property, use Document Property Designer (DPD) to link the index tag to the document property.
  4. Click Mode AFP Enhancer.
  5. 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.
  6. Position your cursor at the top-left corner of the barcode area. While pressing the left mouse button, draw a box the approximate size of the barcode area.

    In a later step, you specify the exact position and size of the barcode area.

  7. Right-click anywhere in the AFP file and click Create barcode.
  8. On the Type tab, type a name for the barcode area.
  9. Select the barcode type.

    The table shows the valid characters for each barcode type.

    Valid characters for barcodes
    Barcode type Valid characters Total number of characters
    Code 39 0123456789 ABCDEFGHIJKLM NOPQRSTUVWXYZ - . $ / + % space character 0 to 50 characters
    Interleaved 2-of-5 0123456789 0 to 50 characters
    Data Matrix Any one-byte character, or binary data 0 to 3116 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
    Intelligent Mail barcode 0123456789 20 to 31 characters

  10. Select a generation method:
    • BCOCA objects

      This object follows the Bar Code Content Object Architecture (BCOCA).

      Generic barcodes

      This object guarantees compatibility on all IPDS printers.

      Font barcodes

      A Presentation Text Object Content Architecture (PTOCA) object with transparent text represents the content. The referenced font resource must be available when printing.

      DrawRule barcodes

      A PTOCA object uses rules to represent the content.

  11. Specify the content of the barcode using Content Expression Language (CEL).

    AFP Enhancer provides several CEL examples for you to select and modify. For more information, see the related reference topic on supplied CEL examples in the RICOH ProcessDirector information center.

      Note:
    • You can type carriage return control characters in the Content area. The carriage returns are removed when you export your enhancements to an EnhanceAFP control file.

    • You can copy CEL expressions from other sources and paste them into the Content area.

    • AFP Enhancer does not validate CEL syntax.

  12. Specify properties for the type of barcode you selected.
    The table describes the properties for each barcode type.
    Barcode properties
    Barcode type Property and description
    Code 39 and Interleaved 2-of-5 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: If you select Auto, an appropriate number of rows is used for the amount of data in the barcode symbol.
    Row size: If you select Auto, an appropriate row size is used 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.
    Intelligent Mail barcode None
  13. Click the Location tab.
  14. Specify the location of the barcode area:
    • In the Location fields, specify the X and Y positions of the top-left corner.
    • In the Right Location fields, specify the X and Y positions of the top-left corner on right-hand pages.
        Note:
      • If you do not specify values for the Right Location fields, AFP Enhancer uses the values in the Location fields for all pages.

      • Use values in both the Location and Right Location fields if 2–up is enabled and the Page Placement value is All Fronts Left And Right.

    AFP Enhancer lets you specify decimal values for the X and Y positions or use CEL expressions. For example, a CEL statement can position a barcode to the right of indexed data that varies in each document.

    Note: To specify an orientation of 90, 180, or 270 degrees, you edit the EnhanceAFP control file manually after you save the barcode in the Visual Workbench control file. Then you export the EnhanceAFP control file.

  15. Specify the pages on which to place the barcode in each page group.
  16. Optional: Specify a trigger using a CEL expression.

    Examples:

    • You want to place a barcode on every document with two or more pages. Use this expression:

      total_pages_in_mp != 1

    • You want to place a barcode on each document sent to California that has yes as the value of the Doc.Custom.PolicyDiscount document property. Use this expression:

      and(Doc.State == CA, Doc.Custom.PolicyDiscount == yes)

  17. Click the Preview tab.

    The Origin of area values show the X and Y positions of the upper-left corner of the barcode area you drew. The Size of area values show the width and height of the barcode area.

    Note: The values on the Preview tab are used to display the barcode in RICOH Visual Workbench. They do not change when you change the values on the Location tab. The values on both tabs are saved in the Visual Workbench control file. Only the values on the Location tab are exported to the EnhanceAFP control file and used to place the barcode on the documents in the AFP file.

  18. Type sample barcode data in the Sample Text field.
    If you leave the field blank, the barcode symbol does not display in RICOH Visual Workbench.
    Note: Intelligent Mail barcodes are an exception. They display even when the Sample Text field is blank.
  19. Click OK.
    You see the barcode symbol in the AFP file.
      Note:
    • Preview displays the barcode on the same relative page in each page group. If you drew the barcode area on page 1 of one document, Preview displays the barcode on page 1 of all the documents. The page placement and trigger values on the Location tab specify barcode placement on the pages of the documents in jobs in the workflow.

    • If you created a text IMB but do not see the barcode symbol, identify the resource directory that contains the AFP IMB font to RICOH Visual Workbench (Resources Specify Resource Directories). The AFP IMB font is installed in the aiw/aiw1/plugins/EditAFP (Linux) or C:\aiw\aiw1\plugins\EditAFP (Windows) directory.

  20. Click File Save Control File to save the barcode in the Visual Workbench control file.
  21. When you are ready to use the enhancements in the Visual Workbench control file (including the new barcode) in your workflow, click Tools Export EnhanceAFP Control File and choose a directory for the exported file.
  22. To specify an orientation of 90, 180, or 270 degrees, add this line to the EnhanceAFP control file with a text editor:

    #Afp.barcode_type.Orientation[barcode_name]=Degrees90

    where barcode_type is the type of barcode in the EnhanceAFP control file and barcode_name is the name that identifies a barcode, text insertion, or hidden area.

    For example:#Afp.LinearBarcode.Orientation[IMB-Verify]=Degrees90

    Note: When you edit an EnhanceAFP control file manually, the edits are not saved in the Visual Workbench control file. If you make additional enhancements and save them in the Visual Workbench control file, you must export the EnhanceAFP control file to make the new enhancements available to the workflow. Then you must manually edit the new EnhanceAFP control file to add the edits that you made in the original EnhanceAFP control file.

    This figure shows four barcode areas with different orientations (0, 90, 180, 270 degrees) of the barcode symbol.

    Barcode areas with four orientations of barcode symbol
    Image showing 4 barcodes with symbols in different orientations

1.2.4.32.6.11 Creating text with AFP Enhancer

You can create text on a specified page of each page group in an AFP file and specify its 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.

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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To create text:
  1. In RICOH Visual Workbench, 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 Enhancer.
  4. Navigate to the page where you want to create the text:
    • To place text on the same page in every page group, navigate to that page in any page group.
    • To place text 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 the top-left corner of the text area. While pressing the left mouse button, draw a box the approximate size of the text area.

    In a later step, you specify the exact position and size of the text area.

  6. Right-click anywhere in the AFP file and click Create Text.
  7. On the Text tab, type a name for the text.
  8. Specify the text using Content Expression Language (CEL).

    AFP Enhancer provides several CEL examples for you to select and modify. For more information, see the related reference topic on supplied CEL examples in the RICOH ProcessDirector information center.

      Note:
    • You can type carriage return control characters in the Content area. The carriage returns are removed when you export your enhancements to an EnhanceAFP control file.

    • You can copy CEL expressions from other sources and paste them into the Content area.

    • AFP Enhancer does not validate CEL syntax.

  9. Click the Font tab and select the type of font:
    • Inline Fonts
      • For Select Character set and Code Page, select a character set and code page from the drop-down lists.
      • For Coded Font, select an option from the drop-down list.
    • 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: If the character names do not match between a character set and code page, the job goes into an error state in RICOH ProcessDirector and the printer issues an error. To correct the error, change the character set and code page to a valid pair and process the job again.
  10. Click the Location tab.
  11. Specify the location of the text:
    • In the Location fields, specify the X and Y positions of the top-left corner.

      X
      The horizontal distance of the left side of the text 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
      The vertical distance of the top of the text 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 distances of the top-left corner of the box that you drew.

    • In the Right Location fields, specify the X and Y positions of the top-left corner on right-hand pages.
        Note:
      • If you do not specify values for the Right Location fields, AFP Enhancer uses the values in the Location fields for all pages.

      • Use values in both the Location and Right Location fields if 2–up is enabled and the Page Placement value is All Fronts Left And Right.

    AFP Enhancer lets you specify decimal values for the X and Y positions or use CEL expressions. For example, a CEL statement can position text to the right of indexed data that varies in each document.

    Note: To specify an orientation of 90, 180, or 270 degrees, you edit the EnhanceAFP control file manually after you save the text in the Visual Workbench control file. Then you export the EnhanceAFP control file.

  12. Specify the pages on which to place the text in each page group.
  13. Optional: Specify a trigger using a CEL expression.

    Examples:

    • You want to place text on every document with two or more pages. Use this expression:

      total_pages_in_mp != 1

    • You want to place text on each document sent to California that has yes as the value of the Doc.Custom.PolicyDiscount document property. Use this expression:

      and(Doc.State == CA, Doc.Custom.PolicyDiscount == yes)

  14. Click the Preview tab and type text in the Sample Text field.

    The text you type on the Preview tab is used to display the text in RICOH Visual Workbench. The text is saved in the Visual Workbench control file. Only the information in the Content (CEL) field is exported to the EnhanceAFP control file and used to place the text on the documents in the AFP file.

  15. Optional: Change the X position and Y position values.

    The Origin of area values show the X and Y positions of the upper-left corner of the text area you drew.

    Note: The values on the Preview tab are used to display the text in RICOH Visual Workbench. They do not change when you change the values on the Location tab. The values on both tabs are saved in the Visual Workbench control file. Only the values on the Location tab are exported to the EnhanceAFP control file and used to place the text on the documents in the AFP file.

  16. Click OK.

    Preview displays the text on the same relative page in each page group. If you drew the text area on page 1 of one document, Preview displays the text on page 1 of all the documents. The page placement and trigger values on the Location tab specify text placement on the pages of the documents in jobs in the workflow.

  17. Click File Save Control File to save the text in the Visual Workbench control file.
  18. When you are ready to use the enhancements in the Visual Workbench control file (including the new text) in your workflow, click Tools Export EnhanceAFP Control File and choose a directory for the exported file.
  19. To specify an orientation of 90, 180, or 270 degrees, add this line to the EnhanceAFP control file with a text editor:

    #Afp.InsertText.Orientation[text_name]=Degrees90

    where text_name is the name that identifies a text insertion.

    For example:#Afp.InsertText.Orientation[Sample-Text]=Degrees90

    Note: When you edit an EnhanceAFP control file manually, the edits are not saved in the Visual Workbench control file. If you make additional enhancements and save them in the Visual Workbench control file, you must export the EnhanceAFP control file to make the new enhancements available to the workflow. Then you must manually edit the new EnhanceAFP control file to add the edits that you made in the original EnhanceAFP control file.

1.2.4.32.6.12 Creating hidden areas with AFP Enhancer

You can hide areas in AFP files that you do not want RICOH ProcessDirector to display or print. For example, you can 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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To create a hidden area:
  1. In RICOH Visual Workbench, 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 Enhancer.
  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. On the General tab, 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. Click the Rectangle tab.
  10. Specify the exact origin (top-left corner) of the hidden area in these fields. Specify the values in inches or millimeters.
    X
    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
    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 distances 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.
  11. Specify the exact bottom-right corner of the hidden area in these fields. Specify the values in inches or millimeters.
    X-extent
    The horizontal distance of the right 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-extent position cannot be greater than the width of the page.
    Y-extent
    The vertical distance of the bottom 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 distances of the bottom-right corner of the box that you drew.

    Note: Specify the bottom-right corner of the hidden area in the unrotated view.
  12. Optional: Specify the Right Rectangle (CEL) values: the top-left and bottom-right corners of the hidden area on right-hand pages. Specify the X, Y, X-extent, and Y-extent values in inches or millimeters.
      Note:
    • If you do not specify values for the Right Rectangle (CEL) fields, AFP Enhancer uses the values in the Rectangle (CEL) fields for all pages.

    • Use values in both the Rectangle (CEL) and Right Rectangle (CEL) fields if 2–up is enabled and the Page Placement value is All Fronts Left And Right.

  13. Specify the pages on which to place the hidden area in each page group.
  14. Optional: Specify a trigger using a CEL expression.

    Examples:

    • You want to place the hidden area on every document with two or more pages. Use this expression:

      total_pages_in_mp != 1

    • You want to place the hidden area on each document sent to California that has yes as the value of the Doc.Custom.PolicyDiscount document property. Use this expression:

      and(Doc.State == CA, Doc.Custom.PolicyDiscount == yes)

  15. Click the Preview tab.
  16. Optional: Change any combination of values for the X position, Y position, Width, and Height fields.

    The Origin of area values show the X and Y positions of the upper-left corner of the hidden area you drew. The Width and Height values show the horizontal and vertical distances from the upper-left corner to the bottom-right corner of the hidden area you drew.

    Note: The values on the Preview tab are used to display the hidden area in RICOH Visual Workbench. They do not change when you change the values on the Rectangle tab. The values on both tabs are saved in the Visual Workbench control file. Only the values on the Rectangle tab are exported to the EnhanceAFP control file and used to place the hidden area on the documents in the AFP file.

  17. Click OK.
    You do not see any text or image data in the hidden area in each page group.

1.2.4.32.6.13 Modifying or deleting AFP Enhancer definitions

After you create barcodes, text, or hidden areas, you can modify or delete any of them.

1.2.4.32.6.14 Editing AFP files

The AFP Enhancer mode of RICOH Visual Workbench and the AFP Editor plug-in to RICOH Visual Workbench let you create barcodes and text, and hide areas that contain unwanted content (such as obsolete barcodes) in AFP files.

1.2.4.32.6.14.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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To create a barcode:
  1. In RICOH Visual Workbench, 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 RICOH Visual Workbench (Resources Specify Resource Directories). The AFP IMB font is installed in the aiw/aiw1/plugins/EditAFP (Linux) or C:\aiw\aiw1\plugins\EditAFP (Windows) directory.
  11. If you see an error message, the barcode is not created in any page group. In addition, no other barcodes or hidden areas 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.2.4.32.6.14.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.

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.2.4.32.6.14.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 job property you want to encode in the barcode. The barcodes will contain the value of the job 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.2.4.32.6.14.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.
Note: For Linux, the serial number file must have the appropriate permissions set so that the RICOH ProcessDirector system user (aiw1 is the default) and all users in the RICOH ProcessDirector group (aiwgrp1 is the default) can read and update the file.
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.2.4.32.6.14.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. To stop printing a job when a presentation error occurs for a printer, you can set the Presentation check errors property for the printer to Barcode or All. 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.2.4.32.6.14.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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 RICOH Visual Workbench (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 RICOH Visual Workbench (Resources Specify Resource Directories). The AFP IMB font is installed in the aiw/aiw1/plugins/EditAFP (Linux) or C:\aiw\aiw1\plugins\EditAFP (Windows) directory.
  12. If you see an error message, the barcode is not created in any page group. In addition, no other barcodes or hidden areas 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.2.4.32.6.14.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.
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.2.4.32.6.14.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.
Note: For Linux, the serial number file must have the appropriate permissions set so that the RICOH ProcessDirector system user (aiw1 is the default) and all users in the RICOH ProcessDirector group (aiwgrp1 is the default) can read and update the file.
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.2.4.32.6.14.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.2.4.32.6.14.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 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. Use any editor to 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. For Linux, set the serial number file with the appropriate permissions so that the RICOH ProcessDirector system user (aiw1 is the default) and all users in the RICOH ProcessDirector group (aiwgrp1 is the default) can read and update the file.

1.2.4.32.6.14.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 RICOH Visual Workbench, 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.2.4.32.6.14.5 Creating hidden areas

You can hide areas in AFP files that you do not want RICOH ProcessDirector to display or print. 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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To create a hidden area:
  1. In RICOH Visual Workbench, 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. 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.
  9. 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.
  10. 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,...)
  11. Click OK.
    You do not see any text or image data in the hidden area in each page group.

1.2.4.32.6.14.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.
    • If the character names do not match between a character set and code page, the job goes into an error state in RICOH ProcessDirector and the printer issues an error. To correct the error, change the character set and code page to a valid pair and process the job again.
  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.2.4.32.6.14.7 Modifying or deleting AFP Editor definitions

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

1.2.4.32.6.14.7.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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To modify a barcode:
  1. In RICOH Visual Workbench, 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 RICOH Visual Workbench (Resources Specify Resource Directories).

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

1.2.4.32.6.14.7.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 RICOH Visual Workbench, 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.2.4.32.6.14.7.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 RICOH Visual Workbench, 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.2.4.32.6.14.7.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 RICOH Visual Workbench, 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.2.4.32.6.14.7.5 Modifying hidden areas

You can modify the hidden areas that were created with AFP Editor.
Note: In RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To modify a hidden area:
  1. In RICOH Visual Workbench, 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.2.4.32.6.14.7.6 Deleting hidden areas

You can delete the hidden areas that were created with AFP Editor.
To delete a hidden area:
  1. In RICOH Visual Workbench, 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.2.4.32.6.14.7.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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To modify a text string:
  1. In RICOH Visual Workbench, 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.
    • If the character names do not match between a character set and code page, the job goes into an error state in RICOH ProcessDirector and the printer issues an error. To correct the error, change the character set and code page to a valid pair and process the job again.
  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.2.4.32.6.14.7.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 RICOH Visual Workbench, 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.2.4.32.6.14.8 Adding steps to edit AFP files

After you create barcodes, text, or hidden areas in a sample AFP file using RICOH Visual Workbench, you must add a step to one or more workflows to create barcodes, text, or hidden areas in production AFP files that use the workflows. The step names the Visual Workbench control file that contains the definitions for the barcodes, text, or hidden areas.
You can base the step on the EditAFP step template. When you configure the step, you can choose to first create any page groups and index tags that are defined in the same control file. The barcodes, text, and hidden areas can depend on the page groups or index tags defined in the control file being created first.

Position the step relative to these steps if they are present:

  • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step)
  • After a step that converts Xerox data to AFP format
  • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step)
  • Before the EnableRepositioning step if you configure the EditAFP step to create page groups and index tags
  • Before the PrintJobs step
  • After a step based on the IndexAFP step template (unless using Index first)
  • After a step that changes the property values in the barcode
    Note:
  • If you created fixed-length page groups with the IndexAFP step template, you can use the EditAFP step template to enhance AFP files that the RICOH ProcessDirectorTransform Features create.

To add a step to edit AFP files:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
    If you prefer to modify a copy of the workflow, right click it and choose Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name. If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Select the EditAFP step template and drag it into the workflow editor. Place the step where you want it.
  6. Connect the EditAFP step to other steps.
  7. Right-click the step and select Properties.
  8. If necessary, change the General properties.
  9. Click AFP.
  10. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains the definitions to create the page groups, index tags, barcodes, text, and hidden areas.
      Note:
    • If you want to use the same workflow for input files that require different control files, you can use symbolic notation for the name of the control file. For example, if you have two input files, abc.afp and xyz, with corresponding control files, abc.afp.ctl and xyz.ctl, and you want to use the same workflow for both files, you can use ${Job.InputFile}.ctl as the control file in the Visual Workbench control file field. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the Visual Workbench control file to the name of the input file plus the .ctl extension.
  11. If the control file contains definitions to create page groups and index tags, you might want to select Yes in the Index first field.
      Note:
    • Do not select Index first if the IndexAFP step and the EditAFP step run in different phases. For example, if a barcode contains the document sequence and another step in the workflow sorts the documents in a different order, you might put the IndexAFP step in the Prepare phase and then put the EditAFP step after the build step in the Assemble phase.
  12. If you select Yes in the Index first field, remove any step from the workflow that is based on the IndexAFP step template because the Index first option and the IndexAFP step provide the same function. (It is more efficient to select Yes in the Index first field than to run an IndexAFP step.)
  13. Click OK.
  14. Save and enable the workflow.

1.2.4.32.6.15 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 in RICOH ProcessDirector to navigate to indexed pages in the file, exclude non-customer information from mailpieces, and reprint specified pages.

1.2.4.32.6.15.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.2.4.32.6.15.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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench, 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 in RICOH ProcessDirector.
  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.2.4.32.6.15.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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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.
You can create an index tag on a supplemental page for text in an AFP text block, text in an area, or mailing addresses in an address area. You do not need to create a trigger on a supplemental page before you create an index tag. However, if the supplemental page does not contain a trigger, the index tag is applied to every page outside a page group.
Note: In RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To create an index tag on a supplemental page:
  1. In RICOH Visual Workbench, 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.2.4.32.6.15.3 Creating index tags

You can create index tags in AFP files. When a file contains index tags, you can use the RICOH ProcessDirector 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, and to assign values to document properties.
The index tag values you choose can be used in the Jump to and Print again pages in RICOH ProcessDirector to navigate to a specific page in the file or to reprint a page group in the job. You can also use the index tag values in barcode data if AFP Editor is installed, and you can use the index tag values to assign values to document properties if Document Property Designer is installed.

1.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench, 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.2.4.32.6.15.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.2.4.32.6.15.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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.
To create page-level triggers:
  1. In RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench, 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.2.4.32.6.15.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.2.4.32.6.15.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 RICOH Visual Workbench you can display measurement units in inches or millimeters. To change the measurement unit, click View Units.

To modify a trigger definition:

  1. In RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 RICOH Visual Workbench, 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.2.4.32.6.15.6 Using existing page groups and index tags

If page groups and index tags are defined in the AFP file instead of a Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.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 Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.15.8 Managing comments

You can manage comments in the AFP Indexer portion of the RICOH Visual Workbench control file.
To manage comments:
  1. In RICOH Visual Workbench, 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 RICOH Visual Workbench 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.

    RICOH Visual Workbench puts each comment inside <Comment></Comment> tags near the top of the AFP Indexer portion of the control file.

1.2.4.32.6.15.9 Adding steps to index AFP files

After you create page groups and index tags in a sample AFP file using RICOH Visual Workbench, you must add a step to one or more workflows to create page groups and index tags in production AFP files that use the workflows. The step names the Visual Workbench control file that contains definitions for the page groups and index tags.

You can base the step on the IndexAFP step template. If AFP Editor is installed, you can base the step on the EditAFP step template. If Whitespace Manager is installed, you can base the step on the FillWhiteSpace step template.

If you base the step on the IndexAFP step template, place the step before the EnableRepositioning step so that you can use the Print again action to reprint a page group.

If you base the step on the EditAFP or FillWhiteSpace step template, position the step relative to these steps if they are present:

  • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step)
  • After a step that converts Xerox data to AFP format
  • Before the EnableRepositioning step
  • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step)
  • Before the PrintJobs step
    Note:
  • You can use the IndexAFP step template to enhance the AFP files that the RICOH ProcessDirectorTransform Features create.

To add a step to index AFP files:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
    If you prefer to modify a copy of the workflow, right click it and choose Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name. If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Select one of these step templates:
    • IndexAFP: This step template creates page groups and index tags in AFP files.
    • EditAFP: This step template can create page groups and index tags before it creates barcodes, text, and hidden areas in AFP files.
    • FillWhiteSpace: This step template can create page groups, index tags, barcodes, text, and hidden areas before it fills defined white space with content in production AFP files.
      Note:
    1. The same Visual Workbench control file must contain the definitions for page groups, index tags, barcodes, hidden areas, and white space.
    2. The EditAFP step template is available only if AFP Editor is installed.
    3. The FillWhiteSpace step template is available only if Whitespace Manager is installed.
    4. Select the EditAFP step template only if the IndexAFP step and the EditAFP step can be done consecutively in the same phase. Otherwise, add the steps separately.
  6. Drag one of the steps into the workflow editor.
  7. Connect the step to other steps.
  8. Right-click the step and select Properties.
  9. If necessary, change the General properties.
  10. Click AFP.
  11. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains the definitions to create the page groups and index tags.
      Note:
    • This control file is not the same as an index object file that the ConvertLineDataJobIntoAFP step might create.
    • If you want to use the same workflow for input files that require different control files, you can use symbolic notation for the name of the control file. For example, if you have two input files, abc.afp and xyz, with corresponding control files, abc.afp.ctl and xyz.ctl, and you want to use the same workflow for both files, you can use ${Job.InputFile}.ctl as the control file in the Visual Workbench control file field. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the Visual Workbench control file to the name of the input file plus the .ctl extension.
  12. If you selected the EditAFP step template, select Yes in the Index first field.
  13. Click OK.
  14. Save and enable the workflow.

1.2.4.32.6.16 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.2.4.32.6.16.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.16.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.16.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.2.4.32.6.16.3.1 Modifying known white space definitions

You can modify a definition for white space that you know exists on a page.
    Note:
  • In RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.16.3.2 Modifying white space defined from a search

You can modify white space that you defined from a search.
    Note:
  • In RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.16.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 RICOH Visual Workbench, 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.2.4.32.6.16.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.2.4.32.6.16.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 RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.16.4.2 Inserting content text

You can define the text you want inserted as white space content.
    Note:
  • In RICOH Visual Workbench 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 RICOH Visual Workbench, 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.
    • If the character names do not match between a character set and code page, the job goes into an error state in RICOH ProcessDirector and the printer issues an error. To correct the error, change the character set and code page to a valid pair and process the job again.
  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.2.4.32.6.16.4.3 Inserting content images

You can define the images you want inserted as white space content.
    Note:
  • In RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.16.4.4 Modifying content text

You can modify the text you have defined for white space content.
Note: In RICOH Visual Workbench 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 RICOH Visual Workbench, 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.
    • If the character names do not match between a character set and code page, the job goes into an error state in RICOH ProcessDirector and the printer issues an error. To correct the error, change the character set and code page to a valid pair and process the job again.
  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.2.4.32.6.16.4.5 Modifying content images

You can modify the images you have defined for white space content.
    Note:
  • In RICOH Visual Workbench 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 RICOH Visual Workbench, 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.2.4.32.6.16.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 RICOH Visual Workbench, 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.2.4.32.6.16.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 RICOH Visual Workbench, 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.2.4.32.6.16.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 RICOH Visual Workbench, 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.2.4.32.6.16.5 Adding steps to fill white space in AFP files

After you define white space in a sample AFP file using RICOH Visual Workbench, you must add a step to one or more workflows to fill the white space with content in production AFP files that use the workflows. The step names the Visual Workbench control file that contains the definitions for the white space.
You can base the step on the FillWhiteSpace step template. When you configure the step and AFP Indexer, AFP Editor, or both are installed, you can choose to first create any page groups, index tags, barcodes, hidden areas, and text that are defined in the same control file before filling the white space areas. The white space areas are often dependent on the page groups, index tags, and other items being created first.

Position the step relative to these steps if they are present:

  • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step).
  • After a step that converts Xerox data to AFP format.
  • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step).
  • Before the EnableRepositioning step if you configure the FillWhiteSpace step to create page groups and index tags, text, or both.
  • Before the PrintJobs step.
  • After a step based on the IndexAFP or EditAFP step template (unless using Index first or Edit first).
    Note:
  • If you created fixed-length page groups with the IndexAFP step template, you can use the FillWhiteSpace step template to fill white space with content in AFP files that the RICOH ProcessDirectorTransform Features create.

To add a step to fill white space with content in AFP files:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
    If you prefer to modify a copy of the workflow, right click it and choose Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name. If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, click Step Templates in the top right corner of the window.
  5. Select the FillWhiteSpace step template and drag it into the workflow editor. Place the step where you want it.
  6. Connect the FillWhiteSpace step to other steps.
  7. Right-click the step and select Properties.
  8. If necessary, change the General properties.
  9. Click AFP.
  10. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains the white space definitions.
      Note:
    • If you want to use the workflow for input files that require different control files, you can use symbolic notation for the name of the control file. For example, if you have two input files, abc.afp and xyz, with corresponding control files, abc.afp.ctl and xyz.ctl, and you want to use the same workflow for both files, you can use ${Job.InputFile}.ctl as the control file in the Visual Workbench control file field. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the Visual Workbench control file to the name of the input file plus the .ctl extension.
  11. If the control file contains definitions to create page groups and index tags, you might want to select Yes in the Index first field.
      Note:
    • Do not select Index first if the IndexAFP step and the FillWhiteSpace step run in different phases. For example, you might need to put the IndexAFP step in the Prepare phase and the FillWhiteSpace step in the Assemble phase after the EditAFP step (or select Edit first).
    • If you select Yes in the Index first field, remove any step from the workflow that is based on the IndexAFP step template because the Index first option and the IndexAFP step provide the same function. (It is more efficient to select Yes in the Index first field than to run an IndexAFP step.)
  12. If the control file contains definitions to create barcodes, hidden areas, or text, you might want to select Yes in the Edit first field.
      Note:
    • The Edit first field applies only if AFP Editor is installed. If you select Yes and the AFP Editor is not installed, RICOH ProcessDirector does not edit the job.
    • If you select Yes in the Edit first field, remove any step from the workflow that is based on the EditAFP step template because the Edit first option and the EditAFP step provide the same function. (It is more efficient to select Yes in the Edit first field than to run an EditAFP step.)
  13. Click OK.
  14. Save and enable the workflow.

1.2.4.32.6.17 Customizing properties for AFP files

You can use Document Property Designer to customize document and job properties for AFP files by linking the properties to index tags. Index tags are also called Tagged Logical Elements (TLEs). In addition, you can define link options for the properties and edit the index tag values.
If you want to manipulate documents or jobs using only the standard properties provided in all document processing features- for example, if you want to split a job based on the number of sheets in each document–you do not need to link custom document properties to index tags. However, in most cases you will have custom document or job properties that you want to use. For example, if you have a custom document property representing a postal code and you link it to its corresponding index tag, then you can sort, split, or group documents by their postal code.

1.2.4.32.6.17.1 Linking custom properties to index tags

You can use RICOH Visual Workbench to link document or job properties to index tags in a sample AFP file.

When a property is linked to an index tag, RICOH ProcessDirector steps assign the value of the index tag in a production AFP file to the property in a workflow. For example, if the value of the index tag is a ZIP code, the value of the document property is also the ZIP code.

You can link more than one property to the same index tag. For example, you might want to link one document property to one portion of an index tag value and link another document property to another portion of the same index tag value. For example, an address line might contain both a city and state or country. If the index tag contains both the city and the country, you can make separate document properties of City and Country.

You can also link several index tags to the same property. For example, if you have an index tag named routing code and an index tag named postal code, you can map both index tags to the property mail code. You can use the same Visual Workbench control file for several jobs that use different index tag names for the same property; however, the system expects that only one of the index tags will be in a particular document. If more than one index tag occurs in a document, the system assigns the property value based on the first occurrence.

You do not need to link all properties to index tags, and you do not need to link all index tags to properties. RICOH ProcessDirector displays the value of an unlinked property as Not set.

These symbols indicate the status of each document property and index tag:

  • The unlinked (Unlinked image) symbol indicates the property or index tag is unlinked.
  • The linked (Linked image) symbol indicates the property or index tag is linked.

Before you can link document properties to index tags:

  • Open a sample AFP file in RICOH Visual Workbench. The sample file must contain page groups and the index tags that you want to link to document properties. Use the AFP Indexer mode of RICOH Visual Workbench to create page groups and index tags.
  • As the RICOH ProcessDirector system user (aiw1 is the default), create a directory to store the control file containing the links. We recommend the /aiw/aiw1/control_files/workbench (Linux) or C:\aiw\aiw1\control_files\workbench (Windows) directory, because files in this directory are backed up when you use the aiwbackup process. This directory and any files you create should be owned by the RICOH ProcessDirector system user or a member of the RICOH ProcessDirector group (aiwgrp1 is the default), with the same permissions (775) as the control_files directory.

To link a property to an index tag:

  1. In RICOH Visual Workbench, click Mode Document Property Designer.
    If the Document Property Designer mode is the only mode that is available, this mode is selected automatically.
  2. Click Tools Link Properties.
    In the window that displays, properties are listed in a table, in alphabetical order by property name; document properties precede job properties. To sort the properties in a different order, click the column heading. Click once to sort in ascending order; click twice to sort in descending order.
  3. In the Link Properties window:
    1. Select a property and select the index tag that you want to link to the property.
      Optional: You can select more than one index tag to link to a single property, or select more than one property to link to a single index tag.
    2. Click Link.
  4. Optional: In the Define Link Options window, define the link options for the property.
  5. Click OK.
  6. To link other properties to index tags, repeat steps 3 to 5.
  7. Click OK.
    You see the properties and linked index tags listed on the Document Properties tab and the Job Properties tab in the bottom pane.
  8. To save the Visual Workbench control file that contains information about how the properties are linked to index tags, do one of these:
    • To save a new control file, click File Save control file as. Select the directory you created above and type the name of the control file in the File name field, and then click Save. Remember where you saved the control file because you must specify the location of the control file when you configure the steps that identify documents in AFP files. The default extension for control files is .ctl. The file is an XML file.
    • To save an updated control file, click File Save control file.
    • If you used AFP Indexer to define the index tags, you should use the same control file for the document and job properties.
    Note: When you add a step to the workflow, you can reference the control file name using symbol notation if the name of the control file for the job matches a value of a job property, such as the job name.

1.2.4.32.6.17.2 Defining link options for properties

When you link document or job properties to index tags, you can define options for each property. These options apply to the property only when it is linked to the index tag.

For example, you can specify whether the index tag is required, the default value for the property if the index tag is not found in a document or job, and so on. You can also edit the text value for the index tag so that the property contains only part of the index tag value.

Before you can define the property link options, you must link the property to an index tag. When you link a property to an index tag, Document Property Designer automatically displays the Define Link Options window so that you can define the options. If you have previously linked a property to an index tag, you can modify the link options.

To define link options for a property:

  1. In RICOH Visual Workbench, click Mode Document Property Designer.
  2. Click Tools Link Properties.
  3. In the Link Properties window, select the property whose link options you want to modify and click Modify Link.
    To sort the properties by tag name or index tag type, click the column heading. Click once to sort in ascending order; click twice to sort in descending order.
  4. Optional: In the Define Link Options window, change the index tags that the property is linked to by selecting one or more of the index tags from the Linked index tag table.
  5. Optional: To edit the text value of the property, click Edit index value.
    You might want to edit the index tag value to remove any leading or trailing blanks, or to remove unwanted special characters.
    • You can select more than one index tag to edit; the rules that you define apply to all of the selected index tags. When you edit more than one index tag at a time, the sample value fields at the bottom of the window do not display an example of the changed property.
    • The edits you make apply only to the property value and do not change the value of the index tag itself.
  6. Specify one or more of these fields:
    Field Action
    Use local value

    This field applies to supplemental page index tags when you have more than one supplemental page in the print stream; it specifies whether the index tag value on a particular supplemental page can be used on any subsequent supplemental pages.

    Select this option if you want to make sure that a supplemental page uses only the values of the index tag for the current page group; a subsequent supplemental page cannot use the same value that was used on a previous supplemental page. If you select this option and a value is missing for the index tag in a subsequent supplemental page, and if the Required option is selected below, the production AFP job is placed in an error state.

    For example, you might define an index tag for a supplemental page that includes a customer address; that address is placed on the documents associated with that supplemental page. If you select the Use local value option and the Required option, and the value of the index tag is null on the next supplemental page, the production AFP job is placed in an error state. If you do not select Use local value, and the value of the index tag is null on the next supplemental page, the system places the customer address value from the preceding supplemental page on its associated documents.

    This table shows some example results based on the options selected:

    Use local value Required Subsequent supplemental page index tag value Result
    Y Y Exists New value is used on subsequent supplemental page
    Y N Exists New value is used on subsequent supplemental page
    Y N Null Value is blank on subsequent supplemental page
    N N Null Current value is used on subsequent supplemental page
    Y Y Null Job moves to error state

    Required

    For linked document property index tags:

    • Select this option if the index tag must exist in each document and set of contiguous supplemental pages found between documents. If RICOH ProcessDirector does not find the linked index tag in a document or set of contiguous supplemental pages, the production AFP job is placed in an error state.

    For linked job property index tags:

    • Select this option if the index tag must exist at least once in the AFP file. If RICOH ProcessDirector does not find the linked index tag in at least one document, the production AFP job is placed in an error state.

    Although the Required option requires that the index tag exists, if the value of the index tag is null, an error does not occur.

    Default value

    For linked document property index tags:

    • The default value is used if the index tag is not found in a document. If you did not select Required, type a default value for the document property, or select Not set. If the index tag is not found in a document and the default value is Not set, then if the index tag exists in the previous set of supplemental pages its value is used instead for this document. In this way you can use an index tag in a supplemental page as a default for all subsequent documents and override the value on a document-by-document basis by adding the index tag to individual documents.

    For linked job property index tags:

    • The default value is used if the index tag is not found in any documents or supplemental pages in the AFP file. If you did not select Required, type a default value for the job property, or select the Not set option.

    Minimum length Select the minimum number of characters (0 - 254) the document property value can contain. If the index tag value, after it is edited, is less than the minimum length, the production AFP job is placed in an error state. 0, the default, means no minimum length. If a value is null and the Minimum length is greater than 0, the production AFP file is placed in an error state.
    Maximum length Select the maximum number of characters (0 - 254) the document property value can contain. If the index tag value, after it is edited, is greater than the maximum length, the production AFP file is placed in an error state. 0, the default, means no maximum length.
    Maximum count Select the maximum number of times (0 - 100) the index tag can occur in a document. If the index tag occurs a greater number of times, the production AFP job is placed in an error state. 0, the default, means that the index tag can occur any number of times without error. The Maximum count option counts index tags that have null values.
    Ignore after nn occurrences Select which index tag (0 - 100) in a document, or in a set of contiguous supplemental pages found between documents, is to be used as the document or job property value. For example, if you select 2, the value of the second index tag in the document is the document or job property value. If the index tag occurs a fewer number of times in a document, the value of the last occurrence of the index tag is used. 0, the default, means that the value of the last index tag in the document is used as the document or job property value. Note that the Ignore after nn occurrences option counts index tags that have null values.
  7. Click OK.

1.2.4.32.6.17.3 Editing text for index tags linked to properties

You can edit the text value for an index tag so that the document or job property contains only part of the index tag value. You might want to edit the text value to remove any leading or trailing blanks, or to remove unwanted special characters.

The edits you make apply only to the property value and do not change the value of the index tag itself.

For example, if the index tag value contains an account number, 01-345678, you can edit the text value so that the property value contains only part of the account number, such as 345678.

When you edit a text value, make sure that you edit it so that it is appropriate for all documents or jobs because the index tag values can be different in each document or job.

The editing rules in the table below are applied top to bottom; for example, first editing by stripping of characters, then editing on delimiters, and finally editing on characters.

To edit the text value for an index tag that is linked to a property:

  1. On the Edit Value window, select On for one or more of these fields:
    Field Action
    Edit by stripping characters Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. 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, producing 324144325511.

    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. 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 index tag value in the Original text field is edited based on your selections and the new value is displayed in the Edited text field. The index tag value that is displayed is the value of the first index tag in the first document in the file.

    Optionally, you can select more than one index tag to edit; the rules that you define apply to all of the selected index tags. When you edit more than one index tag at a time, the sample value fields at the bottom of the window do not display an example of the changed property.

  2. Click OK.

1.2.4.32.6.17.4 Configuring steps to identify documents in AFP files

After you have linked document or job properties to index tags in a sample AFP file, you must configure the step that determines values for document or job properties in production AFP files. The step names the Visual Workbench control file that contains information about how properties are linked to index tags.

Steps that calculate values for properties are based on the IdentifyDocuments step template. Some RICOH ProcessDirector features provide workflows containing an IdentifyDocuments step. If you use any of those supplied workflows, you can configure the IdentifyDocuments step in the workflow to specify the name of the Visual Workbench control file. These are examples of workflows supplied with RICOH ProcessDirector features:

  • ReceiveInsert_I (provided with the Inserter feature)
  • SortAFP
  • SortSplitAFP
  • VerifySample (provided with the Automated Verification feature)

If you add an IdentifyDocuments step to another workflow, keep these tips in mind:

  • The same control file is used for the IndexAFP step, the EditAFP step, and the IdentifyDocuments step.
  • The IdentifyDocuments step must be after the IndexAFP step, if it is present, and all steps that update the AFP file.

To configure a step that identifies documents in AFP files:

  1. Click the Workflow tab.
  2. Copy a workflow that contains the IdentifyDocuments step.
  3. Right-click the IdentifyDocuments step and select Properties.
  4. If necessary, change the properties for the step in the right side of the window.
  5. If you previously linked properties to index tags, this step is required. Otherwise, it is optional. In the Visual Workbench control file field, type the path and file name of the Visual Workbench control file that contains information about how properties are linked to index tags, or use symbol notation to refer to it. RICOH Visual Workbench created this control file when you linked properties to index tags. The default extension for control files is .ctl. If you do not specify a control file, IdentifyDocuments uses any page group information that is already in the AFP file to identify documents, and no index tags in the AFP file are mapped to document properties.
  6. If the input AFP file does not already contain index tags and you use the AFP Indexer mode of RICOH Visual Workbench, add the IndexAFP step before the IdentifyDocuments step.
  7. Click OK.
  8. Save and enable the workflow.

1.2.4.32.7 Using RICOH ProcessDirector Plug-in for Adobe Acrobat

You use this software to enhance a PDF file by adding markup, such as barcodes, and by defining document properties using data in the PDF file.

In the RICOH ProcessDirector IdentifyPDFDocuments and BuildPDFFromDocuments steps, you specify the RICOH ProcessDirector Plug-in for Adobe Acrobat control files that contain the markup and document properties definitions, to apply the same enhancements in PDF files that you process on RICOH ProcessDirector.

1.2.4.32.7.1 Using RICOH ProcessDirector Plug-in for Adobe Acrobat

RICOH ProcessDirector Plug-in for Adobe Acrobat is an Adobe Acrobat Professional plug-in that you use to define and display enhancements in a PDF file that represents the PDF files that are processed by the steps in your workflows.

Enhancements include barcodes, OMR marks, images, hidden areas, and text. The enhancements you define in the PDF file are not saved in the PDF file; instead, they are saved in control files that you make available to a server used by RICOH ProcessDirector. RICOH ProcessDirector uses the control files to apply the same enhancements to production PDF files when it processes them for printing.

To extend markup capabilities, RICOH ProcessDirector Plug-in for Adobe Acrobat provides page groups, document properties, and conditional processing.

1.2.4.32.7.1.1 Page groups

A page group is a set of pages that make up a single document, such as a mailpiece or customer statement, within a PDF file. In RICOH ProcessDirector Plug-in for Adobe Acrobat, a document is a page group. A single PDF file can contain many documents. If an entire PDF file is treated as a single page group, the PDF file represents one document.

You should define a page group before you add markup. After you define a page group, you can apply markup to specific pages in each document. For example, you can add a barcode to the first page of each document, an image to all front-facing pages of each document, or text to the first back-facing page of each document.

You can define a page group in these ways:

  • As the entire PDF file.

  • As a fixed number of pages.

  • Based on text you select that is in the same location on the first page of each page group.

    RICOH ProcessDirector Plug-in for Adobe Acrobat uses the repeated text to determine the first page of each page group. For example, you have 100,000 customer statements in one PDF file. Each statement has three or more pages. To define a page group, you select Page 1 of, which is in the same location on the first page of each statement.

    Note: If you are using a sample PDF file to define page groups, make sure that the content and location of the text you select are consistent among the production PDF files.

  • Based on a specific key word or phrase that appears on the first page of a document within a region of text. The surrounding text might change, but the key word or phrase remains the same.

  • Based on text you specify that is on the first page of each page group. When you type the text, you can include wildcard characters. RICOH ProcessDirector Plug-in for Adobe Acrobat interprets the wildcard characters as any character.

  • Based on Java regular expressions that you define to specify text on the first page of each page group.

    For example, you define a Java regular expression so that RICOH ProcessDirector Plug-in for Adobe Acrobat starts a new page group each time it finds the English text Page 1 of or the Spanish text Página 1 de.

  • When text in a selected area changes.

    For example, you draw a box around the account name on a statement in a PDF file. Whenever the text in the box changes, that page becomes the first page of a new page group. The location of the box on every page must encompass only the text to evaluate or white space (no text).

Use the Page Group Navigator to see a list of the pages in each page group. After you verify that the page groups are correct, save your control file, which contains your new page group definition. If you define document properties, save them in the same control file. You then add the name and location of the control file to a RICOH ProcessDirector step based on the IdentifyPDFDocuments step template.

1.2.4.32.7.1.2 Document properties

A document property is data, such as a customer name or postal code, extracted from a specific location on a page within a document. Using document properties, you can add markup based on variable information. For example, you can add a different image to documents sent to different states or provinces.

RICOH ProcessDirector Plug-in for Adobe Acrobat has an advanced address block parsing tool to help you extract city, state or province, postal code, and other document properties from complex, variable line addresses. If you need to reprint documents in a job, you can use RICOH ProcessDirector to search for document property values to find the specific documents you need to reprint.

You can define your own document property or select a RICOH ProcessDirector document property from a drop-down list. You can use RICOH ProcessDirector document properties with functions provided by RICOH ProcessDirector document processing features.

Note: When you use RICOH ProcessDirector Plug-in for Adobe Acrobat to define document properties, you select from a list of your RICOH ProcessDirector document properties. After you install RICOH ProcessDirector Plug-in for Adobe Acrobat or any time that you change RICOH ProcessDirector document properties, you need to load the document properties into RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see RICOH ProcessDirector: Installing Document Processing Features.

Click Ricoh View Document Property Values to verify that document property values are extracted correctly.

If you want to use document property values with an external program, you can save the values to a tab-delimited text file.

1.2.4.32.7.1.3 Conditional processing

When you add markup to a PDF file using RICOH ProcessDirector Plug-in for Adobe Acrobat, you can create conditional processing rules to place the markup on specific pages.You also can use conditional processing rules to apply media and finishing options and to specify the pages from which RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector extract document property values.

Rules can specify conditions based on pages within documents, such as All Front Pages, as well as on job properties, document properties, statistics, and conditional triggers (text that determines whether a condition is met).

For example, you want the word Invoice at the top of the first page of a statement to trigger the placement of a barcode. First, you select the word Invoice and define it as a conditional trigger. Then you define a rule that specifies the conditional trigger. When you add a barcode to a PDF file, you specify this rule to control placement of the barcode. The barcode only prints on the pages where the word Invoice appears in the location specified by the conditional trigger.

Your RICOH ProcessDirector workflows can contain steps that set job property values during RICOH ProcessDirector processing. If you use RICOH ProcessDirector Plug-in for Adobe Acrobat to define a rule with a job property, you can dynamically create and alter how the rule is applied by setting the job property value in RICOH ProcessDirector. For example, you could use the Job.CustomerName job property to print a barcode only when the value of that property is BANK. RICOH ProcessDirector also keeps track of job processing statistics, such as the current page in a document. If you want to apply a barcode to page three in every document in a PDF job, you can make Stat.CurrentPageInDocument = 3 a condition for the application of a rule.

1.2.4.32.7.1.4 Markup

RICOH ProcessDirector Plug-in for Adobe Acrobat supports five types of markup: barcodes, OMR marks, images, text, and hidden areas.

For each type of markup, you assign a name that identifies the markup contents. Then you assign values for location, placement, and other properties. You can define document properties and conditional processing for markup using data that varies by document within the PDF file.

When RICOH ProcessDirector Plug-in for Adobe Acrobat displays a PDF file, your markup appears as a set of boxes with names. The PDF file is not altered. The Markup Navigator lets you locate and edit markup that is hidden under other markup.

To view and verify the content and placement of your markup on specific pages, you preview the PDF file.

1.2.4.32.7.1.5 Control files

A control file saves your page group definition, document properties, conditional triggers, and markup independently of a PDF source file. Control files are templates that RICOH ProcessDirector uses to apply the same markup rules to the PDF files it processes.
    Note:
  • Saving your PDF source file by clicking File Save or File Save As does not save your RICOH ProcessDirector Plug-in for Adobe Acrobat page groups, document properties, or markup.

To use the RICOH ProcessDirector IdentifyPDFDocuments step in a PDF workflow, you must add the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that defines page groups or document properties for that step. Any markup definition must be saved to one or more control files that are used by the RICOH ProcessDirector BuildPDFFromDocuments step.

You do not need to create separate control files for the page group, document properties, and markup definitions: all definitions can be saved in one control file if that control file is added to both the IdentifyPDFDocuments and the BuildPDFFromDocuments steps. However, you might choose to create multiple control files if you can apply one or more control files to different PDF workflows. For example each workflow might require its own document properties, but some workflows might require the same area to be hidden to cover OMR marks. For each workflow you would save a separate control file that defines document properties, but save only one control file to hide OMR marks. In each workflow, you would specify the workflow-specific control file that defines document properties. But in the step in each workflow that is based on the BuildPDFFromDocuments step template, you would specify the same control file that contains the hidden-area definition.

    Note:
  • The IdentifyPDFDocuments step uses one control file to create page groups and extract document properties. The BuildPDFFromDocuments step optionally uses one or more control files to apply markup and restructure a PDF file. ( BuildPDFFromDocuments does not require a control file.) In order to preview markup, you must define a page group and the document property definitions whose values you use in markup content. If you save a page group or property definition to a control file that you add to the BuildPDFFromDocuments step, RICOH ProcessDirector ignores those definitions. The BuildPDFFromDocuments step receives page grouping and document properties definitions from a workflow that includes the IdentifyPDFDocuments step.

See the help topics on RICOH ProcessDirector Plug-in for Adobe Acrobat control files and previewing markup for more information.

1.2.4.32.7.1.6 Sample PDF files

If your production PDF files are large (for example, over 1000 pages in length), you should mark up a smaller sample PDF file that represents the PDF files you process in RICOH ProcessDirector.

You only need to mark up one sample PDF file, save all your changes to control files, and then use RICOH ProcessDirector to apply those changes to all of your production PDF files that match the sample PDF file. If you use RICOH ProcessDirector to process several PDF files that have different formats or different document properties, you need to mark up a sample PDF file for each type of file that you print using RICOH ProcessDirector. When working with RICOH ProcessDirector Plug-in for Adobe Acrobat, the goal is to mark up a PDF file that represents your production PDF files but that is smaller than your production files. If you mark up a PDF file in RICOH ProcessDirector Plug-in for Adobe Acrobat that is under 1,000 pages, you can work more quickly when adding markup and when using preview and viewing extracted document properties.

Both your sample PDF file and PDF files processed by RICOH ProcessDirector must contain all fonts and images in the PDF file itself. If you have PDF files with varying page sizes, markup may not appear as you expect. The placement reference for all markup, document properties, and page group definitions is the top left corner of each page.

1.2.4.32.7.2 Adding the plug-in icon to the Acrobat quick launch bar

Before you can mark up a PDF file, you must make the plug-in the active tool in Adobe Acrobat. Clicking the plug-in icon is a convenient alternative to clicking Ricoh Select in the menu bar. You can permanently place the RICOH ProcessDirector Plug-in for Adobe Acrobat icon on the Adobe Acrobat quick launch bar.
Follow these steps:
  1. Open Adobe Acrobat Professional.
  2. Click the Tools menu on the far right.
  3. Click Advanced Editing.
  4. Right-click the RICOH ProcessDirector Plug-in for Adobe Acrobat icon (Plug-in tool icon) and select Add to Quick Tools. The RICOH ProcessDirector Plug-in for Adobe Acrobat icon is permanently placed in the quick launch bar below the Acrobat main menu.
When the plug-in is the active tool, its icon will be highlighted.

1.2.4.32.7.3 Preferences

You can set preferences for RICOH ProcessDirector Plug-in for Adobe Acrobat to customize it for the way that you process PDF files.
To change your preferences, click Ricoh Preferences.
Fonts tab
Use the Fonts tab to select the font and size. This font is applied to the name of the markup boxes you draw in a PDF file. You use this option to change the font of the characters in your preferred language.
    Note:
  • Selections for style, effects, color, and type of script are not applied to the name of the markup boxes.
Preview tab

Use the Preview tab to set values for these properties:

Pages to Process
This value determines the maximum number of pages to process when you preview markup, export and view document properties, and use the Page Group Navigator. The more pages you specify, the longer RICOH ProcessDirector Plug-in for Adobe Acrobat takes to preview markup and view document properties.
Production Intent
This value defines how RICOH ProcessDirector Plug-in for Adobe Acrobat interprets PDF files. For example, when the Production Intent is Simplex, Second Front Only page placement puts markup on the second page of each page group. When the Production Intent is Duplex, Second Front Only page placement puts markup on the third page of each page group.
Show electronic forms
This value determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use.

Address tab

Use the Address tab to set a value for the Default address block format property. The default value is displayed when you use the Define Address Block function.

Logging tab
RICOH ProcessDirector Plug-in for Adobe Acrobat provides a log file in text format that you can customize to provide different levels of historical information. Use the Logging tab to define these properties:
Logging Level
The types of messages saved in the log file. Trace saves all six types. Info saves four types: informational, warning, error, and fatal messages. Fatal saves only fatal messages. Off turns off logging.
Log Output Folder
The directory path for the plug-in and Java log files that the system creates. The directory path must exist when the system creates the first log file. If a file does not exist, the system creates it.
Plug-in Log File
The file name for the plug-in log file that the system creates.
Java Log File
The file name for the Java log file that the system creates.
Maximum File Size
The upper size limit for the log. The minimum file size is 1 MB; the maximum file size is 10 GB. When the file reaches the upper limit, the system closes the file, renames it to include a number at the end of the name. The system keeps the file until the value in the Number of Log Files to Retain property is reached. For example, the log file name is Log.txt. Each renamed file is Log.n.txt, where n is a number from 1 to the value in the Number of Log Files to Retain property. The most recent log remains Log.txt.
Number of Log Files to Retain
The number of log files that the system keeps in addition to the current log file. When this limit is reached, the system deletes the oldest log file after it creates a log file. For example, you select 3. The system keeps the current log file plus the three most recent log files.
Advanced tab
Use the Advanced tab to set values for these properties:
Port
The internal port number for communication between RICOH ProcessDirector Plug-in for Adobe Acrobat and its background Java process. Restart Adobe Acrobat for this value to take effect. Edit this field if you have software that uses the default port.
Heap Size (MB)
The number of megabytes for the desired minimum amount of memory in the Java Virtual Machine allocation pool. Restart Adobe Acrobat for this value to take effect. Experiment with this value to tune it to the size and complexity of the PDF files you mark up. When you experience delays while previewing, selecting text, using the Page Group Navigator, or extracting and exporting document properties, you might improve performance by increasing the number of megabytes. If you set the heap size to a value that is greater than the available memory, you might not be able to use RICOH ProcessDirector Plug-in for Adobe Acrobat. In that case, decrease the heap size value, restart Adobe Acrobat, and reactivate the plug-in.
Other JVM Options
In addition to setting the minimum heap size, you can fine-tune other JVM memory settings. Edit this field only on the advice of your support representative.

1.2.4.32.7.4 Units of measure

RICOH ProcessDirector Plug-in for Adobe Acrobat uses the units of measure from the Pages & Ruler Units you set in Adobe Acrobat preferences.

To see or change this setting, click Edit Preferences Units & Guides.

Note: You define certain units of measure, such as those for the OMR marks, when you define the markup.

1.2.4.32.7.5 Loading RICOH ProcessDirector document properties

To use RICOH ProcessDirector Plug-in for Adobe Acrobat to define text in a PDF file as a RICOH ProcessDirector document property, you must import the list of RICOH ProcessDirector document properties.
You must do this task:
  • After you install RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • After changes are made to property definition files, you have run the docCustom utility, and you have installed or upgraded the Custom Document Properties feature.
  1. Close Adobe Acrobat Professional.
  2. Retrieve the definitions.zip file from this directory on the RICOH ProcessDirector server that processes your PDF files:
    • Unix-based systems, /aiw/aiw1/share
    • Windows, C:\aiw\aiw1\share
    This file is generated when you install one of the document processing features and is updated when you run the docCustom utility and install or upgrade the Custom Document Properties feature.
    The definitions.zip file is downloaded when you download the plug-in installer from the Administration tab. After you make any changes to your custom document properties, you must manually download the definitions.zip file.
  3. On the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat, place the definitions.zip file in the <user_home_directory\AppData>\Roaming\InfoPrint\InfoPrintPlugin\ directory.

    For <user_home_directory\AppData>, substitute the name of the home directory application data directory for the current user.

      Note:
    • You can view the application data directory location for the current user by typing %appdata% in the Windows Run command line and clicking OK.

  4. Restart Adobe Acrobat Professional and click Ricoh Select to activate RICOH ProcessDirector Plug-in for Adobe Acrobat. The list of RICOH ProcessDirector document properties in the definitions.zip file is automatically imported into the areas of the plug-in that use document properties.
The definitions.zip file contains document properties and limited document properties. Limited document properties are not saved to a database, but they are stored in the document properties file that contains the property. For more information about both types of properties, see the topics related to document properties in the information center, for example see the topic on editing the sample document properties template.

1.2.4.32.7.6 Loading media objects

After installing RICOH ProcessDirector Plug-in for Adobe Acrobat, load RICOH ProcessDirector media objects. After you load them, you can use them to define media and finishing options for specific pages in a PDF file.

Whenever you change RICOH ProcessDirector media objects, do this task to load them into RICOH ProcessDirector Plug-in for Adobe Acrobat.

To load media objects:

  1. Close Adobe Acrobat Professional.
  2. On the RICOH ProcessDirector primary server, go to this directory:

    • /aiw/aiw1/share on Linux
    • C:\aiw\aiw1\share on Windows

  3. Copy the media.zip file to the <user_home_directory\AppData>\Roaming\InfoPrint\InfoPrintPlugin\ directory on the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat.

    For <user_home_directory\AppData>, substitute the name of the home directory application data directory for the current user.

      Note:
    • You can view the application data directory location for the current user by typing %appdata% in the Windows Run command line and clicking OK.
    • If the directory includes both a media.zip file and a media.xml file, RICOH ProcessDirector Plug-in for Adobe Acrobat uses the media.zip file to load the media objects.
    • The media files are not downloaded when you download the plug-in installer from the Administration tab.

  4. Restart Adobe Acrobat Professional and click Ricoh Select.

The media objects now are available in RICOH ProcessDirector Plug-in for Adobe Acrobat for defining media and finishing options.

If your RICOH ProcessDirector system includes the Preprinted Forms Replacement feature, the electronic forms defined for media objects also are available.

1.2.4.32.7.7 User interface

The plug-in user interface consists of the Ricoh menu added to Adobe Acrobat, a right mouse button popup menu, a left mouse button popup menu, and windows that you use to perform RICOH ProcessDirector Plug-in for Adobe Acrobat functions.
Ricoh menu and right mouse button popup menu

The Table Ricoh and right click menu options describes the options you can select from the Ricoh menu that is added to the Adobe Acrobat Pro menu bar and when you right click in a PDF file.

Ricoh and right click menu options
Menu Option Description
Select Makes RICOH ProcessDirector Plug-in for Adobe Acrobat the active Adobe Acrobat tool. After activating the plug-in, you can use the left mouse button to draw a box in an area of the PDF file where you want to select specific text or add markup.
Add Markup Displays the options on the left-mouse button menu.
View Markup Navigator Displays a list of the markup, document property, and page group definitions that have been added to the active PDF file. You can use this view to edit markup and to locate markup that is hidden under other markup. Mark the check box next to a name in the list to display the box for that markup. Remove the check to hide the markup box. If you deselect the check box in front of a markup type, you hide the boxes for all markup of that type.
View Page Group Navigator Views the pages that belong to each page group. Click the + sign to expand the page groups and click the sign to collapse the page groups. You can also use this view to navigate to specific pages in the PDF file. Click one of the pages in a page group to make that the active page in Adobe Acrobat.

If you do not see the page groups you were expecting based on your page group definition, you must edit the definition to obtain the correct page groups. If you do not see the correct page groups in this view, you cannot obtain correct print results in RICOH ProcessDirector.

Preview Verifies that files are going to print as you expect when your markup, media, and finishing are applied to a job. After you have examined the preview rendering of the PDF file, click X in the upper right corner of the PDF file to close the rendered PDF file and to return to your original PDF file.
Preview Preferences Sets or changes preview preferences. You can define: the maximum number of pages to process, the rendering intent, and other settings.
View Document Property Values Views the values of the document properties that are defined in the loaded control file. You can save the values to a tab-delimited text file.
Manage Rules Displays your conditional processing rules. You can define new rules, and you can edit or delete existing rules.
Manage Inserts Inserts pages from other PDF files before each document that matches the placement conditions, after each document that matches the placement conditions, or both. The inserted pages increase the number of pages in each document, and you can apply markup to them.
Media and Finishing Defines media and finishing options for a range of a pages or for the documents within your PDF file.
Load Control File Loads an existing control file. RICOH ProcessDirector Plug-in for Adobe Acrobat saves all page group, document property, and markup definitions into one or more control files. If you load a control file, you load all definitions in that control file. You can only have one control file loaded at a time.
Save Control File Stores any markup, document property, and page group definitions to a control file. The Save Control File window displays the name and location of the control file you are saving. You can enter a new name for the control file, or keep the existing name to overwrite the control file you previously loaded or saved. Whenever you save a control file used by RICOH ProcessDirector, you must copy the control file to the location you define in the control file properties in the RICOH ProcessDirector BuildPDFFromDocuments or IdentifyPDFDocuments step.
Clear Markup Removes all markup, document property, and page group definitions from the active PDF file. You use this option when you want to start over or create a new control file that does not contain any of the markup from the prior control file. If, after using this option, you add markup or other definitions to the PDF file, you use the Save Control File option and save the definitions with a new control file name.
Preferences Sets or changes preferences, such as the default font used for the labels for the markup you add to a PDF file; the maximum number of pages to process; the rendering intent; logging options; and the maximum amount of memory (heap space) to reserve for RICOH ProcessDirector Plug-in for Adobe Acrobat.
Help Opens the publication RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.
About Displays the version information for your RICOH ProcessDirector Plug-in for Adobe Acrobat installation.
Left-mouse button menu

The Table RICOH ProcessDirector Plug-in for Adobe Acrobat left mouse menu describes the options you can select from the RICOH ProcessDirector Plug-in for Adobe Acrobat menu that you see when you use the left mouse button to draw a box in the PDF file. To use the left mouse button, you must first make RICOH ProcessDirector Plug-in for Adobe Acrobat the active tool in Adobe Acrobat by either clicking the plug-in icon or by clicking Ricoh Select. You draw a box in a PDF when you want to select text or define an area to place markup. To draw a box, click the left mouse button, and without letting go of the mouse button, drag the cursor down and to the right until you have either selected the text you want or have drawn a box the size that you want. When you release the mouse button, a menu pops up with the following options.

RICOH ProcessDirector Plug-in for Adobe Acrobat left mouse menu
Menu Option Description
Define Page Group Defines a page group to break a PDF file into mailpieces, such as statements or invoices. You must define the page group before you add markup or define document properties.
Define Conditional Trigger Defines a conditional trigger from text in the PDF. You use a conditional trigger in a conditional placement rule that defines the pages on which markup is printed or document properties are extracted. For example, you want to add a QR barcode only on the page where the word Invoice occurs near the top left of either the first or second page of a statement. You first define the word Invoice as a conditional trigger. Then, when you are defining the QR barcode, you select that trigger as a conditional placement rule on the QR barcode so it only prints on the pages where the word Invoice occurs in the location you selected.
Define Document Property Defines existing data in your sample PDF file as a document property so RICOH ProcessDirector can use that data in different steps (such as adding barcodes). After you define document properties, you can later search for them in the RICOH ProcessDirector viewer for reprint and other actions.

You can also define a document property on any text or DataMatrix barcode that you want to extract from the PDF file. In that case, you do not select a standard RICOH ProcessDirector document property; instead, you provide your own name for the property.

Define Multiple Properties Defines document properties from a block or multiline section of text.
Define Address Block Defines document properties for an address block.
Hide Area Creates a cover block to hide content in a PDF file. Hidden content does not print and is not viewable in RICOH ProcessDirector Plug-in for Adobe Acrobat preview or in the PDF viewer in RICOH ProcessDirector. You can hide an area and then place other markup over the hidden area.
Add Barcode Adds and configures a barcode. First you select the area where you want to place the barcode. Then, you select a barcode type and add content. When adding a barcode for downstream processing of mailpieces, you must understand the precise optical marks required by your machinery and have configuration specifications from your supplier.
Add OMR Adds and configures optical markings to help manage downstream processing of mailpieces in the PDF file. When adding an OMR, you must have an understanding of the precise optical marks required by your machinery and have configuration specifications from your supplier.
Add Image Adds an RGB JPEG-formatted image to create new content or to cover existing content.
Add Text Adds text to any location in a PDF file. You designate the area where you want the text to print and select content from a combination of options, including typing text.

1.2.4.32.7.7.1 Fields in the RICOH ProcessDirector Plug-in for Adobe Acrobat cut off values

Monitors with a very high resolution and certain display settings can cause problems in the way information is displayed.
To change the way entry fields are displayed in the RICOH ProcessDirector Plug-in for Adobe Acrobat:
  1. Right-click the Desktop and select Display settings.
  2. Under Scale and layout, change the Change the size of text, apps, and other items value to 100%.
  3. Restart the computer for the change to take effect.
      Note:
    • If this change makes the fields too small to use, try changing the Resolution value.

1.2.4.32.7.8 Previewing markup

After you add markup to a sample PDF file, you can preview markup placement. Previewing lets you verify that PDF files are going to print as expected when RICOH ProcessDirector applies the markup that you saved to a control file. Preview also lets you verify that media and finishing options are going to be applied to the intended pages.

Using preview with more than one control file

If you save more than one control file for markup, media, and finishing definitions, preview renders only the definitions contained in the loaded control file. For example, you save a barcode definition in a control file called barcodes.ctl and an image definition in images.ctl. You can have either barcodes.ctl or images.ctl loaded in RICOH ProcessDirector Plug-in for Adobe Acrobat. If you have barcodes.ctl loaded, you preview the placement and content of the barcode, but you cannot preview the image because you do not have images.ctl loaded.

You can include page group and document property definitions in any control file. If a page group is defined in a control file that is not loaded, you cannot preview markup, media, and finishing with conditional placement rules based on page groups. If document properties are defined in a control file that is not loaded, you cannot select those document properties as content for markup. If you want to preview as much markup as possible while using multiple control files, first save page groups and document properties to a control file, for example, pagegrouping.ctl. When you are ready to define markup, load pagegrouping.ctl, add the markup, and save the result to a new control file (for example, barcodes.ctl). To define more markup and save it to a separate control file, first load pagegrouping.ctl. Add the markup (for example, images), and save the result to a new control file (for example, images.ctl). By starting your markup definitions from a control file that contains page groups and document properties, you can preview markup, media, and finishing that use conditional placement rules and document properties.

If you save all your enhancements in one control file, you can preview all markup, media, and finishing at once.

    Note:
  • You cannot edit, print, or save a preview file.
  • You must define a page group before you can preview markup.
  • The Pages to Process preference specifies the maximum number of pages that Preview processes. The greater the Pages to Process value, the longer RICOH ProcessDirector Plug-in for Adobe Acrobat takes to preview markup added to a PDF file.
  • The Production Intent preference determines how RICOH ProcessDirector Plug-in for Adobe Acrobat interprets PDF files.
  • The Show electronic forms preference determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use.
  • When you define markup in a PDF file, you can use the values of job and document properties as content for markup and in conditional placement rules. Preview uses values that are extracted from the PDF file. If you have markup that uses job or document properties that are not defined in the file, RICOH ProcessDirector Plug-in for Adobe Acrobat uses a unique static numeric value for each job or document property. If conditional placement rules use properties that are not defined in the file, usually Preview always applies or never applies markup based on those rules.
  • If your markup uses an image that the plug-in cannot find (for example, an image that is not on your local machine), preview does not render the image. Instead, preview places a message that specifies the name of the missing image in the location specified for the image.
  • You cannot preview markup that is placed using a RICOH ProcessDirector Plug-in for Adobe Acrobat rule that evaluates Stat.CurrentMedia.
To preview markup:
  1. Click Ricoh Preview.

    RICOH ProcessDirector Plug-in for Adobe Acrobat generates and displays a new, temporary PDF file. Your sample PDF file remains open.

    The temporary PDF file opens to the first page regardless of the page you are editing in the sample PDF file.

  2. When a page has media and finishing options, you see an annotation labeled Print Operations in the upper right corner. To see the media name and finishing option, hover the mouse pointer over Print Operations.

    As an alternative, click Comment on the Adobe Acrobat toolbar. In the Comments pane, you see a comment for each page with media and finishing options.

  3. If electronic forms are defined for media used by sample files, you can see how the files look when the data is combined with the forms.

    To see the electronic forms:

    • Make sure that you exported the RICOH ProcessDirectormedia.zip file and loaded it to the correct directory on the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information about loading media objects to the plug-in, see the help system or Ricoh ProcessDirector: Installing Document Processing Features.
    • For pages in your sample PDF file, select media that defines electronic forms. As an alternative, load a control file that you saved after selecting media that defines electronic forms.
    • Make sure that the Show electronic forms preference is set to Yes.

      Although Preview lets you see how files look when the data is combined with the forms, the data and forms remain separate. RICOH ProcessDirector combines the forms with the data in production PDF files when the CombinePDFWithForm step processes the files.

  4. When you have finished previewing the PDF file, you can close this temporary PDF file or leave it open.
    You can update the temporary PDF file by clicking Ricoh Preview.

1.2.4.32.7.9 Working with control files

As you use RICOH ProcessDirector Plug-in for Adobe Acrobat to mark up a PDF file, instead of saving markup in the PDF file itself, you save markup to one or more control files. RICOH ProcessDirector Plug-in for Adobe Acrobat uses a control file to extract data, and RICOH ProcessDirector uses control files in the different stages of preparing a PDF file for printing.

You use the Ricoh menu options Load Control File and Save Control File to manage control files. You can only have one control file loaded at a time. When you finish marking up a PDF file, you save the control file to a directory accessed by RICOH ProcessDirector. You configure RICOH ProcessDirector workflows with one or more step templates that use RICOH ProcessDirector Plug-in for Adobe Acrobat control files.

    Important:
  • Do not manually edit RICOH ProcessDirector Plug-in for Adobe Acrobat control files without advice from a Ricoh support representative.
  • RICOH ProcessDirector Plug-in for Adobe Acrobat Version 3.6 includes an improved PDF processing library. For most PDF files, the new library improves performance, reduces processing time, and uses less memory.

    When you open a control file created in a previous release, RICOH ProcessDirector Plug-in for Adobe Acrobat prompts: Do you want to update your control file to use an improved PDF processing library?

    If you click No, the message appears the next time that you open the control file.

    If you click Yes, RICOH ProcessDirector Plug-in for Adobe Acrobat updates the control file, and the message never appears again.

    When you update a control file, make sure that it produces the same results. Slight differences between libraries could result in slightly different text selection boxes. A smaller box could exclude text that you want to select, and a larger box could include text that you do not want. Using the improved library also could change the position of markup slightly.

    No other changes are required on the RICOH ProcessDirector server to use the improved PDF library.

  • To use a control file built for a PDF 1.7 file with a PDF 2.0 file, you must update the control file to use the new library.

You must save any page group definitions and document properties to a single control file. You can add markup, media, and finishing definitions to that single control file, or you can separate the definitions into different control files. You specify the control file that defines page groups and document properties in a step based on the IdentifyPDFDocuments step template. The control files that define markup, media, and finishing must be specified in a step based on the BuildPDFFromDocuments step. When you decide whether to create one or more control files, take your print environment into account: the complexity of your changes, how you want to differentiate your markup, and what PDF file enhancements change most often.

In a repetitive print environment where your PDF workflow does not change often, you could choose to create only one control file. When you preview a PDF file to verify where markup is going to print and which pages have media and finishing options, you can view all markup, media, and finishing in one view. You move the single control file to a directory accessed by RICOH ProcessDirector. You define the control file name and location in both the IdentifyPDFDocuments and the BuildPDFFromDocuments steps.

You could also use one control file when you want to preview the PDF file to make sure that all markup, media, and finishing are applied correctly. When you preview a file, RICOH ProcessDirector Plug-in for Adobe Acrobat renders markup and applies media and finishing options that are defined in the active PDF file. You cannot use preview to verify markup, media, and finishing definitions in a control file that is not loaded.

You could choose to use more than one control file in an environment that changes frequently or unexpectedly. By using different types of control files, you can mitigate the risk of change or adapt to it quickly. For example:

  • The page group definition is less likely to change than other definitions in your PDF files. You can put the page group and document property definitions in the control file that you add to the IdentifyPDFDocuments step.
  • You have installed the Inserter feature, and you switch between inserters. You do not have to edit your workflow each time you switch. Instead, you save the barcode markup for each inserter in a separate control file with a name that identifies the inserter. In the BuildPDFFromDocuments step, you specify the name and location of one control file, using symbol notation that matches the value of a job property. During print processing, you set the value of that job property to the name of the control file that matches the inserter you want to use for the job.

Symbolic notation also lets you use the same workflow for input files that need different RICOH ProcessDirector Plug-in for Adobe Acrobat control files. For example, you have two input files, File1.pdf and File2.pdf, with corresponding control files, File1.ctl and File2.ctl. You want to use the same workflow for both files. You can use ${Job.InputFile}.ctl as the control file name that you specify in the BuildPDFFromDocuments step. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the RICOH ProcessDirector Plug-in for Adobe Acrobat control file property to the name of the input file plus the .ctl extension.

1.2.4.32.7.10 Modifying markup definitions

After you add markup to a PDF file, you might need to delete the markup, move it to a new location, or modify its properties. RICOH ProcessDirector Plug-in for Adobe Acrobat provides several ways to edit and delete markup, document properties, and a page group definition.

The most common methods to edit markup are to double-click the box you drew to display the markup definition window or to click a box and move it to a new location. But you may have layered markup under other markup, such as having several barcodes in the same area because you want to print only one based on RICOH ProcessDirector conditional processing. You could also place a hidden area over an image and place a smaller image over the hidden area. To edit markup layered under other markup, you can use the Markup Navigator to select the markup you need to edit.

Tip: Keep in mind that changes you make to markup in the active PDF file must be saved to the control file to which you previously saved the markup definition. For example, if you added a barcode to a PDF file and saved that definition to a control file, and you delete the barcode from the active PDF file, you must save that change to the existing control file. After you save markup changes to a control file, you must make the new version of the control file accessible to a RICOH ProcessDirector server for those changes to be applied to your production PDF files.

You can use any of the following methods to edit markup.

Methods to modify markup
Method Description
Double-click a markup box Displays the property definition window for the markup box.
Right-click a markup box Displays a popup menu with options to edit the definition of the markup box or to delete it.
Click and drag to resize or move a box Click any box for markup, document properties, or a page group definition. Resizing handles appear on the corners of the box. Click and drag a corner to change the size of the box.

Click and drag the middle of a box to move it to a new location.

    Note:
  • If the markup is layered underneath other markup, click Ricoh View Markup Navigator to isolate the markup you want to resize. Remove the checkmark from the boxes in front of markup that blocks your access to the markup you want to edit.
  • You can use the horizontal and vertical coordinates, width, and height in the markup definition window to change the location and size of the markup box.
  • If you click, resize, or move either a page group definition or a conditional trigger, make sure it is on the page that contains the data you are looking for. These three actions resample the data for a page group definition or a conditional trigger. If you do one of the actions on the wrong page, RICOH ProcessDirector Plug-in for Adobe Acrobat asks whether it should accept your change. If you click OK, the data changes to an incorrect value.
Left-click in the Markup Navigator To highlight a markup box:
  1. Click Ricoh View Markup Navigator.
  2. Click the markup you want to highlight.
Tip: You can keep the Markup Navigator window open as you add, modify, and delete markup. The window automatically updates with your changes.
Double-click in the Markup Navigator To edit markup, document properties, or a page group definition:
  1. Click Ricoh View Markup Navigator.
  2. Double click the markup you want to edit.
Hide markup using the Markup Navigator To hide markup, document properties, or a page group definition so you can access other markup:
  1. Click Ricoh View Markup Navigator.
  2. Toggle the check box on and off to show and hide:
    • A box that you drew for markup, document properties, or a page group definition.
    • A group of markup. For example, remove the check from the Image check box to hide all image markup boxes.
Note: When you use the Markup Navigator to hide markup, you are only hiding it from your view of the active PDF file. If you have a control file that contains hidden markup and you save a control file, the hidden markup is saved to the control file, and any definitions in it are processed by RICOH ProcessDirector.

1.2.4.32.7.11 Defining a page group

A page group defines the pages ranges for each document in your PDF file. You save one page group definition to the control file that you specify in a RICOH ProcessDirector IdentifyPDFDocuments step. We recommend that you define a page group before you add markup.
Note: You can define more than one control file per PDF file, but only the control file you identify in the Identify PDF control file property of the step based on the IdentifyPDFDocuments step template creates page groups. If you want to use RICOH ProcessDirector Plug-in for Adobe Acrobat preview mode to verify the correct placement of other markup, you might need to define a page group in the control files you use to generate such markup. You can, for example, add a control file that contains page group definitions to a BuildPDFFromDocuments step. However, because a BuildPDFFromDocuments step receives page grouping information from the previous IdentifyPDFDocuments step, a BuildPDFFromDocuments step ignores any page group definitions in its control files. See the information center topic on previewing markup for more information about best practices.
To define a page group:
  1. Open a PDF file in Adobe Acrobat Professional and click Ricoh Select to make the plug-in the active tool.
  2. To define a text-based page group, draw a box around the target text. Otherwise, draw a box anywhere on the page.
  3. Click Define Page Group.
  4. Either accept or change the default page group name. We recommend that you use the default name, so that anyone working on the PDF file can easily see where the page group boundary is defined. If you do change the name, do not use spaces or special characters (such @, #, $, and %). You can use periods and underscores.
  5. For text-based page groups, you can alter the location and size of the enclosing box by entering values for Horizontal and Vertical coordinates, Width, and Height. The position and size of the box are adjusted after you click OK.
  6. From the Page Groups list, select one of these options:
    • Treat entire PDF as a single page group: Creates a single page group that includes all processed pages.
    • Create fixed-length page groups: Creates page groups of specific lengths based on the value of the Page Group Length property. Page grouping starts on page 1 of the PDF file.

      For example, select 5 to create page groups for pages 1–5, 6–10, 11–15, and 16–18 in an 18–page PDF file.

    • Begin page group when the selected text is found: Creates page groups based on text that you select. Any page with the selected text inside the box you drew becomes the first page of a new page group.

      For example, select Page 1 of to create a new page group each time that RICOH ProcessDirector Plug-in for Adobe Acrobat finds the text Page 1 of inside the box you drew.

      Note: Characters in a PDF file have white space enclosing them. Make sure that the Selected Text field does not include characters — such as white-space characters — that you do not want. If it does, cancel the page group definition and redraw the box around the text.

    • Begin page group when the specified text is found: Creates page groups based on text that you specify. Any page with the specified text inside the box you drew becomes the first page of a new page group. The text does not need to be on the same page as the box you drew.

      From the Match method list, select one of these options:

      • Match text exactly: Matches the exact text that you specify.

      • Match text containing: Matches the text that you specify to a portion of the text in the box you drew. The text that you specify does not need to be in the same location on each page.

        For example, use this option to create a new page group each time that RICOH ProcessDirector Plug-in for Adobe Acrobat finds the text Page 1 of anywhere inside the box you drew. The box can contain other text. Page 1 of 4 and This is Page 1 of 4 found in the box both match the specified text Page 1 of.

      • Match text using wildcards [* or ?]: Matches the text that you specify, which includes wildcard characters, by interpreting the wildcard characters as any characters. The asterisk (*) matches zero or more characters. The question mark (?) matches a single character.

        For example, the first page of each mail piece has an account number that starts with A followed by seven digits. The position of the account number varies on each statement. You draw a box large enough to include the account number on all the statements and type A??????? as the value of the Specify text to match property. RICOH ProcessDirector Plug-in for Adobe Acrobat starts a new page group on each page with an account number like A1265581 or A6428229.

        Note: If you typed A??????* as the value of the Specify text to match property, RICOH ProcessDirector Plug-in for Adobe Acrobat would start a new page group when it finds account numbers with six or more digits.

      • Match text using a Java regular expression: Matches the Java regular expression that you specify.

        For example, each mail piece is in one of two languages: English or Spanish. You type (Page 1 of).*|(Página 1 de).* as the value of the Specify text to match property. RICOH ProcessDirector Plug-in for Adobe Acrobat starts a new page group when the text found is Page 1 of followed by any number of characters or Página 1 de followed by any number of characters. Examples: Page 1 of, Page 1 of 6, Página 1 de 2, or Página 1 de 10.

        Note: For more information, see the Java documentation for the java.util.regex.Pattern class.

    • Begin page group when text in selected area changes: Creates page groups when text inside the box you drew changes. The page with the changed text becomes the first page of a new page group.

      For example, you draw a box around an account name. RICOH ProcessDirector Plug-in for Adobe Acrobat creates a page group each time a new account name appears in the box you drew.

      Important: When you draw the box for this type of page group, make sure that the location of the box on every page encompasses only the text to evaluate or white space (no text). If other text appears in the box, unwanted page groups are identified. Pages that contain white space, in the location of the box, do not start a new page group.

    • Begin page group when text or drawn objects are detected: Creates page groups when either a graphic object or text is enclosed in the box you drew. If the box you drew does not contain the text or entire graphic, then the page is not the start of a new page group.
      Note: Not all marks are graphics. Some marks are image data.
  7. Click OK.
  8. Click Ricoh View Page Group Navigator and verify that the page groups begin on the correct pages.
    If text-based page groups do not begin on the correct pages, the box you drew might not be the correct size for the text you selected or specified. Inspect the page groups to see if you can find the problem. Then redraw the box, change the text, or both.
  9. Edit the page group definition by double-clicking the box representing the page group, or by clicking Ricoh View Page Group Navigator and then double-clicking the page group name.
  10. When you are ready to save all your enhancements to the PDF file, including the new page group definition, click Ricoh Save Control File.

1.2.4.32.7.12 Working with document properties

You can define document properties from data in your PDF file that you want to use for later print processing. When RICOH ProcessDirector processes PDF files with document property definitions, it extracts, or mines, values from each page group in a PDF file. For example, you can create document properties to extract data in each page group in a PDF file and define that data as the content of a barcode that prints on a page in the same page group.

When you define a document property, you specify data in the PDF file. You can apply conditional processing rules to tell RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector where to extract the data from and when to extract it. For example, you want to apply conditional processing rules that extract an account number from the first page of every page group when an account is overdue. First you create a conditional trigger on text that indicates the account is overdue. Then you define a rule with two conditions. One condition specifies that the “overdue” text is present. The other condition specifies the pre-defined rule First Front Only. You choose to apply the new rule when all of its conditions are met. Finally you define the account number as a document property and select the new rule in the Placement Conditions section. RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector extract the account number from the first front page of each page group when the “overdue” text is present.

When you define a document property in RICOH ProcessDirector Plug-in for Adobe Acrobat, you select a RICOH ProcessDirector document property from a list or define your own document property name. If you define your own document property name instead of selecting a RICOH ProcessDirector document property, that document property cannot be integrated into RICOH ProcessDirector functions that save the properties to the database. You cannot use that document property for functions in RICOH ProcessDirector document processing features, or for markup content in barcodes or text. You should choose to create your own document property in RICOH ProcessDirector Plug-in for Adobe Acrobat only if you are going to extract your document properties to a file or if you know the document property will exist in RICOH ProcessDirector when your PDF files are processed. If you need to use a document property with RICOH ProcessDirector, create it in RICOH ProcessDirector and then select the document property from the list in RICOH ProcessDirector Plug-in for Adobe Acrobat.

    Note:
  • You see the database or system names for document properties in the lists in RICOH ProcessDirector Plug-in for Adobe Acrobat and the document properties list in the RICOH ProcessDirector viewer. In those lists you do not see custom or translated document property names.

Viewing document property values

After you define one or more document properties, you click Ricoh View Document Property Values to see the values of the document properties in the active PDF file. You can verify that the conditional processing rules and the text selected for each document property are correct. Use the document property view to verify that none of the document property values are longer than the text selection box you drew. RICOH ProcessDirector Plug-in for Adobe Acrobat truncates any text that extends beyond the text selection box.

    Note:
  • The Document Property window is a useful tool for you to keep open as you define document properties. After you create your first document property and view its values, you can click the Update Table button in the Document Property window at any time to update the table with changes that you made to the document properties.

Saving document property values

If you need to use document property values outside the product, click Save while viewing document property values. RICOH ProcessDirector Plug-in for Adobe Acrobat saves the values to a tab-delimited text file.

Using document properties in RICOH ProcessDirector

You define how document properties are used in different RICOH ProcessDirector print processing steps. For example, you define how RICOH ProcessDirector uses document properties in its barcode creation function. You can also use document property values to search for a specific customer account from a PDF print job if you need to reprint a mailpiece of that one customer.

Creating new document properties in RICOH ProcessDirector

After you install your document processing feature, you define all of the custom document properties you need in the docCustomDefinitions.xml file. When you run the docCustom utility to update configuration files, those properties are added to the database. If you need to create additional custom document properties, you edit the docCustomDefinitions.xml file and rerun the docCustom utility.

    Note:
  • If you use custom document properties, starting with Version 3.11.2, you can create them on the Administration tab, using Objects Custom Properties.

    You can choose the database name and the label that displays in property notebooks and column headings. You can also choose what kind of data to store in the property, and the default access that the different user groups have for the property, without adding them to the docCustomDefinitions.xml file.

  • If you already have custom document properties defined in a docCustomDefinitions.xml file, you can continue to use them. Do not re-create them from the Administration tab. Only use that tab to create new job or document properties.

After you load the new document properties values, they are available to you in the plug-in wherever you define document properties. For more information about editing the docCustomDefinitions.xml file and running the docCustom utility, see RICOH ProcessDirector: Installing Document Processing Features.

    Note:
  • When you define document properties you can define a document property as a limited document property. Limited document properties do not need database table space; however, they occupy space for each document in each document properties file that contains the property.

1.2.4.32.7.12.1 Defining a document property

RICOH ProcessDirector features can store document property values in the RICOH ProcessDirector database. The features rely upon document properties for later downstream processing of PDF files in RICOH ProcessDirector.
    Note:
  • Read the document property overview section to ensure you understand how document properties are used in RICOH ProcessDirector so you can take full advantage of your RICOH ProcessDirector feature.
To define a document property:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Left-click just above the top left corner of the data that you want to capture. Drag the mouse to draw a box around the data.
    You can later view the extracted values to verify your selection.
      Note:
    • The data to capture can be text or DataMatrix barcodes encoded as images.
    • Make the box big enough to capture the longest occurrence of the data in your PDF files. Some characters in a PDF file have a larger white space buffer than other characters. For example, the left edge of a large capital letter might have up to a tenth of an inch of white space buffer that you might need to select in order to capture that letter.
  3. Select Define Document Property from the popup menu.
  4. Select a RICOH ProcessDirector document property from the list or type a document property name into the field. Do not use any special characters (such as @, #, $, %, or - (dash)) or spaces. The RICOH ProcessDirector IdentifyPDFDocuments step might fail. You can use periods and underscores.
      Note:
    • When you define document properties, you can define a document property more than once. For example, text in your PDF file might be variable, and you might need to mine the zip code from two different locations. You can define your zip code document property twice - as long as you define different conditional placement rules that specify the pages from which the property is extracted. If you define the same document property in two different ways in the document, and each of their conditions are met, then only the value extracted last is used.
  5. Define which type of data to extract values from.
    • If you selected an area that only contains text, select Text under Select from.
    • If you selected an area that only contains barcodes, select Barcode image under Select from.
    • If you selected an area that contains both text and barcodes, select both Text and Barcode image.

      The text data is placed before the barcode data in the extracted string without an indicator of where the text data ends and the barcode data begins.

        Note:
      • We recommend using black barcodes. Using colored barcodes might have unpredictable results.

  6. Specify the page in each document from which document property data will be extracted. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is First Front Only. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
        Important:
      • The Last Back, Last Front, and Last Page rules do not work with the extraction of document property data.
    • Select Specific pages and type the page in each document that you want.

      If you specify multiple pages, RICOH ProcessDirector Plug-in for Adobe Acrobat extracts the document property data from the last specified page in each document. Examples:

      • You specify pages 2–4. If a document has four or more pages, the document property data is extracted from page 4. If a document has three pages, the document property data is extracted from page 3. If a document has two pages, the document property data is extracted from page 2.
      • You specify pages 2,4. If a document has four or more pages, the document property data is extracted from page 4. If a document has 2–3 pages, the document property data is extracted from page 2.
      • You specify pages 2–n. Because n represents the last page, the document property data is extracted from the last page if the document has two or more pages.
          Important:
        • If you specify only page n, RICOH ProcessDirector Plug-in for Adobe Acrobat does not extract the document property data from any page in a document.

  7. Optional: Select the edit icon (Edit line icon) to display a Modify Text window where you define one or more modifier extraction rules to extract the exact document property you need.
    1. Choose one of the following modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

      When you use a modifier to define a text extraction rule, the Text to Modify field at the top of the Modify Text window contains the selected line plus any edits you make to the line. The Modified Value field to the right of a modifier displays the text that results when that modifier is applied to the text it received from either the modifier above it or the Text to Modify field (if you are defining the first modifier).

    2. Continue to apply modifiers until you extract the value you want from the selected line. Click the Add icon icon to add a new modifier. The Final Text field below the list of modifiers displays the final modified value, after all modifier extraction rules are applied.
      For the selected modifier, the Modifier Initial Text field at the bottom of the window displays the value before the modifier is applied. The Modified Text field displays the value after the modifier is applied.
    3. Use the modifier management icons near the top of the window to delete and reorder the modifier extraction rules. Use the Trash can icon icon to delete the selected modifier extraction rules. Use the up and down arrow icons to reorder the rules. The rules are applied to the line in order from top to bottom.
    4. Click the OK button to save the line extraction rule.
  8. Click OK to create the document property.
  9. Click Ricoh View Document Property Values and scroll through several documents in your PDF file to verify that RICOH ProcessDirector Plug-in for Adobe Acrobat is extracting the correct document property values for each document.
  10. When you are ready to save all your enhancements to the PDF file, including the new document property definition, click Ricoh Save Control File.
  11. In the RICOH ProcessDirector IdentifyPDFDocuments step, specify the name and location of the control file that contains the document property definition.

1.2.4.32.7.12.2 Defining multiple document properties

You can define multiple document properties in a block of data in a PDF file. A block of data can be text, DataMatrix barcodes encoded as images, or both.
    Note:
  • Read the document property overview section to ensure you understand how document properties are used in RICOH ProcessDirector so you can take full advantage of your RICOH ProcessDirector feature.
To define multiple document properties:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Left-click just above the top left corner of the block of data that you want to capture. Drag the mouse to draw a box around the block of data. You can later view the extracted values to verify your selection.
      Note:
    • Make the box you draw big enough to capture the longest occurrence with the most lines of data in your PDF files. Some characters in a PDF file have a larger white space buffer than other characters. For example, the left edge of a large capital letter might have up to a tenth of an inch of white space buffer that you might need to select in order to capture that letter or line.
  3. Select Define Multiple Properties from the popup menu.
  4. Type a Name for the block of multiple document properties. Do not use spaces or special characters (such as @, #, $, %, or - (dash)) in the name. You can use periods and underscores.
  5. Define which type of data to extract values from.
    • If you selected an area that only contains text, select Text under Select from.
    • If you selected an area that only contains barcodes, select Barcode image under Select from.
    • If you selected an area that contains both text and barcodes, select both Text and Barcode image.

      The text data is placed before the barcode data in the extracted string without an indicator of where the text data ends and the barcode data begins.

  6. Specify the page in each document from which document property data will be extracted. Do either of these steps:
    • Select Pages based on a rule, and then select a rule from the list. The default rule is First Front Only. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
        Important:
      • The Last Back, Last Front, and Last Page rules do not work with the extraction of document property data.
    • Select Specific pages and type the page in each document that you want.

      If you specify multiple pages, RICOH ProcessDirector Plug-in for Adobe Acrobat extracts the document property data from the last specified page in each document. Examples:

      • You specify pages 2–4. If a document has four or more pages, the document property data is extracted from page 4. If a document has three pages, the document property data is extracted from page 3. If a document has two pages, the document property data is extracted from page 2.
      • You specify pages 2,4. If a document has four or more pages, the document property data is extracted from page 4. If a document has 2–3 pages, the document property data is extracted from page 2.
      • You specify pages 2–n. Because n represents the last page, the document property data is extracted from the last page if the document has two or more pages.
          Important:
        • If you specify only page n, RICOH ProcessDirector Plug-in for Adobe Acrobat does not extract the document property data from any page in a document.

  7. Use the Document Properties section of the definition window to select a document property and define the property extraction rule. This section contains the full text of the first line of the text data you selected. If you choose to edit an existing text block, this section contains all of the document properties you have defined for the text block. Follow these steps to define a new document property and the modifier extraction rule for it.
    1. Click the add icon (Add document property icon) to add a new document property definition row.
    2. Select a RICOH ProcessDirector document property from the Property list. You can define your own document property by typing in a document property name; however, you cannot use that document property in RICOH ProcessDirector. You should only define your own document properties when you are only using RICOH ProcessDirector Plug-in for Adobe Acrobat to export document property values to a text file.
    3. Select the Line of the text block from which you want to extract the selected document property. You can select the line using a top-down or a bottom-up reference. To select a line using a top-down reference, select 1 through n (where n is a positive whole number). To select a bottom-up reference, select Last or select Last - x (where x is the number of rows up from the last row). Instead of selecting the row value from the list, you can enter the row number directly into the Line field.
    4. Select the edit icon (Edit line icon) to display a Modify Text window where you define one or more modifier extraction rules to extract the exact document property you need.
    5. Choose one of the following modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

      When you use a modifier to define a text extraction rule, the Text to Modify field at the top of the Modify Text window contains the selected line plus any edits you make to the line. The Modified Value field to the right of a modifier displays the text that results when that modifier is applied to the text it received from either the modifier above it or the Text to Modify field (if you are defining the first modifier).

    6. Continue to apply modifiers until you extract the value you want from the selected line. Click the Add icon icon to add a new modifier. The Final Text field below the list of modifiers displays the final modified value, after all modifier extraction rules are applied.
      For the selected modifier, the Modifier Initial Text field at the bottom of the window displays the value before the modifier is applied. The Modified Text field displays the value after the modifier is applied.
    7. Use the modifier management icons near the top of the window to delete and reorder the modifier extraction rules. Use the Trash can icon icon to delete the selected modifier extraction rules. Use the up and down arrow icons to reorder the rules. The rules are applied to the line in order from top to bottom.
    8. Click the OK button to save the line extraction rule.
  8. Continue to define the other document properties you need to extract from a line in the block. You can select the same line that you used in another document property. If you need to delete a document property or want to rearrange their order, place a check mark in the box in front of a document property, and use the Trash can icon icon and the up down arrow icons.
  9. When you have finished defining document properties, click OK.
  10. Click Ricoh View Document Property Values to verify that the properties have the content you want.
  11. Optional: You can edit the text block definition by double-clicking its box or by right-clicking the box and selecting Edit.
  12. When you are ready to save all your enhancements to the PDF file, including the new document properties definition, click Ricoh Save Control File.
  13. Move the control file to a directory location used by a RICOH ProcessDirector server and include its name and location in a RICOH ProcessDirector IdentifyPDFDocuments step. This control file must also contain the page group definition that defines the documents in the PDF files processed by that step.

1.2.4.32.7.12.3 Defining an address block

You can define document properties in an address block in each document in a PDF file. After you define the document properties, you can extract and view them or save them in a text file.

Note: Use the Define Multiple Properties function to define document properties for addresses if:
  • The address components are not in block form.

  • You want to give the document properties your own names.

  • The Define Address Block function assigns one or more components of the address text to the wrong document property.

To define an address block:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
    Tip: Before you select an address block, scan your sample PDF file for the most complicated and longest example of addresses in the PDF files that you are going to process. For example, if the first document in your PDF file contains an address of only three rows, and page 80 contains a five-row address, draw the box around the five-row address so you can work with the most complicated address. When you view document property values, you can verify that each document property in shorter address blocks has the proper value.
  2. Left-click just above the top left corner of an address area and drag the mouse to capture all rows of the address.
  3. Select Define Address Block from the popup menu.
  4. Examine the Selected Address section of the Define Address Block window. If you have not captured all the lines in the address block, click Cancel and draw the box around the address again. Repeat this step until the address you want is displayed in the rows of the Selected Address table.
  5. Type a Name for the address block.
  6. Use the Extraction Conditions section to specify the page in each document from which address block data will be extracted. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is First Front Only. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
      Important: The Last Back, Last Front, and Last Page rules do not work with address block extraction.
    • Select Specific pages and type the page in each document that you want.

      If you specify multiple pages, RICOH ProcessDirector Plug-in for Adobe Acrobat extracts the address block from the last specified page in each document. Examples:

      • You specify pages 2–4. If a document has four or more pages, the address block is extracted from page 4. If a document has three pages, the address block is extracted from page 3. If a document has two pages, the address block is extracted from page 2.
      • You specify pages 2,4. If a document has four or more pages, the address block is extracted from page 4. If a document has 2–3 pages, the address block is extracted from page 2.
      • You specify pages 2–n. Because n represents the last page, the address block is extracted from the last page if the document has two or more pages.
        Important: If you specify only page n, RICOH ProcessDirector Plug-in for Adobe Acrobat does not extract the address block from any page in a document.

  7. Select an address type:
    • Address lines 1–7

      This option defines seven document properties (Doc.Address.1 through Doc.Address.7) based on the first seven lines in the address block. Subsequent lines are ignored.

    • U.S. addresses

      This option defines eight document properties:

      • Doc.Address.FullName

      • Doc.Address.Primary

      • Doc.Address.Secondary

      • Doc.Address.Other

      • Doc.Address.City

      • Doc.Address.State

      • Doc.Address.ZipCode

      • Doc.Address.CityStateZip

    Each component of address text in the Selected Address becomes a value for a document property in the Address Document Properties area.
  8. Check to make sure that each document property has the proper value.
  9. Click OK to create the document properties for the address block.
  10. Click Ricoh View Document Property Values to verify the properties have the content you want.
  11. Optional: You can edit the address block definition by double-clicking its box or by right-clicking the box and selecting Edit.
  12. When you are ready to save all your enhancements to the PDF file, including the new document properties for the address block, click Ricoh Save Control File.
  13. Make the control file accessible by your RICOH ProcessDirector server and include its name and location in an IdentifyPDFDocuments step. This control file must also contain the page group definition that defines the documents in the PDF files processed by that step.

1.2.4.32.7.12.4 Viewing document property values

After you create a document property in a sample PDF file, you can view the data values for that property. You view document property values to verify that you have selected the right location for the property and defined the correct conditional extraction rules. You can click a document property value to go to the first page of the page group that contains the value.
Follow these steps to view a table of extracted document property values.
  1. Open a PDF file in Adobe Acrobat Professional and load the control file that has the document properties you want to view.
  2. Click Ricoh View Document Property Values.
    In the Document Property View window, you see document property values for the number of pages that you defined in the Pages to Process preferences setting.
  3. To view fewer or more document property values, change the Number of pages to process and click Update table.
    The more pages you specify, the longer RICOH ProcessDirector Plug-in for Adobe Acrobat takes to view document property values.
  4. Optional: Click any row in the document property table to go to the first page in the page group that contains the document property value.
    Tip: Keep this window open as you define document properties, so you can update the values in the table to verify you have correctly selected the property.

1.2.4.32.7.12.5 Saving document property values

After you create document properties in a sample PDF file, you can save the data values for those properties. For example, you can save the account numbers in a PDF file that you plan on printing for an audit or printed in the past for an audit.
To save document property values:
  1. While viewing document property values, click Save.
  2. Select a location for the file and type a name, or use the name and location of the PDF file with a .txt extension.
  3. Click Save.
    RICOH ProcessDirector Plug-in for Adobe Acrobat generates a tab-delimited text file containing the values.

1.2.4.32.7.13 Working with rules

A rule is a set of one or more conditions. You can apply the conditions specified by a rule to place markup, extract data, or specify media and finishing options. You can also include a rule as a condition within another rule.

For example, you can use a rule to:

  • Place a barcode on the first page of each document in your PDF file
  • Extract a customer’s name when the city in the mailing address is New York
  • Specify gold media for the first page of each document for a Gold Club member

Each condition in a rule compares two values. The first value can be a Predefined Rule (a rule defined by RICOH ProcessDirector Plug-in for Adobe Acrobat that specifies pages within documents), a Custom Rule (a rule that you have defined), a conditional trigger, a job property, a document property, or a statistic. The choices for the second value depend on the first value.

When you create a rule with multiple conditions, you can specify whether the rule requires all conditions to be met or any condition to be met.

Rules can evaluate static and dynamic values. For example, a rule can evaluate whether the total number of documents in a job is greater than 10. A rule can also evaluate whether the value of the Doc.Begin.Balance document property is equal to the value of the Doc.End.Balance document property.

The Figure below shows a rule with five different types of conditions.

Rule with multiple conditions
Rule Builder dialog showing a rule with multiple conditions

1.2.4.32.7.13.1 Pre-defined rules

RICOH ProcessDirector Plug-in for Adobe Acrobat has 11 pre-defined rules that apply markup to, set media and finishing options for, or extract data from specific pages within each document in a PDF file. For example, you can use a pre-defined rule to place an image on all front pages in each document.

The table below describes each pre-defined rule.

Pre-defined rules
Rule Definition
All Front Pages All front-facing pages in each page group. If the rule is used to define a document property, the value extracted is from the last front page in a page group.
All Back Pages All back-facing pages in each page group. This rule does not apply to a simplex job. If the rule is used to define a document property in a duplex job, the value extracted is from the last back page in a page group.
All Pages Markup prints on all pages in each page group. Document properties values are extracted from the last page (either front or back) in a page group. If a rule does not have a condition with a pre-defined rule, RICOH ProcessDirector Plug-in for Adobe Acrobat applies the rule to All Pages.
First Front Only First page in each page group.
First Back Only First back page in each page group. This rule does not apply to simplex jobs.
Second Front Only Second front-facing page in each page group.
Second Back Only Second back-facing page in each page group. This rule does not apply to simplex jobs or to jobs that do not have a second back page.
Last Front Only Last front-facing page in each page group.
Last Back Only Last back of each page group. This rule does not apply to simplex jobs.
Last Page Only Last page of each page group (front or back is not a factor).
No Pages No pages. To keep a rule from being applied, you can add a condition with No Pages = True.

1.2.4.32.7.13.2 Conditional triggers

A conditional trigger is text that determines whether a condition is met.

If you want to place a barcode on a page whenever the word Invoice appears at the top of the page, you can define a conditional trigger for the word Invoice, define a rule with the trigger as a condition, and use the rule to apply the barcode.

If you want to use special media when the word Overdue appears at the bottom of the page, you can define a conditional trigger for the word Overdue, define a rule with the trigger as a condition, and use the rule to set the media.

If you want to extract the value of a document property whenever the words Account Summary appear on the right side of the page, you can define a conditional trigger for the words Account Summary, define a rule with the trigger as a condition, and use the rule when you define the document property.

Tip: If you know that the word you want to define as a conditional trigger occurs on a specific page in every page group, you can use the Stat.CurrentPageInDocument statistic instead of a conditional trigger.

1.2.4.32.7.13.3 Using job properties or document properties in rules

You can compare a job property or document property to a static value, such as a number or word, or to a dynamic value, such as job property, document property or statistic.

For example, you have two inserters, and you want to choose the inserter for different jobs. You can use the SetDocPropsFromConditions step in your workflow to set a value of a specific job property such as Doc.Insert.InserterID. In RICOH ProcessDirector Plug-in for Adobe Acrobat, you can use the Doc.Insert.InserterID job property in a rule. RICOH ProcessDirector can apply a specific barcode or image based on the control file (which contains the rules you defined in RICOH ProcessDirector Plug-in for Adobe Acrobat) that you add to a BuildPDFFromDocuments step.

Note: When using a document or job property value in a rule, define your value so it matches the value of the property when RICOH ProcessDirector processes the page groups in the PDF file. For example, the values of the Doc.Insert.InserterID job property in RICOH ProcessDirector are 01 and 02. Use those values when you define a rule with the Doc.Insert.InserterID job property as a condition. Do not use One and Two.

1.2.4.32.7.13.4 Using statistics in rules

You can compare a statistic to a static value, such as a number or word, or to a dynamic value, such as a job property, document property, or statistic.

For example, you want to create a barcode on the third page of every document. You select the Stat.CurrentPageInDocument statistic, select = as the mathematical symbol, and type 3 in the Text field. The fifth condition in the Figure Rule with multiple conditions specifies a statistic.

The table below describes the available statistics.

Statistics options for rules
Keyword Level Definition
Stat.TotalDocumentsInJob Print job The total number of documents in the current print job.
Stat.TotalSheetsInJob Print job The total number of sheets in the current print job.
Stat.TotalPagesInDocument Document The total count of pages in the current document.
Stat.TotalSheetsInDocument Document The total count of sheets in the current document.
Stat.CurrentDocumentInJob Document The number of the current document in its print job, starting at 1. For example, the value of Stat.CurrentDocumentInJob for the third document is 3.
Stat.CurrentPageInDocument Page The number of the current page in its document, starting at 1. For example, the value of Stat.CurrentPageInDocument for the second page in a document is 2.
Stat.CurrentSheetInDocument Page The number of the current sheet in its document, starting at 1.
Stat.CurrentPageInJob Page The number of the current page in its print file, starting at 1 and always from the Start page of the job. For example, the value of Stat.CurrentPageInJob for the tenth page in the print file is 10.
Stat.CurrentSheetInJob Page The number of the current sheet in its print file, starting at 1 and always from the Start page of the job.
Stat.CurrentMedia Page The media specified for the current page in a print job when the IdentifyPDFDocuments step was run. If no media is specified for the page, Stat.CurrentMedia provides the media specified for the job. If no media is specified for the page or the job, Stat.CurrentMedia does not provide a value. For example, the value of Stat.CurrentMedia for the first page of a document is Letterhead.
    Note:
  • Stat_CurrentMedia does not provide media specified using RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • You cannot preview markup that is placed using a RICOH ProcessDirector Plug-in for Adobe Acrobat rule that evaluates Stat.CurrentMedia.
Note: Although some statistics describe job-level values, RICOH ProcessDirector evaluates each page in a document when determining whether or not to apply markup or extract the value of a document property.

1.2.4.32.7.13.5 Defining a rule

You can define rules that specify conditions for markup. You can also define rules to set media and finishing options, or to extract data.
Before you define a rule, make sure you have defined each custom rule, document property, and conditional trigger that you want to use as conditions in the rule.
To define a rule:
  1. Click Ricoh Manage Rules.
  2. Click the Add content icon icon.
    Rules are shown alphabetically by name.
    Tip: In a markup dialog, you can define a rule by clicking the Add content icon icon and edit a rule by clicking the Rules Manager icon icon.
  3. Type a Name for the rule. You can use alphanumeric characters, periods, underscores, spaces, and special characters (such as @, #, $, or %).
  4. Optional: Type a Description.
  5. Specify whether RICOH ProcessDirector Plug-in for Adobe Acrobat should apply the rule when any or all of its conditions are met.
  6. Specify the first condition.
    1. Click the down arrow for the Not set drop-down list.
    2. Click the + icon next to Predefined Rule, Custom Rule, Trigger, Job Property, Document Property, or Statistic and select the item you want for the first part of the condition.

      If a choice (such as custom rules, conditional triggers, or document properties) does not have any items, the choice is grayed out.

      Note: To display all items with a word in their names, type the word and press the down arrow key on your keyboard. You can also type the word and click the down arrow for the drop-down list.
    3. Select a mathematical symbol, such as = (equals) or (does not equal), to compare the two parts of the condition.
    4. Specify the second part of the condition:
      • For a rule, select True or False.
      • For a conditional trigger, verify that the condition has the value you want. If not, select a new conditional trigger.
      • For a job property, document property, or statistic, type a value. You can also select any job property, document property, or statistic.
  7. For a rule with multiple conditions, click the Add content icon icon and specify the next condition.
    Repeat this step until you have defined all the conditions in the rule.
  8. Click OK to create the rule and add it to the Rules Manager.
Examples
Rule with one condition: a pre-defined rule
To place markup on the first front page of each document, define a rule with a pre-defined rule as its only condition: First Front Only = True
Three rules that each have one condition: a document property
A job contains sales statements for members at three different levels based on sales performance: Bronze, Silver, and Gold. You want to identify each membership level.
  • In RICOH ProcessDirector, define a document property: doc.member.level.
  • In RICOH ProcessDirector Plug-in for Adobe Acrobat, define three rules:
    • Gold Level

      doc.member.level = GOLD

    • Silver Level

      doc.member.level = SILVER

    • Bronze Level

      doc.member.level = BRONZE

Rule with multiple conditions
A job contains sales statements for members at three different levels based on sales performance: Bronze, Silver, and Gold. You want to print a reward coupon on the first page of each statement for Gold and Silver members. This example uses three rules defined in the previous examples:
  • First Front Only
  • Gold Level
  • Silver Level

First, define a Top Sales rule with two conditions, which you apply when any condition is met:

  • Gold Level = True
  • Silver Level = True

Next, define a Top Sales — First Front rule with two conditions, which you apply when all conditions are met.

  • First Front Only = True
  • Top Sales = True

Finally, select the Add Image option. Apply settings by clicking Pages/documents based on conditions and selecting the Top Sales — First Front rule. Specify the path to the image.

Rule with one condition: a job property
To print VOID: DO NOT MAIL on each page of a test job:
  • Define a Test Job rule with a job property as its only condition: Job.TestJob = Yes
  • Select the Add Text option. Apply settings by clicking Pages/documents based on conditions and selecting the Test Job rule. Select Text as the Content Type and type VOID: DO NOT MAIL for the value.
Rule with a condition that uses dynamic data
When a statement has different addresses for billing and shipping, you want to print Order sent to shipping address on the statement:
  • Define two document properties: doc.shipping.address and doc.billing.address.
  • Define a Sent to Shipping Address rule with this condition: doc.shipping.address ≠ doc.billing.address
  • Select the Add Text option. Apply settings by clicking Pages/documents based on conditions and selecting the Sent to Shipping Address rule. Select Text as the Content Type and type Order shipped to shipping address for the value.

1.2.4.32.7.13.6 Defining a conditional trigger

You can define text in a PDF file as a trigger to control whether markup is applied to a page when RICOH ProcessDirector processes a PDF file. The text can also control whether media and finishing options are applied to a page and whether document properties are extracted from a page.
Note: If you are experimenting to determine which text to use as a conditional trigger, you do not have to save the conditional trigger in a control file before you use preview mode. For preview mode, RICOH ProcessDirector Plug-in for Adobe Acrobat generates a temporary control file.
To define a conditional trigger:
  1. Open a PDF file in Adobe Acrobat Professional and load a control file that contains the page group definition.
  2. Left-click slightly above and to the left of the text that you want to use as a conditional trigger. Drag the mouse to draw a box around the text.
      Note:
    • If you draw a box around an area with no text, the conditional trigger determines that its condition is met whenever the area has no text. The condition is also met when the area has an image or other markup but no text.
  3. Select Define Conditional Trigger.
  4. Verify that the Trigger box has the text that you selected. If not, click Cancel and select the text again.
  5. Type a Name for the trigger. Do not use spaces or special characters (such as @, #, $, or %) in the name. You can use periods and underscores.
  6. Click OK to create the trigger.
    The conditional trigger is now available on the drop-down list for specifying conditions when defining rules.
Example

You want to extract a customer account number for every page group. Each invoice in your PDF file contains the word Account near the upper left of the first or second page of every document. Each customer account number is printed to the right of that word. The longer invoices also have the customer account number on the third page.You draw a box around the first occurrence of the word Account in the PDF file you are enhancing, and you name the trigger acct_trg.

Next, you create a rule with a condition that specifies the trigger: acct_trg = Account.

Finally, you define a document property that applies the rule.

1.2.4.32.7.13.7 Managing rules

The Rules Manager dialog shows information about your rules. You can define new rules, and edit or delete existing rules.

For each rule, the dialog shows the rule name and description. Rules appear on the list in alphabetical order by name.

To define a new rule, click the Add icon icon.

To work with a rule, select it. Click the Edit icon icon to modify the rule or the Trash can icon icon to delete it.

1.2.4.32.7.14 Adding markup to a PDF file

You use RICOH ProcessDirector Plug-in for Adobe Acrobat to add markup to a PDF file that represents your production PDF files. You mark up a PDF file by drawing a box around existing content or by drawing a box to add new markup. You can preview the PDF file as you add markup to verify its content and placement on specific pages. When you are done enhancing the sample PDF file, you save your changes to one or more control files and make them accessible by a RICOH ProcessDirector server so it can apply the control files to production PDF files.

Before you add markup to a PDF file, you must define the page grouping for the documents in the PDF file. When previewing the page placement of markup, you may not be able to view the placement or content that RICOH ProcessDirector applies to markup when processing your RICOH ProcessDirector workflows. RICOH ProcessDirector Plug-in for Adobe Acrobat may not have access to all of the properties that you use to define both page placement rules and markup content (such as in text and barcodes). See the help on previewing a PDF file for more information.

When RICOH ProcessDirector applies markup defined in the control files that you specified in a BuildPDFFromDocuments step, RICOH ProcessDirector applies the markup in this order:

  • Hidden areas
  • Images
  • Text
  • OMR marks
  • Barcodes

1.2.4.32.7.14.1 Adding a barcode to a PDF file

To add a barcode to a PDF file, select the area where you want to place the barcode, specify a barcode type, and add content. You can limit the placement of a barcode to specific pages in each page group by specifying a rule or typing page numbers.

RICOH ProcessDirector Plug-in for Adobe Acrobat supports the following barcode types:

  • 2of5 (Interleaved 2 of 5)
  • Code128
  • Code39
  • Datamatrix
  • IMB (Intelligent Mail Barcode)
  • QR code (Quick Response Code)
  • RM4SCC (Royal Mail 4-State Customer Code)
  • RMM (Royal Mail Mailmark)
    Note:
  • If you are creating child jobs, make sure that the barcode type supports periods. Child jobs have a period in the job number (for example, 10000001.1). Automated Verification workflows create child jobs for open-loop reprints. The Postal Enablement GroupDocsForPostalProcess workflow creates a child job when the documents in the job qualify for more postal processing.

You can create a barcode from content within the PDF file. For example, if your processing extracts the customer account number for every mailpiece you print, you can create a barcode from the account number. You first create a document property for the account number. You can then select that document property when defining the barcode content.

If you want to use text in the PDF file to trigger placement of a barcode on a specific page in a page group, you first create a conditional trigger on that text and define a rule with the trigger as a condition. You can then select that rule when defining the barcode.

To add a barcode:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Use the left mouse button to draw a box where you want the barcode to print. You do not need to draw the box to the exact size of the barcode.
    The barcode is not resized to fit within the box. If you draw a box to the approximate size of the barcode, you can see its position relative to all the markup you add to the PDF file.
  3. Click Add Barcode.
  4. Type a Name for the barcode. Do not use spaces or special characters (such as @, #, $, or %) in the name. You can use periods and underscores.
  5. Optional: Use the Location section of the definition window to change the placement of the barcode by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the barcode, before any rotation. If your manufacturing equipment has a specification for the location of the barcode, use these coordinates to set a precise location.
      Note:
    • Width and Height change the size of the markup box but do not affect the location or size of the barcode.
  6. Select the clockwise Rotation (degrees). The reference point for rotating a barcode is its top left corner.
  7. Use the Placement Conditions section to specify the pages to place the barcode on. Do either of these steps:
    • Select Pages based on a rule, and then select a rule from the list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  8. Use the Barcode Configuration section to define the mechanical attributes and type of the barcode.
    1. Use the Barcode Type list to select one of the following barcodes: 2of5, Code128, Code39, Datamatrix, IMB, QR code, RM4SCC, or RMM.
    2. Click the Settings button to set the mechanical attributes of the barcode.
      The Table Barcode mechanical attributes describes the settings for each barcode type.
      Barcode mechanical attributes
      Barcode type Attribute and description
      2of5 and Code39 The unit of measure for the numeric attributes for these barcode types is millimeters.
      barHeight This attribute determines the vertical height of each bar.
      checksumMode This attribute determines the behavior of checksums.
      • To add the checksum to the message, enter: add
      • To check the checksum when rendering the barcode, enter: check
      • To disable checksum processing, enter: ignore
      • To enable the default barcode behavior, enter: auto
      moduleWidth This attribute is the width of the narrow element.
      widthFactor This attribute is the multiplier for the wide element or how many times wider it is than the narrow element.
      Code128 The unit of measure for the numeric attributes for this barcode type is millimeters.
      barHeight This attribute determines the vertical height of each bar.
      checksumMode This attribute determines the behavior of checksums.
      • To add the checksum to the message, enter: add
      • To check the checksum when rendering the barcode, enter: check
      • To disable checksum processing, enter: ignore
      • To enable the default barcode behavior, enter: auto
      moduleWidth This attribute is the width of the narrow element.
      Datamatrix The unit of measure for the numeric attributes of this barcode type is millimeters.
      maxSize This attribute determines the maximum number of modules in both X and Y directions.
      minSize This attribute determines the minimum number of modules in both X and Y directions.
      moduleWidth This attribute determines the size of each pixel element.
      shape The FORCE_SQUARE value forces the use of square symbols. No other values are supported.
      IMB and RM4SCC The unit of measure for the numeric attributes for these barcode types is millimeters.
      ascenderHeight This attribute defines the height of both the ascender and descender sections of long bars.
      intercharGapWidth This attribute defines the width of each gap. The value you enter must be from 0.38 through 0.63 and must be the same as the moduleWidth value.
      moduleWidth This attribute defines the width of each bar and must be from 0.38 through 0.63.
      trackHeight This attribute defines the height each short track or center bar and must be a value from 1.02 through 1.52.
      QR code The unit of measure for the numeric attribute of this barcode type (moduleWidth) is inches.
      encoding This attribute defines the encoding type of the QR barcode.
      • To specify UTF-8 encoding, enter: Auto
      • To specify that the Unicode data is output in that format, enter: Shift_JIS or another supported type of Shift JIS code points, such as sjis or x-sjis.
        Note:
      • The input data for the barcode must always be Unicode character points. Do not use Shift_JIS or any other non-Unicode input data.
      errorcorrection This attribute defines the capability to restore the data in a damaged QR barcode.
      • To specify that 7% of the code can be restored, enter: L
      • To specify that 15% of the code can be restored, enter: M
      • To specify that 25% of the code can be restored, enter: Q
      • To specify that 30% of the code can be restored, enter: H
      moduleWidth This attribute determines the size of each pixel element.
      version Do not change this attribute; it is reserved for future use.
      RMM shape This attribute determines the type of barcode.
      • To specify a 2D Type 9 barcode, enter: square
      • To specify a 2D Type 29 barcode, enter: rectangle

      The values for the attribute are not case-sensitive.

  9. Select one of the following from the Content Type list.
      Note:
    • Because RICOH ProcessDirector generates barcode content as it prepares a PDF file for printing, RICOH ProcessDirector Plug-in for Adobe Acrobat cannot always determine valid content for a barcode. For example, some barcodes cannot accept text or line breaks. If you include invalid barcode content, the PDF file job might fail in the RICOH ProcessDirector BuildPDFFromDocuments step.
    Job Property Select a job property whose value you want to include in the barcode.
    Document Property Select a document property whose value you want to include in the barcode.
    Statistic Select a statistic whose value you want to include in the barcode.
    Text Enter text that you want to include in the barcode.
    Line Break Select this content type when you want to force a line break. The break occurs after the last character of the prior barcode content.
    Script Only select this option on the advice of your software support representative.
    1. If you selected a document property, job property, or statistic Content Type, you can apply text modifier rules to the value of the property or statistic. Click the Edit icon icon to display a Modify Text window for defining one or more modifier extraction rules to extract the exact value you need.
    2. Enter text into the Text to Modify field. RICOH ProcessDirector generates or extracts statistics and properties as it processes each page group in production PDF files. Because these values are not available to RICOH ProcessDirector Plug-in for Adobe Acrobat, you must enter a text value that represents the values that RICOH ProcessDirector processes. The modifier rule is a template that is applied to all values of the content type that you selected. For example, you want to print only the last eight digits of customer account number, and you have stored the entire number into a document property. You select Document Property as the Content Type, and select the account document property as the Content Value. You define two Remove Character text modifier rules to strip dashes and spaces from the number to make them all uniform. Then you define a Substring by Position rule to retain only the last eight digits. You do not need to know any single value of a document property to create modifier rules. You need to know only the possible formats that could occur in your PDF files.
    3. Choose one of these modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

  10. To add a new content definition row, click the Add content icon icon. After you have added all content types and modifier rules to the barcode, you can place a check mark in the box next to a content type and use the up and down arrows to reorder the content. Use the Trash can icon icon to delete selected content.
  11. If you defined multiple lines of text and you want RICOH ProcessDirector Plug-in for Adobe Acrobat to remove lines that only contain white space, click the Remove blank lines check box to select it.
  12. To create your barcode configuration, click OK.
  13. To verify that the barcode has the content and page placement you intended, click Ricoh Preview.
  14. Optional: You can edit the barcode definition by double-clicking the barcode box or by right-clicking the box and clicking Edit.
  15. When you are ready to save all your enhancements to the PDF file, including the new barcode definition, click Ricoh Save Control File.
  16. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the barcode definition.

1.2.4.32.7.14.2 Adding OMR marks to a PDF file

You can add a variety of OMR marks of different height, width, and pitch to a PDF file. You can limit the placement of OMR marks to specific pages in each page group by specifying a rule or typing page numbers.
    Note:
  • If your brand of inserters or other machinery requires specific OMR marks, you must use the specifications from your supplier.
To add OMR marks:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Use the left mouse button to draw a box where you want the OMR marks to print. You do not need to draw the box to the exact size of the OMR marks.
    The OMR marks are not resized to fit within the box. If you draw a box to the approximate size of the OMR marks, you can see their position relative to all the markup you add to the PDF file.
  3. Select Add OMR.
  4. Type a Name for the OMR marks. Do not use spaces or special characters (such as @, #, $, or %). You can use periods and underscores.
  5. Optional: Use the Location section of the definition window to change the placement of the OMR marks by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the OMR marks. If your manufacturing equipment has a specification for the location of the OMR marks, use these coordinates to set a precise location.
    Note: Width and Height change the size of the markup box but do not affect the location or size of the OMR mark.
  6. Use the Placement Conditions section to specify the pages to place the OMR marks on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  7. Use the Physical Configuration section to define the OMR content and form. If the OMR Content drop-down list has the name of the configuration you need, select it from the list. OMR configuration files have a .omr extension and are saved by default in the RICOH ProcessDirector Plug-in for Adobe Acrobat application data directory. If you need a different configuration than the one that is selected, click the Manage Content button.
    Tip:
    • You can view the application data directory location for the current user by typing %appdata% in Windows Run command line and clicking OK.
    1. If you do not want to modify the selected OMR configuration file, click New or Copy.
    2. Use the Add and Remove buttons to manage the OMR content in the Chosen Marks box. Use the Move Up, Move Down, and Reverse buttons to specify the order in which the marks are printed.
      The Table Available OMR marks describes the marks you can add to your OMR definition.
      Available OMR marks
      OMR mark name Description
      Blank Leaves a space equal to the OMR pitch value plus the OMR height value.
      Collate Indicates that the current group of pages need to be enveloped. This mark normally appears only on the first or last sheet of a page group.
      Feeder Defines the location for a feeder station mark. There can be multiple occurrences of this mark.
      Gate Sometimes used to mark the start of an OMR set. If requested, this mark is always present.
      Parity Used to bring the total number of bars up to the required parity, either even or odd.
      Safety Sometimes used to mark the end of an OMR set. If requested, this mark is always present.
      Sequence Displays a sequence using from one to three bars or from one to four bars.
      Void Leaves a space equal to the OMR Pitch value.
    3. In the OMR Configuration section of the Add OMR window, first select your Units of measure. Enter numeric values into the Height and Length fields to define the height and width of each OMR mark. Enter a numeric value into the Pitch field to define the distance between each OMR mark.
    4. In the Parity section, select whether your inserter uses Odd or Even parity checking.
    5. Select First Page or Last Page collation.
    6. If you select a sequence bar type, use the Sequence Range section to specify 1 through 7 for three bars or 1 through 15 for four bars.
    7. If you select a sequence bar type, use the Sequence section to define the bit order of the sequence bars. Select Up to print the bars in a 1, 2, 4 order (three bars) or in 1, 2, 4, 8 order (four bars). Select Down to print the bars in 4, 2, 1 order or in 8, 4, 2, 1 order.
      If the sequence is Up, a bar in the first position represents 1, a bar in the second position represents 2, bars in the first and second positions represent three, a bar in the fourth position represents 4, bars in the first and fourth positions represent 5, and so on.
    8. After you have defined the OMR content and structure definition click Save and then click Cancel to return to the main OMR configuration window.
  8. Use the Inserts field to select a fixed set of inserts for an entire job. You enter either a 0 or a 1 to tell the inserter which inserts to pull for every document in a job. For example, on a six station inserter with stations numbered from one to six, if you want to add the inserts from stations two and four, you enter the value 010100 into the Inserts field.
  9. Click Ricoh Preview to verify the OMR has the structure and page placement you intended.
  10. Optional: You can edit the OMR definition by double clicking the OMR box or by right-clicking the box and selecting Edit.
  11. When you are ready to save all your enhancements to the PDF file, including the new OMR marks definition, click Ricoh Save Control File.
    Tip:
    • When you save an OMR configuration, the OMR definition is saved to an OMR configuration file in the InfoPrint directory in your application data directory. When you mark up a PDF file, add OMR marks, and save a control file, the OMR configuration is also saved into the control file. You specify that control file in a BuildPDFFromDocuments step. You do not need to move the OMR configuration file to a directory accessible by RICOH ProcessDirector, but you can move the OMR configuration file to another computer used by RICOH ProcessDirector Plug-in for Adobe Acrobat if you want to share the configuration with someone else.
  12. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the OMR marks definition.

1.2.4.32.7.14.3 Adding an image to a PDF file

You can add JPEG images, such as a logo or an advertisement, to the PDF file. You can limit the placement of an image to specific pages in each page group by specifying a rule or typing page numbers. RICOH ProcessDirector Plug-in for Adobe Acrobat can process only JPEG files that are in RGB format; the CMYK format is not supported.

To add an image:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group or define a page group.
  2. Use the left mouse button to draw a box where you want the image to print. You can also place an image over a hidden area markup box.
    Note: The image is not resized to match the size of the box. If you draw a box to the approximate size of the image, you can see its position relative to all the markup you add to the PDF file.
  3. Click Add Image.
  4. Use the Location section of the definition window to change the placement of the image by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the image.
    Note: Width and Height change the size of the markup box but do not affect the location or size of the image.
  5. Type a Name for the image. Do not use spaces or special characters (such as @, #, $, or %). You can use periods and underscores.
  6. Use the Placement Conditions section to specify the pages to place the image on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  7. If the image you are defining exists in a file path that you can access, select Browse, click the JPEG image file you want to add to the PDF file, and click Open. When you save this image definition to a control file, the image file is embedded in the control file. You do not need to copy the image to a directory accessible to a RICOH ProcessDirector server.

    Instead of embedding the image file in a control file, you can enter an image file name and location that RICOH ProcessDirector can access when a BuildPDFFromDocuments step processes PDF files. If you specify an image file name and location that RICOH ProcessDirector Plug-in for Adobe Acrobat cannot find, a message informs you that the image was not found. If you want to use the image file name and path for the RICOH ProcessDirector server, select Yes. Otherwise, select No.

    To specify a directory location accessible to RICOH ProcessDirector, type the full directory path and file name (for example, /aiw/aiw1/images/myimage.jpg). If RICOH ProcessDirector cannot find the image file when it processes a PDF file, the job fails in the BuildPDFFromDocuments step.

  8. Click OK to create the image configuration.
  9. Optional: Click Ricoh Preview to verify that the image has the page placement you intended.
  10. Optional: You can edit the image definition by double-clicking the image box or by right-clicking the box and selecting Edit.
  11. When you are ready to save all your enhancements to the PDF file, including the new image definition, click Ricoh Save Control File.
  12. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the image definition.

1.2.4.32.7.14.4 Hiding an area in a PDF file

You can hide an area of a PDF file by defining a cover block to keep an area on a page from being shown or printed when you process a production PDF file in RICOH ProcessDirector. You can limit the placement of a hidden area to specific pages in each page group by specifying a rule or typing page numbers.
Typically you hide areas of a PDF file that contain images, text, barcodes, or other types of optical marks that are no longer needed. For example, if you want to replace an existing optical mark with a smaller Datamatrix barcode, you draw a box over the area that contains the old marks to hide them. You then place a new Datamatrix barcode on top of the hidden area. When RICOH ProcessDirector processes a PDF file with a hidden area, it blocks that area from having any ink applied, so the hidden area is the same color as the print media. When RICOH ProcessDirector applies markup to a PDF file, the BuildPDFFromDocuments step applies all hidden areas before applying other markup.

To hide an area:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group or define a page group.
  2. Use the left mouse button to draw a box around the area of the PDF file that you want to hide.
  3. Click Hide Area.
  4. Optional: Use the Location section of the definition window to change the placement and size of the hidden area. The Horizontal and Vertical coordinates specify the distance between the top left corner of the page and the top left corner of the hidden area. The Width and Height specify the size of the hidden area.
  5. Type a Name for the hidden area. Do not use spaces or special characters (such as @, #, $, or %). You can use periods and underscores.
  6. Use the Placement Conditions section to specify the pages to place the hidden area on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  7. Click OK to create the hidden area definition.
  8. Click Ricoh Preview to verify the hidden area has the page placement you intended.
  9. Optional: You can edit the hidden area definition by double-clicking the hidden area box or by right-clicking the box and selecting Edit.
  10. When you are ready to save all your enhancements to the PDF file, including the new hidden area definition, click Ricoh Save Control File.
  11. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the hidden area definition.

1.2.4.32.7.14.5 Adding text to a PDF file

You can add fixed text or variable text to a PDF file. You also can combine fixed and variable text in one text box. Fixed text is text that you type. Variable text is data from document properties, job properties, or statistics.
To add text:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group or define a page group.
  2. Use the left mouse button to draw a box in the area where you want to add text.
    RICOH ProcessDirector Plug-in for Adobe Acrobat uses the upper left corner of the text box to position the text. All the text you specify is printed at the size you specify, even if the text does not fit inside the box.
  3. Click Add Text.
  4. Optional: Use the Location section of the definition window to change the placement of the text by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the text box.
    Note: Width and Height change the size of the markup box but do not affect the location or size of the text.
  5. Type a Name for the text box. Do not use spaces or special characters (such as @, #, $, or %) in the name. You can use periods and underscores.
  6. Select a value from the Align with enclosed text drop-down list:
    • If you want to align the text that you are adding with the first occurrence of existing text enclosed by the box you drew, select First occurrence. RICOH ProcessDirector Plug-in for Adobe Acrobat maintains that position each time that it adds the text.
    • If you want to align the text that you are adding with each occurrence of existing text enclosed by the box you drew, select Each occurrence.
    • If you do not want the text aligned, use the default value Disabled.
    Aligning new text with enclosed text is the most precise way to replace existing text.
      Note:
    • The Align with enclosed text function works best when the new text and the existing text are in the same font. If the fonts are different, RICOH ProcessDirector Plug-in for Adobe Acrobat aligns the baselines of the fonts.

    • RICOH ProcessDirector Plug-in for Adobe Acrobat always aligns the first line of the new text with the first line of the existing text.

    • If the enclosed text is not left-justified, RICOH ProcessDirector Plug-in for Adobe Acrobat aligns the new text with the left-most line of the existing text.

  7. Select the clockwise Rotation (degrees). The reference point for rotating a text box is its top left corner.
  8. Use the Placement Conditions section to specify the pages to place the text on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

  9. Use the Font section to select the font, size, and color.
    The font drop-down list includes all fonts available to Adobe Acrobat except for fonts that do not permit embedding in a PDF file.
      Note:
    • To make a font available to RICOH ProcessDirector Plug-in for Adobe Acrobat, install it in the Windows Fonts folder.
    • RICOH ProcessDirector Plug-in for Adobe Acrobat does not support alternate letter forms, including ligatures, swashes, and letter forms that vary according to where they appear in a word. Right-to-left languages, such as Hebrew and Arabic, are rendered incorrectly. However, the font drop-down list shows all fonts installed in the Windows Fonts folder, including fonts for right-to-left languages and fonts with unsupported alternate letter forms.
    • When a font is added to a control file, it is the user’s responsibility to make sure that the font is licensed on all machines that use the control file to process a PDF document.
  10. Define the content of the text you are adding:
    1. Select the first Content Type from the drop-down list. You can select as many of the following types as you need to define the text content:
      Text markup content types
      Content Type Description
      Text Type text that you want to print.
      Document Property Select a document property whose value you want to print.
      Job Property Select a job property whose value you want to print.
      Line Break Select this content type to force a line break. The break occurs after the last character of any prior text content.
      Statistic Select a statistic whose value you want to print.
      Script Only select this option on the advice of your software support representative.
    2. Select the Content Value. The drop-down list has the available values for the selected Content Type.
    3. Optional: You can apply text modifier rules to the value of a document property, job property, or job statistic Content Type. Click the Edit icon icon to define one or more text modifier rules to extract the exact value you need.
    4. Type text in the Text to Modify field. RICOH ProcessDirector generates or extracts statistics and properties as it processes each page group in the production PDF files. Because these values are not available to RICOH ProcessDirector Plug-in for Adobe Acrobat, you must enter a text value that is representative of the values that RICOH ProcessDirector processes. The modifier rule is a template that is applied to all values of the content type that you selected. For example, you might need to print only the last four digits of a credit card number, and you have stored the entire number in a document property. You select Document Property as the Content Type, and select the credit card document property as the Content Value. You define two Remove Character text modifier rules to strip dashes and spaces from the number to make them all uniform, and then you define a Substring by Position rule to retain only the last four digits. You do not need to know any single value of a document property to create modifier rules, you need to know only the possible formats that could occur in your PDF files.
    5. Choose one of the following modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

  11. Click Add document property icon to add a new content definition row. After you have added all content types and modifier rules to the text you are adding to the PDF file, you can place a check mark in the box next to a content type and use the up and down icons to reorder the content. Use the Trash can icon icon to delete selected content.
  12. If you defined multiple lines of text and you want RICOH ProcessDirector Plug-in for Adobe Acrobat to remove lines that only contain white space, click the Remove blank lines check box to select it.
  13. Click OK to create the text configuration.
  14. Click Ricoh Preview to verify the text has the content and page placement you intended.
  15. Optional: You can edit the text definition by double-clicking its box or by right-clicking the box and clicking Edit.
  16. When you are ready to save all your enhancements to the PDF file, including the new text definition, click Ricoh Save Control File.
  17. Move the control file to a directory location that RICOH ProcessDirector can access.
  18. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the text definition.

1.2.4.32.7.15 Working with page inserts

The Inserts Manager dialog shows information about page inserts from other PDF files. You can add, edit, and delete page inserts. You also can set the order in which RICOH ProcessDirector adds the inserts to the documents in a job when the BuildPDFFromDocuments step runs.

The Inserts Manager dialog provides this information for each page insert:

  • The PDF file column shows the directory path to the PDF file on the RICOH ProcessDirector primary server.

  • The Insert location column shows whether the pages are inserted before or after the pages in the documents.

  • The Pages column shows which pages in each PDF file are inserted.

  • The Rule column shows the name of the rule that RICOH ProcessDirector uses to determine which documents in a job receive the inserts when the BuildPDFFromDocuments step runs.

  • The Sides column shows whether the insert is one-sided, two-sided, tumbled, or that the setting is inherited from the job.

To add a page insert, click the Add icon icon.

To work with a page insert, select it. Click the Edit icon icon to modify the page insert or the Trash can icon icon to delete it.

RICOH ProcessDirector adds the inserts to the documents in a job in the order that they appear on the Inserts Manager list, from top to bottom.

To revise the order in which inserts are added to the documents, select an insert. Click the Up arrow icon icon or the Down arrow icon icon to move the insert up or down the list.

1.2.4.32.7.15.1 Inserting pages from other PDF files

In a PDF file, you can insert pages from other PDF files before each document that matches the placement conditions, after each document that matches the placement conditions, or both. The inserted pages increase the number of pages in each document, and you can apply markup to them.

To insert pages from other PDF files:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains page groups or define page groups.
  2. Click Ricoh Manage Inserts.
  3. Click the Add content icon icon.
  4. Specify the first PDF file with pages that you want to insert:
    • If you can access the file, click Browse in the File to Insert section. Navigate to the file. Select it, and click Open.
    • If you cannot access the file, type the full directory path to the file on the RICOH ProcessDirector primary server.

      For example, type /aiw/aiw1/insertpages/insert1.pdf on a Unix-based system or C:\aiw\aiw1\insertpages\insert1.pdf on Windows.

      Make sure that RICOH ProcessDirector can access the file when the BuildPDFFromDocuments step runs.

  5. To insert all pages in the file, click the All pages radio button.

    To specify the pages for insertion, click the Specific pages radio button, and type the page selection.

    • Use a hyphen to separate the first and last pages in a page range.
    • Use a comma to separate page selections.
    • Type n to specify the last page.

      For example, type 8-n,5,2 to insert the pages from 8 to the end of the insert file, followed by pages 5 and 2.

  6. In the Insert Location section, choose whether to insert the pages before or after the pages in the documents that match the specified placement conditions.
  7. In the Placement Conditions section, specify the documents that receive inserted pages:
    • To insert pages before or after each document in the open PDF file, click the All documents radio button.
    • To insert pages before or after some documents but not others, click the Documents based on a rule radio button.

      From the list, choose the rule that defines the placement conditions.

      You also can do these actions:

      • To define a new rule, click the Add content icon icon.

      • To go to the Rules Manager, click the Rules Manager icon icon.

      Important:

      • Custom rules for page inserts can include conditions based on the values of job properties, document properties, and document statistics (such as Stat.TotalPagesInDocument and Stat.TotalSheetsInDocument).

      • Conditions based on the values of conditional triggers or page statistics (such as Stat.CurrentPageInJob and Stat.CurrentSheetInJob) do not work with custom rules for page inserts. RICOH ProcessDirector evaluates whether a rule for page insertions applies to a document before evaluating the information on the individual pages in a document.

      • Pre-defined rules, such as All Front Pages or Last Back Only, add page inserts to all documents or no documents. Because those rules do not restrict page inserts to specific documents, do not use them for page inserts.

  8. In the Sides section, specify whether you want to print the insert one-sided or two-sided.
    Simplex
    The insert prints on a single side of the paper.
    Duplex
    The insert prints on both sides of the paper, with the long side of the paper as the bound edge.
    Tumble
    The insert prints on both sides of the paper, with the short edge of the paper as the bound edge. The bottom of the front side of the sheet is the top of the back side of the sheet.
    From print job
    The insert prints on the sides specified in the print job.
  9. Click OK.
  10. To select another PDF file and specify how to insert pages, click the Add content icon icon. Repeat the steps for the first PDF file.

    RICOH ProcessDirector inserts the pages from the PDF files in the order that the files appear on the Inserts Manager list, from top to bottom.

    For example, an Inserts Manager list has 4 rows. The PDF files provide the following inserts:

    • Page 1 in the first PDF file is inserted before each document in the open PDF file.

    • Pages 4–6 in the second PDF file are inserted before each document.

    • Pages 2–4 in the third PDF file are inserted after each document.

    • Page 3 in the fourth PDF file is inserted after each document.

    The first document in the open PDF file has 6 pages. After RICOH ProcessDirector adds the inserts, the first document has 14 pages, in this order:
    • Page 1 from the first PDF file

    • Pages 4–6 from the second PDF file

    • Pages 1–6 from the original document

    • Pages 2–4 from the third PDF file

    • Page 3 from the fourth PDF file

  11. To change the order that RICOH ProcessDirector uses to insert pages into documents, select a row on the Inserts Manager list. To move the row up or down the list, click the Up arrow icon icon or the Down arrow icon icon.
  12. When you finish adding PDF files to the list, click OK.
  13. Optional: To verify that the pages have been inserted as you intended, click Ricoh Preview.

    When you preview a PDF file with inserts, RICOH ProcessDirector Plug-in for Adobe Acrobat checks whether the PDF files are at the directory paths you specified on the Inserts Manager list.

    • If they are, the pages are inserted from the PDF files at those directory paths.

    • If they are not, the pages are inserted from the PDF files that are embedded in the control file.

    If RICOH ProcessDirector Plug-in for Adobe Acrobat cannot find an embedded PDF file, the preview function displays a warning message and continues without inserting the pages.

  14. When you are ready to save all your enhancements to the open PDF file, including the new inserts, click Ricoh Save Control File.

    In the control file, RICOH ProcessDirector Plug-in for Adobe Acrobat embeds the PDF files that it can access.

    If the PDF files are embedded, you need not copy them to a directory accessible to a RICOH ProcessDirector server.

    Whenever you save the control file, RICOH ProcessDirector Plug-in for Adobe Acrobat tries to replace each embedded PDF file with the file at the directory path shown on the Inserts Manager list.

  15. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the pages to insert.

    When a job with inserts from other PDF files enters the BuildPDFFromDocuments step, RICOH ProcessDirector checks whether the PDF files are at the specified directory paths.

    • If they are, the pages are inserted from the PDF files at those directory paths.

    • If they are not, the pages are inserted from the PDF files that are embedded in the control file.

    If RICOH ProcessDirector cannot find an embedded PDF file, the job moves to error state. The job cannot complete the BuildPDFFromDocuments step until RICOH ProcessDirector can access all the PDF files that provide inserts or until you remove the page insertion instructions from the control file.

Example

Each document in a PDF file has from 1 to 3 pages. You want to insert page A at the end of documents with 2 pages. You want to insert page A and page B at the end of documents with 1 page.

  1. Define a rule named TotalPagesLessThan3 with 1 condition:

    Stat.TotalPagesInDocument < 3

  2. Define a page insert for page A and another page insert for page B.

  3. For each page insert:

    • Click the After documents radio button.

    • Click the Documents based on a rule radio button and select TotalPagesLessThan3.

  4. Make sure that the insert for page A is above the insert for page B on the Inserts Manager list.

If a document has 1 or 2 pages, RICOH ProcessDirector adds page A. If the document now has 2 pages, RICOH ProcessDirector adds page B after page A.

1.2.4.32.7.16 Media and finishing

You can specify media and finishing options for your sample PDF file and apply them as page exceptions to the job-level media and finishing options specified for RICOH ProcessDirector jobs.

You can apply media and finishing options to a range of pages or to the documents (page groups) within a PDF file. When applying media and finishing options to documents, you can use pre-defined rules or custom rules. For example, you can use a pre-defined rule to print the first page of each document on blue paper. You can define a custom rule so that each page with the words Premier Member in the upper right corner prints on gold paper.

Media and finishing options that you specify with RICOH ProcessDirector Plug-in for Adobe Acrobat override the options that RICOH ProcessDirector specifies for jobs.

    Note:
  • RICOH ProcessDirector Plug-in for Adobe Acrobat supports RICOH ProcessDirector media with electronic forms. The Show electronic forms preference determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use.

You can preview the PDF file as you add media and finishing options to verify that they have been applied to the intended pages.

Your media and finishing definitions are saved in the RICOH ProcessDirector Plug-in for Adobe Acrobat control file. RICOH ProcessDirector uses the control file to apply the definitions to print jobs automatically.

1.2.4.32.7.16.1 Managing media and finishing options

The Media and Finishing dialog shows information about your media and finishing options for a PDF file. You can edit and delete options, select new media and finishing options, and set the order in which RICOH ProcessDirector applies the options to a PDF file.

For each page-level media or finishing option, the Range column shows the page selection or the name of the rule that RICOH ProcessDirector Plug-in for Adobe Acrobat uses to apply the option to documents in the PDF file. The Paper substitution column shows media options, and the Subset finishing column shows finishing options.

To specify a new page-level media or finishing option, click the Add icon icon.

To work with a page-level media or finishing option, select it. Click the Edit icon icon to modify the option or the Trash can icon icon to delete it.

To revise the order in which page-level media and finishing options are applied to the PDF file, select an option. Then click the up or down arrow to move it.

RICOH ProcessDirector Plug-in for Adobe Acrobat applies the page-level options to the PDF file in the order that they appear on the list, from top to bottom. If two page-level options specify conflicting selections for the same page (for example, two different types of media), RICOH ProcessDirector Plug-in for Adobe Acrobat applies the option that is lower on the list.

For example, the first option specifies Letter Blue media for the first page of each document in the PDF file. The second option specifies Letter Gold media for the first page of each document for a Gold Club member. When the PDF file is printed, the first page of every document for a Gold Club member prints on Letter Gold media. The first page of every other document prints on Letter Blue media. If the option for Letter Blue media is below the option for Letter Gold media, the first page of every document prints on Letter Blue media. No first pages print on Letter Gold media.

Note: The order of media options does not affect how RICOH ProcessDirector Plug-in for Adobe Acrobat applies finishing options, and vice versa.

1.2.4.32.7.16.2 Selecting media and finishing options

You can select media and finishing options for specific pages in each page group by specifying a rule or typing page numbers. For example, you can specify that pages 1–4 of each page group are stapled. You can also specify that the first page of each page group prints on gold paper.
To select media and finishing options:
  1. Click Ricoh Media and Finishing and then click the Add icon icon.
  2. Select a media option on the Paper substitution list or a stapling option on the Subset finishing list.
      Note:
    • The media options are the names of RICOH ProcessDirector media objects specified in the media.zip file (or the media.xml file from an older version of RICOH ProcessDirector). For more information, see the topic about loading media objects in the help system or RICOH ProcessDirector: Installing Document Processing Features.
  3. Use the Placement Conditions section to specify the pages for the media or finishing option. Do either of these steps:
    • Select Pages based on a rule, and then select a rule from the list. The default rule is All Pages. You can also:
      • Define a new rule by clicking the Add content icon icon.
      • Go to the Rules Manager by clicking the Rules Manager icon icon.
    • Select Specify pages and type the pages that you want. Media and finishing options are applied to these pages in each page group. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page in each page group.

        For example, a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

  4. Click OK.
    The option that you specified appears on the media and finishing list.
  5. If you have multiple options for paper substitution or subset finishing, select the new option. Use the up and down arrows to move it into the proper position in the ordered list of options.

    RICOH ProcessDirector Plug-in for Adobe Acrobat applies the page-level options to the PDF file in the order that they appear on the list, from top to bottom. If two page-level options specify conflicting selections for the same page (for example, two different types of media), RICOH ProcessDirector Plug-in for Adobe Acrobat applies the option that is lower on the list.

  6. To verify that RICOH ProcessDirector Plug-in for Adobe Acrobat has applied media and finishing options to the intended pages:
    1. Click Ricoh Preview.
      If a page has media and finishing options, you see an annotation labeled Print Operations in the upper right corner.
    2. To see the media name and finishing option, hover the mouse pointer over Print Operations.

      For example:

      Media = Blue LetterStapling = Top left (#1)

      (#1) indicates the sequence of the page in the finishing option. If you specify stapling for pages 5–8, page 5 is #1 and page 8 is #4.

      As an alternative, click Comment on the Adobe Acrobat toolbar. In the Comments pane, you see a comment for each page with media and finishing options.
        Note:
      • The Show electronic forms preference determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use. Set the preference to Yes to see the data combined with the forms.
  7. When you are ready to save all your enhancements to the PDF file, including the new media and finishing options, click Ricoh Save Control File.
  8. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the media and finishing definitions.

1.2.4.32.8 Configuring the PDF Document Support feature

To configure the PDF Document Support feature, you set up to use documents in PDF jobs, and you configure your PDF workflows to process documents.

The functions in RICOH ProcessDirector Plug-in for Adobe Acrobat let you set up to use documents in PDF jobs. For example, you define how to identify the documents.

The functions on the RICOH ProcessDirector Workflow page let you configure your PDF workflows to process documents. For example, you add steps that identify documents and build PDF files from the documents. Other steps let you sort, split, and group documents and pull documents from a job.

If your production PDF files are processed by programs that change the PDF data, place the steps that call those programs before the steps that identify documents or after the steps that build PDF files from the documents.

If you get unexpected results when you process a PDF 2.0 file with a step based on the IdentifyPDFDocuments step, do one of these:

  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.
  • Place a step based on the OptimizePDF step template in the workflow before the IdentifyPDFDocuments step.

1.2.4.32.8.1 Setting up to use documents in PDF jobs

To use documents in PDF jobs, you define how to identify the documents, map data in the documents to RICOH ProcessDirector document properties, and add markup to the documents. Finally, you save the setup information in a RICOH ProcessDirector Plug-in for Adobe Acrobat control file.

You map data in the documents to document properties supplied with RICOH ProcessDirector or to custom document properties that you define. Define the custom document properties and load them to RICOH ProcessDirector Plug-in for Adobe Acrobat before you map data.

    Note:
  • This procedure gives general setup instructions. For detailed instructions, see the related topics.

To set up to use documents in PDF jobs:
  1. Open a PDF file in Adobe Acrobat Professional and click Ricoh Select to make RICOH ProcessDirector Plug-in for Adobe Acrobat the active tool.
  2. Define page groups, which identify the start of each document in a job:
    1. Draw a box around the text you want to use to define text-based page groups, or anywhere to define page groups that are not based on text.
    2. Select Define Page Group from the pop-up menu.
    3. Select one of the options from the Page Groups list.
    4. Click OK.
    5. Click Ricoh View Page Group Navigator and verify that the documents in the PDF file have been defined correctly.
  3. Map data in the documents to document properties:
    1. Left-click just above the top left corner of the data to capture. Drag the mouse to draw a box around the data.
      Make the box large enough to capture the longest occurrence of the data in your PDF files. Some characters in a PDF file have a larger white-space buffer than other characters.
    2. Select Define Document Property from the popup menu.
      You see the captured data in the Selected Text area of the dialog.
    3. Select a RICOH ProcessDirector document property from the list.
    4. Use the Placement Conditions section to specify the pages to extract the document property data from.
      For example, to extract the document property data from the first page of each document, select Pages based on a rule, and then select First Front Only.
    5. Click OK to create the document property.
    6. Click Ricoh View Document Property Values and scroll through several page groups in your PDF file to verify that RICOH ProcessDirector Plug-in for Adobe Acrobat extracted the correct document property values for each page group.
    7. To map data in the documents to another document property, repeat the steps above.
  4. Add markup, such as barcodes, OMR marks, images, hidden areas, and text:
    1. Left-click to specify the top left corner of the new markup. Drag the mouse to draw a box.
      For hidden areas, the box specifies the area. For barcodes, OMR marks, images, and text, the box specifies the upper left corner. The box does not specify the area that contains the barcode, OMR mark, image, or text.
    2. Select an option such as Add Barcode from the popup menu.
    3. Supply the requested information.
    4. Click OK to create the markup.
  5. Save your page group definition, document properties, and markup in a control file:
    1. Click Ricoh Save Control File.
    2. Give the control file a name or accept the default value.
    3. Click Save.
      You see a confirmation message.
    4. Click OK.
  6. Send or copy the control file to a directory on the primary computer that the RICOH ProcessDirector system user has access to.
When you create workflows that process PDF jobs containing documents, specify the name and location of the control file in each step based on the IdentifyPDFDocuments or BuildPDFFromDocuments step template.
    Note:
  • If you get unexpected results when you process a PDF 2.0 file with a step based on the IdentifyPDFDocuments step, do one of these:
    • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.
    • Place a step based on the OptimizePDF step template in the workflow before the IdentifyPDFDocuments step.

1.2.4.32.8.2 Configuring steps to identify documents in PDF files

If you have installed the PDF Document Support feature, you can add a step in your workflows based on the IdentifyPDFDocuments step template. You specify the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that contains document properties and the page grouping definitions. When RICOH ProcessDirector processes a PDF file using a workflow that includes an IdentifyPDFDocuments step, it identifies the documents in the PDF file and extracts document property values.
Steps that calculate values for document properties are based on the IdentifyPDFDocuments step template. The PDF Document Support feature and other document processing features provide workflows containing an IdentifyPDFDocuments step. If you use those supplied workflows or create your own workflows, you can configure an IdentifyPDFDocuments step in the workflow to specify the name of the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that contains document property definitions.

If you add an IdentifyPDFDocuments step to a workflow, place the step after all steps that alter the PDF file. If you add the step before a step that alters the file, unexpected results can occur.

If you get unexpected results when you process a PDF 2.0 file with a step based on the IdentifyPDFDocuments step, do one of these:

  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.
  • Place a step based on the OptimizePDF step template in the workflow before the IdentifyPDFDocuments step.

To configure a step that identifies documents in PDF files:

  1. Click the Workflow tab.
  2. Right-click the workflow that contains the IdentifyPDFDocuments step and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Right-click the IdentifyPDFDocuments step.
  5. Select Properties and if necessary, change the properties for the step.
  6. On the PDF tab, for the Identify PDF control file property, type the path and file name of the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that contains information about page grouping and document properties in the PDF files processed by this step, or use symbol notation to refer to the control file. This file is required and was created by RICOH ProcessDirector Plug-in for Adobe Acrobat when you defined document properties in a sample PDF using RICOH ProcessDirector Plug-in for Adobe Acrobat. The default extension for the control file is .ctl.
  7. Click OK.
  8. Save the workflow.

1.2.4.32.8.3 Setting up to process sets of files containing PDF documents and data

To process sets of files containing one or more documents in a PDF file and additional data in an auxiliary input file, you set up an input device that uses one of the batching methods for sets: Number of sets, Pages in sets, or Sets by time. Then, you set up a PDF workflow. When the IdentifyPDFDocuments step runs, it produces a single PDF job that contains all the individual documents. The step includes the additional data in the document properties file (DPF) for use by other steps in the workflow.
The step uses two properties to identify the additional data:
  • The value of the Auxiliary input file extension property identifies the file that contains the data.
  • The value of the Headers file property identifies the file that specifies which data in the auxiliary input file to add to the DPF.

This procedure uses an example to show how to process sets of files containing PDF documents and data.

  • In the example, an insurance company uses an application to produce letters to customers. Each letter is in a separate PDF file. The letters produced by the application do not contain the name, phone number, and email address of the agent for the customer.
  • A separate application produces comma-separated (CSV) files with the agent information and other data that helps the company compose and route the letters. The two applications output 100 pairs of files at the same time.
  • To optimize the processing of the letters and to add the contact information for the agents, the company batches 50 letters into a single PDF job with the 50 CSV files required to read the agent data into the DPF that the other steps in the workflow use.

Before you set up a workflow and an input device:

  • Make sure that the auxiliary input file meets these requirements:
    • The header line contains the database names of document properties, separated by commas, for each data value that you want to add to the document properties file.
    • The file has one data line for each document in the associated PDF file.
    • On each data line, the values for the document properties are separated by commas.

    For example, this auxiliary input file is associated with a PDF file that contains one document. The file contains a header line and one data line with five data values:

    Doc.Custom.AgentName,Doc.Custom.AgentPhone,Doc.Custom.AgentEmail,Region,AgentCodeKelly Lopez,1-800-555-1234,kelly.lopez@insurancebiz.com,Southeast,B475

  • Make sure that the headings for all the data values you want to use in the workflow are defined as RICOH ProcessDirector document properties.

    In the example, you want to use the values for Doc.Custom.AgentName, Doc.Custom.AgentPhone, and Doc.Custom.AgentEmail in a step based on the EmailDocuments step template.

    You define Doc.Custom.AgentName, Doc.Custom.AgentPhone, and Doc.Custom.AgentEmail as custom document properties.

      Note:
    • We recommend that the names of custom document properties start with Doc.Custom.
    • If you do not want to use a data value in the workflow, you do not need to define the heading for the data value as a RICOH ProcessDirector document property. In the example, you do not define AgentRegion and AgentCode as RICOH ProcessDirector document properties.

  • Create a headers file that lists the database names of the document properties whose values you want to add to the DPF. Each database property name is on a separate line.

    For example, you create a headers.txt file with this content:

    Doc.Custom.AgentNameDoc.Custom.AgentPhoneDoc.Custom.AgentEmail

    When the IdentifyPDFDocuments step in your workflow processes the set of files in the example, it creates a document properties file with data extracted from the letter and data from the auxiliary input file. For example, the company has mapped customer name and customer email address data in the letter to document properties in the Identify PDF control file. The IdentifyPDFDocuments step creates a DPF with these values:

    Doc.Custom.CustomerName Doc.EmailAddress       Doc.Custom.AgentNameDoc.Custom.AgentPhone Doc.Custom.AgentEmailChris Smith            chris.smith@myisp.com  Kelly Lopez1-800-555-1234        kelly.lopez@insurancebiz.com

To set up to process sets of files containing PDF documents and data:
  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
  3. Add or copy a hot folder input device.

    For example, click Add Hot Folder, and name the input device PDFInputFromSets.

  4. On all the tabs, fill in the required and optional properties that you need to adjust to match your environment.
  5. Click the General tab.
  6. For the Child workflow property, select the name of the workflow that you are modifying to process sets of files.

    For example, select PDFDocumentsFromSets.

    If you are creating a new workflow, use the default value. After you save the new workflow, display the properties for the input device and select the workflow as the value of this property.

  7. Click the Batching tab.
  8. For the Batching method property, select Number of sets, Pages in sets, or Sets by time.
  9. Specify values for other properties associated with the batching method you selected.

    For example, you want the input device to batch and submit files to the workflow after it receives 50 sets of PDF files and CSV files. For the Number of files to batch property, enter 50.

  10. Specify a value for the Matching pattern for sets property, or use the default value:
    (.+?)\.[^.]*$|$

    The default value tells RICOH ProcessDirector to add files whose names are identical except for their extensions to the same set.

    For example:

    customer_1.pdfcustomer_1.csv

  11. For the Data patterns property, enter: .*pdf$
  12. Enter property values for the file pattern that identifies an auxiliary input file.

    For example, type these values for an auxiliary input file with a CSV file extension:

    • File pattern: .*csv$
    • Spool file usage: auxinput
    • Spool file type: csv
    • File pattern required: Yes
    • File pattern sequence: 1

    RICOH ProcessDirector lets you use any value for the Spool file usage property that is not a RICOH ProcessDirector keyword. Keywords include control, overrrides, and print.

  13. Click Add.
  14. When you finish setting property values for the input device, click OK.
  15. Click the Workflow tab.
  16. Open a workflow that you want to modify, or create a new workflow.

    For example, you copy and modify the EnhancePDFDocuments supplied workflow. You name the copied workflow PDFDocumentsFromSets.

  17. Add or modify a step based on the IdentifyPDFDocuments step template.
  18. Set values for the properties of the IdentifyPDFDocuments step:
    1. For the Identify PDF control file property, specify the full path or symbolic name of the control file that you created using RICOH ProcessDirector Plug-in for Adobe Acrobat.

      The default Identify PDF control file defines each PDF file as a single document. Use RICOH ProcessDirector Plug-in for Adobe Acrobat to create a custom control file if:

      • Your PDF files contain two or more documents.
      • You want to add markup to the documents.
      • You want to map data in the documents to document properties.

    2. For the Auxiliary input file extension property, enter the file extension of the auxiliary input files.

      Make sure that this value matches the value of the Spool file type property for the auxiliary input file pattern that you defined on the input device

      In the example, the auxiliary input files have a CSV extension. Enter: csv

    3. For the Headers file property, enter the full path and name of the file that lists which values to copy from the auxiliary input file to the DPF.

      For example, enter /aiw/aiw1/aux_input/headers.txt (Linux) or C:\aiw\aiw1\aux_input\headers.txt (Windows).

  19. Make other changes to the workflow as needed.
  20. Save the workflow.
  21. Test the input device and workflow:
    1. Enable the workflow.
    2. Enable and connect the input device that sends jobs to the workflow.
    3. Submit sets of PDF files and CSV files to the input device until you reach the limit at which the input device batches the files and submits them to the workflow.
      For the example input device, submit 50 sets of PDF and CSV files.
When the IdentifyPDFDocuments step runs, it generates this output:
  • A single PDF file with all the documents from all the sets.
  • A sets directory that contains a subdirectory for each set of files.
  • A document properties file that contains the values for any data mapped to document properties in the Identify PDF control file and the values of data from the auxiliary input files.

1.2.4.32.8.4 PDF workflow to apply markup

Although the PDF Document Support feature includes advanced functions for managing PDF jobs at a document level, you might benefit from starting with a basic PDF workflow that applies markup to a PDF file and extracts document properties.

You would base the new workflow on the EnhancePDFDocuments workflow. Make a copy of that workflow and define the properties of the steps in the workflow as needed for your environment. In the IdentifyPDFDocuments step, you specify the file name and location of the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that contains page grouping and document property definitions. In the BuildPDFFromDocuments step, you specify the name and location of the control files that contain markup definitions. If you specify more than one control file in a control file property, separate the control files with a semicolon.

For large jobs, both processing of the IdentifyPDFDocuments and BuildPDFFromDocuments steps could be memory intensive operations. Review the documentation on tuning steps and on other considerations for memory management.

1.2.4.32.8.5 Workflow to split PDF jobs by size

The PDF Document Support feature includes step templates that you can use to split a job into smaller jobs so that, for example, they can be printed on separate printers.

To split a job without fragmenting any of its documents across two jobs, you must identify the boundaries of the documents in the job. To do that, you define page groups in PDF files using RICOH ProcessDirector Plug-in for Adobe Acrobat. You copy the plug-in control file with the page group definition to the location you specify in the IdentifyPDFDocuments step.

You include an IdentifyPDFDocuments step so it can apply the rules that you defined in RICOH ProcessDirector Plug-in for Adobe Acrobat to create the document properties file for the original job. The SplitDocuments step determines which documents are placed into each child job and updates the document properties file with that information.

You use a CreateJobsFromDocuments step, which makes document properties files for the child jobs but does not create PDF files. You must also include a step based on the BuildPDFFromDocuments step template in the workflow assigned to the child jobs. BuildPDFFromDocuments creates the PDF file with all the documents in the correct order. In this step, you also specify the RICOH ProcessDirector Plug-in for Adobe Acrobat control files that add markup to the PDF file.

The original workflow does not have any steps in the Print phase because the child workflow controls printing. After all the child jobs complete, the parent job goes to the next step in the original workflow.

The child workflow should begin with steps based on these two step templates: SetJobPropsFromTextFile and SetJobPropsFromOriginal. SetJobPropsFromTextFile sets values for job properties from the steps of the child workflow. SetJobPropsFromOriginal copies the values that were set in the original workflow to become the values for those properties in the child workflow. Then if you choose to run the building of the child PDF files in parallel by including a CreateJobsFromDocuments step in the original workflow, you need to use a BuildPDFFromDocuments step in the child workflow.

    Note:
  • If you have customized phase names in your system, the phase names in the table might not match the names in your system.
Splitting PDF jobs by size using CreateJobsFromDocuments
Parent/child Phase Step
Parent Receive SetJobPropsFromTextFile

In the Input data stream field, select PDF.

Prepare CountPages
IdentifyPDFDocuments
Assemble SplitDocuments
CreateJobsFromDocuments
Complete RetainCompletedJobs
RemoveJobs
Child Receive SetJobPropsFromTextFile
 
  Assemble BuildPDFFromDocuments
  Print CountPages
  CreatePageRanges
  PrintJobs
  Complete WaitForRelatedJobs
    RetainCompletedJobs
    RemoveJobs

1.2.4.32.8.6 Workflow to split PDF jobs by document property

Instead of splitting a PDF job into several jobs using job size as the criterion, you might want to use the value of a document property, such as country or sales region. In this scenario, you use a step based on the GroupDocuments step template instead of on the SplitDocuments step template. Each group of documents becomes a separate child job.

You can use a step based on the GroupDocuments step template to gather all the documents of one group into a single child job. You can use up to six grouping criteria to create child jobs. Each child job contains only the members of a group, such as all statements for each of five cities in each of 10 countries. For the parent workflow, you can copy the SortSplitPDF workflow that is installed by PDF Document Support. Remember to delete any steps you are not using, for example the SplitDocuments step. For the child workflow, make a copy of the AssemblePDF workflow.

This table summarizes the recommended workflow configuration using a step based on the CreateJobsFromDocuments step template.

    Note:
  • If you have customized phase names in your system, the phase names in the table might not match the names in your system.

Splitting PDF jobs by document property using CreateJobsFromDocuments
Parent/child Phase Step
Parent Receive SetJobPropsFromTextFile

In the Input data stream field, select PDF.

Prepare CountPages
IdentifyPDFDocuments
Assemble GroupDocuments
CreateJobsFromDocuments
Complete WaitForRelatedJobs
RetainCompletedJobs
RemoveJobs
Child Receive SetJobPropsFromTextFile
DetectInputDataStream
Assemble BuildPDFFromDocuments
Print CountPages
CreatePageRanges
PrintJobs
Complete WaitForRelatedJobs
RetainCompletedJobs
RemoveJobs

1.2.4.32.8.7 Using steps that change the PDF data in a workflow

RICOH ProcessDirector offers Ultimate Impostrip® Connect and PitStop Connect features that can be used to change the contents of a PDF file during workflow processing.

If those or other programs that change the PDF data process your production PDF files, ensure that the steps calling those programs occur before the IdentifyPDFDocuments step.

If you get unexpected results when you process a PDF 2.0 file with a step based on the IdentifyPDFDocuments step, do one of these:

  • Use RICOH ProcessDirector Plug-in for Adobe Acrobat to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.
  • Place a step based on the OptimizePDF step template in the workflow before the IdentifyPDFDocuments step.

    Important:
  • Run a test of your RICOH ProcessDirector workflow using the sample PDF file that you marked up in RICOH ProcessDirector Plug-in for Adobe Acrobat. Operations that alter data in a PDF file could cause the control files built with the RICOH ProcessDirector Plug-in for Adobe Acrobat not to function as expected.

1.2.4.32.9 Setting a maximum for document search results

You can set a limit on how many documents are returned when searching in the Documents portlet. The limit applies to all users.
To set a document search results limit:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the Max documents to display field, type the maximum number of results you want to list in the Documents portlet when you do a search.
  4. Click SAVE.

1.2.4.33 Setting up to pull documents from a job

You can set up to pull documents from a job, or suppress documents from printing, by doing the configuration tasks described in this section.

Before you do these tasks, read the usage scenarios for pulling documents from a job.

1.2.4.33.1 Running the sample workflow for suppressing PDF documents

The PullPDFSample workflow for suppressing the printing of PDF documents in a job illustrates how to use a list to control print suppression. The PullPDFSample workflow creates two child jobs which process the printed and suppressed documents separately.

The sample objects and files used in this workflow include:

  • Workflow: PullPDFSample
  • Sample file: /aiw/aiw1/testfiles/Pull.pdf
  • Sample pull list file: /aiw/aiw1/testfiles/pull/pulllist.txt
  • Sample property conditions file: /aiw/aiw1/control_files/pull/pullsample.csv
  • Identify documents control file: /aiw/aiw1/testfiles/PullPDF.ctl

    Note:
  • The PullPDFSample sample workflow is installed with the PDF Document Support feature.

This sample workflow includes a Wait step and a SetDocPropsFromList step. The Wait step pauses the job for 60 seconds for demonstration purposes to show how the workflow can be paused until the pull list file has been placed in the correct location. In a production environment, the Wait step can be set to pause the job for a set period of time or until a specific time of day. The SetDocPropsFromList step uses the information from the sample pull list file to make sure the job is properly split to suppress the printing of the correct documents.

The GroupDocuments step identifies the group of documents to be pulled and the group to be printed based on the Pull document property. Based on that grouping, the CreateJobsFromDocuments step generates child jobs. The child jobs are resubmitted to the original workflow and follow the child job branch out of the SetJobPropsfromTextFile step. The child jobs move through their respective print and suppression branches until processing is finished and all of the jobs, the parent job and both child jobs, are completed.

To run the sample workflow:

  1. Click the Administration tab.
  2. Click Devices Input Devices.
  3. On the Input Devices page, right-click the HotFolderPDF hot folder input device and select Copy.
  4. On the General tab of the Copy Hot Folder Input Device page, fill in or edit the values for these properties as indicated:
    • Enter an Input device name.
    • Enter an Input device description. This is optional, but recommended.
    • In the Child workflow property, choose PullPDFSample.
    • In the Folder location property, enter /aiw/aiw1/System/hf/testPullPDF
    • In the Staging location property, enter /aiw/aiw1/System/hf/testPullPDF/Staged
  5. Click OK.
  6. Click the Main tab.
  7. In the Input Devices portlet, right-click the new hot folder you created and select Enable and Connect.
  8. In the Printers portlet, right-click the Sample printer and select Enable.
  9. Navigate to /aiw/aiw1/testfiles and copy Pull.pdf into /aiw/aiw1/System/hf/testPullPDF .
    The job shows up in the Jobs table.
  10. When the job reaches the Wait step, it pauses for 60 seconds. The job goes into the Waiting state, but you can choose the Go to next step action if you want to speed up processing. Choose the Go to next step action only while the job is in the Waiting state.
  11. The parent job waits in the WaitForRelatedJobs step until both child jobs are complete and then finishes. The child job in the Pull path has a ManualStepWithAutoStart step, which you must manually advance. Right-click the job in the Jobs table and select Go to Next Step. Processing then continues until the parent and child jobs are Complete.
    You can see the parent job and the two child jobs in the Jobs table. You can right-click the separate child jobs and select View to see the documents produced by each child job. If you right-click the parent job, you can select View and see all of the documents, both printed and suppressed.

1.2.4.33.2 Running the sample workflow for suppressing AFP documents

The PullAFPSample workflow for suppressing the printing of AFP documents in a job illustrates how to use a list to control print suppression. The PullAFPSample workflow creates two child jobs which process the printed and suppressed documents separately.

The sample objects and files used in this workflow include:

  • Workflow: PullAFPSample
  • Sample file: /aiw/aiw1/testfiles/Pull.afp
  • Sample pull list file: /aiw/aiw1/testfiles/pull/pulllist.txt
  • Sample property conditions file: /aiw/aiw1/control_files/pull/pullsample.csv
  • Visual workbench control file: /aiw/aiw1/testfiles/PullAFP.ctl
    Note:
  • The PullAFPSample sample workflow is provided if you have installed the AFP Support feature.

This sample workflow includes a Wait step and a SetDocPropsFromList step. The Wait step pauses the job for 60 seconds for demonstration purposes to show how the workflow can be paused until the pull list file has been placed in the correct location. In a production environment, the Wait step can be set to pause the job for a set period of time or until a specific time of day. The SetDocPropsFromList step uses the information from the sample pull list file to make sure the job is properly split to suppress the printing of the correct documents.

The GroupDocuments step identifies the group of documents to be pulled and the group to be printed based on the Pull document property. Based on that grouping, the CreateJobsFromDocuments step generates child jobs. The child jobs are resubmitted to the original workflow and follow the child job branch out of the SetJobPropsfromTextFile step. The child jobs move through their respective print and suppression branches until processing is finished and all of the jobs, the parent job and both child jobs, are completed.

To run the sample workflow:

  1. Click the Administration tab.
  2. Click Devices Input Devices.
  3. On the Input Devices page, right-click the HotFolderAFP hot folder input device and select Copy.
  4. On the General tab of the Copy Hot Folder Input Device page, fill in or edit the values for these properties as indicated:
    • Enter an Input device name.
    • Enter an Input device description. This is optional, but recommended.
    • In the Child workflow property, choose PullAFPSample.
    • In the Folder location property, enter /aiw/aiw1/System/hf/testPullAFP
    • In the Staging location property, enter /aiw/aiw1/System/hf/testPullAFP/Staged
  5. Click OK.
  6. Click the Main tab.
  7. In the Input Devices portlet, right-click the new hot folder you created and select Enable and Connect.
  8. In the Printers portlet, right-click the Sample printer and select Enable.
  9. Navigate to /aiw/aiw1/testfiles and copy Pull.afp into /aiw/aiw1/System/hf/testPullAFP .
    The job shows up in the Jobs table.
  10. When the job reaches the Wait step it pauses for 60 seconds. The job goes into the Waiting state, but you can choose the Go to next step action if you want to speed up processing. Choose the Go to next step action only while the job is in the Waiting state.
  11. The parent job waits in the WaitForRelatedJobs step until both child jobs are complete and then finishes. The child job in the Pull path has a ManualStepWithAutoStart step, which you must manually advance. Right-click the job in the Jobs table and select Go to Next Step. Processing then continues until the parent and child jobs are Complete.
    You can see the parent job and the two child jobs in the Jobs table. You can right-click the separate child jobs and select View to see the documents produced by each child job. If you right-click the parent job, you can select View and see all of the documents, both printed and suppressed.

1.2.4.33.3 Setting up a workflow that processes a pull list

To extract documents from a job using a pull list, you set up a workflow that includes a step based on the SetDocPropsFromList step template. Additional steps and conditional processing (or additional workflows) are required to process both the documents extracted from the job and the documents remaining in the job.
The PullPDFSample supplied workflow resembles the PDF workflow that we are going to set up in this procedure. Before you set up your own workflow, open the PullPDFSample workflow. Examine the steps and conditional processing in the workflow as you read this procedure.
    Note:
  • If you have the AFP Support feature installed, the PullAFPSample supplied workflow shows how to extract documents from a workflow that processes AFP files.
To set up a workflow that processes a pull list:
  1. Identify data that determines whether a document is pulled.

    Examples:

    • You want to pull documents based on a list of account numbers. The account number determines whether a document is pulled.
    • You want to pull documents based on a list of postal codes. The postal code determines whether a document is pulled.
    • You want to pull documents based on a list of policy types and states. The policy type and state determine whether a document is pulled.

  2. Decide which document properties you are going to use to specify the data that the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files) extracts from each document in the print file.
    You can use existing RICOH ProcessDirector document properties, or you can define your own custom document properties.
    Examples:
    • You can use the Doc.PullProp document property, which is supplied with all document processing features.
    • You can use one or more custom document properties, such as Doc.Custom.AccountNumber, Doc.Custom.PostalCode, Doc.Custom.PolicyType, and Doc.Custom.State.

      If the custom document properties do not already exist, you must define them.

      Note:
    • To define document properties:
      • Edit the document properties configuration file.
      • Run the docCustom utility.

        The first time that you run the utility, it creates the Custom Document Properties feature.

      • Use Feature Manager to install or update the Custom Document Properties feature.
      • If you are working with PDF files, load the updated RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
  3. Specify the data that the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files) extracts from each document in the job:
    • If you are working with PDF files, use the Define Document Property function in RICOH ProcessDirector Plug-in for Adobe Acrobat.
    • If you are working with AFP files, use the Document Property Designer (DPD) mode of RICOH Visual Workbench.
        Note:
      • If the AFP files do not have index tags defined for the document data that you want to extract, use AFP Indexer to add the tags. AFP Indexer is installed with the AFP Support feature.
  4. Save your document property definitions in a control file for use with the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files):
    • If you are working with PDF files, use the Save control file function in RICOH ProcessDirector Plug-in for Adobe Acrobat.
    • If you are working with AFP files, use the Save control file function in RICOH Visual Workbench.
  5. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
  6. Log in to RICOH ProcessDirector.
  7. Click the Workflow tab.
  8. Make a copy of the workflow that you want to modify, or create a new workflow.

    In this procedure, we modify a simple workflow that processes PDF files. The workflow has these steps:

    • SetJobPropsFromTextFile
    • CountPages
    • IdentifyPDFDocuments
    • WriteDocumentsToDatabase
    • BuildPDFFromDocuments
    • UpdateDocumentsInDatabase
    • CreatePageRanges
    • PrintJobs
    • RetainCompletedJobs
    • RemoveJobs
      Note:
    • If you have the AFP Support feature installed, a simple workflow that modifies AFP files might have UseInlineFormDefinition and EnableRepositioning steps in place of the CountPages step, an IdentifyDocuments step in place of the IdentifyPDFDocuments step, and a BuildAFPFromDocuments step in place of the BuildPDFFromDocuments step.

  9. Add a step based on the SetDocPropsFromList step template to the workflow after the WriteDocumentsToDatabase step.
  10. Set values for the properties of the SetDocPropsFromList step:
    1. For the List file directory property, specify the location of the directory that contains the pull lists.
      For example: /aiw/aiw1/clientfiles/pull.
    2. For the Delimiter property, specify the delimiter used to separate values in the pull list.
      If the pull list only uses one property, you must put each value on a separate line and specify New Line as the delimiter.

      If the pull list uses two or more properties, you must put each set of values on a separate line. Specify the delimiter that you use to separate the values on each line: Tab, Semicolon, Comma, Space, or Tilde.

      Examples:
      • The pull list contains account numbers:
        4377852A
        4372341A
        4400076A
        4401132H
        Set the value of the Delimiter property to New Line.
      • The pull list contains policy types and states separated with commas:
        Home,AZ
        Home,CO
        Auto,CO
        Set the value of the Delimiter property to Comma.
    3. For the Columns in list file property, select all the document properties that you are using to specify the data that determines whether a document is pulled.
      Examples:
      • Doc.PullProp
      • Doc.Custom.AccountNumber
      • Doc.Custom.PostalCode
      • Doc.Custom.PolicyType and Doc.Custom.State
    4. If the you are using two or more document properties to specify the data, order the document properties (from top to bottom) to match the order of the data columns in the pull list (from left to right).
      To rearrange the properties, click Image of a gray pencil on a white background., the pencil icon. In the dialog that opens, right-click each selected property and choose Move to top. After all of the selected properties are at the top of the list, click and drag them into the correct order. After rearranging the properties, click outside of the dialog to close it.
    5. For the Stop for excess columns property:
      • Select YES if you want the step to move into an error state if the pull list has more columns of data than the number of document properties specified by the Columns in list file property.

        For example, select YES if the pull list has two columns of data and the Columns in list file property specifies two document properties. You want the step to go into error if a pull list with four columns of data is placed in the list file directory.

      • Select NO if you do not want the step to move to an error state if the pull list has more columns of data than the number of document properties specified by the Columns in list file property.

        For example, select NO if the pull list has four columns of data but you are using only the first column. The Columns in list file property specifies one document property.

          Note:
        • If the pull list has excess columns, they must all be to the right of columns you are using.

      The step always moves into an error state if the pull list has fewer columns of data than the number of properties specified by the Columns in list file property.

    6. For the Document property to set property, select the document property that you want to use to specify whether a document is pulled.
      The Doc.Pull property is supplied with all document processing features. It is a convenient choice for the value of the Document property to set property. As an alternative, you can create a custom document property or use an existing document property as the value of Document property to set.
        Important:
      • If you use a document property that already contains a value for the documents in the job, RICOH ProcessDirector overwrites the original value with the new value for matching documents or the new value for other documents. Because the new value replaces the original value, make sure that you no longer need the original value.
    7. Specify values for the Value for matching documents and Value for other documents properties.
      If the document property that you specify as the value of the Document property to set property does not exist in the document properties file for the job, RICOH ProcessDirector creates a column for the document property in the file and populates the column with values specified for the Value for matching documents and Value for other documents properties.

      If the document property does exist in the document properties file, RICOH ProcessDirector changes the values for the property based on the values of the Value for matching documents and Value for other documents properties.

      Example:
      • A document properties file contains three document properties:
        Doc.Custom.AccountNumber  Doc.Custom.PolicyType  Doc.Custom.State
        144372                    Home                   CO
        144372                    Auto                   CO
        144372                    Business               CO
        187456                    Home                   AZ
        187456                    Auto                   AZ
        187456                    Business               AZ
        223114                    Home                   NY
        223114                    Auto                   NY
        223114                    Business               NY
      • A pull list contains values for the Doc.Custom.PolicyType and Doc.Custom.State document properties:
        Home,AZ
        Home,CO
        Auto,CO
      • The value of the Document property to set property is Doc.Pull. The document properties file for the job does not have a column for the Doc.Pull document property.
      • The value of the Value for matching documents property is YES.
      • The value of the Value for other documents property is NO.
      • When a job enters the SetDocPropsFromList step, RICOH ProcessDirector:
        • Creates a column for Doc.Pull in the document properties file for the job.
        • Sets the value of the Doc.Pull document property to YES if the values of the document properties for a document match all the values of the document properties on the pull list.

          The value of the Doc.Pull document property is set to YES for documents containing Home policies in Arizona (AZ) and documents containing Home or Auto policies in Colorado (CO).

        • Sets the value to NO if the value of any document property for a document does not match the value of a document property on the pull list.

          The value of the Doc.Pull document property is set to NO for documents containing Auto policies in Arizona, documents containing any policy other than Home or Auto, and documents containing policies in any state except Arizona or Colorado.

        • The updated document properties file has four document properties:
          Doc.Custom.AccountNumber  Doc.Custom.PolicyType  Doc.Custom.State  Doc.Pull
          144372                    Home                   CO                YES
          144372                    Auto                   CO                YES
          144372                    Business               CO                NO
          187456                    Home                   AZ                YES
          187456                    Auto                   AZ                NO
          187456                    Business               AZ                NO
          223114                    Home                   NY                NO
          223114                    Auto                   NY                NO
          223114                    Business               NY                NO
    8. Edit the other step properties as needed.
  11. Optional: If you want jobs to wait until you receive a pull list, add a Wait step to the workflow before the SetDocPropsFromList step. Specify values for the step properties.

    Examples:

    • To wait until 6 PM, set the Wait until property to 6:00 PM. Do not specify values for the Wait for and Complete step after properties.
    • To wait four hours, set the Wait for property to 4 hours. Do not specify values for the Wait until and Complete step after properties.
    • To wait six hours or until 5 PM, whichever occurs first, set the Wait until property to 5:00 PM, the Wait for property to 6 hours, and the Complete step after property to First occurs.
    • To wait at least three hours and at least until 4 PM, whichever occurs last, set the Wait until property to 4:00 PM, the Wait for property to 3 hours, and Complete step after property to Last occurs.

  12. Add steps that process the documents after the SetDocPropsFromList step.

    For example:

    • You can add a GroupDocuments step and set the value of the Group first property to Pull document.
    • Then you can add a CreateJobsFromDocuments step and set the value of the Child workflow property to the name of the current workflow.
        Note:
      • This example uses the conditional processing in the PullPDFSample supplied workflow. As an alternative, you can set the Child workflow property to the name of another workflow and use that workflow to process the child jobs.
    • The CreateJobsFromDocuments step creates two child jobs: one for the group of documents with Pull document set to YES and another for the group of documents with Pull document set to NO.

  13. Add conditional processing for documents that are pulled and documents that remain in the job.
    For example:
    • Add conditional processing for parent and child jobs near the start of the workflow, after the SetJobPropsFromTextFile step.
      • Define a rule for the branch that receives the parent jobs:

        Job number Unlike *.*

        In our example, this branch is connected to the existing DetectInputDataStream step.

      • Add a step based on the SetDocPropsFromConditions step template.
      • Create a new branch for the child jobs, which have a decimal point in their job number, and connect the branch to the SetDocPropsFromConditions step.

        In our example, connect the SetDocPropsFromConditions step to the BuildPDFFromDocuments step, which connects to the UpdateDocumentsInDatabase step.

    • Set the properties for the SetDocPropsFromConditions step.

      In our example, the step assigns a value to a job property based on the value of the Pull document document property. The property conditions file sets the value of the Custom 1 job property (database property name Job.Info.Attr1) to Pull or Print. This example shows the contents of the property conditions file:

      "Doc.Pull","Job.Info.Attr1"
      "=YES","Pull"
      "=NO","Print"

  14. Add steps that process the pulled documents.
    For example, if you are processing PDF jobs, you might add an EmailDocuments step that emails the pulled documents to someone for verification that the documents were pulled.
  15. Add steps that process the documents to be printed.

    For example, if you are processing PDF jobs, you might add CreatePageRanges and PrintJobs steps.

  16. Add conditional processing to send the child jobs to separate pull and print branches of the workflow.
    • In our example, add a connector between the UpdateDocumentsInDatabase step and the new EmailDocuments step. Add this rule to the connector: Custom 1 = Pull
    • In our example, add a connector between the UpdateDocumentsInDatabase step and the CreatePageRanges step. Add this rule to the connector: Custom 1 = Print
    When jobs are sent through the workflow and the child jobs reach the SetDocPropsFromConditions step, RICOH ProcessDirector sets the value of the Custom 1 job property:
    • For a child job with the Doc.Pull property set to Yes, the Custom 1 job property is set to Pull. The child job goes through the connector with the rule Custom 1 = Pull.
    • For a child job with the Doc.Pull property set to No, the Custom 1 job property is set to Print. The child job goes through the connector with the rule Custom 1 = Print.
  17. If you created conditional processing for parent and child jobs, send the parent and child jobs together to the RetainCompletedJobs step:
    1. Add a step based on the WaitForRelatedJobs step template to the workflow before the RetainCompletedJobs step.
    2. Connect the branch for parent jobs and the two branches for child jobs to the WaitForRelatedJobs step.
      In our example, connect these steps to the WaitForRelatedJobs step:
      • CreateJobsFromDocuments in the branch for parent jobs.
      • EmailDocuments in the branch for child jobs with documents that have been pulled.
      • PrintJobs in the branch for child jobs with documents to be printed.
    The workflow now resembles the PullPDFSample workflow with these differences:
    • PullPDFSample has DetectInputDataStream, FailWithMessage, SetDocPropsFromOriginal, CountPagesChild, AssignJobValuesPull, and AssignJobValuesPrint steps.
    • This workflow has an EmailDocuments step in place of the AssignJobValuesPull and ManualStepWithAutoRestart steps in the PullPDFSample workflow.
  18. Save the workflow.
  19. Test the workflow:
    1. Create one or more input devices to point to the workflow.
    2. Enable the workflow.
    3. Enable the input devices.
    4. Place a sample pull list in the list file directory.
    5. Submit your job to the input device.

1.2.4.34 Setting up to reconcile jobs manually

You can reconcile the documents in a job manually, accounting for all documents that processed successfully and reprinting all damaged documents. You also can account for all documents that are pulled from the job.
    Note:
  • The Automated Verification and Inserter features support equipment that can scan barcodes to track documents through mechanical steps, such as insertion or sealing. Those features support both automatic and manual reconciliation. If you have Automated Verification, follow the instructions in the help system for setting up to verify documents in jobs automatically. If you have Inserter, follow the instructions in the help system for configuring the system to use inserters.

To find the documents that you want to reconcile, you can use any of these three methods:

  • You can enter the values of one or more document properties that identify each document in a job. The document properties can be supplied by RICOH ProcessDirector (for example, Document number, Original sequence, or Insert sequence) or defined as custom document properties (for example, Customer account number).

    The document properties that you use must be database properties, not limited properties.

  • You can enter a range of values for the Insert sequence document property.
  • You can scan a barcode on a document with a hand-held scanner attached to your computer. To use this method, you must define a barcode format that includes the document property that identifies each document in a job.

Before you can use the values of document properties or barcodes to reconcile documents, you must set up to use documents in jobs. For more information, see the help system.

To set up to reconcile jobs manually:
  1. Optional: If you want to use barcodes to reconcile documents, create a barcode format.

    The barcode format identifies the values of job and document properties in the barcode. For more information, see the related task for creating barcode formats.

  2. Click the Workflow tab.
  3. Click the name of the workflow you want to modify.
    If you modify the sample EnhancePDFDocuments workflow, the workflow at the end of this procedure shows the results.
  4. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  5. Add a step based on the CreateReprints step template after the Reconcile step. For the Reprint workflow property:
    • Select Not set if you want the child job created for reprints to start over in the same workflow.
    • Select the name of a different workflow if you want the child job created for reprints to move to the first step in that workflow.
  6. To make sure that the original job stays in the system until all the reprint jobs have completed, add a step based on the WaitForRelatedJobs step template. Place the step before the RetainCompletedJobs step.
    The retention period does not start for any of the jobs until all documents from the original job have been accounted for in the reconciliation process.
  7. If the workflow does not have a step based on the WriteDocumentsToDatabase step template:
    • In a workflow that processes PDF files, add that step after the IdentifyPDFDocuments step and before the BuildPDFFromDocuments step.
    • In a workflow that processes AFP files, add that step after the IdentifyDocuments step and before the BuildAFPFromDocuments step.
  8. Add a step based on the SetPropertiesForReconcile step template after the WriteDocumentsToDatabase step and after any step that changes the position of the documents in the job. Add the step before the BuildPDFFromDocuments or BuildAFPFromDocuments step.

    The SetPropertiesForReconcile step sets the Insert sequence property for each document in a job. After the value is set, the operator can use it on the Reconcile Job dialog to find documents to reconcile when the job reaches the Reconcile step.

    For example, the operator can select By range on the Reconcile Job dialog and specify a range of Insert sequence values. The operator also can select By properties and specify an Insert sequence value.

  9. Optional: Add a step based on the SetDocPropsFromConditions step template before the WriteDocumentsToDatabase and Reconcile steps.

    Set the Property conditions file property to the directory path and name of a comma-separated values (CSV) file that you create with a text editor. For example, set the value of the property to /aiw/aiw1/testfiles/ReconcileProperties.csv on Linux or to C:\aiw\aiw1\testfiles\ReconcileProperties.csv on Windows.

    By default, the Action value for every document in a job is Not set. The operator must assign each document a Requested action value ( OK, Reprint, or Pull) to complete the manual reconciliation process. For a job with thousands of documents, the operator must set the Requested action for each document that printed successfully to OK. The fastest way for an operator to reconcile the job is to set the Requested action for all documents to OK. The operator then resets the Requested action for specific documents to Reprint or Pull. To save the operator the time required to set the Requested action for all documents to OK manually, you can use a SetDocPropsFromConditions step to set the Action value to OK automatically. Then the operator can immediately set the Requested action for specific documents to Reprint or Pull.

    This example shows the contents of a property conditions file that sets the value of the Action property for all the documents in the job to OK:

    • Doc.OriginalSequence,Doc.Insert.Disposition>=1,OK

  10. Optional: If you want to send the child jobs for reprints to a print-only workflow, specify that workflow as the Reprint workflow on the CreateReprints step.
    If you want to process the child jobs for reprints in this workflow, add a branch:
    1. Start the new branch with a step based on the BuildPDFFromDocuments or BuildAFPFromDocuments step template.
    2. Add a connector from the SetDocPropsFromTextFile step to the new BuildPDFFromDocuments or BuildAFPFromDocuments step.
    3. Define this rule on the connector:

      • Rule name: Reprint
      • Order of execution: 1
      • Apply any or all of the following conditions: AND
      • Condition 1: Document count >0
      • Condition 2: Created Document Count <1
      • Summary: Job.Doc.DocumentCount > ‘0’ AND Job.Doc.CreatedDocumentCount < ‘1’

    4. Add a step based on the SetDocPropsFromConditions step template after the BuildPDFFromDocuments or BuildAFPFromDocuments step.
    5. Add a step based on the UpdateDocumentsInDatabase step template after the SetDocPropsFromConditions step.
    6. Add a step based on the SetPropertiesForReconcile step template after the UpdateDocumentsInDatabase step.
    7. Connect the SetPropertiesForReconcile step to the step after the BuildPDFFromDocuments or BuildAFPFromDocuments step in the original branch.

      For example, connect the SetPropertiesForReconcile step to the CountPages step.

  11. Save the workflow and enable it.
  12. Test the workflow.

When a job enters the workflow, the job is processed normally until it reaches the Reconcile step, where it goes into the Waiting to reconcile state. The operator then right-clicks the job in the jobs table and selects Reconcile. The Action value of all the documents in the job is not set unless a SetDocPropsFromConditions step sets the Action to another value, such as OK.

The operator finds all the documents to be reprinted and sets their Requested action value to Reprint. When all the documents have a Requested action value, the operator clicks OK.

The job moves to the CreateReprints step. That step creates a child job containing all the documents to be reprinted and sends the job to the workflow specified for reprinting.

The illustrations below show the sample workflow as a series of phases.

Illustration of first part of workflow for reconciling jobs manually

Illustration of second part of workflow for reconciling jobs manually

1.2.4.35 Setting up to exchange data with web services

You can set up to exchange data with web services by running the sample workflow. After you examine how the sample workflow is set up, see the related topics that explain how to set up web service input devices and notifications. You can also examine the related topics on step templates.

1.2.4.35.1 Running the sample workflow for processing orders retrieved from REST web services

The RestfulWebServiceWF workflow shows how to process orders retrieved from REST web services that simulate a web site for ordering books. A REST web service input device, a CallRESTService step, and a REST web service notification exchange data using the web services. The workflow also gives examples of these steps: ConvertJSONToXML, ApplyXSLTransform, CreateJobsFromXML, and DownloadFile.

This workflow uses these sample objects and files:

  • Workflow: RestfulWebServiceWF
  • Input device: RestfulWebServiceSample

    The input device makes a GET call to retrieve JSON orders from a sample REST web service at http://localhost:15080/restapi/1.0/sample/order

  • Notification: RestfulWebServiceSampleNotify

    The notification makes a POST call to a sample web service at http://localhost:15080/restapi/1.0/sample/completeJobTicket

  • JSON orders

    One order is retrieved every 30 seconds from the sample web service.

    Contents of sample order:

    {"Order": {"orderId": "ORDnumber", "customername": "Ricoh"}}

    Each order contains a randomly generated number, for example: 1238875463.

  • Print files: Brochure.pdf and Cover.pdf

    These files are downloaded locally from http://localhost:15080/restapi/

  • XSLT style sheet files:

    • orderToOverrides.xslt

    • jobticketToOverrides.xslt

    The files are in the /aiw/aiw1/testfiles/restsample directory:

  • Notification PDF files

    A notification PDF file is generated for each completed order. Each file is named ORDER-ORDnumber, for example: ORDER-ORD1238875463.

  • TheCallRESTService step makes a GET call to retrieve JSON job tickets from a sample REST web service at http://localhost:15080/restapi/1.0/sample/jobTicket

    Note:
  • The sample web services are available locally. They return sample data in response to specific requests made by the sample input device, notification, and CallRESTService step. The web services do not support other requests.

  • The sample objects and files, including the RestfulWebServiceWF workflow, are installed with the Web Services Enablement feature.

To run the sample workflow:

  1. Click the Main tab.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. In the Input Devices portlet, right-click the RestfulWebServiceSample REST web service input device and select Enable and Connect.

    A job appears in the jobs table.

  4. Right-click the RestfulWebServiceSample input device and select Disable.
  5. Right-click the input device again and select Disconnect.

    Note: The sample input device polls for orders every 30 seconds and retrieves a JSON job. If you do not disable and disconnect the input device, a new job appears in the jobs table every 30 seconds.

    Each time the RestfulWebServiceSample input device retrieves a JSON job:

    • The job is sent through the Parent branch of the workflow.

    • The SetJobPropsFromTextFile step sets the Customer name property to RicohSample and the Custom 1 property to RicohCustom.

    • The ConvertJSONToXML step converts the job into XML.

    • The ApplyXSLTransform step uses the orderToOverrides.xslt XSLT style sheet to convert 2 XML elements into 2 RICOH ProcessDirector job properties in an overrides file:

      XML element Job property
      orderId Job.Info.Attr3
      customername Job.CustomerName

      Contents of sample overrides file:

      Job.Info.Attr3=ORD1238875463Job.CustomerName=Ricoh

      The step puts the overrides file in the spool directory for the job. RICOH ProcessDirector uses the values in the overrides file to set the values of the properties for the job.

    • The AssignJobValues step sets the value of the Job name property to ORDER-${Job.Info.Attr3}, for example: ORDER-ORD1238875463.

    • The CallRESTService step makes a GET call to one of the sample web services that simulate the web site for ordering books. The step specifies order ID as the value of the Request parameters property: orderId:${Job.Info.Attr3}.

      The web service returns JSON job ticket information for the order to RICOH ProcessDirector.

      Contents of sample job ticket information:

      {"JobTicket": [{ "itemnumber": "1182563839", "copies":"4","media" : "Letter Plain","file" : "http://localhost:15080/restapi/Brochure.pdf","type" : "Brochure","title" : "RPDBestSeller"}, { "itemnumber": "1934194376", "copies":"4","media" : "Letter Preprinted","file" : "http://localhost:15080/restapi/Cover.pdf","type" : "Cover" ,"title" : "RPDBestSeller" }]}

    • The ConvertJSONToXML step converts the JSON job ticket information into XML.

    • The CreateJobsFromXML step uses the //JobTicket XPath expression to parse the XML job ticket information. The step finds 2 job tickets and creates 2 child jobs.

      Contents of sample child jobs:

      <?xml version="1.0" encoding="UTF-8"?><JobTicket><copies>4</copies><file>http://localhost:15080/restapi/Brochure.pdf</file><itemnumber>2112076335</itemnumber><media>Letter Plain</media><type>Brochure</type><title>RPDBestSeller</title></JobTicket><?xml version="1.0" encoding="UTF-8"?><JobTicket><copies>4</copies><file>http://localhost:15080/restapi/Cover.pdf</file><itemnumber>1418780325</itemnumber><media>Letter Preprinted</media><type>Cover</type><title>RPDBestSeller</title></JobTicket>

      The step submits the 2 child jobs to the RestfulWebServiceWF workflow.

      The rule on the [2] Child connector determines whether the jobs are child jobs by checking for a decimal point in the job number. The connector sends child jobs through the Child branch of the workflow.

      The original JSON job continues through the Parent branch to the RunHotFolderApplication step. That step puts the JSON job in a hot folder: /aiw/aiw1/testfiles/restsample/sending

      One of the sample web services that simulate the web site for ordering books polls the hot folder for jobs. The web service processes each JSON job when it receives a request from the RestfulWebServiceSampleNotify notification. For more information, see the list item for the RetainCompletedJobs step.

    • The ApplyXSLTransform2 step uses the jobticketToOverrides.xslt XSLT style sheet to convert 6 XML elements for each child job into RICOH ProcessDirector job properties in an overrides file:

      XML element Job property
      file Job.Info.Attr2
      itemnumber Job.Info.Attr1
      type Job.Info.Attr4
      title Job.Info.Attr5
      copies Job.Copies
      media Job.Media

      Contents of sample overrides file:

      Job.Info.Attr2=http://localhost:15080/restapi/Brochure.pdfJob.Info.Attr1=1182563839Job.Info.Attr4=BrochureJob.Info.Attr5=RPDBestSellerJob.Copies=4Job.Media=Letter Preprinted

    • The DownloadFile step downloads the Cover.pdf and Brochure.pdf files from http://localhost:15080/restapi/ by setting the value of the URL for download file property to ${Job.Info.Attr2}.

    • The AssignJobValues2 step sets the values of 3 job properties:

      • Requested printer: Sample

      • Input data stream: PDF

      • Job name: ${Job.Info.Attr5}-${Job.Info.Attr4}

      The names of the child jobs for the Brochure.pdf and Cover.pdf files are now RPDBestSeller-Brochure and RPDBestSeller-Cover.

    • The OptimizePDF, CountPages, CreatePageRanges, and PrintJobs steps process and print the RPDBestSeller-Brochure and RPDBestSeller-Cover child jobs on the Sample printer.

    • When each child job arrives at the RetainCompletedJobs step, the RestfulWebServiceSampleNotify web service notification makes a POST call to one of the sample web services at http://localhost:15080/restapi/1.0/sample/completeJobTicket. The value of the Request parameters property is:

      jobTicket:${Job.Info.Attr1}jobId:${Job.ID}

      The web service waits until all the child jobs for the original JSON job are in the Retained job state. The web service then creates a PDF file containing the job number and item number of each job ticket in the order. For example:

      10000001.2 with item number 278955095 has been processed10000001.1 with item number 913895452 has been processed

      The web service puts the PDF file in the retrieval hot folder for the RunHotFolderApplication step: /aiw/aiw1/testfiles/restsample/retrieval

      The RunHotFolderApplication step polls the hot folder, finds the PDF job, and sends the job to the next step.

    • The AssignJobValues step sets the value of the Input data stream property to PDF and sends the PDF job to the RetainCompletedJobs step.

  6. In the jobs table, right-click an ORDER-ORDnumber job and select View.

    The viewer displays the PDF file. The information in the PDF file confirms that the 2 child jobs have been processed.

1.2.4.36 Setting up to process orders from MarcomCentral

After you read the MarcomCentral Connect overview topic, run the sample workflows for processing orders retrieved from MarcomCentral. After you understand how the sample SOAP web service input device, sample workflows, and sample SOAP web service notification work, you can do the configuration tasks.

After the initial configuration is complete, test your MarcomCentral workflows to make sure that they work as you expect them to.

1.2.4.36.1 Running the sample workflows for processing orders retrieved from MarcomCentral

The MarcomProcessOrders and MarcomProcessJobTicket workflows show how to process orders retrieved from a sample store at the MarcomCentral web site. The sample store serves as a test environment for the RICOH ProcessDirector web services interface to MarcomCentral. A SOAP web service input device, 2 CallSOAPService steps, and a SOAP web service notification communicate with the MarcomCentral web site. The workflows also give examples of these steps: ApplyXSLTransform, CreateJobsFromXML, and DownloadFile.

The sample input device, CallSOAPService steps, and notification run a simulation. They do not call the specified MarcomCentral web services. The simulation lets you run the samples without getting your own MarcomCentral credentials and setting up a sample MarcomCentral store that resembles the sample store. The samples use SOAP 1.1 request payloads to retrieve a simulated MarcomCentral order and 2 job tickets. The value in the static credential and password fields tells RICOH ProcessDirector to run the simulation.

After you run the samples, you can copy them. Then you can adjust the values in the copies to exchange data with your own store at the MarcomCentral web site.

    Note:
  • The sample objects and files are installed with the MarcomCentral Connect feature.

The simulation includes Web Services Description Language (WSDL) SOAP request objects imported from MarcomCentral. The sample input device, CallSOAPService steps, and notification each specify a SOAP request.

This simulation uses these objects and files:

  • Workflows:
    • MarcomProcessOrders
    • MarcomProcessJobTicket
  • Input device: MarcomReceiveOrders

    The input device retrieves XML orders from the MarcomCentral web site by simulating a call to a web service at https://services.printable.com/Trans/1.0/Order.asmx

    The SOAP request is Marcom-GetOrdersByDate.

  • Notification: MarcomCloseoutOrder

    The notification sends order completion information to the MarcomCentral web site by simulating a call to a web service at https://services.printable.com/Trans/1.0/Closeout.asmx

    The SOAP request is MarcomSample-CloseoutByOrder.

  • XML orders

    In the simulation, one order is retrieved every 30 seconds from the web service.

    After you run the sample workflows, you can see the contents of a sample order. Go to: /aiw/aiw1/spool/default/job_number

    Replace job_number with the number of the job, for example, 10000001.

    Display the contents of the job_number.print.xml file, for example, 10000001.print.xml.

  • XML job tickets

    In the simulation, 2 job tickets are retrieved for every order.

    After you run the sample workflows, you can see the contents of the 2 sample job tickets. Go to: /aiw/aiw1/spool/default/child_job_number

    Replace child_job_number with the number of the child job, for example, 10000001.1 or 10000001.2.

    Display the contents of the child_job_number.print.xml file, for example, 10000001.1.print.xml or 10000001.2.print.xml.

  • Print file: Savings.pdf

    This file is downloaded locally from http://localhost:15080/restapi/

  • XSLT style sheet files:
    • orderToOverrides.xslt
    • jobticketsReceived.xslt
    • jobticketToOverrides.xslt
    • skuToOverrides.xslt
    • downloadOverrides.xslt

    The files are in the Marcom directory: /aiw/aiw1/testfiles/Marcom

  • Stock-keeping unit (SKU) files:
    • SKU13933967.xml
    • SKU15302443.xml

    The files are in the Marcom directory: /aiw/aiw1/testfiles/Marcom

  • CallSOAPService steps:
    • The first CallSOAPService step retrieves XML job tickets from the MarcomCentral web site by simulating a call to a web service at https://services.printable.com/Trans/1.0/JobTicket.asmx

      The SOAP request is Marcom-GetJobTicketsByOrderNumber.

    • The second CallSOAPService step retrieves a job ticket from the MarcomCentral web site by simulating a call to a web service at https://services.printable.com/Trans/1.0/JobTicket.asmx

      The SOAP request is Marcom-GetJobTicketByLineItem.

  • The CheckTicketCount step, which is based on the CallRESTService step template, calls a web service at http://localhost:15080/restapi/1.0/util/compareProperties

To run the sample workflow:

  1. Click the Main tab.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. In the Input Devices portlet, right-click the MarcomReceiveOrders SOAP web service input device and select Enable and Connect.

    A job named Marcom Sample Order appears in the jobs table.

  4. Right-click the MarcomReceiveOrders input device and select Disable.
  5. Right-click the input device again and select Disconnect.
      Note:
    • The sample input device polls for orders every 30 seconds and retrieves an XML job. If you do not disable and disconnect the input device, a new job appears in the jobs table every 30 seconds.

    The request payload for the input device includes these RICOH ProcessDirector symbols:

    <PartnerCredentials> <Token>${WebService.StaticCredential}</Token></PartnerCredentials><DateRange> <Start>${WebService.LastSuccessRequestTime}</Start> <End>${WebService.CurrentRequestTime}</End></DateRange>

    The ${WebService.StaticCredential} symbol specifies the static credential. The ${WebService.LastSuccessRequestTime} symbol specifies the date and time when the input device last successfully requested a response from the web service. The ${WebService.CurrentRequestTime} symbol specifies the date and time of the current request.

    Each time the MarcomReceiveOrders input device retrieves an XML job, it sends the job to the MarcomProcessOrders workflow.

    The job goes through these and other steps in the MarcomProcessOrders workflow:

    • The SetJobPropsFromTextFile step sets the Job name property to Marcom Sample Order.
    • The ApplyXSLTransform step uses the orderToOverrides.xslt XSLT style sheet to convert 8 XML elements into 5 RICOH ProcessDirector job properties in an overrides file.

      The table lists the job properties in the order that they are specified in the XSLT style sheet and appear in the overrides file.

      XML element Database name of job property User interface name of job property
      OrderNumber Job.Marcom.OrderNumber MarcomCentral order number
      ID Job.Marcom.OrderId MarcomCentral order ID
      ShippingAddress/Address1ShippingAddress/CityShippingAddress/StateShippingAddress/Zip Job.Info.Attr1 Custom 1
      User/Email Job.CustomerName Customer name
      count(OrderDetails/OrderDetail) Job.Info.Attr2 Custom 2

      This example shows the contents of the sample overrides file:

      Job.Marcom.OrderNumber=WS113Job.Marcom.OrderId=8487184Job.Info.Attr1=400 Main Street Anywhere CO 11111Job.CustomerName=Myrna.Jensen@company.comJob.Info.Attr2=2

      The step puts the overrides file in the spool directory for the job. RICOH ProcessDirector uses the values in the overrides file to set the values of the properties for the job.

    • The CallSOAPService step calls the MarcomCentral web service that returns job tickets for a specified order. The step specifies 2 RICOH ProcessDirector symbols as part of the value in the Request payload property:

      <Token>${Job.WebService.Password}</Token><PONumber>${Job.Marcom.OrderId}</PONumber>

      The ${Job.WebService.Password} symbol specifies the static credential. The ${Job.Marcom.OrderId} symbol specifies the order ID.

    • The ApplyXSLTransform2 step uses the jobTicketsReceived.xslt XSLT style sheet to compute the value of the Job.Info.Attr3 property by counting the number of job tickets that have been retrieved.
      XML element Database name of job property User interface name of job property
      count(ns0:Envelope/ns0:Body/ns2:GetJobTicketsByOrderNumberResponse/ns1:GetJobTicketResponse/JobTicket) Job.Info.Attr3 Custom 3

      The step puts the value in an overrides file, and overwrites the overrides file in the spool directory for the job with the new overrides file.

      This example shows the contents of the overrides file after all job tickets have been retrieved:

      Job.Info.Attr3=2

    • The CheckTicketCount step makes a POST call to a RICOH ProcessDirector web service. The web service checks whether all the job tickets for an order have been retrieved. The step compares the values of Custom 2 (total job tickets) and Custom 3 (retrieved job tickets). If the values match, the step sets the value of Custom 4 (result of comparison) to EQUAL.

      The step puts the value in an overrides file, and overwrites the overrides file in the spool directory with the new overrides file.

      This example shows the contents of the overrides file after all job tickets have been retrieved:

      Job.Info.Attr4=EQUAL

    • The rule on the [1] All tickets found connector checks whether the value of the Custom 4 job property (result of comparison) is EQUAL.
      • If it is, the number of job tickets retrieved equals the total number of job tickets expected. The workflow sends the job directly to the CreateJobsFromXML step.
      • If it is not, the number of job tickets retrieved is less than the total number of job tickets expected. The rule on the [2] Check for tickets connector checks whether the value of the Custom count 1 job property is less than 10. The first time that the job arrives at the CheckTicketCount step, the value of the Custom count 1 property is 0.
        • If the value is 0 through 9, the workflow sends the job to the Wait step, which waits for 1 minute. The workflow then sends the job to the RunExternalProgram step.

          The RunExternalProgram step runs a Java utility that increments the value of the Custom count 1 property by 1. The workflow then sends the job back to the CallSOAPService step. The step repeats the call to the MarcomCentral web service that returns job tickets for the order. If the number of job tickets retrieved is less than expected, the workflow can send the job through the CallSOAPService step up to 9 times.

        • If the value is 10, the job has been sent to the CallSOAPService step 10 times. After 10 minutes, the number of job tickets retrieved does not equal the number expected. The job does not meet the rule on the [2] Check for tickets connector. The workflow sends the job through the [3] Timeout connector to the FailWithMesssage step and writes a failure message to the job log. The message states: Some job tickets were not found in the time allowed.

            Note:
          • Because the message is a job property, it appears on the Information tab of the job property notebook for all jobs that go through the workflow. The message appears in the job log only when the workflow sends the job through the [3] Timeout connector to the FailWithMesssage step.

    • The CreateJobsFromXML step uses the //JobTicket XPath expression to parse the XML job ticket information. The step finds 2 job tickets and creates 2 child jobs.

      Child jobs named Jensen Bank Baseball Cap and Brochure appear in the jobs table.

      The step submits the 2 child jobs to the MarcomProcessJobTicket workflow.

      The original order job is sent to the WaitForRelatedJobs step.

    The child jobs go through these and other steps in the MarcomProcessJobTicket workflow:

    • The ApplyXSLTransform step uses the jobticketToOverrides.xslt XSLT style sheet to convert 10 XML elements into 10 RICOH ProcessDirector job properties in an overrides file.

      The table lists the job properties in the order that they are specified in the XSLT style sheet and appear in the overrides file.

      XML element Database name of job property User interface name of job property
      OrderDetails/OrderDetail/OrderID Job.Marcom.OrderId MarcomCentral order ID
      OrderDetails/OrderDetail/SKUDescription Job.Info.Attr1 Custom 1
      OrderDetails/OrderDetail/SKU/ID Job.Info.Attr4 Custom 4
      OrderDetails/OrderDetail/ProductType Job.Marcom.ProductType MarcomCentral product type
      FinalOutputFileURL/URL Job.Info.Attr3 Custom 3
      floor(OrderDetails/OrderDetail/Quantity) Job.Copies Job copies requested
      floor($var2_current/OrderDetails/OrderDetail/ID) Job.Marcom.JobTicketId MarcomCentral job ticket ID
      OrderDetails/OrderDetail/ProductName Job.Name Job name
      OrderDetails/OrderDetail/ProductDescription Job.Description Job description
      OrderDetails/OrderDetail/Shipping/Method Job.Info.Attr2 Custom 2

      The step puts each overrides file in the spool directory for the corresponding job. Because these jobs are in a new workflow, the overrides files do not overwrite existing overrides files.

      This example shows the contents of the sample overrides file for the Jensen Bank Baseball Cap job:

      Job.Marcom.OrderId=8487184Job.Info.Attr1=RedJob.Info.Attr4=13933967Job.Marcom.ProductType=StaticJob.Info.Attr3=Job.Copies=20Job.Marcom.JobTicketId=22722188Job.Name=Jensen Bank Baseball CapJob.Description=Jensen Bank branded baseball cap features an embroidered patch logo on the front. This fitted cap is made of cotton. Fit may vary depending on the construction, materials and manufacturer.Job.Info.Attr2=Rush Shipping

      This example shows the contents of the sample overrides file for the Brochure job:

      Job.Marcom.OrderId=8487184Job.Info.Attr1=Brochure - Investing_Boulder_6300 Diagonal Highway_Boulder_CO_80301Job.Info.Attr4=15302443Job.Marcom.ProductType=VersionedJob.Info.Attr3=http://localhost:15080/restapi/Savings.pdfJob.Copies=250Job.Marcom.JobTicketId=22722189Job.Name=BrochureJob.Description=Job.Info.Attr2=Rush Shipping

    • The rule on the [1] No SKU Details connector checks whether the job has a stock-keeping unit (SKU).
        Note:
      • In this sample, an SKU supplies information for producing an item in an order. For example, SKU information for a printable item includes the media to use. SKU information for a non-print item includes the packing material to use. MarcomCentral items can have an SKU number that identifies information stored outside of MarcomCentral. This portion of the workflow accesses that information and converts it into RICOH ProcessDirector job properties.
      • If the value of the Custom 4 (SKU ID) property is not SKU13933967 or SKU15302443, the workflow sends the job directly to the ContinueToNextStep step.
          Note:
        • These 2 SKU IDs match the sample SKU files in the Marcom directory. When you set up RICOH ProcessDirector to communicate with MarcomCentral, you decide how you want to store information about the items in an order.
      • If the value is SKU13933967 or SKU15302443, the workflow sends the job to the ApplyXSLTransform2 step to process the SKU information.

        The ApplyXSLTransform2 step uses the skuToOverrides.xslt XSLT style sheet to convert 3 XML elements into 3 RICOH ProcessDirector job properties.

        The table lists the job properties in the order that they are specified in the XSLT style sheet and appear in the overrides file.

        XML element Database name of job property User interface name of job property
        Media Job.Media Media
        Duplex Job.Duplex Duplex
        Package Job.Info.Attr5 Custom 5

        The step puts the values in an overrides file, and overwrites the overrides file in the spool directory for the job with the new overrides file.

        This example shows the contents of the sample overrides file for the Jensen Bank Baseball Cap job:

        Job.Media=Job.Duplex=NoJob.Info.Attr5=Gift wrap

        This example shows the contents of the sample overrides file for the Brochure job:

        Job.Media=Letter PlainJob.Duplex=YesJob.Info.Attr5=

        The workflow sends the job to the ContinueToNextStep step.

    • When the job arrives at the ContinueToNextStep step, the rule on the [1] Warehouse connector checks the value of MarcomCentral product type property. Versioned, Variable, and JobDirect are product types for printable items.
      • If the item does not have a printable product type, the workflow sends the job through the Warehouse branch.
      • If the item has a printable product type, the workflow sends the job through the Print Shop branch.

    The printable child jobs go through these steps and connectors in the Print Shop branch of the workflow:

    • When the job arrives at the second ContinueToNextStep step, the rule on the [1] File ready connector checks whether the Custom 3 (URL of download file) property is set to a value.
      • If it is, the print file is ready to download. The workflow sends the job directly to the DownloadFile step.
      • If it is not, the rule on the [2] Check for file connector checks whether the value of the Custom count 1 job property is less than 10. The first time that the job arrives at the second ContinueToNextStep step, the value of the Custom count 1 property is 0.
        • If the value is 0 through 9, the workflow sends the job to the Wait step, which waits for 30 seconds. The workflow then sends the job to the CallSOAPService step.

          The CallSOAPService step calls the MarcomCentral web service that retrieves a job ticket for a printable item. The step specifies 2 RICOH ProcessDirector symbols as part of the value in the Web service payload property:

          <Token>${Job.WebService.Password}</Token><LineItemID type=”Printable”>${Job.Marcom.JobTicketId}</LineItemID>

          The ${Job.WebService.Password} symbol specifies the static credential. The ${Job.Marcom.JobTicketId} symbol specifies the job ticket ID.

          The ApplyXSLTransform2 step uses the downloadOverrides.xslt XSLT style sheet to convert an XML element into a RICOH ProcessDirector job property:

          XML element Database name of job property User interface name of job property
          JobTicket/FinalOutputFileURL/URL Job.Info.Attr3 Custom 3

          The step puts the value in an overrides file, and overwrites the overrides file in the spool directory for the job with the new overrides file.

          This example shows the contents of the sample overrides file:

          Job.Info.Attr3=http://localhost:15080/restapi/Savings.pdf

          The RunExternalProgram step runs a Java utility that increments the value of the Custom count 1 property by 1. The workflow then sends the job back to the second ContinueToNextStep step, which sends the job through the Wait step to the CallSOAPService step. The CallSOAPService step repeats the call to the MarcomCentral web service that retrieves a job ticket for a printable item. If the Custom 3 property still does not have a value for the URL, the workflow sends the job through the CallSOAPService step up to 9 times.

        • If the value is 10, the job has been sent to the CallSOAPService step 10 times. After 5 minutes, the Custom 3 property still does not have a value for the file to download. The job does not meet the rule on the [2] Check for file connector. The workflow sends the job through the [3] Timeout connector to the FailWithMesssage step and writes a failure message to the job log. The message states: File was not available to download in the time allowed.

            Note:
          • Because the message is a job property, it appears on the Information tab of the job property notebook for all jobs that go through the workflow. The message appears in the job log only when the workflow sends the job through the [3] Timeout connector to the FailWithMesssage step.

    • The DownloadFile step downloads the Savings.pdf print file from http://localhost:15080/restapi/ by setting the value of the URL for download file property to the ${Job.Info.Attr3} symbol.
    • The OptimizePDF, CountPages, CreatePageRanges, and PrintJobs steps process and print the job on the Sample printer.

    The non-printable child jobs go through this step in the Warehouse branch of the workflow:

    • The ManualStepWithAutoStart step waits for the warehouse staff to indicate that the job is ready to ship.

    The WaitForRelatedJobs step holds the parent job and each of the child jobs until all the child jobs arrive at the step.

  6. In the jobs table, right-click the Jensen Bank Baseball Cap job and select Manual Complete.
  7. Select Move to next step and click OK.

    The job moves to the WaitForRelatedJobs step.

    When both child jobs reach the WaitForRelatedJobs step, the workflow sends the parent and child jobs to the RetainCompletedJobs step. The state of each job changes to Retained.

    The MarcomCloseoutOrder web service notification calls the web service at https://services.printable.com/Trans/1.0/Closeout.asmx

    The request payload includes these RICOH ProcessDirector symbols:

    <PartnerCredentials> <Token>${WSNotification.WebService.Credential}</Token></PartnerCredentials><OrderID> <ID type="Printable">{${Job.Marcom.OrderId}}</Start></OrderID>

    The ${WSNotification.WebService.Credential} symbol specifies the static credential. The ${Job.Marcom.OrderId} symbol specifies the order ID.

    If the notification called the web service instead of running the simulation, this change would occur at the sample store on the MarcomCentral web site. On the Display by Item dialog in the Order Manager, the value in the Order Status column for each item in order number WS113 would change from Work in Progress to Shipped.

  8. In the jobs table, right-click the Brochure job and select View.
    The viewer displays the PDF file that was printed as part of the order.
To run the sample workflows again, enable and connect the MarcomReceiveOrders input device. Then disable and disconnect it.

Now that you have run the samples, you can copy them. Adjust the values in the copies to exchange data with your own store at the MarcomCentral web site. See the related task topics.

1.2.4.36.2 Planning how to process orders from your MarcomCentral store

In this procedure, you map MarcomCentral XML elements for orders and job tickets to RICOH ProcessDirector job properties. You decide how to supply the information required for RICOH ProcessDirector to process the items in an order. You also decide what criteria to use to report status to MarcomCentral.
To plan how to process orders from your MarcomCentral store:
  1. Review your MarcomCentral orders and decide which XML elements to map to RICOH ProcessDirector job properties.

    Later in this procedure, you map the XML elements to job properties using a third-party tool (such as Altova MapForce) that creates XSLT stylesheets.

    For reference, this table lists the eight MarcomCentral XML elements for orders that are mapped to five RICOH ProcessDirector job properties in the sample MarcomProcessOrders workflow.

    XML element for order Database name of job property User interface name of job property
    OrderNumber Job.Marcom.OrderNumber MarcomCentral order number
    ID Job.Marcom.OrderId MarcomCentral order ID
    User/Email Job.CustomerName Customer name
    ShippingAddress/Address1ShippingAddress/CityShippingAddress/StateShippingAddress/Zip Job.Info.Attr1 Custom 1
    count(OrderDetails/OrderDetail) Job.Info.Attr2 Custom 2

    Keep in mind this information about RICOH ProcessDirector job properties as you do the mapping:

    • Two job properties for orders are supplied with the MarcomCentral Connect feature: MarcomCentral order number and MarcomCentral order ID.

    • Two job properties for job tickets are supplied with the MarcomCentral Connect feature: MarcomCentral job ticket ID and MarcomCentral product type.

    • For a list of all job properties supplied with the base product, see the related reference about database property names for jobs.

    • RICOH ProcessDirector supplies custom 20 job properties: 10 of the properties hold text, 5 hold integers, and 5 hold numbers, including fractional numbers such as 8.5 or 9.725.

      • If one workflow processes order jobs and another workflow processes ticket jobs, you can use a custom job property for different purposes in each workflow. For example, you can use the Custom 1 property for the shipping address of an order in the workflow for order jobs. You can use the Custom 1 property for the SKU description in the workflow for ticket jobs.

      • You cannot use the same custom job property for different purposes within the same workflow. For example, you use the Custom 1 property for the SKU description in the job ticket workflow. If you also use the Custom 1 property to provide packaging information in the job ticket workflow, the packaging information overwrites the SKU description.

    • If you need more custom job properties, contact your Ricoh support representative.

      Note: If you are not using some of the job properties supplied with the base product or an installed feature, you can use those properties for MarcomCentral. For example, you have the AFP Support feature, but you are not using the Job.Info.Department and Job.Info.Programmer job properties. You can use those properties for MarcomCentral.

    Create a table similar to the one below to record the MarcomCentral order elements to map to RICOH ProcessDirector job properties. Add as many rows as needed.

    Note: The sample MarcomProcessOrders workflow uses three custom job properties to determine when all the expected job tickets have been retrieved. The other custom job properties are available for your use.
    Database name of job property User interface name of job property XML element for order
    Job.Marcom.OrderNumber MarcomCentral order number OrderNumber
    Job.Marcom.OrderId MarcomCentral order ID ID
    Job.Info.Attr1 Custom 1  
    Job.Info.Attr2 Custom 2 count(OrderDetails/OrderDetail)
    Job.Info.Attr3 Custom 3 count(ns0:Envelope/ns0:Body/ns2:GetJobTicketsByOrderNumberResponse/ns1:GetJobTicketResponse/JobTicket)
    Job.Info.Attr4 Custom 4 Used to determine when all job tickets for an order have been retrieved from MarcomCentral.
    Job.Info.Double1 Custom number 1  
    Job.Info.Double2 Custom number 2  
    Job.Info.Double3 Custom number 3  
    Job.Info.Integer1 Custom integer 1  
    Job.Info.Integer2 Custom integer 2  
    Job.Info.Integer3 Custom integer 3  

  2. Review your MarcomCentral job tickets and decide which XML elements for job tickets to map to RICOH ProcessDirector job properties.

    For reference, this table lists the nine MarcomCentral XML elements for job tickets that are mapped to nine RICOH ProcessDirector job properties in the sample MarcomProcessJobTicket workflow.

    XML element for job ticket Database name of job property User interface name of job property
    OrderDetails/OrderDetail/ID Job.Marcom.JobTicketId MarcomCentral job ticket ID
    OrderDetails/OrderDetail/ProductType Job.Marcom.ProductType MarcomCentral product type
    OrderDetails/OrderDetail/ProductName Job.Name Job name
    OrderDetails/OrderDetail/ProductDescription Job.Description Job description
    OrderDetails/OrderDetail/Quantity Job.Copies Job copies requested
    OrderDetails/OrderDetail/SKUDescription Job.Info.Attr1 Custom 1
    OrderDetails/OrderDetail/Shipping/Method Job.Info.Attr2 Custom 2
    FinalOutputFileURL/URL Job.Info.Attr3 Custom 3
    OrderDetails/OrderDetail/SKU/ID Job.Info.Attr4 Custom 4

    Create a table similar to the one below to record the MarcomCentral job ticket elements to map to RICOH ProcessDirector job properties. Add as many rows as needed.

    Database name of job property User interface name of job property XML element for job ticket
    Job.Marcom.JobTicketId MarcomCentral job ticket ID OrderDetails/OrderDetail/ID
    Job.Marcom.ProductType MarcomCentral product type OrderDetails/OrderDetail/ProductType
    Job.Info.Attr1 Custom 1  
    Job.Info.Attr2 Custom 2  
    Job.Info.Attr3The DownloadFile step uses this job property. Custom 3  
    Job.Info.Double1 Custom number 1  
    Job.Info.Double2 Custom number 2  
    Job.Info.Double3 Custom number 3  
    Job.Info.Integer1 Custom integer 1  
    Job.Info.Integer2 Custom integer 2  
    Job.Info.Integer3 Custom integer 3  

  3. Decide how to supply the information required for RICOH ProcessDirector to process the items in an order from your MarcomCentral store.
    MarcomCentral does not store the information required to process the items in an order. For example, MarcomCentral does not store the media, duplex, and finishing options required for print items or the packing material required for non-print items.
    1. Decide whether you want your MarcomCentral workflows to process both print and non-print items or only print items.

      If you want your workflows to process only print items, skip the instructions for non-print items. When you copy the sample MarcomProcessJobTicket workflow and modify it for your needs, remove the branch that processes non-print items.

    2. Decide what information RICOH ProcessDirector requires to process print items.

      For reference, this table lists the two RICOH ProcessDirector job properties that provide information required to process print items in the sample MarcomProcessJobTicket workflow.

      Database name of job property User interface name of job property
      Job.Media Media
      Job.Duplex Duplex

      Create a table similar to the one above to record the RICOH ProcessDirector job properties that provide the information required to process print items in your job ticket workflow. Add as many rows as needed.

      Note: Optionally, you can add an additional column to the table for XML elements to use later in this procedure.

    3. Decide what information RICOH ProcessDirector requires to process non-print items.

      For reference, this table lists the RICOH ProcessDirector job property that provides information required to process non-print items in the sample MarcomProcessJobTicket workflow.

      Database name of job property User interface name of job property
      Job.Info.Attr5 Custom 5

      Create a table similar to the one above to record the RICOH ProcessDirector job properties that provide the information required to process non-print items in your job ticket workflow. Add as many rows as needed.

      Note: Optionally, you can add an additional column to the table for XML elements to use later in this procedure.

    4. Identify the MarcomCentral XML element or elements required to look up the information RICOH ProcessDirector uses to process each item ordered at your MarcomCentral store.

      For example:

      • At one MarcomCentral store, different print items require different media and duplex options. The MarcomCentral elements for product type and product ID identify each print item. RICOH ProcessDirector maps the product type and product ID elements to job properties. RICOH ProcessDirector then uses the values of the job properties to determine the media and duplex setting required for each print item.

      • At another MarcomCentral store, different non-print items require different packing material and gift wrap options. The MarcomCentral element for stock-keeping unit (SKU) ID identifies each non-print item. RICOH ProcessDirector maps the SKU ID element to a job property. RICOH ProcessDirector then uses the SKU ID to determine the packing material and gift wrap options required for each non-print item.

      • At a third MarcomCentral store, a portion of the MarcomCentral SKU ID identifies each print or non-print item. RICOH ProcessDirector maps SKU ID to a job property and uses a substring function in the XSLT stylesheet to remove digits that are not needed. RICOH ProcessDirector then uses the portion of the SKU ID to determine the processing options required for each print or non-print item.

        Note:
      • Make sure that you plan for elements that change based on how customers customize the products they order. For example, an element identifies baseball caps, but the value of the element changes for red and blue caps. Use a second element to identify the color.
    5. If the element or elements are not included in the table of XML elements for job tickets, add them to the table.

      For example, you use the SKU ID element to identify items. Make sure that the SKU ID element is included in the table of XML elements for job tickets that you map to RICOH ProcessDirector job properties. In the sample MarcomProcessJobTicket workflow, the SKU ID element is mapped to the Custom 4 job property.

    6. If an external data source contains the information required to process items ordered at your store, decide how to retrieve the information from the data source.

      For example, if a web service can retrieve the processing information, you can use a CallSOAPService or CallRESTService step to call the web service. A later step in this procedure explains how to add a CallSOAPService step to a workflow. Another way to retrieve the information is to use a RunExternalProgram step.

    7. If you do not have an existing data source, decide how to supply the information required to process items ordered at your store.

      The procedures for configuring RICOH ProcessDirector to retrieve and process MarcomCentral orders discuss two ways to supply information:

      • XML files

        You can create a set of XML files, one for each item ordered at your MarcomCentral store. An ApplyXSLTransform step uses the XML file to set values for the job properties of the item. The sample MarcomProcessJobTicket workflow uses this method.

        To create the XML files, you map the XML elements used by each item to RICOH ProcessDirector job properties. The next step in this procedure explains how to create the XML files.

      • AssignJobValues steps

        You can add to your job ticket workflow an AssignJobValues step for each item ordered at your MarcomCentral store. For example, if SKU IDs identify items, you can use an AssignJobValues step for each SKU ID. In the step, you assign all the job properties required to produce the item.

      You can use other methods to supply the information required to process the items ordered at your MarcomCentral store. For example, if you have the Archive feature, you can store print items and the job properties required to print them correctly in a repository. When RICOH ProcessDirector processes the job for the print item, it can retrieve the PDF file and the properties required to print it from the repository.

  4. To use a set of XML files at a specified location as input to an ApplyXSLTransform step, do these steps.
    1. Assign XML elements to the job properties required to process each print or non-print item.
      You identified those job properties in earlier steps. The tables provided in those steps include a column that you can use to assign an XML element to each job property.
    2. Create a directory for the files.

      For example, create a MarcomItemProperties subdirectory in the testfiles directory:

      • /aiw/aiw1/testfiles/MarcomItemProperties (Linux)
      • C:\aiw\aiw1\testfiles\MarcomItemProperties (Windows)

    3. Create an XML file for each item that can be ordered at your MarcomCentral store.

      The file contains the XML element or elements that identify the item and an XML element for each job property required for print and non-print items. Each property specifies the value required to process the item.

      A separate file is required for each item, even if some items require the same processing information.

      In this example, the value of the SKU/ID element identifies the item. The example includes an element that identifies the name of the item (Brochure_JensenBank) and seven more elements with the values required to process the item.

      <?xml version="1.0" encoding="utf-8"?>
      <SKU>
        <ID>10000001</ID>
        <Name>Brochure_JensenBank</Name>
        <Duplex>Yes</Duplex>
        <Media>Letter Plain></Media>
        <Punch>Not set</Punch>
        <Staple>Not set</Staple>
        <Fold>None</Fold>
        <Package></Package>
        <PackMaterial></PackMaterial>
      </SKU>

    4. When you name the file, include the value of the job property or properties that identify the item in the name.

      For example:

      • SKU ID 10000001 identifies a brochure, and you map the SKU ID element to the Custom 4 ( Job.Info.Attr4) job property.

      • Name the file Item10000001.xml.

      • When you modify the MarcomProcessJobTicket workflow to access your XML files, use a symbol in the name of the input file for the ApplyXSLTransform2 step. Specify Item${Job.Info.Attr4}.xml as the value of the Input file property. For more information, see the related task for accessing XML files from your job ticket workflow.

    5. Put the files in the directory that you created.

      For example, put the files in the MarcomItemProperties directory.

  5. Prepare your XSLT stylesheet files:
    1. Create a directory in a location that the RICOH ProcessDirector server can access.
    2. Make copies of the jobticketsReceived.xslt and downloadOverrides.xslt XSLT stylesheet files and put them in the new directory.

      The jobticketsReceived.xslt and downloadOverrides.xslt files are in this directory:

      • /aiw/aiw1/testfiles/Marcom (Linux)
      • C:\aiw\aiw1\testfiles\Marcom (Windows)

      Note: You do not need to change these files.
      • The jobticketsReceived.xslt file converts an XML element into a job property that RICOH ProcessDirector uses to count the number of job tickets that have been received.

      • The downloadOverrides.xslt file converts an XML element into a job property that RICOH ProcessDirector checks to see whether a print file is ready to download.

    3. Use an XSLT tool (such as Altova MapForce) to create an XSLT stylesheet that converts MarcomCentral order elements into job properties.

      • In an earlier step, you mapped MarcomCentral order elements to RICOH ProcessDirector job properties in a table. Refer to that table as you prepare the input to the tool.

      • After you create the stylesheet, save it in a file named orderToOverrides.xslt.

      This example shows the contents of the sample orderToOverrides.xslt file supplied with the MarcomCentral Connect feature:

      <?xml version="1.0" encoding="UTF-8"?><xsl:stylesheet version="1.0" 
      	xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
      	xmlns:xs="http://www.w3.org/2001/XMLSchema" exclude-result-prefixes="xs">
        <xsl:output method="text" encoding="UTF-8"/>
        <xsl:template match="/">
          <xsl:variable name="var1_initial" select="."/>
          <xsl:for-each select="Order">
            <xsl:variable name="var2_current" select="."/>
            <xsl:value-of select="concat('Job.Marcom.OrderNumber=', OrderNumber, 
      			'&#10', 'Job.Marcom.OrderId=', ID, '&#10', 'Job.Info.Attr1=', 
      			ShippingAddress/Address1, ' ', ShippingAddress/City, ' ', 
      			ShippingAddress/State, ' ', ShippingAddress/Zip, '&#10', 
      			'Job.CustomerName=', User/Email, '&#10', 'Job.Info.Attr2=', 
      			count(OrderDetails/OrderDetail))"/>
          </xsl:for-each>
        </xsl:template></xsl:stylesheet>

    4. Use the XSLT tool to create an XSLT stylesheet that converts MarcomCentral ticket elements into job properties.
      • In an earlier step, you mapped MarcomCentral ticket elements to RICOH ProcessDirector job properties in a table. Refer to that table as you prepare the input to the tool.

      • Make sure that the stylesheet maps the job ticket element or elements that look up the information required to process each item in an order.

      • Make sure that the stylesheet maps the order element that associates each job ticket with its order. In the sample MarcomProcessJobTicket workflow that element is OrderDetails/OrderDetail/OrderID, which is mapped to the MarcomCentral order ID job property.

      • After you create the stylesheet, save it in a file named jobticketToOverrides.xslt.

    5. If you created XML files with information required to process each item in an order, use the XML tool to create an XSLT stylesheet. The stylesheet converts the XML elements in each XML file into job properties.

      • In an earlier step, you recorded in tables the RICOH ProcessDirector job properties required to process print and non-print items. In another step, you assigned XML elements to the job properties. Refer to those tables as you prepare the input to the tool.

      • After you create the stylesheet, save it in a file named itemToOverrides.xslt.

    6. Put the new XSLT stylesheet files in the directory that you created.
  6. Decide what criteria to use to report status to MarcomCentral.

    Consider whether you want to report status only for some workflows or items. You can use any job property or combination of job properties to trigger the notification to MarcomCentral.

    For example, the sample MarcomCloseoutOrder notification reports status when an order is ready to ship and the state of the order job has changed to Retained. The state of the order job does not change until the jobs for all the items in the order complete their processing.

After you plan how to process orders, you are ready to prepare to call MarcomCentral web services.

1.2.4.36.3 Preparing to call MarcomCentral web services

In this procedure, you import WSDL files and install a security certificate. If your environment requires a proxy server to communicate with MarcomCentral, set up the system to use it. You decide whether you want to call operations in MarcomCentral web services in addition to those operations called by the sample input device, workflows, and notification. If you do, you learn the requirements of the operations and manually test the web services.
To prepare to call MarcomCentral web services:
  1. Before you make calls to MarcomCentral web services, do these tasks:
    1. Import a WSDL file for each MarcomCentral web service that you plan to call.

      RICOH ProcessDirector creates SOAP request objects from SOAP operations in the WSDL file. You specify a prefix that RICOH ProcessDirector adds to the names of the SOAP operations when it creates the objects. A SOAP request object lets RICOH ProcessDirector determine the SOAP version and other information required to make a correct call to the web service.

    2. Install a security certificate for MarcomCentral on the RICOH ProcessDirector primary computer.
    3. If your environment requires a proxy server to communicate with MarcomCentral, set up the system to use it.
    For more information, see the related tasks.
  2. If you have a production MarcomCentral store, we recommend setting up a test store.

    If you have a test store, you can test your input device, CallSOAPService steps, and notifications without accidentally processing or closing out real orders. You can establish that the communication between RICOH ProcessDirector and MarcomCentral works with simple orders and a basic process. You can add information to your web service calls and test new web service calls incrementally.

  3. Decide whether you want to call operations in MarcomCentral web services in addition to those operations called by the sample objects in theMarcomCentral Connect feature.

    The sample objects call these operations in MarcomCentral web services:

    • The sample MarcomReceiveOrders input device calls the GetOrdersByDate operation in the Order web service and retrieves orders within specified times and dates.

    • The CallSOAPService step in the sample MarcomProcessOrders workflow calls the GetJobTicketsByOrderNumber operation in the Job Ticket web service and retrieves all the job tickets for an order.

    • The CallSOAPService step in the sample MarcomProcessJobTicket workflow calls the GetJobTicketByLineItem operation in the Job Ticket web service and retrieves the URL of the file to download.

    • The sample MarcomCloseoutOrder notification calls the CloseoutByOrder operation in the Order Closeout web service and sends the order ID of a completed order.

      You can add information for invoicing, packing slips, and settlements to the Request payload property of the notification. As an alternative, you can do invoice, packing slip, and settlement operations individually by calling the Invoice, Packing Slip, and Settlement web services. For more information, see the MarcomCentral web services documentation.

    You can call any operation in any MarcomCentral web service, including Catalog and Inventory, from a CallSOAPService step or a SOAP web service notification.

  4. To call another operation in a MarcomCentral web service from the RICOH ProcessDirector workflows that process MarcomCentral orders and job tickets:
    1. Learn the requirements for communication with the MarcomCentral web service operation:

      • The values for requesting data

      • The format of the data provided in the response

      Refer to the MarcomCentral documentation for the web service or consult with the company.

    2. Run a manual test that authenticates with MarcomCentral and requests a response from the web service. Verify that the web service does the action that you want.

      Many browsers have plug-ins, such as Boomerang for Google Chrome, that test web service calls to SOAP clients.

      When the test call updates the correct information at your store and returns the correct response, the payload is ready to use in RICOH ProcessDirector.

    3. Save the payload in a text file.
    4. To put the call to the web service operation in a CallSOAPService step, add the step when you define the workflow for processing orders or job tickets. Copy the payload into the Request payload property of the CallSOAPService step.
    5. To put the call to the web service operation in a notification, add the notification after you define the workflows for processing orders or job tickets. Copy the payload into the Request payload property of the notification.

After you prepare to call MarcomCentral web services, you are ready to prepare to retrieve orders from MarcomCentral.

1.2.4.36.4 Preparing to retrieve orders from MarcomCentral

To retrieve orders from a store at the MarcomCentral web site, copy the MarcomReceiveOrders SOAP web service input device supplied with the MarcomCentral Connect feature. The Request URL and Request payload properties of the input device are set to call the Order MarcomCentral web service and retrieve orders by date. Set other properties to values that work with your MarcomCentral store and RICOH ProcessDirector workflows.

Before doing this procedure, make sure that you imported WSDL files and installed a security certificate. If your environment requires a proxy server to communicate with MarcomCentral, make sure that you set up the system to use it. For more information, see the related tasks.

To prepare to retrieve orders from MarcomCentral:
  1. Click the Administration tab.
  2. In the left pane, click Devices Input Devices.
  3. Copy the MarcomReceiveOrders input device and give it a new name.
  4. On the General tab, set the Polling interval property to the time that you want the input device to wait between web service calls.

    Make sure that the polling interval meets the MarcomCentral terms of service. If the terms limit calls to the MarcomCentral system to a maximum of 1 every 5 minutes, set the value to 5 minutes or more.

  5. On the Request tab:
    1. Set the Use proxy property to the proxy server (if any) that you use to communicate with the web service.
    2. Set the Time zone offset property to the offset in hours between Coordinated Universal Time (UTC) and the time zone that the MarcomCentral web service uses.

      For example, if the MarcomCentral web service uses Pacific Standard Time to compute dates and times, set the property to -8.

        Note:
      • Make sure that you change this property when a MarcomCentral location that hosts the web service changes between standard and daylight savings time. Otherwise, you can lose the orders placed during the lost or gained hour.

      • To retrieve orders, the input device uses symbols for two properties:

        • WebService.CurrentRequestTime

          RICOH ProcessDirector sets the value of this property at the start of the polling interval.

        • WebService.LastSuccessRequestTime

          When the input device successfully communicates with the application, RICOH ProcessDirector sets the value of this property to match the value of the WebService.CurrentRequestTime property. A successful communication results in a response code 200, even if no data is received that creates a job.

    3. Set the SOAP request property to the GetOrdersByDate SOAP request that you imported.

      If you prepended MyStore to the names of the SOAP requests when you imported them, set the property to MyStore-GetOrdersByDate.

    4. Use the default values for all other properties on the Request tab.
  6. On the Authentication tab:
    1. Set the Static credential property to your MarcomCentral order token.
    2. Leave the values of all other properties blank.
  7. When you finish editing the properties, click OK.
After you define a workflow to process MarcomCentral orders, right-click the input device and select Properties. On the General tab, set the Child workflow property to the name of the workflow that you defined.

1.2.4.36.5 Defining a workflow to process MarcomCentral orders

To process orders retrieved from a store at the MarcomCentral web site, copy the MarcomProcessOrders workflow supplied with the MarcomCentral Connect feature. The CallSOAPService step calls the Job Ticket MarcomCentral web service and retrieves job tickets by order number. Modify that step and others in the workflow by setting the step properties to values that work with your MarcomCentral store and RICOH ProcessDirector workflows.

The workflow that processes MarcomCentral orders receives jobs from the SOAP web service input device.

Before you define the workflow:

  • Plan how to process the orders, including how to map XML elements in the orders to RICOH ProcessDirector job properties using an XSLT style sheet.
  • Prepare to call MarcomCentral web services.
  • Define a SOAP web service input device.

For more information, see the related tasks.

To define a workflow to process MarcomCentral orders:
  1. Click the Workflow tab.
  2. Right-click the MarcomProcessOrders workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. In the workflow editor, right-click the SetJobPropsFromTextFile step and select Properties.
  5. In the Job Defaults - General tab, set the Job name property to a value that identifies orders from your MarcomCentral store.
  6. For the ApplyXSLTransform step, set the XSLT file property to the directory path and name of the orderToOverrides.xslt file that you created.
      Note:
    • This file was created in the procedure for planning how to process orders from your MarcomCentral store.
  7. For the CallSOAPService step:
    1. Set the Use proxy property to the proxy server (if any) that you use to communicate with the web service.
    2. Set the Password property to your MarcomCentral order token.
    3. Set the SOAP request property to the GetJobTicketsByOrderNumber SOAP request that you imported.
      If you prepended MyStore to the names of the SOAP requests when you imported them, set the property to MyStore-GetJobTicketsByOrderNumber.
    4. For the ApplyXSLTransform2 step, set the XSLT file property to the directory path and name of the jobticketsReceived.xslt file that you copied into your new directory.
        Note:
      • This file was created in the procedure for planning how to process orders from your MarcomCentral store.
  8. For the Wait step, set the Wait for property to a value that makes jobs wait until your MarcomCentral store processes all their job tickets.
    The (2) Check for tickets connector and Wait for property together specify how long a job waits for all its job tickets before it goes to the FailWithMessage step. The Wait for property specifies a wait of 1 minute, and the rule on the (2) Check for tickets connector specifies that the job goes through the branch 9 times. The elapsed time before the job goes to the FailWithMessage step is 10 minutes. If you set the Wait for property to 2 minutes, the elapsed time is 20 minutes. If you then set the rule on the connector to Custom count 1 < 20, the elapsed time is 40 minutes.
  9. Optional: If you want your workflows to process only print items, set the XPath expression to create jobs property for the CreateJobsFromXML step to an expression that excludes non-print items.
  10. For the RetainCompletedJobs step, set the Retention period property to an appropriate value for your site.
  11. Save and enable the workflow.
  12. Connect the workflow to the input device that you defined to retrieve MarcomCentral orders:
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Right-click the input device and select Properties.
    4. On the General tab, set the Child workflow property to the name of the workflow that you defined to process MarcomCentral orders.
After you define a workflow to process MarcomCentral job tickets, set the Workflow for new jobs property of the CreateJobsFromXML step to the name of the job ticket workflow.

1.2.4.36.6 Defining a workflow to process MarcomCentral job tickets

To process job tickets retrieved from a store at the MarcomCentral web site, copy the MarcomProcessJobTicket workflow supplied with the MarcomCentral Connect feature. The CallSOAPService step calls the Job Ticket MarcomCentral web service and retrieves job tickets by order number. Modify that step and others in the workflow by setting their properties to values that work with your MarcomCentral store and RICOH ProcessDirector workflows.

The workflow that processes MarcomCentral job tickets receives child jobs from the CreateJobsFromXML step in the workflow that processes MarcomCentral orders.

Before you define the workflow:

  • Plan how to process the orders, including how to map XML elements in the orders to RICOH ProcessDirector job properties using an XSLT style sheet.
  • Prepare to call MarcomCentral web services.
  • Define a SOAP web service input device.
  • Define the workflow that processes MarcomCentral orders.

For more information, see the related tasks.

To define a workflow to process MarcomCentral job tickets:
  1. Click the Workflow tab.
  2. Right-click the MarcomProcessJobTicket workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. In the workflow editor, set the XSLT file property for the ApplyXSLTransform step to the directory path and name of the jobticketToOverrides.xslt file that you created.
      Note:
    • This file was created in the procedure for planning how to process orders from your MarcomCentral store.
  5. Check the conditions specified for the (1) Warehouse connector and adjust as required for your MarcomCentral store.

    The three conditions on the connector in the sample MarcomProcessJobTicket workflow specify MarcomCentral product types JobDirect, Variable, and Versioned. Jobs with those product types do not go through the 1 Warehouse connector. Instead, those jobs go through the (2) Print shop connector.

  6. For the Wait step, set the Wait for property to a value that makes jobs wait until your MarcomCentral store provides the link to the file to download.

    The (2) Check for file connector and Wait for property together specify how long a job waits for your MarcomCentral store to provide the link to the file. If the store does not provide the link within the specified time, the job goes to the FailWithMessage step. The Wait for property specifies a wait of 30 seconds, and the rule on the (2) Check for file connector specifies that the job goes through the branch 9 times. The elapsed time before the job goes to the FailWithMessage step is 5 minutes. If you set the Wait for property to 1 minute, the elapsed time is 10 minutes. If you then set the rule on the connector to Custom count 1 < 20, the elapsed time is 20 minutes.

  7. For the CallSOAPService step:
    1. Set the Use proxy property to the proxy server (if any) that you use to communicate with the web service.
    2. Set the Password property to your MarcomCentral order token.
    3. Set the SOAP request property to the GetJobTicketByLineItem SOAP request that you imported.
    4. If you prepended MyStore to the names of the SOAP requests when you imported them, set the property to MyStore-GetJobTicketByLineItem.
  8. For the ApplyXSLTransform2 step in the Prepare phase, set the XSLT file property to the directory path and name of the downloadOverrides.xslt file that you copied into your new directory.
      Note:
    • This file was created in the procedure for planning how to process orders from your MarcomCentral store.
  9. For the DownloadFile step, set the Use proxy property to the proxy server (if any) that you use to communicate with the web service.
  10. For the RetainCompletedJobs step, set the Retention period property to an appropriate value for your site.
  11. In the Print shop branch, modify the four steps in the Print phase or replace them with your steps for processing and printing PDF jobs.
  12. Modify the Warehouse branch:
    • If your workflows process only print items, delete the branch.
    • If your workflows process both print and non-print items, you can keep the ManualStepWithAutoStart step or replace it with other steps.
      • If the warehouse staff has access to RICOH ProcessDirector, they can complete the ManualStepWithAutoStart step when they add a non-print item to the order.
      • If the warehouse staff does not have access to RICOH ProcessDirector, you can use other steps to communicate with them.

        For example, you can add a SendEmail step that sends an email message to the warehouse staff when the non-print item enters the Warehouse branch. If your business uses an application with a web service interface to handle pick and pack operations, you can add a CallSOAPService step to the Warehouse branch. The step sends the data in the job to the application.

  13. Save the workflow.
  14. Connect the workflow to the workflow that you defined to process MarcomCentral orders:
    1. In the workflow editor, open the workflow that you defined to process MarcomCentral orders.
    2. For the CreateJobsFromXML step, set the Workflow for new jobs property to the name of the job ticket workflow.
Now you are ready to add the information required to process the items in an order to your job ticket workflow.

1.2.4.36.7 Adding information required to process items to your job ticket workflow

You can supply the information required to process the items ordered at your MarcomCentral store in several different ways. If you decided to use XML files, do the procedure for accessing XML files from your job ticket workflow. If you decided to use AssignJobValues steps, do the procedure for adding AssignJobValues steps to your job ticket workflow.

If you decided to supply the information in another way, make the necessary changes to your job ticket workflow. For example, you decide to retrieve the information by calling a web service that accesses an external data source. Add a CallSOAPService step or a CallRESTService step to the job ticket workflow and adjust the other steps to support the process.

When you finish, you are ready to define a SOAP web service notification to send status to your MarcomCentral store.

1.2.4.36.7.1 Accessing XML files from your job ticket workflow

If you decided to use a set of XML files as input to an ApplyXSLTransform step, this procedure explains how to access the files. The XML files store the information required to process each item ordered at your MarcomCentral store.

To create the XML files, follow the instructions in the related task for planning how to process orders from your MarcomCental store. That task includes a sample XML file with the information required to print a brochure.

The sample MarcomProcessJobTicket workflow uses a set of two XML files as input to the ApplyXSLTransform2 step in the Receive phase.

  • Each XML file contains the processing information for an item. The MarcomCentral SKU ID identifies each of the two items and associates each item with the XML file that contains its processing information. The name of each XML file includes the value of the SKU ID for the item: SKU13933967.xml or SKU15302443.xml.
  • The job ticket for each item contains the SKU ID, which the jobticketToOverrides.xslt style sheet maps to the Custom 4 ( Job.Info.Attr4) job property. The Custom 4 job property is a symbol in the value of the Input file property for the ApplyXSLTransform2 step: SKU${Job.Info.Attr4}.xml. The step resolves the symbol when it runs. For example, if the SKU ID for an item is 13933967, the step resolves the file name to SKU13933967.xml.
  • The ApplyXSLTransform2 step uses the skuToOverrides.xslt XSLT style sheet to convert element values in the input XML file into job property values. The steps in the workflow use the job property values to process the job for the item.

This procedure modifies your job ticket workflow to access your set of XML files.

To access XML files from your job ticket workflow:
  1. Click the Workflow tab.
  2. Click the name of the workflow for processing job tickets.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. For the ApplyXSLTransform2 step in the Receive phase:
    1. Set the Input file property to the full directory path and the symbolic name that RICOH ProcessDirector resolves to the name of one of your XML files.
      For example:
      • You name each XML file with the prefix Item followed by the SKU ID and the XML extension. Example: Item10000001.xml.
      • You map the SKU ID element in the job ticket for the item to the Custom 4 ( Job.Info.Attr4) job property.
      • Set the Input file property to <directory_path>Item${Job.Info.Attr4}.xml. If you created a MarcomItemProperties directory in the testfiles directory, set the property to /aiw/aiw1/testfiles/MarcomItemProperties/Item${Job.Info.Attr4}.xml (Unix) or C:\aiw\aiw1\testfiles\MarcomItemProperties\Item${Job.Info.Attr4}.xml (Windows).
      • When the ApplyXSLTransform2 step runs, it uses the value of the Custom 4 job property to resolve Item${Job.Info.Attr4}.xml to Item10000001.xml. The step then retrieves the Item10000001.xml file.
    2. Set the XSLT file property to the directory path and name of the XSLT file that converts elements that contain item processing information into job properties.
        Note:
      • This file was created in the procedure for planning how to process orders from your MarcomCentral store.
  5. Right-click the (1) No SKU Details connector and select Properties.

    This connector sends jobs for items that do not require processing information directly to the ContinueToNextStep step. The connector identifies those jobs by checking the Custom 4 job property. If the property does not equal any of the SKU IDs specified by the conditions for the rule, the connector sends the job to the ContinueToNextStep step.

      Note:
    • If all your items require processing information, you can delete the (1) No SKU Details connector and send all jobs to the ApplyXSLTransform2 step.

    1. If you do not use SKU IDs to access item processing information, rename the rule to something that indicates that the branch bypasses item processing information.
      For example, you can rename the rule to No Matching Item Details.
    2. Delete the two existing conditions: Custom 4 != 15302443 and Custom 4 != 13933967.
    3. Add a condition that specifies each XML file that you created.
      For example, you use the SKU ID to access the information required to process MarcomCentral items. You created four XML files. The SKU IDs that identify the files are 10000001, 10000002, 10000003, and 10000004.

      Add four conditions:

      Custom 4 != 10000001 Custom 4 != 10000002 Custom 4 != 10000003 Custom 4 != 10000004

      Apply all the conditions.

  6. If you use something other than SKU ID to access item processing information:
    1. Right-click the (2) SKU Details connector and select Properties.
    2. Rename the rule to something that indicates that the branch accesses item processing information.
      For example, you can rename the rule to Item Details.
  7. Save and enable the workflow.
Now you are ready to define a SOAP web service notification to send status to your MarcomCentral store.

1.2.4.36.7.2 Adding AssignJobValues steps to your job ticket workflow

If you decided to use AssignJobValues steps to store item processing information, this procedure explains how to add the AssignJobValues steps to your workflow.

This figure shows the steps and connectors after you change the workflow to add the AssignJobValues steps.

To add AssignJobValues steps to your job ticket workflow:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to edit.
  3. Delete the ApplyXSLTransform2 step in the Receive phase.
  4. Connect the ApplyXSLTransform step to the ContinueToNextStep step in the Prepare phase.
  5. Add two ContinueToNextStep steps:
    1. Name one step ContinueToPrintShopBranch and put it at the start of the [1] Print shop branch.
    2. Name the other step ContinueToWarehouseBranch and put it at the start of the [2] Warehouse branch.
    These steps separate the connectors for AssignJobValues steps from the [1] Print shop and [2] Warehouse connectors.
  6. For each print item, add an AssignJobValues step to the Print shop branch. Make each step a separate branch between the ContinueToPrintShopBranch step and the ContinueToNextStep step.
  7. For each non-print item, add an AssignJobValues step to the Warehouse branch. Make each step a separate branch between the ContinueToWarehouseBranch step and the ContinueToNextStep step.
  8. For each AssignJobValues step, add a rule to the connector from the ContinueToPrintShopBranch step or the ContinueToWarehouseBranch step.
    The rule specifies the value that you use to look up item processing information.
    For example, you use the MarcomCentral stock-keeping unit (SKU) ID to look up item processing information. The Custom 4 job property stores the value of the SKU ID. If the SKU ID for a print item is 10000001, the rule is Custom 4 = 10000001. You can name the rule SKU ID = 10000001.
  9. Add a connector from the ContinueToPrintShopBranch step to the ContinueToNextStep step in the Prepare phase:
    1. Give the rule on the connector a name.
      For example, you use the MarcomCentral SKU ID to look up the information required to process an item. You can name the rule No SKU ID.
    2. Do not give the rule a condition.
  10. Add a connector from the ContinueToWarehouseBranch step to the next step in the branch. Select the rule that you assigned to the connector from the ContinueToPrintShopBranch step to the ContinueToNextStep step.
    For example, select the rule No SKU ID.
  11. For each AssignJobValues step, specify the property values required to process the item in the Values to set list.
    For example, a print item requires Letter Plain media, duplex printing, and a gate fold. Specify these property values for job properties in the Values to set list:

    Screen capture of job properties for AssignJobValues step shows list of three properties and values.

      Note:
    • If multiple items require the same property values, you can use one AssignJobValues step for all of them. For example, you use the MarcomCentral SKU ID to look up the information required to process a print item. The Custom 4 property stores the value of the SKU ID. If items with SKU IDs 10000001 and 10000004 require the same property values, add a rule for each SKU ID to the connector:

      Custom 4 = 10000001 Custom 4 = 10000004

      Apply all the conditions.

  12. Save and enable the workflow.
Now you are ready to define a SOAP web service notification to send status to your MarcomCentral store.

1.2.4.36.8 Preparing to send status to MarcomCentral

To send status to a store at the MarcomCentral web site, copy the MarcomCloseoutOrders SOAP web service notification supplied with the MarcomCentral Connect feature. The Request URL and Request payload properties of the notification are set to call the Order Closeout MarcomCentral web service and send the ID of the completed order. Set other properties to values that work with your MarcomCentral store and RICOH ProcessDirector workflows.

Before you define the notification:

  • Plan how to process the orders, including how to map XML elements in the orders to RICOH ProcessDirector job properties using an XSLT style sheet.
  • Prepare to call MarcomCentral web services.
  • Define the workflow that processes MarcomCentral orders.

For more information, see the related tasks.

    Note:
  • Another way to send status is with a CallSOAPService step. For example, you can use a CallSOAPService step to call the Order Closeout web service. Put the step in your order workflow after the WaitForRelatedJobs step. If you use a CallSOAPService step to send closeout status, do not copy and modify the MarcomCloseoutOrders notification.

To prepare to send status to MarcomCentral:
  1. Click the Administration tab.
  2. In the left pane, click Objects Notifications.
  3. Copy the MarcomCloseoutOrder notification and give it a new name.
  4. On the Request tab:
    1. Set the Use proxy property to the proxy server (if any) that you use to communicate with the web service.
    2. Set the SOAP request property to the CloseoutByOrder SOAP request that you imported.
      If you prepended MyStore to the names of the SOAP requests when you imported them, set the property to MyStore-CloseoutByOrder.
    3. To send more closeout information to MarcomCentral, add the appropriate XML to the Request payload property.
      For example, you can add XML for invoicing, packing slips, and settlements.
        Note:
      • If you change the payload, we recommend running a manual test using a browser plug-in, such as Boomerang for Google Chrome. For more information, see the task for preparing to call MarcomCentral web services.
    4. Use the default values for all other properties on the Request tab.
  5. On the Authentication tab:
    1. Set the Static credential property to your MarcomCentral closeout token.
    2. Leave the values of all other properties blank.
  6. On the Event and Conditions tabs, specify the job property or combination of job properties to trigger the notification to MarcomCentral.
    For example:
    • You added a ShipOrder step based on the ManualStepWithAutoStart step template to your order workflow. Your warehouse staff completes the step when the order reaches the shipping department.
    • You want the notification to monitor the Current step property for jobs in your order workflow.
    • When the value of the Current step property for the order job changes to ShipOrder, you want the notification to call the Order Closeout MarcomCentral web service.
    • On the Event tab, set Property to Current step, Action to Changes to, and Value to ShipOrder.
    • On the Conditions tab, change the Value property to the name of your order workflow.
  7. When you finish editing the properties, click OK.
After you set up an input device, workflows for orders and job tickets, and a notification, you can retrieve and process MarcomCentral orders. You can notify your MarcomCentral store when the orders complete the process.

1.2.4.36.9 Retrieving and processing orders from your MarcomCentral store

After you set up an input device, workflows, and a notification, do these steps to retrieve and process orders from your MarcomCentral store.
To retrieve and process orders from your MarcomCentral store:
  1. Enable your new workflows for processing MarcomCentral orders and job tickets:
    1. Click the Workflow tab.
    2. Right-click the workflow for processing orders and select Enable.
    3. Right-click the workflow for processing job tickets and select Enable.
  2. Enable your new notification:
    1. Click the Administration tab.
    2. In the left pane, click System Notifications.
    3. Right-click the notification and select Enable.
  3. Enable your new input device:
    1. In the left pane, click Devices Input Devices.
    2. Right-click the input device and select Enable and Connect.
  4. Log in to your store at the MarcomCentral web site and create an order.
    As an alternative, reorder selected items.
  5. Check to see if the order appears on the jobs table.
  6. If the order does not appear on the jobs table:
    1. Disable and disconnect the input device.
    2. Check the messages in the log for the input device.
    3. If the web service returned a 500 error, display the properties for the input device. Click the Authentication tab, and reenter your order token in the Static credential property.
    4. If a message states that nothing in the response matched the value of the response pattern, click the Request tab. Check the value of the Time zone offset property.
      Make sure that the value is the offset in hours between Coordinated Universal Time (UTC) and the time zone used by the MarcomCentral web service.
      For example, if the MarcomCentral web service uses Pacific Standard Time, make sure that the value is -8.
    5. Enable and connect the input device.
  7. After the order appears in the jobs table, check to see if child jobs appear in the jobs table.
  8. If child jobs do not appear in the jobs table:
    1. Disable the workflow.
    2. Check the state of the order job and the messages in its job log.
    3. If the job is in the Error state in the ApplyXSLTransform step, display the properties for the step. Check the value of the XSLT file property. Make sure that the directory path and name of the XSLT file are correct.
      For this problem, the message in the job log states that the system cannot use the XSLT file.
    4. If the job is in the Error state in the CallSOAPService step:
      • Check the messages in the job log.
      • Display the properties for the step.
      • If a message in the job log states that the web service returned a 500 error, reenter your order token in the Password field.

        Other problems, such as an incorrect SOAP request, can cause the web service to return a 500 error.

      • If a message in the job log states that the web service returned a 400 error, check the payload.

        Other problems can cause the web service to return a 400 error.

    5. If the job is in the FailWithMessage step in the order workflow, increase the value of the Wait for property on the Wait step.
    6. Save and enable the workflow.
    7. Right-click the job and select Process Again. Process the job from the first step in the workflow.
  9. If a child job goes into the Error state in the CallSOAPService step in the job ticket workflow:
    1. Check the messages in the job log.
    2. Display the properties for the step.
    3. If a message in the job log states that the web service returned a 500 error, reenter your order token in the Password field.
      Other problems, such as an incorrect SOAP request, can cause the web service to return a 500 error.
    4. If a message in the job log states that the web service returned a 400 error, check the payload.
      Other problems can cause the web service to return a 400 error.
  10. If a child job is sent to the FailWithMessage step in the job ticket workflow, display the properties for the Wait step. Increase the value of the Wait for property.
  11. To solve other problems with job processing, check the messages in the job log.
  12. When the state of all the jobs in the order changes to Retained, the notification calls the CloseoutByOrder operation in the Order Closeout web service.
    MarcomCentral changes the value in the Order Status column for each item in the order to Shipped. The ship date for the item is the date when MarcomCentral received the notification. Depending on how you set up your store, other values can change. For example, MarcomCentral can assign an invoice number and date and a packing slip number.
  13. Log in to your MarcomCentral store and verify that the status of all the items in the order is Shipped.
  14. If the status remains Work in Progress:
    1. Check the messages in the log for the notification.
    2. If the web service returned a 500 error, display the properties for the notification. Click the Authentication tab, and reenter your closeout token in the Static credential property.
    3. At your MarcomCentral store, verify that the status of all the items in the order is Shipped.

1.2.4.37 Setting up the Archive feature

After you read the Archive overview topics, you can set up Archive by doing the configuration tasks described in this section.

After the initial configuration is complete, test your Archive workflows and repositories to make sure they work as you expect them to.

1.2.4.37.1 Running the Archive sample workflow

The Archive feature provides a sample workflow that you can examine and run to understand how the feature works. The sample includes a repository, a hot folder input device with a pre-submitted PDF file, a supplied history record notification, and a workflow that includes the StoreInRepository step.
The sample objects used in this workflow are:
  • Repository: SampleRepository
  • Hot folder input device: RepositoryFolder
  • Sample print job: Repository.pdf
  • Workflow: RepositorySample
  • History record notification: SampleHistoryRecord
Review the properties for each object before you start the procedure to see how they interact.

To run the sample workflow:

  1. Click the Main tab.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. In the Input Devices portlet, right-click the RepositoryFolder hot folder input device and select Enable and Connect.
    The first time you try this procedure, RICOH ProcessDirector immediately submits the Repository.pdf job to the RepositorySample workflow.
  4. In the Jobs table, find the job and check to see that the value in the Phase column is Complete.
    The Repository.pdf file and its documents are now stored in the SampleRepository repository.
  5. Click the Archive tab.
  6. In the Repository to search list, select the SampleRepository and the Any are true value for the Search criteria. You can choose to do either a job search or a document search.
    • For a job search, select Customer name (job) from the Property drop-down, = from the Comparison drop-down, type RicohSample in the Value field and click Search.
    • For a document search, select Member number from the Property list, like from the Comparison list, type 6883% in the Value field, and click Search.
        Note:
      • The % character is a wildcard representing zero or more characters beyond those already entered. Wildcards can be used only with like and unlike comparisons.
  7. After you have found the job or document, you can select an item and choose an action:
    • To view the job or document, click View file.
    • To submit the job or document back into the RICOH ProcessDirector system, click Submit file, select a workflow, and click OK.
    • To review the property values and any history information stored with the job, click Show details.
    • To see a report that contains all the values and any history information stored with one or more jobs or documents, click View detailed report.
    • To export the property values and any history information to a comma-delimited file, click Export to CSV.
    • To export a report that contains the property values and any history information in a PDF file, click Export to PDF.
To run the example again, copy the sample file to the hot folder. The sample file, Repository.pdf, is in the aiw/aiw1/testfiles directory.

1.2.4.37.2 Planning for retention of job and document data

Before you configure the Archive feature, plan the best way to set up repositories to hold the job and document data that you want to store.

You should identify:

  • The files you need to store
  • The properties you need to store
  • The history information you need to store
  • The points in the workflow where you need to store the job and document data
  • How long you need to retain the job and document data
  • Who should have access to the job and document data
  • The system on which the job and document data should be stored
  • What search properties you need to retrieve job and document data after they are stored in a repository
  • What job property values you need to preserve for use when the job is retrieved from a repository

This information helps you decide how many repositories you need. You can then create the repositories and add StoreInRepository steps to your workflows.

Files
Each StoreInRepository step can store one file for each job in one repository. You can store any type of file in your repositories. For example, you can store PDF files, JDF job tickets, AFP files, PostScript files, or compressed files. You can store just property values or job history and no file.
If you have the PDF Document Support feature installed, you can retrieve data, including a PDF job, a document from inside a job, or information about a job, from a repository and view it. If you have the AFP Support feature installed, you can retrieve and view the same kinds of data for AFP jobs. You cannot view the contents of jobs or documents in other types of files, though you can view property values and job history if you have chosen to store that information.

You can create repositories based on who you receive files from or how you use the files in your company. For example:

  • A print shop might store files for each customer account in its own repository.
  • An in-house printing department might store files for each line of business in its own repository. One repository might store accounts receivable jobs, and another repository might store accounts payable jobs.
  • A company might store files for each call center in its own repository. Call center employees have quick access to the files they need to support customers.
Properties
You can save the values of job and document properties with or without saving a job file or production history. You can also save the values of properties that are associated with a job, but are properties of other objects, and document data that is not defined as RICOH ProcessDirector document properties.
You can use job and document properties to retrieve a job, document, or information about the job from a repository and view the information. Information about the job can include properties associated with the job, such as the model of the printer used to print the job, and document data returned to RICOH ProcessDirector after an external program processes the documents in a job.
Storing properties takes much less space than storing jobs, so property repositories can be much smaller than repositories that store files.
You can specify properties to store based on how you use property information at your company. For example:
  • A company might store the customer name, account number, and other information on each document printed as well as the number of pages in the document and the model of the printer used to print the job. Storing job files containing the actual documents might not be necessary.
  • An in-house printing department might store job files, job and document properties needed to retrieve the documents in each job file, and postal processing data (such as change of address information) returned by third-party mail software. Although the postal processing data is not defined as RICOH ProcessDirector document properties, department personnel can view the data when they retrieve a document from the repository.
Production History
You can save the production history of a job, with or without saving a job file. You can set up history record notifications to capture varying levels of detail about job processing and then set the StoreInRepository step to store history records. For example, you can set up your notifications to record every state change for every step in the workflow that processes the job. Or you can limit what you record by choosing a particular state change, such as when the job state changes to Complete in the InsertJobs step or in the PrintJobs step.

Storing job history takes less space than storing jobs or documents, so job history repositories can be much smaller than repositories that store files or files and job history together.

You can create history record notifications based on how you use job history in your company. For example:

  • A print shop might want to be able to tell customers precisely when their jobs are received, printed, and ready for pickup.
  • A company might want to create an audit trail for all processing performed for specific customers whose jobs are time-sensitive.
Workflows
You can save files, job history, or both in a repository by adding a step based on the StoreInRepository step template at any point in the workflow. You can have multiple StoreInRepository steps in one workflow.

If you want to save jobs at different points in the same workflow, you can create a separate repository for each step. For example, you might store jobs in one repository before you process them so you have a record of the files that you received from customers. You might store jobs in another repository after you print them with added production information such as postal barcodes. The history records stored by each step contain only the job state changes recorded at the time each step ran. When you search for a job from the repository that was processed by multiple StoreInRepository steps, more than one result is returned. Each result contains only the history information known at the time the step ran.

Note: Some steps that you can add to your workflows only work at the job level; they are not aware of the documents inside the jobs. Some of those steps, such as ReversePDFPageOrder, change the order of pages in the job, without consideration for the document properties that are associated with each page. When the pages are rearranged, the document properties remain associated with their original page locations, even though the content of that page is entirely different. Opening the job in the viewer and searching on document properties results in incorrect search results.

For example, you receive a file with 50,000 pages from your customer. The workflow adds barcodes, sorts the job based on postal codes, then reverses the order of the pages so that the last page is printed first.

If you store the job in a repository after the IdentifyDocuments, IdentifyPDFDocuments, BuildAFPFromDocuments, or BuildPDFFromDocuments steps, and before the ReversePDFPageOrder or ReverseOutputOrder steps, you can retrieve the correct documents in a job using document properties as search criteria. If you store the job in a repository after the ReversePDFPageOrder or ReverseOutputOrder steps, searching for a document in a job produces unreliable results.

After you add a StoreInRepository step to a workflow, you can adjust the retention period in the RetainCompletedJobs step. For example, you have set a long retention period in the RetainCompletedJobs step because you might need to reprint a job or document. You can reduce the retention period because now you can reprint from the repository.

Retention periods
If you need to retain different jobs or job history for different periods, create a separate repository for each retention period.
When you first set up a repository, you might want to set a short retention period so you can test the information specified in the StoreInRepository step. Set a one or two day retention period and send a sample job through the workflow. Then you can check the repository to be sure you stored the correct file, along with its properties and history information. Also verify that the history record notifications you set up are capturing the history information you expect.
You cannot delete jobs or documents from a repository or change the properties stored with them, so you must make sure that all of the information you expect to be retrieved is available. After you complete your testing, you can use the Change Retention Period action on the Repositories page to set the value you want to use for your production work.
Access
If you want to control access to a repository, you can set a value for the Repository location property. Only users who have access to the location set for the repository can find the documents and jobs stored in it. If different groups of users should have access to different stored jobs and documents, create a separate repository for each group.
System storage
If you want to store files in folders at different places on your computer system, create a separate repository for each folder. You can create a repository on the local system or on a mounted drive anywhere on your network.
Search properties
You can search for and retrieve jobs, documents, and their history information from a repository based on job or document properties stored in the archive.

For each StoreInRepository step in each workflow, identify the properties that you need to search for stored jobs, documents, or job history. For example, you might search by the Job name and Customer name job properties. You might search for a document by the Member number document property.

Note: The Archive feature provides a large number of job and document properties that you can use to search for jobs and documents in a repository. Examine the values for the Job properties to store and Document properties to store properties on the StoreInRepository step template. If you need custom document properties, you can create them when you enhance PDF or AFP files for use with Archive.

In a step based on the StoreInRepository step template, you specify the repository to store the job in and the job and document properties used to search for jobs and documents in the repository. You can specify the same repository for multiple StoreInRepository steps. You can specify different search properties for each step.

If you use different search properties for different jobs, consider creating a separate repository for each set of jobs that use different search properties.

We recommend these best practices:

  • Specify the same search properties for each step that stores jobs in the same repository.
  • Store jobs with different search properties in different repositories.
  • Choose properties carefully because after a job or document is stored in the repository, you cannot change its properties or remove the job or document from the repository.

When the search properties in a repository are consistent, RICOH ProcessDirector displays search results faster and data is simpler for users to find.

For example, repository A has 15 search properties. The properties are the same for each step that stores jobs in the repository. Repository B has 10 search properties. Some jobs stored in repository B use five of the ten properties. Other jobs stored in repository B use three of the properties. RICOH ProcessDirector displays search results faster for Repository A. Because the properties used to search for some jobs are different from the properties used to search for other jobs, users searching Repository B can become confused about which properties to specify. If a job or document does not have a value for the property that a user searches for, the job or document is not returned in the search results.

Search speed
How you set up repositories can affect the speed of repository searches. Keep these points in mind:
  • Searches are faster if a repository has only jobs that were stored with the same search properties than if the repository has jobs that were stored with a mixture of different search properties.
  • If a repository has only jobs that were stored with the same search properties, searches are faster if fewer search properties were stored.
  • Smaller repositories are faster to search than large repositories.
  • Search speed is not affected if you store data files along with properties and history information.
Preservation of job property values
You can store the values of job properties set when a job is processed to preserve them for use when the job (or a document in the job) is retrieved from a repository and submitted as a new job. For example, if a job has custom job properties whose values indicate special processing requirements, you can store those values in an override properties file and submit them with the job or document when you retrieve it from the repository.

1.2.4.37.3 Tuning for search and storage performance

The Archive configuration can be modified to optimize search and storage performance based on server resources.

To optimize the Archive search function, you can edit the repository.cfg file to tune the use of your system resources to maximize efficiency.

To produce a faster return on results, modify the threads_for_search property so that it matches the number of CPU cores you have on your system. The search function then uses one thread per CPU, so that results are returned more quickly.

If you store 10 million or more documents or jobs in the repository, set the max_merge_size to 4000000.

If you store fewer than 10 million documents or jobs, set max_merge_size to about 25% of your total documents or jobs stored. For example, if you store 1,000,000 documents, set the max_merge_size to 250000.

To tune the repository search:

  1. Navigate to the repository.cfg file in /aiw/aiw1/config/ (Unix-based systems) or C:\aiw\aiw1\config\ (Windows).
  2. Open repository.cfg in a text editor.
  3. Modify threads_for_search and max_merge_size as needed.
  4. Save the file.
    Note: You do not need to restart RICOH ProcessDirector for the change to take effect.

1.2.4.37.4 Creating repositories

You can create repositories to hold job and document data that you want to store for possible later retrieval to submit again as a new job. You can create multiple repositories to hold job and document data for different lengths of time or to make the data accessible to different groups of users.
To create a repository:
  1. Click the Administration tab.
  2. In the left pane, click Objects Repositories.
  3. Click Add.
  4. Fill in the properties.
  5. Click OK.

1.2.4.37.5 Defining history record notifications

You can use notifications to create records to be saved as part of job history. You can define history record notifications to capture timestamps of job state changes as a job is processed in its workflow.
To define a history record notification:
  1. Click the Administration tab.
  2. In the left pane, click Objects Notifications.
  3. Click Add History Record.
  4. On the General tab, enter a name for the notification.
  5. On the Event tab:
    1. Select the property, the action, and the value to monitor.
      History record notifications can monitor only the Current job state property.
    2. To define an additional event, click the plus sign () to the right of any event. Events are combined with an OR so that a history record is written when any one of the events occurs.
    3. To delete an event, click the minus sign () to the right of the event you want to delete.
  6. On the Conditions tab:
    1. Select the property and the value that must be satisfied before any history record is recorded.
    2. To define an additional condition, click the plus sign () to the right of any condition.
      Select Any, All, or Custom to specify how the conditions are combined.
    3. To delete a condition, click the minus sign () to the right of the condition you want to delete.
  7. Click OK.

1.2.4.37.6 Enhancing PDF files for Archive

Use the RICOH ProcessDirector Plug-in for Adobe Acrobat to enhance sample PDF files so that you can store the documents or historical information about them in a repository.

The files must have a page group, which identifies documents, as well as the document properties required to search for documents in the repository. Use the RICOH ProcessDirector Plug-in for Adobe Acrobat to identify the page groups. For detailed information about the RICOH ProcessDirector Plug-in for Adobe Acrobat functions that you use in this procedure, such as Define Document Property, see the online help for the RICOH ProcessDirector Plug-in for Adobe Acrobat.

To enhance PDF files for use with the Archive feature:

  1. Open a PDF file in Adobe Acrobat Professional and click Ricoh Select to make RICOH ProcessDirector Plug-in for Adobe Acrobat the active tool.
  2. Draw a box around the text you want to use to define text-based page groups, or draw a box anywhere to define page groups that are not based on text. Click Define Page Group.
    1. From the Page Groups drop-down menu, select Create fixed-length page groups or Begin page group when the selected text is found.
      You can define a page group based on a fixed number of pages or based on text that appears repeatedly throughout the PDF file. For example, if Page 1 appears on the first page of each document, you can use that text to define page groups.
        Note:
      • If you use text to define the beginning of the page group, this text should appear in the same location on the first page of every document.

      • If you are using a sample PDF file to define page groups, make sure that the content and location of the text you select are consistent among the production PDF files.

    2. Click OK.
  3. Click Ricoh View Page Group Navigator and verify that the documents in the PDF file have been defined correctly.
  4. Define the first document property that you want to use to search for documents in a repository:
    1. Left-click just above the top left corner of the data that you want to capture. Drag the mouse to draw a box around the data.
      Make the box big enough to capture the longest occurrence of the data in your PDF files. Some characters in a PDF file have a larger white space buffer than other characters. You can see the captured data in the Selected Text area of the dialog.
    2. Select Define Document Property from the popup menu.
    3. Select a RICOH ProcessDirector document property from the drop-down list.
      If you need document properties that are not on the drop-down list, you must define those custom document properties in the docCustomDefinitions.xml file. Then you run the docCustom utility to update configuration files and add those properties to the database. After you load the new document properties, they are available in RICOH ProcessDirector Plug-in for Adobe Acrobat wherever you define document properties. For more information about editing the docCustomDefinitions.xml file, running the docCustom utility, and loading RICOH ProcessDirector document properties, see RICOH ProcessDirector: Installing Document Processing Features.
    4. Use the Placement Conditions section to specify the pages to extract the document property data from.
      If you want to extract the document property data from the first page of each document, select Pages based on a rule, and then select All Front Pages.
    5. Click OK to create the document property.
    6. Click Ricoh View Document Property Values and scroll through several page groups in your PDF file to verify that RICOH ProcessDirector Plug-in for Adobe Acrobat is extracting the correct document property values for each page group.
  5. Repeat the steps above to define each document property that you want to use to search for documents in a repository.
  6. When you are ready to save your page group definition and document properties, click Ricoh Save Control File.
  7. Give the control file a name or accept the default value. Click Save. You see a confirmation message. Click OK.
  8. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
    Note: When you create your Archive workflow, specify the name and location of the control file in each step based on the IdentifyPDFDocuments or BuildPDFFromDocuments step template.

1.2.4.37.7 Enhancing AFP files for Archive

Most AFP files that are submitted to RICOH ProcessDirector need to be enhanced before you can store the documents or information about their processing history in the AFP files in a repository.
If you plan to use AFP Indexer to enhance AFP files, you must purchase and install the AFP Support feature.
To enhance AFP files for use with the Archive feature:
  1. If the AFP file does not have page group triggers (which identify the start of each document in a job) or index tags defined for the document data that you want to extract, use AFP Indexer to add that information:
    1. Open the AFP file in the RICOH Visual Workbench.
    2. Select IndexAFP.
    3. Define the triggers that identify document boundaries.
    4. Add index tags for the document property data that you want to extract.
  2. Use the Document Property Designer (DPD) mode to link each document property that you want to use to search for documents in a repository:
    1. Open the AFP file in the RICOH Visual Workbench and select the DPD mode.
    2. Double-click the document property name at the bottom of the window.
    3. Supply the requested information in the Define link options dialog.
      When a document property is linked to an index tag, the value of the document property is the same as the value of the indexed data.
    For more information, see the topics related to RICOH Visual Workbench and Document Property Designer.
  3. Save the control file created by RICOH Visual Workbench and send it to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
    The control file contains Document Property Designer definitions.
    Note: When you configure your Archive workflows, specify the name of the Visual Workbench control file in each step based on the IdentifyDocuments or BuildAFPFromDocuments step template.

1.2.4.37.8 Creating an associated properties file

You can create an associated properties file to specify one or more properties that are associated with a job, but that are properties of other objects. When a step based on the StoreInRepository step template runs, these properties and their values are stored in a repository along with job and document data. For example, you can store the model of the printer requested for a job or the color of the media specified to print a job.

    Note:
  • You can also specify positional job properties in an associated properties file and store their values in a repository. You cannot select a positional job property as a value for the Job properties to store property on the StoreInRepository step. In a workflow, the values of positional properties can be different for different steps based on the same step template.

Positional job properties

To store values for a positional job property, you specify the property, the phase that the step is in, the internal name of the step with the property, and a property label. The syntax is:

Job_property[Phase][Step_identifier]:Property_label

For example, you have the Automated Verification feature, and you want to store the name of the barcode reader that the ReadBarcodeData step in the Insert phase uses to track the documents in a job through an inserter.

When you create the associated properties file, you type this line into a text editor:

Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Property_label

The property label might be Job.BarcodeReader.

When the StoreInRepository step runs, RICOH ProcessDirector:

  1. Gets the value of the Barcode reader job property (database name Job.TrackAndTrace.BarcodeReader) for the ReadBarcodeData step in the Insert phase.

    This value might be BarcodeReader1.

  2. Stores the value of the Barcode reader property along with other information for the job and its documents in the repository.

To see whether a property on a step template is positional, click the ? icon and check the Usage notes in the help.

Properties associated with a job

To store the value for a property of another object, you must be able to create a chain of relationships to that property. The chain must start with a job property that specifies an object as a value. The next property in the chain must be a property of the object specified by the job property. The chain must end with the property whose values you want to store.

Although you can start the chain with any job property that specifies an object as a value, these job properties satisfy most needs.

Object User interface name of job property Database name of job property Base product or feature
Barcode reader Barcode reader Job.TrackAndTrace.BarcodeReader Automated Verification
Input device None Job.SourceInputDeviceName Base product
Inserter Inserter controller Job.InserterSystem.ID Inserter
Media Media Job.Media Base product
Printer Requested printer Job.RequestedPrinter Base product

The following line shows a simple version of the syntax for specifying associated properties:

Property_to_store@Job_property:Property_label
    Note:
  • If you chose Any printer on the PrintJobs step, you cannot use the Job.RequestedPrinter database name. Replace that name with Job.PreviousPrinter.

The system starts at the colon and reads the properties from right to left. The number of properties in the chain can vary. An @ symbol separates the properties. To the right of the colon is a property label. The property label is required.

These examples give the user interface names of properties with the database names in parentheses. Use the database names when you create the associated properties file.

  • You want to store values for the Printer model printer property (database name Printer.Model.Specific). You can chain the Requested printer job property (database name Job.RequestedPrinter) directly to the printer property.

    When you create the associated properties file, you type this line into a text editor:

    Printer.Model.Specific@Job.RequestedPrinter:Property_label

    The property label might be Job.PrinterModel.

    When the StoreInRepository step runs, RICOH ProcessDirector:

    1. Gets the value of the Requested printer property.

      This value might be Printer4.

    2. Uses the Printer. portion of the Printer.Model.Specific property to identify the next object in the chain: a printer object.
    3. Gets the value of the Printer model property for Printer4.

      This value might be Ricoh Pro C901.

    4. Stores the value of the Printer model property along with other information for the job and its documents in the repository.
        Important:
      • The link between the job property and the object portion of the next property is critical. You must link the Requested printer job property to a printer property. The database name of a printer property starts with Printer. An example at the end of this topic shows how to link a job property to another property through an intermediate property.

  • You have the Automated Verification feature, and you want to store values for the Barcode Format property (database name BarcodeReader.BarcodeFormat). You can chain the Barcode reader job property (database name Job.TrackAndTrace.BarcodeReader) directly to the Barcode Format property. Because the Barcode reader property is positional, you need to specify the Phase and Step identifier.

    You have two different steps that read barcodes, and the barcode readers in the two steps use a different barcode format. You want the barcode reader that the ReadBarcodeData step in the Insert phase uses.

    When you create the associated properties file, you type this line into a text editor:

    BarcodeReader.BarcodeFormat@Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Property_label

    The property label might be Job.BarcodeFormat.

    When the StoreInRepository step runs, RICOH ProcessDirector:

    1. Gets the value of the Barcode reader property for the ReadBarcodeData step in the Insert phase.

      This value might be BarcodeReader2.

    2. Uses the BarcodeReader. portion of the BarcodeReader.BarcodeFormat property to identify the next object in the chain: a barcode reader object.
    3. Gets the value of the Barcode Format property for BarcodeReader2.

      This value might be BarcodeFormat2.

    4. Stores the value of the Barcode Format property along with other information for the job and its documents in the repository.

To create an associated properties file:
  1. With a text editor, create a new file.
  2. Type a line for the first property whose values you want to store.

    Use this syntax:

    Property_to_store@Intermediate_property@Job_property[Phase][Step_identifier]:Property_label

    where:

    • Property_to_store is the database name of the property you want to store.
    • Intermediate_property is the database name of an intermediate property, if needed, that links the job property to the property you want to store by identifying an intermediate object, such as Media. If you need to specify two intermediate properties, separate them with an @ symbol.

      You can link many job properties directly to properties you want to store without an Intermediate_property.

    • Job_property[Phase][Step_identifier] has these parts:
      • Job_property is the database name of the job property that identifies an object such as a printer.

        If you are storing a positional job property, which you cannot select as a value for the Job properties to store property on the StoreInRepository step, Job_property is the database name of the positional job property. You do not need to specify any additional properties.

      • If the property is positional, Phase is the name of the phase that the step is in, and Step_identifier is the internal name of the step with the property.

        If the property is not positional, do not type a [Phase] or [Step_identifier].

    • Property_label is the name that appears on the Properties tab when you click Show details on the Results table of the Archive tab. We recommend the format Job.MyProperty. The property label for each property in the associated properties file must be unique.

    For example, you might type:

    Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Job.BarcodeReader

  3. If you want to store values for a second property, type a line break, and then repeat the previous step for the second property.

    For example, you might type:

    Printer.Model.Specific@Job.RequestedPrinter:Job.PrinterModel

  4. Save the text file.
    For example, you might name the file associatedproperties.txt.
  5. Send the associated properties file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.

The file is now available to use as the value of the Associated properties file property for a StoreInRepository step in a workflow.

When the StoreInRepository step runs, RICOH ProcessDirector stores (with each document and job) the value of each stored property specified in the associated properties file.

  • If the value is null for any stored property on a line of the associated properties file, RICOH ProcessDirector stores a null value for the property.
  • If a property allows multiple selections, RICOH ProcessDirector stores the multiple selections separated by a vertical bar (|). For example, the value of a stored property might be BarcodeReader1|BarcodeReader2.
  • If multiple values are selected for both a job property and the associated object property, RICOH ProcessDirector adds an underscore and the name of the job property value to the property label. RICOH ProcessDirector stores each job property value separately. For example:
    Job.BarcodeFormat_BarcodeReader1    Job.BarcodeFormat_BarcodeReader2
    BarcodeFormat1|BarcodeFormat2          BarcodeFormat3

Users cannot search a repository for these properties. After you search on the Archive tab for job or document properties, RICOH ProcessDirector displays the values of associated properties on the Properties tab when you click Show details on the Results table.

Examples

Storing the model of the printer requested to print a job
  • File contents:
    Printer.Model.Specific@Job.RequestedPrinter:Job.PrinterModel
  • Value of Printer model property:
    Ricoh Pro C901
  • Information stored in the repository for a specific job and each document in the job:
    Job.PrinterModelRicoh Pro C901
  • Information displayed in the properties notebook for the results of a search:

    Job.PrinterModel: Ricoh Pro C901

      Note:
    • When processing an associated properties file, RICOH ProcessDirector does not store or display the value of the Job_property_identifying_object property or any Property_identifying_intermediate_object property.
    • If you chose Any printer on the PrintJobs step, you cannot use the Job.RequestedPrinter database name. Replace that name with Job.PreviousPrinter.

Storing the barcode format used by a barcode reader
  • File contents:
    BarcodeReader.BarcodeFormat@Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Job.BarcodeFormat
  • Barcode readers selected on the ReadBarcodeData step:
    • BarcodeReader1
    • BarcodeReader2
  • Barcode formats selected for BarcodeReader1:
    • BarcodeFormat1
    • BarcodeFormat2
  • Barcode format selected for BarcodeReader2: BarcodeFormat3.
  • Information stored in the repository for a specific job and each document in the job:
    Job.BarcodeFormat_BarcodeReader1    Job.BarcodeFormat_BarcodeReader2
    BarcodeFormat1|BarcodeFormat2          BarcodeFormat3
  • Information displayed in the properties notebook for the results of a search:

    Job.BarcodeFormat_BarcodeReader1: BarcodeFormat1|BarcodeFormat2

    Job.BarcodeFormat_BarcodeReader2: BarcodeFormat3

Storing the reprint method used by an inserter
  • File contents:
    InserterSystem.ReprintMethod@Job.InserterSystem.ID:Job.InserterReprintMethod
  • Value of Reprint method property (database name InserterSystem.ReprintMethod):
    Open loop
  • Information stored in the repository for a specific job and each document in the job:
    Job.InserterReprintMethod
    Open loop
  • Information displayed in the properties notebook for the results of a search:

    Job.InserterReprintMethod: Open loop

Storing the folder location of the input device that received a job
  • File contents:
    InputDevice.FolderLocation@Job.SourceInputDeviceName:Job.InputDeviceFolder
  • Value of Folder location property (database name InputDevice.FolderLocation):
    /aiw/aiw1/System/hf/defaultPDF
  • Information stored in the repository for a specific job and each document in the job:
    Job.InputDeviceFolder
    /aiw/aiw1/System/hf/defaultPDF
  • Information displayed in the properties notebook for the results of a search:

    Job.InputDeviceFolder: /aiw/aiw1/System/hf/defaultPDF

Storing the color of the media requested to print a job
  • File contents:
    MediaType.Color@Media.MediaTypeID@Job.Media:Job.MediaColor
  • Value of Media color property (database name MediaType.Color):
    Ricoh Pro C901
  • Information stored in the repository for a specific job and each document in the job:
    Job.MediaColor
    Blue
  • Information displayed in the properties notebook for the results of a search:

    Job.MediaColor: Blue

    Note:
  • You can replace the Media color property with other media type properties such as Media weight (database name MediaType.Weight) and Media details (database name MediaType.Details).

    To store the values of a media size property, such as Media height (database name MediaSize.Height), use this line:MediaSize.Height@Media.MediaSizeID@Job.Media:Job.MediaHeight

1.2.4.37.9 Workflows that store jobs and data in a repository

Workflows in the Archive feature can be created to store jobs, documents, properties, history information, or a combination of these in one or more repositories. Workflow steps based on the StoreInRepository step template are used to store the files and data.

You can store any type of job, but you can view only AFP and PDF files after they have been archived. You do not have to save jobs or documents to store properties or history information.

1.2.4.37.9.1 Creating a workflow to store jobs, job properties, and job history in a repository

To store jobs, job properties, and job history in a repository, you must create a workflow that includes a step based on the StoreInRepository step template.
Before you create a workflow, plan for retention of files and history, create repositories, and create any history notification objects that are needed.
To create a workflow to store jobs, job properties, and job history in a repository:
  1. Click the Workflow tab.
  2. Right-click a workflow that you want to have write information to a repository and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Insert one or more StoreInRepository steps into the workflow after the steps whose property values or history information you want to store.
  5. Right-click each of the StoreInRepository steps you added, select Properties, and then click Repository:
    1. For the Repository property, select the repository that you want to store job and document data in. If you have more than one StoreInRepository step, you can choose separate repositories or the same repository.
    2. For the Store history records property, change the value to Yes.
    3. If you want to store only properties and history information, clear the value of the File to store property.
    4. If you want to store only properties, clear the value of the File to store property and set the value of the Store history records property to No.
    5. If you want to preserve the values of job properties for use when the job or its documents are resubmitted to a workflow:
      1. Use a text editor to create an override properties file.
      2. Place the database name of each job property on a separate line.
      3. To add a comment, place it on a separate line that starts with a pound sign (#).

        This example shows a file with three job properties (Customer name, Media required, and Duplex) and a comment:

        Job.CustomerNameJob.MediaRequired# This is a comment.Job.Duplex

      4. Name the file, save it, and move it to a directory on the RICOH ProcessDirector primary computer. For example:
        • /aiw/aiw1/control_files/job_properties.txt (Linux)
        • C:\aiw\aiw1\control_files\job_properties.txt (Windows)
      5. On the StoreInRepository step, enter the path and name of the file in the Path to override properties file property.
    6. If you are using an associated properties file, enter the full path and name or the symbolic name of the file in the Associated properties file property.
    7. For the Archive entry type property, enter a name that identifies the specific type of data being captured, such as Preflight, Post-Print, or History Information only. Alternatively, you can enter a value of Print file to indicate that this entry in the repository has the print file associated with it and can therefore be viewed or resubmitted. You can use this property to search for information about the job you want to retrieve.
    8. From the Available job properties to store list, select the job properties that you want to use to search for jobs in the repository.
    9. Click OK.
      Note:
    • Make sure that each of the StoreInRepository steps is in the correct place in the workflow. Storing a file after steps that change the order of pages, such as ReversePDFPageOrder, affects your ability to search using document properties in the viewer.
  6. Optional: Right-click the RetainCompletedJobs step. Select Properties, and then click Job defaults - General. Update the value of the Retention period property. Click OK.
  7. Save and enable the workflow.
  8. To test the workflow:
    1. Create one or more input devices to point to the workflow.
    2. Enable the input devices.
    3. Submit your PDF or AFP print job to the input device.
    4. When the job finishes, look in the Archive to make sure that the right information was stored.
    Note:
  • If a job is processed again and runs the StoreInRepository step more than once, two copies of the job are stored in the repository.

1.2.4.37.9.2 Creating a workflow to store PDF jobs and documents in a repository

To store jobs and documents in a repository, you must create a workflow that includes a step based on the StoreInRepository step template. You can also add StoreInRepository steps to your existing workflows. If you want the repository to hold documents and document data, make sure to add the necessary document processing steps if they are not already present.
Before you create a workflow, plan for retention of files and documents, create repositories, and make enhancements to PDF files.
To create a workflow to store PDF jobs and documents in a repository:
  1. Click the Workflow tab.
  2. Right-click the RepositorySample workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Right-click the IdentifyPDFDocuments step. Select Properties, and then click PDF. For the Identify PDF control file property, type the path and file name of the control file that contains your document property definitions. Click OK.
  5. Right-click the BuildPDFFromDocuments step. Select Properties, and then click PDF. For the Build PDF control file 1 property, type the path and file name of the control file that contains your document property definitions. Click OK.
  6. Optional: Right-click the RetainCompletedJobs step. Select Properties, and then click Job Defaults - General. Update the value of the Retention period property. Click OK.
  7. Right-click the StoreInRepository step, select Properties, and then click Repository:
    1. For the Repository property, select the repository that you want to store jobs and documents in.
    2. From the Available job properties to store list, select the job properties that you want to use to search for jobs and documents in the repository.
    3. From the Available document properties to store list, select the document properties that you want to use to search for documents in the repository.
    4. If you want to preserve the values of job properties for use when the job or its documents are resubmitted to a workflow:
      1. Use a text editor to create an override properties file.
      2. Place the database name of each job property on a separate line.
      3. To add a comment, place it on a separate line that starts with a pound sign (#).

        This example shows a file with three job properties (Customer name, Media required, and Duplex) and a comment:

        Job.CustomerNameJob.MediaRequired# This is a comment.Job.Duplex

      4. Name the file, save it, and move it to a directory on the RICOH ProcessDirector primary computer. For example:
        • /aiw/aiw1/control_files/job_properties.txt (Linux)
        • C:\aiw\aiw1\control_files\job_properties.txt (Windows)
      5. On the StoreInRepository step, enter the path and name of the file in the Path to override properties file property.
    5. If you are using an associated properties file, enter the path and name of the file in the Associated properties file property.
    6. If you want to store document data that is contained in a file but is not defined as a document property to RICOH ProcessDirector, enter the full path and name or the symbolic name of the file in the Document properties file property and make sure to select ALL in the Document properties to store list.
    7. Click OK.
      Note:
    • Make sure that the StoreInRepository step is in the correct place in the workflow. Storing a file after steps that change the order of pages, such as ReversePDFPageOrder, affects your ability to search using document properties in the viewer.
  8. Optional: If you want to store job files in the repository more than once, include additional StoreInRepository steps in the workflow.
  9. Save and enable the workflow.
  10. To test the workflow:
    1. Create one or more input devices to point to the workflow.
    2. Enable the input devices.
    3. Submit your PDF print job to the input device.
    4. When the job finishes, look in the Archive to make sure that the right information was stored.
    Note:
  • If a job is processed again and runs the StoreInRepository step more than once, two copies of the document or job are stored in the repository.

1.2.4.37.9.3 Creating a workflow to store AFP jobs and documents in a repository

To store jobs and documents in a repository, you must create a workflow that includes a step based on the StoreInRepository step template. You can also add StoreInRepository steps to your existing workflows. If you want the repository to hold documents and document data, make sure to add the necessary document processing steps if they are not already present.
Before you create a workflow, plan for retention of files and documents, create repositories, and make enhancements to AFP files.
To create a workflow to store AFP jobs and documents in a repository:
  1. Click the Workflow tab.
  2. Right-click the RepositorySample workflow and select Copy.
    The RepositorySample workflow processes PDF jobs. To change the workflow to process AFP jobs, you must replace some of the steps in the workflow.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Right-click the If PDF connector and select Properties. Change the value of the Rule name property to If AFP. Change the value of the rule condition Value property to AFP. Click OK.
  5. Add a step based on the UseInlineFormDefinition step template at the start of the If AFP conditional processing branch, before the CountPages step.
  6. Replace the CountPages step in the Prepare phase with a step based on the EnableRepositioning step template.
  7. Replace the IdentifyPDFDocuments step with a step based on the IdentifyDocuments step template.
  8. Right-click the IdentifyDocuments step. Select Properties, and then click AFP. For the Visual Workbench control file property, type the path and file name of the control file that you created with Document Property Designer. Click OK.
  9. If your AFP print file is not already indexed, add a step based on the IndexAFP step template before the IdentifyDocuments step.
    This step shares the control file you specified for the IdentifyDocuments step. You do not need to specify the control file here.
  10. Replace the BuildPDFFromDocuments step with a step based on the BuildAFPFromDocuments step template.
  11. Right-click the BuildAFPFromDocuments step. Select Properties, and then click AFP. For the Enhance AFP control file property, type the path and file name of the control file that contains your document enhancements. Click OK.
  12. Replace the CountPages step in the Print phase with a step based on the EnableRepositioning step template.
  13. Optional: Right-click the RetainCompletedJobs step. Select Properties, and then click Job Defaults - General. Update the value of the Retention period property. Click OK.
  14. Right-click the StoreInRepository step, select Properties, and then click Repository:
    1. For the Repository property, select the repository that you want to store job and document data in.
    2. From the Available job properties to store list, select the job properties that you want to use to search for jobs and documents in the repository.
    3. From the Available document properties to store list, select the document properties that you want to use to search for documents in the repository.
    4. If you want to preserve the values of job properties for use when the job or its documents are resubmitted to a workflow:
      1. Use a text editor to create an override properties file.
      2. Place the database name of each job property on a separate line.
      3. To add a comment, place it on a separate line that starts with a pound sign (#).

        This example shows a file with three job properties (Customer name, Media required, and Duplex) and a comment:

        Job.CustomerNameJob.MediaRequired# This is a comment.Job.Duplex

      4. Name the file, save it, and move it to a directory on the RICOH ProcessDirector primary computer. For example:
        • /aiw/aiw1/control_files/job_properties.txt (Linux)
        • C:\aiw\aiw1\control_files\job_properties.txt (Windows)
      5. On the StoreInRepository step, enter the path and name of the file in the Path to override properties file property.
    5. If you are using an associated properties file, enter the path and name of the file in the Associated properties file property.
    6. If you want to store document data that is contained in a file but is not defined as a document property to RICOH ProcessDirector, enter the full path and name or the symbolic name of the file in the Document properties file property and make sure to select ALL in the Document properties to store list.
    7. Click OK.
      Note:
    • Make sure that the StoreInRepository step is in the correct place in the workflow. Storing a file after steps that change the order of pages, such as ReverseOutputOrder, affects your ability to search using document properties in the viewer.
  15. Optional: If you want to store job files in the repository more than once, include additional StoreInRepository steps in the workflow.
  16. Save the workflow.
  17. To test the workflow:
    1. Create one or more input devices to point to the workflow.
    2. Enable the input devices.
    3. Submit your AFP print job to the input device.
    4. When the job finishes, look in the Archive to make sure that the right information was stored.
    Note:
  • If a job is processed again and runs the StoreInRepository step more than once, two copies of the document or job are stored in the repository.

1.2.4.38 Setting up the Postal Enablement feature

Review the overview topics related to Postal Enablement, then run the sample workflows to see how the supplied step templates and workflows can work together. When you feel comfortable with the concepts, define one or more workflows to send jobs to your postal processing software and test them to make sure that they function correctly.

1.2.4.38.1 Running the PrintAndMailJob sample workflow

The PrintAndMailJob sample workflow submits a PDF or AFP file for processing by Ricoh ProcessDirector and the Postal Enablement feature. The workflow simulates sending the job to postal processing software to update addresses as needed and to replace a PostNet barcode with a Datamatrix barcode that identifies the job number and document number that can be used to track the progress of the document through other steps in the workflow.

You can review the sample workflow and run a sample job to understand how the feature works.

The sample files provided for use with this workflow are summarized in the table below.

Filename File Location Specified in property Used by Step Description

PostalPDFReplaceAddr.ctl

/aiw/aiw1/control_files/postal Build PDF control file 1

BuildPDFFromDocuments

Builds a PDF file with the PostNet barcode replaced by a Datamatrix barcode that identifies the job number and document number. Updates addresses as indicated by the postal software.

PostalPDF.ctl

/aiw/aiw1/control_files/postal Identify PDF control file

IdentifyPDFDocuments

Identifies the page groups in the sample PDF print file and defines the data to be extracted in document properties.

postal_doc_print_only.csv

/aiw/aiw1/control_files/postal Property conditions file

SetDocPropsFromConditions

Sets the Postal code property based on the Address processing return code from the postal software so that documents that have replacement addresses available can be identified when the print file is generated.

Postal.pdf

/aiw/aiw1/testfiles Job name  

The sample PDF print file.

Postal.afp

/aiw/aiw1/testfiles Job name  

The sample AFP print file.

jobid.print_and_mail.csv

/aiw/aiw1/testfiles Retrieval pattern

RunHotFolderAppplication

A sample external results file from MailPreparer based on processing of the sample print file. Can be used to move the sample job through the RunHotFolderApplication step to simulate the response from postal software.

PostalAFPReplaceAddr.cfg

/aiw/aiw1/control_files/postal Enhance AFP control file

BuildAFPFromDocuments

Builds an AFP file with the PostNet barcode replaced by a Datamatrix barcode that identifies the job number and document number. Updates addresses as indicated by the postal software.

PostalAFP.ctl

/aiw/aiw1/control_files/postal Visual Workbench control file

IdentifyDocuments

Identifies the page groups in the sample AFP print file and links the index tags in the AFP file with the corresponding document properties.

You can review the properties for each object before you start the procedure to see how they interact.

To run the sample workflow:

  1. Log in to RICOH ProcessDirector.
  2. Copy the PostalFolder input device to create a new hot folder input device.
    1. Click the Administrator tab.
    2. In the left pane, click Devices → Input Devices.
    3. Select the PostalFolder input device and click Actions → Copy.
    4. In the Input device name property, type a name for the hot folder.
    5. In the Child workflow property, select PrintAndMailJob.
    6. In the Folder Location property, update the folder location to a unique filepath.
    7. In the Staging Location property, update the staging location to a unique filepath.
    8. Click OK.
  3. In the Printers portlet, select the Sample printer and click Actions Enable.
  4. In the Input Devices portlet on the Main page, select the newly created hot folder and click Actions → Enable and Connect.
  5. Copy the sample file into the hot folder you created in Step 2. Navigate to /aiw/aiw1/testfiles , and copy Postal.pdf into the directory that you specified in the Folder location property of the input device.

    The system starts processing the job through the PrintAndMailJob workflow. When the job reaches the RunHotFolderApplication step, it waits for results to come from the postal software. The job state changes to Waiting.

  6. Navigate to/aiw/aiw1/testfiles .
  7. Copy jobid.print_and_mail.csv into /aiw/aiw1/postal/receive .
  8. Navigate to /aiw/aiw1/postal/receive and rename jobid.print_and_mail.csv, replacing jobid with the value of the Job Number property for the sample job. For example, if the Job number for the sample job is 10000067, rename the file to 10000067.print_and_mail.csv.
    The RunHotFolderApplication step picks up the file and the job continues to process through the remaining steps in the workflow.
  9. When the job finishes processing, the State column of the Jobs table changes to Complete.
  10. The job is retained for three days and is deleted.
    Note: The sample workflow uses a sample printer that does not print any data. However, the job file can be viewed as it moves through the workflow, so the barcode updates can be observed. For example, you can view the job while it is waiting in the RunHotFolderApplication step to see the PostNet barcode, then view it in the RetainCompletedJob step to see the Datamatrix barcode.

1.2.4.38.2 Running the sample workflows for qualified/non-qualified mail

The sample workflows for qualified and non-qualified mail include GroupDocsForPostalProcess, PrintForPostalProcess, and ProcessQualifiedDocuments. By submitting the sample print job into the GroupDocsForPostalProcess workflow and simulating the results obtained from postal software, you can see three child jobs get created corresponding to different postal categories-- Qualified, Non-Qualified, and Other.

The GroupDocsForPostalProcess workflow collects document data for the postal software, updates the document data based on the output from the postal software, and produces child jobs for each type of mail identified by the postal software. The sample uses results produced by TEC Mailing's MailPreparer software to send documents to two other workflows based on what additional postal processing can be performed to optimize the postal savings.

If the child jobs do not qualify for additional postal processing, they are sent to the PrintForPostalProcess workflow where the PostNet barcode on the original job is removed and a 2D barcode is added for mail piece tracking. Documents classified as Other are sorted by number of sheets and documents classified as Non-qualified are sorted in zip code order but not using postal software.

If the child jobs from GroupDocsForPostalProcess qualify for additional postal processing, the jobs are sent to the ProcessQualifiedDocuments workflow. In the ProcessQualifiedDocuments workflow, the job is processed again by postal software to sort the documents according to postal rules. An Intelligent Mail barcode and a 2D datamatrix barcode is also added to these Qualified documents.

The sample objects used in this workflow include:
  • Hot folder input device: PostalFolder
  • Workflow: GroupDocsForPostalProcess
  • Workflow: PrintForPostalProcess
  • Workflow: ProcessQualifiedDocuments

    The sample files provided for use with these workflows are summarized in the table below.

Filename File Location Specified in property Used by Workflow Used by Step Description

PostalPDFBuildQualify.ctl

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Build PDF control file 1

PrintForPostalProcess

BuildPDFFromDocuments

Builds a PDF file with the PostNet barcode replaced with a Datamatrix barcode that identifies the job number and document number and adds an Intelligent Mail barcode.

PostalPDFBuildOther.ctl

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Build PDF control file 1

PrintForPostalProcess

BuildPDFFromDocumentsOther

Builds a PDF file with the PostNet barcode replaced with a Datamatrix barcode that identifies the job number and document number.

PostalPDFBuildNonQualify.ctl

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Build PDF control file 1

PrintForPostalProcess

BuildPDFFromDocumentsNonQualified

Builds a PDF file with the PostNet barcode replaced with a Datamatrix barcode that identifies the job number and document number.

PostalPDF.ctl

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Identify PDF control file

GroupDocsForPostalProcess

IdentifyPDFDocuments

Identifies the page groups in the sample PDF print file and defines the data to be extracted in document properties.

postal_doc_qualified.csv

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Property conditions file

ProcessQualifiedDocuments

SetDocPropsFromConditions

Sets the workflow for the documents in the job to PrintForPostalProcess. Sets sequence numbers for documents according to the presort sequence returned by the postal sortation software.

postal_doc_print_afp.csv

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Property conditions file

PrintForPostalProcess

SetDocPropsFromConditionsAFP

Sets the child job names to reflect the Processing category. Sets the EnhanceAFP control file name for the child job in each Processing category.

postal_doc_print.csv

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Property conditions file

PrintForPostalProcess

SetDocPropsFromConditions

Sets the child job names to reflect the Processing category.

postal_doc.csv

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Property conditions file

GroupDocsForPostalProcess

SetDocPropsFromConditions

Maps MailPreparer return codes for each document to Processing category values ( Non-qualified, Qualified, and Other). Sets the workflow name for the child jobs that are created based on the GroupDocuments step.

Postal.pdf

/aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows) Job name    

The sample PDF print file.

Postal.afp

/aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows) Job name    

The sample AFP print file.

jobid.qualified_doc.csv

/aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows) Retrieval pattern

ProcessQualifiedDocuments

RunHotFolderAppplication

A sample external results file from MailPreparer based on processing the child job created for only documents that MailPreparer determined were qualified for postal sortation. Can be used to move the sample job through the RunHotFolderApplication step to simulate the response from postal software.

jobid.group_doc.csv

/aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows) Retrieval pattern GroupDocsForPostalProcess RunHotFolderAppplication A sample external results file from MailPreparer based on processing of the sample print file. Can be used to move the sample job through the RunHotFolderApplication step to simulate the response from postal software.

PostalAFPBuildQualify.cfg

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Enhance AFP control

PrintForPostalProcess

BuildAFPFromDocuments

Builds an AFP file with the PostNet barcode replaced with a Datamatrix barcode that identifies theJob number and Document number and adds an Intelligent Mail barcode.

PostalAFPBuildOther.cfg

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Enhance AFP control

PrintForPostalProcess

BuildAFPFromDocumentsOther

Builds an AFP file with the PostNet barcode replaced with a Datamatrix barcode that identifies the Job number and Document number.

PostalAFPBuildNonQualify.cfg

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Enhance AFP control

PrintForPostalProcess

BuildAFPFromDocumentsNonQualify

Builds an AFP file with the PostNet barcode replaced with a Datamatrix barcode that identifies the Job number and Document number.

PostalAFP.ctl

/aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) Visual Workbench control file

GroupDocsForPostalProcess

IdentifyDocuments

Identifies the page groups in the sample AFP print file and links the index tags in the AFP file with the corresponding document properties.

To run the sample workflow:

  1. Log in to RICOH ProcessDirector.
  2. Click the Main tab.
  3. In the Printers portlet, select the Sample printer and click Actions →Enable.
  4. In the Input Devices portlet, select the PostalFolder hot folder input device and click Actions → Enable and Connect.
    The first time you run this procedure, RICOH ProcessDirector immediately submits the Postal.pdf job to the GroupDocsForPostalProcess workflow.

    The system starts processing the job through the GroupDocsForPostalProcess workflow. When the job reaches the RunHotFolderApplication step, it waits for results to come from the postal software. The job state changes to Waiting.

  5. To simulate results being returned by the postal software, navigate to /aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows) and copy jobid.group_doc.csv into/aiw/aiw1/postal/receive (Linux) or C:\aiw\aiw1\postal\receive (Windows).
  6. Navigate to /aiw/aiw1/postal/receive (Linux) or C:\aiw\aiw1\postal\receive (Windows) and rename jobid.group_doc.csv, replacing jobid with the Job Number of the sample job you submitted. For example, if the Job number for the sample job is 10000067, rename the file to 10000067.group_doc.csv.
  7. The job moves on to the SetDocPropsFromConditions step where the sample property conditions file sets the Processing category for each document ( Qualified, Non-qualified or Other). The value of the Processing category property determines the next workflow for the document. The CreateJobsFromDocuments step creates the child jobs based on those document properties.
    • Documents with a Processing category of Non-Qualified are grouped into a child job that is sent to the PrintForPostalProcess workflow. In that workflow, the PostNet barcode is replaced with a 2D barcode that can be used to track the progress of the document through other steps in the workflow. In addition, the documents are sorted in ascending order of zip code.
    • Documents with a Processing category of Other are grouped into a child job that is sent to the PrintForPostalProcess workflow. In that workflow, the PostNet barcode on each document is replaced with a 2D barcode that can be used to track the progress of the document through other steps in the workflow. In addition, the documents are sorted in ascending order of the number of sheets.
    • Documents with a Processing category of Qualified are grouped into a child job that is sent to the ProcessQualifiedDocuments workflow. That workflow sends the child job through the postal software again to sort the documents. When the job reaches the RunHotFolderApplication step, it waits for results to come from the postal software. The job state changes to Waiting.
  8. To simulate the results being returned by the postal software for the ProcessQualifiedDocuments workflow, navigate to /aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows) and copy jobid.qualified_doc.csv into /aiw/aiw1/postal/receive (Linux) or C:\aiw\aiw1\postal\receive (Windows).
  9. Navigate to /aiw/aiw1/postal/receive (Linux) or C:\aiw\aiw1\postal\receive (Windows) and rename the file jobid.qualified_doc.csv, replacing jobid with the Job Number of the child job. For example, if the Job number for the child job is 10000067.3, rename the file to 10000067.3.qualified_doc.csv.
  10. The Qualified child job resumes processing. Because the workflow specifies that each postal container can hold 50 documents, the job is broken into multiple child jobs (grandchild jobs) with a maximum of 50 documents per job. Those child jobs are sent to the PrintForPostalProcess workflow. That workflow adds Intelligent Mail barcodes to the documents.
  11. When each child job from the original job finishes, it is retained for three days and is then deleted. The parent job does not leave the system until all of the children (and grandchildren) have completed.
      Note:
    • The sample workflow uses a sample printer that does not print any data. However, the job file can be viewed as it moves through the workflow, so the barcode updates can be observed. For example, you can view the job while it is waiting in the RunHotFolderApplication step to see the PostNet barcode, then view it in the RetainCompletedJob step to see the Datamatrix barcode.

      If you want to run the example again, you must copy the sample file to the hot folder. The sample file, Postal.pdf, is in /aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows).

      If you want to run the sample AFP file, you must copy the sample file to the hot folder. The sample file, Postal.afp, is in /aiw/aiw1/testfiles (Linux) or C:\aiw\aiw1\testfiles (Windows).

1.2.4.38.3 Creating a workflow to exchange data with postal software

You can create a workflow, or a set of workflows, to extract mailing address data from the documents in a job and prepare the data for processing by external postal software. After the postal software verifies the addresses and improves their quality, the workflow can process results received from the postal software to update the documents in the job.
The Postal Enablement feature does not provide postal software. You can use your choice of external postal software, for example, the Bell and Howell BCC Mail Manager software or the TEC Solutions MailPreparer software. You must understand what information your postal software needs to perform the postal processing that you want. You also need to know how to connect the postal software to RICOH ProcessDirector.
To create a workflow to exchange data with postal software:
  1. Identify the job and document data that you need to exchange with the postal software.
    1. Identify the data that your postal software requires for each mail piece.
      The postal software requires name and address data in a specific format.

      If you are using the postal software to compute postage, the software might need information about mail piece weight and thickness. Some postal software assumes that all mail pieces in a job have uniform weight and thickness. Other postal software lets you specify different values for each mail piece.

    2. Identify the data that your postal software requires for each job.
      For example, you might need to specify Mailer ID and Postage statement date.
    3. Identify the RICOH ProcessDirector job and document properties that correspond to the data required by your postal software.
      The Postal Enablement feature provides a large number of job and document properties for use with postal software. For job properties, examine the properties notebook for the SetPostalJobProps step template. For document properties, examine the properties notebook for the BuildExternalDocPropsFile step template. Select from the document properties on the Available list.
    4. If you need custom document properties, edit the docCustomDefinitions.xml file and then run the docCustom utility to define the properties to the system. See RICOH ProcessDirector: Installing Document Processing Features for instructions.
  2. If your print file is in PDF format, do these steps:
    1. Follow the instructions in the Information Center to enhance PDF files for Postal Enablement.
      These instructions explain how to identify the start of each mail piece in a job, define document properties to extract address data from each mail piece, and make changes to the PDF file based on the data returned by the postal software.
    2. Save your document property definitions in a control file for use with a step based on the IdentifyPDFDocuments step template.
    3. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
    4. If you are making changes to the PDF file based on the data returned by the postal software (for example, adding a barcode or replacing the address), save your document property definitions and updated address data in a control file with a different name from the control file in the previous step. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
      This new control file is used with a step based on the BuildPDFFromDocuments step template.
  3. If you have the AFP Support feature installed and your print file is in AFP format, do these steps:
    1. Follow the instructions in the Information Center to enhance AFP files for Postal Enablement.
      These instructions explain how to identify the start of each mail piece in a job, define document properties to extract address data from each mail piece, and make changes to the AFP file based on the data returned by the postal software.
    2. Save the control file created by RICOH Visual Workbench and send it to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
      This control file is used with a step based on the IdentifyDocuments step template.
    3. If you are making changes to the AFP file based on the data returned by the postal software (for example, adding a barcode or replacing the address), save your document property definitions and updated address data in an Enhance AFP control file. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
      The Enhance AFP control file is used with a step based on the BuildAFPFromDocuments step template.
  4. Log in to RICOH ProcessDirector as an administrator.
  5. Click the Workflow tab.
  6. Copy the workflow that best meets your processing needs:
    • If you do not need to change how documents are processed based on results from the postal software, right-click the PrintAndMailJob workflow, and select Copy.

      The PrintAndMailJob workflow collects document data to send to postal software and uses a step based on the RunHotFolderApplication step template to exchange files with the postal software. After receiving the output of the postal software, the workflow updates the document data and prints the job for mailing. If you have RICOH ProcessDirector, the workflow processes both AFP and PDF print jobs. If you are using only one format, you can delete the steps in the branch for the other format.

    • If you need to take results from the postal software and split a job into child jobs that are processed by different workflows, right-click the GroupDocsForPostalProcess workflow, and select Copy.

      GroupDocs ForPostalProcess is part of a set of three workflows:

      • GroupDocsForPostalProcess

        This workflow collects document data to send to postal software and updates the document data from the output of the postal software. Using rules that you set up to interpret the data, the workflow produces child jobs for each type of mail that the postal software identified. The workflow is configured to pass the child jobs to one of the next two workflows.

      • ProcessQualifiedDocuments

        This workflow processes child jobs created by the GroupDocsForPostalProcess workflow if the documents in the job qualified for additional postal processing. The workflow sorts the documents, using the optimal method determined by the postal software, and passes the child jobs to the PrintForPostalProcess workflow.

      • PrintForPostalProcess

        This workflow prints the child jobs created by the GroupDocsForPostalProcess workflow. The child jobs contain qualified, nonqualified, and other types of mail. The workflow makes sure that the order of documents within each job is correct for each type of mail.

      After you copy the GroupDocsForPostalProcess workflow, determine how many additional workflows you need to perform postal processing at your company.

  7. Name the copy of the workflow, fill in or edit other values that you need, and click OK.
  8. If you have both the AFP Support and PDF Document Support features installed, these workflows process both AFP and PDF print jobs. If you only have one of those features installed, delete the steps in the branch for the other format.
  9. If the workflow process PDF jobs, right-click the IdentifyPDFDocuments step. Select Properties, and then click PDF. For the Identify PDF control file property, type the path and file name of the control file that contains your document property definitions. Click OK.
  10. If you have the AFP Support feature installed and the workflow processes AFP jobs, do these steps:
    1. Right-click the IdentifyDocuments step. Select Properties, and then click AFP. For the Visual Workbench control file property, type the path and file name of the control file that you created with Document Property Designer. Click OK.
    2. If your AFP print file is not already indexed, add a step based on the IndexAFP step template before the IdentifyDocuments step.
      This step shares the control file you specified for the IdentifyDocuments step. You do not need to specify the control file here.
  11. Right-click the SetPostalJobProps step. Select Properties, and then click Postal. Specify the values of the properties for the job. Click OK.
  12. Right-click the BuildExternalDocProps step. Select Properties , and then click Document processing. Do these steps:
    1. For the External document properties file property, specify the name and location that you want to use for the external document properties file.
      The default value writes a file named jobID.ToPostal.csv to the job's spool directory.
      When RICOH ProcessDirector creates this file, it converts the document properties file into the format required by the postal software.
    2. For the File type property, select CSV or Tab-delimited.
    3. From the Document properties list, select the document properties that you saved in the control file for the IdentifyPDFDocuments step (PDF) or the IdentifyDocuments step (AFP).
        Important:
      • Make sure that you include the Document number or Sequence in job property.
    4. In the Column headings field, type the names of the column headings required by postal software for the document properties. Use commas to separate the names, even if you selected Tab-delimited for the file type.
      The order of the headings must match the order of the selected document properties.
    5. Click OK.
  13. Based on the capabilities of the postal software, choose an interface with RICOH ProcessDirector:
    • RunHotFolderApplication step

      If your software can receive data using a hot folder, use this step to send and receive files containing document information that the postal software requires. You must:

      • Configure the postal software to watch a directory for a file with a specific name or filetype.
      • Configure the postal software to write its output to a directory with known filename characteristics.
      • Set up the network (for example, NFS or SAN), file permissions, and so on to share the directories defined for input and output on the RunHotFolderApplication step.

      The sample workflows provided with the Postal Enablement feature use this step with example directory names.

    • RunExternalProgram step

      If your software accepts command line input, use this step to run the postal software directly in the workflow.

      • The postal software must have a command line invocation that can be run on the primary RICOH ProcessDirector server. If you have RICOH ProcessDirector, the command line invocation also can be run on a secondary server or a Windows application server.
      • You must use standard RICOH ProcessDirector methods, such as ${getFileName(postal,bcc,read)}, to reference the files exchanged with the postal software.

    • SendEmail and ManualStepWithAutoStart steps

      Use these steps for a manual interface with the postal software. The SendEmail step sends the output file to a person who submits the file to the postal software while the job waits in the ManualStepWithAutoStart step. The person puts the results file returned by the postal software into the workflow where the MapExternalResultsFiletoDocProps step expects to find the file. The person then does a Manual Complete action to let the job continue through the workflow to the MapExternalResultsFiletoDocProps step.

  14. If you are using the RunHotFolderApplication step to interface with the postal software, do these steps:
    1. Right-click the RunHotFolderApplication step. Select Properties, and then click Job Defaults.
    2. Specify values for the Sending folder, File to send, Retrieval folder, Retrieval pattern, and Retrieved file properties.
    3. Specify values for other properties as needed.
    4. Click OK.
  15. If you are using the RunExternalProgram step to interface with the postal software, do these steps:
    1. Delete the RunHotFolderApplication step and replace it with the RunExternalProgram step.
    2. Right-click the RunExternalProgram step, select Properties, and then click External.
    3. Specify the command line invocation for the postal software in the External command field.
    4. Specify other values as needed.
    5. Click OK.
  16. If you are using the SendEmail and ManualStepWithAutoStart steps to interface with the postal software, do these steps:
    1. Delete the RunHotFolderApplication step and replace it with the SendEmail step.
    2. Add the ManualStepWithAutoStart step to the workflow after the SendEmail step.
    3. Right-click the SendEmail step. Select Properties, and then click Email.
    4. For the Recipient address property, specify the email address.
    5. Specify the other values as needed.
        Note:
      • If you have not already specified SMTP server settings, you should specify them to enable the email function. After you save the workflow, you can access the settings by clicking the Administration tab on the Main page. In the left pane, click System Settings.
    6. Click OK.
    7. Right-click the ManualStepWithAutoStart step, and select Properties.
    8. Specify values as needed.
    9. Click OK.
  17. Right-click the MapExternalResultsFileToDocProps step. Select Properties, and then click Document processing. Do these steps:
    1. For the Modified results file property, specify the name and location that you want to use for the modified results file.
    2. For the External results file property, specify the name and location that you want to use for the external document properties file that is returned from the postal software.
    3. For the File type property, select the type of the external results file: CSV or Tab-delimited.
    4. For the External results contain column headings property, select Yes or No.
      If the external results file does not contain column headings, you must edit the results file to contain only the columns of data that map to the list of selected properties. The number and order of columns in the external results file must match the number and order of the document properties in the Selected list.
    5. If the external results file contains column headings, type the names of the column headings that you want to keep in the Columns to keep field. Use commas to separate the names.
    6. From the Document properties list, select the document properties that correspond to the column headings that you are keeping.
      The order of the document properties must match the order of the column headings. The step uses this Information to create a modified results file.
    7. Click OK.
  18. You can use the information in the modified results file to have other RICOH ProcessDirector steps do additional processing of the document data before the data is merged into the document properties file.
  19. Right-click the UpdateDocPropsFromExtResultsFile step. Select Properties, and then click Document processing. For the Modified results file property, type the path to and name of the file. Click OK.
    This step merges the document data in the modified results file with the original document properties file that was created in the IdentifyPDFDocuments step for PDF jobs or the IdentifyDocuments step for AFP jobs.

    The document data from your postal software is now in RICOH ProcessDirector. The data can be used by a variety of RICOH ProcessDirector steps.

  20. If you want to set job properties based on document properties, do these steps:
    1. With a text editor, create a properties conditions file.
    2. Define the logic required to group documents for additional processing.
      Four sample properties conditions files are in the /aiw/aiw1/control_files/postal directory (on Linux) or the C:\aiw\aiw1\control_files\postal directory (on Windows):
      • postal_doc.csv
      • postal_doc_qualified.csv
      • postal_doc_print.csv
      • postal_doc_print_afp.csv
      For more information, see the topic on the SetDocPropsFromConditions step template in the information center.
      The GroupDocsForPostalProcess workflow uses a properties conditions file to place documents in child jobs for additional processing by the ProcessQualifiedDocuments workflow, the PrintForPostalProcess workflow, or both.
    3. If you are editing a copy of the PrintAndMailJob workflow, add a step based on the SetDocPropsFromConditions step template to the workflow.
    4. Right-click the SetDocsPropsFromConditions step. Select Properties, and then click Documents. For the Property conditions file property, type the path to and name of the file. Click OK.
  21. If the workflow processes PDF jobs, right-click the BuildPDFFromDocuments step. Select Properties, and then click PDF. For the Build PDF control file 1 property, type the path and file name of the control file that contains your document property definitions and address replacement data. Click OK.
      Note:
    • The GroupDocsForPostalProcess workflow does not have a BuildPDFFromDocuments step. If you have been editing a copy of GroupDocsForPostalProcess, you can copy the PrintForPostalProcess workflow and edit the BuildPDFFromDocuments step in that workflow, or you can create a workflow to perform the job processing you need. If you edit a copy of the PrintForPostalProcess workflow, you can use different control files for each processing path.
  22. If the workflow processes AFP jobs, right-click the BuildAFPFromDocuments step. Select Properties, and then click Documents. For the Enhance AFP control file property, type the path and file name of the Enhance AFP control file that you created. Click OK.
    If you edit a copy of the PrintForPostalProcess workflow, you can use different Enhance AFP control files for each processing path.
  23. Save the workflow.
  24. To test the workflow, do these steps:
    1. Create one or more input devices to point to the workflow.
    2. Enable the input devices.
    3. Submit your PDF or AFP print job to the input device.
  25. If you want to process reports from the postal software that are required for your postal service, you can add steps to your workflow to receive those reports along with the external results file and use a step based on the CopyToFolder step template to submit the report files for printing in their own workflow.
    Another approach is to build a workflow that emails the reports to users. If the reports are in a specified directory with a specified name, the SendEmail step can email them to a recipient that you specify on the step.

1.2.4.38.4 Enhancing PDF files for Postal Enablement

To process sample PDF files for Postal Enablement, use RICOH ProcessDirector Plug-in for Adobe Acrobat to enhance the files. The files must have a page group, which identifies documents, and document properties required for the external postal software. The files might have other markup, such as a barcode that contains updated address data from the postal software.
Install RICOH ProcessDirector Plug-in for Adobe Acrobat by following the instructions in RICOH ProcessDirector: Installing Document Processing Features.

For detailed information about the RICOH ProcessDirector Plug-in for Adobe Acrobat functions that you use in this procedure, such as Define Multiple Properties, Add Text, and Add Barcode, see RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.

To enhance PDF files for use with Postal Enablement:
  1. Open a PDF file in Adobe Acrobat Professional and click Ricoh Select to make RICOH ProcessDirector Plug-in for Adobe Acrobat the active tool.
  2. Draw a box around the text you want to use to define text-based page groups, or draw a box anywhere to define page groups that are not based on text. Click Define Page Group.
    1. From the Page Groups drop-down menu, select Create fixed-length page groups or Begin page group when the selected text is found.
      You can define a page group based on a fixed number of pages or based on text that appears repeatedly throughout the PDF file. For example, if Page 1 appears on the first page of each document, you can use that text to define page groups.
        Other:
      • If you use text to define the beginning of the page group, this text should appear in the same location on the first page of every document.

      • If you are using a sample PDF file to define page groups, make sure that the content and location of the text you select are consistent among the production PDF files.

    2. Click OK.
  3. Click Ricoh View Page Group Navigator and verify that the documents in the PDF file have been defined correctly.
  4. To define document properties that correspond to the data required by your postal software, do one of these:
    • If the document properties that you need are listed in the table below, click Ricoh Preferences. Click the Address tab and select Address lines 1–7 or U.S. addresses. Click Ricoh Define Address Block and draw a box around the mailing address. Check to make sure that each document property has the proper value, and then click OK.

      The Define Address Block function defines a set of document properties for mailing addresses. You can select either Address lines 1–7 or U.S. addresses.

      Note: You cannot change the mapping of the document properties in either set.

      Address lines 1-7 U.S. addresses
      Doc.Address.1 Doc.Address.FullName
      Doc.Address.2 Doc.Address.Other
      Doc.Address.3 Doc.Address.Secondary
      Doc.Address.4 Doc.Address.Primary
      Doc.Address.5 Doc.Address.City
      Doc.Address.6 Doc.Address.State
      Doc.Address.7 Doc.Address.ZipCode

    • If the document properties that you need are not listed in the table above, click Ricoh Define Multiple Properties and draw a box around the mailing address.

      Select the most complicated and longest address in the sample PDF file. For example, if addresses have from three to five lines, select an address with five lines.

      You can define a single document property for a line of text. Alternatively, you can define multiple document properties for a line of text by clicking the Edit icon icon and defining text modifier rules to extract a portion of the data on the line. For example, you can extract the city, state, province, or postal code and define it as a document property.

  5. When you are ready to save your page group definition and document properties, click Ricoh Save Control File.
  6. Give the control file a name or accept the default value. Click Save. You see a confirmation message. Click OK.
  7. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
    Note: When you create your Postal Enablement workflow, specify the name and location of the control file in each step based on the IdentifyPDFDocuments step template.
  8. To clear the markup in the control file that you saved, click Ricoh Clear Markup.
  9. Click Ricoh Define Page Group and define the same page group that you defined in the control file that you specified in the step based on the IdentifyPDFDocuments step template.
  10. If you want to replace the original mailing address data with updated data returned by the postal software, create a new control file. Do these steps:
    1. Click Ricoh Hide Area and draw a box around the mailing address.
      Make sure that the box covers all the addresses in the sample PDF file. Any portion of an address that extends beyond the box is not going to be covered.
    2. Click Ricoh Add Text and define the content of the text by specifying document properties with updated data returned by the postal software.
  11. Optional: Click Ricoh Add Barcode to define a barcode with the mailing address data returned by the postal software.
  12. When you are ready to save your markup, click Ricoh Save Control File.
  13. Give the control file a name or accept the default value. Click Save. You see a confirmation message. Click OK.
  14. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
    Note: When you create your Postal Enablement workflow, specify the name and location of the control file in each step based on the BuildPDFFromDocuments step template.

1.2.4.38.5 Enhancing AFP files for Postal Enablement

Most AFP files that are submitted to RICOH ProcessDirector need to be enhanced before they can be processed for Postal Enablement.
If you plan to use AFP Indexer to enhance AFP files, you must purchase and install the AFP Support feature.
To enhance AFP files for use with Postal Enablement:
  1. If the AFP file does not have page group triggers (which identify the start of each mail piece in a job) or index tags defined for the mail piece data that you want to extract, AFP Indexer to add that information. Do these steps:
    1. Open the AFP file in the RICOH Visual Workbench.
    2. Select IndexAFP.
    3. Define the triggers that identify document boundaries.
    4. Add index tags for the mailing address data that you want to extract.
  2. Use the Document Property Designer (DPD) mode to link each document property that your postal software requires to an index tag in the AFP file. Do these steps:
    1. Open the AFP file in the RICOH Visual Workbench and select the DPD mode.
    2. Double-click the document property name at the bottom of the window.
    3. Supply the requested information in the Define link options dialog.
      When a document property is linked to an index tag, the value of the document property is the same as the value of the indexed data.
    For more information, see the topics related to RICOH Visual Workbench and Document Property Designer.
  3. Save the control file created by RICOH Visual Workbench and send it to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
    The control file contains Document Property Designer definitions.
    Note: When you configure your Postal Enablement workflows, specify the name of the Visual Workbench control file in a step based on the IdentifyDocuments step template.
  4. Optional: Use the AFP Enhancer mode in RICOH Visual Workbench to edit an Enhance AFP control file if you want to:
    • Create a barcode with the updated mailing address data returned by the postal software.
    • Replace the original mailing address data with updated data returned by the postal software.
    • Hide areas that contain unwanted content.
    Four sample Enhance AFP control files in the /aiw/aiw1/control_files/postal (Linux) or C:\aiw\aiw1\control_files\postal (Windows) directory replace a PostNet barcode with a Datamatrix barcode that identifies the job number and document number:
    • PostalAFPReplaceAddr.cfg

      This control file also replaces any addresses for which the postal software returned updated address data.

    • PostalAFPBuildQualify.cfg

      This control file also adds an Intelligent Mail barcode.

    • PostalAFPBuildNonQualify.cfg

    • PostalAFPBuildOther.cfg

  5. Click Tools Export EnhanceAFP Control File to export the Enhance AFP control file and send it to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.
    Note: When you configure your Postal Enablement workflows, specify the name of the Enhance AFP control file in the step based on the BuildAFPFromDocuments step template.

1.2.4.39 Setting up the Automated Verification feature

After you read the Automated Verification overview topics, run the VerifySample workflow. You can then set up Automated Verification by doing the configuration tasks described in this section.

After the initial configuration is complete, test your Automated Verification workflow to make sure it works as you expect it to.

1.2.4.39.1 Running the Automated Verification sample workflow

The Automated Verification feature provides a sample workflow that you can examine and run to understand how the feature works. The sample includes a barcode format, a barcode reader, a hot folder input device with a pre-submitted PDF file, and a workflow that includes the ReadBarcodeData step.
The sample objects used in this workflow are:
  • Barcode reader: SampleReader

  • Barcode format: SampleFormat

  • Hot folder input device: VerificationFolder

  • Sample print job: Verify.pdf

  • Workflow: VerifySample

You can review the properties for each object before you start the procedure to see how they interact.

To run the sample workflow:

  1. Click the Main tab.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. In the Input Devices portlet, right-click the VerificationFolder hot folder input device and select Enable and Connect.

    The first time you try this procedure RICOH ProcessDirector immediately submits the Verify.pdf job to the VerifySample workflow. The job stops when it enters the Reading Barcodes state. Because there is no camera or barcode reader connected to the system, no barcodes are read.

    Make sure that the job is in the Reading Barcodes state before moving to the next step.

  4. In the Jobs table, right-click the job and select Complete barcode step. You can see that the results report zero barcodes read. Click OK.
  5. When the job enters the Waiting to reconcile state, right-click the job and select Reconcile.
  6. In the Documents table, review the Action column for each document. The Action column shows Reprint for all the documents and Attention for the Status 1 property because no barcodes were read. To change the action for a document, select the document:
    • To print the document again, click Reprint.
    • To mark the document OK without printing it again, click Mark OK.
    • To mark the document pulled from the job without printing it again, click Pull.
    You see the action that you requested in the Requested action column, and the counts in the Current column of the summary table change.
  7. When you finish, click OK.
  8. If you chose to reprint some documents, select a printer, review your selections, and then click Yes.
    RICOH ProcessDirector creates a child job that contains the documents to be reprinted. The job number of the child job is the original job number with a numeric suffix (for example, 10000001.1).

    The child job starts processing from the first step in the VerifySample workflow. Because the child job has already been processed into documents, it follows the PDF Reprints path through the workflow and returns to the ReadBarcodeData step.

    After the child job is created, the original job moves to the next step in the workflow.

  9. If all the documents in the child job have a status of OK or Pulled, the child job moves to the next step in the workflow.
If you want to run the example again, you must copy the sample file to the hot folder again. The sample file, Verify.pdf, is in aiw/aiw1/testfiles directory.

1.2.4.39.2 Creating barcode readers

Barcode readers represent the cameras and barcode scanners in your system that read barcodes on documents in a print job to verify that each document has been processed. Each camera or barcode scanner requires a barcode reader.
To create a barcode reader:
  1. Click the Administration tab.
  2. In the left pane, click Devices Barcode Readers.
  3. Click Add.
  4. To add one or more barcode readers:
    1. In the Name field, type the name you want to name the barcode reader.
    2. In the IP address field, specify the IP address or hostname that RICOH ProcessDirector uses to connect to the camera or barcode scanner you want to use with the barcode reader.
    3. In the Port field, specify the port that RICOH ProcessDirector uses to connect to the camera or barcode scanner.

      Only one barcode reader can use a given combination of IP address and port.

    4. In the Description field, type a description of the barcode reader.

      For example, the description could include details of where the camera or barcode scanner is placed.

    5. In the Barcode format field, select the barcode format you want this barcode reader to use.

      Each barcode reader must have at least one barcode format, although a barcode reader can have more than one barcode format. The barcode formats must match the barcodes that are on the printed documents that the barcode reader is set to read. If more than one barcode format is specified, the properties in the barcode must be in the same position in the barcode for all the barcode formats.

    6. In the Barcode reader location field, select a location to associate with the barcode reader.
  5. Click OK.

1.2.4.39.3 Defining a workflow that uses barcodes to track jobs

You can define a workflow that reads barcodes on documents in a job. The workflow reconciles the documents with barcodes that were read against the total documents in the job. The workflow can reprint any documents that were not accounted for during reconciliation.

Before you create a workflow, make sure that you have completed these tasks:

  • For PDF jobs, use the RICOH ProcessDirector Plug-in for Adobe Acrobat to create a control file that identifies page groups.
  • For PDF jobs, use the RICOH ProcessDirector Plug-in for Adobe Acrobat to create a control file that generates barcodes to add to documents.
  • For AFP jobs, make sure that the jobs already contain page groups. If you want to use the Verification recipient property, use Document Property Designer to make a Visual Workbench control file.
  • For AFP jobs, create a control file that generates barcodes to add to documents. Use the sample control file or the AFP Enhancer mode of RICOH Visual Workbench.

To define a workflow that uses barcodes to track jobs:
  1. Click the Workflow tab.
  2. Right-click a workflow that you want to use as a model, such as VerifySample, and select Copy.
    If your workflow does not include IdentifyPDFDocuments, BuildPDFFromDocuments, ReadBarcodeData, Reconcile, and CreateReprints steps, add them.
      Note:
    • The IdentifyPDFDocuments and BuildPDFFromDocuments steps are for PDF jobs. A workflow that processes AFP jobs must have IdentifyDocuments and BuildAFPFromDocuments steps instead. An EnableRepositioning step is also recommended for AFP jobs.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. If the workflow processes PDF jobs:
    1. Right-click the IdentifyPDFDocuments step and select Properties.
    2. On the PDF tab, find the Identify PDF control file property. Type the path to the control file containing the page groups that you created with RICOH ProcessDirector Plug-in for Adobe Acrobat.
    3. Click OK.
    4. Right-click the BuildPDFFromDocuments step and select Properties.
    5. On the PDF tab, find the Build PDF control file 1 property and type the path to the control file that you created with RICOH ProcessDirector Plug-in for Adobe Acrobat to generate barcodes.
    6. Click OK.
  5. If the workflow processes AFP jobs:
    1. Right-click the IdentifyDocuments step and select Properties.
    2. On the AFP tab, find the Visual Workbench control file property and type the path to the control file that you created with Document Property Designer.
        Note:
      • The Automated Verification feature requires that AFP jobs already contain page groups. If your jobs do not have page groups defined, you can use AFP Indexer to add them.
    3. Click OK.
    4. Right-click the BuildAFPFromDocuments step and select Properties.
    5. On the Documents tab, find the Enhance AFP control file property and type the path to the control file. The control file is created using the sample control file or the AFP Enhancer mode in RICOH Visual Workbench.
    6. Click OK.
  6. Right-click the ReadBarcodeData step and select Properties. On the Verification tab, update these properties:
    1. For the Barcode Reader property, select the barcode reader that is going to read the barcodes on the documents in this step.
    2. For the Complete step when all barcodes are read property, select Yes if you want jobs to move to the next step when all barcodes have been read. Otherwise, select No.
    3. For the Results file inactivity timer property, specify the amount of time that RICOH ProcessDirector waits for updates to the results file before moving the job to the next step.
      For example, you want RICOH ProcessDirector to wait 10 minutes before moving the job to the next step regardless of whether all barcodes have been read. Specify 10 minutes and select No for the Complete step when all barcodes are read property.
    4. Select the Document status property (for example, Document status 1) that the step updates with OK when the barcode on a document is read.
        Note:
      • If 2 or more ReadBarcodeData steps process a job, we recommend that you set each Document status property to a different value.
    5. Select the Document scan time property (for example, Document scanned 1) that the step updates with the date and time when the barcode on a document is read.
        Note:
      • If 2 or more ReadBarcodeData steps process a job, we recommend that you set each Document scan time property to a different value.
    6. Click OK.
  7. Right-click the Reconcile step and select Properties. On the Reconcile tab:
    1. For the Automatic reconciliation property, select one of these values:
      • Select Yes if you want RICOH ProcessDirector automatically to reconcile and reprint documents whose barcodes were not found in the ReadBarcodeData step.
      • Select No if you want an operator manually to reconcile documents whose barcodes were not found in the ReadBarcodeData step.
    2. For the Maximum documents to reprint (%) property, specify the maximum percentage of documents in a job that RICOH ProcessDirector can schedule for reprint during automatic reconciliation. If more than this percentage of documents must be reprinted, RICOH ProcessDirector places the job in the Waiting to reconcile state for manual reconciliation by an operator.
    3. For the Requested reprint printer property, select the printer to reprint documents whose barcodes were not found.
    4. Click OK.
  8. Right-click the CreateReprints step and select Properties. On the Reconcile tab:
    1. For the Reprint workflow property, do one of these steps:
      • Select Not set if you want the reprint job to start over in the same workflow that the CreateReprints step is in.

        The sample workflow checks whether a job is a reprint job. If it is, a branch omits steps that are not needed when reprinting documents.

      • Select the name of a different workflow if you want the reprint job to move to the first step in that workflow.
    2. Click OK.
  9. To make sure that the original job stays in the system until all the reprint jobs have completed, add a step based on the WaitForRelatedJobs step template. Place the step before the RetainCompletedJobs step. The retention period does not start for any of the jobs until all documents from the original job have been accounted for in the reconciliation process.
  10. Save and enable the workflow.

1.2.4.39.4 Enhancing PDF files for Automated Verification

To process PDF files for Automated Verification, use RICOH ProcessDirector Plug-in for Adobe Acrobat to enhance the files. The files must have a page group, which identifies documents, and a verification barcode that contains the Job number job property and the Sequence in child job document property.
Install RICOH ProcessDirector Plug-in for Adobe Acrobat by following the instructions in RICOH ProcessDirector: Installing PDF Document Processing Features.
To enhance PDF files for use with Automated Verification:
  1. Open a PDF file in Adobe Acrobat Professional and click Ricoh Select to make RICOH ProcessDirector Plug-in for Adobe Acrobat the active tool.
  2. Draw a box around the text you want to use to define text-based page groups, or draw a box anywhere to define page groups that are not based on text. Click Define Page Group.
    You can define a page group based on text that appears repeatedly throughout the PDF file, or based on a fixed number of pages. For example, if Page 1 appears on the first page of each document, you can use that text to define page group.
      Other:
    • If you use text to define the beginning of the page group, this text should appear in the same location on the first page of every page group.

    • If you are using a sample PDF file to define page groups, make sure that the content and location of the text you select are consistent among the production PDF files.

  3. Follow the instructions for defining a page group in the plug-in help system or in RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.
  4. After you verify that the page groups are what you expect, use the left mouse button to draw a box where you want the verification barcode to print. Click Add Barcode.
    The upper left corner of the box specifies the upper left corner of the barcode. You do not need to draw the box to the exact size of the barcode. The barcode is not resized to fit within the box. If you draw a box to the approximate size of the barcode, you can see its position relative to other markup that you add to the PDF file.
    Important:
    Make sure that sure the placement of the barcode matches what the camera or barcode scanner expects to see.
  5. Type a name for the barcode.
  6. Use the Placement Conditions section to specify the pages to place the barcode on.
    If you want to place a barcode on the first page of each document, select Pages based on a rule, and then select All Front Pages.
  7. Use the Barcode Configuration section to define the mechanical attributes and type of the barcode.
    The barcode type must support periods. Child jobs for reprints have a period in the job number (for example, 10000001.1).
  8. Add the Job number job property to the barcode:
    1. Select Job Property from the Content Type list.
    2. Select Job.ID for the Content Value.
    3. Click the Edit icon icon to display a Modify Text window.
    4. For the Text to Modify value, type: 10000001
      This value is an example of an 8–digit RICOH ProcessDirector job number. As RICOH ProcessDirector runs, it determines the actual value.
    5. Select Pad with Character from the Modify list.
    6. Select Beginning of Line for the Padding Location value.
    7. Type 0 for the Character to Pad with value.
    8. To pad the 8–digit job number with three zeroes, select 11 for the Minimum Padded Text Length value.
      You see 00010000001 for the Modified Text value. The padded characters allow for up to 99 child jobs (for example, child job number 10000001.99) to handle reprints.
      Important: The length that you specify by padding with characters must match the length of the barcode format that you defined in RICOH ProcessDirector.
    9. Click OK.
  9. Click the Add content icon icon to add a new content definition row.
  10. Add the Sequence in child job document property to the barcode:
    1. Select Document Property from the Content Type list.
    2. Select Doc.SequenceInChild for the Content Value.
    3. Click the Edit icon icon to display a Modify Text window.
    4. For the Text to Modify value, type 1
      This value is an example of a Sequence in child job property value. As RICOH ProcessDirector runs, it determines the actual value.
    5. Select Pad with Character from the Modify list.
    6. Select Beginning of Line for the Padding Location value.
    7. Type 0 for the Character to Pad with value.
    8. Pad the document number with enough zeroes to account for the largest number of documents that you could have in a print job. If you could have up to 9999 documents in a print a job, pad the Sequence in child job value with four zeroes. Select 4 for the Minimum Padded Text Length value.
      You see 0001 for the Modified Text value.

      Do not underestimate the number of documents that you could have. If you could have between 10000 and 99999 documents in a print job, select 5 for the Minimum Padded Text Length value.

      Important: The length that you specify by padding with characters must match the length of the barcode format that you defined in RICOH ProcessDirector.
    9. Click OK.
  11. Click OK.
  12. When you are ready to save your page group and verification barcode, click Ricoh Save Control File.
  13. Give the control file a name or accept the default value. Click Save. You see a confirmation message. Click OK.
  14. When you configure your Automated Verification workflow, specify the name and location of the control file in the step based on the IdentifyPDFDocuments step template.
For more information about how to add a barcode, see the plug-in help system or RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.

1.2.4.39.5 Enhancing AFP files for Automated Verification

Most AFP files that are submitted to RICOH ProcessDirector need to be enhanced before they can be processed for Automated Verification.

AFP files must contain page groups that identify the documents (mailpieces) in the AFP file. If an AFP file does not have page groups, you can use AFP Indexer to add them.

The barcodes that the Automated Verification feature uses must contain these properties:

  • Job number
  • Sequence in child job
You must use the Enhance AFP function to add barcodes that contain the values of those properties to each document in AFP jobs.

Note: AFP Editor, if it is installed, can also hide existing barcodes and create new ones. However, AFP Editor cannot include the values of document properties (such as Sequence in child job) in the barcode. Therefore, you must use Enhance AFP to create barcodes for use with Automated Verification.
To create barcodes for use with Automated Verification:
  1. Create an Enhance AFP control file.
    • You can use the sample Enhance AFP control file named enhanceAfp.cfg in /opt/infoprint/ippd/extensions/doc/samples (Linux) or C:\Program Files\Ricoh\ProcessDirector\extensions\doc\samples (Windows) to create a new control file.
    • You can also use the AFP Enhancer mode in RICOH Visual Workbench to create a new control file. Make sure to save the RICOH Visual Workbench control file and export the Enhance AFP control file.
  2. When you configure your Automated Verification workflow, specify the name of the Enhance AFP control file in the step based on the BuildAFPFromDocuments step template.
  3. Optional: If the output is not what you expected, use AFP Enhancer mode in RICOH Visual Workbench to edit the Enhance APP control file.
    • If you used the sample Enhance AFP control file enhanceAfp.cfg, use a text editor to modify the control file.
    • If you used the AFP Enhancer mode in RICOH Visual Workbench, open the RICOH Visual Workbench control file and make your changes. Then export the Enhance AFP control file.

1.2.4.39.6 Customizing the Verification recipient document property for PDF files

You can customize the Verification recipient document property for PDF files that you process at your installation. Operators can then use the Verification recipient property to identify documents that need to be reprinted during manual reconciliation.

For example, if you customize the Verification recipient property to capture customer name data, the operator can use the Verification recipient property to find a document with the customer name that is displayed in the address window of the envelope of a damaged mailpiece.

    Note:
  • You see the values of the Verification recipient property in the Recipient column of the Documents table on the Reconcile Job dialog. The database name of the property is Doc.Verification.Recipient.

To customize the Verification recipient document property:
  1. Open a PDF file in Adobe Acrobat Professional and load the control file that you created to enhance PDF files for Automated Verification.
  2. Left-click just above the top left corner of the data that you want to capture. Drag the mouse to draw a box around the data.
    Make the box big enough to capture the longest occurrence of the data in your PDF files. Some characters in a PDF file have a larger white space buffer than other characters. You can see the captured data in the Selected Text area of the dialog.
    If you are capturing customer name data, draw a box around the customer name.
  3. Select Define Document Property from the popup menu.
  4. Select Doc.Verification.Recipient from the drop-down list.
  5. Use the Placement Conditions section to specify the pages to extract the document property data from.
    If you want to extract the document property data from the first page of each document, select Pages based on a rule, and then select All Front Pages.
  6. Click OK to create the document property.
  7. Click Ricoh View Document Property Values and scroll through several page groups in your PDF file to verify that RICOH ProcessDirector Plug-in for Adobe Acrobat is extracting the correct document property values for each page group.
  8. When you are ready to save your new document property definition, click Ricoh Save Control File, the click Save. You see two confirmation messages. Click Yes and then OK.
  9. When you configure your Automated Verification workflow, specify the name and location of the control file in the step based on the BuildPDFFromDocuments step template.
For more information about working with document properties, see the plug-in help system or RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.

1.2.4.39.7 Customizing the Verification recipient document property for AFP files

If you have the AFP Support feature installed, you can customize the Verification recipient document property for AFP files that you process at your installation. Operators can then use the Verification recipient property to identify documents that need to be reprinted during manual reconciliation.

Your AFP files must contain page groups and the index tag information that you want to map to the Verification recipient property. If an AFP file does not have page groups and index tags, you can use AFP Indexer to add them.

For example, if you link the Verification recipient property to an index tag that contains the customer name, the operator can use the Verification recipient property to find a document with the customer name that is displayed in the address window of the envelope of a damaged mailpiece.

Use Document Property Designer to link the Verification recipient document property to an index tag in your AFP applications. When the Verification recipient document property is linked to an index tag, the value of the document property is the same as the value of the indexed data. For PDF files, use RICOH ProcessDirector Plug-in for Adobe Acrobat to define document properties.

Note: You see the values of the Verification recipient property in the Recipient column of the Documents table on the Reconcile Job dialog. The database name of the property is Doc.Verification.Recipient.

To customize the Verification recipient document property:
  1. Start RICOH Visual Workbench and open a sample AFP file that is representative of production jobs.
    The AFP file must contain page groups and the index tag information you want to use for the Verification recipient property.
  2. To link the Verification recipient document property to an index tag in the AFP file, use the Document Property Designer (DPD) mode. Double-click the Verification recipient property name at the bottom of the window and supply the requested information in the Define link options dialog.
  3. Save the Visual Workbench control file.
    The control file contains Document Property Designer definitions.
  4. When you configure your Automated Verification workflow, specify the name of the Visual Workbench control file in a step based on the IdentifyDocuments step template.
For more information, see the topics related to RICOH Visual Workbench and Document Property Designer.

1.2.4.40 Setting up the Preference Management feature

After you read the Preference Management overview topics, you can set up Preference Management by doing the configuration tasks described in this section.

After the initial configuration is complete, test your Preference Management workflows to make sure they work as you expect them to.

1.2.4.40.1 Running the sample workflow for managing output preferences

The PreferencesSample workflow for applying processing preferences to jobs illustrates how to use a preferences file to control multichannel delivery. The PreferencesSample workflow creates three child jobs each of which processes documents differently based on the value of the Output type property.
The sample objects and files used in this workflow include:
  • Workflow: PreferencesSample
  • Sample input device: PreferencesFolder
  • Sample property mapping object: DelimitedSample
  • Sample PDF file: /aiw/aiw1/testfiles/DemoPref.pdf
  • Sample PDF file:
  • Sample PDF control file: /aiw/aiw1/testfiles/DemoPref.ctl
  • Sample PDF control file:
  • Sample preferences file: /aiw/aiw1/testfiles/pref/preferences.csv
  • Sample preferences file:
This sample workflow includes an ApplyPreferences step. The ApplyPreferences step uses the DelimitedSample property mapping object to map values from the preferences file to values in the document properties file. These values are then used to determine which output method is used for each document. One of the properties set by the ApplyPreferences step is the Output type property for each document.

The GroupDocuments step organizes the documents based on the Output type property. Based on the groupings identified, the CreateJobsFromDocuments step generates child jobs. The child jobs are resubmitted to the original workflow and follow the child job branch out of the SetJobPropsfromTextFile step. The child jobs move through their respective print, email, and suppression branches until processing is finished and all of the jobs, the parent job and both child jobs, are completed.

To run the sample workflow:

  1. Click the Main tab.
  2. In the Printers portlet, right-click the Sample printer and select Enable.
  3. In the Input Devices portlet, right-click the PreferencesFolder hot folder input device and select Enable and Connect.
  4. The parent job waits in the WaitForRelatedJobs step until all the child jobs reach the same step and then finishes.
    The child jobs for Print and Suppress also process as far as the WaitForRelatedJobs step. The Email child job stops at the CheckEmailSettings step, and goes into the Manual, working state. If you configured RICOH ProcessDirector to send email using an SMTP server, use the Manual complete action to move the child job to the next step.
    If you have not configured RICOH ProcessDirector to send email, you can delete the child job from the Jobs table and let the rest of the job complete.
    You can see the parent job and the child jobs in the Jobs table. You can select the separate child jobs and click View to see the documents produced by each child job.

1.2.4.40.2 Defining document properties for use with a preferences file

Before RICOH ProcessDirector can use data about documents, you must define the data as RICOH ProcessDirector document properties.
To define document properties for use with a preferences file:
  1. Identify data that you need document properties for.

    Examples:

    • You want to extract account number, customer name, and statement date from each document in the job. You need to define three document properties.

      As a job goes through the workflow, the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files) extracts the data from each document in the job.

    • You want to extract two columns of data from an external preferences file so you can insert the data into the job. The columns have the headings Output Type and Awards. You need to define two document properties.

  2. For each document property, choose a user interface name and a database name.
    You can use existing RICOH ProcessDirector document properties, or you can define your own custom document properties.

    Examples:

    • You can use the Output type document property (database name Doc.Pref.Output), which is supplied with the Preference Management feature.

    • Instead of using the Output type document property, you can define your own custom document property. You might give the document property the user interface name Delivery choice and the database name Doc.Custom.DeliveryChoice.

    • You can define your own custom document property with the user interface name Award level and the database name Doc.Custom.AwardLevel.

    Note: We recommend that the database names of your custom document properties start with Doc.Custom.

  3. Define all the custom RICOH ProcessDirector document properties you need by editing the document properties configuration file (docCustomDefinitions.xml).

    For example, you might add these lines to the file:

    <docProperty name="Doc.Custom.AccountNumber"
                 datatype="String"
                 dbType="varchar (32)"
                 access="attrWriteAdmin"
                 shortCaption="Acount number"
                 caption="Account number"
                 description="Customer account number"/>
    <docProperty name="Doc.Custom.AwardLevel"
                 datatype="String"
                 dbType="varchar (32)"
                 access="attrWriteAdmin"
                 shortCaption="Award level"
                 caption="Award level"
                 description="Customer award level"/>
    <docProperty name="Doc.Custom.StatementDate"
                 datatype="Timestamp"
                 dbType="Timestamp"
                 access="attrWriteAdmin"
                 shortCaption="Statement date"
                 caption="Statement date"
                 description="The date the statement was created"/>
    Note: The name line defines the database name. The caption line defines the user interface name.

  4. Update your configuration files by running the docCustom utility.
    The first time that you run the docCustom utility, it creates the Custom Document Properties feature and adds it to the Feature Manager. When you run the utility again, it updates the Custom Document Properties feature.
  5. Use Feature Manager to install or update the Custom Document Properties feature.
  6. If you are working with PDF files, load the updated RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
  7. Specify the data that the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files) extracts from each document in the job:
    • If you are working with PDF files, use the Define Document Property function in RICOH ProcessDirector Plug-in for Adobe Acrobat.
    • If you are working with AFP files, use the Document Property Designer (DPD) mode of RICOH Visual Workbench.
      Note: If the AFP files do not have index tags defined for the document data that you want to extract, use the AFP Indexer mode to add the tags. AFP Indexer is not supplied with RICOH ProcessDirector. You must purchase the feature.
  8. Save your document property definitions in a control file for use with the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files):
    • If you are working with PDF files, use the Save control file function in RICOH ProcessDirector Plug-in for Adobe Acrobat.
    • If you are working with AFP files, use the Save control file function in RICOH Visual Workbench.
  9. Send the control file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.

1.2.4.40.3 Making a preferences file available to the system

You can make an external preferences file available to the system in several different ways. For example, you can submit a job and a preferences file together to an input device, you can copy a preferences file to a directory on the primary computer for use with multiple jobs, or you can instruct RICOH ProcessDirector to retrieve a preferences file from an external location.

Before you make a preferences file available to RICOH ProcessDirector:

  • Verify that the preferences file has headings for all the columns of data you want to use with RICOH ProcessDirector.
  • Define RICOH ProcessDirector document properties for each column of data you use.
  • Define a property mapping object that maps the headings in the preferences file to the document properties.
  • Decide how to make the preferences file available to RICOH ProcessDirector.
  • Choose an existing hot folder input device or create a new one to use with a preferences file.

To make a preferences file available to the system, do the steps that are required for the method that you plan to use:

If you plan to send the preferences file with the job, you must configure an input device that uses the pattern batching method, then configure the step to find the preferences file.

If you plan to store the preferences file in a static location (either on the primary computer or in a shared directory), you only need to configure the step to find the preferences file.

  • Configure the input device to use the Pattern batching method.
    1. Select the input device on the Input Devices portlet.
    2. If the input device is enabled, disable it.
    3. Click Actions Properties.
    4. Click the Batching tab and for the Batching method property, select Pattern.
    5. Enter property values for the file pattern that identifies a job.

      For example, use these values to identify a PDF job:

      • File pattern: .*pdf$
      • Spool file usage: print
      • Spool file type: pdf
      • File pattern required: Yes
      • File pattern sequence: 1

      If you have the AFP Support feature installed and want to process AFP jobs, change the File pattern and Spool file type values to .*afp$ and afp.

    6. Click Add.
    7. Enter property values for the file pattern that identifies a preferences file.

      For example, use these values for a preferences file in comma-separated values (CSV) format with a csv file extension:

      • File pattern: .*csv$
      • Spool file usage: pref
      • Spool file type: csv
      • File pattern required: Yes
      • File pattern sequence: 2

      If the preferences file is in tab-delimited format with a txt extension, change the File pattern and Spool file type values to .*txt$ and txt.

      You can use any value for the Spool file usage property that is not a RICOH ProcessDirector keyword. Keywords include control, overrrides, and print.

    8. Click Add.
    9. When you finish setting property values for the input device, click OK.
  • Configure the step to find the preferences file.
    When you set up the workflow that uses the preferences file, set the value of the Preferences file property on the ApplyPreferences step:
    • If you plan to send the preferences file with the job, specify the symbolic name of the file, for example: ${getFileName(pref,csv,read)}.

      The symbolic name uses the values for Spool file usage and Spool file type that you specified on the Batching tab when you created the input device.

    • If you plan to store the preferences file in a static location, specify the full path and name of the file, for example: /aiw/aiw1/preferences/preferences.csv.

1.2.4.40.4 Defining property mapping objects

You can use property mapping objects to define the relationship between the headings in a preferences file and the document properties defined for documents in a job. The relationship determines how the ApplyPreferences step uses their values during processing.
To define a property mapping object:
  1. Click the Administration tab.
  2. In the left pane, click Objects Property Mapping.
  3. Click Add Delimited.
  4. On the General section, enter values for the properties as needed.
    Make sure the value you select for the File type property matches the format of the preferences file.
  5. On the Property Mapping section:
    1. Enter a heading from the preferences file and select the document property that corresponds to that heading.
    2. Select a value for Usage.
      • The properties with the Usage value set to Identify document are used to locate documents in the job.
      • The properties with the Usage value set to Update property are updated by the ApplyPreferences step with values from the preferences file.
    3. To add an additional mapping, click the plus sign () to the right of your last entry.
    4. To delete a mapping, click the minus sign () to the right of the entry you want to delete.
    You must have at least two entries on the Mapping tab, one used to identify documents in the job and one designated as a property whose value is updated by the ApplyPreferences step.
    The order of the headings in the list does not have to match the order of the headings in the preferences file.
  6. Click OK.

1.2.4.40.5 Setting up a workflow that uses an external preferences file

To process documents based on information from an external preferences file, you set up a workflow that includes a step based on the ApplyPreferences step template. Additional steps and conditional processing (or additional workflows) might be required to handle the processing for each document based on the preference information.

Before you set up a workflow:

  • Define the values you are using from the external preferences file as RICOH ProcessDirector document properties.
  • Define a property mapping object.
  • Decide how to make the preferences file available to RICOH ProcessDirector. For example:
    • You might submit a preferences file with each job.
    • RICOH ProcessDirector might retrieve a preferences file from a static location (either on the primary computer or from a mounted drive) and use that preferences file with multiple jobs.
  • Create an input device to receive the required files:
    • Job files, if RICOH ProcessDirector retrieves the preferences file from a static location
    • Job files and preferences files

To set up a workflow that uses a preferences file:
  1. Click the Workflow tab.
  2. Click the name of a workflow that you want to modify, or create a new workflow.
    For example, you might copy and modify the EnhancePDFDocuments supplied workflow.
  3. If you are editing an existing workflow, disable it.
  4. Add a step based on the ApplyPreferences step template to the workflow after the IdentifyPDFDocuments step and before the BuildPDFFromDocuments step.
    If you have the AFP Support feature installed and the workflow processes AFP files, add the ApplyPreferences step after the IdentifyDocuments step and before the BuildAFPFromDocuments step.
  5. Set values for the properties of the ApplyPreferences step:
    1. For the Preferences file property, specify the full path or symbolic name of the preferences file.
      • If you are placing the preferences file on the RICOH ProcessDirector server for use by multiple jobs, specify the full path and name of the file, for example: /aiw/aiw1/preferences/preferences.csv.
      • If you are submitting a preferences file with each job, specify the symbolic name of the file, for example: ${getFileName(pref,csv,read)}.
          Note:
        • To use the values in the example, you define pref as the value of the Spool file usage property and csv as the value of the Spool file type property on the Batching tab when you created the input device.
    2. For the Property mapping property, select the property mapping object you created for this workflow.
  6. Optional: Add steps and connectors for conditional processing, if needed.

    The PreferencesSample supplied workflow contains conditional processing that might be used with values from an external preferences file.

  7. Save the workflow.
  8. Test the workflow:
    1. Enable the workflow.
    2. Enable and connect the input device that sends jobs to the workflow.
    3. Submit a preferences file and a job to the workflow:
      • If RICOH ProcessDirector is retrieving a preferences file from a static location, copy a sample preferences file to that location and then submit your job to the input device.
      • If you are submitting a preferences file with your job, submit both files to the input device.

1.2.4.41 Setting up security

You can control access to the RICOH ProcessDirector system with user names and security groups. You can also increase the security of the data in your print system by enabling Secure Sockets Layer (SSL) or Transport Layer Security (TLS) in the Web server component. If you exchange data with a web service, you can install a security certificate for the web service.

All users who access the RICOH ProcessDirector system must have a RICOH ProcessDirector user name and must be assigned to a security group based on job role requirements.

Users can be members of more than one security group. If you belong to more than one group, the system automatically gives you the authority of the highest level group that you belong to. For example, you might be a member of both the Operator and Supervisor groups. When you log in, the system gives you Supervisor authority so you can do actions that a member of the Operator group cannot.

1.2.4.41.1 Defining user names

Users must have a RICOH ProcessDirector user name to access the system and to do RICOH ProcessDirector actions.

If the Security feature is installed and Authentication with LDAP is enabled, user names are set up using LDAP, not RICOH ProcessDirector.

1.2.4.41.1.1 Adding users

You can create user names for each person who uses RICOH ProcessDirector. These user names are separate from Linux or Windows user names.
    Note:
  • If you have the Security feature installed and Authentication with LDAP is enabled, do not add users with this procedure. Users are added automatically when they log in the first time after LDAP authenticates them.
To add a user:
  1. Click the Administration tab.
  2. In the left pane, click Security Users.
  3. Click Add.
  4. Enter values for the required fields: User name, New user password, Confirm new user password, Group membership.
      Note:
    • A user can be a member of more than one user group. If you are a member of more than one user group, you are granted the highest level of authority from the groups you belong to. For example, if you are a member of both the Supervisor and Operator user groups, you retain all the access privileges of the Supervisor user group. As a result, you can do actions that a typical member of the Operator group cannot do.
  5. Optional: Enter values for the optional fields.
    • If you want the user to receive notifications that are sent to a group of users, enter an email address for the user.
  6. Click OK.
  7. Tell the user the user name and password that you created. Users must change their passwords the first time they log in.
    Important:
  • Documents are not associated with a specific location. Restricting users to specific locations does not prevent them from displaying documents included in jobs that are associated with other locations.
    Note:
  • You can export entries in the Users table to a Comma-Separated Values (CSV) file. Click the Gear menu button in the top right corner of the page and select Export table to CSV. The exported list only contains entries for users that match all the filters that are set. For example, you type Administrator in the filter field Funnel icon. The list in the CSV file contains only the entries for users that are members of the Administrator group. The entries are sorted by user name.

1.2.4.41.1.2 Copying a user

You can copy a user so you can use it as a template for creating another user. Copying users can save you time, especially when you need to create several users with similar properties.
Note: If you have the Security feature installed and Authentication with LDAP is enabled, do not add users with this procedure. Users are added automatically when they log in the first time after LDAP authenticates them.
To copy a user:
  1. Click the Administration tab.
  2. In the left pane, click Security Users.
  3. Right-click the user that you want to copy and select Copy.
  4. Enter values for the required fields.
  5. Click OK.
Tell the user the user name and password that you created. Users must change their passwords the first time they log in.

1.2.4.41.1.3 Changing group membership for a user

You can change the group membership for users when their RICOH ProcessDirector tasks and actions change.
    Note:
  • If the Security feature is installed, Authentication with LDAP is enabled, and the Synchronize with LDAP groups property is set to Yes, RICOH ProcessDirector updates the group membership for a user based on the values for the Product to LDAP group mapping property each time the user logs in.
To change group membership for a user:
  1. Click the Administration tab.
  2. In the left pane, click Security Users.
  3. Right-click the user whose group membership you want to change and select Properties.
  4. For the Group membership property, select all the groups that the user is a member of.
    Users can be members of more than one security group. If a user is a member of multiple security groups with different permissions, the user has any permission authorized by any of the groups.
  5. Click OK.

1.2.4.41.1.4 Giving a user system user authority

If you want to let other users access RICOH ProcessDirector file systems and run the RICOH Visual Workbench user interface, you can give a user name virtually the same authority as the RICOH ProcessDirector system user (aiw1 is the default).
To give system user authority to a user name, either when you create the user name or later:
  1. Assign the user to the RICOH ProcessDirector group (aiwgrp1 is the default).
    This gives the user the same access permissions as the system user.
  2. To set the user's environment variables, including PATH, to the same values as the system user's environment variables, edit the user's .profile file and add these lines:
    if [[ -f /opt/infoprint/ippd/base/config/ippdprofile ]] ; then
       .  /opt/infoprint/ippd/base/config/ippdprofile
    fi
The user can now access the same file systems as the RICOH ProcessDirector system user and can use tools such as the RICOH Visual Workbench user interface. However, this user cannot run the startaiw or stopaiw commands. Only the RICOH ProcessDirector system user can use those commands.

1.2.4.41.2 Defining security groups

Security groups define specific authority levels for the actions that can be done in the user interface for each type of object. When a member of a group logs in to RICOH ProcessDirector, the only actions that are available in the user interface are the ones that the group is authorized to do. You can also select what properties of each object can be viewed or set by members of a security group. You can select a default Main page view for all the users in a security group.

RICOH ProcessDirector provides several predefined security groups: Administrator, Supervisor, Operator, and Monitor. You can create your own security groups by copying one of those security groups and adding or removing actions that the group has permission to do and properties that the group has permission to change.

Users can be members of more than one security group. If you belong to more than one group, the system automatically gives you the authority of the highest level group that you belong to. For example, you are a member of both the Operator and Supervisor groups. When you log in, the system gives you Supervisor authority, so you can do actions that a member of the Operator group cannot.

If a user is a member of multiple security groups with different permissions, the user has any permission authorized by any of the groups.

If you have LDAP authentication activated, you must map RICOH ProcessDirector security groups to existing LDAP groups. RICOH ProcessDirector checks the LDAP groups for a user the first time the user logs in and assigns the user to RICOH ProcessDirector groups based on the product to LDAP group mapping. See the examples in the table below.

Product to LDAP group mapping
Product group LDAP group
Administrator Network Administrators
Administrator First-shift Administrators
Administrator Second-shift Administrators
Supervisor First-shift Supervisors
Supervisor Second-shift Supervisors
Supervisor Third-shift Supervisors
Operator First-shift Operators
Operator Second-shift Operators
Operator Third-shift Operators
Monitor Sales
Monitor Preflight

    Note:
  • RICOH ProcessDirector uses the name of the LDAP group in the Group search filter property when it authenticates an LDAP user to RICOH ProcessDirector.

If you do not synchronize product groups with LDAP groups, RICOH ProcessDirector does not check the LDAP groups for a user after the first log in. You can add users to groups manually in RICOH ProcessDirector.

If you synchronize product groups with LDAP groups, RICOH ProcessDirector checks the LDAP groups for a user at each log in and updates the product group memberships for the user based on the product to LDAP group mapping. RICOH ProcessDirector groups are inactive unless they are mapped to LDAP groups. You make changes to the security group memberships for a user in LDAP.

1.2.4.41.2.1 Security groups that RICOH ProcessDirector provides

RICOH ProcessDirector provides several predefined user security groups.

These security groups are:

Administrator
Administrators have access to all functions and pages of the user interface. Members of this group can change values for all properties that accept user input on all object types that RICOH ProcessDirector provides, such as servers, workflows, step templates, input devices, printers, and users. Administrators can also add, copy, and delete all types of objects.
Supervisor
Supervisors can view property notebooks for most existing objects, but they cannot add or copy objects. Supervisors can change values for most job and printer properties and can enable and disable all object types. The only objects that Supervisors can delete are jobs.
Operator
Operators can view property notebooks for some objects and can change values for some job properties, such as the Requested printer. Operators can do actions on printers, such as enabling, disabling, and changing scheduling properties. They can do most of the available job and input device actions. They cannot add objects or copy existing objects. The only objects that Operators can delete are jobs.
Monitor
Monitors have view-only access to the RICOH ProcessDirector system. They can view job properties and input files, see the candidate jobs for a printer, and change their own password, but they cannot do any other actions, including viewing the contents of jobs.

1.2.4.41.2.2 Copying a security group

You can copy a group that RICOH ProcessDirector provides or one that you created and use it as a template for creating another group.

When you plan a security group, be aware that:

  • Some actions require authorization to do other actions or edit certain properties:
    To do this action To this object type A group must be able to do this action to that object type And edit these properties of that object type
    Add Any Edit Properties All required properties
    Copy Any Edit Properties All required properties
    Edit Properties Any View Properties  
    Make jobs match printer Job Edit Properties Scheduling properties
    Print Again Job Edit Properties Input data stream, Workflow, Restart steps, Stop when entering phase
    Process Again Job Edit Properties Job copies, Requested printer
    Schedule Job Edit Properties Scheduling properties
  • If you prohibit a group from adding objects, you might also want to prohibit that group from importing objects.

To copy a security group:

  1. Click the Administration tab.
  2. In the left pane, click Security Groups.
  3. Right-click the group that you want to copy and select Copy.
    When you copy a group provided by RICOH ProcessDirector, you can add and delete permissions for the new group. Start with group that has approximately the same permissions that the new group requires, so you do not have to make many changes.
  4. Fill in the Group name and Group description properties.
  5. Edit the actions that the group can do to objects:
    1. In the Object types list, select an object type.
    2. To prohibit an action, clear the check box for the action.
    3. To allow an action, select the check box for the action.
  6. Edit the object properties that the group can view and edit:
    1. In the Object types list, select an object type.
    2. To restrict the group from viewing a property, clear the property check box in the View column.
    3. To let the group view a property, select the property check box in the View column.
    4. To restrict the group from editing a viewable property, clear the property check box in the Edit column.
    5. To let the group edit a property, select the property check box in the Edit column.
  7. Change the Default Main page view value to the saved view you want the users in the group to use.
  8. Click OK.
    Note:
  • You can export entries in the Groups table to a Comma-Separated Values (CSV) file. Click the Gear menu button in the top right corner of the page and select Export table to CSV. The exported list only contains entries for groups that match all the filters that are set. For example, you type Operator in the filter field Funnel icon. The list in the CSV file contains only the entries for groups with Operator in the group name, description, or source ID. The entries are sorted by group name.

1.2.4.41.2.3 Updating properties of a group

You can update the properties that define the characteristics of a group.

When you update a security group, be aware that:

  • Some actions require authorization to do other actions or edit certain properties:
    To do this action To this object type A group must be able to do this action to that object type And edit these properties of that object type
    Add Any Edit Properties All required properties
    Copy Any Edit Properties All required properties
    Edit Properties Any View Properties  
    Make jobs match printer Job Edit Properties Scheduling properties
    Print Again Job Edit Properties Input data stream, Workflow, Restart steps, Stop when entering phase
    Process Again Job Edit Properties Job copies, Requested printer
    Schedule Job Edit Properties Scheduling properties
  • If you prohibit a group from adding objects, you might also want to prohibit that group from importing objects.

    Important:
  • You cannot change the properties of a group that RICOH ProcessDirector provides. Copy the group and change the properties of the copy.

To update the properties of a group:

  1. Click the Administration tab.
  2. In the left pane, click Security Groups.
  3. Right-click the group you want to update and select Properties.
  4. To change the Group description property, type the new value in the entry field.
  5. Edit the actions that the group can do to objects:
    1. In the Object types list, select an object type.
    2. To prohibit an action, clear the check box for the action.
    3. To allow an action, select the check box for the action.
  6. Edit the object properties that the group can view and edit:
    1. In the Object types list, select an object type.
    2. To restrict the group from viewing a property, clear the property check box in the View column.
    3. To let the group view a property, select the property check box in the View column.
    4. To restrict the group from editing a viewable property, clear the property check box in the Edit column.
    5. To let the group edit a property, select the property check box in the Edit column.
  7. Change the Default Main page view value to the saved view you want the users in the group to use.
  8. Click OK.
    Note:
  • If you try to update properties when Properties notebooks for several objects are open in different browser tabs, the RICOH ProcessDirector user interface can freeze. If this happens, close all tabs and open one Properties notebook at a time in the same tab and window as the Main page or Administration page.

1.2.4.41.3 Creating credentials

A credential object specifies the user authentication information required to access an SFTP server. If multiple input devices or steps access the same SFTP site with the same credentials, you can specify the user authentication information once in the Credential object and then select that credential in the step or input device that needs it.
To create a credential:
  1. Click the Administration tab.
  2. Under Objects, click Credentials.
  3. Click in the top right corner, and select the type of credential object to create:
    Credentials for input device object
    Password
    Password credentials use a user name and password for authentication.
    SSH Key
    SSH key credentials require a private key in OpenSSL (traditional SSLeay) or PKCS#8 format. Different utility programs to generate SSH keys are available on each operating system.
    Credentials for data transmitter object
    Static
    Static credentials use an authorization code to connect to an application. A user or application can use the same credential repeatedly.
    Session
    Session credentials use a password to connect to an application and retrieve temporary authentication data, such as a token. The token is valid for the current communication session with the application and then it expires.
  4. Fill in the values as needed and click OK.
Credentials are used by SFTP input devices, the PullFromSFTP and PushToSFTP step templates, and by data transmitter objects. To use a credential with any of those objects, select it from the list in the Credential property in the object's property notebook.
    Note:
  • You can export entries from the Credentials table to a Comma-Separated Values (CSV) file. Click the Gear menu button in the top right corner of the page and select Export table to CSV. The entries are sorted by name.

1.2.4.41.4 Enabling Secure Sockets Layer or Transport Layer Security

You can activate Secure Sockets Layer (SSL) or Transport Layer Security (TLS) protocols for secure encrypted connection using RICOH ProcessDirector settings.

Before you begin this task, you must obtain a digital certificate and store it on the computer where the base product is installed on. Follow the instructions provided by the certificate authority (CA) for installing the certificate. You must also know where the keystore is located on the server and the password for the keystore.

If your server is not already using SSL or TLS, generate a new key and keystore with the keytool command.

The enabling process requires Perl to run. Before you enable SSL or TLS, make sure a Perl interpreter is installed.

    Note:
  • keytool is a Java command. For details about using keytool, consult your CA or Java documentation.
  • Your private key password and keystore password must be the same. If they are not the same, you receive a java.io.IOException error.
To enable secure connection:
  1. Click the Administration tab.
  2. In the left pane, click Settings Security.
  3. Set the Enable secure HTTP property to Yes.
  4. Enter values for the required fields: Keystore file, Keystore password.
  5. To be automatically redirected to the secure protocol without having to take any action, set the Redirect to secure URL property to Yes.
      Note:
    • If you enable the secure connection but leave the Redirect to secure URL property set to No, you and other users are not redirected to the new URL when you try to use a link to the old URL (http://hostname:15080/pd). Make sure that everyone updates their links to use the URL from the Secure URL field.
    • The URL value that RICOH ProcessDirector uses for a secure connection is listed in the Secure URL field.
  6. Click SAVE.
  7. Restart RICOH ProcessDirector to apply the settings.
      Note:
    • If Feature Manager is running, you must also restart it to apply the new settings.

If you use RICOH ProcessDirector Web services to exchange print data with other applications in your system, make sure that the client software you use to invoke the Web services supports SSL or TLS.

1.2.4.41.5 Setting a password expiration counter

You can set a limit on how long all passwords in the system can be used before they must be changed. The limit applies to all users.
Make sure you are aware of any password guidelines that your company follows and create a password that meets them.
    Note:
  • If the Security feature is installed and Authentication with LDAP is enabled, this option is not available.
To set a password expiration counter:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the Maximum password age before expiration field, type the number of days a password can be used before it expires.
  4. Click OK.

1.2.4.41.6 Enforcing password complexity

You can enable complex password rules.
    Note:
  • This option is not available if LDAP authentication is enabled.
To ensure that user passwords meet password complexity rules:
  1. Click the Administration tab.
  2. In the left pane, click Settings Security.
  3. Set the Enforce password complexity rules property to Yes.
  4. Click SAVE.

1.2.4.41.7 Setting up to use LDAP authentication

If you have an existing LDAP or Active Directory server, you can use LDAP or Active Directory user names and passwords to authenticate into RICOH ProcessDirector.
You must install the Security feature before you can set up to use LDAP authentication.

Consult your LDAP administrator for the values of the LDAP server and other properties you set in this procedure. Before you turn on LDAP authentication, you map RICOH ProcessDirector security groups to existing LDAP groups.

After you turn on LDAP authentication, the first time that a user logs in:

  • RICOH ProcessDirector authenticates the user name and password with the LDAP server.
  • RICOH ProcessDirector creates a RICOH ProcessDirector user name that is identical to the LDAP user name.
      Note:
    • No LDAP password information is stored on the RICOH ProcessDirector server.
  • RICOH ProcessDirector assigns the user RICOH ProcessDirector group memberships based on the values for the Product to LDAP group mapping property and the LDAP group memberships of the user.

Each time that a user logs in:

  • RICOH ProcessDirector authenticates the user name and password with the LDAP server.
  • If you synchronize product groups with LDAP groups, RICOH ProcessDirector updates the product group memberships of the user based on:
    • The values for the Product to LDAP group mapping property.
    • The LDAP group memberships of the user.
  • If you do not synchronize product groups with LDAP groups, RICOH ProcessDirector does not update the product group memberships of the user. You can assign group memberships to users manually in RICOH ProcessDirector.

To set up to use LDAP authentication:
  1. Log in as a user who is a member of the Administrator security group.
  2. Click the Administration tab.
  3. In the left pane, click Settings LDAP.
  4. Set the LDAP server property to either of these values:
    • The network IP address.
    • The fully qualified host name of the LDAP server and the port that the system uses for authentication.

      To include more than one LDAP server, use a semicolon (;) to separate the entries.

  5. Specify values for the Root distinguished name, User search base, and User search filter properties.
    The value you enter for the User search filter property determines the format of your RICOH ProcessDirector user names, for example, an email address format or a UID format.
  6. Optional: Specify a value for the Email attribute property.
    If you enter a value for this property, RICOH ProcessDirector sets a value for the Email address property when it creates a user.
  7. Specify values for the Manager distinguished name and Manager password properties.
  8. Specify values for the Group search base, Group search filter, and Group search member properties.
    RICOH ProcessDirector uses the name of the LDAP group specified in the Product to LDAP group mapping property in the Group search filter property when it authenticates an LDAP user to RICOH ProcessDirector.
  9. If you want to manage RICOH ProcessDirector security groups using LDAP, set the Synchronize with LDAP property to Yes. If you want to manage security groups using RICOH ProcessDirector, set the property to No.
  10. Specify the connections between product groups and LDAP groups:
    1. Select a product security group from the list.
    2. Type the name of the corresponding LDAP group next to it.
    3. Click + to the right of the LDAP group and map another product group to an LDAP group.
    4. Repeat the previous step until you have mapped all product groups to LDAP groups.
  11. Check to see whether your browser has automatically filled the Manager distinguished name and Manager password properties. If they are filled, clear the properties and leave them blank.
  12. To secure the connection to the LDAP server and establish Transport Layer Security (TLS), specify a value for the LDAP security property:
    • To use the StartTLS operation, set the property to StartTLS.

      StartTLS works with most default implementations of LDAP.

    • To use the Secure LDAP (LDAPS) protocol, set the property to ldaps.

      Do not specify LDAPS unless your LDAP administrator already has set up your LDAP implementation to use LDAPS.

  13. To verify that you can log in with your LDAP credentials:
    1. In the Test LDAP Settings section, enter an LDAP user name and password. Make sure that the user name is a member of an LDAP group that is mapped to the RICOH ProcessDirector Administrator group.
    2. Click Test LDAP Settings.
      If the test is successful, you receive a message that says LDAP settings test succeeded.

      If you receive an error message, click Close, update your LDAP settings, and click Test LDAP Settings again.

  14. When the test completes successfully, set the Authenticate with LDAP property to Yes.
    If you cannot get a successful test, leave the Authenticate with LDAP property set to No and have your LDAP specialist look at other possible issues.
  15. Click SAVE.
    If you have not used the test function before you click SAVE with the Authenticate with LDAP property set to Yes, the system runs the test with the user ID and password specified.
    • If the test succeeds, the settings are saved and LDAP authentication is activated.
    • If the test fails, you see an error message and none of the settings are saved.

      Fix the LDAP settings and run the test until it passes. If the test continues to fail, set the Authenticate with LDAP property to No and click SAVE. Work with your LDAP specialist to resolve the problems and retest the settings.

After you turn on LDAP authentication:
  • Local RICOH ProcessDirector users cannot log in to RICOH ProcessDirector.
  • The first time that an LDAP user logs in to RICOH ProcessDirector, the system creates a user name that is identical to the LDAP user name.
  • If the Synchronize with LDAP property is set to Yes, RICOH ProcessDirector does not use any product groups that are not associated with LDAP groups.

RICOH ProcessDirector does not delete existing user names when you turn on LDAP authentication. You must manually delete those user names from the system.

    Note:
  • When LDAP authentication is turned on and RICOH ProcessDirector has a user with the same user name as an LDAP user:
    • RICOH ProcessDirector keeps the password of the existing user.
    • RICOH ProcessDirector lets the user authenticate with LDAP.
  • If LDAP authentication is turned off, the user can authenticate with the RICOH ProcessDirector password.

1.2.4.41.8 Communicating between RICOH ProcessDirector and the LDAP server

When you set up communications between RICOH ProcessDirector and your LDAP server, you might have to modify your LDAP server settings for these binds and search requests.

This table maps the Database property names to the corresponding names in the user interface. Use this table as a reference to help understand what properties are passed and returned by the searches and binds performed by RICOH ProcessDirector.

Database and User Interface property names
Database Property Name User Interface Property Name
WorkflowSystem.AdLdap.GroupMap Product to LDAP group mapping
WorkflowSystem.AdLdap.GroupSearchBase Group search base
WorkflowSystem.AdLdap.GroupSearchFilter Group search filter
WorkflowSystem.AdLdap.GroupSearchMember Group search member
WorkflowSystem.AdLdap.ManagerDN Manager distinguished name
WorkflowSystem.AdLdap.ManagerPassword Manager distinguished name password
WorkflowSystem.AdLdap.rootDN Root distinguished name
WorkflowSystem.AdLdap.Server LDAP server
WorkflowSystem.AdLdap.UserSearchBase User search base
WorkflowSystem.AdLdap.UserSearchFilter User search filter
User.ID User name
User.Password User password

RICOH ProcessDirector creates these binds whenever a user logs in:

  • bind ${WorkflowSystem.AdLdap.Server} using ${WorkflowSystem.AdLdap.ManagerDN} and ${WorkflowSystem.AdLdap.ManagerPassword}

    When the Manager distinguished name system property (WorkflowSystem.AdLdap.ManagerDN) does not have a value, an Anonymous bind is created.

  • bind to ${WorkflowSystem.AdLdap.Server} using ${User.ID} and ${User.Password}
      Note:
    • The password for User.Password must be set when making changes for LDAP. If the password is not set, the bind fails.

RICOH ProcessDirector does these search requests whenever a user logs in:

  • For all RICOH ProcessDirector LDAP groups:searchRequest "${WorkflowSystem.AdLdap.GroupSearchBase},${WorkflowSystem.AdLdap.rootDN}" wholeSubtree Filter: (${WorkflowSystem.AdLdap.GroupSearchFilter}${WorkflowSystem.AdLdap.GroupMap})

    The results must include the Group search member. The value of the Group search member is used as the RICOH ProcessDirector user name.

  • When a user name is set to the value returned on the Group search member argument:searchRequest "${WorkflowSystem.AdLdap.UserSearchBase},${WorkflowSystem.AdLdap.rootDN}" wholeSubtree Filter: (${WorkflowSystem.AdLdap.UserSearchFilter}=${User.ID})

Verify communications between RICOH ProcessDirector and your LDAP server are working correctly by testing the Group search base and User search base:

  • Test the Group search base by entering this command at a command prompt:

    ldapsearch -D "WorkflowSystem.AdLdap.ManagerDN" -x -W -b "WorkflowSystem.AdLdap.GroupSearchBase,WorkflowSystem.AdLdap.rootDN" -h "WorkflowSystem.AdLdap.Server" -s sub "(WorkflowSystem.AdLdap.GroupSearchFilter=GroupMap)"

    If communications between RICOH ProcessDirector and your LDAP server are working correctly, data containing the group search is returned. The response contains information stored in your LDAP server:

    UID=UserName, ou=GroupName, ou=OrganizationName, dc=ComputerName, dc=CompanyName

    GroupName is returned by WorkflowSystem.AdLdap.GroupSearchBase. OrganizationName, ComputerName, and CompanyName are returned by WorkflowSystem.AdLdap.rootDN.

  • Test the User search base by entering this command at a command prompt:

    ldapsearch -D "WorkflowSystem.AdLdap.ManagerDN" -x -W -b "WorkflowSystem.AdLdap.UserSearchBase,WorkflowSystem.AdLdap.rootDN" -h "WorkflowSystem.AdLdap.Server" -s sub "(WorkflowSystem.AdLdap.UserSearchFilter=User.ID)"

    Data containing the user search is returned if communications between RICOH ProcessDirector and your LDAP server are working correctly. The response contains information stored in your LDAP server:

    UID=UserName, ou=OrganizationUsers, ou=OrganizationName, dc=ComputerName, dc=CompanyName

    OrganizationUsers is returned by WorkflowSystem.AdLdap.UserSearchBase. OrganizationName, ComputerName, and CompanyName are returned by WorkflowSystem.AdLdap.rootDN.

1.2.4.41.9 Installing a security certificate for a web site

Before you exchange data with a secure web site, install the security certificate for that web site. The process involves downloading the certificate from the web site and adding it as a trusted certificate to your Java Virtual Machine (JVM) Trust Store.

Note: RICOH ProcessDirector supports security certificates signed by a certificate authority. It does not support self-signed certificates.

To install a security certificate for a web site:
  1. Export the security certificate that the secure web site requires:
    1. Open a browser and navigate to the secure web site.
    2. Click the lock icon on the address bar.
    3. View the certificate and copy it to your computer.

      The steps to view and copy (or export) the security certificate differ for each browser. For detailed instructions, search the browser help system.

  2. Copy the security certificate to the RICOH ProcessDirector primary server.
  3. On the command line of the primary server, enter this command:

    keytool -import -trustcacerts -alias name -file directorypath_filename -keystore /opt/infoprint/ippd/jre/jre/lib/security/cacerts -storepass changeit

    Replace name with a unique name for the certificate. You use the alias in keytool commands to access the certificate in the keystore.

    Replace directorypath_filename with the directory path and file name of the certificate that you copied to the server.

    The default password is changeit. To change the default password, see the Java keytool documentation about changing passwords. If the password has been changed, see your administrator to get the new password. Type it as the value of the storepass parameter.

    The system displays certificate data followed by this prompt: Trust this certificate?

  4. Enter: yes
  5. To use the certificate, restart RICOH ProcessDirector. Enter: stopaiw -d ; startaiw
  6. If a RICOH ProcessDirector secondary server runs steps or hosts input devices that exchange data with the web site, repeat these steps for the secondary server.

1.2.4.42 Instructing new users about logging in to RICOH ProcessDirector

After you set up user names and groups (or set up authentication using LDAP), tell your users how to log in to the RICOH ProcessDirector system.

Give each user this information about the installation:

Web browser configuration
Users can access the login page from a workstation using a Web browser. Before they access the login page, users and administrators must customize certain settings for their Web browsers, such as the setting for cookies and active scripting.
User name
Tell users the user names and temporary passwords that you created for them. Users must change their passwords the first time they use the system.
Note: If you set up authentication using LDAP, tell users to log in using their LDAP user ID and password.
URL for the RICOH ProcessDirector user interface
The URL that all users use to access the RICOH ProcessDirector interface is: http://[hostname]:15080/pd. The name of the computer where the RICOH ProcessDirector base product is installed is hostname.
Login authority
Users are authorized to do actions based on the group that you assign them to. Tell users what types of actions they can do in the RICOH ProcessDirector user interface.
Note: Make sure that you tell your users about this information center and how they can access it. The URL for the information center is available on the help menu. You can save a link and open the information center from anywhere in your network, even if you are not currently logged in to RICOH ProcessDirector.

1.2.4.42.1 Configuring Google Chrome

To access the RICOH ProcessDirector user interface from the Google Chrome Web browser, configure the browser with these settings:
  1. In the Chrome address bar, enter: chrome://settings/
  2. Under Privacy and security:
    1. Click Cookies and other site data and select Allow all cookies.
    2. Go back to Privacy and security and click Site settings. Scroll down to Content and click JavaScript. Make sure Sites can use Javascript is turned on.
  3. If you want to use the viewer component of RICOH ProcessDirector, you must verify that Chrome is configured to open PDF files in its built-in PDF viewer:
    1. In the Chrome address bar, enter: chrome://settings/content/pdfDocuments
    2. Make sure that the Open PDFs in Chrome is selected.
      Some actions (such as highlighting search text or using small or large zoom values) do not function properly when you use the built-in viewer with RICOH ProcessDirector.
  4. Close the settings tab.

1.2.4.42.2 Configuring Mozilla Firefox

To access the RICOH ProcessDirector user interface from a Windows computer with the Mozilla Firefox Web browser, you must configure the browser.
Important: The instructions to configure your version of Mozilla Firefox might differ from the instructions below. If any of the instructions do not work with your version of Firefox, click Help Help and search the Firefox help system. For example, search for enable javascript. As an alternative, use a search engine. For example, search for Firefox enable javascript.
To configure Mozilla Firefox:
  1. In the Firefox address bar, enter: about:config.
  2. Click I accept the risk!.
  3. To verify that Javascript is enabled:
    1. Find the javascript.enabled preference.
    2. Make sure the value is set to True.
      If the value is set to False, double-click the javascript.enabled preference to change the value to True.
  4. If you want to use the RICOH ProcessDirector right-click context menu, verify that the menu is enabled:
    1. Find the dom.event.contextmenu.enabled preference.
    2. Make sure the value is set to True.
      If the value is set to False, double-click the dom.event.contextmenu.enabled preference to change the value to True.
  5. Close the about:config tab.
  6. Click Menu Button Options.
  7. To make sure that Firefox can accept cookies:
    1. Click the Privacy & Security ()tab.
    2. In History, select Use custom settings for history to tailor cookies. Ensure Accept cookies from sites is selected.
  8. Optional: To change how files are downloaded:
    1. Click the General () tab.
    2. In the Downloads area, select Always ask you where to save files.
  9. Optional: If the Language feature is installed, you can change the language that RICOH ProcessDirector uses for the user interface text and most of the messages that it issues:
    1. In Language, click Choose and follow the instructions to add your language to the top of the list. Then click OK.
      Note: RICOH ProcessDirector supports these languages and locales:
      • Brazilian Portuguese (pt_BR)
      • English (en_US)

      • French (fr_FR)
      • German (de_DE)
      • Italian (it_IT)
      • Japanese (ja_JP)
      • Spanish (es_ES)
  10. Optional: When you install Firefox, it is configured to use a built-in PDF viewer. You can use the built-in PDF Viewer with RICOH ProcessDirector, but some actions (such as zoom and highlighting search text) might not function properly.

    In some cases, using a different plugin provides more functionality. Depending on the version of Firefox that you are running, you might need to try different options to find one that works with the RICOH ProcessDirector viewer.

    To set up the browser to use a different plugin for the viewer, do these steps:

    1. In Applications, go to the Content Type list, find Portable Document Format (PDF), and select it.
    2. Next to Portable Document Format (PDF), select the PDF plug-in you want to use.
    3. Try to view a job in RICOH ProcessDirector to see if it meets your needs.
    4. Repeat this process until you find the plugin that works best for you.
  11. Optional: In general, we do not recommend logging in to RICOH ProcessDirector as more than one user from the same workstation. If you do, each user must log in to a different browser session. To make this possible, you must create a browser profile for each additional user ID and enable Firefox to use more than one profile at a time:
    1. Close Firefox.
    2. Click Start Run.
    3. Enter this command:
      firefox.exe -ProfileManager
    4. Follow the instructions in the Profile Manager to create a new profile.
    5. In the Windows Control Panel, click System Advanced system settings Environment Variables.
    6. In the System Variables area, click New.
    7. In the Variable name field, type MOZ_NO_REMOTE.
    8. In the Variable value field, type 1.
    9. Click OK to close the New System Variable window.
    10. Click OK to close the Environment Variables window.
    11. Click OK to close the System Properties window.
    Whenever you start Firefox, you will be able to choose a profile that is not already in use.

1.2.4.43 Customizing the user interface

The RICOH ProcessDirector user interface lets you change the size, location, and contents of portlets. You can even create custom portlets to display property combinations in a structure that is meaningful for your operations. It also lets you change how often the information is refreshed. You can change the background color for the RICOH ProcessDirector pages to identify the system at a glance.

1.2.4.43.1 Changing the layout of the Main page

You can change the layout of the Main page of the RICOH ProcessDirector user interface to make it more useful for the tasks you do. You can rearrange and close portlets as well as resize areas within the page.

The Main page is divided into areas. Portlets can be moved up and down within an area and from one area to another.

  • To move a portlet, place the cursor on the title bar, click and hold the left mouse button, and drag the portlet to the new position. When the cursor moves over a position where the portlet can be dropped, the area is highlighted.
  • To close a portlet, click the Close icon (Close icon).
  • To open a portlet again, hover over the Main tab until the menu appears, then select the name of the portlet.
  • To resize all the portlets to fill the screen, hover over the Main tab until the menu appears, then select Fit portlets to window.
    Main tab menu
  • To resize an area, hover on the bar between portlets. When you see the double arrow cursor (Double arrow cursor), hold the left mouse button and drag the cursor.

1.2.4.43.2 Managing views

You can rearrange the portlets on the Main page of the user interface so the layout is more useful for your tasks or your environment. When you create a layout that you like, you can save it as a customized view. Then, you can change the Main page to use any customized views that you have saved or return to a default view.

A customized view contains what portlets are open, their size, location on the Main page, the order and size of columns in the tables in the portlets, applied filters, and whether the favorite filter is applied. Which objects are favorites are not saved in the view.

By default, all saved views are private, so only the person who created them can use them. However, you can choose to make the view public. Public views can be used by anyone who logs in to RICOH ProcessDirector.

If you ever have to move to a new primary computer, you can export the customized views from the current system and import them to a new system. If a view is no longer needed, you can delete it.
  • To save a customized view:
    1. Hover over the Main tab until the menu appears, then click Save the current view ().
    2. In the Save view dialog, type a name for the view.
    3. Select Public if the view should be shared with other users.
    4. Click OK.
  • To change to a different view:
    1. Hover over the Main tab until the menu appears, then choose a view from the Saved Views list.
      If you make changes to your layout and want to return to your default view, click Apply my default view.
      After you select a view from the Saved Views list, a dot appears next to the current view. If you make changes to the view, the dot changes to a circle.
  • To update a view:
    1. Hover over the Main tab until the menu appears, then choose the view you want to update from the Saved Views list.
    2. Update the layout of the Main page.
    3. Hover over the Main tab until the menu appears.
      You see a circle next to the current view.
    4. Click Save the current view (), enter the name of the saved view you want to update, and specify whether the view is Public or Private.
    5. Click OK to save the updated view.
    6. In the confirmation window, click OK again.
  • To delete a saved view:
    1. Hover over the Main tab until the menu appears, then hover over the view you want to delete in the Saved Views list.
    2. Click the X that appears to the right of the view name to make it red. Click the red X to delete the view.
  • To export a saved view:
    1. Hover over the Main tab until the menu appears, then select Settings () Export current view.
    2. Enter a name for the view.
    3. Specify whether the view is Public or Private.
    4. Click OK.
      The file is downloaded. If your browser is configured to let you choose where to save files, you can choose where to store the file and give it a different name.
  • To import a saved view:
    1. Hover over the Main tab until the menu appears, then select Settings () Import saved view.
    2. Specify the full path and file name of the saved view to import.
    3. Click OK.
  • To set a default view for all users in a group:
    1. Click the Administration tab.
    2. In the left pane, click Security Groups.
    3. Click the name of the group you want to change the default view for.
    4. Change the Default Main page view value to the saved view you want the users in the group to use.
    5. Click OK.
      Note:
    • You can only export and import one saved view at a time on the Main page. Use the Export and Import functions on the Administration page if you need to move multiple saved views.

1.2.4.43.3 Setting a start page

You can customize RICOH ProcessDirector to display a specific page when you log in.
To set a start page:
  1. Click the user icon in the top right corner and select Preferences.
  2. Select the page from the Start page list.
  3. Click OK.

1.2.4.43.4 Adding custom portlets to the Main page

RICOH ProcessDirector provides several options to create custom portlets showing property combinations in a structure that is relevant to your operation.
Before you begin, make sure that you know what type of custom portlet you want to create.

To add a custom portlet to the Main page:

  1. On the Administration page, click MAIN PAGE Custom Portlets .
      Note:
    • After you create your first custom portlet, you can create more from the Main page. Hover over the Main tab and click Add a custom portlet ().
  2. Click Add to add a new custom portlet type.
  3. On the General tab, fill in values for all the required fields.
  4. On the Objects To Show tab, select the Object type that you want to display in the custom portlet.
    To limit the number of objects that are included in the portlet, define one or more conditions to use to filter the objects that are displayed in the portlet. Each condition consists of a property, a comparison, and a value. For example, if you want to exclude jobs in the Complete phase, add a condition of Current phase is not Complete.
    • To define an additional condition, click the plus sign () to the right of any condition.
    • To delete a condition, click the minus sign () to the right of the condition you want to delete.
      Note:
    • When selecting the Numeric portlet, the Objects To Show tab is only visible when including a new indicator.
  5. On the Presentation tab, select how you want to display the information on the Main page.
    • For Matrix, select the properties for rows and columns used to define the matrix portlet. One column is the count of the objects and other columns can be added if they have values that can be summed such as number of pages. If you want to include a row that displays the sum of each column, select Yes for Show totals row field.
    • For Tree, select the hierarchy of properties that form the rows. One column is the count of the objects and other columns can be added if they have values that can be summed such as number of pages.
    • For Numeric, add an indicator and select the property that the indicator counts.You can add more than one indicator to a portlet and use multiple types of objects in the same portlet.
  6. On the Display Preferences tab, select what happens if the user clicks a cell in the portlet.
    • Select Fixed Portlet to filter the Jobs table, replacing any other filters that were active. This option is only available if Jobs is the object type contained in the custom portlet. This option is available only for Matrix and Tree styles.
    • Select Floating Window if you want to open a floating window showing only the objects counted in the cell selected in the custom portlet.

      You can save details about the last position and size of the columns in the floating window. Or, you can allow more than one floating window to be opened from the custom portlet at the same time.

  7. To save your custom portlet and add it to your Main page, click OK. Other users can select the new portlet from the list of portlets on the Main tab when they next click it.

1.2.4.43.5 Displaying system identification

If you have several systems with names that are not distinctive, you can customize them to make it easier to see which system you are working on. The system can display a nickname on the banner area of the user interface or a different background color on each page.
To display system identification:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the General section, find System identification.
  4. Select Background color to apply a color from the Color list to the background of most pages in the interface.
  5. Select Banner label to display the System identifier on the application banner.
  6. Choose a meaningful nickname for the System identifier property; for example, Test or Production.
  7. Go to Color and select a color for the banner label and the background color.
  8. Click SAVE.

You see the nickname on the banner area of the user interface:

User interface banner with alternate system name

You see the background color on the System settings page:

User interface colored background

1.2.4.43.6 Changing phase names

You can change the default phase names to better match the functions that you perform in that phase.
To change the default phase names:
  1. Click the Workflow tab.
  2. In the left pane, click Phases.
  3. In the phase name fields, enter new phase names.
  4. Click Save.

1.2.4.43.7 Changing the color of a step

You can use this function to highlight steps in a workflow for a variety of reasons. For example, you can make conditional paths display in different colors so that it is easier to understand the processing flow. Or you can make any steps that require manual intervention or send the job to a different workflow display in red.

When you change the color of a step, the property values of that step and its connectors remain unchanged. Any jobs that are currently processing in the step are not affected.

To change the color of a step:

  1. Click the Workflow tab.
  2. Click the name of the workflow that you want to update.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. In the workflow editor, right-click the step you want to change and select Properties.
  5. Select a color from the Step color drop-down list.
  6. Click OK.
  7. Save and enable the workflow.

1.2.4.43.8 Filtering tables

You can control the items that are displayed in various tables by defining a filter. When you apply a filter, only objects that meet the specified criteria are displayed.
To filter a table:
  1. If the Advanced filter section is hidden, click the Gear menu button, then click Show Advanced Filter.
    The Advanced filter area appears. This example shows the Advanced filter on the Jobs table.Jobs table with Advanced filter area open; filter not set
  2. Set the conditions for the filter using the Property field, the Comparison field, and the Value field.
      Note:
    • To find objects that have a null value (no value or Not set) for the specified property, select the Comparison value has no value (notset). Objects that have a null value are not found when you use another Comparison value, such as is not (!=) or is not like (unlike). The example at the end of this procedure finds objects that have values and objects that have a null value.
  3. Optional: To add more conditions, click + to the right of any condition and set values for the Property, Comparison, and Value fields.
  4. Select how the conditions for the filter are combined from the list.
      Note:
    • If you choose Custom, enter your condition combination formula in the text field. Refer to the field help for more information.
  5. Click Apply filter.
    The filter is set. The table content reflects the filter that you set.

    Jobs table with Advanced filter area open; filter set

  6. Optional: To minimize the Advanced filter area, click the arrow to the left of the Advanced filter title.
    Jobs table with Advanced filter area open; filter set
  7. Optional: To close the Advanced filter area, click the Gear menu button, then click Show Advanced Filter.
    If a filter has been set, the Advanced filter area closes and the filter remains set.

    Jobs table with Advanced filter area open; filter set

  8. To remove a condition from the filter, click Remove filter button in the gray box that contains the condition.
  9. To turn off all of the filters, change the Advanced filter switch to the Off position.
    Advanced filter switch in Off position.

Example

To display all jobs that do not have a Job priority of 1, specify these conditions:

  • Job priority is not (!=) 1
  • Job priority has no value (notset)

Apply the conditions when any of them are true.

1.2.4.43.9 Changing table columns

You can customize the columns of any object table. You can change the width of table columns, add or remove columns, and reorder columns.

To change the width of table columns, click the separator between two column headings and drag it to a new position.

To change the order of the columns, click a column heading, drag it to a different position, and release the mouse button.

To make any other changes to the table columns:

  1. Open the Manage Columns area:
    1. At the top right of any portlet, click Settings (image of the settings icon) and select Manage Columns.
    Manage columns area of the Jobs table
    Manage columns area of the Jobs table
  2. To add columns to the table, select the check box next to the property name.
  3. To remove columns from the table, clear the check box next to property name.
  4. To change the order of table columns, select a property name and drag it to a new location. To reorder a selected property name using the keyboard, use the controls to the right of the name to move it to a new location.
    Highlighted row in the Jobs table
    • Click to move the property name up one row.
    • Click to move the property name to the top of the list.
    • Click to move the property name down one row.
    • Click to move the property name to the bottom of the list.
  5. To save your changes, click OK.

To remove all the changes that you made to the table columns, select Settings (image of the settings icon) Manage columns, then click Restore defaults and click OK.

1.2.4.43.10 Turning the print progress bars on or off

AFP, PCLOut, Ricoh PDF, and Ricoh TotalFlow printers can show a print progress bar that shows the percentage of pages printed. You can turn the print progress bars on or off for all the AFP, PCLOut, Ricoh PDF, and Ricoh TotalFlow printers in the Printers portlet.
To turn the print progress bars on or off:
  1. Click the Main tab.
  2. Make sure the % Printed column is displayed in the Printers portlet.
    1. At the top right of the Printers portlet, click Settings () button, then click Manage Columns.
    2. Select the check box next to the % Printed property.
    3. Click OK.
  3. Click the Administration tab.
  4. In the left pane, click Settings System.
  5. Change the Print progress bar property:
    Yes
    The progress bar is displayed for AFP, PCLOut, Ricoh PDF, and Ricoh TotalFlow printers.
    No
    The progress bar is not displayed for AFP, PCLOut, Ricoh PDF, and Ricoh TotalFlow printers.
  6. Click SAVE.

1.2.4.44 Show totals for selected jobs

You can show totals of many numeric job properties for selected jobs in the RICOH ProcessDirector system using the Show Totals Footer function on the Jobs table. By default, Total pages and Total sheets are shown. You can change what properties are displayed in the footer. The properties you choose must be included as columns in the Jobs table.
To add the totals footer on the Jobs table:
  1. In the Jobs table, select the job or jobs that you want to see totals for.
  2. In the right corner of the Jobs table, click the Settings () icon, then click Show Totals Footer.
    The Totals Footer opens at the bottom of the Jobs table.
      Note:
    • If you select Show Totals Footer without selecting a job, the footer will not appear.
    • If one or more child jobs are selected with their parent job, the totals are not adjusted for the duplicate entries. Select only the parent or the children to get the correct totals.
  3. To change what job properties are displayed in the footer, right click on the footer area and select Choose Footer Properties.
  4. To add properties to the footer, select the check box next to the property name.
  5. To remove properties from the table, clear the check box next to property name.
  6. To change the order of properties, select a property name and drag it to a new location. To reorder a selected property name using the keyboard, use the controls to the right of the name to move it to a new location.
  7. To save your changes, click OK.
  8. To hide the totals footer, right click on the footer area and select and select Hide Totals Footer.

1.2.4.45 Changing the job information shown in the Printers portlet and on the printer console

By default, the Printers portlet in the user interface shows the number of the job that is printing. RICOH ProcessDirector lets you show the job name instead of the job number.

RICOH ProcessDirector also lets you show the job name or the job number:

  • On the printer console for an AFP or Kodak printer.
  • In the job completion log for AFP and PCLOut printers.

    Note:
  • For Ricoh PDF and Custom PDF printers, RICOH ProcessDirector puts the value of the Job identifier to use property in the JDF file. Settings for the printer device in RICOH ProcessDirector and on the control unit of the printer determine how the job is displayed on the printer console.
  • The printer console for a Xerox printer shows the job number even when the Job identifier to use property is set to Job name.
  • Passthrough printers use a command to specify the information sent to the printer. The most common commands result in the printer console displaying the job number even when the Job identifier to use property is set to Job name. To display the job name on the printer console, prepend a command that copies the print file to a file with the job name. Use a symbol for the job name in the command that sends the file to the printer. See the examples at the end of this procedure.
  • The AFP Support feature adds AFP and PCLOut printer devices to RICOH ProcessDirector. The Cut Sheet Support for Kodak feature adds Kodak printer devices. The Cut Sheet Support for Xerox feature adds Xerox printer devices.

To change the job information shown in the Printers portlet and in the job completion log:

  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. On the System Settings page, change the value of the Job identifier to use property:
    • Job name

      Displays the job name for print jobs.

    • Job number

      Displays the job number for print jobs.

    To see the name and number of a job in the Printers portlet, hover the mouse pointer over the job name or number.

Example of Passthrough printer commands that display the job number or job name on the printer console

You can use this command to send a Passthrough printer a PDF file with the job number:

cp ${getCurrentFile(pdf)} /aiw/aiw1/spool/default/${Job.ID}.pdf && lpr -P printerName -S printer_IP_address /aiw/aiw1/spool/default/${Job.ID}.pdf

The example copies the print file to the spool directory and renames the file with the job number. As an alternative, you can copy the file to the tmp directory.

This command sends the printer a PDF file with the job name:

cp ${getCurrentFile(pdf)} /aiw/aiw1/spool/default/${Job.Name} && lpr -P printerName -S printer_IP_address /aiw/aiw1/spool/default/${Job.Name}

The example copies the print file to the spool directory and renames the file with the job name. As an alternative, you can copy the file to the tmp directory.

1.2.5 Managing system objects

The RICOH ProcessDirector system includes a variety of objects that you might need to work with, including servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects.

1.2.5.1 Viewing object properties

The properties of an object are the characteristics that a user defined, or the status information that RICOH ProcessDirector supplied. Objects include servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects as well.
To view the properties of an object:
  1. Open the property notebook for the object:
    • From the Main page:
      1. Find the object in its portal.
      2. Click the name of the object.
    • From the Administration page:
      1. In the left pane, click the object type.
      2. In the table, click the name of the object.
  2. In the property notebook, click the tabs to see different properties, or click Show all tabs to display all the properties on a single page.
  3. To see information about any of the properties, click the Question mark icon icon next to the property name.

1.2.5.2 Updating object properties

You can update the properties that define the characteristics of an object. Objects include servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects.

Before you update the properties of some objects, make sure that the object is disabled.

Before you update the properties of a workflow, note that:

  • You can change job default properties in the workflow while jobs are still in the system. However, those values are not changed in existing jobs that use the workflow. To apply the new values, process the job again from a step before all the steps that use the updated properties.
  • If you add or remove steps or connectors in a workflow that has jobs in it, any jobs in the system that were being processed by that workflow can only be restarted at the beginning of the workflow.
  • If you add steps in a workflow that has jobs in it, values set for any properties added to the job by those steps are applied to the jobs that are active in the workflow. Values changed on any properties that were already set in the workflow are updated when you select the Process again action.
  • If you delete steps in a workflow that has jobs in it, any property values set by the deleted steps remain set on the job and are still used by connectors as the job moves forward in the workflow.
  • If you add or delete connectors in a workflow that has jobs in it, all changes to the connectors are applied to the jobs as they move forward in the workflow.

  • To update the properties of an object:
    1. Open the properties notebook for the object:
      • From the Main page:
        1. Find the object in its portal.
        2. Click the name of the object.
      • From the Administration page:
        1. In the left pane, click the object type.
        2. In the table, click the name of the object.

        Note:
      • To update the properties for multiple jobs, find the jobs in Jobs portlet, select the jobs you want to update, and click Update Multiple.

    2. Select or type new values for the properties as needed.
    3. To see information about any of the properties, click the Question mark icon icon next to the property name.
    4. Click OK.
  • To view and change the properties of multiple jobs:
    1. In the Jobs table, select the jobs you want to work with and select Update Multiple.
    2. Select a property you want to change from the list. Then select or type new values for the property.
    3. To add an additional property, click the plus sign to the right of your last entry.
    4. To delete a property, click the minus sign to the right of the entry you want to delete.
    5. Click OK.
  • To set the default values for job properties in a workflow without editing steps:
    1. Open a workflow.
    2. Right-click on the workflow editor and select Manage job defaults.
    3. Find the property you want to change and specify the new value.
    4. If the property is not in the list, use the Add a property field to select the property and its value.
    5. If you want to remove the value from a property in the list, hover over the property in the list and select the X that appears to the right of the value field.
    6. After you complete your changes, click OK.
Note:
  • For some updates for printers to take effect, RICOH ProcessDirector disables and shuts down the printer, then starts up and enables the printer automatically.
  • For some updates for input devices to take effect, you must disconnect the input device and then connect it again.

1.2.5.3 Deleting objects

You can delete an object if it is no longer needed. Objects include servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects as well.

Before you delete an object:

  • Make sure that no job or workflow specifies the object in the job properties.

    For example, to delete a printer, make sure that none of the jobs in the system have that printer set for the Requested printer property.

  • If you delete a printer, make sure that no jobs are currently assigned to it. The name or number of the current job is below the printer icon in the Printers portlet.
  • If you delete media, make sure that media is not currently ready in any printer input trays.
To delete an object:
  1. Click the Administration tab.
  2. In the left pane, click the object type.
  3. If necessary, right-click the object and select Disable or Disable and Disconnect.
  4. Right-click the object and select Delete.
  5. On the confirmation dialog, click OK if you are sure that you are deleting the correct objects.
    Note:
  • You cannot delete some of the objects that RICOH ProcessDirector provides.
  • Deleting an input device also deletes any input files associated with it.

1.2.5.4 Exporting objects

To reuse objects on another RICOH ProcessDirector system, you can export them for use on the other system. On the other system, you then import the objects. Examples of objects are input devices and printers.

If you are using the Preprinted Forms Replacement feature, follow the instructions in the help system for exporting media objects with electronic forms.

To export objects:

  1. Click the Administration tab.
  2. Disable all pop-up blockers in your browser because the export file opens in a pop-up window.

    If a pop-up blocker is running, you cannot save the export file.

  3. In the left pane, click Utilities Export Objects.
      Note:
    • To export all the objects in the system, click the Settings menu (image of gear menu) and select Export all system objects.
    • To export specific objects in the system, continue to the next step.
  4. Select the type of object to export from the Add objects by type list.
  5. Select the objects to export and click Add to export list.
  6. Optional: In the Objects to Export table, select the objects you want to add references to and click Add references.
      Important:
    • Step resources referenced by other objects are not added to the export list by the Add references action.
  7. Repeat these steps for any other objects you want to export.
  8. Optional: To remove one or more objects from the Objects to Export table, select the objects you want to remove and click Remove from list.
  9. In the Objects to Export table, select the objects you want to export and click Export.
    Note:
  • When you export custom document properties and import them into Version 3.10 or higher, copy the C:\aiw\aiw1\config\docCustomDefinitions.xml file to the new RICOH ProcessDirector system.
  • When you export objects, include all objects that are referenced in workflows in the export file. For example, workflows may include a PrintJobs step template that specifies the name of a printer requested for the job in the Requested Printer job property. If that printer object is not included in the export file, the import on the new RICOH ProcessDirector fails.
  • You can only export Password, Session, and Static credentials. RICOH Cloud and Private Key credentials must be generated on the computers where they are used, so they cannot exported.
  • When you export objects that reference credential objects, the credential objects are included in the export file.
  • If you created a custom portlet on a RICOH ProcessDirector system prior to version 3.10.1, you cannot import it to a system with RICOH ProcessDirector version 3.10.1 or later. Create the custom portlet again.
  • When you export step resources, the files that they refer to are not included in the export package. Copy the files referenced in the step resources from the export system to the import system manually. You must copy the files to the import system before you import the step resource objects.
    • To export all the step resources, copy the contents of /aiw/aiw1/StepResources from the export system into the same directory on the import system.
    • To export specific step resources, open the XML file that you exported. Find the entry for each step resource that you exported and locate the StepResource.File property. In that value, find the name of the RSC file associated with that step resource. For example, in this value:
      • <property name="StepResource.File" value="{&quot;fileName&quot; : &quot;/aiw/aiw1/StepResources/ 1992052c6ef44a229b8b43d77232bf53.rsc&quot;,&quot;displayName&quot; : &quot;Ricoh_Export-2019-08-26_13-30-04.xml&quot;}"/>

      The file name is: 1992052c6ef44a229b8b43d77232bf53.rsc

      Find the file on the export system and copy it into the same directory on the import system.

1.2.5.4.1 Exporting media with electronic forms

To reuse media objects with electronic forms on another RICOH ProcessDirector system, you can export them by copying the media.zip file to another system. The Export Objects function exports media objects but does not export the electronic forms defined for media objects.
RICOH ProcessDirector creates a media.zip file whenever you define, edit, rename, or delete a media object.
To export media with electronic forms:
  1. Log in to the primary computer.
  2. Go to this directory:

    • /aiw/aiw1/share on Linux
    • C:\aiw\aiw1\share on Windows

  3. Copy the media.zip file to the system that you are exporting the media to.
  4. Log in to the RICOH ProcessDirector primary computer on that system and put the media.zip file in this directory:
    • /aiw/aiw1 on Linux
    • C:\aiw\aiw1 on Windows
  5. Extract the media objects from the media.zip file.
    Extracting the media objects:
    • Puts a media.xml file in the same directory as the media.zip file.
    • Adds all electronic forms defined for the media to this directory:
      • /aiw/aiw1/constantforms on Linux
      • C:\aiw\aiw1\constantforms on Windows

    If the constantforms directory has another version of an electronic form, the file extraction process asks if you want to replace the form. For example, the constantforms directory could have copies of the sample forms installed with the Preprinted Forms Replacement feature.

    • To extract only forms that are not on the system where you are importing the media objects, choose the option to replace none of the files.
    • To replace all the forms on the system with the version of the forms in the media.zip file, choose the option to replace all the files.

  6. Make sure that the RICOH ProcessDirector system user and group ( aiw1 and aiwgrp1 are the defaults) have permission to read and modify these files and directories:
    • The constantforms directory
    • All electronic forms in the constantforms directory
  7. Import the media objects:
    1. Click the Administration tab on the user interface of the system where you are importing the media objects.
    2. In the left pane, click Utilities Import Objects.
    3. Click File to Import.
    4. Go to this directory:
      • /aiw/aiw1 on Linux
      • C:\aiw\aiw1 on Windows
    5. Select the media.xml file.
    6. Select the media objects that you want to import.
    7. To make sure that you do not update media objects that exist, click Deselect existing objects.
    8. Click Import.
    For more information about importing objects, see the related task for copying objects from another system.

1.2.5.5 Viewing object logs

You can view the log for an object to see messages about its operations, such as property or state changes. Objects include servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects as well.
Object logs contain messages issued in the last 3 days. After 3 days, the log information is moved to audit files in the /aiw/aiw1/audit/object type directory. However, job logs remain in the system as long as the job does. When the job is deleted, the log information is moved to the audit files.

Audit files remain in the system for 28 days and then are automatically deleted. There is no size limit for logs.

Log entries are sorted by the Time column, from the newest to the oldest entry.

The timestamp in an exported log is displayed in Greenwich Mean Time (GMT) followed by a plus sign (+) or a minus sign (−) and an offset representing the number of hours that the local time of the issuing system is ahead (+) or behind (−) GMT. However, the timestamp in an object log being viewed in RICOH ProcessDirector is displayed in the time zone of the browser that you are using.

To view the log for an object:

  1. Do one of these:
    • From the Main page:
      1. Find the object in its portal or table.
      2. Right-click the object and select View Log.
    • From the Administration page:
      1. In the left pane, click the object type.
      2. In the table, right-click the object and select View Log.
  2. You see the messages that were issued. All the message times are displayed in the time zone of the browser that you are using. If the text of a message is truncated, click the message entry. You see the complete text of the message at the bottom of the window.
  3. To sort the messages by message type or by another column, click the column heading.
    Click once to sort in ascending order; click twice to sort in descending order.
  4. To change what you see in the log, change the value of the Type and Range properties:
    Type
    By default, you see messages of all types. To only show certain types of messages, choose a value from the list.
    Range
    Select All to see all of the messages in the log, filtered by the Type setting. Select Custom to limit the number of messages to a certain number of days or hours. Specify the days and hours in the Issued within property.

1.2.5.6 Enabling objects

Enabling an object makes it available to RICOH ProcessDirector. Objects include servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects as well.
An input device can receive input files if it is connected and disabled, but it must be enabled to create RICOH ProcessDirector jobs and send those jobs for further processing.
To enable an object, do one of these:
  • From the Main page:
    1. Find the object in its portal.
    2. Right-click the object and select Enable.
  • From the Administration page:
    1. In the left pane, click the object type.
    2. In the table, right-click the object and select Enable.
    Note:
  • After RICOH ProcessDirector enables an input device or printer, the symbol next to it changes to the enabled symbol, which is a solid green arrow.
  • After a system shutdown and restart, all the printers are disabled. If you want all the printers that were enabled before the shutdown to be enabled after the system is restarted, you can change the Remember enabled status of printers property value to Yes on the System page of the Administration tab.
  • Secondary servers enable any input devices and printers that the server manages.

1.2.5.7 Disabling objects

Disabling an object makes it unavailable to RICOH ProcessDirector. Objects include servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects as well.
A disabled input device can still be connected and receive input files.

Jobs that are already scheduled to a disabled printer still print on it, unless they are scheduled to a different printer.

    Note:
  • Shutting down a printer both disables it and releases it from RICOH ProcessDirector, while simply disabling it does not release it. Other programs can send jobs to a shutdown printer, but not to a disabled printer that has not been shut down.

To disable an object:

  1. Do one of these:
    • From the Main page:
      1. Find the object in its portal.
      2. Right-click the object and select Disable.
    • From the Administration page:
      1. In the left pane, click the object type.
      2. In the table, right-click the object and select Disable.
  2. If you see a confirmation message, click Yes.
    Note:
  • After RICOH ProcessDirector disables an input device or printer, the symbol next to it changes to the disabled symbol, which is a broken orange arrow.
  • After a system shutdown and restart, all the printers are disabled. If you want all the printers that were enabled before the shutdown to be enabled after the system is restarted, you can change the Remember enabled status of printers property value to Yes on the Administration Settings System page.
  • When you disable a secondary server:
    • The server is still connected to the RICOH ProcessDirector primary server, so there is communication between them. You can still work with that server through the Web interface. For example, you can change properties and then enable the server again when you are ready.
    • The server does not become idle immediately after it is disabled; it finishes the jobs that it is currently processing and sends results to RICOH ProcessDirector.
    • RICOH ProcessDirector disables any printers that are associated with the secondary server. Any jobs in the system that are already assigned to printers on those servers still print, unless you move them to a different printer. RICOH ProcessDirector does not schedule additional jobs to those printers.
    • RICOH ProcessDirector changes the connection status of any input devices that are associated with a disabled secondary server to Unable to connect. RICOH ProcessDirector automatically connects the input device when you enable the secondary server again.

1.2.5.8 Compiling a list of objects and their properties

You can compile a list of objects and the properties that define their characteristics. To compile the list, you export the entries in an object table to a Comma-Separated Values (CSV) file.

This action supports all object types for the base product, its features, and its extended features. Examples in the base product include input devices, printers, jobs, media, locations, users, and groups. Examples in features include barcode readers and inserter controllers.

The list contains entries only for objects that match all the filters that are set. For example, you type New York in the filter field Funnel icon of the Locations table. The list contains only entries for locations with New York in the value of one or more properties that are included as columns in the table.

The list contains all the properties shown in the object table. You can add properties to or remove them from the table. For more information about changing table columns, refer to the help system.

To compile a list of objects and their properties:
  1. Display the object table:
    • Click the Main tab.

      Each portlet for an object contains an object table.

    • Click the Administration tab.

      Select the object type.

  2. Make sure that the table includes the objects and properties that you want to compile.

    RICOH ProcessDirector compiles the list using only the objects and properties displayed in the table. To add or remove objects, adjust the filters that you set. To add or remove properties, change the table columns.

  3. Click the Gear menu button in the top right corner of the table and select Export table to CSV.
  4. Click OK.

    RICOH ProcessDirector exports the objects in the table as entries in a CSV file. The entries are sorted by object name.

1.2.5.9 RICOH ProcessDirector servers

A RICOH ProcessDirector system is made up of the primary server and, if needed, one or more application and secondary servers.

You can create secondary servers on Linux systems; you can install application servers on Windows systems. You might have to do tasks on the primary server, a secondary server, or an application server, such as starting, stopping, enabling, and disabling them. In some cases, the procedures for application and secondary servers differ among the operating systems.

1.2.5.9.1 Starting and stopping servers

The RICOH ProcessDirector base product and secondary servers can be configured to start and stop when the system they are installed on starts and stops. Application servers must always be started manually; they stop when the system they are installed on shuts down, but can also be stopped manually.

You might need to start or stop the base product, secondary servers, or application server without shutting down or restarting the system. You must start and stop the base product and each remote secondary server individually.

1.2.5.9.1.1 Starting the base product and secondary servers

RICOH ProcessDirector base product and secondary servers start automatically when the systems on which they are installed start. However, you might need to start the base product or a secondary server without restarting the entire operating system.

After a system shutdown and restart, all the printers are disabled. If you want all the printers that were enabled before the shutdown to be enabled after the system is restarted, you can change the Remember enabled status of printers system property to Yes.

To start the base product or remote secondary servers:

  1. Log in to the system as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Access the command line.
  3. Enter this command:
    • startaiw
  4. If the startaiw command fails, enter these commands:
    • stopaiw
    • startaiw
On the primary computer, the command starts the primary server, local secondary servers, the user interface program, and the information center. On a secondary computer, the secondary server starts and connects to the primary server.

1.2.5.9.1.1.1 Deactivating the base product or secondary server autostart script

If you do not want the RICOH ProcessDirector base product or secondary servers to start automatically when you restart the system on which they are installed, you can deactivate the autostart script.

RICOH ProcessDirector can be running when you deactivate the script.

To deactivate the autostart script:

  1. Log in as the root user.
  2. Access the command line.
  3. Remove two symbolic links from the script:
    1. Enter these commands:
      cd /etc/init.d
      ls rc*/*aiwserv
    2. Delete the files with names like rcn.d/Snnaiwserv and rcn.d/Knnaiwserv.
      n and nn are numbers that determine when the script runs. Note these numbers so that you can reactivate the autostart script.

1.2.5.9.1.1.2 Activating the primary or secondary server autostart script

If you previously deactivated the autostart script on the system, you can reactivate it. Reactivating the autostart script causes the RICOH ProcessDirector base product or secondary server to start automatically when the system starts.
Note: When you install RICOH ProcessDirector, the default is that it activates the autostart script. You need to activate the autostart script only if you previously deactivated it.
To activate the autostart script:
  1. Log in as the root user.
  2. Access the command line.
  3. Add two symbolic links to reactivate the script. Enter these commands:
    ln -s /etc/init.d/aiwserv /etc/init.d/rcn.d/Snnaiwserv
    ln -s /etc/init.d/aiwserv /etc/init.d/rcn.d/Knnaiwserv
    n and nn are numbers that determine when the script runs. You noted these numbers when you deactivated the autostart script.

1.2.5.9.1.2 Starting an application server

To run processing steps on an application server, the application server must be running. If the application server is not configured as a service, you must start the application server manually.
To manually start an application server:
  1. Log in to the Windows system as the user that the application server runs under.
  2. Start the application server. Use the Start application server link in the RICOH ProcessDirector start menu folder.

1.2.5.9.1.3 Starting and stopping Docker container secondary servers

Docker container secondary servers do not start and stop automatically when the computer they are installed on restarts or when you run the startaiw or stopaiw commands. You must start and stop them separately.

To start or stop Docker container secondary servers, run the appropriate command below.

  • If you created the container secondary server on the primary computer, run the command on the primary computer.

    Replace directory with: /aiw

    The path_to_script is not required on the primary server.

  • If you created the container secondary server on a different computer, run the command from the secondary computer.

    On a secondary computer, you must provide the full path to the script on the primary computer, including the directory that is mounted to the /aiw directory on the primary server. In the command below, replace these values:

    • path_to_script

      The full path to the script on the primary server, including the mounted directory. If the mounted directory is /aiw (as in the procedure above), the value is: /aiw/aiw1/bin/

    • directory

      The full path to the directory that is mounted to the /aiw directory on the primary server. In the procedure above, this directory is also /aiw.

  • To start a specific container secondary server, replace [secondary_name] with the name of that server. Omit this value to start all of the container secondary servers present on the Linux computer.

  • Start Docker container secondary servers on a computer:
    [path_to_script]containers.pl start directory[secondary_name]
  • Stop Docker container secondary servers on a computer:
    [path_to_script]containers.pl stop directory[secondary_name]

1.2.5.9.1.4 Stopping the base product and secondary servers

When you stop the RICOH ProcessDirector base product or a remote secondary server, you can stop the system with or without waiting for job-processing steps to complete. If you have the AFP Support feature installed, you can also choose whether to stop processes that were started by the RICOH ProcessDirector printer driver component, by Download for z/OS, or by AFP Download Plus.

After a system shutdown and restart, all the printers are disabled. If you want all the printers that were enabled before the shutdown to be enabled after the system is restarted, you can change the Remember enabled status of printers system property to Yes.

To stop the base product or a remote secondary server:

  1. Log in to the system as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Access the command line.
  3. Optional: To minimize the impact of shutting down the system on processes that are currently running, disable the input devices associated with the server.
  4. Enter one of these commands:
    • To stop the system immediately without waiting for steps to complete:
      • stopaiw

      Any steps that were in a processing state will move to an error state when you restart the system.

    • To stop the system after the currently processing steps are complete:
      • stopaiw -q
    • To stop the system and all processes that were started by the printer driver component, by Download for z/OS, or by AFP Download Plus:
      • stopaiw -t

      This option is only available on a primary computer with the AFP Support feature installed.

    On the primary computer, the command shuts down the primary server, local secondary servers, the user interface program, and the information center. If a remote secondary server is connected to the primary server when the primary server stops, the secondary server tries to reestablish the connection every 30 seconds, until it can connect or until the remote secondary server stops.

    On a secondary computer, the command disconnects the remote secondary server from the primary server and stops the secondary server.

1.2.5.9.1.5 Stopping an application server

You can stop an application server through the Windows Start menu. Stopping the server prevents RICOH ProcessDirector from accessing any external programs on the Windows system.
To stop an application server:
  1. Log in to the Windows system as the user that the application server runs under.
  2. Stop the application server. Use the Stop application server link in the RICOH ProcessDirector start menu folder.

1.2.5.9.2 Updating a primary computer host name or IP address

When the host name or IP address of a primary computer changes, you must update RICOH ProcessDirector to recognize the change.
Change the host name or IP address before you update RICOH ProcessDirector.
To update RICOH ProcessDirector:
  1. Log in to the primary computer as the root user.
  2. Start a command prompt.
  3. Enter this command. For oldhostname, use the old host name without the domain name:
    /opt/infoprint/ippd/bin/changeHostname.pl oldhostname
    The changeHostname utility shuts down RICOH ProcessDirector and updates the files listed here. The path name might be different if you used an install location that is not the default.
    • /aiw/aiw1/config/servers.cfg
    • /aiw/aiw1/config/communication.cfg
    • /home/aiwinst/sqllib/db2nodes.cfg
    Then it restarts RICOH ProcessDirector.

1.2.5.9.3 Recovering from an unplanned outage

If your primary computer becomes unavailable because of network problems, hardware failure, or software failure, you must shut down the system, fix all the problems on the primary computer so that it is available to the network, and then restart the system. If an application/secondary server is defined to the primary server when the primary server suffers an unplanned outage, that server attempts to reestablish the connection every 30 seconds, until it is able to connect or until it stops.
To recover from an unplanned outage:
  1. Use the stopaiw command to stop each secondary server that is installed on another computer.
  2. Stop any application servers that are running.
  3. Use the stopaiw command to stop the base product.
  4. Use the startaiw command to start the base product and any secondary servers on the same computer.
  5. Verify that any secondary servers that run on the same computer as the base product are enabled.
  6. Use the startaiw command to start each secondary server that is installed on another computer.
  7. Start any application servers you stopped.
  8. Enable the application and secondary servers that you just started.
  9. Enable and start your printers.
  10. Enable and connect your input devices.

1.2.5.9.4 Moving processing to and from a failover server

Failover servers are designed to take over processing in the event that your RICOH ProcessDirector production server suffers a catastrophic event. Use this procedure to move processing between the RICOH ProcessDirector production server and the failover server.
To switch RICOH ProcessDirector processing to and from a failover server:
  1. Log in as the system user (aiw1 is the default) to the server you are moving processing from. If the system is not available (for example hardware failure or if the system is powered down), continue with step 3. If you are moving processing from the production server to the failover server, log in to the production server.If you are moving processing from the failover server to the production server, log in to the failover server.
  2. Open a command line and enter: stopaiw
  3. Log in as the root user to the server you are moving the processing to.
  4. Enter /opt/infoprint/ippd/bin/changeHostname.plserver_hostname where server_hostnameis the name of the server you are moving processing from and press Enter. If you are moving processing from the production server to the failover server, server_hostnameis the production server.If you are moving processing from the failover server to the production server, server_hostnameis the failover server.

1.2.5.10 Input devices

RICOH ProcessDirector supports various types of input devices. You can do a variety of tasks for input devices, such as enabling, disabling, connecting and disconnecting them.

1.2.5.10.1 Customizing the Input Devices portlet

You can change the Input Devices portlet so it shows only the input devices that you work with frequently. You can also sort the devices according to their properties and change the order in which the properties are displayed.
To customize the portlet:
  1. Optional: If the star (Blue star) icon in the header row of the table is blue, click it.
    The star turns gray and the portlet shows all the devices that are defined in the system.
  2. Select the devices that you want to include in your list of favorites:
    • To include a device in your favorites list, click the gray star next to that device. It turns blue.
    • To remove a device from your favorites list, click the blue star next to the device. It turns gray.
  3. Sort the list of devices:
    • Click a column heading to sort the devices in ascending order according to that column. Click the column heading again to sort the devices in descending order.
  4. Reorder the properties displayed for the devices:
    • To change the order of the properties, click a column heading, drag it to a different position, and release the mouse button.
  5. To see only your favorite devices, click the star in the header row of the table.
  6. To change the properties that are displayed for each device:
    1. At the top right of the Input Devices portlet, click Settings (image of the settings icon) and select Manage Columns.
    2. To add columns to the table, select the check box next to the property name.
    3. To remove columns from the table, clear the check box next to property name.
    4. To change the order of table columns using the mouse, select a property name and drag it to a new location. To reorder a selected property name using the keyboard, use the controls to the right of the name to move it to a new location.
      • To move the property name up one row, click .
      • To move the property name to the top of the list, click .
      • To move the property name down one row, click .
      • To move the property name to the bottom of the list, click .
    5. To save your changes, click OK.

1.2.5.10.2 Connecting and disconnecting input devices

Connecting and disconnecting an input device controls the flow of data into the input device from job submission tools. An input device can only receive input files if it is connected.

Before you connect an LPD input device whose parent server is a Linux system, stop any LPD daemons on the Linux system that do not belong to RICOH ProcessDirector.

Disconnected input devices do not receive any more input files. If an input device is still enabled, any input files that it received before it was disconnected can still be submitted for processing.

To connect or disconnect an input device:
  1. In the Input Devices portlet, right-click the input device or devices that you want to connect or disconnect.
  2. Select Connect or Disconnect.
  3. If you see a confirmation message, click Yes.
    Note:
  • If the parent server for the input device is not available when you make the connection request, RICOH ProcessDirector changes the icon to the left of the input device. It also changes the Connection status property for the input device to Unable to connect. After you correct the problem with the parent server, RICOH ProcessDirector connects the input device.
  • If more than one Download input device has the same port number assigned, RICOH ProcessDirector only lets you connect and enable one of the input devices at a time.
  • Connecting or disconnecting a Download input device also starts or stops the Download daemon. If the Download daemon stops running or the mainframe system loses connection, the Connection status property of the input device is changed to Disconnected.
  • Connecting the first LPD input device on a RICOH ProcessDirector server also starts the LPD daemon. If the LPD daemon does not start, the Connection status property for the input device changes to Unable to connect. If the parent server of the input device is a Linux system, a possible reason is that other LPD daemons are already running on the Linux system. Stop these daemons, then disconnect and reconnect the LPD input device.
  • Disconnecting the last LPD input device on a RICOH ProcessDirector server also stops the LPD daemon.
  • After RICOH ProcessDirector connects or disconnects an input device, the symbol next to it changes. The connected symbol is a solid green arrow. The disconnected symbol is a broken orange arrow.
    Note:
  • You can set up a notification object to send an email when an input device is disconnected.
  • If you have the Web Service Enablement feature, you can set up a notification object to issue a SOAP or REST web service call when an input device is disconnected.

1.2.5.11 Input files

Input files are the data files that are sent to the RICOH ProcessDirector input devices defined for the installation. Input files include the files that contain job data as well as trigger files, list files, and other files that might be submitted with the data files. You can group input files into batches to submit them as a job.
Note: Do not use these characters in the file names for input files: " ' ; < = > \ ` | ~ !

If RICOH ProcessDirector finds any of these characters in a file name for an input file, it removes the character and renames the file. For example, if you submit an input file with the name COPIES=3;DRAFT.pdf, RICOH ProcessDirector removes the characters that are not allowed and renames the file COPIES3DRAFT.pdf.

In addition, when RICOH ProcessDirector processes control files (such as list files), it removes the disallowed characters from the file names listed in the control file before it looks for the corresponding file.

1.2.5.11.1 Batching all input files

You can group the input files that are submitted to a hot folder or an SFTP input device and submit them together. The Batching method for each input device determines how many jobs are created from each input device.

You can only batch jobs for hot folder and SFTP input devices.

All input files are submitted using the existing settings on the input device, though some values are overridden. For example, an input device uses the Number batching method. That input device waits until it receives 5000 input files and submits them as a job. When you use Batch all, the input device collects all the input files that are waiting and submits them immediately, even if there are fewer than 5000 files.

To batch all input files from one or more input devices:

  1. Select the input devices that you want to batch all the files for.
  2. Right-click one of the input devices and select Batch all.
  3. In the confirmation dialog, click OK.
    Note:
  • Do not use the Batch all action with input devices that use the JDF or Pattern batching method.
  • For the List batching method, only files matching the contents of the list file are submitted as jobs. If a file specified in the list file is missing, the job for that list file is not submitted.
  • For the Number and Pages batching methods, the specified amount to include in a batch is used. For example, if the Number of files to batch property value is 500 and there are 600 files present in the input device waiting for the polling interval to end. Two jobs are submitted with the Batch all action - one with 500 files and one with 100 files.
  • For the Number of sets and Pages in sets batching methods, the specified patterns to match and amount to include in a set are used.
  • For the Time and Sets by time batching methods, the specified patterns to match are used. After the jobs are submitted, the Batching interval is not reset.

1.2.5.11.2 Displaying submitted input files

You can see what input files have been submitted to an input device and are waiting to be processed. After the input device submits the input files for processing, they are no longer visible as input files.
To display a submitted input file:
  1. In the Input Devices portlet, right-click the input device whose input files you want to see and select Show Files.
  2. When you finish looking at the input files table, click CLOSE.

1.2.5.11.3 Manually assigning a workflow to an input file

If you have not set up your system so that input devices assign workflows to input files or if an error occurred with automatic assignment, you can manually assign a workflow to an input file by resubmitting the file.
To manually assign a workflow to an input file:
  1. In the Input Devices portlet, right-click the input device that holds the input file that you want to work with and select Show Files.
  2. Right-click the file that you want to assign a new workflow to and select Resubmit.
    This operation resubmits all input files that share the submit group of the selected input file.
  3. Click Different workflow and select a workflow from the list.
  4. Click OK.
  5. Click CLOSE.

1.2.5.11.4 Submitting a batch of input files manually

You can group two or more input files that are in an input device directory together and process them together, either as a single job or a collection of jobs.
If the Batching method property is set to Batch, you must always submit jobs manually. If the Batching method is set to a value such as Time or Number of pages, use this procedure to submit files as a job before the requirements for batching are met.

For example, an input device usually waits to receive 1000 PDF pages before it submits a job. At the end of the day, there are only 650 PDF pages in the input device. You want to start processing those pages before you leave, so you use this procedure to submit those pages manually.

    Note:
  • You can submit all the input files in an input device with the Batch all action on the input device as long as the Batching method is not JDF or Pattern. The Batch all action does not wait for the Polling interval to be reached before creating the jobs.

To manually submit a group of input files:
  1. In the Input Devices portlet, right-click the input device whose input files you want to batch together and select Show Files.
    You see a list of all input files for the selected input device.
  2. Select two or more files whose status is not Error.
    If the Batching method is Number of sets, Pages in sets, or Sets by time, select all the files for each set.
  3. Click Make Batch.
  4. Click OK.
  5. Click CLOSE.
The files are submitted to a workflow based on the batching settings for the input device. If the Batching method is Number of sets, Pages in sets, or Sets by time, only complete sets are submitted. The completed sets are combined and submitted as a single job.

If the Create .zip file property is set to No, a child job is created for each input file you selected. A parent job is submitted to keep the child jobs together as a group. If the Create .zip file property is set to Yes, the files are combined in a ZIP file and submitted as a group.

1.2.5.11.5 Deleting input files

If you do not want to process an input file or you no longer need the input file on the system, you can delete it.
To delete an input file:
  1. In the Input Devices portlet, right-click the input device that the input file was submitted to and select Show Files.
  2. Right-click the file that you want to delete and select Delete.
    You see a confirmation message.
  3. Click OK.
  4. Click CLOSE.

1.2.5.12 Barcode readers

Barcode readers are the system representations of your cameras and barcode scanners. You can do a variety of tasks for barcode readers, such as connecting and disconnecting them.

1.2.5.12.1 Connecting and disconnecting barcode readers

Connecting and disconnecting a barcode reader controls the flow of barcode data into the barcode reader from the camera or barcode scanner. A barcode reader can only receive barcode data if it is connected.
To connect or disconnect a barcode reader:
  1. In the Barcode Readers portlet, select the barcode reader or readers that you want to connect or disconnect.
  2. Click Connect or Disconnect.
  3. If you see a confirmation message, click OK.
    Note:
  • The camera or barcode scanner might get disconnected if it is powered off or loses network connection. If that happens, RICOH ProcessDirector automatically attempts to reconnect.
  • If a user disconnects the barcode reader by clicking Disconnect, they must then click Connect action to restore the connection.
  • You might have to manually disconnect the camera or barcode scanner to clean it or reposition it.

1.2.5.13 Printers

Printers are the RICOH ProcessDirector representations of your printer devices. You can do a variety of tasks for printers, such as starting, stopping, enabling, and disabling them.

1.2.5.13.1 Customizing the Printers portlet

You can change the Printers portlet so it shows only the printers that you work with frequently. You can sort the list of printers, and you can change the properties that are displayed.
To customize the portlet:
  1. To switch between the List View and the Graphic View, set the Device portlets on Main property in the Preferences dialog or the user property notebook.
  2. If the star (Yellow star on a yellow background) icon in the header row of the table is blue, click it.
    The star turns gray and the portlet shows all the devices that are defined in the system.
  3. Select the devices that you want to include in your list of favorites:
    • To include a device in your favorites list, click the gray star next to that device. It turns blue.
    • To remove a device from your favorites list, click the blue star next to the device. It turns gray.
  4. Sort the list of devices:
    • Click on a column heading to sort the printers in ascending order according to that column. Click the column heading again to sort the printers in descending order.
  5. To see only your favorite devices, click the star in the header row of the table.
  6. To change the properties that are displayed for each device:
    1. At the top right of the Printers portlet, click Settings (image of the settings icon) and select Manage Columns.
    2. To add columns to the table, select the check box next to the property name.
    3. To remove columns from the table, clear the check box next to property name.
    4. To change the order of table columns using the mouse, select a property name and drag it to a new location. To reorder a selected property name using the keyboard, use the controls to the right of the name to move it to a new location.
      • To move the property name up one row, click .
      • To move the property name to the top of the list, click .
      • To move the property name down one row, click .
      • To move the property name to the bottom of the list, click .
    5. To save your changes, click OK.

1.2.5.13.2 Viewing printer status

The operational status of a printer device includes whether it is enabled, and the current condition that the printer hardware is reporting to RICOH ProcessDirector.
To view the status of a printer:
  1. In the Printers portlet:
    • If the portlet is open in the Icon View, look at the symbol to the left of the printer icon. A green arrow indicates that the printer is enabled; a broken yellow arrow indicates that the printer is disabled. A yellow bar next to the printer also indicates the printer is disabled. If there is a red bar next to the printer it needs operator attention.
    • If the portlet is open in the Grid View, check the information in the Enabled and Status columns.
  2. To determine the status that the printer is reporting, click the name of the printer. You see the properties notebook.
  3. Click the Status tab.
  4. Look at the Printer status field and check the value.
    For more information about the status, click the Question mark icon button.

1.2.5.13.3 Starting and stopping printers

You can start or stop a RICOH ProcessDirector printer. Starting a printer lets users send jobs to it. You can stop printing during or after the current job.
    Note:
  • You can only start and stop AFP and PCLOut printers.
  • You can stop a job that is printing on a PCLOut printer if you request the stop action while PSF is transforming the job to PCL.

To start or stop a printer:

  1. In the Printers Portlet, right-click the printer that you want to start or stop and select Start or Stop.
  2. Specify when you want the AFP printer to stop printing:
    • Immediately stops the printer as soon as possible.
    • After the current copy prints stops the printer after it finishes printing the current copy of a multi-copy job.
    • After all copies of the current job print stops the printer when the current job is finished.
  3. Optional: To advance the paper so that the last page of printed output is stacked after the printer is stopped, select After stopping, perform a non-process runout (NPRO) operation.
  4. If you see a confirmation message, click OK.

After stopping a printer:

  • The printer status changes to Stopped and the printer icon in the Printers portlet turns red. No jobs print on that printer until it is started again. The printer is still enabled, so RICOH ProcessDirector can still schedule jobs to it.
  • Jobs that were assigned to the printer that has been stopped remain in the Assigned state.

1.2.5.13.4 Spacing a job on the printer

If you have a job on an AFP printer and need to reposition it to print again from an earlier page (backspace) or to skip pages and start printing at a later page (forwardspace), you can use the Jump to job action.

To space a job on the printer:

  1. Using the job number shown under the printer icon, find the job in the Jobs table and make sure it is in the Print phase and the Printing state.
  2. In the Printers Portlet, select the printer that is printing the job and click Stop. If the job consists only of a single copy, select Immediately. If the job consists of multiple copies, select either Immediately or After the current copy prints.
    Note: Using the stop function on the printer console does not put the printer in the stopped state in RICOH ProcessDirector. You must stop the printer using the RICOH ProcessDirector user interface.
  3. In the Jobs portlet, select the job that was printing on the printer that you just stopped.
  4. Click Actions Jump to.
  5. On the Jump to a Location page, specify where you want to resume printing the job:
    1. If the job consists of a single copy, you can specify a page number. You can also select the number of sides to skip ahead or back up from the side on which the last page printed. Use the View function to see the last page that printed and to help select where to resume printing the job.
    2. If the job consists of multiple copies, you can only specify a page in the current copy. To back up or skip ahead to a page in a different copy, you must specify which side of the job to jump to.
    3. If the Interrupt Message Page property for the printer is set to Yes, the printer prints a message page for the repositioning action and the restart point might be off by one sheet. To avoid printing from the wrong position, set the Interrupt Message Page property to No or use the Resume printing at page control instead of the Back up or Skip ahead controls.
  6. Select whether you want RICOH ProcessDirector to do a non-process runout (NPRO) action before it resumes printing.
  7. Click OK.
  8. In the Printers Portlet, select the printer that is printing the job and click Start.

1.2.5.13.5 Viewing and updating the media ready in printer input trays

RICOH ProcessDirector uses SNMP and JMF to distinguish between the media that a printer supports and the media that is ready in its input trays. Supported media is not ready until it is loaded in an input tray. Unless your printer can automatically match media, update the ready media for the printer object when you load new media in the printer device.
If you are using a Ricoh PDF printer and the media catalog is defined on the printer, RICOH ProcessDirector automatically queries the printer and updates the media ready in the printer input trays.

To view and update the media ready in printer input trays:

  1. In the Printers portlet, select a printer. Click Actions Show Trays.
    As an alternative, you can select a job in the Jobs portlet and click Schedule. Select the printer you want to use and then click Show Trays.
  2. If you have Media Matching set to Use the properties selected below and the printer reports all the properties you use to distinguish media, the table shows the trays and the media that is currently loaded. If you load different media while this page is open, do these steps to update the media:
    1. Click Update.
      RICOH ProcessDirector queries the printer and returns the media that is ready in each input tray. If you loaded different media and the table does not change, make sure that Get tray information from printer property on the printer is set to Yes.
    2. Click OK.
  3. If you have Media Matching set to Use the properties selected below, but the printer does not report all the properties you use to distinguish media or SNMP is not turned on for the printer, follow the instructions for Media Matching set to Use media product ID or media name.
  4. If you have Media Matching set to Use media product ID or media name, do these steps to update the media:
    1. Select the input tray that you want to update.
    2. Click Set tray media.
    3. Select the media that is loaded in the tray and click OK.
    4. Click CLOSE.

1.2.5.13.6 Shutting down printers

You can instruct RICOH ProcessDirector to end all processing for a printer and its assigned jobs and to disable the printer.
    Note:
  • The difference between shutting down a printer and disabling it without shutting down is that shutting down the printer both disables the printer and releases it from RICOH ProcessDirector, while simply disabling it does not release it. Other programs can send jobs to a shutdown printer, but not to a disabled printer that has not been shut down.

To shut down a printer:

  1. In the Printers Portlet, right-click the printer that you want to shut down and select Shutdown.
  2. Click OK.

The printer is disabled, so no jobs print on that printer until it is enabled again. RICOH ProcessDirector cannot schedule jobs to the printer.

If a job is assigned to a Ricoh PDF or Custom PDF printer when the shutdown is requested, the job status changes to Stopped.

If a job is assigned to a PCLOut, Passthrough, Kodak PDF, or Xerox PDF printer when the shutdown is requested, the job status changes to Complete if the printer command returned successfully before the shutdown was processed. Otherwise the job status changes to Error.

If RICOH ProcessDirector can pause the job that is printing on an AFP printer, the status of that job changes to Stopped. Otherwise, the job status changes to Error. Jobs that are assigned to an AFP printer, but that have not started to print, are moved to the Unassigned state.

1.2.5.14 Working with data in the Reports database

After you collect data using the Reports feature, you can access that data and use it as input to your business intelligence software.

Use the procedures below to connect to the database, then retrieve data using SQL statements. For example, you can use the SELECT statement to query data or the COPY statement to export data.

    Note:
  • You don't have to follow this procedure if you use Data Transmitters.

For more information about working with data in PostgreSQL databases, including the Reports database, see the PostgreSQL tutorial (http://www.postgresqltutorial.com/).

1.2.5.14.1 Connecting to the Reports database

You can connect to the Reports database directly by using psql, an interactive terminal program. After you make the connection, you can use SQL statements to extract or query the data without using a business intelligence tool.
    Note:
  • You do not have to follow this procedure if you use Data Transmitters.

To verify that the Reports database is running, try to connect to it. If you get the psql command prompt, the database is running.

To connect to the Reports database:
  1. Log in to the primary computer and open a command line.
  2. Change directories to the correct option for your system.
    • On Linux:
      • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin or
      • /usr/pgsql-14/bin/
    • On Windows:
      • C:\aiw\aiw1\bin\postgresql\Windows\pgsql\bin or
      • <RPD Install Directory>\PostgreSQL\bin\
  3. Enter this command: ./psql databaseusername

    Replace database with the name of the database that you specified in Administration Reports Database Settings. The default is history.

    Replace username with the user name that you specified in Administration Reports Database Settings. The default is rpdreports.

  4. If prompted, enter the password that you specified in Administration Reports Database Settings.

    The psql command prompt database=# is displayed.

    If you specified history in the command, the command prompt is history=#.

    You now are connected to the Reports database.

  5. To access the data, run SQL statements.
  6. To exit psql, enter: \q

1.2.5.14.2 Exporting data in the Reports database to a CSV file

You can export data in the Reports database to a file in comma-separated values (CSV) format.
To export data in the Reports database to a CSV file:
  1. Click the Administration tab.
  2. Select Reports Data Collectors.
  3. Select the data collector whose data you want to download and click Download data.
  4. Specify a time range for the data to download and click OK.

1.2.5.15 Repositories

You can work with repositories to do a variety of tasks.

1.2.5.15.1 Changing the retention period for a repository

You can change the Retention period of an existing repository to increase or decrease the period of time it stores job and document data and history information.
To change the Retention period of a repository:
  1. Click the Administration tab.
  2. In the left pane, click Objects Repositories.
  3. Select the repository you want to change the Retention period for.
  4. Click Change Retention Period.
  5. Specify the period of time.
  6. Select the unit of time.
      Note:
    • If you shorten the Retention period, the system deletes all data that have been stored in the repository longer than the new retention period.
  7. Click OK.

1.2.5.15.2 Changing the folder location for a repository

You can change the Folder location of an existing repository.
To change the Folder location of a repository:
  1. Click the Administration tab.
  2. In the left pane, click Objects Repositories.
  3. Select the repository you want to change the Folder location for.
  4. Click Change Folder Location.
  5. Specify the directory where you want the repository to store the files or history information.
      Note:
    • If you change the Folder location of a repository after jobs, documents, properties, or history information is stored, the data is not automatically moved to the new location. You must manually move the contents of the repository to the new location.
    • If you do not specify a full path, the directory is created in the /var/aiw directory for Linux, and in the drive:\Program Files\Ricoh\ProcessDirector path for Windows, where drive is the drive where RICOH ProcessDirector is installed.
  6. Click OK.

1.2.6 Working with jobs

You can manage jobs and their progress through all phases of RICOH ProcessDirector processing using the Main page of the RICOH ProcessDirector user interface.

Through the user interface, you can do a variety of tasks.

1.2.6.1 Finding jobs in the system

Jobs that have been created by input devices and that have entered the RICOH ProcessDirector system are displayed in the Jobs portlet.

RICOH ProcessDirector provides different mechanisms to find jobs in the Jobs table. You can use each mechanism by itself or in combination with the others.

To find a job in the system:

  • Filter using the Filter entry field

    To search the Jobs table for specific text, you can type in the Filter field at the top of the Jobs table. As you type, the contents of the Jobs table change to show only jobs that contain that text. The text can appear in any property value that is displayed in a column on the Jobs table.

      Note:
    • Entering special characters such as ?, _, *, or % might not return the list of jobs you expect.
    • If you have the Deadline Tracker feature installed and want to search for a value of the Deadline step property, search only for the step name, not the name of the phase associated with that step name. Do not include parentheses in the search text.
  • Filter using the Advanced filter

    To search the Jobs table for a specific job, you can specify the conditions that you want to use.

  • Filter using the System Summary

    If you know the phase or state (for example, Error or Manual) that the job is in, you can use the links in the System Summary to limit the number of jobs that are displayed.

  • Use the sorting and paging features of the Jobs table

    If you know the name, job ID, or other information about the job, you can sort the Jobs table by the appropriate property. Click the heading of the column that you want to sort by. The jobs are rearranged so they are in ascending order (alphabetical or numerical). Click the column heading a second time to sort the items in the table in descending order.

    When you sort on a column, you see an arrow (black arrow pointing up) next to the column header. If the arrow is pointing up (black arrow pointing up), the table is sorted based on that column in ascending order. If the arrow is pointing down (black arrow pointing down), the table is sorted based on that column in descending order.

    RICOH ProcessDirector displays up to 1500 jobs per page. If you have more than 1500 jobs in the system, use the arrow buttons or the Page field under the table to move to the other pages.

1.2.6.1.1 Finding jobs using a user-defined filter

You can find jobs in the RICOH ProcessDirector system using the filter function on the Jobs table. You can filter for values such as job name, job number, and jobs that have been reprinted.
To set a user-defined filter:
  1. In the right corner of the Jobs table, click the Settings () icon, then click Show Advanced Filter.
    The filter area opens with New filter.
  2. Define one or more conditions to use to filter the list. Each condition consists of a property, a comparison, and a value.
      Note:
    • The Comparison value is not (!=) does not return jobs that have a null value (no value or Not set) for the specified property. To find these jobs, select the Comparison value has not value (notset).
  3. Optional: To define an additional condition, click the plus sign () to the right of any condition. To delete a condition, click the minus sign () to the right of the condition you want to delete.
    The additional filters are appended to the first filter with AND operators.
  4. Optional: To delete a condition, click the minus sign () to the right of the condition you want to delete.
  5. Click Apply filter.
    The Jobs table is filtered using the conditions you specified.
  6. Optional: Select Save filter and enter a name for the filter to keep your filter settings.
  7. Optional: To enable or disable the filter, click the Advanced filter switch. Disabling the Advanced filter clears all of the conditions and refreshes the Jobs table.
  8. Optional: To minimize or maximize the Advanced filter area, click the arrow to the left of the Advanced filter.
  9. Optional: To show or hide the Advanced filter, click the Settings () button, then select Show Advanced Filter.
    If a filter has been set, the Advanced Filter area is partly closed and the filter remains set. If no filter has been set, the Advanced Filter area is completely closed.

1.2.6.1.2 Finding jobs that are scheduled to a printer

If you know that the job is a candidate to be printed on a specific printer, you can find the job by displaying all the jobs that are candidates for that printer.
A job is a candidate for a printer when the values of the scheduling attributes for the job match the values of the scheduling attributes for the printer.

To find a job that is scheduled to a printer:

  1. In the Printers Portlet, find the printer jobs are scheduled to.
    If the printer that you are looking for is not in the list, you might be looking at only your favorite printers. Click the blue star on the title bar to see all the printers.
  2. Right-click the printer and select Show Candidate Jobs.

1.2.6.1.3 Finding late jobs

You can find jobs whose tracking status is Behind schedule, whose predicted outcome is May miss, or whose checkpoint status is Late so that you can take corrective action.

The Deadline Tracker feature adds a Deadlines portlet to the Main page. The portlet contains dots that show the number of jobs that have missed or are close to missing a deadline or checkpoint.

When you hover over a dot, you see a legend that lists the statuses represented by the dot. Click View all jobs in this state to open a table of all the jobs in that state. The dots also appear in the Schedule risk column in the Jobs table. The heading of the Schedule risk column is blank. To see the name of the column, hover over the heading area.

A tracking status of Behind schedule means that the job has been processing for longer than the estimated duration for all steps run up to this point. When the job is behind schedule, a yellow dot appears in the Schedule risk column for the job in the Jobs table.

A predicted outcome of May miss means that the estimated duration of the steps remaining is greater than the time remaining before the deadline for the job. When the job may miss its deadline, an orange dot appears in the Schedule risk column.

A checkpoint status of Late means that the job is late meeting the next checkpoint or that it has missed the final checkpoint. RICOH ProcessDirector calculates a checkpoint status for all jobs that have a service policy associated with them. When a job is late, a yellow dot appears in the Schedule risk column. If the job catches up before another checkpoint, the yellow dot is removed.

To find late jobs in the Jobs table:

  1. In the System Summary portlet on the Main page, click All to see all the jobs in the system.
  2. To sort the jobs by schedule risk, with jobs that have the most urgent risk at the top, click the blank column heading for Schedule risk.
  3. To display only jobs with specific schedule risks in the Jobs table, click Advanced filter.
  4. To display only jobs whose checkpoint status is Late, select the Checkpoint status property, the is (=) comparison, and the Late value.

    To display only jobs whose tracking status is Behind schedule, select Tracking status, is (=), and Behind schedule.

    To display only jobs whose predicted outcome is May miss, select Predicted outcome, is (=), and May miss.

    To select a combination of schedule risks, first select Any are true and the first property, comparison, and value. Then click + to the right of the condition and select another property, comparison, and value.

  5. If you see a job that is Late or Behind schedule, or a job that may miss its deadline, you can view the properties of the job.

    For example, if a job is Late, you can see its planned and actual checkpoint times. If a job is Behind schedule or may miss its deadline, you can see the values of the properties on the Deadline tab.

  6. After you fix a problem that is making a job late, consider using the Promote action so that the job progresses faster through the remaining phases. Or, you could use the Schedule Job action to move the job to another printer.

1.2.6.1.4 Finding jobs ready to load on an inserter

To find jobs that are ready to be loaded on an inserter that a specific inserter controller manages, you can display all active jobs for that inserter controller. Then, you can sort the jobs to find those that are ready to load on an inserter.
To find jobs that are ready to load on an inserter:
  1. In the Inserter Controllers portlet on the Main page, find the inserter controller with active jobs in it.
    If the inserter controller that you are looking for is not in the list, you might be looking at only your favorite inserter controller. Click the blue star in the Inserter Controllers tab to see all the inserter controllers.
  2. Right-click the inserter controller and select Show Jobs.
  3. In the Jobs table that opens, click the heading of the Current step column to sort the jobs by the current step.
    To see the Current step column, you might need to edit the columns to add a column for the Current step property.

    Jobs that are ready to be loaded are in a step based on the InsertJobs step template and in the Waiting state or in the Manual, working state.

1.2.6.1.5 Finding jobs waiting to complete insertion

To find jobs that have finished insertion on a specific inserter controller and that are waiting for manual completion, you can display all active jobs for that inserter controller. Then, you can sort the jobs to find those that are waiting for you to complete insertion.
To find jobs that are waiting to complete insertion:
  1. In the Inserter Controllers portlet on the Main page of the RICOH ProcessDirector user interface, find the inserter controller where jobs have finished insertion.
    If the inserter controller that you are looking for is not in the list, you might be looking at only your favorite inserter controller. Click the blue star in the Inserter Controllers tab to see all the inserter controllers.
  2. Right-click the inserter controller and select Show Jobs.
  3. In the Jobs table that opens, click the heading of the Current step column to sort the jobs by the current step.
    To see the Current step column, you might need to edit the columns to add a column for the Current step property.

    Jobs that are ready to be loaded are in a step based on the InsertJobs step template and in the Waiting state or in the Manual, working state.

1.2.6.1.6 Finding jobs waiting for reconciliation

To find jobs that have finished insertion on a specific inserter controller and that are waiting for manual reconciliation, you can display all active jobs for that inserter controller. Then, you can sort the jobs to find those that are waiting for reconciliation.
To find jobs that are waiting for reconciliation:
  1. In the Jobs table, if the Current job state property is a column, use the Filter field to find jobs that are in the Waiting to reconcile state.

1.2.6.2 Viewing job information

You can view various pieces of information about jobs in the RICOH ProcessDirector system, including their status, properties, and log information.

1.2.6.2.1 Viewing and changing properties of a job

The properties of a job include a wide variety of information, such as what printer the job is supposed to print on, how big the input file is, whether it is a duplex job, and much more. You can change some of the job properties as needed.
  • To view and change the properties of a job:
    1. In the Jobs table, click the job name you want to work with to open the property notebook.
    2. In the properties notebook, use the tabs to see different properties or click Show all to display all the properties on a single page.
      To see information about any of the properties, click the Image of a button with a question mark on it icon next to the property name.
    3. Make the appropriate changes.
      You can use the Find function in your Web browser to locate the fields you want to change. The browser only searches the tab that is currently displayed. Click Show all tabs to search the fields on all the tabs.
    4. Click OK.
  • To view and change the properties of multiple jobs:
    1. In the Jobs table, select the jobs you want to work with and click Update Multiple.
    2. Select a property you want to change from the list. Then select or type new values for the property.
    3. To update an additional property, click the plus sign to the right of your last entry.
    4. To remove a property update from the list, click the minus sign to the right of the entry you want to delete.
    5. Click OK.

1.2.6.2.2 Custom job properties

You can use custom job properties to set values that do not correspond to any other job properties that are available. You can set default values for these custom job properties in your workflows and change them just as you can any other editable job properties.

Custom job properties can be useful in various situations:

  • To provide additional sorting and filtering options in the Jobs table
  • To pass values that are unique to your company with the job, so they can be printed on banner pages or used by downstream processes
  • To include a value that does not otherwise appear in the job properties in a command that invokes an external program
  • To record numerical values that are unique to your company with the job.

There are two ways to include custom job properties in your workflows. You can:

  • Use supplied custom properties included with RICOH ProcessDirector.
  • Define unique job properties for your specific circumstances.

Using supplied custom properties

RICOH ProcessDirector provides 20 properties in the job properties notebook that can be used as custom job properties:

  • 10 properties labeled Custom 1 through Custom 10 can be used as custom job properties. These properties can contain text or numeric information about the job.
      Note:
    • In these fields, numbers are treated as text, not numerical values.
  • 10 properties labeled Custom integer 1 through Custom integer 5, and Custom number 1 through Custom number 5 can be used as custom number job properties. These properties only contain numeric information. Custom integer fields always store whole numbers; Custom number fields might store fractional numbers.

You cannot change the names of the properties; you can only change their values.

Defining unique job properties

If you do not want to use the supplied custom properties, or if you need more custom properties than are available, you can define your own from the Administration tab.

You can choose the database name and the label that displays in property notebooks and column headings. You can also choose what kind of data to store in the property and the default access that different user groups have for the property.

1.2.6.2.3 Viewing the JDF job ticket

Some values in the JDF job ticket are not shown in the RICOH ProcessDirector user interface, but the workflow might call an application that uses these values. Therefore, you might need to view the JDF job ticket.

To view the JDF job ticket:

  1. Find the JDF job ticket in the spool file directory for the job.
    The spool file directory name is /aiw/aiw1/spool/default/JobNumber. The name of the JDF job ticket is JobNumber.filename.jdf.

    If the JDF job ticket has been modified by an overrides file or an application, you might find more than one JDF job ticket with different file names. The date of the last change tells you which JDF job ticket is most recent.

  2. Use a text editor or a Web browser to view the JDF job ticket.
    The JDF job ticket is in XML format.
    Note: RICOH ProcessDirector does not keep the user interface and the JDF job ticket synchronized at all times; it only updates values in the job ticket when it receives a request for the job ticket. When you look at the job ticket, some values listed might not match the values of RICOH ProcessDirector job properties.

1.2.6.2.4 Viewing and changing page exceptions

You can view and change page exceptions. Page exceptions are media, sides, and finishing instructions for specific pages that differ from the instructions for a job.
For example, the media and finishing instructions for a simplex job specify plain A4 paper with no stapling. The page exceptions for the job specify blue A4 paper for the first page, pages 2-3 as duplex, and stapling in the top left corner of pages 5-8.

The Page exceptions action shows media, finishing, or sides pages exceptions even if the PrintJobs step is not in the workflow that is processing the job.

Media and stapling values for page exceptions are applied only to PDF jobs sent to Ricoh PDF, Custom PDF, or Ricoh TotalFlow, printers. Sides page exceptions are applied to PDF jobs sent to Ricoh PDF, Custom PDF, Ricoh TotalFlow, Kodak, and Xerox printers. Some printer control units do not support Sides page exceptions in JDF job tickets.

Only media and sides page exceptions are applied to jobs sent to Kodak PDF printers and Xerox PDF printers. Stapling page exceptions are not supported for these printers.

If you have the Preprinted Forms Replacement feature:

  • RICOH ProcessDirector combines electronic forms with page data when the CombinePDFWithForm step processes the job. After the job goes to the next step in the workflow, changes to media have no effect on electronic forms. Examples:
    • After the job goes through the CombinePDFWithForm step, you change a page exception from Letter Yellow media to Form100 media with electronic forms. The Page Exception dialog includes Form100 media, but the electronic forms for Form100 media are not combined with the page data.
    • After the job goes through the CombinePDFWithForm step, you change a page exception from Form200 media with electronic forms to A4 Plain media. The Page Exception dialog includes A4 Plain media, but the page data is printed with the electronic forms for Form200 media.
  • The CombineAFPWithForm step ignores any values set for the media page exceptions on the Page Exception dialog.
To view and change page exceptions:
  1. In the Jobs table, right-click the job that you want to work with and select Page Exceptions.

    The Media property shows the media for the job, and the Staple property shows whether the job has stapling instructions. The Duplex property shows the job setting for what sides to print on. The Page range column shows the pages that each exception applies to. The Paper substitution column shows media exceptions, and the Subset finishing column shows stapling exceptions. The Sides column shows exceptions to the duplex setting.

  2. To add a media, staple or sides page exception, click Add.
  3. Type the pages that you want for the Page range.

    You can:

    • Use a hyphen to separate the first and last pages of a range.
    • Use a comma to separate page selections.
    • If the job has a value in the Total Pages property, type n to specify the last page in the job.
        Note:
      • To compute the total pages for a job, add a step based on the CountPages step template to the job workflow.

  4. Select a media option in the Paper substitution list, a stapling option on the Subset finishing list, or a duplex option on the Sides list.
  5. Click OK.
  6. To change a page exception, right-click the page range that you want to edit and select Properties. Adjust the values as needed and click OK.

    To delete a page exception, right-click the page range that you want to delete and select Delete. You see a confirmation message. Click OK.

  7. To replace one media, duplex, or finishing option specified in all page exceptions for a job with another media, duplex, or finishing option (for example, to replace A4 gold paper with A4 yellow paper):
    1. Click Update all.
    2. Select the current media, duplex, or finishing option and the value to replace it with.
    3. Click OK.
New media page exceptions only replace media instructions that overlap existing pages in the exception. For example, a job specifies plain A4 paper. You add an exception for blue A4 paper on the first page. RICOH ProcessDirector specifies plain A4 paper for all pages except page 1.

New stapling page exceptions replace stapling instructions that overlap an existing page in the exception. For example, a page exception specifies two staples at the bottom of pages 2–5. You add an exception that specifies one staple at the upper left corner of pages 1-4. RICOH ProcessDirector removes the exception for two staples at the bottom of pages 2-5. The new exception for pages 1-4 remains.

If you add a stapling page exception to a job that specifies stapling for the entire job, RICOH ProcessDirector removes the job-level stapling and honors the page exception.

If you want to staple an entire job that has stapling page exceptions, you must delete the page exceptions before you set stapling for the job.

New sides page exceptions only replace duplex instructions that overlap existing pages in the exception. For example, a job specifies tumble duplex. You add an exception for simplex on the first page. RICOH ProcessDirector specifies tumble duplex for all pages except page 1.

1.2.6.2.5 Tracking the progress of a job

You can track the progress of jobs as they print from the Printers portlet. If the print progress bars are visible, each AFP and Ricoh PDF printer shows the number or name of the job that is printing and the current progress of that job.
If you have the Deadline Tracker feature installed, you can track the progress of the job in its workflow.

To track the progress of a print job:

  1. In the Printers portlet, find the printer that you are using.
  2. To see the job name and number, hover the mouse pointer over the job name or number.
  3. To see the current page that is printing and the total page count:
    • If the progress bar is visible, hover the mouse pointer over the progress bar.

1.2.6.2.6 Viewing the status of a job

You can use the Jobs table to see the current status of a job and the workflow associated with it.
As jobs flow through the RICOH ProcessDirector system, they move from step to step and processing phase to processing phase. Overall job status is a combination of several pieces of information about the job as it progresses through the system. For example, a job might be in the Retained state in the Complete phase, or it might be in the Error state in the Prepare phase.
    Important:
  • No print status information is available about jobs that have been sent to Passthrough printers. These jobs remain in the Assigned state in the PrintJobs step until the printer command returns a return code. If the return code is valid, RICOH ProcessDirector moves the job to the Complete state in the PrintJobs step; otherwise, to the Error state.

To view the status of a job:

  1. In the Jobs table, select the job that you want to work with.
  2. To see the status of the job, look for the Phase or State columns.
  3. To see a graphical view of the workflow associated with the job, including the steps that have processed the job and the current step, select the job and click View job in workflow.
    The current step in the workflow is highlighted with a blue ring. If the job is in the Error state, the ring is red. Solid connector lines show the path that the job has followed through the workflow. Dotted connector lines show the path that the job is predicted to follow through the remaining steps of the workflow.
      Note:
    • If the workflow was edited while the job was being processed, the workflow viewer might not show the correct steps. The job log shows the steps that processed the job.
    • If you have the Deadline Tracker feature installed and have set estimated durations for at least one step in the workflow for the job, you can see the percent of the estimated processing time that has elapsed by hovering over the blue bar on the bottom of the window.

    To view different parts of the workflow:

    1. To zoom in and out, use the mouse wheel or the Ctrl + and Ctrl - keys.
    2. To reposition the workflow in the window, click the Map (Image of Map button) icon. In the map, a rectangle shows what part of the workflow is currently displayed. Hover over the map, then click and drag the rectangle to show different parts of the workflow. Click and drag the top of the map to move it to a different location on the screen.
      You can also click and drag the circle in the lower right corner of the rectangle to zoom in and out.
    3. When you are finished, close the workflow window by clicking the X in the upper right corner.
  4. To see additional information about the status of the job, right-click it and select Properties.
  5. To display all the status information, click the Status tab on the left side of the notebook. To see information about any of the properties, click the Image of a button with a question mark on it icon next to the property name.

1.2.6.2.7 Viewing checkpoints and deadlines

Job checkpoints are the planned and actual times that a job completes each processing phase. The SLA deadline is the time by which the job should complete the SLA target step.
RICOH ProcessDirector calculates planned checkpoint times for each job that has an associated service policy. RICOH ProcessDirector records actual checkpoint times for each job even if no service policy is associated with a job. RICOH ProcessDirector sets an SLA deadline for a job only if the SLA target step property is set on the workflow for the job. If the job has passed the target step, the time that the job completed the target step is also recorded.
To view the checkpoints and deadlines for a job:
  1. In the Jobs portlet on the Main page, click the job name to open the properties notebook.
  2. In the property notebook, click the Checkpoints tab to see the job checkpoints, the SLA deadline, and the time that the job completed the target step. To see information about any of the properties, click the Question mark icon icon next to the property name.

1.2.6.3 Starting and restarting jobs

Often, jobs arrive in a RICOH ProcessDirector input device and start to process immediately. However, there might be times when you need to do an action to move a job through the system. In addition, you might need to restart a job if it has been interrupted or stopped during processing.

1.2.6.3.1 Holding jobs

If you do not want jobs to move through their workflow without human intervention, you can configure the workflows to hold jobs at a given point. You can then have the operators do an action to release the jobs.

For example, if operators have to load different forms for each job, they can release jobs after they have loaded the correct forms on the printer.

To hold jobs, do one of these:

  • Set the Requested printer property on a step based on the PrintJobs step template to Not set, so that all jobs that pass through that workflow receive that value.

    The default is that the Requested printer property is set to Any printer. As a result, jobs are automatically scheduled to the first available printer whose scheduling properties match the values for the associated job properties. However, if Requested printer property is set to Not set, the jobs wait for an operator to use the Schedule Job action to assign them to a printer. After the job has been scheduled, the Requested printer property is set and the job moves through the rest of its processing steps.

  • Set the Stop when entering phase property on a step that is based on the SetJobPropsFromTextFile step template. When you add one of those steps to a workflow, you select a phase as the value of the Stop when entering phase property. When a job reaches that phase, it stops and waits without going through any of the processing steps in that phase.

    If a job is stopped at the beginning of a phase, an operator can use the Continue action to resume processing of the job. The operator must also make sure that the scheduling properties for the job match the scheduling properties for at least one printer and that the Requested printer property is set to Any printer or to a specific printer so the job can be scheduled for printing.

    For example, if you select the Print phase, a job moves through all the processing steps specified for the Receive and Prepare phases. Then it moves to the Print phase, but it waits before starting any steps. The job state changes to Stopped. An operator can right-click the job and select Continue to start processing again.

  • Include a manual step in a workflow, so that jobs have to wait for an operator to indicate that the job is ready to move to the next processing step.

    For example, you can create a step based on the ManualStepWithAutoStart step template and name it Enter Purchase Order Number, then add it to the Prepare phase of a workflow. When a job arrives at this step, its status changes to Manual, Working. An operator can edit the job properties to enter the purchase order number and then right-click the job and select Manual complete to complete the step and release the job.

1.2.6.3.2 Sending jobs to a specific printer

Sometimes, you want to make sure that RICOH ProcessDirector sends a job or a group of jobs to a specific printer. You can provide the name of a specific printer in the workflow or you can use the Schedule function to request a specific printer for a job.
Set the Requested printer property on the PrintJobs step in the workflow if all jobs that the workflow processes need a specific printer function, such as MICR. If the scheduling properties for the job match the scheduling properties for the requested printer when the job arrives in the PrintJobs step, the job can be sent to the printer.

The scheduling properties for jobs are:

  • Binding
  • Customer name
  • Fold options
  • Job size, in sheets

    RICOH ProcessDirector calculates the number of sheets that the job contains, and the user who defines the printer specifies the sheet count that a given printer supports. This property might not contain a value for jobs that are not in the AFP or PDF formats.

  • Media required, for the job including any media specified as page exceptions
  • Output bin
  • Output format
  • Punch
  • Requested location
  • Stapling required, for the job including any stapling specified as page exceptions

The AFP Support feature adds these job scheduling properties for AFP jobs:

  • Job class
  • Job destination
  • Job form

Scheduling properties are added or deleted from this list by editing a scheduling properties configuration file.

If you leave a printer scheduling property blank, it matches all values used for the corresponding job property. If you leave a job scheduling property blank, it matches all values used for the corresponding printer property.

If the scheduling properties do not match (or if the value of the Requested printer property is Not set), use the Schedule function to send the job to a specific printer. The Schedule function is an easy way to make the scheduling properties match.

To send a job to a specific printer:

  1. In the Jobs table, select the job or jobs that you want to schedule to a printer.
  2. Click Schedule.
    The Schedule Jobs dialog shows printers that you have defined, plus all their scheduling properties. If you see a colored star in the top row of the table, only your favorite printers are listed. Click the colored star to see all the printers in the list.
  3. To select a specific printer to print the job or jobs:
    1. Under Requested printer, select Printer selected in table.
    2. Select a printer in the Printers table.
      The printer you selected becomes the Requested printer for the jobs.
    3. Click OK.
  4. To change the values of the scheduling properties for the jobs that you selected and either send the jobs to a specific printer or send them to any printer that has the same values set for its scheduling properties:
    1. If the list of Jobs at the top of the page is closed, click Show jobs to open it.
    2. To change the values of the scheduling properties for the jobs so that they match those of the selected printer, click Make jobs match selected printer.
      RICOH ProcessDirector updates the values of the scheduling properties for the jobs to match those of the printer.
        Note:
      • RICOH ProcessDirector does not update the value of the Media required scheduling property. To resolve a Media required scheduling property conflict, you must change the media specified by the job or route the job to a printer that supports the media.
    3. To change the values of individual job properties, click Edit scheduling properties.
    4. To change the value of a scheduling property, select the property and type or select a new value.
    5. Click OK.
      RICOH ProcessDirector assigns the new value to all the jobs that are listed in the Jobs table.

If you schedule two or more jobs to the same printer, RICOH ProcessDirector uses these criteria to determine the printing order of the jobs:

  • RICOH ProcessDirector processes jobs that are not members of process groups in this order:
    • Most recently promoted, as determined by the Promotion time property for the job
    • Highest priority, as determined by the Job priority property
    • Most recently received, as determined by the Time submitted property
  • RICOH ProcessDirector processes jobs that are members of a process group in this order:
    • Most recently promoted
    • Highest priority
    • Job order within the process group, as determined by the Process group order property

1.2.6.3.3 Adding or removing scheduling properties

You can use a scheduling properties configuration file to change the default set of scheduling properties used when assigning jobs to printers. The value in a job property must match the value in its corresponding printer property for the job to schedule to the selected printer.
Entries in the makeLikePrinterAttrs.cfg file are used to determine which job properties are updated to match printer properties when you click the Make Jobs Match Printer action on the Schedule Jobs page.
To update the scheduling properties file:
  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Navigate to /aiw/aiw1/config (Linux) or C:\aiw\aiw1\config (Windows).
  3. Open the makeLikePrinterAttrs.cfg file with a text editor.
  4. Add, edit, or delete scheduling properties from the file.
  5. When you are done editing, save the file.
  6. Restart RICOH ProcessDirector.
    The updated makeLikePrinterAttrs.cfg file is used the next time the PrintJobs step runs or you use the Schedule jobs action.
The contents of the default scheduling properties file:
Job.CustomerName=Printer.CustomerName
Job.Locations=Printer.Locations
Job.StapleRequired=Printer.StapleCapable
Job.FoldOptions=Printer.FoldCapable
Job.Binding=Printer.RingBindingCapable
Job.Binding=Printer.PerfectBindingCapable
Job.Punch=Printer.PunchCapable
Job.OutputBin=Printer.OutputBin
Job.MediaSize=Printer.InputTray
Job.MediaType=Printer.InputTray
Job.Form=Printer.Form
Job.Destination=Printer.Destination
Job.Class=Printer.Class
Job.MediaRequired=Printer.Media
Job.JobSize=Printer.JobSize
    Note:
  • Only the properties with rules specified in the file must match for a job to be scheduled to a printer.
  • If you enter a job property more than once, the last value for the job property is used.
  • If a value for a property in a rule is null, it is considered a match.
  • If you leave a job scheduling property blank, it matches all values used for the corresponding printer property.
  • If the file is empty, the job is sent to the printer without matching any properties.
  • If the file does not exist when the PrintJobs step runs, the default RICOH ProcessDirector base scheduling properties are used to define matches.
  • Conflicts in the Schedule Jobs dialog are caused by job and printer property values in the scheduling properties file that do not match. Some job properties that you add to the scheduling properties file may not be available to display in the Jobs table.

1.2.6.3.4 Moving a job to a different printer

If the printer fails while a job is printing, you can move the job to another printer.
  • To move the job to a different printer and continue printing from the last good page:
    1. Stop the job. On the confirmation page, specify that RICOH ProcessDirector should remember the last page printed.
    2. Shut down the failed printer.
    3. Change the Requested printer property for the job.
    4. In the Jobs table, right-click the job and select Continue.
  • To move the job to a different printer and reprint the job from the beginning:
    1. Shut down the failed printer.
    2. In the Jobs table, right-click the job and select Print Again.
    3. On the Print Again page, select a printer in the Requested Printer field and click OK.

1.2.6.3.5 Moving a job to a different processing step

Sometimes, you want to interrupt the flow of a job through the system and move it to a different processing step.
If a job is in an error state and must be reprocessed to resolve the error, or if it was assigned to the wrong workflow, you can reprocess the job from an earlier step.

To move a job to a different processing step:

  1. In the Jobs table, right-click the job or jobs that you want to reprocess and select Process Again.
    • To restart processing of one or more jobs at a step in the current workflow:
      1. Select Current workflow.
      2. From the list of phases and steps, select the phase and step to send the job back to.
        Note:
      • Some steps are not shown in the list because a job cannot be restarted at that point.
      • If a parent job has child jobs in the system and you try to restart it at or before the last step that created those child jobs, reprocessing fails. If you want to restart at an earlier step, delete the child jobs.
      • The Current workflow option is not available in these situations:

        • The workflow was edited while the job was being processed.
        • The job was sent to a step with a restart type of Delete.
        • The jobs are not in the same workflow.
        You must select a workflow from the list.

    • To restart processing of multiple jobs at the first step of their current workflows, select Current workflow.
    • To process one or more jobs using a different workflow:
      1. Click Different workflow.
          Note:
        • You cannot reprocess a parent job using a different workflow when it has any child jobs in the system. If you want to use a different workflow, delete the child jobs.
      2. In the Workflow property, select the workflow that you want to use.
          Note:
        • The name of the job can change when the new workflow is applied.
  2. Click OK.
If the job has already been printed (in whole or in part), RICOH ProcessDirector increments the Reprint count property when you process the job again. If none of the pages had printed before you selected the Process Again action, the Reprint count property remains blank.

1.2.6.3.6 Scheduling a job using Output format

Sometimes moving a job from one printer to another printer requires reformatting a job. For example, you might need to move jobs from a roll-to-roll printer to a roll-to-fold printer, or you might need to print PDF jobs on a PostScript printer.
You can use the Output format scheduling property to make sure the job is correctly formatted before it is sent to the printer.

Before you can reformat a job for a printer, your workflow must be set up to include a path that reformats jobs. Check with your RICOH ProcessDirector administrator to find out if your workflow can reformat jobs for different printers.

To schedule a job using the Output format scheduling property:
  1. In the Jobs table, select the job or jobs that you want to schedule to a printer.
  2. Click Schedule.
    The Schedule Jobs dialog shows printers that you have defined, plus all their scheduling properties. If you see a colored star in the top row of the table, only your favorite printers are listed. Click the colored star to see all the printers in the list.
  3. Under Requested printer, select Printer selected in table.
  4. Select a printer in the Printers table.

    The printer you selected becomes the Requested printer for the jobs.

  5. If the list of Jobs at the top of the page is closed, click Show jobs to open it.
  6. To reformat the job for the printer, click Make jobs match selected printer.
  7. Click OK.

RICOH ProcessDirector sends the job to the step in the workflow that has a Step restart type of Reformat. From that step, the job follows the path through the workflow that formats jobs for the Output format value of the requested printer.

1.2.6.3.7 Changing the workflow for a job

You can change the workflow for one or more jobs. For example, you can change the workflow when you want to process the job through an extra step.
You cannot change the workflow on the job property notebook. You must use the Process Again action.
    Note:
  • The name of the job can change when the new workflow is applied.

To change the workflow for a job:

  1. In the Jobs table, right-click the job or jobs you want to change the workflow for and select Process Again:
    • To restart processing of one or more jobs at a step in the current workflow:
      1. Select Current workflow.
      2. From the list of phases and steps, select the phase and step to send the job back to.
        Note:
      • Some steps are not shown in the list because a job cannot be restarted at that point.
      • If a parent job has child jobs in the system and you try to restart it at or before the last step that created those child jobs, reprocessing fails. If you want to restart at an earlier step, delete the child jobs.
      • The Current workflow option is not available in these situations:

        • The workflow was edited while the job was being processed.
        • The job was sent to a step with a restart type of Delete.
        • The jobs are not in the same workflow.
        You must select a workflow from the list.

    • To restart processing of multiple jobs at the first step of their current workflows, select Current workflow.
    • To change one or more jobs to a different workflow:
      1. Click Different workflow.
      2. In the Workflow property, select the workflow that you want to use.
        Note:
      • You cannot reprocess a parent job using a different workflow when it has any child jobs in the system. If you want to use a different workflow, delete the child jobs.

      The job returns to the Receive phase.

  2. Click OK.

1.2.6.3.8 Reprinting jobs

Sometimes, you might need to reprint some or all the pages of a job that has already passed through the PrintJobs step.

You cannot specify a range of pages when the job that you want to work with is actively printing on the printer. You must either stop the printer or stop the job before you can select the page range to print.

To reprint a range of pages or page groups in an AFP job, the workflow must include steps based on the EnableRepositioning and CreatePageRanges step templates. The EnableRepositioning step template is included in the AFP Support feature.

To reprint a range of pages in a PDF job, the workflow must include steps based on the CountPages and CreatePageRanges step templates.

To reprint page groups in a PDF job, the workflow must include steps based on the IdentifyPDFDocuments and CreatePageRanges step templates. The IdentifyPDFDOcuments step template is included in the PDF Document Support feature.

To reprint a job:
  1. In the Jobs table, select the job that you want to reprint.
  2. Click Print again.
  3. On the Print Job Again page, select one of these:
    All
    Prints all the pages of the job again.
    Pages
    Selects specific pages to print again.
    Groups
    Reprints specific page groups (such as a multi-page insurance policy or bank statement for a particular account number).
  4. If you selected All, continue with step 7.
  5. If you selected Pages, you can enter a value in the Pages to print again field or click the Select pages in viewer button to look at the job and select the correct pages to reprint:
    1. Click Select pages in viewer to open the file viewer.
    2. Page through the job and find the pages that you want to reprint. When you find one of them, type the page number in the Pages field, or click Add page displayed below to add the page number to the list. You can also enter page ranges, such as 5-14. Separate all values with commas. For example, 3,6,8,12-30,45.
        Note:
      • If there is more than one page on a sheet, selecting any page from that sheet causes the whole sheet to be reprinted. For example:
        • In a 2-up simplex job, page 47 is on the left side of the sheet and page 48 is on the right. If you select page 48, both page 47 and page 48 are reprinted.
        • In a duplex job, page 51 is on the front of the sheet and page 52 is on the back. If you select page 52, both page 51 and page 52 are reprinted.
    3. When you have selected all the pages that you need to reprint, click OK.
    4. Continue with step 7.
  6. If you selected Groups, you can select which page groups you want to reprint using document properties.
    1. Click Select groups in viewer to open the file viewer.
    2. Using the toolbar above the viewer window, select Document properties from the Go to list, then select the property that you want to use to find the page. Document properties are shown in database format, such as Doc.Address.FullName.
        Note:
      • To find the document you are looking for, you may need to use the Find the next document with the given property value button ().
    3. Select the property or tag value for the page group that you want to reprint.
    4. Click Add group displayed below to add the group to the list of page groups to be reprinted.
    5. Repeat these steps until you have added all the page groups that you want to reprint. If you add a group to the list by mistake, select it and click Remove to take it out of the list.
    6. When you have selected all the groups that you need to reprint, click OK.
    7. Continue with step 7.
  7. Select a printer to submit the job to.
    If you see a blue star next to the Requested printer field, only your favorite printers are listed. Click the yellow star to see all the printers in the list.
  8. Optional: To print more than one copy of the job, change the number of copies to print.
      Important:
    • Passthrough printers ignore the number that you specify here. The printer command or the control file template must pass the number of copies to the Passthrough printer if it is greater than one.
  9. Click OK.
When all or part of a job is scheduled to be reprinted, RICOH ProcessDirector increments the Reprint count property for that job and adjusts the Job size property to reflect only the number of pages that is included in the reprint job.

1.2.6.3.9 Printing from a specific point in a job

When a job is in the Print phase and is actively printing on an AFP printer, you can stop the printer, jump to a different position in the job, and resume printing.

To print from a specific point in the job:

  1. Make sure the job is in the Print phase and the Printing state.
  2. In the Printers Portlet, select the printer that is printing the job and click Stop. If the job only consists of a single copy, select Immediately. If the job consists of multiple copies, select either Immediately or After the current copy prints.
      Note:
    • Using the stop function on the printer console does not put the printer in the stopped state in RICOH ProcessDirector. You must stop the printer using the RICOH ProcessDirector user interface.
  3. In the Jobs table, select the job that you want to print.
  4. Click More actions Jump to.
  5. On the Jump to a Location page, select one of these to specify the point at which you want to resume printing the job:
    Resume printing at page
    You know the number of the page where you want to resume printing. You can use the string search function in the file viewer to help you find the page.
    Resume printing at group
    The print job contains page groups and you want to resume printing at the first page of a specific page group (such as a multi-page insurance or bank statement for a particular account number). You can use the document property search function in the file viewer to help you find the page group.
    Back up
    You want to move backwards a number of sides in the job and resume printing from that location.
    Skip ahead
    You want to move forward a number of sides in the job and resume printing from that location.
      Note:
    • Your options depend on the number of copies in the job:
      • If the job consists of a single copy, you can specify a page number. You can also select the number of sides to skip ahead or back up from the sheet on which the last page printed. You can use the View File function to see the last page that printed and to help select where to resume printing.
      • If the job consists of multiple copies, you can only use the Resume printing at page option to select a page within the current copy. If you want to move to a page in a different copy, use Back up or Skip ahead.
  6. If you selected Resume printing at page, type the number of the page where you want to resume printing. If you are not sure of the exact page number, use the file viewer to find the page number.
      Note:
    • If there is more than one page on a sheet, selecting any page from that sheet causes the whole sheet to be printed. For example:
      • In a 2-up simplex job, page 47 is on the left side of the sheet and page 48 is on the right. If you select page 48, printing starts at page 47.
      • In a duplex job, page 51 is on the front of the sheet and page 52 is on the back. If you select page 52, printing starts at page 51.
    1. Click View File to open the file viewer.
    2. Use the viewer controls to move through the job until you find the correct page.
    3. When you find the correct page, type the page number in the Page field or click Select page displayed below to place the number in the field.
    4. Click OK.
    5. Continue with step 9.
  7. If you selected Back up or Skip ahead, calculate how many sides of paper you want to move forward or backwards in the job. Type the number in the correct field and continue with step 9.
  8. If you selected Resume printing at group, click Select in Viewer to open the file viewer so you can select a group.
    1. Using the toolbar above the viewer window, select Property from the Go to list, then select the document property that you want to use (usually a value such as Name or Account number).
    2. Select the document property value for the page group.
    3. Verify that the correct page group displays in the viewer and click Select page displayed below to add the group to the table above the viewer toolbar.
    4. Click OK.
    5. Continue with step 9.
  9. Determine whether you want RICOH ProcessDirector to do a non-process runout (NPRO) action before it resumes printing.
  10. Click OK.
  11. In the Printers Portlet, select the printer and click Start.

1.2.6.3.10 Making jobs process and print sooner

Occasionally, you might need to give one or more jobs a higher priority so that they process through the workflow sooner than they would otherwise. You can use the Job priority job property to move the jobs through their workflow faster.

Job priority is a numerical value from 1 through 999. RICOH ProcessDirector processes jobs with a priority of 1 through each of their steps before other jobs with lower priorities that are queued to the steps. For example, RICOH ProcessDirector processes jobs with a priority of 50 through the steps at a later time, and processes jobs with a priority of 99 at an even later time.

The Job priority property of a job is not a required property, although it might be set by a step based on the SetJobPropsFromTextFile step template. If you configure the step to set the Job priority property, consider having the step set the value between 10 and 999. You can then use the values from 1 through 9 to move jobs through the workflow faster.

Changing the priority of a job to 1 does not suspend all processing of other jobs, and does not move this job through the workflow immediately. Changing the priority moves the job to the front of the queue for processing in each step of its workflow. If two jobs have the same priority, RICOH ProcessDirector processes the first of the jobs that arrives at a step.

To make one or more jobs process and print sooner:

  1. In the Jobs table, select the job or jobs that you want to process sooner.
  2. Right-click one of them and select Set Priority.
  3. For each job, enter a value for the Priority property.
    Keep in mind that RICOH ProcessDirector considers any job with an assigned priority value more important than a job without a priority value.
  4. Optional: From this page, you can use the Schedule action to request a specific printer for the jobs.
  5. Click OK.
If you want to move a job or a group of jobs through their workflow steps ahead of all other jobs on the system, you can use the Promote action. RICOH ProcessDirector processes promoted jobs first, regardless of the priority of other jobs on the system.

1.2.6.3.11 Promoting a job ahead of other jobs on the system

Occasionally, you might need to process a job or a group of jobs ahead of all other jobs on the system. The Promote action causes RICOH ProcessDirector to process a job first, regardless of the priority of other jobs.

The promote action occurs when the job reaches the next processing step in its workflow. It remains in effect for all the subsequent steps and phases in the workflow. If the promoted job is a member of a group, RICOH ProcessDirector automatically promotes all other jobs in the group. RICOH ProcessDirector uses these criteria to determine the order in which the jobs print:

  • RICOH ProcessDirector processes jobs on the system that are not members of process groups in this order:
    • Most recently promoted, as determined by the Promotion time property for the job
    • Highest priority, as determined by the Job priority property
    • Most recently received, as determined by the Time submitted property
  • RICOH ProcessDirector processes jobs that are members of a process group in this order:
    • Most recently promoted
    • Highest priority
    • Job order within the process group, as determined by the Process group order property

If you promote a job and then need to promote another job, RICOH ProcessDirector uses the promote timestamp to determine which of the promoted jobs to process first. It processes the job with the most recent timestamp first, which is the last job that was promoted.

To promote a job ahead of other jobs on the system:

  1. In the Jobs table, right-click the job that you want to promote and select Promote.
  2. In the Promote job dialog, verify that you chose the correct job and click OK.
    Note:
  • Promoting a job does not suspend all processing of other jobs and does not move this job through the workflow immediately. Promoting a job moves the job to the front of the queue for processing in each step through which it passes.

1.2.6.4 Reconciling jobs

If your workflow has a Reconcile step after the PrintJobs step, you can reconcile each job manually. If documents in the job are damaged after reconciliation is complete, you can reprint them by using the Print Again action.

1.2.6.4.1 Reconciling jobs manually

During manual reconciliation, you tell the system what action to take for each document in the job. You can mark a document Reprint, Pull (to show that it was removed from the job), or OK.
For inserters, reconciliation occurs after a job has completed insertion.

For Automated Verification, reconciliation occurs after a job has completed a step based on the ReadBarcodeData step template.

You must reconcile a job manually when one of these conditions apply:

  • You have only the PDF Document Support or AFP Support feature (not the Inserter or Automated Verification feature).
  • For inserters and Automated Verification, the number of documents to reprint exceeds the maximum percentage allowed for the job, even when you are using automatic reconciliation.
  • For inserters, the inserter controller did not report a status for one or more documents, or RICOH ProcessDirector could not interpret the status.

Jobs that are ready to be reconciled are in a step based on the Reconcile step template and are in either the Waiting to reconcile state or the Error state.

To reconcile a job manually:
  1. In the Jobs table on the Main page, right-click the job and select Reconcile.

    On the Reconcile Job dialog, the summary information in the top left corner shows the total number of documents with each action that RICOH ProcessDirector assigned: OK, Reprint, or Pull. The summary information also includes the total number of documents with no assigned action ( Not set). When you start reconciliation, no documents are listed in the documents table.

    You cannot finish reconciliation until all documents have been assigned an action. No document can have a Requested action value of Not set.

  2. To find documents, use the summary information in the top left corner of the dialog or select an option to search for documents. For example, to find:
    • All documents to be reprinted: click the number under Reprint.
    • All documents with no assigned action: click the number under Not set.
    • Documents with one or two property values, select By properties.
    • Documents with certain barcodes, select By barcode scan.
    • Documents with a range of insert sequence values, select By range.

      To set values for the Insert sequence property, the workflow must include a step based on the SetPropertiesForReconcile step template or (for inserters only) the SetInsertProperties step template.

  3. If you select By properties, click Edit (Edit icon).
    1. Select a property in the Property field. Select a Comparison value and then type or scan the value in the Value field.
      For Automated Verification, you can select Verification recipient for the property and Equal to for the Comparison value. Then type a value for the Verification recipient property.
    2. Click the check box next to the second Property field and then select a second property. Select a Comparison value and then type or scan the property value in the Value field.
    3. Click Find.
      Documents that match both property values are found.
      Note:
    • To enter a range of numeric values, select the same property in both Property fields. For the first property, use the Greater than or equal to comparison value and enter the low value. For the second property, use the Less than or equal to comparison value and enter the high value.
  4. If you select By barcode scan, click Edit (Edit icon).
    1. For Barcode format to use, select the barcode format that describes the layout of the barcode that you plan to scan.
    2. In the Scanned barcodes list box, scan each barcode on a separate line. Do not include any blanks after the barcode.
    3. For Action, select the action to apply to the documents that match the barcodes in the list box.
    4. To save the scanned barcodes and close the dialog, click Save and Close.
  5. If you select By range, click Edit (Edit icon).
    1. Click one of these radio buttons:

      • From To

        In the From and To fields, enter the beginning and ending insert sequence values for the range of documents you want to find.

      • Custom range

        Type the insert sequence selections:

        • Use a hyphen to separate the first and last values in a range.
        • Use a comma to separate value selections.

    2. For Action, select the action to apply to the documents that match the values specified in the Insert sequence property.
    3. To save the range of insert sequence values and close the dialog, click Save and Close.
  6. In the Documents table, review the Action column for each document.
    • To verify that a document in the table is the document that you want to work with, select the document.
      • Click View Original to view a document in its original form.
      • Click View Current to view a document in its current form.
    • If the Action is not set, or if you want to change it, select the document and click:

      • Reprint. This action tells the system to print the document again.
      • OK. This action tells the system that the document has been processed successfully.
      • Pull. This action tells the system that the document has been pulled from the job. The system does not print the document again.

      You see the action that you requested in the Requested action column. In addition, the totals change in the summary information. For example, if you clicked Reprint for one document that was originally marked OK, the Reprint total increases by 1, and the OK total decreases by 1.

  7. Make sure that all documents have an assigned action.
    To list the documents that have no action, click the number under Not set in the summary information.
  8. Optional: To resume reconciliation later and save the changes you have already made on the Reconcile Job dialog, click Finish later.

    To resume reconciliation, right-click the job and select Reconcile.

  9. When all documents have an assigned action, click OK.
      Note:
    • You cannot click OK until the number of Not set documents is 0.
  10. If one or more documents are marked Reprint, you see the Reprint Documents dialog.
    1. Select a different printer in the Requested printer property.

      Select a printer that accepts the same data format as the original printer.

    2. For Inserter only: if, in the Reconcile step in the workflow, you selected property values to update before completing reconciliation, enter values in the fields that display on the dialog.
    3. Click OK.

1.2.6.5 Monitoring for expected jobs

Input devices report the status of jobs that are expected to arrive in your system at the intervals you set. You can use the Input Devices portlet to monitor for the arrival of expected jobs.
If one or more jobs do not arrive during the expected time, a red alert icon appears to the right of the input device.

To clear the alert, use the Resolve action for the input device.

To monitor for expected jobs:

  1. In the Input Devices portlet, right-click an input device and select Show Expected Work.

    The Expected Work dialog opens and you see a list of the expected work objects associated with the input device. You also see a current count of how many jobs are expected and how many have already arrived in the current monitoring period.

    If the expected work for the current period has not yet arrived, you see an alert (Alert icon) icon in the second column.

  2. After you determine which jobs have not arrived and take the appropriate action, return to the Input Devices portlet.
  3. Select the input device and click Actions Resolve.
    The Resolve action clears the Late status for all the expected work objects associated with the input device.

1.2.6.6 Inserting and reconciling jobs

After the inserter has inserted all the documents in a job, you can report to the system that the job has completed insertion. After reporting that the job has completed insertion, you can reconcile the job manually.
If documents are damaged after reconciliation is complete, you can reprint them by using the Print Again action.

1.2.6.6.1 Completing insertion for a job

If the inserter controller is configured to use the manual completion method, you must tell RICOH ProcessDirector when the inserter has finished inserting all the documents in the job into envelopes. Then RICOH ProcessDirector can automatically reconcile the job or you can manually reconcile it.
    Note:
  • If the inserter controller is configured to use the automatic completion method, you do not need to manually complete insertion because RICOH ProcessDirector can automatically detect that the job has completed insertion. However, if a job remains in the step based on the InsertJobs step template for a long time after it has finished insertion, you can manually complete insertion.
To complete insertion for a job:
  1. In the Jobs table on the Main page, right-click the job that has finished insertion and select Complete insertion.

    Make sure that the job is in a step based on the InsertJobs step template and is in the Manual, working state.

      Note:
    • If the job is in the Processing state, the inserter controller is configured to use the automatic completion method. In this case, do not continue unless you are sure that the inserter has finished inserting all the documents in the job.

  2. On the Complete insertion? dialog, click OK.

    The job moves to the next step in the workflow, which is usually based on the Reconcile step template. If the job specifies the manual reconciliation method, the state changes to Waiting to reconcile. If the job specifies the automatic reconciliation method, the state changes to Processing.

1.2.6.7 Preview printing

Preview printing lets you print a collection of pages from a print job as a test print before you print the entire job. You can use preview printing to verify your printer settings or test different options for your job.

For example, you can use preview printing:

  • To verify that the printer is set up correctly by printing the first few pages of a job
  • To see what the output looks like when it is printed on the same printer using different paper
  • To see what the colors or grayscales in a job look like when you use different ICC profiles or color management resources
  • To see what the output looks like when it is printed on different printers
  • To change other job properties and see how it affects your output
  • To make sure that the processing done by an external program created acceptable results

RICOH ProcessDirector uses the PreviewPrint step template to create the collection of pages and submit them to a printer. After the pages are printed, the preview print must be accepted or rejected for processing to continue.

Note: The step includes a default job property called Requested printer for preview print. Use this property to set the printer for the PreviewPrint step. You cannot use the Schedule jobs action to choose a printer for preview printing. If you leave the default value as Not set, the job moves to the Device Unavailable state when it arrives in the PreviewPrint step. You must open the job property notebook for the job and set the Requested printer for preview print property to continue processing.

When you configure the step, you have two options for completing the step. You can choose to have the job wait in the step based on the PreviewPrint step template until an operator accepts or rejects it or you can choose to have the system accept the preview print automatically. If the system accepts that job automatically, the job moves to the next processing step without waiting.

When a job is processed through the workflow, the step based on the PreviewPrint step template finds the pages that you want to print and sends them to the printer requested for the preview print. If the step is configured to accept the preview print automatically, the job moves to the next step in the workflow. If the step is configured to wait for an action from an operator, the job moves to the Waiting for Acceptance state. The job stays in that state until an operator looks at the output and decides what action to take:

  • If the output is acceptable, the operator accepts the preview print and it can continue processing, either in the same workflow or a different one.
  • If the output is not acceptable, the operator rejects the preview print. The job goes into error state and can be processed again with different options until it is acceptable.

You can add more than one PreviewPrint step to a workflow. For example, you might always want to print sample pages on three different types of paper and compare the output before deciding which paper to use. You can create three PreviewPrint steps and automate the acceptance of the first two by setting the Accept preview print automatically property to Yes. On the third step, set the Accept preview print automatically property to No.

When a job is processed through the workflow, all three preview print steps process the job. The job moves to the Waiting For Acceptance state after the last preview print is complete. An operator can compare all of the output and choose which paper to use, then accept the preview print so the job can continue processing.

1.2.6.7.1 Working with preview print jobs

If a workflow includes one or more PreviewPrint steps, the preview print must be accepted before the job can continue processing. Preview prints can be reviewed and accepted when they are in the Waiting for Acceptance state.

These actions are available when jobs are in the Waiting for Acceptance state:

Accept
If the output meets the requirements, you can accept the preview print and let the job continue processing. You can choose to let the job continue processing in the same workflow or in a different workflow.
Reject
If the output does not meet the requirements, you can reject the preview print. The job goes into Error state so you can adjust properties as needed and process the job again.

To work with preview print jobs:

  1. Find a job that is in the Waiting for Acceptance state.
  2. Review the output that was printed for the PreviewPrint step.
    If the workflow included more than one PreviewPrint step, you might have multiple versions of the preview print to review.
  3. Determine if the output meets the requirements for this point in the workflow. Select the job and choose:
    More actions Accept If the output is acceptable and you want to continue processing the job.
    More actions Reject If the output is not acceptable and you want to change some options and generate another preview print.
  4. If you accepted the preview print, choose whether to continue processing in the same workflow or move the job to a different workflow and click OK.
  5. If you rejected the preview print, adjust the appropriate properties and use the Process again action to run the PreviewPrint step again.

1.2.6.8 Viewing jobs

You can view the contents of any AFP or PDF job that is in the RICOH ProcessDirector system. When you view a job, you see it in your browser window.
The PDF viewers included with most browsers provide limited capabilities. If you use the standard PDF viewers, some functions (such as zoom and highlighting of search terms) might not be available. If you can configure your browser to use an Adobe PDF viewer, you can use additional functions.

    Note:
  • Adobe PDF viewers are only supported on Windows operating systems. You can open and view files on computers that use different operating systems, but some of the functions of the Viewer are disabled.

To view an AFP or PDF job:
  1. In the Jobs table, right-click the job that you want to view and select View.
  2. Use the viewer controls to move through the job.
  3. Click Close.
    Note:
  • The AFP viewer uses AFP fonts if it can find them in any of these places:
    1. Inline with the job
    2. In the directories specified by the AFP resource path job property, if the AFP Support feature is installed
    3. In /aiw/aiw1/resources
    4. In /usr/lpp/psf/reslib

    If it cannot find the fonts, it uses a set of configuration files to map AFP fonts to Type 1 fonts when it converts files for viewing. Therefore, if an AFP job contains any fonts, including custom fonts, that are not in these places, you must make sure that mappings for those fonts are included in the configuration files. If a job uses mapped fonts, when you compare the displayed image with the final printed version, they might not be identical.

    Important:
  • The AFP viewer does not apply any modifications in the form definition (such as print direction, constant back, and N_UP page positioning).

    If you have the Preprinted Forms Replacement feature, the CombineAFPWithForm step turns on the Constant Back flag when a media object includes an electronic form for the back side and the medium map specifies simplex printing. Those constant back pages are not included in the Total pages property for the job and are not displayed in the viewer.

  • The AFP viewer does not apply medium maps that are inserted between pages.
  • The AFP viewer does not find strings when certain code page properties are not set as expected.
  • The PDF viewer may not find text that includes a blank character when you search by String.
  • The viewer component cannot access resources stored in directories that have international characters, including double-byte characters, in their directory path names. If you store resources in directories that have accented or any other international characters in their directory paths, the viewer substitutes other characters for display purposes. The job might print correctly, even if it does not display correctly.

    To display the job using the correct resources, move the resources to a directory that does not have international characters in its path, or rename the existing directory to remove all international characters.

1.2.6.8.1 AFP viewer controls

The AFP viewer has several sets of controls that let you navigate through jobs and view specific pages.

If you open the viewer to look at the contents of a job, you navigate the job using different controls. The navigation controls you can use are based on the option you select from the Go to list:

  • Page: move through the job by page
  • String: search for text in the document
  • Document Property: search for document properties

If you open the viewer from the Print Job Again page, you see additional controls that let you select which pages to print.

Zooming and Rotating

The right side of the navigation toolbar provides controls you can use to zoom in, zoom out, and rotate the current page.

Rotate clockwise Rotate clockwise icon
Rotates the view of the job ninety degrees in the clockwise direction from the current rotation.
Zoom out Zoom out icon
Decreases the size of the displayed page to a preset percentage, depending on the number of times you click the button.
Zoom value Box with the value "100%" displayed
Changes the size of the displayed page according to a value that you select from a list or type in the field. You can select a percentage or a page fit option.
  • Actual size displays the page at 100% magnification.
  • Fit page adjusts the magnification so that the page fills the window horizontally and vertically.
  • Fit width adjusts the magnification so that the page fills the window horizontally.
  • Fit visible adjusts the magnification so that the text and images fit the width of the window.
Zoom in Zoom in icon
Increases the size of the displayed page to a preset percentage, depending on the number of times you click the button.
Navigating through jobs

The controls on the left side of the toolbar change based on the value that you choose for the Go to field.

Page
The Page toolbar lets you move through the job page-by-page or jump directly to a specific page.
The Page toolbar. The text that follows describes how to use the controls.
Display first page Display first page icon
Displays the first page of the job.
Display previous page Display previous page icon
Displays the page of the job that is immediately before the one that is currently displayed.
Numerical entry field Text entry field with the numeral "1" entered
Type the number of the page that you want to display in the viewer and press the Enter key on your keyboard.
Display next page Display next page icon
Displays the page of the job that is immediately after the one that is currently displayed.
Display last page Display last page icon
Displays the last page of the job.

String
The String toolbar lets you search the job for a page containing specific text.
The String toolbar at the top of the viewer page. The text that follows describes how to use the controls.
Type the term that you want to search for in the text field.
Find previous instance Find previous instance icon
Searches for the previous occurrence of the search term, which might be on a page before the page that is currently displayed.
Find next instance Find next instance icon
Searches for the next occurrence of the search term, which might be on a page after the page that is currently displayed.
Case-sensitiveCase-sensitive icon
Select this option to find only text that matches the exact case that you typed in the text field. For example, if you type john doe and select Case-sensitive, the search shows the first occurrence of john doe, but skips any occurrences of John Doe.

Property
The Property toolbar lets you search the job using the value of a document property or an index tag. To search an AFP file using document properties, you must install the AFP Support feature.
The Property toolbar. The text that follows describes how to use the controls.
Property list A list box containing an alphabetical list of existing properties.
You use this control to select the document property or index tag that you want to search. You can click the down-arrow icon to view and select a document property from the alphabetized list of all document properties in the job. You can also type any part of the name of the document property. As you type, the list of document properties is narrowed to those that contain the text you type.
Display first page Display first page icon
Displays the first page of the job that contains the document property or index tag value you selected.
Find previous Find previous property icon
Click the Find previous arrow to display the previous page in the job that contains the document property or index tag value you selected.
Value list A list box containing an alphabetical list of all of the values in the job for that document property.
After you select a document property or index tag, the viewer populates this list with all of the values in the job for that document property or index tag. You can click the down-arrow icon and select a specific value. If your job has more values than are displayed in the list, type in any part of the name of the document property or index tag value. The list of values is narrowed only to those that contain the text you type. When you select a value from the list, the viewer displays the first page of the job that contains that document property or index tag value.
Find next Find next property icon
Click the Find next arrow to display the next page in the job that contains the document property or index tag value you selected.
Display last page Display last page icon
Displays the last page of the job that contains the document property or index tag value you selected.

Additional controls for Print Job Again

The method you use to open the viewer from the Print Job Again page determines which controls you see:

  • If you select Pages and click Select pages in viewer, you see the Add page to list field and the Add button above the viewer. Click Add page to list to fill in the Pages field with the number of the page that is currently displayed in the viewer. You can select more than one page to be reprinted. If you display a different page and click Add page to list again, the new page is added to the existing value to create a list.
      Note:
    • You can also type a page number or a page range in the Pages field. Use a dash to indicate a page range and separate all page numbers and ranges with commas. To print from a specific page through the end of the job, use the letter n to represent the last page of the job. For example, to print a selection of pages from a 500 page job, enter: 3,27,150-165,302-428,491-n.
  • If you select Groups and click Select groups in viewer, you see a table above the viewer:
    1. Select a property and a value on the toolbar.
    2. Click Add group displayed below to fill in the property and group information of the page that is currently displayed in the viewer.
    3. To remove a group from the list of groups to be reprinted, select the group and click Remove.

1.2.6.8.2 PDF viewer controls

The PDF viewer has several sets of controls that let you navigate through jobs and view specific pages.

When you open the viewer to look at the contents of a job, you use the controls to move through the job by page, by searching for text, or by searching for a document property.

Select the Page option from the Go to list to move through the job by page. Select the String option from the Go to list to enter text and search the job for occurrences of that text. Select the Document Property option from the Go to list to search for a value in one of the document properties in the PDF file.

Zooming and Rotating

The right side of the navigation toolbar provides controls you can use to zoom in, zoom out, and rotate the current page.

Rotate clockwise Rotate clockwise icon
Rotates the view of the job ninety degrees in the clockwise direction from the current rotation.
Zoom out Zoom out icon
Decreases the size of the displayed page to a preset percentage, depending on the number of times you click the button.
Zoom value Box with the value "100%" displayed
Changes the size of the displayed page according to a value that you select from a list or type in the field. You can select a percentage or a page fit option.
  • Actual size displays the page at 100% magnification.
  • Fit page adjusts the magnification so that the page fills the window horizontally and vertically.
  • Fit width adjusts the magnification so that the page fills the window horizontally.
  • Fit visible adjusts the magnification so that the text and images fit the width of the window.
Zoom in Zoom in icon
Increases the size of the displayed page to a preset percentage, depending on the number of times you click the button.
Navigating through jobs

The controls on the left side of the toolbar change based on the value that you choose for the Go to field.

Page
The Page toolbar lets you move through the job page-by-page or jump directly to a specific page.
The Page toolbar. The text that follows describes how to use the controls.
Display first page Display first page icon
Displays the first page of the job.
Display previous page Display previous page icon
Displays the page of the job that is immediately before the one that is currently displayed.
Numerical entry field Text entry field with the numeral "1" entered
Type the number of the page that you want to display in the viewer and press the Enter key on your keyboard.
Display next page Display next page icon
Displays the page of the job that is immediately after the one that is currently displayed.
Display last page Display last page icon
Displays the last page of the job.

String
The String toolbar lets you search the job for a page containing specific text.
The String toolbar at the top of the viewer page. The text that follows describes how to use the controls.
Type the term that you want to search for in the text field.
Find previous instance Find previous instance icon
Searches for the previous occurrence of the search term, which might be on a page before the page that is currently displayed.
Find next instance Find next instance icon
Searches for the next occurrence of the search term, which might be on a page after the page that is currently displayed.
Case-sensitiveCase-sensitive icon
Select this option to find only text that matches the exact case that you typed in the text field. For example, if you type john doe and select Case-sensitive, the search shows the first occurrence of john doe, but skips any occurrences of John Doe.

Property
The Property toolbar lets you search the job using the value of a document property. To search a job using document properties, you must have installed the PDF Document Support feature and defined document properties for the PDF print job using RICOH ProcessDirector Plug-in for Adobe Acrobat.
The Property toolbar. The text that follows describes how to use the controls.
Property list A list box containing an alphabetical list of existing properties.
You use this control to select the document property that you want to search. You can click the down-arrow icon to view and select a document property from the alphabetized list of all document properties in the job. You can also type any part of the name of the document property. As you type, the list of document properties is narrowed to those that contain the text you type.
Display first page Display first page icon
Displays the first page of the job that contains the document property value you selected.
Find previous Find previous property icon
Click the Find previous arrow to display the previous page in the job that contains the document property value you selected.
Select a value A list box containing an alphabetical list of all of the values in the job for that document property.
After you select a document property, the viewer populates this list with all of the values in the job for that document property. You can click the down-arrow icon and select a specific value. If your job has more values than are displayed in the list, type in any part of the name of the document property value. The list of values is narrowed only to those that contain the text you type. When you select a value from the list, the viewer displays the first page of the job that contains that document property value.
Find next Find next property icon
Click the Find next arrow to display the next page in the job that contains the document property value you selected.
Display last page Display last page icon
Displays the last page of the job that contains the document property value you selected.

Additional controls for Print Job Again

When you open the viewer from the Print Job Again page, you see the Add page to list field and the Add button above the viewer. Click Add page to list to fill in the Pages field with the number of the page that is currently displayed in the viewer. You can select more than one page to be reprinted. If you display a different page and click Add page to list again, the new page is added to the existing value to create a list.

    Note:
  • You can also type a page number or a page range in the Pages field. Use a dash to indicate a page range and separate all page numbers and ranges with commas. To print from a specific page through the end of the job, use the letter n to represent the last page of the job. For example, to print a selection of pages from a 500 page job, enter: 3,27,150-165,302-428,491-n.

1.2.6.8.3 Defining custom fonts and TrueType fonts

If your AFP jobs contain fonts that use customized code pages, character sets, or coded fonts that are not inline or in a directory that the AFP viewer can access, or if they use TrueType or OpenType fonts, you can add references to these resources to the font configuration files for the viewer that are installed with RICOH ProcessDirector.
Custom fonts

When you view an AFP file in RICOH ProcessDirector, the file viewer converts the file to be displayed. In the process, it looks for the AFP fonts that the file uses in these places:

  1. Inline with the job
  2. In the directories specified by the AFP resource path job property, if the AFP Support feature is installed
  3. In /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows)
  4. In /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows)
If it does not find the fonts, it maps them to viewable fonts. The default font configuration files provide mappings for IBM fonts, but if the job contains custom fonts that are not available to the viewer or listed in the configuration files, errors occur. If the file viewer does not find the font in the configuration files, it substitutes the font and code page specified in the DEFAULT sections of two of the font configuration files (cpdef.fnt and csdef.fnt). When those files are installed, the font listed in the DEFAULT section is Times New Roman, 8-point and the code page is EBCDIC 500, although they can be changed. The content of the AFP file is not changed, but the displayed version might not look the same as the final printed version. If the code page or the font is not defined in the configuration files and it is not an EBCDIC code page, the file viewer displays unreadable text.

If you do not need to see the exact fonts that are referenced in the document, you do not have to change your font configuration files. However, if most or all of your jobs are going to cause these types of errors to be displayed, you might want to define at least some of your custom fonts, character sets, and code pages to the viewer, so that you can reduce the number of error messages that appear.

The font configuration files shipped with RICOH ProcessDirector contain mapping information for the IBM Core Interchange Latin fonts, the Compatibility and Coordinated fonts, and the IBM Sonoran and Data1 fonts so you only need to update the files if your custom fonts are not one of those font sets. If you have generated font configuration files for the RICOH AFP to PDF transform of InfoPrint Manager, AFP Workbench for Windows, or the AFP Windows Viewer plug-in, you can just copy those files into the /opt/infoprint/ippd/afpviewer/font (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font (Windows) directory.

    Note:
  • Although it is not described here, the viewer component of RICOH ProcessDirector does use an ALIAS.FNT file. The ALIAS.FNT file that RICOH ProcessDirector uses is in the same format as the ALIAS.FNT that InfoPrint Manager uses. As a result, if you have edited the ALIAS.FNT file that you use with InfoPrint Manager, you can copy it into the /opt/infoprint/ippd/afpviewer/font (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font (Windows) directory and use it with RICOH ProcessDirector. This file is different from the ALIAS.FNT file used by the AFP Workbench and AFP Windows Viewer plug-in.

Font mapping information is recorded in several files. You might have to edit more than one of them.

TrueType and OpenType fonts

AFP files can also contain references to TrueType and OpenType fonts. When the viewer finds a reference to a TrueType or OpenType font, it searches the TrueType font configuration file (ttdef.fnt) for a mapping to a Type 0 or Type 1 font. If a mapping is found, the Type 0 or Type 1 font is used.

If no mapping is found, the viewer searches for the TrueType or OpenType font in these places:

  1. The AFP file to see if the TrueType font is included inline
  2. The path set by the TT_Font_Path entry in the viewer configuration file
  3. /opt/infoprint/ippd/afpviewer/font/truetype (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font\truetype (Windows)
  4. The AFP resource path directory for the job
If the TrueType or OpenType font is found, it is used. If it is not found, the viewer substitutes the font listed in the DEFAULT section of the TrueType font definition file. When this file is installed, the font listed in the DEFAULT section is Times New Roman, although it can be changed

    Note:
  • Because double-byte character set (DBCS) TrueType fonts are very large, you should consider mapping them to one of the DBCS fonts that the AFP viewer processes efficiently: JpnSys1 (KozGoPro-Medium) or JpnSys2 (KozMinPro-Regular).

1.2.6.8.3.1 Editing the code page definition file

You might have to edit the code page definition file if you created a new code page.
The code page definition file maps the IBM AFP code page name to its code page global identifier (CPGID) and to a Web browser character set. Each line in the file is a separate mapping. The lines use this syntax:
codepage=cpgid,wincp
codepage
The AFP code page name.
cpgid
The code page global identifier for this code page.
wincp
The Windows character set to use for this code page. Valid values are ANSI and SYMBOL. This value is optional.

For example, the code page definition file might contain these entries:

T1DCDCFS=1003,ANSI
T1GPI363=2066,SYMBOL
DEFAULT=361,ANSI
To edit the code page definition file:

  1. For Linux, log in to the primary computer using a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
  2. Navigate to /opt/infoprint/ippd/afpviewer/font (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font (Windows) and find the file cpdef.fnt.
  3. Copy the file cpdef.fnt and save it as a backup.
    For example, you can save the copy as cpdef.fnt.bak.
  4. Open cpdef.fnt in a file editor.
  5. Insert new lines for the code pages that your files require, using the syntax above.
      Note:
    • The DEFAULT line must be the last one in the list. Add your lines above it.
    • If you create your own code page, you must assign it a unique code page identifier. In that identifier, you cannot use leading zeros.
    • A semicolon (;) in the first column causes that line to be treated as a comment.
    • Section headers within files are enclosed in square brackets ([]) and must not be removed or changed.
    • All values are case-sensitive.
    • If a parameter value is not valid and a default value exists, the default value is used.
    • All parameters are positional.
    • Blanks are allowed between parameters.
  6. Save and close the file.
  7. Because the viewer uses International Components for Unicode (ICU) to display text, you must create the files that ICU needs to interpret and apply your code page.
    For information about completing these steps, see the ICU User Guide (http://userguide.icu-project.org/intro). To find this information, search in the PDF version of the ICU User Guide for ucm.
    1. Create a Unicode character map (.ucm file) that describes your code page and provides a mapping table that links Unicode code points, code page character byte sequences, and optional precision or fallback indicators.
    2. Run the makeconv utility to convert the .ucm file to a .cnv file.
    3. On the primary computer, copy the .cnv file into this directory: /opt/infoprint/ippd/ProcessDirector/afpviewer/cnv (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\cnv (Windows)

1.2.6.8.3.2 Editing the character set definition file

You might have to edit the character set definition file if you created or modified a character set.

The character set definition file specifies the character set attributes and the font global identifier (FGID) of the font. There are two sections of the file, one for the character set ([CHARSET]) and one for the FGID ([FGID]). The lines in each section define different mappings.

In the [CHARSET] section, the lines use this syntax:

charset=fgid,height,width,strikeover,underline
charset
The 8-character identifier for the character set.
fgid
The font global identifier for the character set. The value of the FGID must be a value between 3840 and 4096 or 65260 and 65534.
height
The vertical size of the character set, expressed in tenths of a point. For example, a 9-point font has a height of 90.
  • For raster fonts, valid values for the height are whole numbers from 1 through 990.
  • For outline fonts, the value is 0 because the height is specified in the AFP data stream.
width
The average horizontal size of the characters in the set, expressed in 1440ths of an inch. Use 0 (zero) to let the browser determine the width based on the value that you entered for height. This value is optional.
strikeover
A font whose characters all have a line, parallel to the character baseline, placed over the middle of the character. If the character set refers to a strikethrough font, set this value to 1; if not, set it to 0. This value is optional.
underline
A font whose characters all have a line, parallel to the character baseline, placed under the character. If the character set refers to an underline font, set this value to 1; if not, set it to 0. This value is optional.

For example, the [CHARSET] section of the character set definition file might contain these entries:

[CHARSET]
C?H200A0=2304,110,73,0,0
C?D0GT15=230,80,96,0,0
DEFAULT=2308,80,0

In the [FGID] section, the lines use this syntax:

fgid=familyname,style,weight,italic
fgid
The numerical FGID value.
familyname
The name of a typeface or type family, such as TimesNewRoman or Courier.
    Note:
  • To determine the family name of a Type 0 or Type 1 font, open the .pfa or .pfb file with a text editor and search for /FamilyName. This family name must also be mapped to the file name of the .pfb file in the fontmap.lst file.
  • For a TrueType or OpenType font, use the family name of the Type 0 or Type 1 font that it is mapped to in the ttdef.fnt file.
  • Family names must not contain spaces.
style
A generic description of some aspects of a font. Valid values are:
SWISS
A proportionally spaced sans serif font.
ROMAN
A proportionally spaced serif font.
SCRIPT
A fixed-pitch font that is designed to look like handwriting.
MODERN
A fixed-pitch font that can be serif or sans serif.
DISPLAY
A decorative font.
weight
The degree of boldness of a typeface, caused by changing the thickness of the strokes used to create the character. Valid values are: LIGHT, MED, and BOLD. This value is optional.
italic
A font whose characters slant to the right. If the character set refers to an italic font, set this value to 1; if not, set it to 0. This value is optional.

For example, the [FGID] section of the character set definition file might contain these entries:

[FGID]
230=Gothic,MODERN,MED,0
2304=SWISS,MODERN,MED,0
2308=TimesNewRoman,ROMAN,MED,0

To edit the character set definition file:

  1. On Linux, log in to the primary computer using a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
  2. Navigate to /opt/infoprint/ippd/afpviewer/font (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font (Windows) and find the file csdef.fnt.
  3. Copy the file csdef.fnt and save it as a backup.
    For example, you can save the copy as csdef.fnt.bak.
  4. Open csdef.fnt in a file editor.
  5. Insert new lines for the character sets that your files require in both sections of the file, using the syntax above.
      Note:
    • You can use a question mark (?) as a wildcard character for any single character in the character set name. You can enter more than one ? character.
    • The DEFAULT line of the [CHARSET] section must be the last one in the list. Add your lines above it.
    • If you add your own AFP font character set to the [CHARSET] section, you must assign it an FGID. If the new character set has the same family name, style, weight, and italic attributes as an existing character set, you can use the same FGID; otherwise, you must add a unique FGID to the [FGID] section.
    • A semicolon (;) in the first column causes that line to be treated as a comment.
    • Section headers within files are enclosed in square brackets ([]) and must not be removed or changed.
    • All values are case-sensitive.
    • If a parameter value is not valid and a default value exists, the default value is used.
    • All parameters are positional.
    • Blanks are allowed between parameters.
  6. Save and close the file.

1.2.6.8.3.3 Editing the coded font definition file

You might have to edit the coded font definition file if you created or modified a code page or a character set and have linked them in a coded font.
The coded font definition file maps AFP coded fonts to their AFP character sets and AFP code pages. Two coded font definition files are installed with RICOH ProcessDirector:
ICODED.FNT
Contains definitions for approximately 2500 coded fonts, including the AFP Font Collection and Infoprint Fonts. Do not edit this file.
CODED.FNT
A file that you can edit to include any coded fonts that you have created.
The CODED.FNT file uses this syntax:
CODEDFONT=CHARSET,CODEPAGE
CODEDFONT
The identifier for the coded font that joins the CHARSET and the CODEPAGE.
CHARSET
The 8-character identifier for the character set.
CODEPAGE
The AFP code page name.

For example, the CODED.FNT file might contain these entries:

X?A155N1=C?A155N1,T1DCDCFS
X0T0550C=C0T05500,T1DCDCFS
You can use a question mark (?) as the wildcard character for any single character in the coded font name and the character set name. You can enter more than one ? character.

To edit the coded font definition file:

  1. On Linux, log in to the primary computer using a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
  2. Navigate to /opt/infoprint/ippd/afpviewer/font (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font (Windows) and find the file coded.fnt.
  3. Copy the file coded.fnt and save it as a backup.
    For example, you can save the copy as coded.fnt.bak.
  4. Open coded.fnt in a file editor.
  5. Insert new lines for the coded fonts that your files require, using the syntax above.
      Note:
    • A semicolon (;) in the first column causes that line to be treated as a comment.
    • Section headers within files are enclosed in square brackets ([]) and must not be removed or changed.
    • All values are case-sensitive.
    • If a parameter value is not valid and a default value exists, the default value is used.
    • All parameters are positional.
    • Blanks are allowed between parameters.
  6. Save and close the file.

1.2.6.8.3.4 Editing the TrueType font definition file

Edit the TrueType font definition file to map TrueType and OpenType fonts to Type 0 or Type 1 fonts.

In the ttdef.fnt file, the lines use this syntax:

full font name=familyname,style,weight,italic
full font name
The full font name of the TrueType or OpenType font.
familyname
The name of a Type 0 or Type 1 typeface or type family, such as TimesNewRoman or Courier.
    Note:
  • To determine the family name of a font, open the .pfa or .pfb file for that font with a text editor and search for /FamilyName.
  • Use one of these family names for efficient processing of DBCS TrueType fonts:
    Family name PostScript name
    JpnSys KozGoPro-Medium
    JpnSys2 KozMinPro-Regular
  • Family names must not contain spaces.
style
A generic description of some aspects of a font. Valid values are:
SWISS
A proportionally spaced sans serif font.
ROMAN
A proportionally spaced serif font.
SCRIPT
A fixed-pitch font that is designed to look like handwriting.
MODERN
A fixed-pitch font that can be serif or sans serif.
DISPLAY
A decorative font.
weight
The degree of boldness of a typeface, caused by changing the thickness of the strokes used to create the character. Valid values are: LIGHT, MED, and BOLD. This value is optional.
italic
A font whose characters slant to the right. If the character set refers to an italic font, set this value to 1; if not, set it to 0. This value is optional.

For example, the TrueType font definition file might contain these entries:

[TRUETYPE]
;full font name=familyname,style,weight,italic
Times New Roman=TimesNewRoman,ROMAN,MED,1
MS Gothic=JpnSys,SWISS,MED,0
MS Mincho=JpnSys2,ROMAN,MED,0
DEFAULT=TimesNewRoman,ROMAN,MED,1

To edit the TrueType font definition file:

  1. On Linux, log in to the primary computer using a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
  2. Navigate to /opt/infoprint/ippd/afpviewer/font (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font (Windows) and find the file ttdef.fnt.
  3. Copy the file ttdef.fnt and save it as a backup.
    For example, you can save the copy as ttdef.fnt.bak.
  4. Open ttdef.fnt in a file editor.
  5. Insert new lines for the fonts that you want to map, using the syntax above.
      Note:
    • The DEFAULT line must be the last one in the list. Add your lines above it.
    • If you map a TrueType or OpenType font to a Type 1 or Type 0 font that is not one of the standard fonts that the AFP viewer uses, the non-standard font must be mapped in the Type 1 and Type 0 font map.
    • A semicolon (;) in the first column causes that line to be treated as a comment.
    • Section headers within files are enclosed in square brackets ([]) and must not be removed or changed.
    • All values are case-sensitive.
    • If a parameter value is not valid and a default value exists, the default value is used.
    • All parameters are positional.
    • Blanks are allowed between parameters.
  6. Save and close the file.

1.2.6.8.3.5 Editing the Type 1 and Type 0 font map

If the TrueType font definition file maps TrueType or OpenType fonts to any non-standard Type 1 or Type 0 fonts, you must supply the Printer Font Metrics (.pfm) and Printer Font Binary (.pfb) files for these fonts and edit the Type 1 and Type 0 font map.

The fontmap.lst file has two sections. The font directory section lists the directories where non-standard Type 1 and Type 0 fonts reside. The font name section maps the PostScript name of each non-standard font to its file names.

In the font directory section, the lines use this syntax:

$Font_Directories (pfm_directory) (pfb_directory)
$Abs_Path_Prefix (absolute_path_prefix)
pfm_directory
The full path name of a directory that contains .pfm files, not including the final slash (/ or \). You can specify only one value for pfm_directory on each $Font_Directories line, but you can specify multiple lines.
pfb_directory
The full path name of a directory that contains .pfb files, not including the final slash (/ or \). You can specify only one value for pfb_directory on each $Font_Directories line, but you can specify multiple lines.
absolute_path_prefix
A string at the beginning of a font reference that indicates that the reference is an absolute path. You can specify up to 10 values for absolute_path_prefix on a single $Abs_Path_Prefix line. Each value can be 1 to 7 characters (bytes). Enclose each value in parentheses.

For example, the font directory section might contain these entries:

For Linux:
$Font_Directories (/opt/infoprint/ippd/ProcessDirector/afpviewer/font/pfm) (/opt/infoprint/ippd/ProcessDirector/afpviewer/font/pfb)
$Font_Directories (usr/local/lib/ghostscript/fonts) (usr/local/lib/ghostscript/fonts)
$Font_Directories (.) (.)
$Abs_Path_Prefix (/) 

For Windows:
$Font_Directories (C:\Program Files\Ricoh\ProcessDirector\afpviewer\font\pfm) (C:\Program Files\Ricoh\ProcessDirector\afpviewer\font\pfb)
$Font_Directories (usr\local\lib\ghostscript\fonts) (usr\local\lib\ghostscript\fonts)
$Font_Directories (.) (.)
$Abs_Path_Prefix (\) 

In the font name section, the lines use this syntax:

font_name (pfm_file) (pfb_file)
font_name
The PostScript name of a Type 0 or Type 1 font.
pfm_file
The file name of the .pfm file for that font, including the file extension.
pfb_file
The file name of the .pfb file for that font, including the file extension.

For example, the font name section might contain these entries:

Garamond-Light       (GAL_____.PFM) (GAL_____.PFB)
Garamond-Bold        (GAB_____.PFM) (GAB_____.PFB)
Garamond-LightItalic (GALI____.PFM) (GALI____.PFB)
Garamond-BoldItalic  (GABI____.PFM) (GABI____.PFB)

To edit the Type 1 and Type 0 font map:

  1. On Linux, log in to the primary computer using a user ID that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default).
  2. Then make sure that the RICOH ProcessDirector group has read permission for the .pfm and .pfb files that you want to use.
  3. Navigate to /opt/infoprint/ippd/ProcessDirector/afpviewer/font (Linux) or C:\Program Files\Ricoh\ProcessDirector\afpviewer\font (Windows) and find the file fontmap.lst.
  4. Copy the file fontmap.lst and save it as a backup.
    For example, you can save the copy as fontmap.lst.bak.
  5. Open fontmap.lst in a file editor.
  6. Insert new lines for the Type 1 and Type 0 fonts in both sections, using the syntax above.
      Note:
    • The font directory section must be before the font name section.
    • The $Abs_Path_Prefix line must be the last one in the font directory section. Add your $Font_Directories lines above it.
    • A pound sign (#) or a percent sign (%) in the first column causes that line to be treated as a comment.
    • All values are case-sensitive.
    • All parameters are positional.
    • Blanks are allowed between parameters.
  7. Save and close the file.

1.2.6.9 Downloading print files from jobs

You can download the print files for one or more jobs directly from the Jobs table.
To download the print files:
  1. In the Jobs table, select one or more jobs.
  2. Right-click the row for one of the and select Download data file.
    The print files contained in each job are collected and archived into a ZIP file.
  3. The ZIP file is downloaded based on your browser settings.
The downloaded ZIP file contains the print files for each selected job.
    Note:
  • To get permission to download the data files, contact your system administrator.

1.2.6.10 Working with jobs when using document processing features

This section describes special considerations for working with jobs.

1.2.6.10.1 Considerations with the Process Again action

You can use the Process Again action on jobs that have been through the IdentifyDocuments or IdentifyPDFDocuments step, but you must be aware of some important points.

If the job created child jobs, you cannot process the parent job again until those child jobs are removed from the system. If you try to use the Process Again action when child jobs exist, you see a message listing the child jobs that you must delete.

If you are using the Advanced Document Pool extended feature, you can process a production job again. If the job created child jobs, you cannot process the original job again until those child jobs are removed from the system. If you try to use the Process Again action when child jobs exist, you see a message listing the child jobs that you must delete.

1.2.6.10.2 Considerations with the Print Again action

You can use the Print Again action with jobs that you created using document processing features; however, you must be careful not to create duplicate physical documents. Remember to destroy the originals.

Remember that the original job that entered the system might use a workflow that does not include a PrintJobs step, so you might need to do the Print Again action on a child job instead.

With the Advanced Document Pool extended feature, you cannot use the Print Again action if there are any other production jobs in the system that are actively processing documents from the same original job. You can wait for those production jobs to finish processing, or you can use the Pull or Make Available action for the documents in the job that you want to print again.

1.2.6.11 Submitting jobs when using Avanti Slingshot

In Slingshot, you create a sales order with one or more line items and attach PDF files to the line items. Then you release the sales order for processing and export one or more PDF files associated with a JDF job ticket to RICOH ProcessDirector.

    Note:
  • For a typical implementation of Slingshot, you do these steps to exchange information with RICOH ProcessDirector. Your implementation of Slingshot can have steps that differ from these steps.

To submit jobs when using Avanti Slingshot:

  1. Log in to the Avanti Slingshot client.
  2. Create a new sales order:
    1. In the left pane, click Sales Orders.
    2. Click New (New icon).
    3. Fill in the information you need for Slingshot.
  3. On the Line Items tab:
    1. To create a Line Item for the first type of work in the sales order, for example, Business Cards or Statements, select a Type.
      Important: RICOH ProcessDirector must have a hot folder input device with the same name as the Line Item Type. The hot folder must use the JDF Batching method.
    2. Select a Code for the Line Item, for example, 3.5 x 2 Business card.
    3. Select or type a Description for the Line Item.
    4. Specify Qty Ordered and fill in other information that you need for Slingshot.
    5. Click Add.
  4. On the Sections tab:
    1. Make sure that Description is the name of the Line Item, which is also the name of a RICOH ProcessDirector hot folder. If Description does not have a value, type the name of the RICOH ProcessDirector hot folder that receives the PDF files from Slingshot.
    2. Make sure that Press specifies a printer device that RICOH ProcessDirector sends jobs to. If not, change the value.
      Note: To change the value, click Information (Information icon). Click the Press tab and select a press from the list. Click the Selected Press check box. Click Close.
  5. To attach PDF files to the sales order, on the Documents tab:
    1. Click Attachment (Attachment icon).
    2. Click Select.
    3. Click Browse.
    4. Select a PDF file and click Open.
    5. Click Upload.
    6. Select Copy and click Attach.
    7. In the Section column, select the name of the Line Item. If Section does not have a value, type the name of the RICOH ProcessDirector hot folder that receives the PDF file from Slingshot.
      Important: RICOH ProcessDirector must have a hot folder input device with the same name as the Line Item in the Section column.
    8. In the For Job column, click the check box.
    9. To attach another PDF file, repeat these steps.

      If you attach multiple PDF files to the same line item, Slingshot creates one JDF job ticket for all the PDF files. Each PDF file becomes a separate RICOH ProcessDirector job.

  6. Create a Line Item for each additional type of work in the sales order by repeating the steps for the Line Items, Sections, and Documents tabs.
  7. Click Save Record (Save Record icon).
  8. Release the sales order for processing:
    1. In Table View, click the arrow to the left of the sales order.
    2. Click Edit (Edit icon).
    3. Select Release Order on the Actions list in the upper right corner.

      You see a confirmation message.

    4. Click OK.

      Slingshot assigns a Slingshot job number to each Line Item on the sales order.

    5. Click either Print Job Ticket or Close.
  9. To export each set of one or more PDF files associated with a JDF job ticket to RICOH ProcessDirector:
    1. Navigate to Production Job View.
    2. Select the first Slingshot job for the sales order that you released.
    3. In the Job Details area, click the Sections tab.
    4. Select the Section for the set of PDF files that you want to export, and click Export JDF Based on Tasks (Export JDF Based on Tasks icon).

      Slingshot sends the set of PDF files and the JDF job ticket to the RICOH ProcessDirector server.

      Each PDF file appears as a job in the RICOH ProcessDirector Jobs table.

    5. Select the next Slingshot job for the sales order and repeat these steps.

1.2.6.12 Working with jobs when using Deadline Tracker

This section describes special considerations for working with jobs.

1.2.6.12.1 Setting, changing, or removing job deadlines

You can set a job deadline manually or change a deadline set by the workflow.
To set, change, or remove a job deadline:
  • To set or change a deadline:
    1. Right-click the job in the Jobs table and select Change Deadline.
    2. Set or change the Deadline step property by selecting the name of the step that a job must complete to meet its deadline.
    3. Set the new date, time, and time zone.
      The Change Deadline action lets you change a deadline to a specific time. The action has no effect on any SetDeadline step in a workflow.
    4. Click OK.
  • To remove a deadline:
    1. Right-click the Job and select Remove Deadline.
    2. In the confirmation message, click OK.
If the current deadline has already passed for the job when the deadline is changed or removed, the value of the Deadline outcome property remains unchanged.

1.2.6.12.2 Getting a job back on schedule

If a job falls behind schedule, you can take several different actions to get the job back on schedule.
To get a job back on schedule, do one of these:
  • Change the priority of the job.
  • Schedule the job to a faster printer.
  • If you have a fast-path workflow or branch of the current workflow, you can change a property on the job. Then process the job again to send it down the fast-path workflow or branch.
    A fast-path workflow might have the fewest steps required to complete a job before the deadline.
If you want to be notified as soon as a job falls behind schedule, ask your administrator to set up a notification to send an email when the value of the Tracking status property for the job changes to Behind schedule.

1.2.6.12.3 Tracking the progress of a job using Deadline Tracker

If you have the Deadline Tracker feature installed and have set estimated durations for at least one step in the workflow for the job, you can see the progress of the job in its workflow.
To track the progress of a print job:
  1. Right-click a job in the Jobs table and select View job in workflow.
  2. You can see the percent of the estimated processing time that has elapsed by hovering over the blue bar on the bottom of the window.
  3. Click OK to close the dialog.

1.2.6.13 Working with jobs when using Archive

This section describes special considerations for working with jobs.

1.2.6.13.1 Retrieving documents, jobs, and history information from a repository

Use the Archive tab to search for documents and jobs that have been stored in a repository.
After you search the repository, you can do multiple actions with the results, such as: view the job or document, look at the production history for a job or document, view and export a report of all the information stored for one or more items, send a job or document to be reprinted, or save it to your workstation.

To retrieve documents, jobs, and history information from a repository:

  1. In the Archive tab, choose the repository to search in the Repository to search field.
  2. Set the number of results to return in the Number of Results field. The search stops after this number of results is found.
  3. Define one or more search conditions.
    1. Select a Job or Document property in the Property field.
    2. In the Comparison field, select a comparison value.
    3. In the Value field, type or select the value to use for the search.
  4. Optional: To add another condition, click Add () to the right of the current search condition row.
  5. Select a search option in the Search criteria field. This option determines how the search options are combined.
  6. Optional: To remove a condition, click the Remove () button to the right of the row to remove.
  7. When you finish adding search options, click Search.
      Note:
    • If too many results are returned, you can add another search option and search again.
    • If the job was processed again and ran the StoreInRepository step more than once, two copies of the document or job are stored and both are returned in the search results.
  8. After the search results appear in the Results table, you can do several actions after you select a row in the table.
    • To view a job or document, click View file.
    • To submit one or more jobs or documents back into the RICOH ProcessDirector system, click Submit file, select a workflow, and click OK.
    • To review the property values and any history information stored with a job or document, click Show details.
    • To see a report that contains all the values and any history information stored with one or more jobs or documents, click View detailed report.
    • To export the property values and any history information for one or more jobs or documents to a comma-delimited file, click Export to CSV.
    • To export a report that contains the property values and any history information for one or more jobs or documents in a PDF file, click Export to PDF.
    • To save a file from a repository to your workstation, click Save to file.
  9. If you are likely to use this search criteria again, click Save and give it a name. The next time you have to use the same search criteria, you can choose it from the Saved searches list.
  10. Optional: Delete unwanted saved searches.
    1. From the Saved searches list, hover over the search you want to delete.
      A X appears to the right of the search name.
    2. Click the X.
      The X turns red.
    3. Click the red X.
      The saved search is deleted.

1.2.6.13.2 Viewing a document or job retrieved from a repository

After you search a repository that has PDF or AFP job data files stored in it, you can open the job or documents in the RICOH ProcessDirector viewer to make sure that the correct file has been found or to view information in the file. You cannot view jobs or documents if the repository contains only properties or history information.

To view a document or job within a repository:

  1. In the Archive tab, search for a document or job stored in a repository.
  2. Select an entry in the Results table that contains a document or job and click View file.
    The file opens in a dialog.
  3. Use the Viewer controls to move through the file, including the search function.
    If you search for document properties and the wrong page opens, the file might have been stored in the repository after one or more steps that changed the order of pages in the job. The document properties are mapped to the order that the pages were in when the IdentifyDocuments, IdentifyPDFDocuments, BuildAFPFromDocuments or BuildPDFFromDocuments step ran. If later steps changed the page order, that information was not updated in the repository.
  4. Optional: Click the Submit file button to send the job or document you are viewing to a workflow.
  5. Optional: Select an entry in the Results table and click Save to file. The selected file is saved to your workstation.

1.2.6.13.3 Viewing and exporting properties and history information

After you search a repository, you can view the properties and production history for jobs or documents listed in the Results table.
Each search result is a separate entry in the repository. If more than one StoreInRepository step processed a job or document, your search likely returns multiple results for the same job or document. You can view or export the properties and history information for a single entry or for all of the entries associated with that job or document.

To view and export properties and any history information:

  1. In the Archive tab, search for documents or jobs stored in a repository.
  2. Review the entries in the Results table. You can view details about each entry individually or as a group:
    Option Action
    To see details about a single entry Select the entry and click Show details.
    To see details about multiple entries at the same time Select multiple entries and click View detailed report.
  3. To export the properties and history information about one or more entries, select one or more results and choose one of these actions:
    Action Result
    Export to CSV Detailed information about each result is written into two CSV files, one for history information and one for properties. The CSV files are packaged as a ZIP file that you can save to your computer.
    Export to PDF Detailed information about the selected results is collected and composed in a PDF file. The file lists the properties for each result, then shows a table for the history information about each result. You can save The PDF file to your computer.
    View detailed report Detailed information about the selected results is collected and composed in a PDF file, then displayed so you can review it. If the file contains the information that you need, click Export to PDF.

1.2.6.13.4 Submitting a retrieved document as a new job

After you search a repository, you can resubmit jobs or documents so they can be reprinted or reprocessed. You cannot resubmit a document or job for which only history information has been saved.
After you find a job or document in a repository, you can submit it as a new job for additional processing, such as reprinting the same document that was sent in the mail.
  1. In the Archive tab, search for a document or job within a repository.
  2. In the Results table, select the document or job by either selecting the check box or by clicking anywhere in the row in the table.
      Note:
    • You can only submit one job to a workflow at a time.
  3. Optional: Click View fileto view the document or job. You can view only AFP or PDF data files.
  4. Click Submit file. A Submit file dialog appears.
  5. On the dialog, select the workflow you want to use. Be sure the workflow you select is appropriate for the type of job or document you selected.
      Note:
    • Any document properties stored with the document in the repository are also submitted with the new job. The properties are included in the jobid.document.overrides file in the spool directory for the job. Steps in the workflow can use symbol notation to refer to the file as input for other processing.
    • If an override properties file is saved with the job in the repository, an arch.overrides.txt file containing the saved values of the override job properties is submitted with the new job.
  6. Click OK.

1.2.6.14 Working with jobs when using Automated Verification

You can complete the ReadBarcodeData step for a job manually as part of your barcode verification process or to see the status of the verification. If your barcode scanner or camera scans a barcode that the barcode reader is not able to interpret, you can resolve the invalid scans.

When the verification is complete, the system can reconcile the job automatically or you can reconcile it manually. If documents are damaged after reconciliation is complete, you can reprint them by using the Print Again action.

1.2.6.14.1 Completing the barcode step for a job

If the Complete step when all barcodes are read property for a step based on the ReadBarcodeData step template is set to No, you must complete the barcode step for a job manually. Then the system can reconcile the job automatically or you can reconcile it manually.
You can also complete the barcode step for a job manually while it is in the Reading barcodes state.
    Note:
  • If the Complete step when all barcodes are read property is set to Yes or the Results file inactivity timer property is set to a value, you do not need to complete the barcode step manually. RICOH ProcessDirector can complete the step automatically.
To complete the barcode step for a job:
  1. In the Jobs table on the Main page, right-click the job that is in the Reading barcodes state and select Complete barcode step.

    As the camera or barcode scanner reads the barcodes of the documents in a job, you can use this action to check the progress.

  2. Review the information on the dialog. If some documents have not been read and you do not want to complete the step, click CANCEL.

      Note:
    • You can select the job and move it to the next step regardless of whether all the barcodes of all documents have been read.

  3. If you believe that all the barcodes have been processed, click OK.

    The job moves to the next step in the workflow. If that step is based on the Reconcile step template, the state changes to Waiting to reconcile or Processing, based on the reconciliation method that the step uses.

RICOH ProcessDirector records who did the action and when it occurred in the Job log. If the Reports feature is installed, the information is also recorded in the UserActivity Report.

1.2.6.14.2 Resolving invalid scans

If your barcode scanner or camera scans a barcode that the barcode reader is not able to interpret, the barcode reader goes into the Attention state.
A red bar is displayed next to the barcode reader in the portlet. It continues to read barcodes. Check whether intervention is required to resolve errors.

There are many reasons that cause a barcode scanner or camera to fail to read a barcode. For example:

  • Dust or other contamination is on the lens.
  • The lighting conditions have changed.
  • Different media is being scanned and the barcode is not detected on the new media.
  • The barcode scanner or camera is not aligned correctly.
  • The barcode scanner or camera configuration or calibration has changed.
  • The barcode scanner or camera received scan data that it does not recognize.
  • The barcode format used to produce the barcode does not match what the barcode reader is expecting.
  • The mail piece did not contain a barcode in the expected location. This failure could happen if, for example, the first page of the second document was put in an envelope at the end of the first document.
  • An unexpected event triggered the barcode scanner or camera.

To restore the state of the barcode reader:
  1. Find the barcode reader that is in the Attention state and open its log. Look for information about the last valid barcode scanned and the next valid barcode scanned, to help identify the scan that was detected as invalid.
  2. Find the items that scanned incorrectly and take the necessary actions to resolve the errors.
  3. In the Barcode Readers portlet, right-click the barcode reader that is in the Attention state and select Clear Alert.

1.2.6.15 Logging job information before the job completes

RICOH ProcessDirector writes job information to an audit log when the job's retention period ends. You can also log job information at any point in the print process.
To log job information before the job completes:
  1. Add a step based on the WriteJobLog step template to the workflow at the point where you want to log the information (for example, after the PrintJobs step).
  2. In the WriteJobLog step, set these properties:
    1. Set External command to a command that writes a log file. For example:
      cp ${getControlFileName()} /aiw/aiw1/testfiles/${Job.ID}.log
    2. Set External control file to the name of the job audit control file that defines the properties that you want to log.

1.2.6.16 Moving jobs to the next step

You can move one or more jobs to the next processing step with the Go to Next Step action. You can do this task only if the job is in one of these states: Error; Manual, Waiting; Manual, Working; Retained; Unassigned; or Waiting.

To move one or more jobs to the next step:

  1. In the Jobs table, select the jobs that you want to move.
  2. Right-click one of the jobs and select Go to Next Step.

    You see a confirmation message that lists all the selected jobs.

  3. Click OK.

If any jobs cannot move to the next step, the system lists them.

1.2.6.17 Restarting jobs at the current step

You can restart one or more jobs so that they process the current step again from the beginning, using the Restart Step action. You can do this task only if the jobs are in the Error state.

To restart one or more jobs at the current step:

  1. In the Jobs table, select the job or jobs that you want to restart.
  2. Right-click one of the jobs and select Restart Step.

    You see a confirmation message that lists all the selected jobs.

  3. Click OK.

If any jobs cannot restart at the current step, the system lists them.

1.2.6.18 Stopping a job or a group of jobs

You can stop processing a job or a group of jobs and then start to process them again later, either from the point that they stopped or from a different spot. You must stop jobs to do some job actions.

In most cases, jobs finish processing in their current steps before stopping. You can continue processing the job using the same workflow, or you can process it again using a different workflow.

If you stop a job while it is printing on an AFP or PCLOut printer (included with the AFP Support feature), you can have RICOH ProcessDirector remember the last page that printed. That way, you can use the Continue function to start printing again from the point where the job stopped. However, if you need to start printing from a different point, you can select a page range or select a page to start printing from.

    Important:
  • If you stop a job that is printing on a PDF or Passthrough printer, RICOH ProcessDirector tries to cancel the command, but the job might continue printing.
  • This action is not supported for PDF jobs printing on a Ricoh TotalFlow printer.

To stop a job or a group of jobs:

  1. In the Jobs table, right-click the job that you want to stop and select Stop.
    • If the job is a member of a group of jobs, the confirmation page lets you stop all the jobs in the group. Follow the instructions on the page.
    • If a job is printing on an AFP printer and you stop the job during the PrintJobs step, you can have RICOH ProcessDirector remember the last page that was printed so you can resume printing from that point later.
The job or jobs are moved into the Stopped state. The progress in the phase is changed to Manual.

1.2.6.19 Deleting jobs

You can delete a job that is no longer needed.

Jobs can be deleted during any phase and in any state.

To delete one or more jobs:
  1. Select one or more jobs, right-click one, and select Delete.
  2. On the confirmation dialog, click OK if you are sure that you are deleting the correct jobs.

When RICOH ProcessDirector deletes jobs, it moves the jobs to their first step in their workflows that have a restart type of Delete. That step and steps following it can record information about the jobs before they go to the RemoveJobs step. If no step in the workflow has a restart type of Delete, RICOH ProcessDirector advances the jobs to the RemoveJobs step.

1.2.6.20 Working with documents

You can work with documents using the Documents portlet on the Main page of the user interface.

For example, you can find documents in the system and then create a new job to process them. Or, you can find the job that contains a document and then do actions on the job from the Jobs table.

1.2.6.20.1 Finding documents in the system

You can find documents in the RICOH ProcessDirector system using the search functions on the Documents portlet on the Main page. You need to find documents before you can work with them.
Note: A step based on the WriteDocumentsToDatabase step template must have run in your workflow before documents appear in the Documents portlet.

1.2.6.20.1.1 Finding documents by properties

You can search for documents in the Documents portlet using property values. This method is useful if you know the values of one or more RICOH ProcessDirector job or document properties.

Tips:

  • You can find documents only if they are in the RICOH ProcessDirector database. A step, such as WriteDocumentsToDatabase, that updates the database with document property values must have run in your workflow for the document search function to work.
  • When searching for documents, you cannot search by location because individual documents are not associated with a particular location. Also, documents are displayed for all locations regardless of any location preferences that you or the administrator has set.

To find documents by properties:
  1. In the Documents portlet on the Main page, click By property.
  2. Click the Edit () button.
  3. Define one or more characteristics to use to search for the documents you want to retrieve.
    To see information about any of the search options, click the Image of a button with a question mark on it icon.
  4. Click OK.
  5. To find documents that have other property values, repeat these steps.
    Each new search clears the table and only the results from the most recent search are displayed.

1.2.6.20.1.2 Finding documents by scanning barcodes

You can search for documents in the Documents portlet using barcodes. This method is useful if the document has been printed and a barcode on the document contains properties that identify the document.

Tips:

  • The administrator must first create a barcode format object that describes the layout of the job and document properties in the barcode. The properties contained in the barcode format must be defined as database properties, not limited properties.
  • You can find documents only if they are in the RICOH ProcessDirector database. A step, such as WriteDocumentsToDatabase, that updates the database with document property values must have run in your workflow for the document search function to work.
  • When searching for documents, results are displayed for all locations regardless of any location preferences that you or the administrator has set.

To find documents by scanning barcodes:
  1. In the Documents portlet on the Main page, click By barcode scan.
  2. Click the Edit () button.
  3. Select a barcode format from the Barcode format list.
  4. Click in the Scan barcodes field and scan the barcodes for the documents you want to find.
  5. Click OK.
  6. To find more documents, repeat these steps.
      Note:
    • Each new search clears the table and only the results from the most recent search are displayed.

1.2.6.20.2 Viewing documents

You can view the contents of documents using the View action on the Documents table. You can view the contents of any document that was submitted in a PDF job, or in an AFP job if you have the AFP Support feature installed.
To view a document:
  1. In the Documents portlet on the Main page, find the documents to include in one or more new jobs.
    To find the documents, you search either using document property values or by scanning barcodes.

    If you select By properties:

    1. Click the Edit () button.
    2. Define one or more characteristics to use to search for the documents you want to retrieve.

      To see information about any of the search options, click the Image of a button with a question mark on it icon.

    3. Click OK.

    If you select By barcode scan:

    1. Click the Edit () button.
    2. Select a barcode format to use from the Barcode format list.
    3. Click in the Scan barcodes field, then scan the barcodes for the documents you want to find.
    4. Click OK.

  2. Right-click the document to view and select:
    • View Original to view a document in its original form. You do not see any changes that RICOH ProcessDirector made to the contents of the document. For example, you do not see barcodes that were added after the original job was received.
    • View Current to view a document in its current form.
    You see the document in your browser window. The job opens to display the selected document.
  3. Use the viewer controls to move through the document.
  4. Click Close.

1.2.6.20.3 Viewing document properties

You can view the properties of documents using the Properties action on the Documents table. The properties of a document include the document number, job number, and document state.
To view the properties of a document:
  1. In the Documents portlet on the Main page, find the document whose properties you want to view.
    To find the documents, you can use By properties. By barcode scan, or By range.
  2. Right-click the document and select Properties.
      Note:
    • You cannot set document properties from the property notebook.

1.2.6.20.4 Creating jobs to process documents

You can create jobs to process selected documents using the Create Job action on the Documents table. For example, you can create a job to reprint documents that were damaged after they were printed.
    Note:
  • Use the Reconcile action on the Jobs table to reprint documents that are damaged during processing, for example, during the insertion process. Use the Create Job action only to reprint any documents that are damaged after the job has been reconciled.

When you create a job, you must select a workflow for the new job. For AFP jobs, the workflow must contain a step based on the BuildAFPFromDocuments step template. For PDF jobs, the workflow must contain a step based on the BuildPDFFromDocuments step template.

RICOH ProcessDirector creates a separate job for the documents in each original job unless the Advanced Document Pool extended feature is installed. The documents in the new jobs are in the order in which the Documents table displays the documents.

To create a job to process documents:
  1. In the Documents portlet on the Main page, find the documents that you want to include in one or more new jobs.
    To find the documents, you can use By properties, By barcode scan, or By range.
  2. Select all the documents that you want to include in a job.
  3. Click Create Job.
    You see the Create a Job page.
  4. In the Workflow field, select a workflow for the job.
  5. Click OK.
    A confirmation message shows that one or more jobs were created, and shows the number of documents in each job.

1.2.6.20.5 Emailing documents during job processing

You can email PDF documents by adding a step based on the EmailDocuments step template to a workflow.

You must provide an email address for each document and store the email address in a document property. You can use the Doc.EmailAddress document property, or you can define a custom document property in the docCustomDefinitions.xml file. After you define a custom document property, run the docCustom utility and update the Custom Document Properties feature.

  • If each document contains the email address of the document recipient, you can use the Define Document Property function in RICOH ProcessDirector Plug-in for Adobe Acrobat to specify the email address data that you want to extract from each document in a job.
  • If you have the Preference Management feature installed, you can map email addresses in an external file to the document property for each document in the job.

You must have an SMTP server installed and configured to let RICOH ProcessDirector send email. RICOH ProcessDirector lets you connect to two SMTP servers. You might use the default SMTP server properties to connect to an internal SMTP server and the alternate SMTP server properties to connect to an email service provider.

To configure RICOH ProcessDirector to email documents during job processing:
  1. Make a copy of an existing workflow or create a new workflow.
  2. Add a step based on the EmailDocuments step template to the workflow after the BuildPDFFromDocuments step and before any step that reorders documents at the job level, such as ReversePDFPageOrder or PreparePDFOutputForFinishing.
    You can place the EmailDocuments step after steps that reorder documents at the document level, such as GroupDocuments, SortDocuments, and SplitDocuments.

    For jobs that email and print documents, a typical step order is:

    • IdentifyPDFDocuments
    • SortDocuments
    • BuildPDFFromDocuments
    • EmailDocuments
    • PreparePDFOutputForFinishing
    • PrintJobs

    If you add a step to keep a copy of the job file in the spool directory to use for extracting documents to email, you can place the EmailDocuments step after a step that reorders documents at the job level. For example, you can place a step based on the SnapshotJobFile step template after the BuildPDFFromDocuments step and before the step that reorders documents:

    • IdentifyPDFDocuments
    • SortDocuments
    • BuildPDFFromDocuments
    • SnapshotJobFile
    • PreparePDFOutputForFinishing
    • PrintJobs
    • EmailDocuments

      Important:
    • If you do not follow these recommendations for step placement, the EmailDocuments step could send a document to the incorrect email address without recording an error.

  3. Connect the step to the other steps in the workflow.
    If you want to print some documents and email others, add conditional processing to the workflow or create child workflows.

    For example, you can:

    • Add conditional processing for parent and child jobs at the start of the workflow (for example, after a SetJobPropsFromTextFile step). Define a rule for the branch that receives the parent jobs: Job number Unlike *.*. Child jobs, which have a decimal point in their job number, go to the branch for child jobs.
    • Define a Doc.Custom.EmailPreference document property with values of Yes and No.
    • Use a step based on the GroupDocuments step template to group the documents based on the value of the Doc.Custom.EmailPreference document property.
    • Use a step based on the CreateJobsFromDocuments step template to create a separate child job for each group.
    • Use a step based on the SetDocPropsFromConditions step template at the start of the branch for child jobs. The step assigns a value to a job property based on the value of the Doc.Custom.EmailPreference document property.

      The property conditions file might set the value of the Custom 1 job property (database property name Job.Info.Attr1) to email or print:

      Doc.Custom.EmailPreference,Job.Info.Attr1
      =Yes,email
      =No,print

    • Send the child jobs to separate email and print branches of the branch for child jobs by defining rules on the branches:
      • Custom 1 = email for the branch with the EmailDocuments step.
      • Custom 1 = print for the branch with the PrintJobs step.

  4. Specify property values for the EmailDocuments step:
    1. Set a value for the Recipient address property.
      For example, you want to email each document to the email address in the Doc.EmailAddress document property. Set the value to ${Doc.EmailAddress}.
    2. Set a value for the SMTP server type property.
      For example, you want to send documents to an external SMTP server that has been configured with the Alternate SMTP server properties. Set the value to Alternate.
    3. Set the Attach document property to Yes.
    4. Set a value for the Source file for attachment property.
      Examples:
      • You want to attach a document from the current PDF file in the job's spool directory. Use the default value: ${getFileName(print,pdf,read)}.
      • You want to attach a document from a PDF file that you saved with a SnapshotJobFile step. If you set the value of the Snapshot file descriptor property on the SnapshotJobFile step to email, use this value: ${getFileName(email,pdf,read)}.
    5. Set a value for the Subject property, the Message property, or both.
      For example, you extracted the customer name from each document by defining a Doc.Custom.CustomerName document property. You can set the value of either property to Statement for ${Doc.Custom.CustomerName}.
    6. Fill in or edit values for any other optional properties that you plan to use.
  5. After you save and enable your workflow, test the workflow to make sure that it is working properly:
    1. Create a test job with a small number of documents. They should have valid email addresses that you want to test with.
    2. Send the job through the workflow and make sure that the correct document is sent to each email address.
When the EmailDocuments step sends a document to the SMTP server, it sets the Email created property value to Yes in the document property file. If the step does not send a document, it sets the property value to No.
    Note:
  • RICOH ProcessDirector does not receive information from the SMTP server about sending email or successful delivery to recipients.

1.2.6.20.6 Finding the jobs associated with documents

You can find the jobs associated with documents using the Show Jobs action on the Documents table. After you find the associated jobs, you can do job actions on the Jobs table.

The associated jobs include:

  • The original job that was submitted to RICOH ProcessDirector and that contained the document.
  • Child jobs that RICOH ProcessDirector automatically created that include the document.
  • Jobs that you created using the Create Job action on the Documents table.

To find the jobs associated with a document:

  1. In the Documents portlet on the Main page, find the document whose associated jobs you want to find.
    To find the documents, you can use By properties, By barcode scan, or By range.
  2. In the Documents table, right-click the document for which you want to see the associated jobs and select Show Jobs.
    The Jobs table shows the jobs associated with the selected document.

1.2.7 Performance

You can tune RICOH ProcessDirector to improve performance.

1.2.7.1 Defining secondary servers on the primary computer

You can define a secondary server directly on the primary server to distribute processing and improve the performance of your system. No additional software is required on the primary computer.
For example, you can define a secondary server on the primary computer then configure certain steps to run on that server instead of on the primary. This configuration lets the processing run in parallel and removes some of the burden from the primary server.

To define a secondary server on the primary computer:

  1. Click the Administration tab.
  2. In the left pane, click Objects Servers.
  3. On the Servers page, click Add and choose Secondary Server.
  4. Fill in the values as required.
    • For the Computer IP address or host name property, enter: localhost
    • For the In general server pool property, choose whether you want the secondary server to be used for any steps or for only certain steps. Select Yes to run any steps on this server; select No to limit this server to specific steps.
  5. Click OK.
  6. If you set In general server pool to No, tune the step templates that you want to run on this server.
    1. Click the Workflow tab.
    2. In the left pane, click Step Templates.
    3. Click the name of the step template to tune.
    4. In the property notebook, click the Tuning tab.
    5. For the Servers to use property, select Run on specific servers, then select the server you just created.
    6. Click OK.

1.2.7.2 Using multiple file systems to distribute spool I/O on primary computer

You can distribute I/O activity across multiple file systems to improve throughput.
The /aiw file system contains the spool directories for the entire RICOH ProcessDirector system. You can extend the /aiw file system by defining partitions on the primary computer and mounting them under the /aiw file system to distribute spool processing.

It is recommended that you use an additional hard drive that is the same size as your /aiw file system (80 + GB) and a dedicated SCSI channel or bus port for the additional partition.

To define a new partition and mount it in the spool directory on the primary computer:
  1. Stop the system:
    1. On each secondary computer, log in as the RICOH ProcessDirector system user (aiw1 is the default) and enter stopaiw.
    2. On the primary computer, log in as the RICOH ProcessDirector system user and enter stopaiw.
  2. On the primary computer, log in as the root user.
  3. Enter this command to change to the spool directory:
    • cd /aiw/aiw1/spool
  4. If the spool directory does not exist, the command fails and you see this message: No such file or directory. If that happens, enter these commands:
    1. cd /aiw/aiw1
    2. mkdir spool
    3. chown systemuser:group spool,
      where systemuser is the RICOH ProcessDirector system user (aiw1 is the default) and group is the RICOH ProcessDirector group (aiwgrp1 is the default).
    4. chmod 775 spool
    5. cd /aiw/aiw1/spool
  5. From the aiw/aiw1/spool directory, enter this command to create a new spool directory on the primary computer:
    • mkdir newspooldirectory
    • newspooldirectory is any valid directory name on your system.
  6. Use YaST (Yet another Setup Tool) System Partitioner to define the new partition and where it is to be mounted. The mount point is: /aiw/aiw1/spool/newspooldirectory
  7. Enter these commands to specify the appropriate permissions:
    1. cd /aiw/aiw1/spool
    2. chown systemuser:groupnewspooldirectory
    3. chmod 775 newspooldirectory
  8. If you have secondary servers, you must export a new directory or partition:
    1. To export the newspooldirectory directory to remote secondary servers use rw,no_root_squash,sync mount options.
    2. Configure each remote Linux secondary computer to mount the new spool directory separately from /aiw mount.
    3. Make sure that you can access on the secondary server the contents of the newspooldirectory mounted on separate filesystem. Secondary servers fail if they cannot access the file systems.
  9. Restart RICOH ProcessDirector:
    1. Restart the base product by logging in to the Linux system as the RICOH ProcessDirector system user and entering startaiw.
    2. Restart each secondary server by logging in to each secondary computer as the RICOH ProcessDirector system user and entering startaiw.

1.2.7.2.1 Configuring a Linux secondary computer to mount a new spool directory

You can extend the /aiw file system by creating and mounting additional partitions on a Linux secondary computer.
To define a new partition and mount it in the spool directory on the Linux secondary computer:
  1. On the Linux secondary computer, log in as the root user.
  2. Configure the Linux secondary computer to use the exported directory by mounting it:
    1. From YaST Network Services, click NFS Client.
    2. You see the Configuration of the NFS Client window. Click Add.
    3. Type the IP address of the primary computer in the Host name of the NFS Server field. Type the directory exported from the primary computer (/aiw/aiw1/spool/newspooldirectory) in the Remote filesystem field.
  3. In the Mountpoint (local) field, type /aiw/aiw1/spool/newspooldirectory.
  4. In the Options field, type rsize=65536,wsize=65536,intr.
  5. Click OK and then click Finish.

1.2.7.3 Tuning Java memory allocation

Allocating more memory to Java often improves the performance of RICOH ProcessDirector. However, it is imperative that you take several factors into consideration before you change this configuration.
Run with the default setting for a while before you consider changing the Java memory allocation. If you repeatedly experience Java out of memory errors, consider increasing the allocation.
Important: We recommend allocating no more than 50% of the available system memory on your system to RICOH ProcessDirector Java processes. This recommendation takes into consideration the memory needs of other parts of RICOH ProcessDirector, such as the database, transforms, custom code, and other components. The recommendation also ensures that the operating system and other tools and utilities have the resources they require to operate.

To tune Java memory allocation:

  1. Check the amount of RAM installed on your system. Divide that number by 2 and write it down.
  2. Check how much memory is allocated to other applications that run on this system.
    Reduce the number you wrote down by the amount of memory each application uses. The resulting value is the total amount of heap memory that is available for you to allocate to Java for all running RICOH ProcessDirector primary and secondary processes.
    Note: If your RICOH ProcessDirector solution requires more memory than the amount determined in this step, we recommend upgrading the system memory to meet the stated guidelines. Allocating more than 50% of available memory to the RICOH ProcessDirector Java heap negatively impacts performance.
  3. Log in to the primary computer as the system user (aiw1 is the default).
  4. Open $AIWDATA/config/jvmsettings.cfg in a text editor.
    By default, $AIWDATA is /aiw/aiw1.
  5. Find the line that looks like this:
    primary=-Xmx2048m -Djava.net.preferIPv4Stack=true -Djava.awt.headless=true

    The value after primary=-Xmx is the maximum amount of heap memory the RICOH ProcessDirector Java run time environment is allowed to use for the RICOH ProcessDirector primary process. In this example, the primary server can use 2048MB (2GB) of RAM for its heap.

  6. Update the -Xmx value to the number you determined in step 2.
    For example, to allow the primary server use 8GB of heap space, you can specify -Xmx8192m or -Xmx8g
  7. Save and close the file.
  8. Restart RICOH ProcessDirector to apply the changes.

1.2.7.4 Scheduling automatic maintenance

RICOH ProcessDirector provides maintenance scripts that must be run regularly on the primary computer to improve performance. By default, RICOH ProcessDirector runs these scripts every day at midnight. You can change the time or frequency, and you can run your own maintenance scripts at the same time.

While these scripts are running, they might slow RICOH ProcessDirector down for a few minutes. Therefore, you should avoid running them at peak production times.

These entries in the crontab file run the maintenance scripts:

00 00 * * 0-6 /aiw/aiw1/maintenance/maintenance.pl daily
00 00 * * 0 /aiw/aiw1/maintenance/maintenance.pl weekly

crontab entries are in this format:

mm hh dd month weekday command
The first entry runs all scripts in the /aiw/aiw1/maintenance/daily directory at 00:00 (midnight) every day from Sunday (0) through Saturday (6). The second entry runs all scripts in the /aiw/aiw1/maintenance/weekly directory at 00:00 (midnight) every Sunday. (By default, there are no scripts in /aiw/aiw1/maintenance/weekly.)

  • To run the maintenance scripts weekly instead of daily, move them to the /aiw/aiw1/maintenance/weekly directory.
  • To change the time, day, or frequency for running maintenance scripts, edit the crontab file.
    1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
    2. Enter this command:
      • crontab -e
    3. Make any necessary changes.
      For example, this entry runs all scripts in the /aiw/aiw1/maintenance/daily directory at 10:30 PM every Monday, Wednesday, and Friday:
      30 22 * * 1,3,5  /aiw/aiw1/maintenance/maintenance.pl daily
  • To run your own scripts at the same time as the RICOH ProcessDirector maintenance scripts, copy them into the /aiw/aiw1/maintenance/daily or /aiw/aiw1/maintenance/weekly directory.
    Make sure that the RICOH ProcessDirector system user ID has execute permission for your scripts.

1.2.7.5 Compressing files

You can save disk space by compressing the files related to jobs.
To configure a workflow that compresses job files:
  1. Click the Workflow tab.
  2. Click the name of the workflow that you want to configure.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. To compress all spool and checkpoint files for the job when the job is retained, see if the workflow has a step based on the RetainCompletedJobs step template. If it does not, add the step:
    1. In the workflow editor, click Step Templates in the top right corner of the window.
    2. Drag the RetainCompletedJobs step template into the workflow editor. Place the step where you want it.
    3. Connect the step to the other steps in the workflow.
    4. Right-click the step and select Properties.
    5. Click Job Defaults - General.
    6. Set the default value for the Compress all files job property to Yes.
    7. Click OK.
  5. To compress specific files at any time, add a step to the workflow based on the CompressFiles step template:
    1. In the workflow editor, click Step Templates in the top right corner of the window.
    2. Drag the CompressFiles step template into the workflow editor. Place the step where you want it.
    3. Connect the step to other steps in the workflow.
    4. Right-click the step and select Properties.
    5. Click Job Defaults - General.
    6. Set the value for the Compress file patterns job property to specify the files that you want to compress.
      • The value of Compress file patterns uses regular expression syntax:
        • Period (.) matches a single occurrence of any character (letter or number).
        • Asterisk (*) matches zero or more occurrences of the preceding character, up to the maximum file name length.
        • Backslash (\) is the escape character that means that the next character is interpreted literally.
        • Dollar sign ($) means that a match signifies the end of the expression.
      • Characters in the value are case-sensitive. For example, .*PDF$,.*AFP$ represent patterns that are different from .*pdf$,.*afp$.
      • Separate multiple patterns by commas; do not type a space between them.
      For example:
      • To compress all PDF files, including files with names like myfile.pdf.old, set the value to .*pdf,.*PDF.
      • To compress all PDF files, excluding files with names like myfile.pdf.old, set the value to .*pdf$,.*PDF$.
      • To compress all PDF files with ABC in the filename, such as draft_ABC.pdf and ABC1.pdf, set the value to .*ABC.*pdf,.*ABC.*PDF.
    7. Click OK.
  6. Save and enable the workflow.

1.2.7.6 Performance and capacity considerations with document processing features

Keep these performance and system capacity considerations in mind as you configure and use document processing features, such as Archive, Postal Enablement, Inserter support, and the Advanced Document Pool extended feature.

1.2.7.6.1 Document properties and document management

Use these document management tips to help you optimize system performance.

Carefully assess your document management needs before you define document properties. Not only must you control the number of properties, but also consider their size. A 1024-character property uses more storage space than a 32-character property.

Limited document properties do not need database table space; however, they occupy space for each document in each document properties file that contains the property.

Using database document properties lets you display document information in the user interface and lets you process documents globally (without knowing which job contains each document), but putting document information in the database has a performance cost. Document properties in the database use space in the database tables. Updates to properties increase logging activity and create possible database contention. The database caches information in memory. With fewer and smaller-sized properties, the database can cache more records in memory and provide better system performance.

Several steps and actions process documents in the database. The database system locks database rows during processing. As more document processing occurs, the impact on system resources increases. You can tune your step templates to limit the number of concurrent steps that process documents in the database.

These steps and actions cause updates to the database:

  • WriteDocumentsToDatabase adds entries for each document to the database and assigns each such entry a document identifier.
  • ReadDocumentsFromDatabase retrieves document information from the database and stores it in a document properties file. No updates are done on the database.
  • CompleteDocuments changes the state of all documents in the job to Complete.
  • CreateJobsFromDocuments and CreateAFPJobsFromDocuments create a new association between documents and the child jobs that are created.
  • RemoveJobs notifies RICOH ProcessDirector when jobs are deleted. When RICOH ProcessDirector deletes a job that has documents in the database, it deletes the documents from the database.
  • UpdateDocumentsInDatabase updates the document properties in the database using the values from the document properties file.
  • The Process Again action requires approval from document processing features. Document processing features do not let RICOH ProcessDirector process an original job again if the documents for that job are also associated with other jobs.
  • Opening the Document properties notebook from the Documents portlet retrieves document property values from the database. Only properties that are stored in the database appear in the property notebook.

This list shows steps and actions in order according to how many database resources they use. The most resource-intensive items are at the top.

  1. RemoveJobs
  2. CompleteDocuments
  3. WriteDocumentsToDatabase
  4. CreateJobsFromDocuments or CreateAFPJobsFromDocuments
  5. Displaying the Documents table in the user interface
  6. ReadDocumentsFromDatabase
  7. Process Again
  8. Opening the Documents property notebook from the Documents table

1.2.7.6.2 Memory usage

Keep these memory usage considerations in mind as you configure and use document processing features.
    Note:
  • Your installation might not include all of the step templates discussed in this section.

Some steps might need a lot of memory to process a job.

For example, steps based on the CreateJobsFromDocuments, CreateAFPJobsFromDocuments, BuildPDFFromDocuments, BuildAFPFromDocuments, IdentifyPDFDocuments, and IdentifyDocuments step templates read information into memory to do their processing. The system keeps a record for each document in memory.

Steps based on the GroupDocuments, SortDocuments, and SplitDocuments step templates also read information into memory to do their processing. The system keeps a record for each document in memory. The amount of memory needed by GroupDocuments and SortDocuments varies depending on which properties you use for grouping and sorting. When more data exists for those properties, the system uses more memory.

    Note:
  • If you process jobs using any of these step templates, increase the amount of memory that the Java Virtual Machine (JVM) can use for RICOH ProcessDirector steps to at least 8 GB of memory:
    • BuildAFPFromDocuments
    • BuildPDFFromDocuments
    • BuildPDFFromZip
    • CreateAFPJobsFromDocuments
    • CreateJobsFromDocuments
    • GroupDocuments
    • IdentifyDocuments
    • IdentifyPDFDocuments
    • SortDocuments
    • SplitDocuments
    • ReadDocumentsFromDatabase
    • RemoveDocumentsFromDatabase
    • UpdateDocumentsInDatabase
    • WriteDocumentsToDatabase

By default, steps are tuned to run on the primary computer, which uses up to 2000 MB of memory when it runs. The primary computer uses the memory for system management, user interface and Web service requests, printer management, input device management, and running steps. Jobs with many documents that sort or group using many properties can use a significant amount of memory.

You can optimize step tuning to minimize memory usage:

  1. Define one or more RICOH ProcessDirector secondary servers on the primary server. The secondary servers should not be in the general server pool. The servers should allow only one step to run at a time.
  2. Change the tuning of these step templates to run only on the secondary servers:
    • BuildAFPFromDocuments
    • BuildPDFFromDocuments
    • CreateAFPJobsFromDocuments
    • CreateJobsFromDocuments
    • GroupDocuments
    • IdentifyDocuments
    • IdentifyPDFDocuments
    • SortDocuments
    • SplitDocuments

1.2.7.6.3 Setting the maximum number of open files (optional)

This section is not applicable to Windows. The system setting for the maximum number of open files prevents an uncontrolled process from taking over your system, but you might need a higher limit than the default if you are processing jobs with many files. Changing the open file limit lets your document processing feature use more system resources. This task is optional, but if File Not Found errors frequently appear in the job log during job processing, you should do this task.

To set the open file limit:

  1. Log in to your system as the root user, or use sudo or the su command to become the root user.
  2. On Linux: Open the file /etc/security/limits.conf.
  3. Find the line in the file that sets the open file limit. For example, on a Linux system it might look like this: aiw1 - nofile 4096.
    If the line does not exist, add it in the next step.
  4. Edit the line, or add a new line if needed, to set a higher limit for the RICOH ProcessDirector system user (aiw1 is the default).

    This example sets the limit to 15,000 on Linux: aiw1 - nofile 15000

    Check with your system administrator to determine a reasonable upper limit for the number of open files.

  5. Log out as root and log in to make the change take effect.

1.2.7.6.4 Defining the JVM memory pool allocation

Depending on the size of your production files, processing a workflow can involve several memory-intensive operations. If you do not allocate enough memory to these processes in RICOH ProcessDirector, you might encounter processing errors or slow processing.
You can configure the Java Virtual Machine memory pool allocation by editing the /aiw/aiw1/config/jvmsettings.cfg (UNIX-based operating systems) or C:\aiw\aiw1\config\jvmsettings.cfg (Windows) file. If you change the settings in this configuration file, you need to reset the system using the stopaiw and startaiw commands for the change to take effect.

The primary setting defines the maximum amount of memory allocated to a Java Virtual Machine process. You can change that setting to match your memory usage needs. The default is 2 GB, and you want to allocate at least 6 GB. In the jvmsettings.cfg file you change:

primary=-Xmx2048m

to

primary=-Xmx6144m
    Note:
  • You change the RICOH ProcessDirector Plug-in for Adobe Acrobat JVM memory allocation by clicking Ricoh Preferences from the Adobe Acrobat menu bar.

1.2.8 Security

Security of your RICOH ProcessDirector system includes determining who can access RICOH ProcessDirector and what functions they can do. You use RICOH ProcessDirector user names, groups, and locations to control security.

1.2.8.1 Managing passwords

Users must have a RICOH ProcessDirector user name and password to access the system and to do RICOH ProcessDirector actions.

1.2.8.1.1 Changing your password

Users defined in the RICOH ProcessDirector system can change their own passwords to something that they can remember easily.
Make sure you are aware of any password guidelines that your company follows and create a password that meets them.
    Note:
  • If RICOH ProcessDirector is configured to use LDAP authentication, you cannot use this procedure to change your password. Follow the established procedure for your company to change your password.
To change your password:
  1. Click the user icon in the top right corner and select Change Password.
  2. Type your new password in the New password and Confirm the new password fields. Passwords are case-sensitive and cannot include these characters: " ' ; < = > \ | ~ ` (Grave accent) or ASCII control characters: x00-x19 and x7F.
      Note:
    • Your administrator determines the minimum password length and if you must follow any password complexity rules.
  3. Click OK.
The next time you log in, use your new password.

1.2.8.1.2 Resetting the password for a user

You can reset a password for a user if they forget their password or feel that it has been compromised.
    Note:
  • If RICOH ProcessDirector is configured to use LDAP authentication, you cannot use this procedure to reset a password. Follow the established procedure for your company to request a password reset.
To reset the password for a user:
  1. Click the Administration tab.
  2. In the left pane, click Security Users.
  3. In the list of users, right-click the user and select Reset Password.
  4. Type a temporary password for the user in both fields and click OK. Passwords are case-sensitive and cannot include these characters: " ' ; < = > \ | ~ ` (Grave accent) or ASCII control characters: x00-x19 and x7F
      Note:
    • Your administrator determines the minimum password length and if you must follow any password complexity rules.
  5. Tell the user the temporary password.
    When the user logs in using that password, RICOH ProcessDirector prompts the user to change it.

1.2.8.1.3 Setting a password expiration counter

You can set a limit on how long all passwords in the system can be used before they must be changed. The limit applies to all users.
Make sure you are aware of any password guidelines that your company follows and create a password that meets them.
    Note:
  • If the Security feature is installed and Authentication with LDAP is enabled, this option is not available.
To set a password expiration counter:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the Maximum password age before expiration field, type the number of days a password can be used before it expires.
  4. Click OK.

1.2.8.1.4 Changing the password for the DB2 instance user

If you use a DB2 server on a separate computer, whenever you change the password for the RICOH ProcessDirector DB2 instance user you must also update RICOH ProcessDirector to use the new password.
  1. To change the password in RICOH ProcessDirector, enter this command:
    /opt/IBM/aiw/V1.0/bin/updateInstPassword.sh
    Note: There is another copy of updateInstPassword in the linux/db directory on the RICOH ProcessDirector product CD.

1.2.8.2 Giving a user system user authority

If you want to let other users access RICOH ProcessDirector file systems and run the RICOH Visual Workbench user interface, you can give a user name virtually the same authority as the RICOH ProcessDirector system user (aiw1 is the default).
To give system user authority to a user name, either when you create the user name or later:
  1. Assign the user to the RICOH ProcessDirector group (aiwgrp1 is the default).
    This gives the user the same access permissions as the system user.
  2. To set the user's environment variables, including PATH, to the same values as the system user's environment variables, edit the user's .profile file and add these lines:
    if [[ -f /opt/infoprint/ippd/base/config/ippdprofile ]] ; then
       .  /opt/infoprint/ippd/base/config/ippdprofile
    fi
The user can now access the same file systems as the RICOH ProcessDirector system user and can use tools such as the RICOH Visual Workbench user interface. However, this user cannot run the startaiw or stopaiw commands. Only the RICOH ProcessDirector system user can use those commands.

1.2.8.3 Secure Sockets Layer and Transport Layer Security support

RICOH ProcessDirector provides support for the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocols, so you can protect the print data in the system.

SSL and TLS are widely used to protect data on the Internet. The SSL and TLS protocols use digital certificates to establish a secure connection between a Web server and any client systems that interact with it. After the connection is established, data transferred between the systems is encrypted using security keys. Only the intended recipient of the information can decrypt the data.

You can also use SSL or TLS to protect data on a smaller scale, such as within a print system like RICOH ProcessDirector. You can activate SSL or TLS to provide a greater level of security for the print data that is exchanged between the primary server and user interfaces, as well as the data that is exchanged with other applications using the Web services that RICOH ProcessDirector supports.

To use SSL or TLS on a computer, you must obtain a digital certificate and install it on that computer. It is recommended that you get your certificate from a certificate authority (CA), because CAs are considered trusted third parties. You can use a self-signed certificate for testing, but using that certificate on production systems is not recommended.

When the certificate is issued, the CA sends it to you in an e-mail. You store the certificate in a keystore on the computer that the certificate is registered to.

    Note:
  • RICOH ProcessDirector only supports Java Key Stores (JKS) files. To create a keystore, see the Java documentation about enabling SSL or TLS.

After the Web server is configured to use it, SSL or TLS is automatically used for communications. The URL for the RICOH ProcessDirector user interface changes to use the https:// prefix. You can still access the user interface using the http:// address, but you can configure the Web server to forward all requests to the secure address.

1.2.8.4 Managing access to objects using locations

Many objects, such as jobs, printers, input devices, inserter controllers, and barcode readers have a Location property. The user property notebook has two properties to manage access to locations. The Allowed locations property affects which objects the user can see in the user interface. The Locations to show property lets users select which of their allowed locations to display in the user interface. On the Preferences dialog, each user can change the Locations to show property to add or remove locations from their current view.

As an example, a company has two print sites, North and South, and a secure print area that only a few operators can access. The administrator defines three location objects: North, South, and Secure. Some operators at the South site are set up with allowed locations of both Secure and South and others only have access to the South location. One operator at the North site also has access to the South site and the others only have North as their allowed location. Supervisors at both sites are allowed to see objects associated with all locations.

Objects can also appear in the system without a value for their Location property. For example, some workflows do not set the Requested location property for jobs. To let users see objects that do not have a value set for their Location property, open the user property notebook and select Include objects with no locations. To prevent users from seeing those objects, clear the setting.

Similarly, when selecting which Locations to show, select the Show objects with no locations check box to include objects that do not have a value set for their Location property. Use this check box to find jobs that entered the system without a Location value assigned.

    Note:
  • Changes made to the Allowed locations property of a user take effect the next time the user logs in.
  • Documents are not associated with a specific location. Restricting users to specific locations does not prevent them from displaying documents included in jobs that are associated with other locations.
  • Users with multiple values for the Allowed locations property can view the objects that are assigned to one of the locations by changing the Locations to show property value on the Preferences dialog. When the Locations to show property has fewer values than the Allowed locations property, an indicator () appears in the top right of the banner area of the page. When you hover over the location pin, the shown and hidden locations are listed.

1.2.8.5 Restricting use of the LPD protocol to submit jobs

You can limit the hosts that can use the LPD protocol to submit jobs to all the input devices with the same parent server. The default is to allow input from all systems.
To restrict the use of the LPD protocol:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the Hosts allowed to submit LPD jobs field, type a list of authorized host names or IP addresses separated with semicolons.

    You can use an asterisk (*) to represent zero or more characters. Values that contain only digits (0–9), decimal points (.), and asterisks (*) are compared to the IP address of the incoming connection. Values that contain one or more alphabetic characters (A–Z, a-z) are compared to the host name of the incoming connection.

    A list value of * means that all hosts are allowed to submit jobs. An empty list value means that no hosts are allowed to submit jobs.

  4. Click SAVE.

1.2.9 Troubleshooting and support

If you encounter problems while you are working with RICOH ProcessDirector or need more support, use these topics to help solve them.

1.2.9.1 Troubleshooting

If you encounter problems while you are working with RICOH ProcessDirector, you might be able to use these topics to help solve them.

1.2.9.1.1 Problems

These topics describe specific problems that you might encounter and how to correct them.

1.2.9.1.1.1 Starting or restarting

These topics describe what to do if RICOH ProcessDirector or a related application does not start or automatically restart.

1.2.9.1.1.1.1 Resetting the system

If you enter the startaiw command on the primary computer and RICOH ProcessDirector does not start running as usual, you might need to reset the system. Resetting the system makes sure that all components are in a known state and lets them start up correctly.
Print this topic so you can have it for reference as you work through the task.

To reset the system:

  1. If you have any secondary servers in your system that are not installed on the same computer as the base product, stop all of them.
      Note:
    • You do not have to stop any secondary servers that are running on the same computer as the base product; RICOH ProcessDirector stops them automatically when the base product stops.
    1. Log in to each secondary computer as the RICOH ProcessDirector system user (aiw1 is the default).
    2. Open a command line.
    3. Enter stopaiw.
  2. If you have any application servers in your system, stop them.
  3. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  4. Open the command line.
  5. Type stopaiw and press Enter.
    The system tries to shut down all the components. If any error messages are displayed, make note of them and try the stopaiw command again. If error messages still occur, reboot the primary computer.
  6. Type startaiw and press Enter.
    The system should start up as usual.
  7. If the system does not start up correctly, enter the stopaiw command again and check for these common problems:
    1. Verify that your primary computer, secondary computers, and any mounted file systems are still attached to the network and can be accessed from other systems.
    2. Verify that there is space available on all the file systems that RICOH ProcessDirector uses on the primary computer, using the command df -h.
  8. If all the systems have network connectivity and the file systems on the primary computer have space available, enter the startaiw command again.
  9. Start the application servers that you stopped.
  10. Start the secondary servers that you stopped.

If you continue to encounter problems, contact Software Support.

1.2.9.1.1.1.2 Web server not restarting automatically

The Web server restarts automatically if a problem causes it to fail. The settings in the WebserverChecker.cfg file determine how many times the server restarts. If the Web server restart is not working as expected, check the settings in the WebserverChecker.cfg file.

Authorized users should:

  1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
  2. Navigate to /aiw/aiw1/config/.
  3. Open the WebserverChecker.cfg file, view the settings, and make any needed changes.
  4. If you want to stop the automatic restart script without shutting down the server, you can access the command line and enter the stopchecker command.

If you continue to encounter problems, contact Software Support.

1.2.9.1.1.1.3 Startup fails to connect to DB2 database with message SQL30082N

If the RICOH ProcessDirector cannot connect to the DB2 database when you run the startaiw command, it might have the wrong password. This can happen if you change the password for the DB2 instance user and forget to update RICOH ProcessDirector to use the new password.
If this is the problem, you see these messages:

SQL30082N Security processing failed with reason "24" ("USERNAME AND/OR PASSWORD INVALID"). SQLSTATE=08001

WARNING: Failed to connect to database due to an invalid password. Run updateInstPassword.sh to update the password ProcessDirector uses to connect to its database.

  1. To change the password in RICOH ProcessDirector, enter this command:
    /opt/IBM/aiw/V1.0/bin/updateInstPassword.sh
    Note: There is another copy of updateInstPassword in the linux/db directory on the RICOH ProcessDirector product CD.

1.2.9.1.1.2 Logging in or logging out

These topics describe what to do if you cannot log in to RICOH ProcessDirector or if you are logged out unexpectedly.

1.2.9.1.1.2.1 Cannot log in to RICOH ProcessDirector

If you cannot log in to RICOH ProcessDirector, the primary server or the Web server might not be running. If RICOH ProcessDirector uses LDAP to authenticate your credentials when you log in, your credentials might need to be changed or the LDAP server might be down.

If you use the same user ID and password to log in to RICOH ProcessDirector that you use for other applications, and you update that password in one place, you are probably using LDAP authentication.

Try these steps to resolve the issue:

  1. If RICOH ProcessDirector uses LDAP to authenticate your credentials when you log in:
    1. Ask your RICOH ProcessDirector administrator to verify that you are a member of an LDAP group that has authority to log in to RICOH ProcessDirector.
    2. Make sure the LDAP server is working correctly. If it is down, RICOH ProcessDirector cannot authenticate any users.
    3. Make sure your user ID is not locked out of your network’s LDAP system. If there is a problem with your credentials in LDAP, ask your LDAP administrator to correct your credentials in LDAP and then try logging into RICOH ProcessDirector again.
    The following steps are for the RICOH ProcessDirector administrator.
  2. If you determine that the problem is not related to LDAP authentication, an administrator can stop and restart RICOH ProcessDirector.
    1. Log in to the primary computer as the RICOH ProcessDirector system user ( aiw1 is the default).
    2. Open the command line.
    3. Type stopaiw and press Enter.
      The system tries to shut down all the components. If any error messages are displayed, make note of them and try the stopaiw command again. If error messages still occur, reboot the primary computer.
    4. Type startaiw and press Enter.
      The system should start up as usual.
  3. If the system does not start up correctly, enter the stopaiw command again and check for these common problems:
    1. Verify that your primary computer, application/secondary computers, and any mounted file systems are still attached to the network and can be accessed from other systems.
    2. Verify that there is space available on all the file systems that RICOH ProcessDirector uses on the primary computer, using the command df -h.
  4. If all the systems have network connectivity and the file systems on the primary computer have space available, enter the startaiw command again.

If you continue to encounter problems, contact Software Support.

1.2.9.1.1.2.2 New user logs previous user off

If more than one user logs in to RICOH ProcessDirector from the same workstation, the browser window where the first user logged in might change to show that the new user is logged in instead. If this happens, the browser windows share a session. Only one user can work in each browser session.
To prevent this problem:
  • Never log in as different users in different tabs of the same window.
  • In Mozilla Firefox, all browser windows that use the same profile share a session. You must create a profile for each additional session and configure Firefox so that it can use more than one profile at a time. Then start a new browser window for each user from the desktop or the Start menu.

1.2.9.1.1.3 Using the user interface

These topics describe what to do when you encounter problems with the RICOH ProcessDirector user interface.

1.2.9.1.1.3.1 User interface freezes

If you open the RICOH ProcessDirector user interface in more than one browser tab or window, the user interface can freeze when you try to do an action. If this happens, close all tabs or additional windows and open one browser window without tabs at a time.

1.2.9.1.1.3.2 Unexpected results with portlets on the Main page

The automatic refresh function causes the portlets on the Main page to fade while they are refreshing. If a portlet remains dim or an error is displayed, click Refresh on the browser window to activate the portlet.

For example, if you use Go to next page/Go to previous page or Go to last page/Go to first page on the Jobs portlet from the Main page of the RICOH ProcessDirector user interface and you receive an unexpected error, click Refresh.

Note: Always use the tabs to navigate in the user interface because using the browser's forward and back buttons can cause unexpected results.

1.2.9.1.1.3.3 User interface does not show printers or input devices

If the Printers portlet or the Input Devices portlet on the Main page does not show objects that you expect to see, it might be set to show only devices that have been marked as favorites or to show only devices in certain locations.

Click the star (Star icon in the header row of the table.) icon in the header row of the table to show the complete list.

To see if your user interface is limited to only a few locations, click the Location pin () at the right of the banner. Locations not shown in the user interface are displayed.

1.2.9.1.1.4 Creating and configuring objects

These topics describe problems with creating and configuring RICOH ProcessDirector objects.

1.2.9.1.1.4.1 Cannot create Hot folder input device

If creating a new Hot folder input device fails with message AIWP3051W, check the ownership of the hot folder directory.

For example, you might see these messages:

  • AIWP3038W: Input device device_name: failed validation.
  • AIWP3051W: Input device device_name Folder location property value of directory_path does not have read and write access to directory directory_path.
  • AIWP3051W: Input device device_name Staging location property value of directory_path/Staged does not have read and write access to directory directory_path.

For Hot folder input devices, the RICOH ProcessDirector system user (aiw1 is the default) in the RICOH ProcessDirector group (aiwgrp1 is the default) must own the directories that you specify as the Folder location and Staging location. It is not enough to give read and write permission to the RICOH ProcessDirector system user.

Note: If you specify directories that do not already exist when you create a Hot folder input device, RICOH ProcessDirector creates them automatically with the correct ownership.

1.2.9.1.1.4.2 Cannot connect LPD input devices

If you cannot connect an LPD input device on a Windows system, another LPD service might be using the LPD port.

If you see this message: AIWI6030E: Error return code: 1 from command: VerifyLPD.pl System "system_name", stop the other LPD service:

  1. In the Windows Control Panel, double-click Administrative Tools Services.
  2. Select the LPD service:
    • The LPD service supplied with the base operating system of some Windows releases is called TCP/IP Print Server.
    • The LPD service available as an optional feature of other Windows releases is called LPD Service.
    • Other print programs might install their own LPD service.
  3. Click Stop.

1.2.9.1.1.4.3 Export file is not created

If you export objects but an export file is not created even though the log shows that the objects were exported, disable all pop-up blockers in your browser.

The export file opens in a pop-up window. You must click Save in that window to save the file. If a pop-up blocker is running, you cannot save the export file.

1.2.9.1.1.4.4 Objects missing from export

If you export a workflow and use the Include references function, some referenced objects may not be included in the export. This problem only occurs if you did not enable the workflow after you changed it.
    Note:
  • Saving the workflow does not validate the workflow but enabling the workflow does.

To ensure that all the referenced objects are included in the export, make sure that the workflow has been validated before you export it.

1.2.9.1.1.4.5 Objects are not imported

If you can export objects from one RICOH ProcessDirector system, but cannot import them to another, the first system might have an extension that is not installed on the second computer.

Because the import system does not have the extension, it cannot recognize objects that were created in that extension on another system.

1.2.9.1.1.4.6 Media objects exported to another system no longer have electronic forms

The process for exporting media objects with electronic forms is different from the process for exporting other objects, such as input devices and printers.
RICOH ProcessDirector creates a media.zip file whenever you define, edit, rename, or delete a media object. You must copy the media.zip file from one system to another instead of exporting media objects. If you export media objects, RICOH ProcessDirector does not export any electronic forms defined for the objects.

To solve the problem:

  1. Follow the instructions for exporting media with electronic forms.
    For more information, see the related task for exporting media with electronic forms.
  2. Make sure that you have a constantforms directory on the primary server that you copied the electronic forms to:
    • /aiw/aiw1/constantforms on Linux
    • C:\aiw\aiw1\constantforms on Windows
  3. Make sure that the RICOH ProcessDirector system user and group ( aiw1 and aiwgrp1 are the defaults) have permission to read and modify these files and directories:
    • The constantforms directory
    • All electronic forms in the constantforms directory
  4. On the primary server that you copied the electronic forms to, make sure that you selected the media.xml file with the Import Objects function.
    For more information, see the related task for exporting media with electronic forms.

1.2.9.1.1.5 Submitting jobs

These topics describe problems with submitting and scheduling jobs to print.

1.2.9.1.1.5.1 Job not appearing in Jobs table

If a job does not appear in the Jobs table, make sure that the input device is connected and enabled. Then check various settings, depending on how the job was submitted.

1.2.9.1.1.5.1.1 Job sent using Download for z/OS or AFP Download Plus

If you sent a job to RICOH ProcessDirector using Download for z/OS or AFP Download Plus and it does not appear in the Jobs table, check these settings.
  • Make sure that the port number defined in the routing-control data set matches the port number defined in RICOH ProcessDirector.
  • On Linux, make sure that the MVSPRSD daemon is running.
    From a Linux command line, enter:
    ps -ef | grep mvsprsd
    If only the grep command is returned, the daemon is not running. Disconnect and reconnect the Download input device that you want to use.
  • On Windows, make sure that the MVSPRSD daemon is running:
    1. Open Task Manager.
    2. Click the Processes tab and sort the list by Image Name.
    3. Find the mvrsprsd.exe processes and see how many are running. There should be one for each Download input device that is connected. If there are fewer, disconnect and reconnect the Download input device that you want to use.
  • Verify that the resources required for the job are in the default resource directory or in a directory specified in the AFP resource path property.
    On Windows, if the Merge dataset property on the input device is set to Yes, check if the resource is located in the resource library. The resource library is specified in the destination control file, in the GLOBAL section for the resource context.

      Note:
    • If the required external resource is not in the default resource library, move the resource there.

  • If the files are missing an inline form definition (FORMDEF) or other resource when they enter the input device, the submitted data files remain in the input device. You can find the files in the w directory of the input device, for example: C:\aiw\aiw1\System\dl\InputDevice\w (Windows) or /aiw/aiw1/System/dl/InputDevice/w (Linux).
      Note:
    • Make sure that you remove these files and resubmit the job after the missing resource is placed in the resource library.
  • If these steps do not resolve the issue, contact your Ricoh support representative. They might ask for traces for the download input device. To enable traces on a download input device:
    1. In the C:\aiw\aiw1\bin\ (Windows) or /aiw/aiw1/bin/ (Linux) directory, open the startMvsprsd.pl script file.
    2. Uncomment this line by removing the # symbol at the beginning of the line.
      • #$extra_parm_string = $extra_parm_string eq '' ? "-t" : (join ' ', $extra_parm_string, "-t");
    3. Save the startMvsprsd.pl script file.
    4. Disconnect and reconnect the download input device.
      Tracing for the download input device is now enabled.
    5. Send a job to RICOH ProcessDirector using Download for z/OS or AFP Download Plus again to create the log files. The log files are saved in the C:\aiw\aiw1\System\dl\InputDevice\w (Windows) or /aiw/aiw1/System/dl/InputDevice/w (Linux) directory.
    6. Find the log files and contact your Ricoh support representative.

1.2.9.1.1.5.1.2 Job copied to a hot folder

If you copied a file to a hot folder and it does not appear as a job in the Jobs table, check these settings.
  • Make sure that you have waited through a polling interval cycle by checking input device settings.
    The polling interval for factory-supplied hot folders is 30 seconds. If the Completion method property is set to Size, the job is submitted after the file size stops changing. RICOH ProcessDirector checks the file size, then waits for the length of the polling interval and checks the size of the file again. When the file size stays the same from one check to the next, the input device submits the job.
  • Make sure that the folder location where you copied the file is the same one that the administrator defined in the input device.
  • Make sure that the Data patterns property for the hot folder matches the pattern of your file name.

1.2.9.1.1.5.1.3 Job sent using the LPD protocol

If you sent a job to RICOH ProcessDirector using a command that uses the LPD protocol and it does not appear in the Jobs table, check these settings.
  • If the command you used to submit the job does not include an option to pass a server name, make sure that there is a print queue defined on the sending system to send jobs to the LPD input device.
  • Make sure the print server that the job was sent to is the parent server of the LPD input device.
  • Make sure that the network settings on the sending system allow data to be sent over port 515.
  • Set the LPD host entries to IP addresses or fully qualified domain names instead of host names in the System settings. Validation for host names can cause delays that result in the LPR client timing out. To change the host entries:
    1. Click the Administration tab.
    2. Click Settings System.
    3. In the Hosts allowed to submit LPD jobs field, change the LPD host entries to IP addresses or to fully qualified host names (such as hostserver.co.acmeproducts.com instead of *.acmeproducts.com).

1.2.9.1.1.5.1.3.1 Job sent to an LPD input device with a Linux parent server

If the parent server of the LPD input device that you sent the job to is a Linux system, check these settings.
  • Make sure that the sending system is defined in the Hosts allowed to submit LPD jobs system property.
    The default is to allow input from all systems.
  • Make sure that the LPD daemon is running.
    From a Linux command line, enter:
    ps -ef | grep ippd_lpd
    If only the grep command is returned, the daemon is not running. Disconnect all LPD input devices defined on that server and then reconnect them.
  • If any LPD daemons that do not belong to RICOH ProcessDirector (for example, the Common UNIX Printing System [CUPS] LPD daemon) are running on the parent server, stop them.

1.2.9.1.1.5.2 Job moves to error state with message AIWI0017I, return code 310

If a job goes into an error state and you see message AIWI0017I with return code 310, there might be a problem with submitting files to RICOH ProcessDirector.

Message AIWI0017I contains a copy of a message that was issued by a component of RICOH ProcessDirector. In this case, the message text is:

AIWI0017I 0425-422 AN ERROR OCCURRED WHILE ATTEMPTING TO READ "spool_file_name"
RETURN CODE 310

Message 0425-422 with return code 310 means that the file format is not valid. This can happen when a Hot folder input device creates a job from a file that has not been completely transmitted.

For example, if the Completion method of the Hot folder input device is Size, the Hot folder input device checks its contents at regular intervals, records the size of each file in it, and compares it to the size of that file at the previous checkpoint. If the size of the file has not changed, the Hot folder input device assumes that it has been fully received and creates a job. However, if the transmission pauses in the middle of a file due to network traffic and the file size does not increase before the next checkpoint, the Hot folder input device submits a partial file.

To verify that the file is incomplete, enter this command on the server where the Hot folder input device resides:

afpdmp spool_file_name | tail

If you see these messages, the file has probably been truncated:

Input file is too short
Input is not valid AFPDS

Delete the job and send it again.

To prevent this problem, try one or more of these methods:

  • Increase the Polling interval of the Hot folder input device.
  • Change the Completion method of the Hot folder input device.
  • Adjust the network to prevent pauses in data transmission.

1.2.9.1.1.5.3 Job name is blank in Jobs table

If a job name is blank in the Jobs table, either the Job name property for the workflow is not set or a job property control file that defines the job name was not submitted with the job.
RICOH ProcessDirector does not require a job name to print the job; the Job number property contains the unique system identifier, or spool ID, that RICOH ProcessDirector uses to identify the job. However, you might want a job name to appear in the Jobs table. These are the ways the job name is specified for a job:
  • A job properties control file that is submitted with the job defines the job name.
  • The user who submitted a job specifies the job name, or the host system that submitted the job assigns the job name. RICOH ProcessDirector initially supplies the job name when it creates the job from the input file. Authorized users can specify a different name.

To display the job name for a job in the Jobs table, you must do either of these:

  • Submit a job properties control file that defines the job name with the job.
    To define a job name and submit the control file:
    1. In the control file, make sure that the DEFINE ${Job.Name} line is set. For example, this line sets the job name to the name that the TITLETEXT job parameter specifies:
      DEFINE ${Job.Name} AS "${TITLETEXT}"
      RICOH ProcessDirector provides sample control files, receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, and receive_lpd_pdf_jobtype.cfg, that are installed in the /aiw/aiw1/samples/rules/ directory. You can copy those files to the /aiw/aiw1/control_files/rules/ directory and modify them to meet your needs.
    2. Make sure the Child workflow initialization step property for the input device is set to SetJobTypeFromRules or SetJobTypeFromFileName and use the Child workflow parsing rules property to specify the name of the control file that defines the job name. Make sure the directory path is correct so RICOH ProcessDirector can find the file.
  • Set the job name in the Job name property of the SetJobPropsFromTextFile step, which is the first step in a workflow.
    When you use the ${Job.InputFile} symbol as the value in the Job name property, RICOH ProcessDirector sets the job name to the name of the input file from which the job was created.
    Note: Do not use the ${Job.InputFile} symbol when you are submitting a job to a Download or LPD input device with a control file that defines the job name because the symbol overrides the job name defined in the control file. For example, if the workflow specifies ${Job.InputFile} as the value of the Job name property, and a control file, such as receive_jcl_jobtype.cfg, specifies DEFINE ${Job.Name} AS "${DEPARTMENT}", RICOH ProcessDirector sets the value of the Job name property to the name of the input file for the job, not to the value that the DEPARTMENT job parameter specifies.

1.2.9.1.1.5.4 Errors in Receive phase

If print files are submitted using FTP or SCP and are placed in the Error state as soon as they arrive in the Receive phase, they might have been submitted incorrectly.
Jobs that are submitted using FTP or SCP must be submitted using a user ID on the primary computer that is a member of the RICOH ProcessDirector group (aiwgrp1 is the default). If they are submitted using an ID that is not a member of that group, RICOH ProcessDirector does not have the appropriate permissions for the files and cannot work with them. As a result, the job goes into the Error state and cannot be printed. The only solution is to delete the file from the input device and resubmit it using an appropriate user ID.

To fix errors in the Receive phase:

  1. In the Input Devices portlet, right-click the input device that the input file was submitted to and select Show Files.
  2. In the list of input files, right-click the input file that is in error state and select Delete.
    You see a confirmation message.
  3. Click OK.
  4. Click CLOSE.
  5. Resubmit the job using FTP or SCP, this time using the RICOH ProcessDirector system user ID (aiw1 is the default) or another user ID that is a member of the RICOH ProcessDirector group.

1.2.9.1.1.5.5 Batched files stay in Waiting state in Receive phase

You can submit a group of files with the Batching method on the input device set to List, which tells RICOH ProcessDirector to use a list file that accompanies the input files to identify all the files in the group. The input device waits for all the files in the list to arrive, then creates a job and submits it. If all the files in the group have arrived in the input device, but they all stay in the Waiting state, you might need to re-create the list file.

This problem typically occurs if you create your list file on a Windows system. When you create a text file on a Windows system and save it in UTF-8 format, the text editor adds a byte order mark (BOM) to the beginning of the text file. While you cannot see the BOM in the file if you open it on a Windows system, RICOH ProcessDirector sees it when it tries to read the file. As a result, RICOH ProcessDirector reads the BOM as part of the file name of the first file in the list. Because it cannot find a file with that name in the folder location for the input device, it keeps all the input files in the Waiting state.

To solve the problem:

  1. Open the list file on a Linux or other UNIX system.
  2. Delete the first three characters in the file (you might see them represented by squares: ☐☐☐)
  3. Save the file.
  4. Resubmit the job using the new list file.

1.2.9.1.1.5.6 Large ZIP file fails in IdentifyPDFDocumentsFromZip step

If your ZIP files fail to process in the IdentifyPDFDocumentsFromZip step, check the compression method used to create the ZIP file.

The IdentifyPDFDocumentsFromZip step can only process ZIP files that are created using the Store and Deflate compression methods. If your ZIP files fail to process, check the compression method used to create them. If they use an unsupported compression method, update the application that creates the ZIP file to use a supported method.

1.2.9.1.1.5.7 Job moves to No matching connector state in a conditional workflow

When a job in a workflow with conditional processing stops at a step and the value of the State column is No matching connector, the conditional processing might not be set up correctly. RICOH ProcessDirector does not validate the conditional processing when it saves a workflow.
To fix a conditional workflow with a job that stops in a No matching connector state:
  1. Inspect each rule to make sure it does not have conditions that conflict with each other.
    For example, a rule has two conditions:
    • Customer name = A
    • Customer name = B
    The rule specifies that All of the conditions apply. No jobs are sent through the connector to the next step because no job has two customers. All jobs stay in the step in a No matching connector state. If the rule specified that any condition applies, jobs for customers A and B would be sent through the connector.
  2. Inspect all the connectors from a step to other steps. Make sure that the rules assigned to the connectors process all jobs that the step receives.
    For example, a step has two connectors:
    • Connector1 has a rule with one condition: Total pages < 20
    • Connector2 has a rule with one condition: Total pages > 20
    The rules do not tell RICOH ProcessDirector how to process jobs with 20 pages. Those jobs stay in the step in a No matching connector state. If the first rule specified Total pages <= 20, jobs with 20 pages would be sent through Connector1.
  3. Make sure to account for jobs that do not have a property value when your conditional processing specifies values for the property.
    For example, a step has two connectors. Each connector has a rule with a condition that specifies a Job priority property value:
    • The condition for the first rule is Job priority > 1.
    • The condition for the second rule is Job priority = 1.
    When jobs that do not have a Job priority property value reach the step with these connectors, they stay in the step in a No matching connector state. To process those jobs, add this condition to a new rule or to one of the existing rules: Job priority unlike %.
  4. Inspect all conditional processing paths to make sure that the rules between different steps in the path do not conflict.
    For example, a conditional workflow branch has a connector in the Receive phase. The connector has a rule with one condition: Input data stream = PDF. Later in the same branch, a step in the Prepare phase has two connectors.
    • Connector1 has a rule with one condition: Input data stream = Postscript
    • Connector2 has a rule with one condition: Input data stream = Unknown
    All jobs that arrive at the step are PDF. They were sent through the connector whose rule specifies that the input data stream is PDF. Because neither connector processes PDF jobs, the jobs stay in the step in a No matching connector state. To fix this example, review how the workflow processes input data streams.
  5. To fix problems, disable the workflow and edit it.
    If jobs are in the workflow, make a copy of the workflow and edit the copy.
  6. Enable the workflow and test it.
    A conditional workflow might have multiple problems.
      Note:
    • If you have a complex workflow, we recommend that you connect each step with branches to multiple steps to its own FailWithMessage step. Give each connector a rule with no condition. For each FailWithMessage step, set the Failure message property to a value that identifies the conditional processing. If a job arrives at a FailWithMessage step, RICOH ProcessDirector writes the message to the job log. The message identifies the conditional processing problem.
  7. Use the Process Again action to switch jobs in No matching connector state to the new workflow.

1.2.9.1.1.5.8 Job processes incorrectly in a conditional workflow

When jobs in a workflow with conditional processing do not process properly, the connectors that specify the conditions might not be set up correctly or job values might not be assigned correctly. RICOH ProcessDirector does not validate the conditional processing when it saves a workflow.
To fix a conditional workflow with jobs that process incorrectly:
  1. Inspect all the connectors from a step to other steps. If a step has a connector that processes all jobs that are not sent through the other connectors, that connector must have the highest value for its Order of execution property of all of the connectors exiting the step.
      Note:
    • If you enter a value for the Rule name property of a connector, the Order of execution value is displayed on the label of the connector before the value of the Rule name.
    For example, a step has two connectors:
    • A connector named else has a rule with no conditions.
    • A connector named < 20 has a rule with one condition: Total pages < 20.
    RICOH ProcessDirector tries to send jobs through a step’s connectors according to the values specified in the Order of execution property of each connector. If the else connector has its Order of execution value set to 1, RICOH ProcessDirector sends all jobs through the else connector. No jobs would use the < 20 connector. However, if the < 20 connector has its Order of execution value set to 1, RICOH ProcessDirector tries to send all jobs through the < 20 connector first. The rule set for the < 20 connector prevents jobs with 20 pages or more from going through the connector. RICOH ProcessDirector then sends all remaining jobs through the else connector. If all jobs in your workflow are sent through an else connector, make sure the Order of execution value of that connector has the highest value of all the connectors exiting the step.
      Important:
    • If you create a conditional workflow by modifying an existing workflow, such as a RICOH ProcessDirector sample workflow, the Order of execution of the connectors on the workflow are carried over from the original workflow. If you make an existing connector part of a conditional process and add another conditional connector, RICOH ProcessDirector first tries to send all jobs through the existing connector. If a job does not meet the conditions in the rule set on the connector, RICOH ProcessDirector tries to send the job through the newly added connector. When you add conditional processing to a step, we recommend that you examine the values for the Order of execution property on each connector exiting the step to check that the tests reflect the order in which you want them to be evaluated. If you have an else connector, make sure it has the highest Order of execution value of all the connectors exiting the step.
  2. Inspect how job values are set and passed to the steps and connectors in a branch of a workflow.
    For example, a conditional workflow has two branches, one with steps that request stapling and another with steps that do not request stapling. The connector that sends jobs to the branch with steps that request stapling has a rule with one condition: Staple = Top left. Jobs for customer A should be stapled, but the jobs are sent to the branch with steps that do not request stapling because jobs for customer A do not have a stapling job value. One way to assign job values is with a step based on the AssignJobValues step template. Jobs for customer A might be sent through an AssignJobValues step that sets the value of the Staple property to Top left.
  3. To fix problems, disable the workflow and edit it.
    If jobs are in the workflow, make a copy of the workflow and edit the copy.
  4. Enable the workflow and test it.
    A conditional workflow might have multiple problems.
      Note:
    • To find problems in a complex workflow, consider adding a step based on the ManualStepWithAutoStart step template after each connector with a conditional processing rule. Check jobs at each ManualStepWithAutoStart step to make sure they are moving through the correct branches of the conditional workflow.

1.2.9.1.1.5.9 The Wait step finishes at the incorrect time

If the workflow includes a Wait step and the job finishes earlier than expected or later than expected, then your Wait step might be set up incorrectly.
  • If the job starts processing again after a Wait step at the wrong time, check the following in the workflow:
    • The Wait until property

      Make sure the Wait until property has the correct time set. If your country uses the 12–hour time format, make sure either AM or PM is correctly chosen. This property is only used if you are pausing a job until a certain time of day.

    • The Time zone property

      Make sure that the time zone chosen on the Wait step matches the time zone that the primary server uses. This property is only used if you have specified a value for the Wait until property.

    • The Wait for property

      Make sure the length of time entered in the Wait for property is correct and matches the chosen unit of time. This property is used if you are pausing a job for an interval of time.

    • The Complete step after property

      Make sure the value chosen for Complete step after is correct.

      For example, a workflow contains a Wait step with these settings:

      • Wait until: 12:00 PM
      • Time zone: Eastern Standard Time (EST)
      • Wait for: 3 hours

      A job reaches that step at 10:00 AM EST. The step determines that the two possible end times are:

      • Wait until: 12:00 PM EST
      • Wait for: 3 hours (1:00 PM EST)

      If Complete step after is set to First occurs, the job moves to the next step at 12:00 EST. If Complete step after is set to Last occurs, the job moves to the next step at 1:00 PM EST.

    • The time on the RICOH ProcessDirector server

      Make sure the time and the time zone on the RICOH ProcessDirector server is set correctly. The Wait step acquires its time from the RICOH ProcessDirector server. If the system time or the time zone is incorrect, the Wait step might not complete at the correct time.

        Note:
      • Time is counted when RICOH ProcessDirector server is powered off. For example, a job arrives in the Wait step and is supposed to wait for one hour. The job waits for 30 minutes and the power to the server is interrupted. It takes 45 minutes for power to be restored and for RICOH ProcessDirector to start processing again. At that point, the job starts to process again, because the waiting period has ended.

1.2.9.1.1.6 Transforming jobs

These topics describe problems with transforming jobs.

1.2.9.1.1.6.1 Transform features cannot find resources in some directories

The transform features cannot access resources stored in directories that have international characters, including double-byte characters, in their directory path names.
To transform jobs using the correct resources, move the resources to a directory that does not have international characters in its path, or rename the existing directory to remove all international characters.

1.2.9.1.1.6.2 Job continues processing on Transform server

When you use the Stop function for a job that is processing in a step that calls a Ricoh Transform, the status of the job changes to Stopped, but the transform continues processing the job.

Correct any values in the properties set on the step that is transforming the job before using the Process again action to restart the transform processing.

1.2.9.1.1.6.3 Transformed halftone images are poor quality

When you transform GIF, JPEG, PDF, PS, or TIFF data to AFP for printing on an InfoPrint 4100-TS or InfoPrint 4100-TD printer using PQI toner, it can be difficult to determine the right halftone.

If the results are not as expected, consult the InfoPrint Transform Feature information center to determine the value to set for the Transform halftone property in the TransformJobIntoAFP step template.

If you used a Transform feature to transform the file, view the Transform features log to determine the parameters that were passed to the Transform feature:

  1. In a Web browser, navigate to http://server_name:16080/itm.
  2. Log into the Transform features user interface. The default password is nopassword.
  3. On the Main page next to the Export traces button, select Actions View log. You see the log information for the jobs.
  4. Look in the Message column for job parameters. The value of the -thresh parameter is the halftone that was used to transform the job.

1.2.9.1.1.6.4 Job fails in TransformWithAdvancedFeature step

If AFP jobs are failing when using the TransformWithAdvancedFeature step, the object containers might include images or other data types.

When sending jobs with AFP object containers that hold images or other types of files (such as PDF), you must have an input transform installed for that data type in addition to the InputAFP transform. If you do not have a compatible transform installed, the job is not transformed correctly and the job fails.

Install the appropriate transform before sending the jobs, such as InputImage or InputPDF transform.

1.2.9.1.1.6.5 Viewer reports PDF file structure error after transform

If you use the RICOH AFP to PDF Transform feature to transform a large AFP file to PDF and you receive the FTD0002E message reporting a PDF error when trying to view the job, you might need to set the Max_Objects parameter in the afp2pdf configuration file.

This parameter specifies the maximum objects that can be listed in the PDF cross-reference table (XREF). The Max_Objects parameter is commented out in the afp2pdf configuration file, which limits the number of objects to 500000. Remove the comment character (#) from the Max_Objects entry in the file.

After you change the values in the afp2pdf configuration file, you must use the Resource Distributor in the Transform features user interface to make the changes take effect. The changed configuration file is distributed as a resource type Configuration File for the RICOH AFP to PDF transform.

In addition, you should change the max-proc-time setting in the configuration file to a larger value. The configuration file is located at /opt/infoprint/itm/hn/cfg/tapp.cfg (Linux) or ITM_INSTALL_PATH\itm\hn\cfg\tapp.cfg (Windows) where ITM_INSTALL_PATH is the path chosen in Transform Features GUI at install time (default is: C:\Program Files (x86)\InfoPrint\InfoPrint Transform Features). The default is 240, which represents the number of seconds after which a job is automatically terminated if it produces no output. You can change this value to 2400 (40 minutes), 24000 (400 minutes), or even larger values for exceptionally large input files that take a long time to process. After you change this value, you must restart the Transform features either by pressing Reset Transform Feature in the user interface or by running the script /opt/infoprint/itm/restart.sh (Linux) or restart the ITMServer Windows service (Windows).

1.2.9.1.1.6.6 Transform fails with error 100

If you are using a RICOH Transform Feature with a step based on the TransformJobIntoAFP step template and the step fails with error, the problem could be related to a downlevel library in your operating system.

To solve the problem:

  1. Log in to the primary computer and open a command line.
  2. Type: rpm -qa glibc
    In the results, look at the level of the glibc library. If it is lower than 2.27, this library is the cause of the error.
  3. To resolve the error, you can choose one of these options:
    1. Update to glibc version 2.27 or higher.
    2. Reconfigure the transform step to use the CPSI conversion program in the TransformJobIntoAFP step instead of APPE. Open the workflow that uses this step and change the name of the file in the value of the External control file template property to prepare_transform.cfg instead of prepare_transform_APPE.cfg.

1.2.9.1.1.7 Printing jobs

These topics describe problems with printing jobs.

1.2.9.1.1.7.1 Errors when printing Cyrillic or Japanese characters on PDF banner pages

If you try to use Cyrillic or Japanese characters on PDF banner pages with a workflow that uses the default values for the Header page configuration file and Trailer page configuration file properties, the characters do not display correctly.
To print the characters correctly, update these properties for the workflows that you use with the values indicated:
  • For Cyrillic:
    Header page configuration file:
    aiw/aiw1/control_files/banner_pages/header_ru.jrxml
    Trailer page configuration file:
    aiw/aiw1/control_files/banner_pages/trailer_ru.jrxml
  • For Japanese:
    Header page configuration file:
    aiw/aiw1/control_files/banner_pages/header_ja.jrxml
    Trailer page configuration file:
    aiw/aiw1/control_files/banner_pages/trailer_ja.jrxml

1.2.9.1.1.7.2 Jobs do not print on a Ricoh PDF printer

Configuring RICOH ProcessDirector to send jobs to a cutsheet printer using a Ricoh PDF printer device can be challenging. If you set up a Ricoh PDF printer and jobs are not printing, use these instructions to check the most common configuration issues.
Configuration issues can occur on the printer, in the control unit (digital front-end), in the connected network, or in the RICOH ProcessDirector printer definition.

To try to resolve printing issues on a Ricoh PDF printer:

  1. If this trouble is new:
    1. In RICOH ProcessDirector, disable the Ricoh PDF printer device.
    2. Follow the manufacturers' instructions to shut down the control unit, printer engine, and all pre-and post-processing equipment. Make sure you shut down all the elements of the system in the correct order.
    3. Start the control unit, printer engine, and all pre-and post-processing equipment again. Follow the manufacturers' instructions to start each item in the correct sequence.
    4. After everything in step 3 is restarted and online, enable the Ricoh PDF printer device in RICOH ProcessDirector.
    5. Try to send a print job again.
      If the issue reoccurs, continue with the steps below.
  2. Make sure that your printer model is supported for use as a Ricoh PDF printer with your version of RICOH ProcessDirector.
    1. In RICOH ProcessDirector, find the printer in the Printers portlet.
    2. Select the printer and click More actions Show Printer Web Page.
      • If the printer web page does not open, there is likely a network issue causing the connection to be blocked. Work with your network team to resolve network issues. Potential issues include: firewalls, proxy servers, virus protection software, and other security protection software, among others.
      • Try to open the printer web page after each network change until the page can be opened successfully.
    3. On the printer web page, find the printer model.
    4. Verify that RICOH ProcessDirector supports defining this printer model as a Ricoh PDF printer. In RICOH ProcessDirector, find the Ricoh PDF printer device and open the properties. Find the Type of printer property and look for your printer model. If your model is not in the list, it cannot be defined as a Ricoh PDF printer with your current level of RICOH ProcessDirector. You might be able to update the Ricoh PDF Printer feature to a level that supports the printer model.

      If you have not upgraded the Ricoh PDF Printer feature in over a year, open a support ticket to request the latest version. Install the new version and try to print again. Return to this procedure if the issues are not resolved.

    5. If you have a current version of the Ricoh PDF Printer feature or if you install a new version and your model still does not appear in the list, choose a different type of printer device.
      For example, you can create a Passthrough printer or request a custom printer definition from your Ricoh software sales representative.
  3. Make sure that the Ricoh PDF printer uses the correct values for these properties in RICOH ProcessDirector and in the control unit settings.
    You should be able to find these values on the printer web page:
    • Printer port
    • Printer TCP/IP address or host name
  4. Check that the SNMP settings on the printer and in RICOH ProcessDirector are set the same.
    1. Make sure that they use the same SNMP community name and that SNMP is enabled on both.
    2. RICOH ProcessDirector only supports SNMP v1 or v3. If the printer uses SNMP v2, the SNMP connection does not function. Change the printer to use SNMP v1 or v3.
    3. SNMP receives requests on UDP port 161. Make sure that UDP port 161 is open.
    4. Check that SNMP traffic between the RICOH ProcessDirector server and the printer can pass through any firewalls you have in place. Make sure that they firewall rules do not time out and that SNMP traffic can flow in both directions (from the server to the printer and from the printer to the server) at all times.
  5. Check that the printer is configured correctly to receive jobs from RICOH ProcessDirector.
    Depending on the control unit connected to your printer, you might have to define a hot folder, virtual printer, or print queue for RICOH ProcessDirector on the control unit. See the documentation for your control unit to learn about supported job submission methods and details for setting up the device.

    Work with your Ricoh printer service representative to set up, configure, and check this configuration.

  6. If you are attempting to send PDF/JDF print jobs (PDF files with accompanying JDF job tickets), make sure that the printer is configured to receive JDF.
    JDF is not enabled on all printers by default.
  7. If the printer uses the Ricoh internal controller (not RICOH TotalFlow Print server or the EFI Fiery controller) and you are sending PostScript jobs, make sure that the correct PostScript option for the device is installed and enabled on the printer.
    You must either use the Adobe PostScript 3 card option, or, if available on your printer model, the onboard PostScript emulation software known as IRIPS Postscript 3.
  8. If all the settings are correct, try changing the value of the Data stream to send property on the Ricoh PDF printer object to a different datastream. For example, if PDF/JDF jobs are failing, change Data stream to send to PostScript and submit the job again.
  9. Assess the larger picture to see if there is contention for resources between applications.
    Some printers place higher priority on jobs submitted over different protocols. If other applications are prioritized over RICOH ProcessDirector and those applications send jobs regularly, jobs from RICOH ProcessDirector can be blocked.

    Find out how many applications are sending jobs to this printer. If there is even one additional application using this printer, it could be crowding out your attempts to send jobs using RICOH ProcessDirector.

    Test this possibility by shutting down other applications that use this printer and submitting a job from RICOH ProcessDirector. If the job prints successfully, enable the other applications one-by-one to determine which one is causing trouble.

  10. Restart the entire system to return everything to a known-good state.
    1. Shut down all applications that send jobs to the printer, including RICOH ProcessDirector.
    2. Shut down the control unit, printer engine, and all pre-and post-processing equipment.
        Note:
      • Follow the manufacturer instructions for shutting the equipment down completely and in the correct order.
    3. Start the control unit, printer engine, and all pre-and post-processing equipment in the correct order.
        Note:
      • Follow the manufacturer instructions for starting the equipment in the correct order. Make sure that all components are in a Ready state before you continue.
    4. Start RICOH ProcessDirector and enable the Ricoh PDF printer object.
    5. Submit a job from RICOH ProcessDirector to see whether it processes correctly.
    6. Start the other applications that send jobs to the printer.
  11. If none of those suggestions resolve the configuration issues, prepare to contact Ricoh Software Support. Follow these steps to collect the data that software support needs to start evaluating the issue:
    1. In RICOH ProcessDirector, open Administration Diagnostics System Trace.
    2. Change the value for Capture job data from Ricoh PDF printers to Yes.
        Important:
      • If this setting is not available, contact Software Support and request an update to add it to RICOH ProcessDirector.
      • Turning this setting on captures job data sent to all Ricoh PDF printers until it is turned off again. If jobs submitted include confidential data (such as Personally Identifiable Information (PII) or Electronic Personal Health Information (ePHI)), take appropriate precautions to protect that data.

        Discuss the type and scope of the data with your Ricoh Software Support Representative BEFORE uploading the data for review so Ricoh can also take the needed steps to protect this data.

      • Capturing job data requires large amounts of disk space. Therefore, we recommend turning this capture property on only for debugging and tracing purposes and turn it off as quickly as possible. In this case, after you submit one job and it fails to print on the Ricoh PDF printer, turn this capture property off.
    3. Click Save.
    4. Send a job to the Ricoh PDF printer that you are troubleshooting.
      The job data is stored in a capture file here:
      • On Linux: /aiw/aiw1/pc/ws/webapps/printing/WEB-INF/tmp/printing/
      • On Windows: C:\aiw\aiw1\pc\ws\webapps\printing\WEB-INF\tmp\printing\
    5. Turn off the Capture job data from Ricoh PDF printers property.
    6. Open Administration Diagnostics Data Capture and click Capture.
    7. Gather this data, so you have it ready for Software Support:
      • The PDF file that you are printing.
      • The job log for the job that failed.
      • The capture file you generated with the Capture action.
      • A ZIP file containing these directories:
        • Spool directory for the job
        • If the Parent server for the Ricoh PDF printer is a Windows Application server:
          • C:\aiw\aiw1\pc\ws\webapps\printing\WEB-INF\tmp\printing
          • C:\aiw\aiw1\pc\ws\webapps\printing\WEB-INF\logs
          • C:\aiw\aiw1\pc\version
        • If the Parent server for the Ricoh PDF printer is a Linux server:
          • /aiw/aiw1/pc/ws/webapps/printing/WEB-INF/tmp/printing
          • /aiw/aiw1/pc/ws/webapps/printing/WEB-INF/logs
          • /aiw/aiw1/pc/version
          Note:
        • These directories are default values. If you installed on a different drive or in a different directory structure, adjust the paths as needed.
        Important:
      • Do not send any files if ePHI jobs were printing when you ran the capture action. When you contact Software Support, tell them that you need a Red Zone set up and for information about uploading jobs to the Red Zone.
    8. Call Ricoh Software Support and describe the issue. Let them know what information you have collected, including whether any of the files contain ePHI.

1.2.9.1.1.7.3 Jump to goes to incorrect page

If you click the Jump to control in the RICOH ProcessDirector user interface and the page where the printer resumes is not the page displayed in the viewer, check for functions that can introduce inaccurate page counts. Examples are cut sheet emulation, N_UP printing, and the Duplex and Form definition job properties.
To check for and account for these functions:
  • At the printer console, check if the printer is set to cut sheet emulation.

    Cut sheet emulation is used to print two pages of data side-by-side on a single sheet that is later cut in two.

  • Check if the form definition is set to N_UP printing.

    N_UP printing is a function that is specified in the form definition that is used to print the job. It lets a job print multiple (n) pages per side of a sheet. With duplex printing taken into account, you could print four pages on each side of one sheet, totalling eight pages per sheet. Although RICOH ProcessDirector accounts for N_UP printing, N_UP printing can be turned on and off in a job and errors might occur. In that case, use the Jump to control again until you get the correct page.

  • Check the printer properties to see if Interrupt Message Page is set to Yes.

    The Interrupt Message Page property prints an informational page when the Jump to action is used. This adds an extra sheet to the page count. To avoid this problem, set the Interrupt Message Page property to No or use the Resume printing at page control instead of the Back up or Skip ahead controls.

Note that both of these functions put more than one page on a sheet. Whenever there is more than one page on a sheet, selecting any page from that sheet causes the whole sheet to be reprinted. For example:

  • In a 2-up simplex job, page 47 is on the left side of the sheet and page 48 is on the right. If you select page 48, both page 47 and page 48 are reprinted.
  • In a duplex job, page 51 is on the front of the sheet and page 52 is on the back. If you select page 52, both page 51 and page 52 are reprinted.

If you are not using cut sheet emulation or N_UP printing, contact Software Support.

1.2.9.1.1.7.4 Job copied to a hot folder does not print

If you copied a job to a hot folder and it does not print, the physical printer might not be able to receive jobs. Check to see if an AFP printer device represents the same physical printer.
If so, check these settings for the AFP physical printer:
  1. Make sure that the Share printer connection property is set to Yes.
    If the value is No (the default), the printer driver component of RICOH ProcessDirector never releases control of the printer to the hot folder.
  2. Make sure that the IPDS printer connection timer property is less than the Inactivity timer property. If the IPDS printer connection timer property is greater than the Inactivity timer property, RICOH ProcessDirector drops the connection before it can share the printer.

1.2.9.1.1.7.5 Job prints on wrong printer

If a job received from Download for z/OS or AFP Download Plus prints on a printer other than the one you expected, you might have to change the printer properties or your configuration file so that RICOH ProcessDirector uses the value of the DEST parameter in the job's JCL to select the printer.

The DEST JCL parameter is often used to specify a printer on a z/OS system. When the job is downloaded, the sample receive_jcl_jobtype.cfg file maps DEST to the Destination property of the job. The job is then scheduled to a printer whose Destination property matches the job Destination property.

RICOH ProcessDirector can also use the Requested printer property to schedule jobs to a printer whose name matches the value of the Requested printer property.

To use the DEST JCL parameter to assign a job to a printer, you must do either of these:

  • Set the Destination property of the printer to match the value of the DEST JCL parameter.
  • Give the printer a name that matches the DEST value and then edit the receive_jcl_jobtype.cfg file to map the DEST parameter to the Requested printer property;
    for example:
     DEFINE ${Job.RequestedPrinter} AS "${DEST}

1.2.9.1.1.7.6 Job requires a long time to stop printing

If you use the Stop action on a job that is printing but it takes a long time for the job to stop printing, you might need to change some settings on the printer console.
RICOH ProcessDirector uses Simple Network Management Protocol (SNMP) to send the Stop request to the printer. However, if the printer is not set up to permit SNMP communication, or if it does not support a fast Stop request, RICOH ProcessDirector uses a slower method to transmit the Stop request. To speed up the response of these printers to a Stop action:
  • InfoPrint 2000 for AFP
  • InfoPrint 3000
  • InfoPrint 4000
  • InfoPrint 4100
  • InfoPrint 5000
  • InfoPrint Pro C900AFP
use the printer console to enable the SNMP agent and to allow SNMP to configure the printer.

1.2.9.1.1.7.7 Job moves to error state with message AIWI0017I, return code 310

If a job goes into an error state and you see message AIWI0017I with return code 310, there might be a problem with submitting files to RICOH ProcessDirector.

Message AIWI0017I contains a copy of a message that was issued by a component of RICOH ProcessDirector. In this case, the message text is:

AIWI0017I 0425-422 AN ERROR OCCURRED WHILE ATTEMPTING TO READ "spool_file_name"
RETURN CODE 310

Message 0425-422 with return code 310 means that the file format is not valid. This can happen when a Hot folder input device creates a job from a file that has not been completely transmitted.

For example, if the Completion method of the Hot folder input device is Size, the Hot folder input device checks its contents at regular intervals, records the size of each file in it, and compares it to the size of that file at the previous checkpoint. If the size of the file has not changed, the Hot folder input device assumes that it has been fully received and creates a job. However, if the transmission pauses in the middle of a file due to network traffic and the file size does not increase before the next checkpoint, the Hot folder input device submits a partial file.

To verify that the file is incomplete, enter this command on the server where the Hot folder input device resides:

afpdmp spool_file_name | tail

If you see these messages, the file has probably been truncated:

Input file is too short
Input is not valid AFPDS

Delete the job and send it again.

To prevent this problem, try one or more of these methods:

  • Increase the Polling interval of the Hot folder input device.
  • Change the Completion method of the Hot folder input device.
  • Adjust the network to prevent pauses in data transmission.

1.2.9.1.1.7.8 Job moves to error state with message AIWI6416E

If a job goes into an error state and you see message AIWI6416E, there might be a problem with the AFP file or there might have been an error when RICOH ProcessDirector tried to connect to the printer.
  1. First, try to print the job again using the Print Again function. If there was a problem connecting to the printer, the job might print correctly.
  2. If errors in the AFP data stream prevent the RICOH ProcessDirector printer driver component from printing the job, RICOH ProcessDirector might not be able to print any subsequent error-message pages. You can look at the contents of /var/psf/printernameaiw1/error.log (Linux) or C:\Program Files (x86)\InfoPrint\PSF\var\psf\printernameaiw1\error.log (Windows) (printername is the name of your printer) to see if there is any more information about the problem. RICOH ProcessDirector can write messages to this error log, even if it is not able to print error-message pages.
    Note: /var/psf/printernameaiw1/error.log (Linux) or C:\Program Files (x86)\InfoPrint\PSF\var\psf\printernameaiw1\error.log (Windows) and the printer log that you can view from the Printers portlet contain some of the same messages. In addition, each contains some messages that the other does not.
    • /var/psf/printernameaiw1/error.log (Linux) or C:\Program Files (x86)\InfoPrint\PSF\var\psf\printernameaiw1\error.log (Windows) contains all the messages that the RICOH ProcessDirector printer driver component issues about a specific printer, whether it returns these messages to the RICOH ProcessDirector server or not. It does not contain messages that the RICOH ProcessDirector server issues.
    • The printer log contains all the messages that the RICOH ProcessDirector server issues about the printer and the messages that the RICOH ProcessDirector printer driver component returns to the server. It does not contain messages that the printer driver component does not return to the server.
  3. You can then use the psfmsg command to see more information about a specific error. The syntax for the command is:
    psfmsg prefix-number

    For example:

    psfmsg 0420-885

    The prefixes for messages that the RICOH ProcessDirector printer driver component issues are in the range 0420 through 0424. The psfmsg command does not provide message information for messages with any other prefix.

The error log identifies jobs by their spool ID numbers. To determine the spool ID for a specific job, see the General tab of the properties notebook for the job. An example of a spool ID is:

743750000

Note: There is no relationship between the spool ID number and the job ID number.

1.2.9.1.1.7.9 Job moves to error state with no message

If a job goes into an error state during the PrintJobs step and you do not see an error message on the error-message pages or in the printer log, there may be more information in /var/psf/printernameaiw1/error.log (Linux) or C:\Program Files (x86)\InfoPrint\PSF\var\psf\printernameaiw1\error.log (Windows). printername is the name of your printer.

/var/psf/printernameaiw1/error.log (Linux) or C:\Program Files (x86)\InfoPrint\PSF\var\psf\printernameaiw1\error.log (Windows) and the printer log that you can view from the Printers portlet contain some of the same messages. In addition, each contains some messages that the other does not.

  • /var/psf/printernameaiw1/error.log (Linux) or C:\Program Files (x86)\InfoPrint\PSF\var\psf\printernameaiw1\error.log (Windows) contains all the messages that the RICOH ProcessDirector printer driver component issues about a specific printer, whether it returns these messages to the RICOH ProcessDirector server or not. It does not contain messages that the RICOH ProcessDirector server issues.
  • The printer log contains all the messages that the RICOH ProcessDirector server issues about the printer and the messages that the RICOH ProcessDirector printer driver component returns to the server. It does not contain messages that the printer driver component does not return to the server.

  1. Use a text editor to look at the contents of /var/psf/printername/error.log (Linux) or C:\Program Files (x86)\InfoPrint\PSF\var\psf\printernameaiw1\error.log (Windows) to see if there is any more information about the problem.
  2. You can then use the psfmsg command to see more information about a specific error. The syntax for the command is:
    psfmsg prefix-number

    For example:

    psfmsg 0420-885

    The prefixes for messages that the RICOH ProcessDirector printer driver component issues are in the range 0420 through 0424. The psfmsg command does not provide message information for messages with any other prefix.

The error log identifies jobs by their spool ID numbers. To determine the spool ID for a specific job, see the General tab of the properties notebook for the job. An example of a spool ID is:

743750000

Note: There is no relationship between the spool ID number and the job ID number.

1.2.9.1.1.7.10 AFP jobs print with incorrect colors

If an AFP job contains multiple AFP presentation documents and they have different color management resources (CMRs), the job can print with incorrect colors.
    Note:
  • An AFP presentation document is different from a RICOH ProcessDirector document. Begin Document (BDT) and End Document (EDT) structured fields define an AFP presentation document. Begin Named Group (BNG) and End Named Group (ENG) structured fields define a RICOH ProcessDirector document. AFP jobs can have AFP presentation documents regardless of whether they have RICOH ProcessDirector documents. For example, an application that combines multiple AFP files into one AFP job can make each of the original AFP files into an AFP presentation document.

The EnableRepositioning step runs the AFP Conversion and Indexing Facility (ACIF). When ACIF processes a job with multiple presentation documents:

  • It removes all the BDT and EDT structured fields.
  • It generates a single set of BDT and EDT structured fields for the entire output.
If the presentation documents have different CMRs, all but one of the CMRs are removed, and the job prints with incorrect colors.

To fix a problem with AFP jobs that print incorrectly because CMRs have been removed:
  • Remove the EnableRepositioning step from the workflow.
    When using the Jump to and Print again functions without the EnableRepositioning step, you cannot use sheet numbers or indexing tags to select pages in the viewer.

    If you have the Inserter feature and the workflow contains the CreateInserterReprints step, do not remove the EnableRepositioning step. It is required to reprint documents damaged during insertion.

  • Contact your Ricoh support representative for a fix that lets ACIF pass all the BDT and EDT structured fields into the output data stream.

1.2.9.1.1.7.11 Job containing multiple AFP files does not print

The AFP architecture lets applications put multiple documents in a single file. The document boundaries are marked with Begin Document (BDT) and End Document (EDT) structured fields. Applications might use this function to cause finishing operations, such as stapling or binding, to operate on each document separately. However, some steps provided in many workflows supplied with RICOH ProcessDirector cannot process files that contain multiple documents.

The EnableRepositioning and CreatePageRanges steps map pages to sheets so that the Jump to and Print again functions can reliably locate a page in the job and so that the CreateInserterReprints step can reprint documents that were damaged during insertion. If either of these steps processes a job containing multiple documents, an error occurs that prevents the job from printing.

You can remove these steps from the workflow being used to process the job and the job will print, but you will no longer be able to use sheet numbers or indexing tags to select pages in the viewer when using the Jump to and Print again functions. If the workflow contains the CreateInserterReprints step, do not remove the EnableRepositioning and CreatePageRanges steps because these steps are required to reprint documents damaged during insertion.

1.2.9.1.1.7.12 Recovering from printer jams

Usually RICOH ProcessDirector can resume printing from the last stacked page when a jam is cleared from the printer. However, for AFP printers only (especially continuous forms printers) follow these steps if you need to reprint some of the pages that were successfully stacked. For example, you might need to be certain that you have complete jobs for any post-processing equipment.
To recover from a printer jam:
  1. In the Printers portlet, select the printer and click Stop.
  2. On the Stop Printer dialog, select Immediately.
  3. Click OK.
  4. On the Jobs table, select the job that was active on the printer and click Stop.
  5. On the Stop Jobs dialog, choose Stop now and remember the last page that prints.
  6. Click OK.
  7. Clear the jam and make the printer ready.
  8. In the Printers portlet, select the printer and click Start.
  9. Click OK.
  10. On the Jobs table, select the job and click Continue.
  11. On the Continue jobs dialog, choose From the page after the last page that previously printed for the job.
  12. Click OK.

1.2.9.1.1.7.13 Job moves to error state with message RPDF008E

If a job goes into an error state and you see message RPDF008E, check how your Ricoh PDF printer is configured.

  • In the Printer Model property, make sure that the correct value is selected.
  • Check the Data stream to send property. If it is set to JDF/PDF, the printer must have a supported EFI Fiery control unit or RICOH TotalFlow Print server installed. For a list of control units that support this data stream, see the Ricoh PDF printer readme. On a Linux primary or secondary server, the readme file is in the /aiw/aiw1/pc directory. On an application server, the readme file is in the C:\Program Files (x86)\Ricoh\ProcessDirector\pc directory.

    If your printer and control unit combination does not support the JDF/PDF data stream, select PostScript in the Data stream to send property.

1.2.9.1.1.7.14 Job prints on incorrect media using an AFP printer

If AFP support is installed and your job was sent to an AFP printer, where it printed on the wrong paper (for example green instead of blue paper), you might need to update some job or printer properties.
AFP jobs have two ways of specifying the media to use: the form definition resource and the Media property set in the workflow. The form definition resource specifies the bin number to use to print each page of the job. Setting a value for the Media property for the job overrides the form definition and all pages are printed using the Media value set for the job. When the media specified in the Media property for the job is loaded in a tray in the printer and that tray is enabled, RICOH ProcessDirector sends the bin number that is defined for that tray to the printer driver component and all pages of the job will print from the stock loaded in that tray. If you specify a value for the Media property of the job, it must match a value for the Media supported on the printer before RICOH ProcessDirector can schedule the job to the printer.
To view and update the appropriate properties:
  1. Right-click the job and select Properties.
    1. Find the Media property on the Scheduling tab and make sure it lists the correct media name.
    2. If the media value is blank, look at the Form definition property on the AFP tab. If that value is blank, the form definition is contained in the print job. If a form definition was specified, you may need an AFP data analysis tool to tell you if the form definition specified a bin to pull paper from and, if so, what bin number was specified for the job.
  2. If there was a Media value for the job, check in the job log for any evidence that the value of the Media property for the job changed since you submitted it.
    1. Right-click the job and select View Log.
    2. Set the log to show Property changes and search for Media.
    3. Look for evidence that someone used the Correct media action to change the job media value after you submitted the job.
  3. Look at the banner page or the job log to find the name of the printer that printed the job. If you look in the job log, sort the Issued by column until you see the name of the printer.
  4. In the Printers portlet on the Main page, select the printer that printed the job, and click Properties. On the Media tab, look for the list of Media supported for the printer.
    • If the value for Media supported is Ready media objects, use the Show Trays action on the selected printer to see what media is loaded in each tray. The values displayed might have changed after you printed the job. If the media named by your job is shown as loaded in a tray, note the bin number associated with that tray.
    • If the value for Media supported is Custom, look for the name of the media you requested in the list. Then, check to see whether that system media is mapped to the correct printer media. Click Administration Media Media Mapping. Select the printer from the list and look for the system media in the table.

      If the system media is mapped incorrectly, delete it and add a new mapping.

  5. On the printer or printer controller console, check the bin mapping information. See if the bin with the number listed on the Tray information page is loaded with the correct paper or has any indications about the media that is usually loaded in it. It is possible that the operator did not have the correct media loaded in the tray.
  6. If the values in the Media required property for the job are all matched by the values set in the Media supported for the printer used to print the job, it is likely that the operator forgot to update the media loaded in the printer to match the requested media before the job was printed.

1.2.9.1.1.7.15 Job prints on incorrect media using a Passthrough printer

If your job was sent to a Passthrough printer and it printed on the wrong paper (for example green instead of blue paper), you might need to update some job or printer properties.

When RICOH ProcessDirector sends a job to a Passthrough printer, no media information is sent with it. As a result, operators have complete responsibility for the media that is used for the job. The operator must know what media the job requests in the Media required property and must make sure that the correct media is loaded in the printer. Then the operator should use the View trays option for the printer to make sure that the correct media is listed. When that setting is correct, RICOH ProcessDirector can schedule the job to the printer using media properties.

If you think there is a scheduling error, you might need to update the Media property for the job, the media requested by any page exceptions, or the list of supported media for the printer.

To view and update the appropriate properties:
  1. Right-click the job and select Properties.
    1. On the Scheduling tab, find the Media required property and make sure it lists the correct media names.
    2. If it does not, check the Media property for the job and the media requested by any page exceptions. Update them as needed.
  2. Check in the job log for any evidence that the value of the Media property for the job changed since you submitted it.
    1. Right-click the job and select View Log.
    2. Set the log to show Property changes and search for Media.
    3. Look for evidence that someone used the Correct media action to change the job media value after you submitted the job.
  3. Look at the banner page or the job log to find the name of the printer that printed the job. If you look in the job log, sort the Issued by column until you see the name of the printer.
  4. In the Printers portlet on the Main page, select the printer that printed the job, and click Properties. On the Scheduling tab, look for the list of Media supported for the printer.
    If the value for Media supported is Ready media objects, use the Show Trays action on the selected printer to see what media is loaded in each tray. The values displayed might have changed after you printed the job. Using Ready media objects for the Media supported on the printer should prevent scheduling errors if the operator always uses the Show Trays action when changing media in the printer trays.
  5. If the values in the Media required property for the job are all matched by the values set in the Media supported property for the printer used to print the job, it is likely that the operator forgot to update the media loaded in the printer to match the requested media before the job was printed.

1.2.9.1.1.7.16 Job prints on incorrect media using a Ricoh PDF, Custom PDF, or Ricoh TotalFlow printer

If your job was sent to a Ricoh PDF, Custom PDF, or Ricoh TotalFlow printer and it printed on the wrong paper (for example green instead of blue paper), you might need to update some job or printer properties.
To view and update the appropriate properties:
  1. Right-click the job and select Properties.
    1. Find the Media required property on the Scheduling tab and make sure it lists the correct media name.
    2. If it does not, check the Media property for the job and the media requested by any page exceptions. Update them as needed.
    3. Find the Prevent media substitution property.
      If the value is Yes or Not set, media mappings between system and printer media are ignored. If the value is No, media mappings are used.
  2. You might need to examine the method you used to submit the job and the options it provides for specifying media properties. The media properties might not have been submitted correctly in the job ticket.
  3. If there was a Media value for the job, check in the job log for any evidence that the value of the Media property for the job changed since you submitted it.
    1. Right-click the job and select View log.
    2. Set the log to show Property changes and search for Media.
    3. Look for evidence that someone used the Correct media action to change the job media value after you submitted the job.
  4. Look at the banner page or the job log to get the name of the printer that printed the job. If you look in the job log, sort the Issued by column until you see the name of a printer.
  5. In the Printers portlet on the Main page, select the printer that printed the job, and click Properties. On the Media tab:
    • Make sure the Media to use property is set correctly.

      If it is set to Printer, make sure that the system media requested in the job is mapped to the correct printer media.

    • If the value for Media supported is Ready media objects, use the Show Trays action on the selected printer to see what media is loaded in each tray. The values displayed might have changed after you printed the job. Using Ready media objects for the Media supported on the printer should prevent scheduling errors if the operator always uses the Update media action when changing media in the printer trays.
    • If the value for Media supported is Custom, look for the name of the media you requested in the list. Then, check to see whether that system media is mapped to the correct printer media. Click Administration Media Media Mapping. Select the printer from the list and look for the system media in the table.

      If the system media is mapped incorrectly, delete it and add a new mapping.

  6. If Media Matching is set to Use the properties selected below on the Media settings page, media objects are automatically created when values are returned from the printer for all of the selected properties. If your job requested a media that was created this way, the media object could have been edited or renamed in such a way that RICOH ProcessDirector does not consider it a match. The administrator might have to change the Media supported property for the printer or change the procedures used by operators who load paper and schedule jobs to check that the media names are set up according to your site's expectations.
  7. If the values in the Media required property for the job are all matched by the values set in the Media supported for the printer used to print the job, it is likely that the operator forgot to update the media loaded in the printer to match the requested media before the job was printed.
  8. If you have a Custom PDF printer, check with your Ricoh support representative to make sure that the custom printer definition file is correct.

1.2.9.1.1.7.17 Jobs do not print with electronic forms

Several different problems can keep jobs from printing with electronic forms.
To solve the problem:
  1. Check the media required for the job when it printed:
    1. On the Main page, right-click the job in the Jobs table and select Properties.
    2. On the Scheduling tab, note the media, if any, in the Media required field.

      The media required by the job when it enters the workflow can change when it goes through the CombinePDFWithForm or CombineAFPWithForm step. See step 4 of this procedure for an explanation of the changes.

  2. Make sure that electronic forms have been defined for the media required by the job before it enters the CombinePDFWithForm or CombineAFPWithForm step in the workflow:
    1. Click the Administration tab.
    2. In the left pane, click Media System Media.
    3. Right-click the media object that you want to check and select Properties.
    4. To make sure that an electronic form is defined for the front side, look at the field next to the Folder button for the Front of form property.

      Make sure that the field has a blue Front of form link. If it does not have a link, you must define a form for the front side of the media object. Follow the instructions in the Information Center.

    5. To make sure that an electronic form is defined for the back side, look at the field next to the Folder button for the Back of form property.

      Make sure that the field has a blue Back of form link. If it does not have a link, you must define a form for the back side of the media object.

  3. Make sure that you can display the electronic forms by clicking each blue link.

    If the forms that you defined are not displayed, you must delete the current forms and define new forms for the media object:

    1. To delete a form, click x to the right of the blue link.
    2. To define a new form, follow the instructions in the Information Center.
  4. Check the setting of the Media name for printing property.

    The setting does not control whether the job prints with electronic forms, but it does control the media name required for the job when it prints. Comparing the media that you expect the job to print on with the media used to print the job can help you diagnose the problem.

    The setting determines whether the media required for the job changes when the job goes through the CombinePDFWithForm or CombineAFPWithForm step.

    For example, when entering the workflow, the job requires Form100 media.

    • If Media name for printing is set to Current name, the media required for the job when it prints is Form100.
    • If Media name for printing is set to None, no specific media is required for the job when it prints. The job prints on the default media for the printer.
    • If Media name for printing is set to Selected and the value in the list box is Letter Blue, the media required for the job when it prints is Letter Blue.

    If the job includes page exceptions, it can have multiple media objects that define the electronic forms for the job.

  5. Make sure that you have a CombinePDFWithForm or CombineAFPWithForm step in your workflow and that the step processes the jobs.

    Jobs print on electronic forms only when the jobs go through the CombinePDFWithForm or CombineAFPWithForm step.

    1. Click the Workflow tab.
    2. Open the workflow that processes the jobs and make sure that it has a CombinePDFWithForm or CombineAFPWithForm step.

      If the workflow does not have one of those steps, you must add the appropriate step.

    3. If some jobs go through the step and others bypass the step, make sure that the jobs that print on electronic forms go through the step. To check whether a job that did not print with electronic forms went through the step, right-click the job and select View job in workflow.

      If any jobs that print on electronic forms bypass the step, adjust the rules that control the conditions on the branch that goes through the step.

  6. For AFP jobs:
    • Make sure that the job prints on an AFP printer that supports PDF object containers in AFP data.
    • Make sure that pages to be printed on electronic forms do not include opaque overlays.

      If they do include opaque overlays, make the overlays transparent. A page with one or more opaque overlays can hide the electronic form overlay.

    • Make sure that no side of any sheet already has eight medium overlays.
    • Make sure that the CombineAFPWithForm step is after the UseInlineFormDefinition step (if it exists) and before the EnableRepositioning step.

      If your workflow has an afpnorm command in a step based on the RunExternalProgram step template, make sure that the CombineAFPWithForm step is after the RunExternalProgram step.

If all the settings that you reviewed are correct, the cause of the problem can be settings that do not involve media objects with electronic forms. To troubleshoot general problems with jobs printing on incorrect media, see the related reference topics.

1.2.9.1.1.7.18 Data does not print correctly on electronic forms

If data does not print correctly on electronic forms, check the size and alignment of the electronic form and the pages that contain the job data.
To solve the problem:
  1. Make sure that the form is the same size as the pages that contain the data.

    If the form is not the same size, replace it with a new form.

  2. If the form and the pages that contain the data are the same size, make sure that the form aligns with the data.

    If the form does not align with the data, you can fix the problem in these ways:

    • Replace the form with a new form.
    • Change the formatting of the data in the print file so that the data aligns with the form.
    • For AFP jobs, you can set values for the X offset and Y offset job properties to adjust the page origin relative to the medium origin.
    • For AFP jobs, you can adjust the medium map by modifying the Page Position structured field to shift the page relative to the media.

1.2.9.1.1.7.19 Page data is combined with the wrong electronic forms

If page data is combined with the wrong electronic forms, make sure that the correct forms have been defined for the media objects. Also make sure that the CombinePDFWithForm or CombineAFPWithForm step has been placed correctly in the workflow.
To solve the problem:
  1. Make sure that the correct electronic forms have been defined for the media required by the job:
    1. Click the Administration tab.
    2. In the left pane, click Objects Media.
    3. Right-click the media object that you want to check and select Properties.
    4. If the front side of the media has a form, click the blue link in the field next to the Folder button for the Front of form property.

      If the wrong form is displayed, delete the current form by clicking x to the right of the blue link. Define a new form by following the instructions in the related task for adding electronic forms to media objects.

    5. If the back side of the media has a form, click the blue link in the field next to the Folder button for the Back of form property.

      If the wrong form is displayed, delete the current form by clicking x to the right of the blue link. Define a new form.

  2. Check the placement of the CombinePDFWithForm or CombineAFPWithForm step in the workflow.
    • For PDF jobs with documents, make sure that the CombinePDFWithForm step is after the BuildPDFFromDocuments step.
    • For AFP jobs with documents, make sure that the CombineAFPWithForm step is after the BuildAFPFromDocuments step and before the EnableRepositioning step.

1.2.9.1.1.7.20 Jobs with electronic forms print on the wrong paper

Even when electronic forms are combined with page data correctly, several problems can cause jobs to print the forms and page data on the wrong paper.
To solve the problem:
  1. Check the media required for the job when it printed:
    1. On the Main page, right-click the job in the Jobs table and select Properties.
    2. On the Scheduling tab, note the media, if any, in the Media required field.

      The media required by the job when it enters the workflow can change when it goes through the CombinePDFWithForm or CombineAFPWithForm step. See step 4 of this procedure for an explanation of the changes.

  2. Make sure that the correct paper is loaded in the printer.
  3. For AFP jobs:
    • If you are matching media names in the AFP medium maps to RICOH ProcessDirector media names, make sure that the matching is case-sensitive.

      For example, if the medium map specifies a media name in all uppercase letters (such as LETTER BLUE), RICOH ProcessDirector must have media named LETTER BLUE. Letter Blue does not match.

    • If you are mapping trays in AFP medium maps to RICOH ProcessDirector media names, make sure that the tray mapping file is correct.

      For more information about mapping AFP medium maps to RICOH ProcessDirector media names, refer to the Information Center.

  4. Check the setting of the Media name for printing property.

    If this property is set to the wrong value, the job prints on the wrong paper.

    1. Click the Administration tab.
    2. In the left pane, click Objects Media.
    3. Right-click a media object and select Properties.
    4. If the value of the Media name for printing property is incorrect, change it.
    5. Click OK.

    For each media object with electronic forms required by pages in the job, this property specifies the media that RICOH ProcessDirector uses to print the pages.

    The setting of the property determines whether the media required for the job changes when the job goes through the CombinePDFWithForm or CombineAFPWithForm step.

    For example, when entering the workflow, the job requires Form100 media.

    • If Media name for printing is set to Current name, the media required for the job when it prints is Form100.
    • If Media name for printing is set to None, no specific media is required for the job. It prints on the printer default paper.
    • If Media name for printing is set to Selected and the value in the list box is Letter Blue, the media required for the job when it prints is Letter Blue.

    Several problems can cause the job that requires Form100 media when entering the workflow to print on the wrong paper. For example:

    • You expect the job to print on the paper for Form100 media, but the job prints on the printer default paper. Make sure that the Media name for printing property is set to Current name. If it is set to None, the job prints on the printer default paper.
    • You expect the job to print on blue letter paper, but the job cannot be scheduled to a printer. The reason is that Form100 media is not defined on the printer. Make sure that the Media name for printing property is set to Selected (not Current name) and the value in the list box is Letter Blue.

If all the settings that you reviewed are correct, the cause of the problem can be settings that do not involve media objects with electronic forms. To troubleshoot general problems with jobs printing on incorrect media, see the related reference topics.

1.2.9.1.1.7.21 Whole job reprints instead of selected pages

If you select a page range when you reprint a job, but the entire job reprints, the workflow might not include required steps, or reprinting might be starting at the wrong step.
Required steps

To reprint pages in a job, the workflow must include both the CountPages and CreatePageRanges steps. CountPages must run before CreatePageRanges and before PrintJobs. If you have the AFP Support feature installed, you can replace the CountPages step with the EnableRepositioning step. In addition to calculating page counts, EnableRepositioning lets you use the Print again or Jump to functions with AFP data that contains index tags. However, EnableRepositioning requires more processing time, so using CountPages is more efficient if you do not need the additional function.

Where to restart

The step property Step restart type specifies whether RICOH ProcessDirector can restart processing at the step. A value of Print means that the Print again action can restart at the step. If more than one step in a workflow has Step restart type set to Print, RICOH ProcessDirector restarts printing at the first of these steps.

In the sample workflows that RICOH ProcessDirector supplies, the first step with a Step restart type value of Print is CreatePageRanges. CreatePageRanges uses the value you specify in the Pages field in the View function to create a subset of the job for reprinting.

If printing restarts at a step before the CreatePageRanges step, the reprint process might not use the value in the Pages field. Without this value, the whole job reprints.

1.2.9.1.1.7.22 Job moves to No matching device state

When a job stops in the No matching device state, check the Requested printer property and make sure that the scheduling properties for the job match the corresponding properties of the requested printer.

RICOH ProcessDirector provides both manual and automated scheduling of jobs to printers. When a job is submitted to RICOH ProcessDirector, the Requested printer property can contain one of these values:

  • A specific printer: RICOH ProcessDirector assigns jobs to a specific printer that you define based on availability and matching scheduling properties ( Customer name, Job size, Location, Media, Output bin, Binding, Folding, Punch, and Staple). The AFP Support feature adds Class, Destination, and Form. Scheduling properties are added or deleted from this list by editing a scheduling properties configuration file.
  • Any printer: RICOH ProcessDirector assigns jobs to the first available printer based on matching scheduling properties.
  • Not set: RICOH ProcessDirector does not assign a job to a printer until you use the Schedule function to select a printer for the job.

To correct the problem and print the job:

  1. Select the job in the Jobs table and click Schedule.
  2. On the Schedule Jobs page, select a printer in the Printers table.
    The properties that prevent the job from being scheduled to that printer are marked in both the Printers table and the Jobs table.
  3. Do either of these:
    • To change the job properties to match the printer properties, click Make jobs match selected printer.
        Note:
      • RICOH ProcessDirector does not update the value of the Media scheduling property. To resolve a Media scheduling property conflict, you must change the media specified by the job or route the job to a printer that supports the media.
    • To change the printer properties to match the job properties, click Edit properties in the Printers table.
  4. Click OK.

1.2.9.1.1.7.23 Job moves to No matching media state

When a job stops and the value of the Current job state details column is No matching media, the media name or media properties in the JDF job ticket or overrides file for the job cannot be matched to an existing media object.
You can use the Correct media action on the job to select an appropriate media. The Correct media function changes all requests for the media in error with the replacement media, whether the media was requested for the entire job or for a set of pages.

To correct the media requested by a job:

  1. In the Jobs table, right-click a job that is in the No matching media state and select Correct Media.
    The Correct media window opens, displaying two columns: the list of media requested for the job that do not match any defined media objects, and a list of available media objects.
  2. Select a value from the available media list.
      Note:
    • If you select Not set, that media is removed from the Media property for the job, the media for any page exceptions, and the job ticket.
  3. Click OK.

1.2.9.1.1.7.24 Job moves to Device unavailable state

When a job stops and the value of the Current job state details column is Device unavailable, no printer is enabled and connected that matches the scheduling properties of the job.

To correct the problem and print the job:
  1. Double-click the job to open the Properties notebook and review the properties on the Scheduling tab.
  2. Enable a printer whose properties match the job scheduling properties.
  3. If the printer is not connected, view the properties for the printer and determine its parent server. Then, use the startaiw command to start the parent server .

1.2.9.1.1.7.25 Job in Status changed on printer state

If a job is in the Status changed on printer state, the job was manipulated on the printer console and the status is no longer reported.

When the Current job state details column of the Jobs table shows Status changed on printer, the job has been moved from the Active state to the Inactive state (held) or deleted on the printer console. Check the printer console to determine whether the job can continue in its workflow or if a different action is required. In RICOH ProcessDirector, use the Go to next step action to move the job to the next step in the workflow. Use either the Print again or Restart step action to send the job to the printer again.

This state applies only to jobs assigned to a Ricoh TotalFlow printer.

1.2.9.1.1.7.26 Printing a large PDF file causes an out of memory message or slow processing

If you see an out of memory message or encounter slow processing when printing a large PDF file, you can set the Merge banner pages into PDF print file property to No or increase the Java Virtual Machine (JVM) memory. Merging banner pages on large PDF files takes more memory and system resources than printing banner pages as separate files. If you need to merge banner pages, increase the JVM memory.
To improve system performance when printing large PDF files:
  1. Check the setting of the Merge banner pages into PDF print file property:
    1. In the Printers portlet, right-click the printer and select Properties.
    2. Click the Banner Pages tab.
    3. If the Merge banner pages into PDF print file property is set to Yes, change it to No.
  2. Increase the JVM memory:
    1. Open the /aiw/aiw1/config/jvmsettings.cfg file with a text editor.
    2. Increase the memory amount by changing the value specified.
    3. Save the changes and restart RICOH ProcessDirector.

1.2.9.1.1.7.27 Errors in jobs for WPM Web

You might experience issues with jobs that should be sent to WPM Web that can be resolved by updating the configuration of some steps, workflows or printers.

Some common issues with sending jobs to WPM Web and steps to resolve them are:

  • Settings for the job in WPM are not correct.

    Incorrect settings might be caused by the values included in the User Information Page (UIP) that the printer object creates and sends to WPM Web. Open the workflow that processed the job and review the job default property values for the step based on the SetWPMProperties step template. Adjust the values as needed and process the job again.

  • WPM cannot process the job.

    If the printer object does not send a UIP to WPM Web with the job, WPM Web cannot process the job. The printer object only sends a UIP with the job if the Create User Information Page property is set to Yes. Open the property notebook for the printer that sent the job to WPM and verify the value of the Create User Information Page property.

  • Job goes into the error state.

    A job can move into the error state if the workflow does not include a step based on the SetWPMProperties step template. Without that step, the printer object cannot create the UIP, so it moves the job to error. Update the workflow that processes jobs for WPM Web to include a step based on SetWPMProperties and process the job again.

  • UIP is unreadable in WPM

    If you try to view the UIP using the WPM interface and the text is not readable, coded font mappings might need to be updated. Make sure valid values are entered for the User Information Page DBCS coded font and User Information Page SBCS coded font properties of the step based on the SetWPMProperties step template.

    Then, check the code page mapping file for banner page files to make sure the correct mappings are included. The file is stored in:/aiw/aiw1/control_files/banner_pages/.

    Add lines to map your SBCS and DBCS coded fonts to the IBM-930 or IBM-939 code pages. For example, add lines like these:

    X0H16N=IBM930
    X0G32F=IBM930
    X0H16U=IBM939
    X0M32F=IBM939

    Also make sure that the coded fonts are stored in a directory that RICOH ProcessDirector searches for resources. For example, you can add the directory to the AFP resource path property for the printer object.

1.2.9.1.1.7.28 Incorrect characters in document properties from PDF files

If you have trouble with document property values that are extracted from PDF files using RICOH ProcessDirector Plug-in for Adobe Acrobat, the fonts included in the PDF file might be incomplete or contain different UNICODE mappings than you expect.

The process of displaying or printing content using font on a PDF pages can use a variety of encodings. The process of extracting text from a PDF page requires a UNICODE mapping from an encoded page character to a Unicode code point.

To extract content from PDF to UNICODE, fonts include a table that maps each PDF character to its UNICODE equivalent. Some fonts include multiple look-alike characters. For example, a font might include a dash, a minus sign, and a hyphen. Though they seem very similar, each one is a different character and is drawn slightly differently. Each one also has a different UNICODE codepoint. The mapping table determines which UNICODE character is used.

When RICOH ProcessDirector extracts document property values from a PDF file using a control file created in RICOH ProcessDirector Plug-in for Adobe Acrobat, it reads the value in UNICODE. Then the value is recorded in the Document Properties File (DPF), which requires data to be encoded in UTF-8 format. UTF-8 format uses multi-byte character sequences to represent UNICODE codepoints outside of the ASCII encoding range. As a result, the value is converted to the UNICODE equivalent character when it is added to the DPF file.

Problems can occur when values from the DPF are written back into the PDF file. If the UNICODE characters do not have PDF equivalents in the font, incorrect characters are inserted. These problems occur most often with subsetted and Identity-H fonts. Additional problems can occur when you search for explicit characters, but the UNICODE codepoints in the DPF are not the expected characters.

The ideal solution is to update the input PDF file so that it includes complete fonts instead of subsets. Another option is to add a step to your workflow that corrects the DPF properties. The native2ascii utility can be used to normalize the DPF file to an ASCII character encoding. The UNICODE codepoints that were encoded as UTF-8, will be normalized to a form \u####. An editor or a filter script can be used to change the problem character from the UNICODE \u#### to the actual ASCII character required. Once the ASCII version of the DPF is updated, the native2ascii utility would be used to convert the DPF back to the required UTF-8 encoding.

The native2ascii utility converts text to Unicode Latin-1. It is shipped with RICOH ProcessDirector.

  • On Linux, the native2ascii utility is stored in: /opt/infoprint/ippd/jre/bin
  • On Windows, the native2ascii.exe utility is stored in: C:\Program Files\Ricoh\ProcessDirector\jre\bin

The utility is also provided with the Java Development Kit, which you can download from this site: http://www.oracle.com/technetwork/java/javase/downloads

Instructions for using the utility (for Java 6) are here: http://download.oracle.com/javase/6/docs/technotes/tools/#intl

1.2.9.1.1.8 Using job resources

These topics describe problems with the AFP resources used to print jobs.

1.2.9.1.1.8.1 Font not found error

If you see a Font not found error in the job log when you try to print, check the IPDS Resolution setting at the printer console and the Font fidelity property of the RICOH ProcessDirector printer.
    Note:
  • On a Windows system, if you store data or resources on a mapped network drive, contact Software support for help configuring your system to find and use them. Check the C:\aiw\aiw1\trace\mountDrives.log file for messages from mountDrives.bat. For information about mapping network drives on a Windows computer, see the RICOH ProcessDirector information center.

Font not found errors can occur at print time even when a job has printed to another printer successfully. If a RICOH ProcessDirector job references one font resolution, but the printer is set to another font resolution and the Font fidelity printer property in RICOH ProcessDirector is set to Stop printing, you get an error printed in the job and in the job log.

To fix this error:

  • Change the IPDS Resolution setting to Automatic at the console of the printer where the error is occurring.
  • Change the Font fidelity property of the RICOH ProcessDirector printer to Continue printing.

The IPDS Resolution setting now automatically detects the font resolution of the RICOH ProcessDirector job. If fonts in this resolution cannot be found, the printer substitutes available fonts.

1.2.9.1.1.8.2 Resources cannot be found

If you receive error messages from a ConvertLineDataJobIntoAFP or PrintJobs step or from the AFP file viewer saying that your AFP resources cannot be found, you might need to make any of several changes.
  1. Check the value of the AFP resource path property of the job, workflow, and printer. Make sure that the value includes all the directories that hold AFP resources and that multiple directories are separated by colons.
  2. Make sure that you have made all of those directories available to RICOH ProcessDirector. On Linux systems, if those directories reside on different systems, they must be NFS-mounted to the parent server of the printer so that they can share resources.
      Note:
    • On a Windows system, if you store data or resources on a mapped network drive, contact Software support for help configuring your system to find and use them. Check the C:\aiw\aiw1\trace\mountDrives.log file for messages from mountDrives.bat. For information about mapping network drives on a Windows computer, see the RICOH ProcessDirector information center.
  3. If the missing resource is a color management resource (CMR), verify that you used AFP Resource Installer to install the CMR. If you did not use AFP Resource Installer, either the resource library does not contain a resource access table (RAT) or there is no entry for the CMR in the RAT, so RICOH ProcessDirector cannot find the CMR.
  4. Check the value of the Resource type property of the job and workflow. Make sure that the list of values includes the type of the missing resource.
  5. On Linux systems, if the resources that the job is trying to use are on a Windows file system, you might encounter problems because of the case of letters in the file name. Windows print drivers such as InfoPrint Manager for Windows can locate resource files without regard to case in the file name. Linux system is case-sensitive. RICOH ProcessDirector might look for a file named myoverlay but it is stored in Windows as MyOverlay, so RICOH ProcessDirector cannot find it. You must correct either the reference in the input file or the file name of the resource so the case matches.
  6. On Linux systems, if the message comes from the AFP file viewer, check that the RICOH ProcessDirector system user (aiw1 is the default) and the RICOH ProcessDirector group (aiwgrp1 is the default) have read permission for the resource and for the directory that the resource is in.
    Note:
  • The viewer component cannot access resources stored in directories that have international characters, including double-byte characters, in their directory path names. If you store resources in directories that have accented or any other international characters in their directory paths, the viewer substitutes other characters for display purposes. The job might print correctly, even if it does not display correctly.
  • To display the job using the correct resources, move the resources to a directory that does not have international characters in its path, or rename the existing directory to remove all international characters.

1.2.9.1.1.8.3 Errors in barcodes that include job properties

You can use AFP Editor to create barcodes, including barcodes that contain property values. However, some of the properties presented in the list in AFP Editor might not have values when the EditAFP step runs. If a property does not have a value when the EditAFP step runs, the barcode is created with no value for that property; spaces or blanks are not substituted for the empty value. If the property value is the only element in the barcode and the value is empty, no barcode is created.

1.2.9.1.1.9 Printer does not stop

On a Linux system, if you cannot stop a printer from the RICOH ProcessDirector user interface, check the permissions of the /etc directory and the files in it.

The RICOH ProcessDirector system user (aiw1 is the default) must have execute permission for the /etc directory and read permission for network control files, specifically, /etc/protocols. By default, the /etc/protocols file is installed with permissions of 644. If read permission for other users is removed, RICOH ProcessDirector cannot stop printers.

1.2.9.1.1.10 Finishing jobs

These topics describe problems with finishing options and with job output.

1.2.9.1.1.10.1 Job is punched or stapled incorrectly

When you specify options for job finishing, the output might not be what you requested. These are possible reasons.
  • Available punching and stapling options vary from printer to printer. You can configure some RICOH ProcessDirector printers to be punch-capable or staple-capable, but you cannot configure their finishing patterns for punching or stapling. Therefore, RICOH ProcessDirector might schedule a job to a printer that does not support the punch or staple patterns that you requested. When this happens, the printer applies its best equivalent punch or staple pattern.
  • Inline form definitions override the Punch and Staple job properties. If you use an inline form definition for an AFP job, you must specify finishing options there.
  • Stapling values for page exceptions replace stapling instructions for a job.
  • Stapling values for page exceptions are only applied by PDF jobs with JDF job tickets sent to Ricoh PDF printers or Passthrough printers that can read JDF.
  • For a Custom PDF printer, the custom printer definition file sets the values of printer properties. Check with your Ricoh support representative to make sure that the file is correct.

To view and update the appropriate properties:

  1. Right-click the job and select Properties.
    1. Make sure the Punch property on the Scheduling tab is set correctly.
    2. Make sure the Stapling required property on the Scheduling tab is set correctly.

      If it is not, check the Staple property for the job and the stapling requested by any page exceptions. Update them as needed.

  2. You might need to examine the method you used to submit the job and the options it provides for specifying finishing properties. The finishing properties might not have been submitted correctly in the job ticket.
  3. If the job had a Punch or Staple value, check the job log to see if the value changed after you submitted it.
    1. Right-click the job and select View log.
    2. Set the log to show property changes and search for Punch or Staple.
  4. Look at the banner page or the job log to get the name of the printer that printed the job.
  5. In the Printers portlet on the Main page, select the printer that printed the job and click Properties. On the Scheduling tab, check whether the printer can punch or staple.
  6. For page exceptions, make sure that your printer supports page exception stapling. Not all printers that support job stapling support page exception stapling. Refer to your printer operation manual.
    Note: If a Ricoh PDF printer does not support page exception stapling, it staples jobs that require job stapling only when the Merge banner pages into PDF print file property on the Banner Pages tab is set to No. If the property is set to Yes, the printer does not staple the job.

1.2.9.1.1.10.2 Job is not rotated

To print a job on media that is wider than it is long, you must specify the rotation in the form definition used for the job.

To specify finishing options for a rotated job, you must also specify them in the form definition. Do not use the Punch and Staple job properties.

  • If the form definition is external, the Punch and Staple job properties cause a new form definition to be created. The new form definition overrides the existing external form definition, so the rotation from the existing form definition is ignored.
  • If the form definition is inline, it overrides the Punch and Staple job properties.

1.2.9.1.1.10.3 External form definition is ignored

External form definitions are ignored when the job specifies finishing options.

To process the job properties that specify the finishing options Punch and Staple, RICOH ProcessDirector creates a new external form definition. This new form definition completely replaces any other external form definition. To combine the options from the form definition with finishing options, you must either:

  • Set job properties that are equivalent to the form definition options.
  • Add finishing options to the form definition and set the Punch and Staple properties to Not Set.

1.2.9.1.1.11 Viewing jobs

These topics describe problems with viewing jobs.

1.2.9.1.1.11.1 Font errors when viewing AFP jobs

If you open a file in the viewer and see a message that a code page, character set, or coded font is not defined, you might want to update the font configuration files that the viewer uses to identify the custom fonts that the installation uses.

When you view an AFP file in RICOH ProcessDirector, the file viewer converts the file to be displayed. In the process, it looks for the AFP fonts that the file uses in these places:

  1. Inline with the job
  2. In the directories specified by the AFP resource path job property, if the AFP Support feature is installed
  3. In /aiw/aiw1/resources
  4. In /usr/lpp/psf/reslib
If it does not find the fonts, it maps them to viewable fonts. The default font configuration files provide mappings for IBM fonts, but if the job contains custom fonts that are not available to the viewer or listed in the configuration files, errors occur. If the file viewer does not find the font in the configuration files, it substitutes the font and code page specified in the DEFAULT sections of two of the font configuration files (cpderedhat7_6_vers_shortf.fnt and csdef.fnt). When those files are installed, the font listed in the DEFAULT section is Times New Roman, 8-point and the code page is EBCDIC 500, although they can be changed. The content of the AFP file is not changed, but the displayed version might not look the same as the printed version. If the code page or the font is not defined in the configuration files and it is not an EBCDIC code page, the file viewer displays unreadable text.

To view the job using the correct fonts, add your custom font information to the font configuration files. Write down the character sets, code pages, and coded fonts that the error messages reported as missing so you have them to refer to while you edit the files.

    Note:
  • The viewer component cannot access resources stored in directories that have international characters, including double-byte characters, in their directory path names. If you store resources in directories that have accented or any other international characters in their directory paths, the viewer substitutes other characters for display purposes. The job might print correctly, even if it does not display correctly.
  • To display the job using the correct resources, move the resources to a directory that does not have international characters in its path, or rename the existing directory to remove all international characters.

1.2.9.1.1.11.2 AFP Viewer does not display barcode

If you view an AFP file that contains a barcode, but you cannot see the barcode, the problem might be the way the barcode was created.

If you create a barcode by specifying a barcode font to map a Presentation Text Data (PTX) structured field, the AFP Viewer cannot display the barcode because there is no Type 1 font to map the barcode font to. To create viewable barcodes, compose the data in the Bar Code Object Content Architecture (BCOCA).

1.2.9.1.1.11.3 Incorrect page displayed in viewer

The viewer can display pages in an unexpected order after a step that changes the order of pages in the job runs.

If the job has been processed by the ReverseOutputOrder or ReversePDFPageOrder step, the last page of the job displays as the first page.

If one or more document processing features are installed, document properties are mapped to pages when the IdentifyDocuments, IdentifyPDFDocuments, BuildAFPFromDocuments, and BuildPDFFromDocuments steps process the job. If the order of pages in the job changes after those steps, the document properties are still mapped to the page numbers in the original job. Searching using a document property returns the page in the original jobs, which might not be the page expected. To correct the problem, place all steps that alter a PDF file before the IdentifyPDFDocuments step. Place all steps that alter an AFP file before the IdentifyDocuments step.

1.2.9.1.1.11.4 AFP viewer does not display changes specified in medium map

A medium map is a print control resource object that contains the print control parameters for presenting pages on a physical medium and for generating copies of the physical medium. For example, a medium map specifies medium overlays, finishing, rendering intent, and page modifications. If you view an AFP file that contains a medium map, but you cannot see the changes specified in the medium map, the problem might be the way the AFP file was created or modified.

If you use the afpreorder utility to create or modify an AFP file, it might insert medium maps between pages. The AFP viewer does not apply these medium maps.

If you have the Preprinted Forms Replacement feature, the CombineAFPWithForm step turns on the Constant Back flag when a media object includes an electronic form for the back side and the medium map specifies simplex printing. Those constant back pages are not displayed in the viewer.

1.2.9.1.1.11.5 Hidden text is being displayed instead of hidden in AFP viewer

If you open a file in the viewer and see text that should be hidden, you might need to edit the configuration file for the viewer component and change the value of the GOCA_PASS1 parameter to 2.

The GOCA_PASS1 parameter specifies whether or not text supersedes graphics such as hidden areas or cover blocks. The default value of GOCA_PASS1 is 2.

To change GOCA_PASS1:

  1. Navigate to the /opt/infoprint/ippd/afpviewer/ directory.
  2. Open the a2pxopts.cfg file.
  3. Change the value of GOCA_PASS1 at the bottom of the file.

GOCA_PASS1 = 1
Text supersedes graphics such as hidden areas. Set GOCA_PASS1 to 1 if you have text added by Whitespace Manager.
GOCA_PASS1 = 2
Graphics such as hidden areas supersede text. Set GOCA_PASS1 to 2 if you have hidden text.

1.2.9.1.1.11.6 Text in AFP jobs is not highlighted in search results

If the search in the Viewer does not highlight a word or phrase in an AFP job, do one of these for the AFP file and all required resources:
  • Set the Unicode scalar value in the Code Page Control (CPC) and Code Page Index (CPI) structured fields for every AFP code page.
  • Set the Graphic Character Global ID from the CPC and CPI structured fields for every AFP code page used. The Graphic Character Global ID must be set in accordance with the IBM Naming Convention regarding the Graphic Character Global Identifier.

1.2.9.1.1.11.7 Text in a Whitespace area is not displayed in AFP viewer

If you open a file in the viewer and text from Whitespace Manager is not displayed, you might need to edit the configuration file for the viewer component and change the value of the GOCA_PASS1 parameter to 1.

The GOCA_PASS1 parameter specifies whether or not text supersedes graphics such as hidden areas or cover blocks. The default value of GOCA_PASS1 is 2.

To change GOCA_PASS1:

  1. Navigate to the /opt/infoprint/ippd/afpviewer/ directory.
  2. Open the a2pxopts.cfg file.
  3. Change the value of GOCA_PASS1 at the bottom of the file.

GOCA_PASS1 = 1
Text supersedes graphics such as hidden areas. Set GOCA_PASS1 to 1 if you have text added by Whitespace Manager.
GOCA_PASS1 = 2
Graphics such as hidden areas supersede text. Set GOCA_PASS1 to 2 if you have hidden text.

1.2.9.1.1.11.8 Images in a Whitespace area are not displayed in AFP Viewer

If you open a file in the AFP viewer and images from Whitespace Manager are not displayed, verify that the images meet specific requirements.
Whitespace Manager only supports GIF, JPEG, and Page segments as image formats. Other types of images, such as TIFF or PNG are not supported.

In addition, images must use an RGB color space. If your images use a CMYK color space, convert them to RGB.

1.2.9.1.1.11.9 Fixing unreadable entries in the viewer

If you see entries such as @@--@@ instead of meaningful text for the index groups and tags in the file viewer, it is likely that the indexing in that file was created on a host system, not in RICOH ProcessDirector.

When the indexing is done on a host system, the text in the index tags is created in EBCDIC. The viewer tries to display that text as ASCII text.

To fix the problem:

  1. Open the properties notebook for the job and click the AFP tab.
  2. Set the Code page global identifier to 500.
  3. Click OK.
  4. In the Jobs table on the Main page, select the job.
  5. Click Process Again and restart the job at the ConvertLineDataJobIntoAFP or EnableRepositioning steps, whichever comes first in the workflow.
  6. After that step has completed processing the job, open the file viewer and select the tags; the unreadable entries should be gone.

1.2.9.1.1.12 DB2 database errors

Errors in the job log can refer to a timeout or a deadlock in DB2.

If you see an error of this kind, use the Process Again action to try to restart the job from the last step shown on the Process Again dialog.

1.2.9.1.1.13 Slow performance

If you notice that printing, transferring files, or doing actions in the user interface takes longer than it should, these changes might improve performance.
  • On your Ethernet adapter, set up full duplex and turn off autonegotiation. RICOH ProcessDirector for Linux: Planning and Installing, G550-1042, provides information about using YaST to change these settings.
  • Distribute the I/O activity across multiple file systems to improve throughput.

1.2.9.1.1.14 Problems caused by antivirus software

Programs that scan and lock files, such as antivirus products, often cause installation and performance problems.
In some situations, antivirus software has caused RICOH ProcessDirector to:
  • Fail to install.
  • Fail when running a step.
  • Experience degraded performance.
  • Block network traffic on some ports.

You may need to exclude some directories from scanning in order to avoid these consequences.

Directories to exclude are:
  • /aiw/aiw1/
  • /home/aiwinst/sqllib
  • /opt/infoprint/ippd/db
  • /var/lib/docker
If you experience any of these symptoms while running RICOH ProcessDirector on a server with antivirus software installed, contact your Ricoh support representative.

1.2.9.1.1.15 Reducing file size

If your file systems are becoming too full, you can reduce the information that some steps save in workflows to conserve space.

Each step in a workflow has a Step restart type property, which is used to specify if you can use the Process again action to restart processing of a job at that step. When the Step restart type is set to a value other than None, Delete, or Reformat, a copy of the input file is saved to the checkpoints directory for the job before the step runs. The default Step restart type for most steps is General, which saves copies of the input file.

To prevent saving the input file for a step:

  1. Go to a step in your workflow.
  2. Change the value for Step restart type to None.

If you change the Step restart type to None for a step, you will not be able to use the Process again action to restart at that step. You will need to select a step that runs before this one to restart the job.

1.2.9.1.1.16 Networking and connecting

These topics describe problems with networking and connectivity.

1.2.9.1.1.16.1 Host name does not match the IP address

If you see a message that begins: The host name in /aiw/aiw1/config/servers.cfg does not match the IP address of the system, the host name or IP address of the primary computer has changed. You must update RICOH ProcessDirector to recognize the change.

To update RICOH ProcessDirector:

  1. Log in to the primary computer as root.
  2. Run the changeHostname.pl command as in the example:/opt/infoprint/ippd/bin/changeHostname.ploldhostname

1.2.9.1.1.16.2 Network connection drops

If the network connection between the primary computer and an application/secondary computer drops because of network problems, the server automatically tries to reconnect with the primary server every 30 seconds, until it is able to connect or until the server stops.

1.2.9.1.1.16.3 SNMP connection with a printer cannot be established

If RICOH ProcessDirector cannot connect to a printer using SNMP, check these settings.
  • The Community name property of the printer must match the SNMP community name set at the physical printer.
  • For a Passthrough or PCLOut printer, the Printer TCP/IP address or host name property must be set.

1.2.9.1.1.16.4 Application server does not connect

If you have an application server that does not connect and that shows as disconnected at the primary server, you can check certain configuration files on both the primary computer and the Windows system.

To determine why the application server does not connect:

  1. Do these steps on the primary computer:
    1. Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
    2. Navigate to /aiw/aiw1/config.
    3. Verify the host= value in the communications.cfg file. If you are not sure that your network accepts short names, use the fully qualified host name of the primary computer. For example, host=myhost.boulder.co.com. Use a text editor, such as vi, and update the entry if necessary.
  2. Verify the settings for the application server in the RICOH ProcessDirector user interface:
    1. Click the Administration tab.
    2. In the left pane, click Objects Servers.
    3. Verify that the value in the Computer IP address or host name column for the application server lists the correct IP or host name.
  3. Check the NFS connections for the primary computer and the application server.
    1. Log in to the Windows system with the user ID that the application server runs under.
    2. Open a command prompt and type this command:
      net use
      The results should show the shared drives on the computer. You should see the drive letter you chose when you installed the application server, the primary computer (listed as the Remote system), and the status of the connection.

      If you do not see the drive letter or if the status is listed as Unavailable, skip to step 5 to try to restore the connection.

    3. At the command prompt, type this command, replacing primary_server with the hostname or IP address of the primary computer:
      showmount -e primary_server
      The results should indicate that the application server is mounted to the primary computer. If it is not mounted, repeat the procedure for configuring NFS.
  4. If the primary computer has a mapped drive and is mounted, but is still not connected to RICOH ProcessDirector, make sure that the user ID has read and write permission to the mounted directory.
    1. At a command prompt, type the drive letter for the drive that the application server uses.
      For example, type: Z:
    2. Type these commands to create and delete a file in that directory:
      cd /aiw1
      echo. > file
      del file
      If any of those commands fails, the user does not have the correct permission for the directory. Try to restore the connection with the correct permissions.
  5. Stop the application server and reboot the Windows computer. Then, start the application server.
  6. After the application server starts, access the servers table using the RICOH ProcessDirector user interface:
    1. Click the Administration tab.
    2. In the left pane, click Objects Servers.
    3. Verify that the value in the Connection status column for the server is Connected.
  7. If the value is not Connected, stop and start the primary server and repeat the previous step to check the application server status.

1.2.9.1.1.16.5 Reports database connection issues

If RICOH ProcessDirector or the business intelligence tool cannot connect to the Reports database, consider the following troubleshooting suggestions.

  • Make sure that data collection is enabled.
  • If you have changed any values on the Database Settings page, make sure that the values in the Reports database are updated to match. RICOH ProcessDirector does not send those changes to the database. You must update the settings using a PostgreSQL tool outside of RICOH ProcessDirector.
  • If you have updated any settings in the Reports database, make sure that values on the Database Settings page are updated accordingly.
  • Make sure that the pg_hba.conf, and postgresql.conf files are set up correctly.
  • If the business intelligence tool is on a computer that has a dynamically allocated IP address, the connection might stop working when the IP address changes.

    For temporary troubleshooting purposes, set the IPV4 local connections to allow address 0.0.0.0/0. This setting allows all IP addresses to connect. If the business intelligence tool can connect with that setting, you can figure out which specific IP addresses need to be added to the allowed list in pg_hba.conf.

  • Verify that the Reports database is listening on the designated port. By default, the database uses port 5432, though it might have been changed in the Database Settings.

    To determine whether the database is listening on the port:

    1. Open a command line and type: netstat -an

      A list of open ports is displayed.

    2. Check the list for the port specified on the Database Settings page.

    If the database is not listening on the port, stop and restart the PostgreSQL database. The sample commands listed below use the default values from the Database Settings for the user name, password, and port number. If you changed any of those values, use your values in the command.

    1. Stop the database:
      • On a Windows server:

        • \aiw\aiw1\bin\postgresql\Windows\pgsql\bin\pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

          or

        • <RPD Install Directory>\PostgreSQL\bin\pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

      • On a Linux server:

        • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

          or

        • /usr/pgsql-14/bin/pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

    2. Start the database:
      • On a Windows server:

        • \aiw\aiw1\bin\postgresql\Windows\pgsql\bin\pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

          or

        • <RPD Install Directory>\PostgreSQL\bin\pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

          Note:
        • On Windows, running the database command can be unreliable. To see whether the database started, log in to RICOH ProcessDirector and click the Administration tab. Open Reports Database Settings.

          If the page reports that the database is connected, the command worked correctly. If the page reports that the database is not connected, click the switch to enable data collection. RICOH ProcessDirector starts the database for you.

      • On a Linux server:
        • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

          or

        • /usr/pgsql-14/bin/pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

  • If the database is listening on the port, but the business intelligence tool does not connect:
    • Check for firewalls or other network issues.
    • If no other network issues exist, reboot the server that holds the database.

1.2.9.1.1.17 Emails are not sent or received

An email might not have been sent from the system or received by the recipient if your email provider blocked the message, the recipient email address is incorrect, an attached file is too large, or if the SMTP settings are incorrect.
  • First, check with your email administrator to make sure the system is running correctly. Verify that no settings have changed recently. Then check your SMTP settings in RICOH ProcessDirector.
    Check your SMTP settings for the SMTP server your step uses:
    • Make sure the SMTP server or Alternate SMTP server field has the correct server address listed.
    • Make sure the SMTP port or Alternate SMTP port field has the correct port number listed and check with your network administrator to make sure this port is not blocked by any firewalls.
    • Make sure the SMTP user name or Alternate SMTP user name and the SMTP password or Alternate SMTP password fields contain the correct SMTP user name and password combination.
    • If your default or alternate SMTP server uses network security, check your default or alternate SMTP server settings to see if the server uses SSL or TLS protocols. If it uses either one of these protocols, make sure only the corresponding field, Email SSL port/Alternate email SSL port or Email TLS port/Alternate email TLS port, is used. If you are not using either of these technologies, do not use either of these fields.
  • Check the size of the file sent to the recipient. If a file is too large, your email provider or the recipient’s email provider might block the message. If the file is too large, you might need to split it into segments or mail it on removable media.
      Note:
    • The common maximum email size limit is 25Mb, though this value can be different for each provider.
  • Make sure the job reached the step that sends email. The job might:
    • Go to the Error state before reaching the step that sends email.
    • Follow an incorrect path through a conditional workflow and never reach the step that was supposed to send the email. In this case, correct the logic that sent the job through the incorrect branch.

1.2.9.1.1.18 Encrypted PDF file cannot be opened

If the encrypted PDF file generated by the EncryptPDF step cannot be opened, the password is probably incorrect.

Check with the recipient and make sure the password they used matches the password entered in the EncryptPDF step. Provide the recipient with the correct password if the passwords do not match.

If they did not use a password to open the file, but need one to do additional tasks, provide the Owner password.

1.2.9.1.1.19 Encrypted PDF file cannot be edited

If the recipient states that they can open the file but cannot fill in fields or make changes to the file, provide the correct password for the file.

Find out what password the customer used to open the file. If they used the User password, they have read-only permission to the file. You must provide the Owner password to permit editing the file, including filling in forms.

If they did not use a password to open the file, but need one to do additional tasks, provide the Owner password.

1.2.9.1.1.20 Cannot access Acrobat Plug-in after successful installation

Even if you successfully install the RICOH ProcessDirector Plug-in for Adobe Acrobat, sometimes you cannot see the Ricoh menu when opening Adobe Acrobat. This behavior may be related to your installed Acrobat version and the default values for some settings.
To resolve the issue, open Adobe Acrobat and try these steps:
  1. If you are using the new Adobe Acrobat experience (introduced in May 2023), there is no longer a Ricoh menu at the top of the screen. To find the Ricoh menu, click Menu Plug-ins.
    You should see Ricoh as a sub menu. If it is not visible, continue with the next step.
  2. Open the Preferences dialog:
    • In the traditional view, click Edit Preferences.
    • In the new Adobe Acrobat experience, select Menu Preferences.
  3. Select the General category.
  4. In the Application Startup section, make sure that Use only certified plug-ins is not selected.
  5. Select the Security (Enhanced) category.
  6. In the Sandbox Protections section, you might see an option called Enable Protected mode at startup. Make sure this option is not selected.
  7. Click OK.
  8. You might have to restart Adobe Acrobat to see the Ricoh menu.
If you continue to encounter problems, contact a Ricoh Support representative.

1.2.9.1.1.21 Fields in the RICOH ProcessDirector Plug-in for Adobe Acrobat cut off values

Monitors with a very high resolution and certain display settings can cause problems in the way information is displayed.
To change the way entry fields are displayed in the RICOH ProcessDirector Plug-in for Adobe Acrobat:
  1. Right-click the Desktop and select Display settings.
  2. Under Scale and layout, change the Change the size of text, apps, and other items value to 100%.
  3. Restart the computer for the change to take effect.
      Note:
    • If this change makes the fields too small to use, try changing the Resolution value.

1.2.9.1.1.22 The Wait step finishes at the incorrect time

If the workflow includes a Wait step and the job finishes earlier than expected or later than expected, then your Wait step might be set up incorrectly.
  • If the job starts processing again after a Wait step at the wrong time, check the following in the workflow:
    • The Wait until property

      Make sure the Wait until property has the correct time set. If your country uses the 12–hour time format, make sure either AM or PM is correctly chosen. This property is only used if you are pausing a job until a certain time of day.

    • The Time zone property

      Make sure that the time zone chosen on the Wait step matches the time zone that the primary server uses. This property is only used if you have specified a value for the Wait until property.

    • The Wait for property

      Make sure the length of time entered in the Wait for property is correct and matches the chosen unit of time. This property is used if you are pausing a job for an interval of time.

    • The Complete step after property

      Make sure the value chosen for Complete step after is correct.

      For example, a workflow contains a Wait step with these settings:

      • Wait until: 12:00 PM
      • Time zone: Eastern Standard Time (EST)
      • Wait for: 3 hours

      A job reaches that step at 10:00 AM EST. The step determines that the two possible end times are:

      • Wait until: 12:00 PM EST
      • Wait for: 3 hours (1:00 PM EST)

      If Complete step after is set to First occurs, the job moves to the next step at 12:00 EST. If Complete step after is set to Last occurs, the job moves to the next step at 1:00 PM EST.

    • The time on the RICOH ProcessDirector server

      Make sure the time and the time zone on the RICOH ProcessDirector server is set correctly. The Wait step acquires its time from the RICOH ProcessDirector server. If the system time or the time zone is incorrect, the Wait step might not complete at the correct time.

        Note:
      • Time is counted when RICOH ProcessDirector server is powered off. For example, a job arrives in the Wait step and is supposed to wait for one hour. The job waits for 30 minutes and the power to the server is interrupted. It takes 45 minutes for power to be restored and for RICOH ProcessDirector to start processing again. At that point, the job starts to process again, because the waiting period has ended.

1.2.9.1.1.23 SSL or TLS security not active

If you previously configured RICOH ProcessDirector to use SSL or TLS but notice that it is not currently active, you must reactivate it.

If you recently updated your installation, SSL or TLS might have been affected. SSL and TLS security settings are cleared in the Web server component when you install service updates or a new version of RICOH ProcessDirector. To correct the situation, follow the procedure for enabling SSL or TLS.

1.2.9.1.1.24 Notifications are not received

After an administrator creates a notification, one or more of the specified recipients does not receive an email.

Check both areas to find what is preventing email notifications from being received.

1.2.9.1.1.24.1 Problems with notification email configuration

A notification email might not be sent for one of these reasons:
  • The email address in the User information of a user is not specified or is specified incorrectly.
  • The recipient’s email provider marked the notification mail as spam.
  • The recipient’s email provider blocks zip files as attachments.
  • The total size of the attached files is greater than the size limit imposed by the recipient’s email provider.
  • Your email server is not configured to let RICOH ProcessDirector send emails.
  • RICOH ProcessDirector cannot log into the email server because the values on the Email/SMTP section of the System settings page are incorrect.

Check the email address specified for any users who did not receive an email.

If an email provider marked the notification email as spam, ask the user who needs to receive the email to mark the email as safe or not spam, or add the sender address to the list of approved addresses.

Make sure that the default SMTP server is working correctly. RICOH ProcessDirector sends notifications using the default SMTP server, not the alternate SMTP server. Verify that the system settings for your SMTP server are consistent with the values for the RICOH ProcessDirector default SMTP server on the Email/SMTP section of the System settings page.

    Note:
  • The alternate SMTP server cannot send notifications. It is not a backup for the default SMTP server.

Make sure that the notification object that is configured to send the email is enabled.

1.2.9.1.1.24.2 Problem with notification object configuration

A notification email might not be sent because the notification object does not contain the right email address, because the Conditions are not satisfied, because the Notification limit was reached, or because the notification object is disabled.
  • Check the Notification limit in the notification object. If messages were not sent because the limit was reached, a message is written in the log for the notification object.
  • Some properties can only use a subset of the Comparison values. For example, if you select the Current day as the property for the condition, you must use the = (equal to) or != (not equal to) comparisons. If you select the Current time as the property, you muse use the < (less than), > (greater than), <= (less than or equal to), or >= (greater than or equal to) comparisons.
  • Some combinations of properties and their values cannot be used to define a condition because the nature of the properties and when they are set. For example, it is impossible for the status of a job to change to Printing when the Current step is not a step based on the PrintJobs step template, because only that step sets that state.
  • Consider what steps in the workflow set the property you want to use for a condition so that jobs are likely to contain a value for the property at the time you specify. For example, if you want to use Current phase or Current step as a condition, make sure that the job property you specify for the event has a value when the job is in the phase or in the step you specify in the condition.

To edit an existing notification object:

  1. Click the Administration tab.
  2. In the left pane, click Objects Notifications.
  3. Click the name of notification object that you want to edit.
  4. In the General tab, make sure that the email addresses in the Recipient address, Copy address, and Blind copy address fields are correct.
  5. In the Event tab, make sure the events are defined correctly.
  6. In the Conditions tab, make sure the conditions are defined correctly and are not combined in a way that prevents the notification from being sent.
    The Comparison and Value for each condition must be valid.
  7. After you are done editing, click OK.
  8. Enable the notification object when you are ready for emails to be sent.

1.2.9.1.1.25 Emails with attached documents are not sent or received

An email with an attached document might not have been sent from the system or received by the recipient if your email provider blocked the message, the recipient email address is missing, an attached file is too large, or if the SMTP settings are incorrect.

  • Check to see how many of the emails for a given job were not sent. If none of the emails were sent, there is likely a problem with your email server. First, check with your email administrator to make sure the system is running correctly. Verify that no settings have changed recently. Then check your SMTP settings in RICOH ProcessDirector.

  • If you are sending thousands of emails to customers on a daily basis, your email provider or the recipient’s email provider might mark the email as spam or block the email altogether. To prevent this behavior, consider using a third party emailer who is certified to send bulk mail. Make sure you select an emailer with a high sender reputation and a high domain reputation

    .

    You can also consider certifying your company’s email. By certifying your emailing service, you are added to email whitelists to ensure delivery.

  • Make sure the document being sent has an email address associated with it. In RICOH ProcessDirector, look at the job log to see how many emails were sent and compare that number to the number of documents in the job. Then look in the document properties file, located in the job’s spool directory, to see if any email addresses were missing.

  • In the document properties file, check the document property that you are using to extract email address data from the documents in the job. For example, if you are using the Doc.EmailAddress document property, make sure it is populated with email addresses. If the property does not contain any email addresses, make sure:

    • You have correctly mapped the address information from the documents in the job.

    • The EmailDocuments step specifies the document property as the value of the Recipient address property. For example, the value might be ${Doc.EmailAddress}.

  • Check the size of the document sent to the recipient. If a document is too large, your email provider or the recipient’s email provider might block the message. If the document is too large, you might need to split it or mail a physical copy of the document.

    Note: The common maximum email size limit is 25Mb, though this value can be different for each provider.

1.2.9.1.1.26 Using web services

These topics describe some of the issues that can arise while using web service input devices, notifications, and steps.

1.2.9.1.1.26.1 A web service input device does not retrieve orders when expected

If REST or SOAP web service input devices do not retrieve orders when you expect them, check the time settings that control the exchange of data. You must adjust for differences between the time settings of the RICOH ProcessDirector server and the application that hosts the web service. RICOH ProcessDirector server time adjusted by the value of the Time zone offset property must equal the time used by the application that hosts the web service.

To check the time settings:

  1. Make sure that the system clock and time zone on the RICOH ProcessDirector primary server are set correctly.

    The RICOH ProcessDirector server uses Coordinated Universal Time (UTC). It computes UTC based on the date, time, and time zone settings for the operating system. If any of those values are not set correctly, the RICOH ProcessDirector server cannot compute UTC correctly. For example, the operating system is set to 4:00 AM Mountain Standard Time (MST) but the real time is 3:00 AM MST. The web service input device calls the web service to retrieve orders an hour earlier than you expect.

    Note: The date, time, and time zone settings for the operating system need not match a physical location as long as they are correct relative to UTC.

  2. Make sure that the value of the Time zone offset property on the Request tab of the input device is correct.

    This property specifies the offset in hours between UTC and the time zone used by the application hosting the web service called by the input device. If the application uses UTC (and the time settings for both the RICOH ProcessDirector server and the application are correct), no offset value is necessary. If the application uses another time zone, make sure that the value is set to the correct offset from UTC. For example, MST is seven hours behind UTC. If the application uses MST, make sure that the property is set to -7.

  3. Make sure that the system clock and time zone used by the application that hosts the web service are set correctly.

    If you cannot change a system clock or time zone that is set incorrectly, adjust the value of the Time zone offset property to compensate for the discrepancy.

    Note: If the application uses local time and changes between standard and daylight savings time, adjust the value of the Time zone offset property when the change occurs. Otherwise, you can lose the orders placed during the lost or gained hour. If the application uses local time and does not change between standard and daylight savings time, no adjustment is required.

1.2.9.1.1.27 RICOH ProcessDirector data does not appear in RICOH Supervisor

If RICOH Supervisor is not receiving information or data from a RICOH ProcessDirector system, check your connection settings, firewall settings, credential, or data transmission settings.
To check the RICOH Supervisor settings:
  1. Verify that the proxy settings are correct. If the settings are not correct, RICOH ProcessDirector cannot communicate to RICOH Supervisor.
    1. Go to Administration Settings RICOH Supervisor.
    2. Check if the RICOH Supervisor communication is configured to use a proxy server.
    3. If you use a proxy server, go to Administration Settings System and make sure that the selected proxy server is correctly configured.
  2. Make sure any firewalls or proxy settings that are in use on your network permit communication between RICOH ProcessDirector and RICOH Supervisor.
  3. Make sure that the Reports feature is configured correctly to collect data:
    1. Go to Administration Reports Database settings.
    2. Click the switch to enable Capture data.
    3. Click SAVE.
  4. Make sure that the data collectors are configured correctly to collect data:
    1. Go to Administration Reports Data collectors.
    2. Select the data collector you want to collect data.
    3. Click the switch to enable Capture data.
    4. Click OK.
  5. Make sure that the Ricoh cloud credential is not expired.
    1. Go to Administration Settings RICOH Supervisor.
    2. Check if there are any warnings on the Credential section.
      If the certificate is expired, obtain a new one-time code to generate a new certificate.
  6. Make sure that the RICOH Supervisor Data Transmitter is enabled:
    1. Go to Administration Reports Data transmitters.
    2. Check the data transmitters table to see if the RICOH Supervisor Data Transmitter is enabled.
  7. Check the RICOH Supervisor Data Transmitter schedule. Data is transmitted at the date and time set in the schedule.
  8. Allow an amount of time for recent data to display on a dashboard. The most recently transmitted data needs time to appear on a dashboard and is based on several factors, including the amount of data. It can take as much as 20 minutes.

1.2.9.1.1.28 RICOH ProcessDirector data displayed in RICOH Supervisor is in a wrong time zone

The data transmitted by RICOH ProcessDirector and displayed in RICOH Supervisor is in a different time zone.
RICOH ProcessDirector collects data and sends it to RICOH Supervisor using the primary server time zone. If you are in a different time zone than the RICOH ProcessDirector primary server, you want the data sent to RICOH Supervisor be displayed in your current time zone.

To select a different time zone for receiving the data in RICOH Supervisor:

  1. Go to Administration Settings RICOH Supervisor.
  2. Go to Convert times to time zone and select your current time zone.
    The data transmitted to RICOH Supervisor is displayed in the currently selected time zone.
  3. Click Save settings.

1.2.9.1.1.29 Problems with Archive

These topics describe some of the issues that might arise while using the Archive feature.

1.2.9.1.1.29.1 Improving performance of your search

If your search performance is too slow, you can optimize your search or the search configuration for faster and more accurate results. By adjusting the search values, parameters, and configuration file, you can reduce the time it takes for search results to return.

When you search a repository, specify as many of the search criteria values as possible. Specifying multiple values reduces the amount of data to be searched which reduces the time needed to complete the search. Additionally, you can optimize the repository configuration to match your server specifications for faster results.

To improve the performance of your search:

  • If you know what repository the data is likely to be in, select that repository rather than the choice to search All repositories.
  • Reduce the Number of results to return the smallest number of results that is likely to meet your needs because the search stops when this number is reached. Because the search stops when this number is reached, you get some results faster than if you wait for the entire repository to be searched.
  • Tune the repository configuration file, repository.cfg, for search and storage performance based on your server setup.

1.2.9.1.1.29.2 Cannot find items in the repository

If you cannot find the data items you expected to find in the repository, there are several possible solutions you can try.
  • If you have multiple repositories defined, be sure that you have selected the correct one for your search.
  • Check the value for Number of results. The search function stops after finding the specified number of results. You might want to use a higher value to accommodate a broader search. The maximum value of Number of results is 999, so if your search options match 1000 or more entries, only 999 are returned. Narrow your search.
  • Check your search options for the proper logical combination (Any means OR, All means AND), especially if you have used the Custom option.
  • If you use like and unlike in the Comparison field, make sure that the wildcard characters are used correctly. Also, you cannot use wildcards with numeric fields, only with character strings.
  • If you are searching for a number, be aware that some properties that appear to have numerical values are stored as text strings. As a result, comparisons might behave differently than expected. For example, 999 in a numerical expression is less than 98765, but as a text string 999 is greater than 98765.
  • If the Value is numeric or is a date or timestamp, make sure that the Comparison is less than or greater than.
  • Check the retention period on your repository. If the job or job containing the document is older than the retention period, it has been deleted from the repository.
  • Make sure that you are searching for the correct job or document properties. You must use at least one document property to find a specific document.
  • Check the properties of the StoreInRepository step in the workflow that was used to write the job into the repository to confirm that you are searching for a job or document property that was retained with the job.
  • Check the status of the job or job that contains the document you are searching for. If the job stopped before reaching the StoreInRepository step, your document is not yet available in the repository.
  • Check the workflow used to process the job to make sure the StoreInRepository step is included. Additionally, if the workflow used to process the job has branches, check to see that the job did not flow into a branch that is missing the StoreInRepository step.

1.2.9.1.1.29.3 Cannot find history information in the repository

If you cannot find the history information you expected to find in the repository, there are several possible solutions you can try.
  • Make sure that your history record notification object is correctly set up.
  • Make sure that the history record notification is enabled.
  • Make sure the conditions are defined correctly.

    For example, you can use the Current step property to limit the steps that cause history records to be written. RICOH ProcessDirector compares value entered for the Current step condition to the Step identifier value, not to the Step name. Often the values for these two properties are identical, but sometimes the step identifier is the step name with a number added to the end.

    As a result, we recommend using a wildcard value with the Current step property. For example, to write a history record whenever an event occurs during a Wait step, use this condition:

    Current step like Wait*
  • Check to see that the Store history records property in the StoreInRepository step is set to Yes.

If you find history information but not a specific history record you were expecting, make sure you selected the correct result from the Results portlet on the Archive tab. Each StoreInRepository step that processes a job produces a separate entry in the repository so a search might return multiple results. The history information is cumulative, but if you select the result from a StoreInRepository step early in the workflow, it does not have the history information about a step that occurred later in the workflow. You might want to use the Archive entry type property on the StoreInRepository step to give you a way to search for the different entries written to the repository for the same job or document.

If everything is set up correctly, check the general reasons for items not being found in a repository.

1.2.9.1.1.30 Problems with Avanti Slingshot Connect

These topics describe some of the issues that may arise while using the Avanti Slingshot Connect feature.

1.2.9.1.1.30.1 The system is not receiving information from Avanti Slingshot

When RICOH ProcessDirector is not receiving information or data from Avanti Slingshot, check your system setup, firewall settings, or job settings.
To check your Avanti Slingshot settings:
    Note:
  • For a typical implementation of Slingshot, you do these steps to exchange information with RICOH ProcessDirector. Your implementation of Slingshot can have steps that differ from these steps.
  1. Verify that the Avanti URL is correct. If it is not correct, RICOH ProcessDirector cannot communicate to Avanti Slingshot.
    1. Log in to RICOH ProcessDirector.
    2. Navigate to Administration Settings Avanti Slingshot.
    3. Note the Avanti URL.
    4. Log in to Avanti Slingshot.
    5. Navigate to System Setup General and double-click JDF type.
    6. Select the Connection Options tab.
    7. Verify that the Avanti URL in RICOH ProcessDirector and the JMF Return HTTP URL in Avanti Slingshot are the same. If they are not, update the Avanti URL to match the JMF Return HTTP URL.
        Important:
      • If you change the Avanti Slingshot client password, you must update the JMF Return HTTP URL with the new password and copy the JMF Return HTTP URL into the Avanti URL field in RICOH ProcessDirector. For example, if you updated your password to MyPassword, and your current URL is http://AvantiServer:8081/servoy-service/rest_ws/avanti_jdf/jmf_inbound_processing/params?Username=UserName&Password=password, change Password=password at the end of the URL to Password=MyPassword.
  2. Make sure any firewalls that are in use on your network permit communication between RICOH ProcessDirector and Avanti Slingshot.
  3. Make sure that the JDF Type has been correctly configured. If the following settings are not correct, problems can occur when Avanti Slingshot tries to send the required information to RICOH ProcessDirector:
    • The JDF Type must have Use Combined JDF Format selected.
    • All the JMF Messages options should be selected.
    • If Slingshot sends PDF files with sales orders, one or more PDF files must be attached to the JDF Type.

      If Slingshot puts a link to PDF files in the JDF job ticket, make sure that the link is correct. Make sure that the files are in the specified directory and that the RICOH ProcessDirector system user has authority to read them. The default system user is aiw1.

    • Make sure that each Line Item in a Slingshot sales order has a matching hot folder input device in RICOH ProcessDirector. Make sure that the Batching method property for the hot folder is set to JDF. Make sure that the input device is enabled and connected.

1.2.9.1.1.30.2 The system cannot find a data file for a job received from Avanti Slingshot

If a job exported from Avanti Slingshot goes into an error state and you see message AIWI6126E, RICOH ProcessDirector did not receive a valid PDF file with the JDF job ticket from Slingshot.

To identify and correct the problem:

  1. In Slingshot:
    1. On the sales order, make sure that you created the Line Items correctly.

      • If Slingshot sends PDF files with sales orders, make sure that you attached at least one PDF file to the Documents tab for each Line Item.
      • If Slingshot puts a link to PDF files in the JDF job ticket, make sure that the link is correct. Make sure that the files are in the specified directory and that the RICOH ProcessDirector system user has authority to read them. The default system user is aiw1.

    2. On the job, make sure that the Description on the Sections tab specifies the name of the RICOH ProcessDirector hot folder that receives the job from Slingshot.
    3. If you find a problem on the sales order or job, create a new sales order. Release it for processing, and export the job to RICOH ProcessDirector.
  2. In RICOH ProcessDirector:
    1. Make sure that you set up a hot folder with the same name as the Line Item on the Slingshot sales order.
    2. If a hot folder does not have the same name, set up a new hot folder.

1.2.9.1.1.30.3 Avanti Slingshot does not create orders for jobs in RICOH ProcessDirector

When Avanti Slingshot does not create orders for jobs in RICOH ProcessDirector, your CreateOrderInSlingshot step, proxy server (if any), or Slingshot system is not set up correctly.
To fix the problem:
  • If jobs in the CreateOrderInSlingshot step are in the Error state, check the messages in the job log.
    • If a message states that a general error has occurred and if your environment requires a proxy server to communicate with Slingshot:

      1. Check the values for the proxy server properties on the Proxy server tab of the System Settings page.

      2. Check the value of the Use proxy property for the step.

    • If the proxy server settings are correct or your environment does not use a proxy server, check the value of the Request URL property for the step.

      Confirm with your Avanti support representative that the value is correct.

    • If a message states that the Slingshot web service returned a 500 error, check the SenderID, Username, and Password parameters in the value for the Request parameters property.

      Confirm with your Avanti support representative that the parameters in the value are correct.

      Other problems also cause the web service to return a 500 error.

    • If a message states that the Slingshot web service returned a 400 error:

      • Check the Slingshot integration log for messages that explain why Slingshot did not process the request from RICOH ProcessDirector.

      • Check the file containing the XML order information that RICOH ProcessDirector sends to Slingshot.

        Confirm with your Avanti support representative that the request values and XML format match the requirements of the Slingshot web service. Confirm with your RICOH ProcessDirector support representative that the XML works with RICOH ProcessDirector.

      • Make sure that the Request payload property specifies the full directory path and name of the file containing the XML order information.

      Other problems also cause the web service to return a 400 error.

  • If the CreateOrderInSlingshot step processes jobs without errors but Slingshot does not create orders, ask your Ricoh support representative to check the configuration of your Slingshot system.

1.2.9.1.1.30.4 Avanti Slingshot is not receiving job information from RICOH ProcessDirector

When Avanti Slingshot is not receiving job information or data from RICOH ProcessDirector, you might need to check your system setup between RICOH ProcessDirector and Avanti Slingshot.
Check your system settings:
  • Make sure the Avanti Slingshot configuration file (avanti.cfg) is correct.
    • Open the Avanti Slingshot configuration file in a text editor and verify the file is correctly formatted. Each cost center must be on its own line in the configuration file.
    • Make sure the cost centers in the .cfg file match the External Device IDs in Avanti Slingshot. The cost center values are case-sensitive.
  • Make sure the steps whose job information is being sent to Avanti Slingshot are correctly defined in the RICOH ProcessDirector workflow.
    • Make sure each step has the appropriate cost center selected for the Slingshot cost center property.

    • Make sure the Slingshot milestone status property is correctly defined. The last step sending information to Avanti must have Complete as the milestone status. If there are two or more steps for the same cost center, the first step must have In Progress as the milestone status.
    • Make sure the step with the Complete milestone status has the same cost center defined as the step with the In Progress milestone status.
  • If you are sending job information to Slingshot from a RICOH ProcessDirector printer, make sure the printer has the appropriate cost center selected for the Slingshot cost center property.

1.2.9.1.1.30.5 Slingshot costs are incorrect

If Slingshot costs and milestones based on information received from RICOH ProcessDirector are incorrect, the Slingshot cost center and Slingshot Milestone status properties might not be set up correctly.

Check these items:

  • In the workflow, make sure the Slingshot cost center and Slingshot Milestone status properties are correctly set on the steps.

    • Make sure the correct cost center is associated with the Slingshot cost center property.

    • Make sure that a job goes through one step with a Slingshot milestone status property value of Complete for each Slingshot cost center that you want to report information to.

    • The first step that reports information to a Slingshot cost center should have a Slingshot milestone status property value of In progress. The last step that reports information to a cost center should have a value of Complete. If only one step reports information to a cost center, the step should have a value of Complete.

  • Make sure the cost centers are correctly defined in the Avanti Slingshot configuration file (avanti.cfg). The cost centers in the configuration file must match the External Device IDs defined for cost centers in Avanti Slingshot. The cost center values are case-sensitive.
  • If you are sending job information to Slingshot from a RICOH ProcessDirector printer, make sure the printer has the appropriate cost center selected for the Slingshot cost center property.

1.2.9.1.1.31 Setting deadlines and estimating durations

These topics describe problems with setting deadlines and estimating durations for jobs.

1.2.9.1.1.31.1 Jobs table does not show the correct predicted outcome

If the Jobs table or the Predicted outcome property on the job properties notebook shows on-schedule jobs as behind schedule or behind-schedule jobs as on schedule, there might be a problem with the estimated durations. The estimated durations for one or more of the steps in the workflow might not be accurate, or you might not have included steps in the estimate that you should have included.
To adjust estimated durations for steps in a workflow:
  1. Click the Workflow tab.
  2. Click the name of the workflow you want to modify.
  3. Optional: Disable the workflow by clicking the switch to the left of the workflow name.
    If you do not disable the workflow while you edit it, jobs that use this workflow continue to move through steps. When you save, the workflow is momentarily disabled then enabled again. Jobs that are processing in the workflow could move into error.
  4. Right-click in the workflow editor and select Estimated durations.
  5. Review the estimated duration of each step.
  6. If an estimated duration is not accurate, change it.
  7. If you want to include an estimated duration for a step that is not included in the estimate, set the Include in estimated duration property to Yes. Specify both the estimated duration and the number of jobs or pages that are used to calculate the estimated duration.
  8. If you want to stop computing estimated durations for all the steps in the workflow, do these steps:
    1. Select all the steps.
    2. In the Edit Multiple area, select Include in estimated duration and select No.
    3. Click Apply to Selected.
  9. When you finish, click OK.
  10. Save the workflow.
Your changes to the estimated duration of the steps in the workflow affect the predicted outcome for jobs submitted to the workflow in the future. Your changes have no effect on the predicted outcome for jobs that have already been processed.

1.2.9.1.1.32 Reading barcodes

These topics describe problems with reading barcodes.

1.2.9.1.1.32.1 Job leaves Reading barcodes state too soon

If a job leaves the Reading barcodes state before all the documents have been read, you might have to adjust some configuration settings.
On the Job properties notebook, look at these properties:
  • Verification tab: Results file inactivity timer

    If this property has a value, the step monitors updates to the barcode reader results file. If the results file remains unchanged for the amount of time set in this property, the job moves to the next step even if not all barcodes for the job have been verified. To prevent jobs from moving on in the future, you can increase the value from the Results file inactivity timer on the ReadBarcodeData step in the workflow used for the job to a greater length of time.

    You can also prevent a job from leaving the Reading barcodes state automatically by simply not including a value in the Results file inactivity timer.

  • Reconcile tab: Automatic reconciliation

    If this property on the Reconcile tab of the job properties notebook is set to Yes, the job might move through the Reconcile step without pausing.

1.2.9.1.1.32.2 Job stays in Reading barcodes state

Various issues can cause jobs to stay in the Reading barcodes state for longer than expected.
If a job stays in the Reading barcodes state after you expect all the documents to have been read, try the following actions.
  1. Use the Complete barcode step action to see the percent of documents read by the scanner and the number of unread documents. Close the dialog and then do the action again. If the barcode reader is still reading barcodes for the job, the number of unread documents should decrease. If the number does not decrease, note which barcode readers are being used for the job.

    Look in the Barcode readers portlet and make sure that the barcode reader is connected. If the barcode reader is disconnected, select View log on the barcode reader portlet and look at the timestamps for any disconnect messages. If some barcodes were read when the barcode reader was disconnected, scan the documents again.

  2. Check the barcode format on the barcode reader. If the data is not in the expected format, the information read from the barcode is written to a file in the /aiw/aiw1/barcodereader directory (Linux) or C:\aiw\aiw1\barcodereader directory (Windows). The file is named BarcodeReaderName.unmatched, where BarcodeReaderName is the name of the barcode reader object that received the unexpected data. Compare the contents of that file with the barcode format that was used to read the barcodes. Correct the barcode format or the method used to create the barcode.
  3. Check the properties on the Verification tab of the Job property notebook. If the Complete step when all barcodes are read property is set to No, the job will not leave the Reading barcodes state until you complete the step using the Complete barcode step action.

1.2.9.1.1.32.3 Auto reconciliation jobs need to be reconciled

Some jobs still require operator reconciliation, even if the Auto reconciliation property is set to Yes.

If the barcode on a document is scanned twice, the job it is a part of goes into a Duplicate detected state in the ReadBarcodeData step. After completing this step, the job enters a Reconcile step and goes into the Waiting to reconcile state because the duplicate scans must be resolved before reconciliation can be completed.

To reconcile the duplicate scans:
  1. In the Main page, right-click the job in the Jobs portlet and select Reconcile.
  2. In the Documents table, documents that have more than one scan are found in the Scan count column by looking for values other than 1 or blank, or by looking for the Duplicate value in the column containing the document status specified for the job.
  3. Select an action.
    Option Description
    OK Changes the Status to OK. Use this option after you identify the reason for the duplicate scan and dispose of any duplicates, according to your company’s policies.
    Pull Use this option if you want to remove all copies of the document from the job.
    Reprint A child job is created and the documents are printed again. Use this option if you want to print the document again. The next printing of the document contains a different barcode, so it does not appear as a duplicate of the document you marked for reprint.
  4. After you specify an action for all of the documents marked with a Duplicate status, click OK.

1.2.9.1.1.33 Problems with Postal Enablement

These topics describe some of the issues that may arise while using the Postal Enablement feature.

1.2.9.1.1.33.1 Postal software returns incorrect values for document properties

If the postal software returns incorrect values for document properties, the document properties that you defined in your PDF or AFP file might not be the same document properties that you selected in a step based on the BuildExternalDocPropsFile step template or the MapExternalResultsFileToDocProps step template.
To check that you have specified the correct document properties:
  1. Open the document properties file for the job (jobID.document.dpf in the job’s spool directory) and look for the value that you expected to see. Determine the database property name for that value by looking at the header record of the document properties file. For example, you might find one column named Doc.Custom.ZipCode and another named Doc.Address.PostalCode and the value you are expecting is in the Doc.Address.PostalCode column. Both properties could have the same user interface name of Zip code in the list of available properties on the BuildExternalDocPropsFile or MapExternalResultsFiletoDocProps step. You need to determine which entry to include in the list of Selected properties.
  2. If the print job is PDF, open the PDF file and the control file specified on the IdentifyPDFDocuments step in the RICOH ProcessDirector Plug-in for Adobe Acrobat plug-in. Verify that the database name for the property you want to use matches the one in the document properties file for the job. To determine you have the correct corresponding user interface name for the property set on the step, you can look up the document property in the Information Center. The Information Center gives both the database name and the user interface name. If you do not find the property there, use trial and error to select another property in the selected list as described in the next step.
    If you have RICOH ProcessDirector and the print job is AFP, open the AFP file and the Visual Workbench control file in the Ricoh Visual Workbench and see what user interface name is used in the Document Property Designer for the value you want to use.
  3. Correct the properties in the selected list.
    1. Disable the workflow.
    2. Display the properties for the step based on the BuildExternalDocPropsFile or MapExternalResultsFileToDocProps step template.
    3. Change the list of selected document properties as needed.
    4. Enable the workflow.
  4. Select the job and use the Process again action to rerun the appropriate step.

1.2.9.1.1.33.2 Properties set by conditions have incorrect values

If a property set by conditions does not have the correct value, the .csv file specified in a step based on the SetJobPropsFromConditions step template might not have the correct logic.
To fix a problem with properties that have incorrect values:
  1. Open the .csv file with a text editor.
    Important: Do not edit a .csv file with a spreadsheet program, such as Microsoft Excel. The spreadsheet program might interpret any expressions in the file as formulas.
  2. Examine the logic in the .csv file.
    For example, the file contains this logic:

    If the postal software address correction return code = 200 and the address cleansing return code =100, then set the Processing category job property to Qualified.

    If the postal software address correction return code = 300 and the address cleansing return code = 100, then set the Processing category job property to Non-Qualified.

    If the postal software returns a value for the address correction return code that is not 200 or 300 or an address cleansing return code that is not 100, no value is set for the Processing category job property.

  3. Correct each logic problem that you identify. Then use the Process again action to rerun the SetDocPropsFromConditions step that uses this CSV file.

1.2.9.1.1.33.3 Jobs move to error in a Postal Enablement workflow with column headings that have double-byte characters

If all jobs in a Postal Enablement workflow with column headings that have double-byte characters are placed in the Error state, the column headings fields in Postal Enablement steps might contain double-byte commas. To fix the problem, change all double-byte commas to single-byte commas.
To change all double-byte commas to single-byte commas:
  1. Disable the workflow.
  2. Display the properties notebook for the step based BuildExternalDocPropsFile step template.
  3. In the Column headings field, replace any double-byte commas with single-byte commas.
  4. Display the properties notebook for the step based MapExternalResultsFileToDocProps step template.
  5. In the Columns to keep field, replace any double-byte commas with single-byte commas.
  6. Enable the workflow.

1.2.9.1.1.34 Problems with MarcomCentral Connect

These topics describe some of the issues that might arise while using the MarcomCentral Connect feature.

1.2.9.1.1.35 Problems with Preference Management

These topics describe some of the issues that might arise while using the Preference Management feature.

1.2.9.1.1.35.1 Document properties are not updated with values from preferences file

If the document properties are not updated with the values from the preferences file, then your property mapping object might be incorrect, your preferences file might have changed, or your ApplyPreferences step might be configured incorrectly.

Check each item for these common problems.

  • Property mapping object

    Look at the property values for the property mapping object that processed the job.

    • On the General section, make sure that the correct value is selected for File type. If you chose CSV and the file is tab-delimited, the file is read incorrectly.
    • On the Property Mapping section, make sure that the headings in the preferences files are mapped to the expected document properties and usage. Also make sure that all of the expected mappings are listed and the headings exactly match the headings in the preferences file. Headings are case-sensitive.
  • Preferences file

    Open the preferences file that was used to process the job. Make sure that:

    • The delimiters used in the file have not changed.
    • None of the delimiters are missing from any lines.
    • The headings that are used in the property mapping object are still present and spelled the same way.
    • Each column still contains the expected values.

      If the workflow uses these values for conditional processing, changes in expected values can have unexpected results.

    • The file has not been corrupted by being edited with a program that inadvertently changes the formatting.

  • ApplyPreferences step
    • Make sure you have specified the correct property mapping object.
    • If the preferences file is stored in a static location, make sure that RICOH ProcessDirector can access that location during processing with the correct permissions:
      • For Linux, make sure the aiw1 user and the aiwgrp1 group have read permissions.
      • For Windows, make sure the Windows Administrators group has read permissions.
    • If you submit the preferences file with the job, make sure that the symbol notation used for the file name is correct. You might need to check the File patterns defined in the hot folder input device to verify the file usage values.
    • If you have more than one ApplyPreferences step in the workflow, make sure the settings are correct for each value and the job followed the expected path in the workflow.

1.2.9.1.1.36 License keys

These topics describe problems with license keys.

1.2.9.1.1.36.1 Feature is not available because its license key was not found or has expired

If a feature is not available and you see a message that the license key was not found or has expired, the feature does not have a valid license key.

If you run a feature in trial mode, you see this message when the trial period expires. To continue using the feature, you must purchase it and install a license key for it.

1.2.9.1.1.36.2 Job moves to error because a license key was not found or has expired

If a job moves to error and you see a message that a license key was not found or has expired, the job contains a job step that requires a feature that does not have a valid license key.

This might happen when you run a feature in trial mode and the trial period expires. To run the job, you must either remove the step from the workflow or purchase the feature and install a license key for it.

1.2.9.1.1.37 Problems with document processing

These topics describe some of the issues that might arise while processing documents.

1.2.9.1.1.37.1 File not found errors occur when files exist

This section is not applicable to Windows. If a job goes into an error state and you see File Not Found errors when the files actually do exist, you might need to increase your system setting for the maximum number of open files.

The system setting for the maximum number of open files prevents an uncontrolled process from taking over your system, but the AFP Support and PDF Document Support features might need a higher limit if you are running jobs with many documents. Changing the open file limit lets the AFP Support and PDF Document Support features use more system resources.

To change the open file limit:

  1. Log in to your system as the root user.
  2. For your Linux operating system, open the file: /etc/security/limits.conf
  3. Find the line in the file that sets the open file limit. For example, on a Linux system it might look like this: aiw1 - nofile 4096.
    If the line does not exist, add it in the next step.
  4. Edit the line, or add a new line if needed, to set a higher limit. This example sets the limit to 15,000 on Linux: aiw1 - nofile 15000.
    Check with your system administrator to determine a reasonable upper limit for the number of open files.
  5. Log out as root and log in to make the change take effect.

1.2.9.1.1.37.2 Document property values are missing

If you try to view document property values in the user interface and they do not display, your workflow might not have written the property values to the database yet, or the properties might be defined as limited properties.

The user interface (for example, in property notebook pages or in the Documents table) displays the values of document properties according to their current values in the database. You cannot view document property values in the user interface until a step based on the WriteDocumentsToDatabase step template runs in your workflow.

If your workflow has processed a step based on the WriteDocumentsToDatabase step template but you are still not seeing a document property's values in the Documents table, the document property might have been configured as a limited property, so it is not stored in the database. Only values for database properties display in the user interface. Verify that the property is defined as a database property in the document property configuration file aiw/aiw1/config/docCustomDefinitions.xml (Linux) C:\aiw\aiw1\config\docCustomDefinitions.xml (Windows).

If the document property is a limited property:

  1. Work with your Ricoh support representative to remove the limited property definition and define the property as a database property.
  2. Run the docCustom utility and install or upgrade the Custom Document Properties feature.

    Note:
  • Do not define a document property as both a database property and a limited property. Unexpected behavior might occur.

If your workflow includes the SetDocPropsFromList step, the step might not be updating the property values correctly. Compare the contents of the list files processed by the step with the settings on the step for the Document property to set, Value for matching documents, and Value for other documents properties to be sure they are the correct values.

1.2.9.1.1.37.3 Document property values are not current

If you view database property values in the user interface and they are not current, their values might not have been updated in the database using the values in the document properties file.

The user interface displays the values of document properties according to their current value in the database. If a step, such as SortDocuments, has processed a document but the updated value in the document properties file has not yet been written to the database (an UpdateDocumentsInDatabase step has not occurred), the user interface still shows the previous value.

If your workflow includes a step that updates values in the document properties file, make sure you follow it with a step that writes those updated values to the database.

If your workflow includes the SetDocPropsFromList step, the step might not be updating the property values correctly. Compare the contents of the list files processed by the step with the settings on the step for the Document property to set, Value for matching documents, and Value for other documents properties to be sure they are the correct values.

1.2.9.1.1.37.4 Incorrect documents are attached to emails

If incorrect documents are attached to emails in the EmailDocuments step, there are a few items you can check to determine the cause of the problem. There is no validation for matching email addresses with attachments.

Document properties are mapped to pages in the job when the IdentifyPDFDocuments or BuildPDFFromDocuments steps process the job. If the order of pages in the job changes after those steps, the document properties remain mapped to the original page numbers in the job.

For instance, if the job has been processed by the PreparePDFOutputForFinishing or ReversePDFPageOrder step after the IdentifyPDFDocuments or BuildPDFFromDocuments steps and before the EmailDocuments step, the page numbers do not match the document boundaries so the attachments do not contain the correct pages for each email address.

You can correct the problem in one of the following ways:

  • Change the workflow to omit any steps that rearrange the documents before the EmailDocuments step and then process the job again.
  • Add the SnapshotJobFile step to the workflow before any step that reorders the job and then specify the snapshot file in the Source file for attachment property in the EmailDocuments step. The workflow might include these steps in this order:
    • IdentifyPDFDocuments
    • SnapshotJobFile (save that version of the PDF with a name like jobID.original.pdf)
    • PreparePDFOutputForFinishing (or ReversePDFPageOrder)
    • EmailDocuments (and set the Source file for attachment property to ${getFileName(original,pdf,read)}
    Note:
  • You cannot correct the problem by including a second IdentifyPDFDocuments or BuildPDFFromDocuments step.

1.2.9.1.1.37.5 Emails are sent without documents attached

If emails are sent without documents attached to them, the attachment might not be in the PDF format, the EmailDocuments step might be incorrectly configured, or the PDF might not contain information for each recipient.

The EmailDocuments step lets you attach documents to emails within a RICOH ProcessDirector workflow.

If RICOH ProcessDirector is sending emails without attachments, check the following:

  • The file type of the attachment

    RICOH ProcessDirector can only attach and email PDF documents. Check your source directory and make sure the file is a PDF.

  • The Source file for attachment property

    Make sure that the EmailDocuments step has the correct source file listed for an attachment. The default value for EmailDocuments is ${getFileName(print,pdf,read)}, which retrieves the current PDF file from the spool directory.

  • The Attach document property

    In your workflow, make sure the Attach document property on the EmailDocuments step is set to Yes.

  • Your email service provider’s policy on attachments

    Make sure your email provider lets you send documents with attachments through their system. If all of the settings in the step are correct and the PDF files are still not attached to the emails that are sent, your email service might be blocking emails with attachments. If they permit attachments, make sure that the name of the attachment does not trigger the email provider’s spam filter. If the filename of the attachment triggers the spam filter, it might be deleted from the email.

1.2.9.1.1.37.6 Problems with list files

If you set up a workflow to pull documents from jobs before printing or other processing, but experience issues with incorrect documents left in the job or incorrect documents pulled from the job, you might need to update some settings.

Check the following items:

  • Your workflow

    Make sure you have a SetDocPropsFromList step in your workflow. This step processes the list file and is mandatory.

  • The Columns in list file property

    Check the SetDocPropsFromList step to see if you correctly specified the properties used to identify which documents in the job should be pulled. For example, a bank has customers who have the same account number for their checking and savings accounts. A separate document property named Type specifies the account type. A job contains a mixture of savings and checking documents.

    To pull all of the savings documents from the job, you could provide a list file that contains only the word SAVINGS and set the Columns in list file property to Type. If the list file contains entries with both account numbers and types and you want to pull the documents that match on both account number and type, set the Columns in list file property to Account number and Type. For the same list file, if you want to pull all the documents for a set of account numbers no matter what the account type is, set the Columns in list file property to Account number.

    You can increase or decrease the properties in the Columns in list file property to identify only the documents you want to pull. Check the order of the properties in the Columns in list file property to make sure it matches the order of the columns in the list file.

  • The Delimiter property

    Each entry in a list file must be on a separate line. If an entry contains multiple property values (such as account number and type), the property values must be separated by a delimiter.

    Make sure the correct type of delimiter is chosen. If there is only one value per line in the list file, use New line. If there is more than one value per line in the list file, select the type of delimiter used between the values.

  • The list files in the directory specified in the List file directory property

    RICOH ProcessDirector processes all the files in the directory named in the List file directory property. If you have files leftover from a previous day's processing, they are applied along with today's list file.

    Make sure the values in the Columns in list file property are values for the correct document properties in the order in which they appear in the list file.

    Make sure the list files are located in the correct directory. If the list files are not located in the specified directory, RICOH ProcessDirector is unable to locate them.

  • When the list file was placed in the list file directory

    If the SetDocPropsFromList step processes the job before the list file is received, it is too late for RICOH ProcessDirector to use the list file. You can add a Wait step to the workflow before the SetDocPropsFromList step so the job will wait until a time that you specify for any list file to arrive. Or you can add a manual step before the SetDocPropsFromList step and set it to require the operator to complete the manual step after the list file is in its correct place.

1.2.9.1.1.37.7 Batching of AFP files fails if original jobs use same inline resource name with different content

If you try to batch multiple AFP files (make a job from documents that came from different original jobs), and the original jobs use the same name for an inline resource but the resources contain different content, an error occurs and the step attempting to build the AFP file fails.

For example, if two original jobs both include a code page named T1EX0000 but the content of the two code pages is different, the step attempting to build the print job fails.

Document composition software sometimes builds these inline resources with arbitrary names, reusing the same names for a resource for each AFP file they create; this practice makes the problem likely to occur. For example, a composition application builds a code page for each AFP file and places it inline. It always names the code page T1CODEPG, but it contains only the code points used for each file. So the first file built this way has an inline code page named T1CODEPG with 100 code points in it and a second file built by this application also has an inline code page named T1CODEPG with 150 code points in it. When the CreateAFPJobsFromDocuments, BuildAFPFromDocuments, or BuildAFPFromZip step attempts to build a single job containing documents from these two files, an error occurs because the two resources with the same names have different contents.

If possible, change a setting in the composition application to produce uniquely named inline resources. Or find a way to have the different input files point to the same external resource.

This problem can occur for any AFP resource type except form definitions. However, the medium maps specified for all the documents being batched into a single job must have the same setting for duplex and include the same values for the constant back parameter.

1.2.9.1.1.37.8 Missing overlays or wrong duplex output

In the AFP data stream, you can use the form definition resource to specify several aspects of the printed output, including the addition of overlays to the data, whether printing should occur on one or both sides of the sheet, and whether a side should contain only an overlay and no print data (also called constant back).

One form definition is needed for each AFP print job, but a form definition can contain multiple medium maps, each of which sets the properties for a set of pages until the print file requests a switch to another set of properties. For example, the first five pages of an insurance application might have one set of overlays for the front and back sides, but a different set of overlays is needed for pages 6 and higher to handle state-specific information. Each set of overlays is specified in its own medium map. To switch from one medium map to another, an Invoke Medium Map (IMM) structured field is included in the AFP data.

With the AFP Support feature, when you use the IdentifyDocuments step to divide an AFP job into individual documents, RICOH ProcessDirector needs to keep track of the medium map information that is required for each document. The step templates that create new AFP files (CreateAFPJobsFromDocuments and BuildAFPFromDocuments) build a new form definition for the jobs they create, so they must have the medium map information available to make sure that all the medium maps needed for all the documents in the new AFP file are included in the form definition they build. If that information is not available, the step might build an AFP file that does not reference the overlays that were in the medium map when the job was received in the system or that does not contain the correct duplex specification.

To make sure that the AFP files built by these steps have access to the correct medium map information, do one of these:

  • Build the AFP with an Invoke Medium Map structured field inside each named group in the file. If the medium map is defined this way with each document when it is received into RICOH ProcessDirector, you should not see a problem with new AFP files built from those original documents. For information about standard AFP requirements, see the associated related topic.
  • If the AFP is not in the required standard form, you can add a step to your workflow that calls a program provided with the AFP Support feature to add the medium map information to the AFP file before it is divided into documents. To do this, see the related topic about handling references to medium maps in non-conforming AFP.

1.2.9.1.2 Messages in RICOH ProcessDirector

Messages from different RICOH ProcessDirector devices and components, and messages from external programs that RICOH ProcessDirector works with, can help solve problems that arise during processing.

Because messages from different RICOH ProcessDirector components might be recorded in the same log, the first step to interpreting messages is to determine which component generated them. You can use these conventions to determine which component issued a message:

Messages that begin with AIW
Many of these messages are generated by the RICOH ProcessDirector server or user interface. If you view a message in one of the RICOH ProcessDirector logs, you can click the message to see the full text and any recommended actions.

In other cases, messages that begin with AIW contain messages from other components. If an external program (or a component that behaves like an external program, such as a Ricoh Transform feature or the AFP Conversion and Indexing Facility (ACIF)) sends a message to the primary server, the message is recorded as a server message. The text of the message contains the message ID for the component that issued the message.

For example, you might find this message in a log:

AIWI0017I 0425-440 ACIF AT PK17935 HAS COMPLETED NORMALLY WITH RETURN CODE 0.
In this case, AIWI0017I is the message that is issued by the server. The text of the message identifies message number 0425-440 which, based on the information below, indicates that this message was originally generated by the ACIF component.

Messages that begin with the numbers 0420 through 0424
These messages are generated by the print driver in RICOH ProcessDirector, Print Services Facility (PSF). These messages are documented in InfoPrint Manager: PSF and Server Messages, and Transform Messages, G550-1053. The actions described in that manual are specific to InfoPrint Manager, but can be adapted to the RICOH ProcessDirector environment.

On a Linux system with a RICOH ProcessDirector server, you can use the psfmsg command to display information about these messages. Enter this command:

/usr/lpp/psf/bin/psfmsg 042n-nnn
042n-nnn is the message number.

Messages that begin with the number 0425
These messages are generated by ACIF. For information about resolving these messages, see AFP Conversion and Indexing Facility User's Guide, G550-1342. If you are familiar with the LookAt tool on the zSeries systems, you can replace the 0425 in the message number with APK and use LookAt to find the explanation.

On a Linux system with a RICOH ProcessDirector server, you can use the psfmsg command to display information about these messages. Enter this command:

/usr/lpp/psf/bin/psfmsg 0425-nnn
0425-nnn is the message number.

Messages that begin with FTD
These messages are generated by the AFP viewer component. The majority of these messages contain actions that you can take to resolve the error.
Any message that mentions SQL
These messages are generated by the internal database and should generally be reported to Software Support.

Messages that begin with characters not listed above are generated by components called by RICOH ProcessDirector (such as a Ricoh Transform feature). You must read the text of the message to determine what program or component issued the message.

1.2.9.1.2.1 Language of messages

RICOH ProcessDirector issues most messages in the language of the user interface, which is determined by the language setting of your browser. Some messages might be in a different language.
  • The printer driver component issues messages in the language of the RICOH ProcessDirector base product. This language is set when the base product is installed.
  • SNMP issues messages in the language set at the physical printer.
  • On a Linux system, Download input devices receive messages from the Download daemon in the language set by the Device language property.

1.2.9.1.2.2 Viewing object logs

You can view the log for an object to see messages about its operations, such as property or state changes. Objects include servers, notifications, media, and devices such as input devices and printers. Features might add other kinds of objects as well.
Object logs contain messages issued in the last 3 days. After 3 days, the log information is moved to audit files in the /aiw/aiw1/audit/object type directory. However, job logs remain in the system as long as the job does. When the job is deleted, the log information is moved to the audit files.

Audit files remain in the system for 28 days and then are automatically deleted. There is no size limit for logs.

Log entries are sorted by the Time column, from the newest to the oldest entry.

The timestamp in an exported log is displayed in Greenwich Mean Time (GMT) followed by a plus sign (+) or a minus sign (−) and an offset representing the number of hours that the local time of the issuing system is ahead (+) or behind (−) GMT. However, the timestamp in an object log being viewed in RICOH ProcessDirector is displayed in the time zone of the browser that you are using.

To view the log for an object:

  1. Do one of these:
    • From the Main page:
      1. Find the object in its portal or table.
      2. Right-click the object and select View Log.
    • From the Administration page:
      1. In the left pane, click the object type.
      2. In the table, right-click the object and select View Log.
  2. You see the messages that were issued. All the message times are displayed in the time zone of the browser that you are using. If the text of a message is truncated, click the message entry. You see the complete text of the message at the bottom of the window.
  3. To sort the messages by message type or by another column, click the column heading.
    Click once to sort in ascending order; click twice to sort in descending order.
  4. To change what you see in the log, change the value of the Type and Range properties:
    Type
    By default, you see messages of all types. To only show certain types of messages, choose a value from the list.
    Range
    Select All to see all of the messages in the log, filtered by the Type setting. Select Custom to limit the number of messages to a certain number of days or hours. Specify the days and hours in the Issued within property.

1.2.9.1.2.3 Exporting object logs

You can export logs for one or more objects so you can save the logs locally. Exported logs are saved as comma-separated value (CSV) files in a single compressed folder. Examples of objects are input devices and printers.

Any sorting or filtering that you do on the View Log page is not saved in the exported log. Exported logs are in ascending time order (from oldest to newest) and contain messages of any type issued in the last 3 days. The exception is job logs, which contain all the information recorded for the job since it entered the system.

The timestamp in an exported log is recorded in Greenwich Mean Time (GMT) followed by a plus sign (+) or a minus sign (−) and an offset representing the number of hours that the local time of the issuing system is ahead (+) or behind (−) GMT. However, the timestamp in an object log being viewed in RICOH ProcessDirector is displayed in the time zone of the browser that you are using.

To export the log for an object:

  1. Disable all pop-up blockers in your browser because the export file opens in a pop-up window.
    If a pop-up blocker is running, you cannot save the export file.
  2. Do one of these:
    • From the Main page:
      1. Select one or more objects in the portal or table.
      2. Click More actions Export Log.
    • From the Administration page:
      1. In the left pane, select the object type.
      2. In the table, select one or more objects and click More actions Export Log.
    • From the View Log page, click Export.
  3. In the File Download window, click Save.
    The compressed file is downloaded. If your browser is configured to let you choose where to save files, you can choose where to store the file and give it a different name. The default name of this folder is object typetimestamp.zip.
  4. Click Save.

1.2.9.1.2.4 Exporting system logs

You can export several logs for diagnostic use from the System Log page. Exported logs are saved as comma-separated value (CSV) files in a single compressed folder.

Timestamps in exported logs are recorded in Greenwich Mean Time (GMT) followed by a plus sign (+) or a minus sign (−) and an offset representing the number of hours that the local time of the issuing system is ahead (+) or behind (−) GMT. However, the timestamps in a log viewed in RICOH ProcessDirector is displayed in the time zone of the browser that you are using.

To export the set of diagnostic logs:

  1. Disable all pop-up blockers in your browser because the export file opens in a pop-up window.
    If a pop-up blocker is running, you cannot save the export file.
  2. At the top right of the System Summary portlet, click Settings () and select View Log.
  3. Click Export All.
    The compressed file is downloaded. If your browser is configured to let you choose where to save files, you can choose where to store the file and give it a different name. The default name of this folder is Instance–timestamp.zip.
  4. Click Save.

1.2.9.1.2.5 Audit and message file removal

When a print job leaves the RICOH ProcessDirector system, audit files are created to record data about the job. In addition, all the message logs are exported to files every three days. While these files are useful, they also take up space on the system. If they are not deleted periodically, they can begin to impact system performance.

When RICOH ProcessDirector is installed, a script that deletes these files is installed. By default, the script runs daily at midnight and deletes the job audit and message log files that are over 28 days old.

1.2.9.2 Support

Some of the issues you encounter can be resolved by downloading and applying service to your system from the support Web site. For other issues, you might want to talk with a Ricoh support representative.

1.2.9.2.1 Backing up and restoring RICOH ProcessDirector data

To prevent loss of data from a system failure or to recover data (for example, if you want to return your system to a previously installed level with all the settings and objects restored), RICOH ProcessDirector provides backup and restore programs.

The backup program saves this data:

  • System data, such as workflows, step templates, users, input devices, and printers stored in the database
  • Control files, such as those used for header sheets
  • User data, such as job files in the spool directory
Then, if you need to reinstall RICOH ProcessDirector, you can run a restore program to recover your data. System data and control files are always backed up and restored; as an option, you can back up and restore user data.

Note: You cannot use the backup and restore programs to copy or move RICOH ProcessDirector from one computer to another unless the two computers have the same host name and the same RICOH ProcessDirector service level. You can copy objects from one computer to another with a different host name or service level by exporting them from the first computer and importing them to the second.

1.2.9.2.1.1 Backing up data

You can use a backup script to archive a copy of your RICOH ProcessDirector system configuration.
To back up RICOH ProcessDirector data:
  1. Stop all application and secondary servers. The backup procedure stops the primary server automatically.
  2. Log in to the primary computer as the root user.
  3. Enter /opt/infoprint/ippd/bin/aiwbackup.pl with any of these options:
    Option Description
    -f filename Back up data to a directory and file name other than the default, which is /tmp/aiw_backup_data.[timestamp].tar.gz .
    -m Do not make a backup image of the DB2 database. Use this option if the DB2 database is on a different computer.
    -r Input files and job files (the files in the spool directory that contain job information, including copies of input files) are saved by default. A backup with the -r option does not save input files or job files, but it does save jobs. System data and control files are always saved.
      Important:
    • The -r option is slightly different on the aiwbackup and aiwrestore commands:
      • On aiwbackup, the -r option removes only input files and job files from the saved system. It does not delete the jobs from the system.
      • On aiwrestore, the -r option removes jobs, input files, and job files from the restored system.
      If you use the -r option when you back up RICOH ProcessDirector, you should also use it when you restore the system to avoid restoring jobs whose files have not been saved.
    -h or -? Display help for the aiwbackup command.
    For example, this command saves data, including jobs, but not including input files or job files, to a file called mybackup.tar.gz:
    • /opt/infoprint/ippd/bin/aiwbackup.pl -f mybackup.tar.gz -r
    You see a message that all servers will be stopped, whether jobs and input files will be backed up, and the location of the backed up files.
  4. Enter Y to proceed with the backup.
    When the backup is complete, you see a message that the backup was successful.

1.2.9.2.1.2 Restoring data

You can use a RICOH ProcessDirector restore script to return your system to the configuration that you stored in a backup archive.
To restore RICOH ProcessDirector to a previous level, including any service updates, you must back up your data before you install an update of RICOH ProcessDirector.
Keep these considerations in mind when restoring a RICOH ProcessDirector level:
  • All existing jobs and input files from the current RICOH ProcessDirector level are removed when you restore to a previous level.
  • You can only restore the backup to a system that has the same host name and the same RICOH ProcessDirector features installed as the system on which you performed the backup.
  • If you used a new level of RICOH ProcessDirector and then restored to a previous level, or if you installed and used the previous level before you restored the backup files, any changes you made to system data, control files, or user data is lost. Therefore, if you need to restore your backup files, do it as soon as possible to reduce the amount of lost data.

To restore RICOH ProcessDirector data:

  1. Stop the base product and all application/secondary servers. .
  2. On all computers, install the same level of RICOH ProcessDirector as the backup you previously created. .
  3. On the primary computer, log in as an administrator.
  4. Start a command prompt as an administrator. Even if you are logged on to your system as an administrator, you must start the command prompt by selecting Run as administrator from the right-click menu.
  5. Enter /opt/infoprint/ippd/bin/aiwrestore.pl with any of these options:
    -f filename
    Restore data from a directory and file name other than the default, which is C:\tmp\aiw_backup_data.[timestamp].tar.gz on Windows and /tmp/aiw_backup_data.[timestamp].tar.gz on Linux.
    -m
    Do not restore the DB2 database. Use this option if the DB2 database is on a different computer than the base product.
    -r
    Jobs, input files, and job files (the files in the spool directory that contain job information, including copies of input files) are restored by default. A backup with the -r option does not restore jobs, input files, or job files. System data and control files are always restored.
    Important: The -r option is slightly different on the aiwbackup and aiwrestore commands:
    • On aiwbackup, the -r option removes only input files and job files from the saved system. It does not delete the jobs from the system.
    • On aiwrestore, the -r option removes jobs, input files, and job files from the restored system.
    If you used the -r option when you backed up RICOH ProcessDirector, you should also use it when you restore the system to avoid restoring jobs whose files have not been saved.
    -h or -?
    Display help for the aiwrestore command.
    For example, this command restores data, not including jobs, input files, or job files, from a file called mybackup.tar.gz: /opt/infoprint/ippd/bin/aiwrestore.pl -f mybackup.tar.gz -r
    You see a message that all servers will be stopped and the location the files are restored from.
  6. Enter Y to proceed with the restore.
    When the restore is complete, you see a message that the restore was successful.
  7. Start the base product and application/secondary servers to use the restored level of RICOH ProcessDirector.

1.2.9.2.2 Determining the RICOH ProcessDirector version

If you need to place a service call on your RICOH ProcessDirector system, you must provide the version number of RICOH ProcessDirector that you currently have installed.
To determine the RICOH ProcessDirector version:
  1. On any page of the user interface, click the Information icon button in the upper right corner.
  2. Select About.
  3. Make note of the version and service level.
  4. Click Close.
To determine the version of an installed feature:
  1. Click the Administration tab.
  2. In the left pane, click Utilities Features.
  3. Look in the Installed version column for the feature you are interested in.

1.2.9.2.3 Applying service to a DB2 server on a different computer

If RICOH ProcessDirector uses a DB2 server on a different computer, applying service to the remote database while RICOH ProcessDirector is running can cause problems.
To apply service to a DB2 server on a different computer:
  1. Shut down RICOH ProcessDirector.
  2. Apply service to DB2 on the computer it is installed on.
  3. Restart RICOH ProcessDirector.

1.2.9.2.4 System diagnostics

To help software support understand and solve your issues, you might have to collect information from your system and submit it for analysis.

1.2.9.2.4.1 Setting trace options

Traces generate information about system functions. Changing trace options adjusts the amount of information recorded to help diagnose problems, but it also uses more system resources. Software Support might ask you to change trace options temporarily to gather the data they need.
Trace options should only be changed at the direction of Software Support.
To set trace options:
  1. Click the Administration tab.
  2. In the left pane, click Diagnostics System Trace.
  3. On the System Trace page, set the options according to the instructions from Software Support.
    Make note of the original settings so you can change them back when you finish collecting data.
  4. Click SAVE.
After you send the required information to Software Support, repeat this procedure to reset the options to their original values.

1.2.9.2.4.2 Creating a data capture file

You can use the data capture function to collect all the information needed to help diagnose your problem and package it in a ZIP file that you can send to Software Support.
Software Support can tell you if a capture file is required and what data should be included.
    Note:
  • You can use the Easy Capture button to gather initial tracing and system information to provide to the support team. The Easy Capture function uses your browser’s download function to transfer the ZIP file of diagnostic information onto your workstation, making it easy to provide the file to Software Support. You may need to use the GET DATA CAPTURE button later, if directed by Software Support, to help with debugging.
  • Under the Last data capture file property, click the file name to download the last data capture file created successfully.

To create a capture file:

  1. Click the Administration tab.
  2. In the left pane, click Diagnostics Data Capture.
    Look in the lower right corner to ensure that the capture process is not already running.
  3. On the Data Capture page, set the options according to the instructions from Software Support.
    If you need to capture information from an application server:
    1. Log in to the application server as the user that the service runs under.
    2. Select Start Internet Options Security Local Intranet
    3. Click Sites.
    4. Under Add this website to the zone type the drive letter that you used to map the connection between the application server and the RICOH ProcessDirector primary server. Include a colon after the drive letter. For example, this application server has drive R: mapped to the primary server, type: R:
    5. Click Add.
    6. Click Close.
    7. Click OK in the Internet properties dialog.
  4. Click GET DATA CAPTURE to collect the information.
    The capture process runs in the background, so you can continue using RICOH ProcessDirector while the capture file is created. You can only create one capture file at a time.
  5. To check if the capture process has finished creating the capture file, open the Data Capture page and look in the lower right corner.
    A status message reports that the capture is still in progress, it failed, or it has completed. The Last data capture completed property specifies the date and time when a capture last completed.
  6. When the data collection is finalized, the Capture complete status is displayed. Click the download icon to download the file.

To download the file at a later time, click the name of the file in the Last data capture file property or find the capture file in the location specified in the Where to store capture file property.

1.2.10 Reference information

Reference information includes sample files that RICOH ProcessDirector supplies, descriptions of files that RICOH ProcessDirector uses, and descriptions of the syntax that those files and other properties use.

1.2.10.1 Directory structure

RICOH ProcessDirector uses specific directories and subdirectories on the system to store its files. At some point, you might need to access a directory or locate a specific file in a subdirectory.
    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples directory, but they do not overwrite files in the /aiw/aiw1/control_files directory. We recommend copying sample files into the /aiw/aiw1/control_files directory and making all your changes in the copied file.
RICOH ProcessDirector directory structure
Directory name Contents
/aiw/aiw1/audit/InputDevice Completed audit files for input devices
/aiw/aiw1/audit/Instance Completed audit files for servers
/aiw/aiw1/audit/Job Completed audit files for individual jobs
/aiw/aiw1/audit/JobType Completed audit files for workflows
/aiw/aiw1/audit/Printer Completed audit files for most types of printers
/aiw/aiw1/audit/PrinterInternalAFP Completed audit files for AFP printers
/aiw/aiw1/audit/JdfOutputPrinter Completed audit files for Ricoh PDF printers
/aiw/aiw1/audit/StepTemplate Completed audit files for step templates
/aiw/aiw1/audit/User Completed audit files for users
/aiw/aiw1/config/ Miscellaneous configuration files
/aiw/aiw1/control_files/audit/ Control files for collecting audit information for jobs
Note: Some objects, such as input devices, only record messages as audit information and do not have control files to control the type of audit information that RICOH ProcessDirector retains.
/aiw/aiw1/control_files/banner_pages/ Configuration files for banner pages
/aiw/aiw1/control_files/external_programs/ Control files for use with external programs
/aiw/aiw1/control_files/passthru/ Control files for use with Passthrough printers
/aiw/aiw1/control_files/rules/ Rules files for assigning workflows and setting job properties.
/aiw/aiw1/samples/audit/ Control file templates for collecting audit information for jobs

Files in the samples directory are only used as templates for customizing control files. RICOH ProcessDirector does not use them at runtime.

Note: Some objects, such as input devices, only record messages as audit information and do not have control files to control the type of audit information that RICOH ProcessDirector retains.
/aiw/aiw1/samples/banner_pages/ Configuration templates for banner pages

Files in the samples directory are only used as templates for customizing control files. RICOH ProcessDirector does not use them at runtime.

/aiw/aiw1/samples/external_programs/ Control file templates for use with external programs

Files in the samples directory are only used as templates for customizing control files. RICOH ProcessDirector does not use them at runtime.

/aiw/aiw1/samples/passthru/ Control file templates for use with Passthrough printers

Files in the samples directory are only used as templates for customizing control files. RICOH ProcessDirector does not use them at runtime.

/aiw/aiw1/samples/rules/ Rules templates for assigning workflows and setting job properties

Files in the samples directory are only used as templates for customizing control files. RICOH ProcessDirector does not use them at runtime.

/aiw/aiw1/exits Compiled user exit programs
/aiw/aiw1/resources Job resources
/aiw/aiw1/spool/default
or
/aiw/aiw1/spool/SpoolName
Job data
/aiw/aiw1/System Input device folders
/aiw/aiw1/testfiles Sample print files
/aiw/aiw1/trace System trace files
/opt/infoprint/ippd/afpviewer/font Font configuration files for file viewer
/usr/lpp/psf/exits Sample printer-driver user exit programs

Only available when the AFP support feature is installed.

/usr/lpp/psf/reslib AFP font and form definition files

Only available when the AFP support feature is installed.

1.2.10.2 Supplied step templates

RICOH ProcessDirector supplies a set of step templates, which were installed with RICOH ProcessDirector. The supplied workflows contain steps created from these step templates. You can copy these templates to create customized steps that they can use when they build workflows.

You can add a step created from a step template to any phase of a workflow. The phases provide logical groupings for steps. Some steps go logically in a single phase. For example, the Print phase is a logical choice for the PrintJobs step. Other steps go logically in several phases. For example, to save a copy of a print file before RICOH ProcessDirector sends it to a transform program for conversion to a different data stream, add a CopyToFolder step to the Prepare phase. Then, to save a copy of the file after it prints, add another CopyToFolder step to the Complete phase. Or to verify that the correct forms are loaded before printing a job, add a ManualStepWithAutoStart step to the Prepare phase. Then, to conduct a print quality check after the job is printed, add another ManualStepWithAutoStart step to the Print phase after the PrintJobs step.

1.2.10.2.1 AddPageExceptionsToAFP

A step based on this step template uses the page exception file generated by the ExtractPageExceptions step and converts the media settings into an inline form definition with the appropriate medium maps. The step also inserts Invoke Medium Map (IMM) structured fields into the output AFP file so that the page exceptions take effect on the correct pages.
Job Defaults

  • Page exceptions file: ${getFileName(pletotab,del,read)}

1.2.10.2.2 ApplyPreferences

A step that is based on this step template uses a property mapping object to interpret a preferences file. The information in the preferences file is used to add or update one or more document property values in the document properties file (DPF).

When the step runs, it uses the settings in the property mapping object to determine:

  • Which property each column in the preferences file corresponds to.
  • Which properties are used to uniquely identify each document, both in the preferences file and in the DPF. The Usage value of these properties is set to Identify document in the property mapping section.
  • Which property values need to be updated with the information in the preferences file. The Usage value of these properties is set to Update property in the property mapping section.

The step then uses Identify document properties to match each entry in the preferences file with a document in the DPF. For each matching row, the values of the other properties listed in the table are updated.

Job property defaults
  • Preferences file:
  • Property mapping: Not set
Usage notes
  • This step must run after a step based on the IdentifyDocuments or IdentifyPDFDocuments step template.
  • The preferences file can contain columns that are not mapped to document properties. Columns that are not mapped are ignored.
  • If more than one document in the DPF matches the Identify document, the changes to the document properties are made to all matching documents in the DPF.
  • Each entry in the preferences file must have a unique combination of values for its Identify document properties. If more than one line has the same combination of values, the job is placed in an Error state and a message is written to the job log. The step stops reading the preferences file on the first occurrence of this error.
  • If an entry in the preferences file matches no documents in the DPF, the entry is skipped and no message is logged.
  • If there are documents in the DPF that do not have corresponding entries in the preferences file, any properties added by the ApplyPreferences step are also added to those documents with a value of null.
  • If the step does not make any changes to the DPF for a job, the step writes a warning message to the job log.
  • The function of this step is similar to the SetDocPropsFromList step template. The ApplyPreferences step can set multiple document properties, while the SetDocPropsFromList step template can only set one.

1.2.10.2.3 ApplyXSLTransform

A step based on this step template uses an Extensible Stylesheet Language Transformations (XSLT) style sheet to convert a file in one format into another format. For example, the step can convert XML into another XML format for use as a JDF job ticket or as input to the CreateJobsFromXML step. The step also can convert XML into a text file containing RICOH ProcessDirector job or document properties.
Job property defaults
  • Input file:
  • XSLT style sheet file:
  • Output file:
Usage notes
  • The step supports XSLT Version 1.1.
  • Use an XSLT editor to create the XSLT style sheet.
  • This step can process input files in formats other than XML. For example, if your XSLT style sheet contains the unparsed-text function, you can use a text file as input.
  • To use a file in the spool directory for the job as the input file, specify this value: ${getCurrentFile(extension)}

    where extension is the filename extension.

    For example, to use an XML file in the spool directory, specify ${getCurrentFile(xml)}.

  • To use a text output file as the overrides file in the spool directory for the job, specify this value: ${getFIleName(overrides,txt,write)}.
  • Steps based on the ApplyXSLTransform step template have positional properties. You can place a step with positional properties in a workflow multiple times, and the job properties can take different values when each step is used. The phase and step names appear as section names with the properties of the step shown inside the section.
  • This example shows:
    • A simple input file containing XML elements for order type, copies, paper, file, and industry.
    • An XSLT style sheet that converts the 5 XML elements into 5 corresponding RICOH ProcessDirector job properties: Job.Info.Attr1, Job.Copies, Job.Media, Job.Info.Attr2, and Job.Info.Attr3.
    • An output file containing text for the 5 job properties.
    Input file containing XML
    <?xml version="1.0" encoding="utf-8"?>
    <Order Type="Statement">
        <Copies>4</Copies>
        <Paper>Letter Plain</Paper>
        <File>http://localhost:15080/pd/Demo.pdfFile>http://localhost:15080/pd/Demo.pdf</File>
        <Industry>Hotel</Industry>
    </Order>
    XSLT style sheet
    <?xml version="1.0" encoding="utf-8"?>
    <xsl:stylesheet version="1.0">
        <xsl:output method="text" encoding="UTF-8"/>
        <xsl:template match="/">
            <xsl:variable name="var1_initial" select="."/>
            <xsl:for-each select="Order">
                <xsl:variable name="var2_current" select="."/>
                <xsl:value-of select="concat('Job.Info.Attr1=', @Type, '&#10;', 
    		'Job.Copies=', floor(Copies), '&#10;', 'Job.Media=', Paper, '&#10;', 
    		'Job.Info.Attr2=', File, '&#10;', 'Job.Info.Attr3=', Industry)"/>
            <xsl:for-each>
        </xsl:template>
    </xsl:stylesheet>
    Output file containing text
    Job.Info.Attr1=Statement
    Job.Copies=4
    Job.Media=Letter Plain
    Job.Info.Attr2=http://localhost:15080/pd/Demo.pdf
    Job.Info.Attr3=Hotel

1.2.10.2.4 AssignJobValues

Add this step to a workflow to set job properties to be used by any steps that follow this one in the workflow. The AssignJobValues step is particularly useful in combination with the use of rules on connectors between steps in a workflow.

For example, you can have two connectors branch from one step that test for the number of pages in a job. If the number of pages exceeds a certain value, the one AssignJobValues step could set a high-speed printer as the Requested printer or specify that no stapling be done. The other branch from the step goes to a different AssignJobValues step that sets a medium-speed printer and selects a value for Stapling.

Job property defaults
  • Job values file
  • Values to set
Usage notes
  • You can use both a configuration file and the list of property values to change the values for a job. If a property is included in both the configuration file and in the list, the value in the list is used.
  • The job values file is a text file that contains job property and value pairs. The values in the file override values that are already set when a job enters the AssignJobValues step.

    Use RICOH ProcessDirector database names for the properties. List each property and value on a separate line as database.property.name=value, with no spaces before or after the equal sign (=). For example:

    Job.RequestedPrinter=RicohProVC60000Job.Duplex=Yes

  • To assign a value to a positional job property, specify the phase and step names in brackets following the property name.

    This example specifies a copy command as the value of the External command job property for the RunExternalProgram step in the Prepare phase of a workflow:

    Job.External.Command[Prepare][RunExternalProgram]=cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv

  • You cannot set positional properties in the list of property values.

1.2.10.2.5 BuildAFPFromDocuments

A step based on the BuildAFPFromDocuments step template creates a single AFP file for the current job, placing the documents in the sequence specified in the document properties file. The AFP file produced by this step becomes the AFP file for the subsequent steps in the workflow.

Some document workflows do not need to create child AFP jobs. Instead, they only need to create or reorder the documents in the AFP file for the existing job.

The BuildAFPFromDocuments step template is similar to the CreateAFPJobsFromDocuments step template, except that all the documents are written to the AFP file for the existing job instead of to AFP files for child jobs. With the BuildAFPFromDocuments step, the documents are included in Child Job ID order, and in Sequence In Child order within the Child Job ID.

This step also applies barcodes, cover blocks, and text if you define these modifications in an Enhance AFP control file and specify the Enhance AFP control file property in the step.

Job property defaults
  • Enhance AFP control file: Not set
Usage notes
  • BuildAFPFromDocuments creates an inline form definition as part of its processing.
  • BuildAFPFromDocuments uses the original documents and original document properties, as identified in the IdentifyDocuments step, to generate the AFP file. If the AFP file changes after IdentifyDocuments runs, those changes are not used by BuildAFPFromDocuments.

1.2.10.2.6 BuildAFPFromZIP

A step that is based on this step template builds a single AFP file from the contents of a ZIP file.
Job property defaults
  • Banner page form definition:
  • Header page configuration file:
  • Include header pages: Yes
  • Include trailer pages: No
  • Trailer page configuration file:
  • External command:

Usage notes
  • A step that is based on this step template can be used only for AFP files packaged in ZIP files.
  • An AFP job that is not inside a ZIP file can also be processed by the step.
  • The original AFP files are added to the final AFP file based on the order that of the AFP files were added to the ZIP file or the order that they appear inside the list file. For example, if you submit a ZIP file that you created, the order of the final AFP file reflects the order in which you added AFP files to the ZIP file. If you use the List batching method and set the Create ZIP file property to Yes, the order of the final AFP file reflects the order that the AFP files are listed in within the list file. If you use any batching method other than List and set the Create ZIP file property to Yes, the order of the final AFP file is based on the timestamp of the individual AFP files in the ZIP file.
  • The header and trailer page properties insert those pages between the individual AFP files when they are printed as a large AFP file. Banner page support is not available on RICOH ProcessDirector for Windows.
  • In the External command property, the program you provide must always expect the AFP file as the last argument. For example, to pass the job number to the program named myscript , enter /aiw/aiw1/bin/myscript ${Job.ID} for the External command property. When the step executes for job 10000045, the command is resolved to /aiw/aiw1/bin/myscript10000045/aiw/aiw1/spool/default/10000045/eachAFPfileinthezip.afp

1.2.10.2.7 BuildExternalDocPropsFile

A step based on this step template lets you extract document data from the document properties file and create a file with the document data and headings that you need to send to an external program. The file you create is called an external document properties file.
Job property defaults
  • External document properties file: ${getFileName(data,csv,write)}

  • File type:CSV

  • Column headings:

  • Selected document properties: Document number

Usage notes
  • This step requires a document properties file as input. To create a document properties file, a step based on the IdentifyPDFDocuments or IdentifyDocuments (RICOH ProcessDirector only) step template must be run in the workflow before the step based on the BuildExternalDocPropsFile step template.

  • The output file will be created where the External document properties file property specifies.

  • The File type property determines if the external document properties file is tab-delimited or comma-separated (CSV).

1.2.10.2.8 BuildFileFromProperties

A step based on this step template creates an output file that contains the values of RICOH ProcessDirector job and document properties for a job. The file can be in any format, including XML, JSON, and CSV.

To create the output file, the step first writes the value of the File header property to the output file. Then the step writes the value of the File body property to the file, once for each document in the document properties file. Finally, the step writes the value of the File footer property to the file.

You can use RICOH ProcessDirector symbol notation in all three of those property values. The symbols are placeholders for the job and document values that you want to include in the file when the step creates it.

You can use symbols for job properties—but not document properties—in the values for the File header and File footer properties.

You can use symbols for both job and document properties in the value for the File body property. In the output file, job values are the same for each document.

The step uses the document properties file in the spool directory for the job as input. The file name is in the format jobid.document.dpf where jobid is the job number. For example: 10000009.document.dpf. The first line in the file contains the database name of each document property. Each additional line contains values for each of the properties from one document.

Example

This example shows how the step creates an XML output file for three documents in a job named Bank Statements 02032017 with 14 pages.

The example creates XML elements that contain the values of two job properties:

  • Job name ( Job.Name)
  • Total pages ( Job.TotalPages)

The database names of the properties are in parentheses.

The example creates XML elements that contain the values of four document properties:

  • Document number ( Doc.ID)
  • Current pages ( Doc.CurrentPages)
  • Customer name ( Doc.Custom.CustomerName)
  • Customer account number ( Doc.Custom.AccountNumber)

Value of File header property:

<?xml version="1.0" encoding="utf-8"?>
<InputFile>
  <PDF>${Job.Name}</PDF>
  <TotalPages>${Job.TotalPages}</TotalPages>

Value of File body property:

<Document>
  <DocNumber>${Doc.ID}</DocNumber>
  <PageCount>${Doc.CurrentPages}</PageCount>
  <Customer Custname="${Doc.Custom.CustomerName}" CustAccount="${Doc.Custom.AccountNumber}" />
</Document>

Value of File footer property:

</InputFile>

Document properties file in the spool directory for the job:

Doc.ID,Doc.CurrentPages,Doc.Custom.CustomerName,Doc.Custom.AccountNumber
1,4,Jane Smith,SA349088
2,4,Chris Lopez,SA347202
3,6,John Gray,SA340655

XML output file:

<?xml version="1.0" encoding="utf-8"?>
<InputFile>
  <PDF>Bank Statements 02032017</PDF>
  <TotalPages>14</TotalPages>
  <Document>
    <DocNumber>1</DocNumber>
    <PageCount>4</PageCount>
    <Customer Custname="Jane Smith" CustAccount="SA349088" />
  </Document>
  <Document>
    <DocNumber>2</DocNumber>
    <PageCount>4</PageCount>
    <Customer Custname="Chris Lopez" CustAccount="SA347202" />
  </Document>
  <Document>
    <DocNumber>3</DocNumber>
    <PageCount>6</PageCount>
    <Customer Custname="John Gray" CustAccount="SA340655" />
  </Document>
</InputFile>

Job property defaults
  • File header:

  • File body:

  • File footer:

  • Output file:

Usage notes:

  • To create an output file that contains the values of job properties but not document properties, leave the value of the File body property blank.
  • The step writes the value of the File body property to the output file only when both these conditions apply:
    • The File body property specifies a value, typically referencing one or more valid document properties.
    • The spool directory for the job contains a document properties file.
  • If you created XML or JSON output, you can validate it by using a step based on the CheckFileStructure step template.
  • If no values are supplied for the File header, File body, and File footer properties, the step creates an empty file.

1.2.10.2.9 BuildPDFFromDocuments

A step that is based on the BuildPDFFromDocuments step template creates a single PDF file for the current job. The step places the documents in the sequence that is specified in the document properties file. After creating the PDF file, the step optimizes the file. The step also creates a JDF job ticket with media and finishing options.
The subsequent steps in the workflow use the PDF and JDF files produced by this step.

This step applies markup if it is defined in one or more RICOH ProcessDirector Plug-in for Adobe Acrobat control files. You specify these control files by name and location in the Build PDF control file properties for this step.

This step combines information from the original RICOH ProcessDirector JDF job ticket with options (simplex or duplex, number of copies, media, and finishing) specified in the Build PDF control files.

Job property defaults
  • Duplex: Yes
  • Build PDF control file 1: Not set
  • Build PDF control file 2: Not set
  • Build PDF control file 3: Not set
  • Build PDF control file 4: Not set
  • Maximum documents in memory: 200
  • Page exceptions for sides: Replace with job value
Usage notes
  • This step uses the documents and document properties identified in the IdentifyPDFDocuments step to generate the PDF file. If the PDF file changes after IdentifyPDFDocuments runs, the BuildPDFFromDocuments step does not use those changes.
  • If the JDF file changes after the IdentifyPDFDocuments step runs, the BuildPDFFromDocuments step does not use those changes, with one exception: media and finishing options for a job. Those changes are not set until BuildPDFFromDocuments runs.
  • You can add more than one control file to any Build PDF control file property. If you do, use a semicolon to separate each control file.
  • This step discards any page exceptions for media and finishing options specified in the original RICOH ProcessDirector JDF job ticket. If the Page exceptions for sides property is set to Replace with job value, the step also discards sides page exceptions. The step retains media and finishing options for the job. For example, a control file specifies blue paper for page 1 in document 5 of a simplex job. The RICOH ProcessDirector JDF job ticket specifies white paper for the job and green paper for page 7. The BuildPDFFromDocuments step discards the RICOH ProcessDirector page exception for green paper. The JDF job ticket produced by the BuildPDFFromDocuments step specifies blue paper for page 1 of document 5 and white paper for the rest of the job.
  • If the PDF job has a JDF job ticket that specifies a combination of simplex and duplex pages, use the Page exceptions for sides property to set how the step combines the Duplex value for the job with the JDF sides settings. If the step creates Sides page exceptions, add an OptimizeJDF step in the workflow after the BuildPDFFromDocuments step to speed processing.
  • The value of the Maximum documents in memory property determines the maximum number of documents that are in memory when this step adds documents to the PDF file. If you have memory issues when this step is processing jobs even though other IdentifyPDFDocuments and BuildPDFFromDocuments steps are not running, decrease the value of this property.
  • Because the step optimizes the PDF file, you do not need to add the OptimizePDF step after the BuildPDFFromDocuments step.
  • If you get unexpected results when you process a PDF 2.0 file with a step based on the BuildPDFFromDocuments step, do one of these:
    • Upgrade the control file to the latest version.
    • Place a step based on the OptimizePDF step template in the workflow before the BuildPDFFromDocuments step.
  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.

1.2.10.2.10 BuildPDFFromSets

A step that is based on this step template concatenates the PDF files received by a hot folder input device that uses the Number of sets, Pages in sets, or Sets by time batching method into a single PDF file.
Job property defaults
  • Add blank page: Yes
Usage notes
  • A step that is based on this step template cannot process encrypted PDF files.
  • Only PDF files from complete sets are added to the final PDF file. The files are added in the same order they were added to the hot folder input device.

1.2.10.2.11 BuildPDFFromZIP

A step that is based on this step template builds a single PDF file from the contents of a .zip file.
Job property defaults
  • Add blank page: Yes
Usage notes
  • A step that is based on this step template can be used only for PDF files packaged as .zip files.
  • A PDF job that is not inside a .zip package can also be processed by the step.
  • A step that is based on this step template cannot be used to process a .zip file that includes any encrypted PDF files.
  • The original PDF files are added to the final PDF file based on the order of the PDF files in the .zip or list file. For example, if you submit a .zip file that you created, the order of the final PDF file reflects the order of that .zip file. If you use the List batching method and set the Create .zip file property to Yes, the order of the final PDF file reflects the order of the list file. If you use any batching method other than List and set the Create .zip file property to Yes, the order of the final PDF file is based on the timestamp of the individual PDF files in the .zip file.

1.2.10.2.12 CallRESTService

A step based on this step template lets you call REST-based web services to communicate with applications.

Job property defaults
  • Request URL:

  • Request method: GET

  • Request payload type: TEXT

  • Request payload:

  • Request header:

  • Request parameters:

  • Use proxy: Not set

  • Response file: ${getFileName(print,json,write)}

  • Password:

Usage note: You can add this step template to a job more than once.

1.2.10.2.13 CallSOAPService

A step based on this step template lets you call SOAP-based web services to communicate with applications.

Job property defaults
  • Request URL:

  • Request payload type: TEXT

  • Request payload:

  • Use proxy: Not set

  • Response file: ${getFileName(print,xml,write)}

  • SOAP request: Not set
  • Password:

Usage note: You can add this step template to a job more than once.

1.2.10.2.14 ChangeHeader

A step that is based on this step template changes the contents of the banner page that prints before the print job. Use this step template with the preview print function to identify the properties used for a given sample job.
Job property defaults
  • External program language: Not set
  • External command: header.pl Job.Print.HeaderConfig /aiw/aiw1/control_files/banner_pages/header_pp.cfg ${getFileName(overrides,text,write)}
  • External control file template:
  • Valid return codes: 0
Usage note
  • If you add a step based on this step template to a workflow used to process PDF jobs and send them to a Passthrough printer, make sure you change the file name in the External command property so that it points to the appropriate .jrxml file.

1.2.10.2.15 ChangeJobType

A step that is based on the ChangeJobType step template transfers control to the workflow specified in the New workflow property. ChangeJobType lets you reuse some of the information from another workflow to avoid repetition.

Before ChangeJobType transfers control, it creates an overrides file containing the values of the job properties in the current workflow. You use the step template SetJobPropsFromTextFile in the new workflow to set the values for the job properties to the values in the overrides file. Job property values from the steps of the new workflow are used only if the overrides file created by the ChangeJobType step does not contain values for those job properties.

Job property defaults
  • New workflow: Not set

1.2.10.2.16 CheckFileStructure

A step based on this step template checks that the syntax of a JSON or XML file is valid. If the syntax is not valid, the job goes into the error state.

Job property defaults
  • File to check:

  • File format: Not set

Usage notes:

  • You can use RICOH ProcessDirector symbol notation for the name of the file that the step checks. For more information about symbol notation and how to use it, refer to the help system.

1.2.10.2.17 CombineAFPWithForm

A step based on this step template replaces preprinted forms by combining electronic forms with data in AFP files.

The step adds PDF pages as medium overlays to medium maps that specify a RICOH ProcessDirector media name. If the medium map specifies tray numbers, the step uses the file set in the Tray mapping file property to replace tray numbers with media names.

If the medium map for a job specifies media, the step ignores any values set for the Media and PLE Media job properties.

If the medium map for a job does not specify media, the step uses the value set for the Media property. If you set the property to the name of a RICOH ProcessDirector media object that includes electronic forms, the step combines the electronic forms with the job data. The step does not use any values set for the PLE Media property.

To define electronic forms for a media object, you use the properties on the Electronic Form section of the media object:

  • Front of form and Back of form

    These properties specify the electronic PDF forms to use for the front and back sides of the media. When the step processes jobs that request media with values for these properties, the step combines the forms with the data for the appropriate pages.

  • Media name for printing

    Because electronic forms replace media with preprinted forms, this property tells the step how to remove or change the names of media with electronic forms:

    • If the property is set to None, the step removes the current tray number or media name from the medium map.
    • If the property is set to Selected, the step replaces the current tray number or media name in the medium map with the selected media name.
    • If the property is set to Current name, the step does not change the current tray number or media name in the medium map.

Job property defaults
  • Combined AFP file: ${getFileName(print,afp,write)}

  • Tray mapping file:

Usage notes

  • This step template is available when the Preprinted Forms Replacement and AFP Support features are installed.
  • You can only print the output of this step to AFP printers that support PDF object containers in AFP data.
  • Matching on media names is case-sensitive. If the medium map specifies a media name in all uppercase letters (such as LETTER BLUE), RICOH ProcessDirector must have media named LETTER BLUE. Letter Blue does not match.
  • The CombineAFPWithForm step can process AFP jobs that use an inline form definition or an external form definition. The step creates a combined AFP file that uses an inline form definition. If the AFP job uses an external form definition, the step embeds the changed form definition with new medium maps inline in the combined AFP file.
  • More processing is required when a media object includes an electronic form for the back side and the medium map specifies simplex printing. The step modifies the existing medium map:
    • It converts simplex to duplex.
    • It turns on the Constant Back flag.
    • It wraps the PDF file for the requested electronic form in an overlay and assigns the overlay to the back of the media.

    The step keeps the same name for the medium map. Any existing Invoke Medium Map (IMM) structured fields now point to the new duplex medium map.

  • If the medium map for a job does not specify media, you can set the media on the PrintJobs step or with an AssignJobValues step. Place the AssignJobValues step before the CombineAFPWithForm step in the workflow.
  • If your workflow has an afpnorm command in a step based on the RunExternalProgram step template, put the CombineAFPWithForm step after the RunExternalProgram step.

    You can use the afpnorm command to insert IMM structured fields before the first page of every document in an AFP file.

  • You cannot add an electronic form to a side of a sheet when the side already has eight medium overlays.
  • If you add an electronic form to a job with one or more opaque overlays, the opaque overlays can hide the overlay for the electronic form. To avoid this problem, make all existing overlays that overlap electronic form overlays transparent.

1.2.10.2.18 CombinePDFWithForm

A step based on this step template replaces preprinted forms by combining electronic forms with data in PDF files.

To define electronic forms for a media object, you use the properties on the Electronic Form section of the media object:

  • Front of form and Back of form

    These properties specify the electronic forms to use for the front and back sides of the media. When the step processes jobs that request job-level or page-exception media with values for one or both of these properties, the step combines the forms with the data for the appropriate pages.

  • Media name for printing

    Because electronic forms replace media with preprinted forms, this property tells the step how to remove or change the names of media with electronic forms:

    • If the property is set to None, the step removes the current media name.
    • If the property is set to Selected, the step replaces the current media name with the name of the selected media.
    • If the property is set to Current name, the step does not change the current media name.

    The step removes or changes the media names in the property notebooks and JDF files for jobs.

Job property defaults
  • Combined PDF file: ${getFileName(print,pdf,write)}

  • JDF output file: ${getFileName(overrides,jdf,write)}

Usage note: When a media object includes a form for the back of the media, the step changes simplex jobs that require the media to duplex.

For example, a simplex job has four pages. The PLE Media property specifies Form12 for page 3. The Form12 media object specifies an electronic form for the back of the media.

When the step processes the job:

  • It converts the job to duplex.
  • It adds three blank pages, one each after pages 1, 2, and 4.
  • It adds a page with the data for Form12 after page 3.

When a media object includes a form for the back of the media and the JDF job ticket associated with the job specifies simplex for the job but includes page exceptions for some duplex pages, the CombinePDFWithForm step changes simplex jobs that require the media to duplex. For example, a simplex job has four pages. The PLE Media property specifies Form99 for pages 2 and 3. The Form99 media object specifies an electronic form for the back of the media.

When the step processes the job:

If the Simplex sheet processing property is set to Insert blank back pages, the step:

  1. Converts the job to duplex.
  2. Adds one blank page after page 1.
  3. Adds a page with the data for Form99 on the backs of pages 2 and 3.

    The back of page 3 has the data from page 4 and the data for Form99.

If the Simplex sheet processing property is set to Add Sides page exceptions to JDF, the step:

  1. Does not change the Duplex property for the job from Simplex.
  2. Adds a new duplex side page exception for page 2 in the JDF.
  3. Adds a page with the data for Form99 on the backs of pages 2 and 3.

1.2.10.2.19 CompleteDocuments

A step that is based on the CompleteDocuments step template causes the documents in the job to move to the Complete state. A workflow used for production jobs can specify the CompleteDocuments step to inform the workflow for the original job that its WaitForDocumentCompletion step can complete.
Usage notes
  • You cannot copy this step template.
  • CompleteDocuments is not required in workflows. If the original job creates child jobs, RICOH ProcessDirector makes sure that the parent job stays in the system until the child jobs are removed. Accordingly, because CompleteDocuments is not being used, you do not need a step based on the WaitForDocumentCompletion step template.

1.2.10.2.20 ComposeAFP

A step that is based on this step template uses Quadient Inspire Designer to generate a new AFP file from a WFD file and raw data files. The step waits for the new file to be returned.

This AFP step template is available when the Quadient Inspire Connect and AFP Support features are installed.

Job property defaults
  • Data files: ${getFileName(origoverrides, text, read)}
  • Data modules:
  • Fixed data files:
  • Fixed data modules:
  • Quadient JOB file:
  • External command: PNetTC ${Job.GMC.WFDFileLocation} ${Job.GMC.SetupDataFiles} -o MyOutput1 -e AFP -f ${getFileName(print, afp, write)}
  • External program language: Not set
  • External program code page: UTF8
  • Valid return codes: 0,2
  • WFD file: ${getFileName(print, unknown, read)}
Usage notes
  • If Quadient Inspire Designer is not listed in the PATH environment variable for the system (aiw1 is the default RICOH ProcessDirector system user in Linux), replace PNetTC in the External command property with the full path to the program.
  • The Job.GMC.SetupDataFiles property used in the external command does not appear in the user interface because you cannot enter a value for it. RICOH ProcessDirector concatenates the values of the Data files, Data modules, Fixed data files, and Fixed data modules properties in the correct order and stores them as the Job.GMC.SetupDataFiles property. You can use this property in commands and symbol formulas that require more than one of those values.
  • If you list a value for the Quadient JOB file, you must also add this text to the value of the External Command property: -c ${Job.GMC.JobFile}

1.2.10.2.21 ComposePDF

A step that is based on this step template uses Quadient Inspire Designer to generate a new PDF file from a WFD file and one or more raw data files. The step waits for the new file to be returned.
Job property defaults
  • Data files: ${getFileName(overrides, text, read)}
  • Data modules:
  • Fixed data files:
  • Fixed data modules:
  • Quadient JOB file:
  • External command: PNetTC ${Job.GMC.WFDFileLocation} ${Job.GMC.SetupDataFiles} -o MyOutput1 -e PDF -f ${getFileName(print, pdf, write)}
  • External program language: Not set
  • External program code page: UTF8
  • Valid return codes: 0,2
  • WFD file: ${getFileName(print, unknown, read)}
Usage notes
  • If you want to send a PDF file with a WFD file to Quadient Inspire Designer to be reformatted, change WFD file to ${getFileName(origoverrides, text, read)}.

  • If Quadient Inspire Designer is not listed in the PATH environment variable for the system (aiw1 is the default RICOH ProcessDirector system user in Linux), replace PNetTC in the External command property with the full path to the program.
  • The Job.GMC.SetupDataFiles property used in the external command does not appear in the user interface because you cannot enter a value for it. RICOH ProcessDirector concatenates the values of the Data files, Data modules, Fixed data files, and Fixed data modules properties in the correct order and stores them as the Job.GMC.SetupDataFiles property. You can use this property in commands and symbol formulas that require more than one of those values.
  • If you list a value for the Quadient JOB file, you must also add this text to the value of the External Command property: -c ${Job.GMC.JobFile}

1.2.10.2.22 CompressFiles

A step that is based on this step template compresses job files that match the value of the Compress file patterns job property.
Job property defaults
  • Compress file patterns:
Usage notes
  • The value of Compress file patterns uses regular expression syntax:
    • Period (.) matches a single occurrence of any character (letter or number).
    • Asterisk (*) matches zero or more occurrences of the preceding character, up to the maximum file name length.
    • Backslash (\) is the escape character that means that the next character is interpreted literally.
    • Dollar sign ($) means that a match signifies the end of the expression.
  • Characters in the value are case-sensitive. For example, .*PDF$,.*AFP$ represent patterns that are different from .*pdf$,.*afp$.
  • Separate multiple patterns by commas; do not type a space between them.

1.2.10.2.23 ContinueToNextStep

A step that is based on this step template continues to the next step without doing any processing. You can use this step to establish a restart point when reprocessing a job, using the Step restart type property.

When you use ContinueToNextStep as a restart point for a job (that is, the Step restart type property has a value other than None), you may restore the input file to the state it was in before starting the next step.

Job property defaults
  • None

1.2.10.2.24 ConvertJSONtoXML

A step based on this step template transforms a JSON file into an XML file.
Job property defaults
  • JSON input file: ${getFileName(print,json,read)}
  • XML output file: ${getFileName(print,xml,write)}

1.2.10.2.25 ConvertLineDataJobIntoAFP

A step that is based on this step template converts a line-data job into the Advanced Function Presentation (AFP) format by calling the line2afp data stream conversion component of RICOH ProcessDirector as an external program. This step also sets a variety of job properties that control the conversion process.
Job property defaults
  • AFP resource path:
  • Carriage controls present: Yes
  • Carriage control type: Z
  • CHARS:
  • Code page global identifier:
  • Duplex: Not set
  • Extended options:
  • External command: line2afp parmdd=${getControlFileName()}
  • External control file template: /aiw/aiw1/control_files/external_programs/prepare_line2afp.cfg (Linux) or C:\aiw\aiw1\control_files\external_programs\prepare_line2afp.cfg (Windows)
  • External program language: Not set
  • External program code page: Not set
  • Form definition: F1A10111
  • Image output format : IOCA
  • Input data stream: Unknown
  • Line data file format: STREAM
  • Map Coded Font Format 2 method: CF
  • Page definition:
  • Processing mode:
  • Resource type: Inline, Formdef
  • Table reference characters: No
  • Valid return codes: 0
Usage notes
  • If any of these keywords are used in a parameter file that is submitted with a print job, the values for the keywords must be specified in ASCII text:
    • COMSETUP
    • CHARS
    • FIELD
    • FORMDEF
    • INDEX
    • PAGEDEF
    • TRIGGER
    • USERMASK
  • By default, messages from steps that are based on this step template are issued in the language in which the RICOH ProcessDirector base product is installed. To change the language for the messages, set the value of the External program language property for the step.

1.2.10.2.26 CopyToFolder

A step that is based on this step template copies a RICOH ProcessDirector print file from the spool directory for the job to a different directory location. Replace the /aiwdir directory in the external command for the step template with an existing directory before using the step template as a step in a workflow.
Job property defaults
  • External command: cp ${getAbsoluteFileName(print,unknown,read)} /aiwdir
  • External program language: Not set
  • External program code page: Not set
  • Valid return codes: 0
Usage notes
  • The default command assumes that the file being copied is in an unknown format. To copy a file in PDF format, use the command: cp ${getAbsoluteFileName(print, pdf, read)} /directory/${Job.InputFile} , where directory is the directory that you want to copy the file into.
  • The External program language property sets the value of the LANG environment variable that the external program can use. The external program must be set up to use this value for it to take effect.
  • This step writes the first 50 lines of standard output (stdout) from your external program to the job log.
  • If stdout is a large data file, use a script that calls the external program as the value of the External command property. Write the script so that it redirects stdout from the command to a file.

1.2.10.2.27 CountPages

A step that is based on this step template calculates the number of pages and sheets for the job, and locates the beginning of each page in a job for use with the viewer component.
Job property defaults
  • Duplex: Not set
Usage Notes
  • To reprint pages in a job, the workflow must include both the CountPages and CreatePageRanges steps. CountPages must run before CreatePageRanges and before PrintJobs. If you have the AFP Support feature installed, you can replace the CountPages step with the EnableRepositioning step. In addition to calculating page counts, EnableRepositioning lets you use the Print again or Jump to functions with AFP data that contains index tags. However, EnableRepositioning requires more processing time, so using CountPages is more efficient if you do not need the additional function.
  • If a step earlier in the workflow fails to create a print file in a valid data stream format, the CountPages step issues a warning message and sends the job to the next step. The job might fail in a later step if the print file is expected.
  • CountPages calculates which pages print on what sheets and, therefore, is affected by the setting of the Duplex property value. If the value of the Duplex property for the job is changed to any value other than Not set after the CountPages step has run, the calculated Total sheets property value might not match the total number of job sheets that actually stack at the printer. The accuracy of the page information provided to the Print again function might also be affected. You can synchronize the page and sheet count information with the new value of the Duplex property by using the Process again action to rerun the CountPages step.
  • When a PDF job with a JDF job ticket specifying a mixture of duplex and simplex pages is processed by the CountPages step, the blank sides of the simplex sheets are not counted in the page count.
  • When working with large PDF files, the amount of memory must be properly assigned to RICOH ProcessDirector to function correctly. If the out of memory message is displayed, open the \aiw\aiw1\config\jvmsettings.cfg (Linux) or /aiw/aiw1/config/jvmsettings.cfg (Windows) file and increase the memory amount by changing the value specified. Save the changes and restart RICOH ProcessDirector.

1.2.10.2.28 CreateAFPJobsFromDocuments

A step that is based on the CreateAFPJobsFromDocuments step template generates one or more child AFP jobs.

The step inserts appropriate medium maps and resolves AFP resources to maintain the original job settings. This step also applies barcodes, cover blocks, and text if you define these modifications by creating an Enhance AFP control file and specify it in the step.

The step creates the child AFP files in individual subdirectories of the children subdirectory of the job's spool directory; for example, /aiw/aiw1/spool/default/JobNumber/children/1 (Linux) or C:\aiw\aiw1\spool\default\JobNumber\children/1 (Windows). When the step completes successfully, RICOH ProcessDirector creates a child job from the AFP file in each subdirectory. You can assign a workflow for all the child jobs that CreateAFPJobsFromDocuments creates by specifying a value for the Child workflow property.

Job property defaults
  • Enhance AFP control file: Not set
  • Child workflow: Not set
Usage notes
  • You cannot delete this step template.
  • The child workflow property is required.
  • When CreateAFPJobsFromDocuments creates a child job, you must use a step based on the SetJobPropsFromTextFile step template for the first step in the child job if you want to transfer job property values to the child job.
  • A step based on the RunExternalProgram step template can also specify job properties (in addition to the workflow) for child jobs by adding columns to the document properties file that use the job property name in the first row. The CreateAFPJobsFromDocuments step adds these properties to the overrides file that it uses to specify the child workflow. If documents for the same child job have different values for these job properties, the step moves the job to an error state.
  • Do not confuse this step template with the SubmitChildFiles step template. SubmitChildFiles cannot be included in a workflow and it does not do the required AFP file processing.

1.2.10.2.29 CreateJobFromFiles

A step that is based on this step template creates a child job from one or more source (input) files. If you specify more than one source file, the system automatically concatenates them. You use this step when you want to create a new job that operates on a single file. For example, if you have one or more text or PostScript files produced by a job that are auxiliary to the main print file, you can use a step based on this step template to create another job to print those files.
Job property defaults
  • Child workflow:
  • Destination file usage:
  • Destination file type:
  • Child job name:
  • First source file:
  • Second source file:
  • Third source file:
  • Fourth source file:
  • Fifth source file:
  • Sixth source file:
  • Seventh source file:
  • Eighth source file:
Usage notes
  • If you use more than one source file, their contents must be compatible when concatenated.
  • If you use an overrides file for the child job, the overrides set in that file will be appended to the overrides created by CreateJobFromFiles. Later properties take precedence, so a workflow value in an overrides file can override the workflow assigned here.
  • You can use RICOH ProcessDirector symbols when specifying a source file name and path.
  • You can specify a source file name as a full path or a relative path. If you use a relative path, the system resolves it with respect to the job's spool folder. For example, for job number 10001025, spool folder /aiw/aiw1/spool/default/10001025, and First source file 3600R.ps, the path resolves to /aiw/aiw1/spool/default/10001025/10001025.3600R.ps.

1.2.10.2.30 CreateInserterReprints

A step based on the CreateInserterReprints step template processes documents to be reprinted after insertion by creating a print file containing only the reprints. The documents are processed using the workflow you specify and the reprint method specified for the inserter controller.
Job property defaults
  • Reprint workflow: Not set
Usage notes
  • The CreateInserterReprints step must run after a step based on the Reconcile step template.
  • If the Reprint method property of the inserter controller is Closed loop, the CreateInserterReprints step reprints the documents in the same job. After all documents in the job have been reprinted, inserted, and reconciled again, the job moves to the next step in the workflow.
  • If the Reprint method property of the inserter controller is Open loop, the CreateInserterReprints step creates a child job to reprint the documents. The child job moves to the first step in the workflow that contains the CreateInserterReprints step. The original job moves to the next step in the workflow.
  • This step must run on the primary server.

1.2.10.2.31 CreateJobsFromDocuments

A step that is based on this step template generates one or more jobs based on entries in the document properties file for the original job. By default, child jobs are created.

CreateJobsFromDocuments creates a document properties file for each child job based on the child job IDs in the document properties file.

The step also creates an overrides files for each child job to specify the child workflow and any child job properties; for example, values for the Total Sheets and Total Pages properties are set for each child workflow.

Note that CreateJobsFromDocuments does not create the file for the child job. The child workflow must have a BuildAFPFromDocuments or BuildPDFFromDocuments step in it to create the file for further processing.

You can assign a workflow for all the child jobs that CreateJobsFromDocuments creates by specifying a value for the Child workflow property.

Job property defaults
  • Child workflow: Not set
Usage note

You cannot delete this step template.

1.2.10.2.32 CreateJobsFromRepositorySearch

A step that is based on this step template searches a repository and creates one or more jobs based on the data retrieved. The step processes these searches based on the criteria specified in a file or a string. When the step completes, new jobs are created using the selected workflow with the data retrieved from the search.

The results of the search are returned in one or more ZIP files. The ZIP files include the data files for the jobs or documents. The ZIP files also contain the overrides file and a document overrides file when those files exist in the repository. For each set of search criteria, the step can return multiple jobs or documents and include them in the ZIP files. Each individual ZIP file is submitted as a separate job.

Job property defaults
  • Repository: Not set
  • Workflow for new jobs:
  • Search criteria:
  • Stop when no results are found: Yes
  • Create as child job: Yes
  • Path to override properties file:
Usage notes
  • You must have at least one repository defined to use this step.
  • Search criteria can contain entries for multiple archive searches. Make sure that each entry is on a separate line separated by a carriage return. You can also provide a full file path to a file that contains the search criteria you want to use.

    You can use symbol notation for job properties in the Search criteria field. If you put the search criteria in a file, you can use symbol notation for both job and document properties. For example: ${Doc.Custom.AccountNumber}=20035564. For more information about symbol notation and how to use it, refer to the help system.

  • To generate the Search criteria in the correct format, use the Search function on the Archive tab. Enter the search options for this step to use and click Search. At the bottom of the Search criteria list, you can see the Search criteria.

    Copy all the text after the number in parentheses and paste it into the Search criteria field or into the search criteria file.

  • If your search results contain a large amount of data, make sure that the default spool directory has enough disk space to process the data. The step creates a temporary copy of all data returned by the search in this directory:
    • /aiw/aiw1/spool/default (Linux)
    • C:\aiw\aiw1\spool\default (Windows)

    For example, if the search returns five PDF files of 4 GB each, the step would require 20 GB of disk space in the default spool directory.

    When the step finishes, it deletes the temporary copy of the data.

  • When you create child jobs, the job processed by the CreateJobsFromRepositorySearch step becomes the parent job for the jobs created by the step. If you add a WaitForRelatedJobs step to the workflow for the parent job, the parent job stays in the system until all the child jobs complete. If you want to use the same workflow to process the child jobs, you can assign a rule to a connector that sends the child jobs through a different branch.
  • Property values, such as Media and Job copies requested, are not passed from the job in the CreateJobsFromRepositorySearch step to the jobs created by the step unless you create an override properties file. When you specify the database names of job properties in an override properties file, RICOH ProcessDirector creates an overrides file with the values of the properties. This overrides file is passed to every job created by the step.

    For example, you receive print jobs for books. The value of the Custom 1 property for the job in the CreateJobsFromRepositorySearch step is Ghost Story, the title of the book to be printed. Specify Job.Info.Attr1 (the database name of the Custom 1 property) in the override properties file. RICOH ProcessDirector creates an overrides file with Job.Info.Attr1=Ghost Story and passes it to every job created by the step. For information about overrides files, refer to the Information Center.

  • Steps based on the CreateJobsFromRepositorySearch step template have positional properties. You can place a step with positional properties in a workflow multiple times, and the job properties can take different values when each step is used. In the job property notebook, the phase and step names appear as section names with the properties of the step shown inside the section.

1.2.10.2.33 CreateJobsFromXML

A step based on this step template lets you create one or more XML jobs from the contents of an XML input file. The step submits the jobs to a workflow that you specify.
Job property defaults
  • XML input file: ${getCurrentFile(xml)}
  • XPath expression to create jobs:
  • Create as child job: Yes
  • Workflow for new jobs:
  • Stop when no matching elements: No
Usage notes
  • The step lets you create XML jobs from the elements in an XML input file that match an XPath expression.
  • You can use any valid XPath expression. For example:
    • A publishing company uses this XPath expression to create jobs for all books with more than 100 pages:

      /bookstore/book[pages>100]/pages

    • A print shop uses this XPath expression to create jobs for each of the poster and business-card elements in an XML input file:

      //order/poster | //order/businesscards

  • A workflow can run two or more CreateJobsFromXML steps on the same XML input file, and each step can use a different value for the XPath expression to create jobs property.

    For example, a workflow receives an XML input file containing an order for both printable items and inventory items (such as coffee mugs and baseball caps). One branch of the workflow processes the printable items, and another branch processes the inventory items. The CreateJobsFromXML step in the first branch uses an XPath expression to find all elements that contain the printable items in the order. The CreateJobsFromXML step in the second branch uses an XPath expression to find all elements that contain the inventory items.

  • The XML input file can be the job file in the spool directory or a file stored at another location on the system.
    • If it is the job file, keep the default value for the XML input file property.

    • If it is stored at another location, specify the full path and file name as the value of the XML input file property.

      When the XML input file is stored at another location, the file does not become part of the job that the CreateJobsFromXML step processes. The step reads the information in the file, uses the information to create XML files, and submits those XML files as jobs.

  • The values of the XPath expression to create jobs property and the Workflow for new jobs property are optional when you specify step properties, but they are required when the CreateJobsFromXML step runs.

    The values can be set as input to a step ahead of a CreateJobsFromXML step in a workflow. For example, you can put an AssignJobValues step ahead of the CreateJobsFromXML step. Create a configuration file that sets the values of these properties. On the AssignJobValues step, specify the configuration file as the value of the Job values file property. Because the XPath expression to create jobs property and the Workflow for new jobs property are positional job properties, you cannot set their values by using the Values to set property on the AssignJobValues step.

  • The value of the Create as child job property determines whether this step creates child jobs or independent jobs.

1.2.10.2.34 CreateOrderInSlingshot

A step based on this step template lets you call an Avanti Slingshot web service that creates an order for a job received from RICOH ProcessDirector.

After Slingshot creates an order for the job, you can use the functions in the Avanti Slingshot Connect feature to report job processing information to Slingshot.

To configure your Slingshot system to create orders for jobs received from RICOH ProcessDirector, contact your Avanti support representative.

Job property defaults
  • Request URL: http://avantidev:8080/servoy-service/rest_ws/avanti_api/api_web_service

  • Request method: POST

  • Request payload type: FILE

  • Request payload: /aiw/aiw1/testfiles/avanti/createOrder.xml

  • Request header:

  • Request parameters:

    SenderID:RPD_INRequestType:NewOrderUsername:RICOH\JDFPassword:jdf

  • Use proxy: Not set

  • Response file: ${getFileName(print,xml,write)}

  • Password:

Usage notes:

  • Run this step on a job one time only. Slingshot returns a status code 500 error when it receives the same job number more than once. RICOH ProcessDirector then moves the job to the error state.

  • When you restart a job after Slingshot has created an order for it, make sure that a CreateJobInSlingshot step does not process the job.

  • You can put this step in a workflow multiple times. Make sure that each step is in a separate branch so that the steps do not process the same job.

  • You can run this step on parent or child jobs. Orders created in Slingshot from parent or child jobs do not retain the relationship between parent and children.

  • The value of the Request URL property is the call to the Slingshot web service that creates an order for each job received from RICOH ProcessDirector. Your Avanti support representative supplies the URL.

  • The value of the Request payload property is the full directory path and name of the file containing the XML order information that RICOH ProcessDirector sends to Slingshot. Your Avanti support representative creates this file for you.

    A sample file is at /aiw/aiw1/testfiles/avanti/createOrder.xml (Linux) or C:\aiw\aiw1\testfiles\avanti\createOrder.xml (Windows). The sample file uses symbols to send Slingshot the job number and the number of copies requested.

  • The value of the Request parameters property is a set of four parameters.

    Work with your Avanti support representative to fill in values for the SenderID, Username, and Password parameters. The value of the RequestType parameter does not change.

1.2.10.2.35 CreatePageRanges

A step that is based on this step template rebuilds the page information needed for accurate repositioning when a partial job is reprinted. When all pages of a job are being printed, this step takes no action.
Job property defaults
  • Duplex: Not set
Usage notes
  • If this step is included in a workflow, the CountPages or EnableRepositioning step should also be included in the workflow. The CreatePageRanges step should come after the CountPages or EnableRepositioning step.
  • If this step is included in a workflow, it should be placed before the PrintJobs step.
  • Messages from this step template are issued in the language in which the RICOH ProcessDirector base product is installed.
  • When working with large PDF files, the amount of memory must be properly assigned to RICOH ProcessDirector to function correctly. If the out of memory message is displayed, open the /aiw/aiw1/config/jvmsettings.cfg file and increase the memory amount by changing the value specified. Save the changes and restart RICOH ProcessDirector.

1.2.10.2.36 CreateReprints

A step based on the CreateReprints step template processes documents to be reprinted after reconciliation by creating a print file containing only the reprints. The documents are processed using the workflow you specify.
Job property defaults
  • Reprint workflow: Not set
Usage notes
  • We recommend that you run the CreateReprints step after a step based on the Reconcile step template.
  • The CreateReprints step creates a child job to reprint the documents. The child job moves to the first step in the reprint workflow. The original job moves to the next step in its workflow.
  • This step must run on the primary server.

1.2.10.2.37 DecryptPDF

A step based on this step template decrypts and removes password protection for a PDF file.

Job property defaults

  • Owner password (required):

  • Decrypted PDF file: ${getFileName(print,pdf,write)}

Usage note: By default, the decrypted PDF file becomes the file in the spool directory of the job.

1.2.10.2.38 DetectInputDatastream

A step that is based on this step template analyzes the first bytes of the input file when the input data stream type is Unknown. If the step can determine the type of the input data stream, the step sets the value of the Input data stream property accordingly.
Job property defaults
None
Usage notes
  • The Input data stream property detects these values: GIF, JPEG, TIFF, AFP, ZIP, PDF, PCL, XML, PS, and JSON. If none of these values are detected, RICOH ProcessDirector sets the Input data stream property value to Unknown.

1.2.10.2.39 DownloadFile

A step based on this step template downloads a file from an external source to a location that the RICOH ProcessDirector server can access.
Job property defaults
  • Path to downloaded file:
  • URL for download file:
  • Use proxy server: No
Usage notes
  • If the URL for the file presents a security certificate before the file can be downloaded, RICOH ProcessDirector accepts this certificate automatically.
  • The URL can use any protocol that allows direct download, such as HTTPS and SFTP.
  • If credentials are required to access the Web site where the file resides, the credentials should be included in the value entered for the URL for download file property.

    For example: ftp://username:password@host/path/file.

1.2.10.2.40 EditAFP

A step that is based on this step template creates barcodes, text, and hidden areas in AFP files. The barcodes, text, and hidden areas are defined in a control file that you create using RICOH Visual Workbench and AFP Editor. When you configure the step, you can choose to create any page groups and index tags that are defined in the same control file before creating the barcodes, text, and hidden areas. You use AFP Indexer to create page groups and index tags.
Job property defaults

  • Index first: Yes
  • Visual Workbench control file:

Usage notes

  • If the Index first property is Yes, do not run the IndexAFP step because the Index first option provides the same function as the IndexAFP step. It is more efficient to select the Index first option.
  • Do not select Index first if the IndexAFP step and the EditAFP step must be done in different phases. For example, if a barcode contains the document sequence and another step in the workflow sorts the documents in a different order, you might put the IndexAFP step in the Prepare phase and then put the EditAFP step after the build step in the Assemble phase.
  • Position the step relative to these steps if they are present:
    • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step)
    • After a step that converts Xerox data to AFP format
    • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step)
    • Before the EnableRepositioning step if you configure the EditAFP step to create page groups and index tags
    • Before the PrintJobs step
    • After a step based on the IndexAFP step template (unless using Index first)
    • After a step that changes the property values in the barcode
  • If you created fixed-length page groups with the IndexAFP step template, you can use the EditAFP step template to enhance AFP files that the RICOH ProcessDirector Transform Features create.

1.2.10.2.41 EmailDocuments

A step based on this step template emails each PDF document in a job as an attachment to an individual email address.

RICOH ProcessDirector can send email directly through an SMTP server or indirectly through an email service provider.

Job property defaults
  • Attach document: Yes
  • Blind copy address:
  • Copy address:
  • Message:
  • Recipient address:
  • Secure connection: None
  • Sender address:
  • SMTP server type: Alternate
  • Source file for attachment: ${getFileName(print,pdf,read)}
  • Subject line:
  • Name of attachment: ${Job.Name}
Usage notes
  • To test your email setup, create a test job with a small number of documents. Enter your own email address for the Recipient address property and submit the job to the workflow. Make sure you receive an email for each document in the job.
    Important: Do not send a job with a large number of documents through the workflow while the Recipient address property is set to your email address. If you do, you are going to spam yourself.
  • If you can set a value for the Doc.EmailAddress property for each document in the job, you can enter the symbol ${Doc.EmailAddress} as the value for the Recipient address property to have each document sent to its associated email address.
  • Make sure the SMTP server settings are correct for the server that you want to use.
    • If your SMTP server requires a user name and password, make sure that you update the correct system properties:
      • For the default SMTP server, use the SMTP user name and SMTP password properties.
      • For the Alternate SMTP server, use the Alternate SMTP user name and Alternate SMTP password properties.
    • This step supports SSL or TLS connections without certificate authentication. If you use an SSL or TLS connection, you must specify the correct port to use.
      • For the default SMTP server, use the Email SSL port or Email TLS port property.
      • For the Alternate SMTP server, use the Alternate SMTP SSL port or Alternate SMTP TLS port property.

      If the SMTP server that this step uses is configured to use SSL or TLS security and the correct port is not configured, the job goes into the Error state.

  • This step only sends email when the job reaches it. No email is sent if the job:
    • Stops processing because of an error before reaching the step.

    • Goes through a branch (in a conditional workflow) that bypasses the step.

  • For each document that is sent to the SMTP server, this step sets the Email created property value to Yes in the document properties file. For each document that is not sent to the SMTP server, the Email created property value for that document is set to No.
  • If two or more EmailDocuments steps process a job, the Email created property for each document shows the status of the last EmailDocuments step that processed the job.
  • If no email is sent, the job goes into the Error state.

  • You can add this step to a workflow more than once.

1.2.10.2.42 EnableRepositioning

A step that is based on this step template locates the beginning of each page in an AFP or PDF job for use with the RICOH ProcessDirector viewer component.
Job property defaults
  • AFP resource path:
  • Code page global identifier:
  • Duplex: Not set
  • Extended options:
  • Form definition: F1A10111
  • Image output format: As is
  • Valid return codes: 0
Usage notes
  • You cannot copy or delete this step template.
  • The EnableRepositioning step cannot process AFP files containing the Include Saved Page structured field.
  • To reprint pages in a job, the workflow should include this step and the CreatePageRanges step.
  • This step should run before the CreatePageRanges step and before the PrintJobs step.
  • To honor finishing options, this step should run before the job is printed on an AFP printer.
  • RICOH ProcessDirector does not verify that this step is run for jobs with finishing options.
  • AFP jobs that require a specific form definition should specify finishing options in the form definition, not as job properties.
  • Messages from this step template are issued in the language in which the RICOH ProcessDirector base product is installed.
  • If a previous step such as RunExternalProgram fails to create a print file in a supported data stream format, the EnableRepositioning step issues a warning message and continues. If the print file is expected, the job might fail in a later step.
  • The EnableRepositioning step template is included as a step in many of the default workflows. If you do not need the additional function that EnableRepositioning provides, you can substitute a step based on CountPages. Internally, EnableRepositioning runs the AFP Conversion and Indexing Facility (ACIF) process. This provides repositioning information and allows you to change certain aspects of the AFP file, but it requires more processing time.
  • The EnableRepositioning step template computes which pages print on what sheets and, therefore, is affected by the setting of the Duplex and Form definition property values. If the value of the Duplex property for the job is changed to any value other than Not set after the EnableRepositioning step has run, the calculated Total sheets property value might not match the total number of job sheets that actually stack at the printer. The accuracy of the page information provided to the Print again and Jump to functions might also be affected. To synchronize the page and sheet count information with the new value of the Duplex property, you can use the Process again action to rerun the EnableRepositioning step.
  • The EnableRepositioning step does not count pages that are defined in the medium map as constant back pages. If you have the Preprinted Forms Replacement feature, the CombineAFPWithForm step turns on the Constant Back flag when a media object includes an electronic form for the back side and the medium map specifies simplex printing. Those constant back pages are not included in the Total pages property for the job and are not displayed in the viewer.

1.2.10.2.43 EncryptPDF

A step based on this step template encrypts and password-protects a PDF file.

Job property defaults

  • Owner password (required):

  • Password-protected actions: Edit, Fill, Read

  • User password:

  • Encrypted PDF file: ${getFileName(print,pdf,write)}

Usage notes:
  • When you encrypt the PDF, you can choose which actions to protect with a password.

    Edit, Fill, Read
    The Owner password is required to read, fill in any form fields, or edit the PDF file. The User password is used to open the file and must be specified when this value is set.
    Edit, Fill
    The Owner password is required to edit the PDF file or fill in any form fields in the PDF file. A password is not required to read the file.
    Edit
    The Owner password is required to edit the PDF file. A password is not required to read the file or fill in any form fields in the PDF file.
  • The User password is used when the downstream recipient or application only needs to read the PDF file. To edit the PDF file or fill in a form inside it, the Owner password is required.

1.2.10.2.44 EnhancePDF

A step that is based on the EnhancePDF step template manipulates or evaluates a PDF file. The actions that manipulate or evaluate the file include rotating pages, removing pages, adding stamp annotations, and checking that the file meets PDF specifications. For each PDF job, the step receives both a PDF file and a JDF job ticket as input.

The subsequent steps in the workflow use the PDF and JDF files produced by this step.

Job property defaults
  • Action list:
Usage notes
  • Type each action, its parameters, and the parameter values on a separate line in the Action list text area.

    This example has 3 actions: RemovePages, AddStamps, and RotatePages.

    RemovePages -pages 3-4,9,12-n

    AddStamps -stampsCSV /aiw/aiw1/control_files/actions/stamp1.csv

    RotatePages -rotate 270 -pagetype landscape

    This example has one action: CheckPDF.

    CheckPDF -outputResultsFile /aiw/aiw1/checkPDF/checkPDFresults.txt

  • When this step runs, it modifies the jobID.print.pdf file and the jobID.overrides.jdf file.

Actions in base product
AddStamps
Function
This action adds a stamp annotation to selected pages of a PDF file based on page number or media name. You can see these stamp annotations in the RICOH ProcessDirector viewer or another PDF viewer. The stamp annotations are not printed.

You cannot use a program such as Adobe Acrobat to modify a stamp annotation or change its print setting.

Parameters
-stampsCSV
This required parameter specifies the full path or symbolic name of a CSV file.
Examples
To add a stamp annotation to selected pages in a PDF file using information in a CSV file at aiw/aiw1/control_files/actions/stamp1.csv , type:

AddStamps -stampsCSV /aiw/aiw1/control_files/actions/stamp1.csv

Usage notes
  • The CSV file contains a heading line and one or more body lines with values for stamp annotations.

    The heading line has this content:

    Page,Media,Image,Author,Content,Subject,XPosition,YPosition,Name

    Each body line in the CSV file contains 9 values, separated by commas:

    Page
    The page that gets the stamp annotation.
      Note:
    • A value for Page or Media is required. If you specify values for both Page and Media, RICOH ProcessDirector adds the stamp annotation to pages that meet either value.
    Media
    The name of the RICOH ProcessDirector media. RICOH ProcessDirector adds the stamp annotation to all pages for which this media name is specified.
    Image
    Required. The full directory path and name of the image file that contains the stamp annotation. RICOH ProcessDirector supports JPEG and PNG images.
    Author
    Optional. The author of the comment attached to the stamp annotation.
    Content
    Optional. The text of the comment attached to the stamp annotation.
    Subject
    Optional. The subject of the stamp annotation.
    XPosition
    Required. The horizontal distance in points from the upper left corner of the page to the upper left corner of the stamp annotation.
    YPosition
    Required. The vertical distance in points from the upper left corner of the page to the upper left corner of the stamp annotation.
    Name
    Optional. The internal name of the stamp annotation. The name does not appear on the stamp annotation or in Adobe Acrobat.

  • This CSV file adds 3 stamp annotations to PDF files:

    Page,Media,Image,Author,Content,Subject,XPosition,YPosition,Name
    3,,/aiw/aiw1/stamps/Parts_Pg_3.png,RICOH ProcessDirector,Content Page 3,Subject Page 3,72,72,Name Page 3
    ,A4 Color,/aiw/aiw1/stamps/Parts_Pg_2.png,RICOH ProcessDirector,Content A4 Color,Subject A4 Color,72,72,Name A4 Color
    4,A4 Plain,/aiw/aiw1/stamps/Parts_Pg_1.png,RICOH ProcessDirector,Content A4 Plain,Subject A4 Plain,144,144,Name A4 Plain

    The first body line adds the image Parts_Pg_3.png to page 3 of the PDF file. The author is RICOH ProcessDirector. The content is Content Page 3. The subject is Subject Page 3. The upper left corner of the image is 72 points to the right and 72 points below the upper left corner of the page. The name is Name Page 3.

    The second body line adds the image Parts_Pg_2.png to all pages in the PDF file that specify RICOH ProcessDirectorA4 Color media.

    The third body line adds the image Parts_Pg_1.png to page 4 and to all pages in the PDF file that specify RICOH ProcessDirectorA4 Plain media.

  • If 2 or more stamp annotations are specified in the same position on a page, RICOH ProcessDirector adds them all.
  • You can use symbol formulas in place of a directory path and file name.

    For example, you want to use the workflow with the EnhancePDF step for input files that require different CSV files for the AddStamps action. To set the value of the CSV file to the name of the input file plus the CSV extension, use ${Job.InputFile}.csv:

    AddStamps -stampsCSV ${Job.InputFile}.csv

CheckOrientation
Function
This action is used on the EnhancePDF step to read the first page of the PDF file to find the values that determine if the document should be printed in the portrait or landscape orientation. This action is also used on the Ricoh TotalFlow printer to set the correct orientation value in the JDF sent to the printer.
Parameters
-RPDproperty
This parameter is used in an Action list on the EnhancePDF step to specify the job property to update with the orientation value found on the first page of the PDF file. Specify Job.PDF. Orientation to see the value in the PDF orientation property on the job property notebook. This parameter should not be specified in the Action list on the printer property notebook.
-ControlUnitJDF
This parameter is used in an Action list for a Ricoh TotalFlow printer to create the correct JDF based on the value of the PDF orientation job property. Specify TotalFlow.
Examples
To set the PDF orientation job property to the value specified on the first page of the PDF file, type the following in the Action list of the EnhancePDF step in a workflow:

CheckOrientation -RPDproperty Job.PDF.Orientation

To create the correct JDF for a Ricoh TotalFlow printer to rotate the pages of a job to the orientation specified in the PDF orientation job property, type the following in the Action list of the Ricoh TotalFlow printer:

CheckOrientation -ControlUnitJDF TotalFlow

Usage notes
  • The value of the PDF orientation job property is used by a Ricoh TotalFlow printer that has the CheckOrientation action specified in its Action list property to create the correct JDF to print the job in the correct orientation.
CheckPDF
Function
This action checks whether the content of a PDF file meets PDF specifications. You can use RICOH ProcessDirector to view and print many PDF files with content that does not meet PDF specifications. However, such content can cause performance problems during printing.
Parameters
-outputResultsFile
Required. Specifies the full path or symbolic name of the output results file, which is a log file in TXT format. The output results file has messages about the results of the check. For all PDF files, including files that meet PDF specifications, the action writes messages with general information to the output results file. If the action finds content that does not meet PDF specifications, it writes error messages to the output results file. If possible, the messages give the numbers of the pages with errors.

To report progress, the action writes a message to the job log after checking 100 pages. For example:

Checked 100 pages.
Checked 200 pages.
Checked 300 pages.

-RPDproperty
Optional. Specifies the database name of a RICOH ProcessDirector job property. We recommend that you use the Job.PDFCheckResult property. If you specify another property, make sure that its data type is String.

After the CheckPDF action checks the PDF file, it sets the value of the job property:

  • If the content meets PDF specifications, the action sets the value to Pass.
  • If the content does not meet PDF specifications, the action sets the value to Fail.
  • If the content is encrypted, the action sets the value to Security.

You can process jobs in different ways based on the value of the job property. For example:

  • If the value is Pass, you can send the job directly to the branch of the workflow that prints PDF files.
  • If the value is Fail, you can send the job to a branch with steps that remove non-standard content and optimize the file.

    If you want to send the job for special processing immediately after the action finds the first error, specify the -fastFail parameter.

  • If the value is Security, you can send the job to a branch that processes encrypted files. For example, a step in the branch can email a request for an unencrypted version of the file.

You can view the value of the Job.PDFCheckResult property on the Enhance PDF tab in the job properties notebook.

-pages
Optional. Specifies individual pages to check in the PDF file:
  • Use a hyphen to separate the first and last pages in a page range.
  • Use a comma to separate page selections.
  • Use a colon followed by a number (n) to make modifications to every nth page in a page range. For example, use :3 to modify every third page in a range.
  • Use n to specify the last page.

If you do not specify this parameter, the action checks all the pages in the PDF file. Checking all the pages in a large file can take the EnhancePDF step a long time to process. To process large files faster, specify individual pages, for example, 1-10.

-fastFail
Optional. Specifies whether the action stops checking the PDF file when it finds the first error.
Values:
true
The action stops checking the PDF file when it finds the first error.
false
The action processes all the pages in the PDF file. It does not stop checking the file when it finds the first error.
Examples
This CheckPDF action checks pages 1, 5 though 10, and all the pages from page 15 to the end of the PDF file:

CheckPDF -outputResultsFile /aiw/aiw1/checkPDF/checkPDFresults.txt -RPDproperty Job.PDFCheckResult -pages 1,5-10,15-n

This CheckPDF action checks all of the even-numbered pages in the job:

CheckPDF -outputResultsFile /aiw/aiw1/checkPDF/checkPDFresults.txt -RPDproperty Job.PDFCheckResult -pages 2-n:2

This CheckPDF action stops checking the PDF file when it finds the first error:

CheckPDF -outputResultsFile /aiw/aiw1/checkPDF/checkPDFresults.txt -RPDproperty Job.PDFCheckResult -fastFail true

All three actions post messages about the content of the PDF file to the /aiw/aiw1/checkPDF/checkPDFresults.txt file. The action sets the value of the Job.PDFCheckResult job property to Pass, Fail, or Security.

RemovePages
Function
This action removes selected pages of a PDF file.
Parameters
-pages
Required. Specifies individual pages in the PDF file:
  • Use a hyphen to separate the first and last pages in a page range.
  • Use a comma to separate page selections.
  • Use a colon followed by a number (n) to make modifications to every nth page in a page range. For example, use :3 to modify every third page in a range.
  • Use n to specify the last page.
Examples
To remove pages 3, 4, 9, and all the pages from page 12 to the end of the PDF file, type:

RemovePages -pages 3-4,9,12-n

To remove all the odd-numbered pages, type:

RemovePages -pages 1-n:2

Usage notes
  • The action adjusts the media information in the JDF file to match the modified PDF file.

    For example, the JDF file specifies blue media for pages 7-8. The action removes page 3-4 from the PDF file and adjusts the JDF file to specify blue media for pages 5-6.

  • If you have the PDF Document Support feature, place the EnhancePDF step that runs this action before the IdentifyPDFDocuments step in a workflow.
RotatePages
Function
This action rotates pages in a job by 90 degrees, 180 degrees, or 270 degrees. You can specify whether to rotate portrait pages, landscape pages, or all the pages in the job.

RICOH ProcessDirector prints the PDF file with the pages rotated.

Parameters
-rotate
Required. Specifies the amount of rotation applied to pages.
Values:
first
RICOH ProcessDirector makes all pages of the specified page type match the first page in the PDF file.
  • If the first page is portrait and the page type is all or landscape, RICOH ProcessDirector rotates all landscape pages to match the first page.
  • If the first page is landscape and the page type is all or portrait, RICOH ProcessDirector rotates all portrait pages to match the first page.
When you set the -rotate parameter to first, we recommend that you set the -pagetype parameter to all.
90
RICOH ProcessDirector rotates all pages of the specified page type clockwise by 90 degrees.
180
RICOH ProcessDirector rotates all pages of the specified page type by 180 degrees.
270
RICOH ProcessDirector rotates all pages of the specified page type clockwise by 270 degrees.
-pagetype
Required. Specifies whether to rotate all landscape pages, portrait pages, or both.
Values:
all
RICOH ProcessDirector rotates all pages in the PDF file.
landscape
RICOH ProcessDirector rotates all landscape pages in the PDF file.
portrait
RICOH ProcessDirector rotates all portrait pages in the PDF file.
Examples
The first page of a PDF file is portrait. To rotate all landscape pages in the PDF file to match the first page, type:

RotatePages -rotate first -pagetype all

To rotate all portrait pages in a PDF file clockwise by 90 degrees, type:

RotatePages -rotate 90 -pagetype portrait

Usage notes
  • This action rotates pages in the PDF file, not the job ticket.
  • This action rotates the page and its content together. It does not rotate the content separately from the page.
  • To see the output of the RotatePages action, print the PDF file. If the PDF viewer rotates pages for optimum viewing, the rotation of the printed pages can differ from the viewed pages.
  • If you are correcting jobs with mixed portrait and landscape pages, consider which edge is used for binding, especially if the pages are duplexed.

1.2.10.2.45 ExportFromRepository

A step based on this step template exports properties from entries in a repository using the search criteria specified in a file or a string. The step uses the entries in the Search criteria to retrieve archived results in the same way that the Search function of the Archive tab does in the RICOH ProcessDirector user interface.
The step exports all of the stored properties from all of the results that are found in the same way that the Export action on the Results area of the Archive tab does.
Job property defaults
  • Repository: Not set
  • Search criteria:
  • Results file descriptor:
  • Criteria type: Text
  • Export results file:
Usage notes
  • If you specify Text for Criteria type, you must enter the search criteria directly into the entry field in the correct format.

    To generate the Search criteria in the correct format, use the Search function on the Archive tab. Enter the search options that this step should use and click Search. At the bottom of the Search criteria list, you can see the Search criteria.

    Copy all of the text after the number in parentheses and paste it into the Search criteria field.

  • If you specify File for the Criteria type, you must provide the full file path to the Search criteria file for the Search criteria property.

    The format of the lines in the Search criteria file is the same format used for Text and the same as the Search query shown in the area on the Archive tab. If you use File, you can include multiple search queries. Each query must be on a separate line.

  • Unlike the Export function on the user interface in the Results area, only the properties are exported to the Export results file. History records are not included in the Export results file.

1.2.10.2.46 ExtractPageExceptions

A step based on this step template reads the page exceptions for the job, either from the JDF file or created in the user interface, and writes them to a tab-delimited file.
Job property defaults
  • Page exceptions file: ${getFileName(pletotab,del,write)}
Usage notes
  • The file created by this step can be used as input to the AddPageExceptionsToAFP step.
  • Only the media and staple page exceptions are included in the page exceptions file.

1.2.10.2.47 FailWithMessage

Add this step to a workflow to have a job go into error with a customizable message that RICOH ProcessDirector writes to the job log. The FailWithMessage step is particularly useful when a job stops in a step because the conditional processing in a workflow gives unexpected results. For example, you add a FailWithMessage step as the last conditional branch from a step. If RICOH ProcessDirector cannot send a job through the other branches of a step, it sends the job to the FailWithMessage step and writes a failure message to the job log.
Job property defaults
  • Failure message

1.2.10.2.48 FillWhiteSpace

A step that is based on this step template fills white space areas in AFP files with content, such as images or text. The white space is defined in a control file that you create using the Whitespace Manager feature of RICOH Visual Workbench. When you configure the step, you can choose to create any page groups, index tags, barcodes, hidden areas, and text that are defined in the same control file before filling the white space areas. You use AFP Indexer to create page groups and index tags and AFP Editor to create barcodes, hidden areas, and text.
Job property defaults

  • Index first: Yes
  • Edit first: Yes
  • Visual Workbench control file:

Usage notes

  • If the Index first property is Yes, do not run the IndexAFP step because the Index first option provides the same function as the IndexAFP step. It is more efficient to select the Index first option.
  • If the Edit first property is Yes, do not run the EditAFP step because the Edit first option provides the same function as the EditAFP step. It is more efficient to select the Edit first option.
  • Do not select Index first if the IndexAFP step and the FillWhiteSpace step must be done in different phases. For example, you might need to put the IndexAFP step in the Prepare phase and the FillWhiteSpace step in the Assemble phase after the EditAFP step (or select Edit first).
  • Position the step relative to these steps if they are present:
    • After a step that converts line data to AFP format (for example, after the ConvertLineDataJobIntoAFP step)
    • After a step that converts Xerox data to AFP format
    • Before a step that transforms AFP files into another format (for example, before the TransformJobIntoPDF step)
    • Before the EnableRepositioning step if you configure the FillWhiteSpace step to create page groups and index tags or text
    • Before the PrintJobs step
  • If you created fixed-length page groups with the IndexAFP step template, you can use the FillWhiteSpace step template to fill white space areas with content in AFP files that the RICOH Transform features create.

1.2.10.2.49 GetTransformPageExceptions

A step based on this step template lets you include page exceptions when you use the Advanced Transform feature to transform AFP input into PDF or PostScript output. The step converts tray information in the AFP form definition into media objects in the job ticket for PDF or PostScript output.
Job property defaults
  • Transform step name: TransformWithAdvancedFeature
  • Output JDF file: ${getFileName(overrides,jdf,write)}
Usage Notes
  • This step requires these input and output transforms for the Advanced Transform feature:
    • InputAFP
    • OutputPDF, OutputPS, or both
  • Before you add this step to a workflow, define RICOH ProcessDirector media objects with the same names as the trays in the AFP form definition.

    For example, the AFP form definition contains trays named Tray1, Tray2, and Tray3. Define media objects named Tray1, Tray2, and Tray3.

    On the Media Settings page, you can substitute media objects with descriptive names for the tray names. For example:

    • Replace Tray1 with A4 Plain media.
    • Replace Tray2 with Letter Color media.
    • Replace Tray3 with Letter Preprinted media.

  • This step cannot process jobs with sides page exceptions. Make sure that the input is simplex or duplex.
  • Place this step after the TransformWithAdvancedFeature step that provides the AFP input for this step.
  • You can add this step to a workflow multiple times.
  • If a workflow has more than one step based on the GetTransformPageExceptions step template, make the values for the Transform step name property different. You can use either of these methods:
    • Give the steps based on the TransformWithAdvancedFeature step template different names.
    • Use the value of the Step identifier property for each TransformWithAdvancedFeature step instead of the step name.
  • After this step runs, you can see the results by displaying the page exceptions for the job.

1.2.10.2.50 GroupDocuments

A step that is based on the GroupDocuments step template updates the document properties file to identify groups of documents based on up to six document properties. After you have grouped documents, you can use a step based on the CreateJobsFromDocuments step template to create a separate child job for each group.
For example, you can group documents by a common set of inserter bin contents. If your workflow does not include a step to create child jobs, such as CreateJobsFromDocuments, GroupDocuments is useful to group the documents before they are sorted by the SortDocuments step.
Job property defaults
  • First group: Not set
  • Second group: Not set
  • Third group: Not set
  • Fourth group: Not set
  • Fifth group: Not set
  • Sixth group: Not set
  • Honor groups on sort: Not set
Usage notes
  • This step must run on the primary server.
  • You cannot delete this step template.
  • The grouping properties can be any property named in the document properties file, such as Customer Name, State, or Country.
  • When ordering the groups resulting from step processing, the type of comparison that is done depends on the data type associated with the property. A property that stores string values uses a character comparison (even if the values are numbers). Properties that accept a list of values are sorted according to the collating sequence defined for the list, not on a character comparison. Numeric data types are sorted based on a numeric sort.
  • If any of the group properties have no value, grouping occurs according to the remaining properties.
  • If Honor groups on sort is Yes, the step creates groups by updating the child job ID field in the document properties file. If there are existing values for the child job ID (for example, from a previous GroupDocuments or SplitDocuments step), those job IDs are considered the primary criteria for grouping, and any new grouping is done within the existing groups. The job IDs associated with the documents remain unchanged, or the jobs are split into smaller jobs.
  • If Honor groups on sort is No, the step does not subdivide existing groups; instead, it considers the entire document properties file as one group.
  • If a step based on the SortDocuments step template occurs before this step, the groups produced are sorted, and the documents within a group retain the relative ordering that they had before grouping. This is an example of the ordering before GroupDocuments processing:
    DocID ChildJob SeqInChild GroupProp
    1       1.1        1          B
    2       1.1        2          B
    3       1.1        3          A
    4       1.1        4          B
    5       1.1        5          A

    After GroupDocuments processing, the documents in Group A stay in the same sequence in their group, as do the documents in Group B:

    DocID ChildJob SeqInChild GroupProp
    1       1.2        1          B
    2       1.2        2          B
    3       1.1        1          A
    4       1.2        3          B
    5       1.1        2          A

1.2.10.2.51 IdentifyDocuments

A step based on the IdentifyDocuments step template determines page and sheet counts, sets the values of properties for each document in the AFP file, and writes the properties to the document properties file. If you specify a Visual Workbench control file that links document properties to index tags, the step sets the values of the document properties equal to the values of the index tags (TLEs). The AFP file must have page groups (BNGs) defined before the step runs.
A step based on this step template also sets the values of properties that are related to the document in its original job:
  • Sequence in original job
  • Original pages
  • Original sheets
  • Original first page
  • Original form definition
  • Data offset
  • Data length
  • Medium map
    Note:
  • The original first page, original form definition, data offset, data length, and medium map properties are not displayed in the user interface, but other steps use these properties.
Job property defaults
  • Duplex: Not set
  • Stop when no documents are found: Yes
  • Visual Workbench control file:
Usage notes
  • If nested page groups exist in the AFP file, only the outer pairs are used as document boundaries.
  • Invalid AFP or invalid indexing of the AFP file can cause unexpected results.
  • If you change the value of the Duplex property, the Total sheets property that RICOH ProcessDirector calculates might not match the total number of job sheets that actually stack at the printer.
  • The Visual Workbench control file is optional. If you do not specify a control file, this step uses existing page groups as document boundaries and does not set the values of any document properties to the values of index tags.
  • If you are using a step based on the IndexAFP step template in the workflow, it must precede a step based on the IdentifyDocuments step template.
  • A step based on this step template does not create the page map that lets the AFP viewer find pages in a job according to the index tag (TLE). If you want to do this, include a step based on the EnableRepositioning step template in your workflow before this step.

1.2.10.2.52 IdentifyPDFDocuments

A step based on the IdentifyPDFDocuments step template identifies the documents in one or more PDF files. For each document, the step determines page and sheet counts and the values of document properties. The step writes the properties and their values to a document properties file.
Input to the step can be:
  • A single PDF file.
  • Multiple PDF files packaged as a ZIP file.
  • One or more complete sets of files, with each set containing a PDF file and other supporting files.

    A set is a group of files that must be processed together, such as a data file, a job ticket (JDF file), and an overrides file.

When the step receives multiple PDF files as input, it combines them into a single PDF file.

When the step receives multiple sets of PDF and JDF files as input, it combines them into a single PDF file and a single JDF file. The step takes page exceptions for media, sides, and stapling in the JDF input files and adds them to the combined JDF file.

    Note:
  • For all documents in the job, the workflow sets the output bin and the finishing options for punching, folding, and binding.
  • When the step creates the combined JDF file, it includes only values that RICOH ProcessDirector supports. The step discards unsupported values.

You must specify a control file on the step. The default control file treats each PDF file as a document. If any PDF file has more than one document, you must provide a control file that you created with RICOH ProcessDirector Plug-in for Adobe Acrobat. The control file must contain a page group definition. If you need the step to extract the values of document properties, the control file must also map data in the documents to document properties.

IdentifyPDFDocuments sets the values of properties that are related to the document in its original job:

  • Sequence in child job
  • Original pages
  • Original sheets
  • Original input file for documents
  • Original first page
    Note:
  • Original input file for documents is not set if the input to the step Is a single PDF file.
  • Original first page is not displayed in the user interface, but other steps use that property.

Job property defaults
  • Duplex: Yes
  • Identify PDF control file: /aiw/aiw1/testfiles/Default.ctl (Linux) or C:\aiw\aiw1\testfiles\Default.ctl (Windows)
  • Auxiliary input file extension:
  • Headers file:
  • Page exceptions for sides: Replace with job value
Usage Notes
  • A step that is based on this step template cannot be used to process an encrypted PDF file.
  • If you submit multiple PDF files packaged as a ZIP file to a workflow with the IdentifyPDFDocuments step, the ZIP file must contain only PDF files. If it contains other files, the step goes into the error state.
  • When processing PDF files packaged as a ZIP file, the step adds the PDF files to the output PDF file based on their order or timestamps. For example:
    • You submit a ZIP file to the input device. The order of the PDF files in the output PDF file matches the order that the PDF files were placed in the ZIP file.
    • You specify the List batching method on the input device and set the Create .zip file property to Yes. The order of the PDF files in the output PDF file matches the order of the PDF file names in the list file.
    • You specify any batching method other than List on the input device and set the Create .zip file property to Yes. The order of the PDF files in the output PDF file is based on the timestamp of each PDF file in the ZIP file.
  • To submit one or more complete sets of files (with each set containing a PDF file and other supporting files) to a workflow with the IdentifyPDFDocuments step, specify one of these batching methods on the input device: Number of sets, Pages in sets, or Sets by time.
  • If the IdentifyPDFDocuments step produces a combined JDF file, we recommend that you run a step based on the OptimizeJDF step template to combine the page exceptions. Place the step after the BuildPDFFromDocuments step.
  • If you change the value of the Duplex property, the Total sheets property that RICOH ProcessDirector calculates might not match the total number of job sheets that actually stack at the printer.
  • If the PDF job has a JDF job ticket that specifies a combination of simplex and duplex pages, use the Page exceptions for sides property to set how the step combines the Duplex value for the job with the JDF sides settings.
  • If you plan to use the RICOH ProcessDirector viewer to search document properties to find specific documents in a PDF file, you must include an IdentifyPDFDocuments step in your workflow.
  • Place the IdentifyPDFDocuments step after all steps in the workflow that modify the PDF file. If you place the step before a step that modifies the PDF file, unexpected results can occur.
  • Do not modify the JDF file between the IdentifyPDFDocuments step and the BuildPDFFromDocuments step. Modifications made between those steps can cause the JDF file to be incorrect.

    Process a PDF job with only one of the IdentifyPDFDocuments or IdentifyPDFDocumentsFromZip steps, not both. We recommend that you use the IdentifyPDFDocuments step.

  • If you get unexpected results when you process a PDF 2.0 file with a step based on the IdentifyPDFDocuments step, do one of these:
    • Upgrade the control file to the latest version.
    • Place a step based on the OptimizePDF step template in the workflow before the IdentifyPDFDocuments step.
  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.

1.2.10.2.53 IdentifyPDFDocumentsFromZip

A step based on the IdentifyPDFDocumentsFromZip step template determines page and sheet counts, determines the values of properties for each document in the PDF file, writes the properties to the document properties file, and builds a single PDF file from the contents of a ZIP file.

During the merging of the PDF files you have the option to keep the individual PDFs in memory or to write them out to the job’s spool directory. A control file is optional and is only necessary if each of the PDFs in the ZIP file contain more than one document or you need to extract additional document properties.

IdentifyPDFDocumentsFromZip also sets the values of properties that are related to the document in its original job:

  • Sequence in child job
  • Original pages
  • Original sheets
  • Original input file for documents
  • Original first page
Note: The original first page is not displayed in the user interface, but other steps use that property.

Job property defaults
  • Duplex: Yes
  • Identify PDF control file: Not set
  • Add blank page: Yes
  • Merge PDFs directly from zip file: Yes
Usage notes
  • A RICOH ProcessDirector job should only be processed by one of the IdentifyPDFDocuments or IdentifyPDFDocumentsFromZip steps, not both. We recommend that you use the IdentifyPDFDocuments step.

  • If you are specifying a control file in this step, it must contain the page group definition that you created using RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • If you change the value of the Duplex property, the Total sheets property that RICOH ProcessDirector calculates might not match the total number of job sheets that actually stack at the printer.
  • If you plan to use the RICOH ProcessDirector viewer to search document properties to find specific documents in a PDF, you must include an IdentifyPDFDocuments or IdentifyPDFDocumentsFromZip step in your workflow.
  • A step that is based on this step template can be used only for PDF files packaged as ZIP files.
  • A step that is based on this step template cannot be used to process a ZIP file that includes any encrypted PDF files.
  • This step can only process ZIP files that use the Store and Deflate compression methods.
  • The original PDF files are added to the final PDF file based on the order of the PDF files in the ZIP or list file. For example, if you submit a ZIP file that you created, the order of the final PDF file reflects the order of that ZIP file. If you use the List batching method and set the Create .zip file property to Yes, the order of the final PDF file reflects the order of the list file. If you use any batching method other than List and set the Create .zip file property to Yes, the order of the final PDF file is based on the timestamp of the individual PDF files in the ZIP file.

1.2.10.2.54 IndexAFP

A step that is based on this step template creates page groups and index tags in AFP files. The page groups and index tags are defined in a control file that you create using RICOH Visual Workbench and AFP Indexer.
Job property defaults

Visual Workbench control file:

Usage notes

  • For better performance, set Index first to Yes and do not run the IndexAFP step if the workflow runs another step that contains the Index first property (for example, a step based on the EditAFP template). The Index first option and the IndexAFP step provide the same function.
  • Run the step before the EnableRepositioning step so that you can use the Print again action to reprint a page group. Also, run this step before the EditAFP or FillWhiteSpace step if it is present.
  • You can use the IndexAFP step template to enhance the AFP files that the RICOH Transform features create.

1.2.10.2.55 InsertCMR

A step that is based on this step template inserts a color management resource that meets your specifications into a job.
Job property defaults
  • Audit color CMR:
  • Audit grayscale CMR:
  • Color mode: Color
  • External command: insrtcmr -riall ${Job.CMR.RenderingIntent} -i -m ${Job.CMR.Mode} -o ${getFileName(print,afp,write)} ${getAbsoluteFileName(print,afp,read)}
  • Ink type: Pigment
  • Instruction color CMR:
  • Instruction grayscale CMR:
  • Processing mode: Audit
  • Printer type: InfoPrint 5000 - 32/64 m/min
  • Rendering intent: Not Set
  • Valid return codes: 0
Usage notes
  • The available values for the Audit color CMR, Audit grayscale CMR, Instruction color CMR, and Instruction grayscale CMR properties change based on the value selected for the Printer type property.
  • This step can only insert one CMR in a job. To insert both an audit and an instruction CMR in a job, add two instances of this step to a workflow.

1.2.10.2.56 InsertJobs

A step based on the InsertJobs step template processes a job for insertion. Also, it can receive and interpret an inserter results file from the inserter controller.
Job property defaults
  • Inserter controller: Not set
  • Inserter job name: ${Job.ID}
  • Inserter name: Not set
  • Load plan: Not set
  • Load plan comment: Not set
Usage notes
  • If the workflow includes a step based on the Reconcile step template, the InsertJobs step must run immediately before that step.
  • If the Completion method property of the inserter controller is Auto, RICOH ProcessDirector completes the step when it receives a results file from the inserter controller. The job moves to the next step.
  • If the Completion method property of the inserter controller is Manual, the operator must complete the InsertJobs step manually by selecting the Complete Insertion action.
  • This step must run on the primary server.

1.2.10.2.57 ManualStepWithAutoStart

A step that is based on this step template stops a job in its workflow so that you can do a manual operation.

When a job enters a step based on this step template, it automatically moves to the Manual, working state. To move the job to the next step in the workflow, you must do a Manual complete action on the job and select whether the step completed successfully or if errors occurred.

Job property defaults
None

1.2.10.2.58 ManualStepWithManualStart

A step that is based on this step template lets you start a manual operation, such as moving a roll of output to the postprocessing area.

When a job enters a step based on this step template, it moves to the Manual, waiting state. To move the job to the Manual, working state, you must do a Manual start action for the job. When the operation is complete, you must do a Manual complete action for the job to move the job to the next step in the workflow.

Job property defaults
None

1.2.10.2.59 MapExternalResultsFiletoDocProps

A step based on this step template maps document properties that you select from an external results file to the document properties included in a modified results file. The external results file is produced by an external program. The modified results file is formatted to contain the document properties from the external results file that must be placed in the document properties file. The modified results file is the input to a step based on the UpdateDocPropsFromExternalResultsFile step template, which applies the changes to the document properties file.
Job property defaults
  • External results file: ${getFileName(data,csv,read)}
  • File type: CSV
  • Modified results file: ${getFileName(data,opf,write)}
  • External results contain column headings: Yes
  • Columns to keep:
  • Selected document properties: Document number
Usage notes
  • The order of the column headings in the Columns to keep property must match the order of the document properties in the Selected document properties list, and the number of document properties in each list must match. If the order of the document properties do not match, you get unexpected results during job processing. If the number of the document properties do not match, the job goes into error state.
  • If the external results file does not contain column headings, you must manually delete the columns that you do not want.

1.2.10.2.60 OptimizeJDF

A step that is based on the OptimizeJDF step template reduces the complexity of the JDF job ticket by combining the page exceptions for media, finishing, and sides options.

For example, the step combines page exceptions for blue media on pages 3-4 and blue media on pages 5-6 into one page exception for blue media on pages 3-6.

Some JDF job tickets have a Sides setting on every page even if only one sheet in the entire job is simplex. When the step processes those JDF files, it makes groups of the series of pages with the same Sides value. Then it counts which Sides setting has the most groups and sets that Sides value at the job level and only inserts page exceptions for the pages that have a different Sides value. JDF job tickets with fewer page exceptions are processed faster by steps in RICOH ProcessDirector.

The JDF job ticket produced by this step is functionally equivalent to the original job ticket. The subsequent steps in the workflow use the JDF file produced by this step.

Job property defaults
  • None
Usage Notes
  • This step is useful if a JDF job ticket from a source outside RICOH ProcessDirector has not been optimized.
  • If the PDF Document Support feature is installed, this step is useful when the BuildPDFFromDocuments step adds page exceptions for media, finishing, and sides options. Run this step after the BuildPDFFromDocuments step.
  • When RICOH ProcessDirector sends a job to a Ricoh PDF or Custom PDF printer, the printer object provides the same function as the OptimizeJDF step. However, you cannot use RICOH ProcessDirector to view changes to JDF job tickets made by the printer object.

1.2.10.2.61 OptimizePDF

A step that is based on the OptimizePDF step template reduces the size of a PDF file and removes elements that are not needed.
Job property defaults
  • None
Usage notes
  • We recommend that you add this step near the start of a PDF workflow to optimize PDF files when they enter the workflow. For example, add this step after the DetectInputDataStream step.
  • We recommend that you add this step after any step that modifies a PDF file. For example, you have the Ultimate Impostrip® Connect feature. Your workflow includes the RunImpostripOnJob step, which sends a PDF print job to Ultimate Impostrip® for impositioning. Add the OptimizePDF step after the RunImpostripOnJob step.
      Note:
    • The BuildPDFFromDocuments step creates a single PDF file for the current job and then optimizes the file. You do not need to add the OptimizePDF step after the BuildPDFFromDocuments step. The BuildPDFFromDocuments step is installed with the PDF Document Support feature.
  • When this step processes a PDF 2.0 file, it converts the file to PDF 1.7 format. We recommend placing a step based on the OptimizePDF step template in the workflow before steps that update PDF files, such as IdentifyPDFDocuments and BuildPDFFromDocuments.
  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.

1.2.10.2.62 PrepareJobFromRepositorySearch

A step that is based on this step template creates a job from the output of a step based on the CreateJobsFromRepositorySearch step template.

The ZIP file created from a step based on the CreateJobsFromRepositorySearch step template includes the data files for the jobs or documents returned by the repository search. The ZIP file also contains any overrides files and document overrides files if those files are returned from the repository search. The PrepareJobFromRepositorySearch step template merges the individual print, job overrides, and document overrides files to create a single instance of each type. The step writes the files print.zip, overrides.txt, and document.overrides to the spool directory of the job.

Job property defaults
  • Input File: ${getFileName(archive,zip,read)}
Usage notes
  • If multiple job overrides files are included in the input ZIP file and different values exist in the files for the same job property, the job goes to Error state.

    For example, in one job overrides file, the property Duplex is set to Yes. In the second job overrides file, the property Duplex is set to Tumble. The step places the job in Error state.

    If one of the jobs overrides files has the property Duplex set to Yes and the second file does not have that property set, then Duplex is added to the resulting overrides file with the value Yes.

  • If multiple document overrides files are included in the input ZIP file and different values exist in the files for the same document property, the document properties are added to the document overrides file created by the step. Documents that do not have a property included in their document overrides file are added with a value of null (“).
  • Any step that uses a ZIP file as input can process the ZIP file created from this step. For example, steps based on the IdentifyPDFDocuments, BuildAFPFromZip, or BuildPDFromZip step templates can be used to process the output of this step. You can submit the ZIP file to a hot folder using a step based on the CopyToFolder step template. If the hot folder is set up to process ZIP files, the ZIP file is submitted as a new job.

1.2.10.2.63 PreparePDFOutputForFinishing

A step based on the PreparePDFOutputForFinishing step template lets you select page layout options for the job in preparation for post-processing, such as finishing. For example, if you are printing a continuous forms job that is placed onto a roll as it exits the printer, you can use this step to change the print direction and page order so that the paper is oriented correctly when it enters the finishing equipment. You can also prepare your printer output for 1-up or 2-up printing as required by finishing equipment such as a cutter or folder.

These examples show some possible settings, followed by their results. In the diagrams, the larger number represents the page number of the front sheet; the smaller number represents the page number of the back of the sheet.

Table 1 example property values:

  • Duplex: Yes
  • Leading edge into finisher: End of print job
  • N-up: 1
  • Finisher order: Not set
  • Additional page rotation: 0
1-up output where the end of the job enters the finisher first
Original Result
Duplexed job before using roll to roll option Duplexed job after using roll to roll option

Table 2 example property values:

  • Duplex: Yes
  • Leading edge into finisher: Start of print job
  • N-up: 2
  • Finisher order: Left to right
  • Additional page rotation: 0
Two column left-right output where the start of the job enters the finisher first
Original Result
Duplexed job before using 2-up left-right option

Table 3 example property values:

  • Duplex: Yes
  • Leading edge into finisher: End of print job
  • N-up: 2
  • Finisher order: Right to left
  • Additional page rotation: 0
Two column right-left output where the start of the job enters the finisher first
Original Result
Duplexed job before using 2-up right-left option

Table 4 example property values:

  • Duplex: Yes
  • Leading edge into finisher: End of print job
  • N-up: 2
  • Finisher order: Right to left
  • Additional page rotation: 90
Two column output where the end of the job enters the finisher first, with additional rotation
Original Result
Duplexed job before using 2-up right-left option Duplexed job after using 2-up right-left option rotated 90 degrees

Job property defaults
  • Duplex: Yes
  • Leading edge into finisher: End of print job
  • N-up: 2
  • Finisher order: Left to right
  • Additional page rotation: 0
Usage notes
  • If you use step based on the PreparePDFOutputForFinishing step template in your workflow, you do not need to use step based on ReversePDFPageOrder in the same workflow. PreparePDFOutputForFinishing reverses page order as needed, depending on the options you select.
  • If you use a step based on PreparePDFOutputForFinishing in a job that prints on a continuous forms printer, the system expects that the printer is configured for 2-up, left to right printing, with no page rotation. If you use different settings on the printer, the page layout of the job is incorrect. We recommend printing a few pages of your job as a test to confirm that your printer settings are correct.
  • If you get unexpected results when you process a PDF 2.0 file with a step based on the PreparePDFOutputForFinishing step, do one of these:
    • Upgrade the control file to the latest version.
    • Place a step based on the OptimizePDF step template in the workflow before the PreparePDFOutputForFinishing step.
  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.

1.2.10.2.64 PreviewPrint

A step that is based on this step template sends a selection of pages from a job to a printer to be printed. You can use the output to determine whether the job properties are set correctly. If they are not set correctly, you can modify them before you print the entire job.
Job property defaults
  • Accept preview print automatically: No
  • Duplex: Not set
  • Header page configuration file: /aiw/aiw1/control_files/banner_pages/header.jrxml

    If the AFP Support feature is installed, the default value changes to: /aiw/aiw1/control_files/banner_pages/header.cfg

  • Header copies: 1
  • Job copies requested: 1
  • Page range for preview print: 1–4
  • Requested printer for preview print: Not set
  • Trailer page configuration file: /aiw/aiw1/control_files/banner_pages/trailer.jrxml

    If the AFP Support feature is installed, the default value changes to: /aiw/aiw1/control_files/banner_pages/trailer.cfg

  • Trailer copies: 1
Job properties and defaults added by the AFP Support feature
  • AFP resource path:
  • Color mapping table:
  • Data check errors: Block all errors
  • Font fidelity: Continue printing
  • Font resolution: Not set
  • Font substitution messages: No
  • Form definition: F1A10111
  • Job class:
  • Job destination:
  • Job form:
  • Jog output copies: No
  • Number of messages to print:
  • Number of messages to stop job:
  • Overlay:
  • Segment size (Kilobytes): 5000
  • Separator page configuration file: /aiw/aiw1/control_files/banner_pages/separator.cfg
  • Separator copies: 1
  • X offset (inches):
  • Y offset (inches):
Usage notes
  • You can include more than one step based on this step template in a workflow.
  • If you change the value of the Requested page range for preview print property after the job arrives in the PreviewPrint step, you must process the job through the PreviewPrint step again.
  • If you add this step to a workflow that sends PDF jobs to a Ricoh PDF or Custom PDF printer on an application server, you must change the values of the Header page configuration file and Trailer page configuration file properties. Those properties must specify the drive letter of the application server that the printer is running on and the file path to the header and trailer configuration files. For example, the application server uses Z: to connect to the /aiw directory on the primary computer, and the file paths to the configuration files on the primary computer are /aiw/aiw1/control_files/banner_pages/header.jrxml and /aiw/aiw1/control_files/banner_pages/trailer.jrxml. Change the values to Z:\aiw1\control_files\banner_pages\header.jrxml and Z:\aiw1\control_files\banner_pages\trailer.jrxml.
  • The default values for the Header page configuration file and Trailer page configuration file properties change in the step template when you install the AFP Support feature. If you add this step to a workflow that sends jobs to a Ricoh PDF or Custom PDF printer on an application server after you install the AFP Support feature, you must change the values of the Header page configuration file and Trailer page configuration file properties. Those properties must point to JRXML files to generate banner pages. The values are not updated in steps that were added to workflows before the AFP Support feature was installed.

1.2.10.2.65 PrintJobs

A step that is based on this step template uses the printer and job scheduling properties to assign the job to a printer.
  • If the job is in PDF format and you have a PDF printer defined in the system, the PrintJobs step can send the job to the PDF printer.
  • If the job is in AFP format and you have the AFP Support feature installed, the PrintJobs step passes it to the RICOH ProcessDirector printer driver component for printing. The print driver component can send the job to an AFP printer or transform the job to PCL format and send it to a PCLOut printer.
  • If the job is in another format, configure the workflow to assign the job to a Passthrough printer so that the PrintJobs step can run the command defined in the Printer command property of the Passthrough printer.

Job property defaults

  • Binding: Not set
  • Collation: Not set
  • Duplex: Not set
  • Fold options: Not set
  • Header page configuration file: /aiw/aiw1/control_files/banner_pages/header.jrxml

    If the AFP Support feature is installed, the default value changes to: /aiw/aiw1/control_files/banner_pages/header.cfg

  • Header copies: 1
  • Job copies requested: 1
  • Media: Not set
  • Media required:
  • Punch: Not set
  • Requested printer: Any printer
  • Requested location: Not set
  • Staple: Not set
  • Stapling required:
  • Trailer page configuration file: /aiw/aiw1/control_files/banner_pages/trailer.jrxml

    If the AFP Support feature is installed, the default value changes to: /aiw/aiw1/control_files/banner_pages/trailer.cfg

  • Trailer copies: 1

Additional job property defaults added by the AFP Support feature
  • Address line 1:
  • Address line 2:
  • Address line 3:
  • Address line 4:
  • AFP resource path:
  • Building information:
  • Color mapping table:
  • Data check errors: Block all errors
  • Department information:
  • Font fidelity: Continue printing
  • Font resolution: Not set
  • Font substitution messages: No
  • Form definition: F1A10111
  • Host device:
  • Host group name:
  • Host user ID:
  • Host writer name:
  • JES job ID:
  • Job class:
  • Job destination:
  • Job form:
  • Jog output copies: No
  • Node ID:
  • Number of messages to print:
  • Number of messages to stop job:
  • Output bin: Not set
  • Overlay:
  • Prevent media substitution: No
  • Programmer information:
  • Room information:
  • Segment size (Kilobytes): 5000
  • Separator page configuration file: /aiw/aiw1/control_files/banner_pages/separator.cfg
  • Separator copies: 1
  • Title information:
  • X offset (inches):
  • Y offset (inches):
Usage notes
  • You cannot copy or delete this step template.
  • If you add a step based on this step template to a workflow used to process PDF jobs and send them to a Ricoh PDF or Custom PDF printer, make sure that you specify the drive letter of the application server that the printer is running on and the file path to the header and trainer configuration files. For example, the application server uses Z: to connect to the primary computer’s /aiw directory, and the file paths to the configuration files on the primary computer are /aiw/aiw1/control_files/banner_pages/header.jrxml and /aiw/aiw1/control_files/banner_pages/trailer.jrxml. Change the values to Z:\aiw1\control_files\banner_pages\header.jrxml and Z:\aiw1\control_files\banner_pages\trailer.jrxml.
  • When you open the properties for this step template in the Workflow tab, the values for the Media and Output bins properties include all of the media objects and output bins that are defined. If you open the properties for this step template on the Administration page, you can limit the list of values so it only includes the media or output bins that are supported or ready.
  • When you open the properties for this step template in the Workflow tab, the values for the X offset and Y offset properties are in inches. If you open the properties for this step template on the Administration page, they are in inches or millimeters.
  • The default values for the Header page configuration file and Trailer page configuration file properties change in the step template when you install the AFP Support feature. If you add this step template to a workflow that sends jobs to a Ricoh PDF or Custom PDF printer after you install the AFP Support feature, change the values of those properties to point to JRXML files to generate banner pages. The values are not updated in steps that were added to workflows before the AFP Support feature was installed.

1.2.10.2.66 PullFromSFTP

A step based on this step template retrieves files from a remote server via SFTP.
Job property defaults
  • Credentials:
  • Delete source files: No
  • SFTP RSA key entry:
  • SFTP server:
  • SFTP source directory:
  • SFTP source file pattern:
  • SFTP target directory:
  • SFTP target file pattern:

1.2.10.2.67 PushToSFTP

A step based on this step template sends files to a remote server via SFTP.
Job property defaults
  • Credentials:
  • Delete source files: No
  • SFTP RSA key entry:
  • SFTP server:
  • SFTP source directory:
  • SFTP source file pattern:
  • SFTP target directory:
  • SFTP target file pattern:

1.2.10.2.68 ReadBarcodeData

A step based on this step template determines whether the barcodes for all the documents in a job have been read. To make the determination, the step checks the results file that one or more barcode readers update.

You can configure the step to process jobs in these ways:

  • After all the barcodes have been read, the step sends the job to the next step.
  • After all the barcodes have been read, the step waits for an operator to do the Complete barcode step action.
  • The step waits a specified amount of time for the results file to be updated. The step then sends the job to the next step even if some documents have not been detected.

Job property defaults
  • Barcode reader: Sample reader
  • Complete step when all barcodes are read: Yes
  • Document scan time property: Document scanned 1
  • Document status property: Document status 1
  • Results file inactivity timer (minutes):
Usage notes
  • A workflow can include multiple steps based on the ReadBarcodeData step template. If two or more ReadBarCodeData steps process a job, we recommend that you set different values for the Document status property and Document scan time property on each step. By using different values for Document status property, you can identify which camera or barcode scanner failed to detect certain barcodes. By using different values for Document scan time property, you have a record of the date and time when each camera or barcode scanner read the barcode.
  • The value of the Results file inactivity timer affects the behavior of the Complete step when all barcodes are read property. Here are several examples of that interaction:
    Results file inactivity timer value Complete step when all barcodes are read value Action
    No value Yes Jobs move to the next step when all the barcodes have been read.
    No value No Jobs stay in the ReadBarcodeData step until an operator does the Complete barcode step action.
    10 minutes Yes Jobs move to the next step in either of these situations:
    • When all the barcodes have been read.
    • When the results file has not been updated for 10 minutes, even if some barcodes have not been read.
    10 minutes No Jobs move to the next step when the results file has not been updated for 10 minutes, even if some barcodes have not been read.

1.2.10.2.69 ReadDocumentsFromDatabase

A step that is based on the ReadDocumentsFromDatabase step template copies the values of document properties for every document associated with the job from the document database or from the document's original job into the production job's document properties file.

The step uses the list of properties in the document properties template file to determine which properties to include in the document properties file. If no document properties template is provided, the document properties file will contain entries for all the document properties in the system.

Document properties that are in the original job's document properties file are copied into the document properties file for the production job. If the document properties template file requests a job property, the value of the job property from the original job is added to the document properties file for each document.

The administrator can specify the set of document properties to write to this file in a document property template file.

Job property defaults
  • Document property template: Not set
Usage note

You cannot delete this step template.

1.2.10.2.70 Reconcile

A step based on the Reconcile step template determines the action to take for the documents in the job based on the status of each document. This step can automatically reconcile the job, or the operator can manually reconcile it.
Job property defaults
  • Automatic reconciliation: No
  • Maximum documents to reprint:
  • Reconciliation user:
  • Requested reprint printer: Same as requested printer
Defaults for job properties added by the Inserter feature

The Automated Verification feature does not include these job properties.

  • Reconcile update property 1:
  • Reconcile update property 2:
  • Reconcile update property 3:
  • Reconcile update property 4:
  • Reconcile update property 5:
  • Reconcile update property 6:
  • Reprint Attention documents: No
Usage notes
  • This step must run on the primary server.
  • For inserters, we recommend that you run the Reconcile step after a step based on the InsertJobs step template and before a step based on the CreateInserterReprints step template.
  • For inserters, if you use the interface on the inserter to reconcile jobs, you can set the Automatic reconciliation property to Yes. To use the RICOH ProcessDirector interface to reconcile jobs, set the Automatic reconciliation property to No.
  • For Automated Verification, we recommend that you run the Reconcile step after a step based on the ReadBarcodeData step template and before a step based on the CreateReprints step template.
  • For Inserters and Automated Verification, when the Automatic reconciliation property of the job is set to Yes, the job moves to the next step after processing completes.

    For Automated Verification, when duplicate scans are detected, the job state changes to Duplicates detected and the Reconcile step requires manual completion.

  • When the Automatic reconciliation property of the job is set to No, the job moves to the Waiting to reconcile state after processing completes. The operator uses the Reconcile action to review the action to take for the documents in the job. The job cannot move to the next step until each document has a Requested action value of OK, Reprint, or Pull.
  • If you have only the PDF Document Support or AFP Support feature (not Inserter or Automated Verification), the Action value for each document in a job is Not set. The operator must assign each document a Requested action value ( OK, Reprint, or Pull) to complete the manual reconciliation process.

    For a job with thousands of documents, the operator must set the Requested action for each document that printed successfully to OK. The fastest way for an operator to reconcile the job is to set the Requested action for all documents to OK. The operator then resets the Requested action for specific documents to Reprint or Pull. To save the operator the time required to set the Requested action for all documents to OK manually, you can use a SetDocPropsFromConditions step to set the Action value to OK automatically. Then the operator can immediately set the Requested action for specific documents to Reprint or Pull.

    This property conditions file for the SetDocPropsFromConditions step sets the value of the Action property for all the documents in the job to OK:

    • Doc.OriginalSequence,Doc.Insert.Disposition>=1,OK

1.2.10.2.71 RemoveDataFromRepository

A step that is based on this step template searches a repository and removes the data that matches one or more search criteria from the repository. When the search completes, the data returned in the search results is removed from the repository.
Job property defaults
  • Repository: Not set
  • Search criteria:
Usage notes
  • A step based on this step template only removes data from a single repository. If data must be removed from multiple repositories, include multiple steps based on this step template in the workflow.
  • The value of the Search criteria property can contain entries for multiple archive searches. Make sure that each entry is on a separate line separated by a carriage return.
  • You can enter the search criteria directly in the Search criteria property or store it in a file. If the search criteria is stored in a file, enter the full file path.
  • To generate the value of the Search criteria property in the correct format, use the Search function on the Archive tab. Enter the search options that this step uses and click Search. At the bottom of the Search criteria list, you can see the search criteria.

    Copy all the text after the number in parentheses and paste it into the Search criteria property field or into the search criteria file.

1.2.10.2.72 RemoveJobs

A step based on this step template exports audit information and removes the job from the system. You can choose whether the step removes job files immediately or waits until the system is less busy processing jobs.

If the job to be removed is the parent of another job in the system, the parent job waits in the RemoveJobs step until the step removes all child jobs. After all child jobs are removed, the step removes the parent job.

Job property defaults

None

Usage notes
  • This step should be the last step in the workflow, otherwise the job remains until it is manually deleted by the user.
  • To control whether jobs are removed as soon as they enter the step or when the system is less busy, change the Clean up timing system property to the appropriate setting for your installation.
  • You cannot copy or delete this step template.
  • We do not recommend changing the value of the Allow error override property for this step.

1.2.10.2.73 RetainCompletedJobs

A step that is based on this step template retains a job when the Retention period (unit) property for the job has a value. It compresses all spool and checkpoint files for the job if the value of the Compress all files property is Yes.

If a retained job is a parent job with active child jobs and the parent job's retention period expires, the parent job moves to the RemoveJobs step and waits until all child jobs complete. After all child jobs are removed, the step removes the parent job.

Job property defaults
  • Compress all files: No
  • Retention period (unit): 3 days
Usage note

You cannot copy or delete this step template.

1.2.10.2.74 ReverseOutputOrder

A step that is based on this step template causes pages to print in reverse order. The last page in the job prints first. You can use ReverseOutputOrder with any supported page layout.
Job property defaults
  • None
Usage notes

  • For the AFP viewer to function properly, you must include a step based on the EnableRepositioning step template in your workflow after the ReverseOutputOrder step. We recommend this sequence: ReverseOutputOrder, EnableRepositioning, CreatePageRanges, PrintJobs.
  • If you use the AFP viewer to view the job's contents after a step based on ReverseOutputOrder runs, the viewer displays the job in reverse order. In some cases, the pages of documents in a job might appear in a different order than you expect. For example, if the AFP job is indexed to contain page groups, and you use the Tag control to find a page group (such as a multi-page document) in the job, the last page of the document displays in the viewer instead of the first page.
  • When using ReverseOutputOrder with simplex jobs, a blank page is added at the front of the document if the document has an odd number of pages.
  • You might need to select a different form definition to print a job that has been processed by ReverseOutputOrder. Although ReverseOutputOrder reverses the order of the pages in the job, it does not alter the layout for the job. This can result in the pages of the job appearing in different positions on the sheet than you expect. For example, you might run a step based on ReverseOutputOrder on a two page job where the form definition has the front page offset by a certain amount, but not the back page. After ReverseOutputOrder runs, page 2, which is now first to be output, will be offset instead of page 1, which is now on the back of the sheet. To fix this, modify the form definition and other attributes such as overlays to get the correct placement of the pages on the output sheets.

1.2.10.2.75 ReversePDFPageOrder

A step that is based on this step template causes pages to print in reverse order. The last page in the job prints first. You can use ReversePDFPageOrder with any supported page layout.
Job property defaults
  • None
Usage notes
  • If you want to do more advanced processing for the job, such as preparing it for insertion into finishing equipment, we recommend that you use a step based on PreparePDFOutputForFinishing in your workflow instead of ReversePDFPageOrder.
  • For the viewer to function properly, your workflow must include a step based on CountPages or EnableRepositioning after the ReversePDFPageOrder step. We recommend this sequence: ReversePDFPageOrder, CountPages, or EnableRepositioning, CreatePageRanges, PrintJobs.
  • If you use the viewer to view job contents after a step based on ReversePDFPageOrder runs, the viewer displays the job in reverse order. Sometimes, the pages of documents in a job appear in a different order than you expect. For example, if you search document properties to find specific documents in a PDF, the last page of the document displays in the viewer instead of the first page.
  • When using ReversePDFPageOrder with simplex jobs, a blank page is not added at the front of the document even if the document has an odd number of pages.
  • If you get unexpected results when you process a PDF 2.0 file with a step based on the ReversePDFPageOrder step, do one of these:
    • Upgrade the control file to the latest version.
    • Place a step based on the OptimizePDF step template in the workflow before the ReversePDFPageOrder step.
  • Use the version of the RICOH ProcessDirector Plug-in for Adobe Acrobat supplied with RICOH ProcessDirector version 3.6 and above to update the control file. Remember to copy the control file to the correct location for RICOH ProcessDirector to use it.

1.2.10.2.76 RunExternalProgram

A step that is based on this step template submits the RICOH ProcessDirector job to an external program for processing. Because processing is external to RICOH ProcessDirector, steps created from this step template are called external steps. You can use this step template to run composition programs on the primary computer, a secondary computer, or an application server.
Job property defaults
  • External program language: Not set
  • External program code page: Not set
  • External command:
  • External control file template:
  • Valid return codes: 0
Usage notes
  • The RunExternalProgram step of the PDF workflow includes an example external command and external control file template.
  • If you add a step based on this step template to a workflow that includes a step based on the SetJobPropsFromTextFile step template and the RunExternalProgram step uses a method in RICOH ProcessDirector to obtain the name of a spool file for the job, use the getAbsoluteFileName method instead of the getFileName method. The SetJobPropsFromTextFile step tries to resolve the file name that the getFileName method represents immediately after the input device creates the job; not all spool files are available at that point in processing. It does not try to resolve the file that the getAbsoluteFileName method represents at that time.

    This usage note does not apply to the getControlFileName method.

  • The External program language property sets the value of the LANG environment variable that the external program can use. The external program must be set up to use this value for it to take effect.
  • This step writes the first 50 lines of standard output (stdout) from your external program to the job log.
  • If stdout is a large data file, use a script that calls the external program as the value of the External command property. Write the script so that it redirects stdout from the command to a file.
  • To set job properties in this step, append property=value to the output file name in the External command value.

    For example, this command sorts a PDF file and sets Job name to myjob and Job copies requested to 5:

    • sort ${getFileName(print,pdf,read)} -o ${getFileName(print,output,write)},Job.Name=myjob,Job.Copies=5

1.2.10.2.77 RunHotFolderApplication

A step based on this step template puts the RICOH ProcessDirector job in a hot folder that submits it to an external program. When the external program finishes processing the job, the step retrieves the job from the hot folder for the output of the external program.

Because processing is external to RICOH ProcessDirector, steps created from this step template are called external steps. You can use this step template to run composition programs on the primary computer, a secondary computer, or an application server.

Job property defaults
  • Application log file:
  • Clean up retrieval folder: Yes
  • File to send: ${getAbsoluteFileName(print.pdf,read)}
  • File size verification count: 2
  • Poll interval (seconds): 30
  • Retrieval folder:
  • Retrieval pattern: ${Job.Id}.*
  • Retrieved file: ${getFileName(print.pdf,write)}
  • Sending folder:
  • Timeout interval (minutes):
Usage notes
  • Either the RICOH ProcessDirector administrator or the administrator of the external program should periodically check the retrieval folder to clean up files left there in error.
  • While the RunHotFolderApplication step can write more than one file to another application, it can retrieve only one file. Therefore, do not use the step for batch jobs. Use the RunExternalProgram step for batch jobs instead.
  • When you set the Clean up retrieval folder property to No, the file that the step retrieves can be in the retrieval folder when a job enters the step. The step retrieves the file, then puts the file specified by the File to send property in the sending folder. The step then sends the job and the retrieved file to the next step in the workflow. The step does not wait for a new file to be placed in the retrieval folder.

1.2.10.2.78 RunImpostripOnJob

A step based on this step template sends a PDF print job to Ultimate Impostrip® for impositioning. The step waits for Ultimate Impostrip® to return the updated job, then continues processing with the next step.
Job property defaults
  • Sending folder:
  • Poll interval (seconds): 30
  • Timeout interval (hours): 2
  • Ultimate Impostrip® job name:
  • Application log file:
  • File size verification count: 2
  • Ultimate Impostrip® input hot folder:
Usage notes
  • Ultimate Impostrip® can be installed on an application server or on a separate Windows system that is not defined as an application server. Tune this step template correctly for your configuration:
    • If Ultimate Impostrip® is installed on an application server, tune the step to run on the application server.
    • If Ultimate Impostrip® is installed on a separate Windows system, tune the step to run on the primary server.

1.2.10.2.79 RunPitStopOnJob

A step that is based on this step template sends a PDF print job to PitStop Server for preflight processing. The step waits for the PitStop Server to return the updated job, then continues processing with the next step.
Job property defaults
  • External command: "C:\Program Files (x86)\Enfocus\Enfocus PitStop Server 10\PitStopServerCLI.exe" -config ${AIWDATA}\control_files\external_programs\pitstop.cfg -input ${getAbsoluteFileName( print, pdf, read)} -output ${getAbsoluteFileName( print, pdf, write)} -mutator "${Job.Pitstop.ActionListOrProfile}" -taskReport ${getAbsoluteFileName( pitstop_rpt, xml, write)}
  • PitStop action list or PDF profile: ${AIWDATA}\pitstop\IP 5000 Global Changes.eal
  • Valid return codes: 0
Usage notes
  • If the primary server runs on a UNIX-based operating system, steps based on this step template must be tuned to run on an application server.
  • The value of the External command property is the command used to run PitStop server using its command line interface. For information about the syntax of the command, see the Command Line Interface publication that comes with PitStop Server.

    You can use RICOH ProcessDirector symbol notation in the command. Symbols are resolved before RICOH ProcessDirector submits the command to PitStop server.

  • The default value of the External command property includes the default path to the PitStop Server program file. You might need to update that path to reflect the install path for PitStop Server on your system.
  • The default value of the PitStop action list or PDF profile property is the path to a PitStop action list that RICOH ProcessDirector provides. This action list is designed to optimize print quality for jobs that are sent to an InfoPrint 5000 printer while minimizing waste.
  • To generate a Pitstop report, add this flag to the External command property: -reportPDF ${getFileName(pitstop-rpt,pdf,write)}

1.2.10.2.80 SendEmail

A step based on this step template sends email with or without attachments to an SMTP server. The attachments can be complete print files, partial print files, or other files.
Job property defaults
  • Attachments:
  • Attach ZIP file: No
  • Blind copy address:
  • Copy address:
  • Message:
  • Page range data stream: Use current
  • Page range to send:
  • Recipient address:
  • Secure connection: None
  • Sender address:
  • SMTP server type: System
  • Subject line:
Usage notes
  • You must have an email server installed and configured so the step can interact with it before the step can run. The SMTP Server Type property specifies whether the step uses the System or Alternate SMTP server. If the SMTP server system property for the chosen SMTP server type is blank or has an incorrect value, the job goes to the error state.
  • This step uses the SMTP user name and SMTP password system properties for the System SMTP server, or the Alternate SMTP user name and Alternate SMTP password system properties for the Alternate SMTP server, to support SMTP servers that require a user name and password.
  • This step supports SSL or TLS connection without certificate authentication. If you use an SSL or TLS connection, you must specify the correct port number on the corresponding property. If the system property is blank or has an incorrect value, the job goes to the error state.
  • The step only sends an email when the job reaches the step. If the job stops processing because of an error, notifications are not sent.
  • This step supports page ranges in PDF jobs, and in AFP jobs if you have the AFP Support feature installed. The step cannot transform jobs from one datastream to another. If the datastream is not AFP or PDF, the job goes to the error state.
  • If you specify a page range for an AFP file, include a step based on the EnableRepositioning step template before the SendEmail step in the workflow. The EnableRepositioning step ensures that the correct pages are selected based on information specified in the form definition and the Duplex job property.
  • If you specify a page range for a file, include a step based on the CountPages step template before the SendEmail step in the workflow. The CountPages step ensures that the correct pages are selected based on its page counts and the Duplex job property.
  • You can add this step to a workflow more than once.

1.2.10.2.81 SendInserterControlFile

A step based on the SendInserterControlFile step template runs a script that transfers the inserter control file to the inserter controller.
Job property defaults

None

Usage notes
  • You must include a step based on the SendInserterControlFile step template in a workflow if the inserter requires a control file. If the inserter does not require a control file, you can remove this step from the workflow.
  • This step must run after a step based on the WriteInserterControlFile step template.
  • If you must send the inserter control file to the inserter before the job prints, move this step before the PrintJobs step.
  • RICOH ProcessDirector provides scripts that you can use to send the inserter control file for the job to the inserter controller. Scripts include: copy_file.sh, move_file.sh (copy_file.pl and move_file.pl on Windows), ftp_file.sh, sftp_file.sh, and scp_file.sh. You specify the script in the Send command property of the inserter controller.
  • This step must run on the primary server.

1.2.10.2.82 SetDeadline

A step based on this step template sets a date and time by which the job must complete a Deadline step to have a Deadline outcome of Met. If a job does not complete the Deadline step before the deadline time, the Deadline outcome for the job is set to Missed. The Deadline outcome of Met or Missed is set after the deadline time has passed.

When a job misses its deadline, RICOH ProcessDirector adds a red dot to the Deadlines portlet and to the Schedule risk column for the job in the Jobs table. The heading of the Schedule risk column is blank. To see the name of the column, hover over the heading area.

You set the deadline time using the combination of the Deadline date, the Deadline time, and the Plus or minus properties.

A workflow can have multiple SetDeadline steps.

Job property defaults
  • Deadline step: Not set
  • Deadline date: Today
  • Deadline time: 12:00 AM
  • Plus or minus (days): 0
  • Inherit deadline from parent job: No
  • Override existing deadline: Yes
Usage notes
  • You cannot select a Deadline step for the SetDeadline step template. The list of steps is only available after the step template is added to a workflow.
  • More than one Deadline step can be defined in the workflow for a job, but only one Deadline step is active at a time. For example, different branches in a conditional workflow could set different Deadline steps. Because the job can only take one branch through the workflow, the Deadline step in that branch determines the Deadline outcome. As a job moves through the workflow, you can see the values related to the deadlines change.
  • If a job passes through multiple SetDeadline steps, the value of the Override existing deadline property determines if this property should be changed when the step runs.
  • If you select a step in the workflow that runs before the SetDeadline step as the Deadline step, specify the Plus or minus value carefully to make sure that the SetDeadline step does not always change the Deadline outcome to Missed.
  • No-service periods are not included when calculating predicted completion times.

1.2.10.2.83 SetDocPropsFromConditions

A step that is based on the SetDocPropsFromConditions step template updates the document properties file in the job based on other document and job property values. You use a property conditions file to assign property values.

For example, you might want to group documents based on a particular ZIP code range, and then create separate child jobs for the ZIP code groups. Additionally, you might want to print each child job at a different location.

Each document has one ZIP code, not a value for its ZIP code group. You add a step to a workflow based on the SetDocPropsFromConditions step template to set a value for a Doc.Custom.Region property based on a ZIP code range. (To implement this example, you would have already defined the custom properties Doc.Custom.Zip and Doc.Custom.Region in the document properties configuration file, run the docCustom utility, and installed or upgraded the Custom Document Properties feature.)

ZIP codes from 00000-50000 go into one group and ZIP codes from 50001-99999 go into another group. You can define the values for the Doc.Custom.Region property in the property conditions file like this:

Doc.Custom.Zip,Doc.Custom.Region
<=50000,EAST
>50000,WEST

If you have a defined Job.Destination property, you can assign the Job.Destination value based on the value of Doc.Custom.Region property: if Doc.Custom.Region = WEST, then Job.Destination=PHOENIX; if Doc.Custom.Region = EAST, then Job.Destination=OHIO.

Doc.Custom.Region,Job.Destination
=EAST,OHIO
=WEST,PHOENIX

Job property defaults
  • Property conditions file: Not set
Usage notes
  • This step must run on the primary server.
  • If you are using a conditions file to set a job property value based on a document property value, the job property's value will be assigned based on the first matching document even if several documents match the defined condition.
  • The property conditions file has additional capabilities, including the ability to: set properties without specifying conditions; use symbol notation; and use an include file to set several properties using Property = value format. For more information, see the related topic about property conditions files.

1.2.10.2.84 SetDocPropsFromList

A step based on this step template reads one or more list files in a directory and sets the value of a specified document property for each document in the document properties file (DPF) for the job.

The step uses the document properties in the Columns in list file list to match documents in the job. If the value for the property in the list file matches the value for the property in the DPF, the step sets one value for the Document property to set property and sets the same property to a different value for the documents that do not match. Using this step, you can provide a "pull list" of documents in a job to suppress them from printing or divert them from inserting or mailing based on setting a value for a document property that controls those actions.

Job property defaults
  • Columns in list file:
  • Delimiter: New Line
  • Document property to set:
  • List file directory:
  • Stop for excess columns: Yes
  • Value for matching documents:
  • Value for other documents:
Usage notes
  • If the DPF contains the document property in the Document property to set field when the step runs, the values for the documents specified by values in the list file are changed to the value specified in the Value for matching documents property.

    If the DPF does not contain the document property when the step runs, the property is added to the DPF, and the value for the documents specified by values in the list file is set to the value specified in the Value for matching documents property. The value for other documents is set to the value specified in the Value for other documents property.

  • If the Stop for excess columns property value is set to Yes and the number of columns in the list file is greater than the number of properties in the Selected list for the Columns in list file property, the step places the job in Error state.
  • The step assumes that the properties listed in the Columns in list file property and the columns in the list file are in the same order. For example, the property at the top of the Selected list corresponds to the first column of the list file; the second property in the Selected list corresponds to the second column in the list file.
  • If you set the Stop for excess columns value to No, the step ignores any columns that are not mapped to properties in the Selected list. For example, if the list file contains 25 columns and the Selected list contains five properties, the step reads the information in the first five columns and ignores the other 20 columns.
Example

The DPF contains this information (where ... means other properties are also present but not important for this example):

Doc.Custom.AccountNumber   Doc.Custom.AccountType   ...
1234   Life   ...
1234   Fire   ...
4567   Life   ...
4567   Fire   ...

The insurance company decides to no longer print policies for Fire, but they do not want to change the application that creates the print job.

To suppress printing of the Fire policies, the administrator builds this list file and places it in the List file directory:

#Doc.Custom.AccountType
Fire
Because the list file does not support column headings, the first line is a comment, indicated by the # comment character.

On the SetDocPropsFromList step in the workflow, the administrator specifies:

  • Columns in list file: Doc.Custom.AccountType
  • Document property to set: Doc.Custom.Suppress
  • Value for matching documents: Yes
  • Value for other documents: No

After the step runs, the DPF contains this information:

Doc.Custom.AccountNumber  Doc.Custom.AccountType  ...  Doc.Custom.Suppress
1234   Life   ...   No
1234   Fire   ...   Yes
4567   Life   ...   No
4567   Fire   ...   Yes

1.2.10.2.85 SetInsertProperties

A step based on the SetInsertProperties step template sets document properties that are required for insertion.
Job property defaults
  • Inserter controller: Not set
  • Inserter job name: ${Job.ID}
  • Inserter name:
  • Insert iteration: 1
Usage notes
  • This step sets the Insert sequence document property to the numerical position of the document in the job.
  • A step based on the SetInsertProperties step template must run after a step based on the WriteDocumentsToDatabase step template and after any step that changes the position of the document in the job.
  • A step based on the SetInsertProperties step template must run before any step that relies on the value of the Insert sequence document property, such as a step based on the BuildAFPFromDocuments, BuildPDFFromDocuments, and WriteInserterControlFile step templates.
  • This step must run on the primary server.

1.2.10.2.86 SetJobPropsFromOriginal

When a step that is based on the SetJobPropsFromOriginal step template processes a child job, it copies the values of some job properties from the parent job to the child job.

The step copies the value of a property that is a column in the jobs table when the property in the child job does not have a value.

Job property defaults
  • None
Usage notes
  • In the workflow that processes the child job, a step that is based on the SetJobPropsFromTextFile step template must precede the SetJobPropsFromOriginal step.

1.2.10.2.87 SetJobPropsFromTextFile

A step that is based on this step template uses a text file that accompanies the input file to set job properties. The text file specifies which properties to set.
Job property defaults
  • Custom 1:
  • Custom 2:
  • Custom 3:
  • Custom 4:
  • Custom 5:
  • Custom 6:
  • Custom 7:
  • Custom 8:
  • Custom 9:
  • Custom 10:
  • Customer name:
  • Input data stream: Unknown
  • Job description:
  • Job location: Not set
  • Job name:
  • Job priority:
  • Stop when entering phase: Not set
  • Test job: Not set
Usage notes
  • The text file that accompanies the input file contains one property and value pair on each line in the format: property=value
  • The property values specified in the text file override the property values that are set by the steps in the workflow.
  • The step tries to find a jobID.overrides.text file first. If it finds that file, it sets values for the properties listed. Then, the step looks for a Job Definition Format (JDF) job ticket file, jobID.overrides.jdf, and uses it to set additional properties of the job. Both files are optional.
  • If you plan to use this type of step in a workflow, the input device that assigns this workflow to input files that it receives must be configured correctly. Set the values of these input device properties as indicated:
    Override patterns
    Type the name of the text file with the default extension or create a pattern-matching string that lets RICOH ProcessDirector identify the text file that contains the properties.
    JDF patterns
    Type the name of the JDF file with the default extension or create a pattern-matching string that lets RICOH ProcessDirector identify the JDF text file that contains the properties.
    Batching method
    Set this property to:
    • Batch if you want to manually group the input file and text file from the list of files displayed by the Show Files action for the input device.
    • JDF if a Job Definition Format (JDF) job ticket is used to supply the additional properties.
    • List if the text file that accompanies the input file is specified in a list file.
    • None if each input file should be submitted as a separate job.
    • Number if you want to group a specific number of files together.
    • Number of sets if you want to group a specific number of sets together.
    • Pages if you want to group PDF files into a job that contains a specific number of PDF pages.
    • Pages in sets if you want to group sets into a job that contains a specific number of PDF pages.
    • Time if you want to group files together based on when they arrive in the hot folder input device.
    • Sets by time if you want to group sets of files together based on when they arrive in the hot folder input device.
      Note:
    • By default, using any batching method causes an input device to create jobs as groups that use the parent/child structure. A parent job contains no data; it is a container that maintains the relationship between other jobs. Those jobs are child jobs. Each input file that a batching method includes in a group becomes a child job.

      If you set the Create .zip file property of an input device to Yes, the input device does not create groups of jobs that use the parent/child structure. Instead, the input device gathers all the input files in the group and creates a ZIP file to hold them. The ZIP file is submitted as a single job.

    Submit step
    Set this property to SubmitInputFiles.
  • When you submit a job to the input device that you just configured, make sure that you include all the required files, such as the text file or job ticket, the input file, or the list file.
  • The SetJobPropsFromTextFile step should be the first step in the Receive phase in a workflow.
  • Remove ${Job.InputFile} from the Job name property in this step when you are submitting a job to a Download or LPD input device with a control file that defines the job name.
  • You cannot copy or delete this step template.

1.2.10.2.88 SetJobTypeFromFileName

A step that is based on this step template uses a pattern-matching string to set the workflow from a portion of the input-file name. The step can also convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format, which the SetJobPropsFromTextFile step uses to set job properties. This type of step cannot be added to a workflow; it is set as the value of the Workflow initialization step, the Child workflow initialization step, or both properties of an input device.
Associated properties
  • Workflow initialization step
  • Child workflow initialization step
Job property defaults

None

Usage notes
  • To use this step to set the workflow, set the Parent workflow pattern or Child workflow pattern property to a pattern-matching string. The pattern-matching string is a regular expression that can be combined with the (JOB_TYPE) token. RICOH ProcessDirector tries to match the pattern-matching string to a workflow twice, first with a dollar sign, $, appended to the pattern-matching string and then without one. The $ looks for a match at the end of the file name. For example:
    • To use the extension of the input file, use this pattern-matching string:
      *.(JOB_TYPE)
      The asterisk, *, represents zero or more characters. The period, ., is a literal period. The (JOB_TYPE) token signifies that RICOH ProcessDirector should use the characters that follow the literal period as the workflow.

      When you submit an input file with the name myfile.PDF, RICOH ProcessDirector finds the characters PDF at the end of the filename. If there is a workflow called PDF, the input device assigns PDF as the workflow.

    • To use the first 4 alphanumeric characters of the file name, use this regular expression:
      [A-Za-z0-9]{4}
      The pattern in square brackets, [A-Za-z0-9], matches any characters in the ranges A–Z, a–z, or 0–9. The number in braces, {4}, indicates the number of characters to use. There is no (JOB_TYPE) token in this string because the entire pattern is the workflow.

      When you submit an input file with the name pdf3file.pdf, RICOH ProcessDirector tries to find a workflow that matches the first 4 alphanumeric characters of the file name. If there is a workflow called pdf3, the input device assigns pdf3 as the workflow. If there is no such workflow, RICOH ProcessDirector logs an error.

  • To use a pattern-matching string to set the workflow, make sure that you have created and enabled a workflow that has the same name as the file extension (or whatever part of the file name you use) of the input files that the workflow processes.
  • The workflow name and the file name are case-sensitive. If the file extension is PDF, the RICOH ProcessDirector-supplied workflow with the name PDF does not match, and RICOH ProcessDirector issues an error message.
  • To use this step to convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, set the Parent workflow parsing rules property to the name of a control file.
  • Set the Convert overrides property for a hot folder input device that uses this type of step to Yes if a control file is required to convert the overrides file submitted with a job to a job properties file in RICOH ProcessDirectorproperty name=value format.
  • You cannot copy or delete this step template.

1.2.10.2.89 SetJobTypeFromRules

This step template is used by an input device to set the workflow from a value of a parameter that accompanies the input file. The step can also convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format, which the SetJobPropsFromTextFile step uses to set job properties. This type of step cannot be added to a workflow; it is set as the value of the Workflow initialization step or the Child workflow initialization step on an input device.
Associated properties
  • Workflow initialization step
  • Child workflow initialization step
Job property defaults
  • None
Usage notes
  • If the initialization step or Child workflow initialization step property for an input device is set to SetJobTypeFromRules, set the Parent workflow parsing rules or Child workflow parsing rules property to the name of the control file to use. RICOH ProcessDirector provides sample control files that are installed in the /aiw/aiw1/samples/rules/ directory. Administrators can copy these files to the /aiw/aiw1/control_files/rules/ directory and modify them to meet the requirements of the installation:
    File name Determines workflow from
    receive_lpd_pdf_jobtype.cfg LPD control file parameters for PDF jobs
    receive_text_jobtype.cfg jobID.overrides.text file or jobID.overrides.jdf file
    receive_jcl_jobtype.cfg JCL parameters

    This file is only available if the AFP Support feature is installed.

    receive_lpd_jobtype.cfg LPD control file parameters for AFP jobs

    This file is only available if the AFP Support feature is installed.

  • The SetJobTypeFromRules can convert an optional Job Definition Format (JDF) job ticket file, jobID.overrides.jdf, to a temporary text-based overrides file that it can use with the jobID.overrides.text file to set the workflow.
  • Set the Convert overrides property for a hot folder input device that uses this type of step to Yes if a control file is required to convert the overrides file submitted with a job to a job properties file in RICOH ProcessDirectorproperty name=value format.
  • The values specified in the control file overrule the values for the same properties that are set by the steps in the workflow.
  • You cannot copy or delete this step template.

1.2.10.2.90 SetPostalJobProps

A step based on this step template lets you set job properties needed by postal software to determine how to process the mailpiece information contained within the external document properties file.
Job property defaults
  • Container size

  • Identical mail piece thickness:

  • Identical mail piece weight:

  • Mail class:

  • Mail piece height:

  • Mail piece length:

  • Mail rate type:

  • Mail type:

  • Mailer ID:

  • Maximum weight of container:

  • Maximum weight of pallet:

  • Minimum weight of container:

  • Minimum weight of pallet:

  • Pallet size:

  • Postage statement date:

  • Presort process:

  • Processing category

  • Use variable measurements: Not Set

1.2.10.2.91 SetPropertiesForReconcile

A step based on the SetPropertiesForReconcile step template sets job and document properties that are required for manual reconciliation or automated verification.
Job property defaults
  • Insert iteration: 1
Usage notes
  • This step sets the Insert sequence document property to the numerical position of each document in the job.
  • A step based on the SetPropertiesForReconcile step template must run after a step based on the WriteDocumentsToDatabase step template and after any step that changes the position of the documents in the job.
  • A step based on the SetPropertiesForReconcile step template must run before any step that relies on the value of the Insert sequence document property. Examples include steps based on the BuildAFPFromDocuments or BuildPDFFromDocuments step template.
  • If you run the SetPropertiesForReconcile step before the Reconcile step, you can use any of the three methods to find documents in the Reconcile dialog:
    • If you choose By properties, you can choose the Insert sequence property and enter a collection of values to find.
    • If you choose By barcode scan, you can scan the barcodes on the documents that you want to find. The Insert sequence property must be included in both the barcode format and the barcodes that are printed on the documents.
    • If you choose By range, you can define a range of values by specifying the first and last Insert sequence values to include.
  • This step must run on the primary server.

1.2.10.2.92 SetWPMProperties

This step template specifies values that are included on the User Information Page (UIP) that RICOH ProcessDirector can create and send to a WPM AFP Emulator.
Job property defaults
  • ACRISID:
  • CELL_DEF_FILE:
  • DBCS_FONTHEIGHT_RATIO:
  • DELDATE:
  • FORMDATE:
  • FORMID:
  • FORMNAME:
  • FORMNO:
  • FORMSIZE:
  • FORMTYPE:
  • MOVE_DATE:
  • MOVE_DIR:
  • OUTPUT_DIR:
  • SBCS_FONTHEIGHT_RATIO:
  • SECCLASS:
  • SENDDATE:
  • SHIFT_CHARS_RATIO:
  • SYSTEM_FLAG:
  • TITLE:
  • User Information Page DBCS coded font:
  • User Information Page SBCS coded font:
Usage notes
  • The UIP is not created until the job arrives in the step based on the PrintJobs step template. If the printer that the job is assigned to is an AFP printer with the Create User Information Page property set to Yes, RICOH ProcessDirector creates the UIP and sends it to the WPM AFP Emulator with the job.
  • All dates must be entered in this format: YYYYMMDD. For example, May 27, 2011 is entered: 20110527
  • The coded fonts entered as values for the User Information Page DBCS coded font and User Information Page SBCS coded font properties must be added to the code page mapping file for banner pages. The code page mapping file for banner pages is stored in:/aiw/aiw1/control_files/banner_pages/.

    Add lines to map your SBCS and DBCS coded fonts to the IBM-930 or IBM-939 code pages. For example, add lines like these:

    X0H16N=IBM930
    X0G32F=IBM930
    X0H16U=IBM939
    X0M32F=IBM939

    Also make sure that the coded fonts are stored in a directory that RICOH ProcessDirector searches for resources. For example, you can add the directory to the AFP resource path property for the printer object.

  • You can use RICOH ProcessDirector symbols in the values for all job properties.
  • If you include spaces in the value of the TITLE property, they are converted to underscore characters (_) when the job is sent to WPM.

1.2.10.2.93 SnapshotJobFile

A step that is based on this step template makes a copy of the print job at this point in the workflow and stores it so RICOH ProcessDirector can access it later. Use this step template with the preview print function to make sure that the modifications made for each preview print are applied to the same print job file.
Job property defaults
  • Snapshot file type: print.pdf
  • Snapshot file descriptor: original

1.2.10.2.94 SplitDocuments

A step that is based on the SplitDocuments step template updates the document properties file to define child jobs within the group.

For example, a group might have 100,000 documents but the inserter can only hold 45,000 at a time; the SplitDocuments step can divide the 100,000 documents into three smaller print jobs. If a single document exceeds the maximum document threshold, it is placed into a job by itself.

If the maximum number of documents or sheets is exceeded, SplitDocuments splits the child jobs into smaller child jobs. The ordering of the documents is preserved in the child job, but the value is adjusted when a job is split so that the first document in the job always has a sequence of 1 and the sequence increments by one for the subsequent documents. When the documents are split into groups, the value of the sequence properties change, but the actual ordering of the documents in the document properties file does not change. If the maximum number of documents or sheets is not exceeded, SplitDocuments does not split the job, and does not change the production job IDs.

You can change the point at which a job is split using the Split boundary property and the Exceed maximum split to reach boundary property. To use these properties, you must have already defined a property that identifies groups of documents that you want to keep grouped in the same job.

Optionally, you can choose to balance the sizes of the resulting child jobs using the Split balance property. Without balancing, the child jobs will be at or close to the maximum size except for the last child job, which might be much smaller than the other jobs. Using Split balance will produce the same number of child jobs as splitting without balancing, but the jobs will be nearly the same size. Optimally the size of each child job would be the same and would be the total size of the original job divided by the number of children (the average of the sizes of all of the children). However, the actual size of the child jobs can differ due to differing sizes of documents and the use of the Split boundary option. Balancing works best when the largest document size (or group if you use Split boundary) is relatively small compared to the maximum size. For example, if the largest document or group is 10% of the maximum size, then the difference in child job sizes could be up to 20% of the maximum.

For example, you might want to make sure that child jobs are split between mailpiece trays so that documents for each tray are all in the same job. First, define a custom document property named Tray ID and make sure that each document has a value for it. Without a split boundary the SplitDocuments step might split the job in the middle of a tray. However, if you enter Tray ID as the value of the Split boundary property, SplitDocuments considers only split points for child jobs where the Tray ID for adjacent documents is different. If Exceed maximum split to reach boundary is Yes, the step will move the split point to the end of the tray so that the child job size equals or exceeds the maximum job size. If Exceed maximum split to reach boundary is No, the step will not add a tray to the child job if adding that tray will cause the child job size to exceed the maximum job size. If you select a Split balance option, the SplitDocuments step will select split points so that the number of mailpieces in each child job is distributed more evenly.

Job property defaults
  • Maximum documents per child job: Not set
  • Maximum sheets per child job: Not set
  • Split boundary: Not set
  • Exceed maximum split to reach boundary: Yes
  • Split balance: None
Usage notes
  • You might want to set the maximum number of documents and sheets to 45,000 each. This corresponds to a typical roll of paper and the capacity at many print shops. Inserter input capacity, paper thickness, business processes, and other factors can affect the optimal value.
      Note:
    • Remember that a sheet represents the physical piece of paper and a page represents one printed page. If you are printing a duplex job, each sheet holds two pages: the front side and the back side.
    • If you are printing mulch-up jobs, a single sheet can contain many more pages. For example, a 4-up duplex job actually prints eight pages per sheet.
  • If a step based on the SortDocuments step template occurs before this step, document sequence is preserved.
  • You can enter a value for both the Maximum documents per child job property and the Maximum sheets per child job property; when either limit is reached, the job splits.
  • SplitDocuments updates the values in the document properties file, not the database. To update the database values of document properties, add a step based on UpdateDocumentsInDatabase in your workflow after SplitDocuments.
  • The Split balance algorithm does not always produce an optimal job balance; you might want to try running the step with and without the option to see which results better meet your needs.
  • When the step balances the job using a Split balance option, document sequence is preserved; for example, the step does not move a document from the first child job to the third child job.
  • If you select a Split balance option but the step determines that it would create more child jobs than with normal processing, the step ignores the Split balance option.

1.2.10.2.95 SortDocuments

A step that is based on the SortDocuments step template updates the document properties file to reorder the documents in a group according to their values for the sort properties. For example, you can sort the documents in a job to appear in ascending order by account number. You can select up to six fields from the document properties file by which to sort the documents.
The step first defines the document sequence (using the Sequence in Child property) according to the first sort property and direction. The step then refines the document sequence for each set of documents that all have the same value of the first sort property. The step uses the second sort property and direction to refine the values in each of the sets. The step repeats this process for the remaining sort properties.
Job property defaults
  • Sort first: Not set
  • First sort direction: Not set
  • Sort second: Not set
  • Second sort direction: Not set
  • Sort third: Not set
  • Third sort direction: Not set
  • Sort fourth: Not set
  • Fourth sort direction: Not set
  • Sort fifth: Not set
  • Fifth sort direction: Not set
  • Sort sixth: Not set
  • Sixth sort direction: Not set
Usage notes
  • You cannot copy or delete this step template.
  • The sort is based on Unicode values in UTF-8 order.
  • Sorting occurs within existing document groups established by GroupDocuments or SplitDocuments.
  • Make sure that your selections in the drop-down lists are valid at the point in the workflow when the step based on SortDocuments runs. For example, if you want to sort by the Document ID property value, a step based on WriteDocumentsToDatabase must precede SortDocuments because Document ID values are defined when WriteDocumentsToDatabase runs.
  • SortDocuments updates the values in the document properties file, not the database. To update the database values of document properties, add a step based on UpdateDocumentsInDatabase in your workflow after SortDocuments.
  • The type of comparison that is done depends on the data type associated with the property. A property that stores string values uses a character comparison (even if the values are numbers). Properties that have a list of values are sorted according to the collating sequence defined for the list, not on a character comparison. Numeric data types are sorted based on a numeric sort.
  • If a sort property is specified but the corresponding sort direction field is empty, the step orders the results in ascending order.
  • If any of the sort properties have no value, sorting occurs according to the remaining properties. If no properties have a value, no sorting occurs.
  • If a Child Job ID property is set in the document properties file, sorting occurs within each child job ID.
  • The Sequence in Child property shows the numerical order of this document in the child job. When you sort the documents, the value of this attribute can change, but the actual ordering of the documents in the document properties file does not change.

1.2.10.2.96 StandardizeAFP

A step that is based on this step template adjusts the AFP print file to reference the correct medium maps when processing documents. The medium map specifies formatting options, such as duplex options and overlays. For accurate document processing, AFP files must contain an Invoke Medium Map (IMM) structured field in each document (page group) so that RICOH ProcessDirector knows which medium map to use. This step adds IMM structured fields in each document in a job if they do not already exist. For duplex jobs, this step also ensures that an even number of pages are included in each page group.
Job property defaults
  • Duplex: Not set
  • Form definition: F1A10111
  • AFP resource path

Usage notes:

  • Tune the step so that it runs only on the primary server.
  • Add the new step into your workflow, inserting it:
    • After IndexAFP (if applicable)
    • Before IdentifyDocuments
  • If you specify Yes or Tumble for the Duplex property, you may need to add the EnableRepositioning step after this step to adjust the page count for the job.

1.2.10.2.97 StoreInRepository

A step that is based on this step template stores a copy of the file selected by the File to store property, history information about the job, or both the file and history information in a repository for a set period of time. You must specify the job and document property values that you want to store along with the job or history information. Those values can be used to retrieve the job, documents inside the job, or job history at a later time.
These job and document properties are stored by default and are not available to select on the step template:
  • AFP resource path (Job.Print.ResourcePath), if AFP Support is installed.
  • Current first page (Doc.CurrentFirstPage).
  • Current pages (Doc.CurrentPages).
  • Current Sheets (Doc.CurrentSheets).
  • Data type (Job.Repository.DataType).
  • Form definition (Job.Line2AFP.FORMDEF), if AFP Support is installed.
  • Original first page (Doc.OriginalFirstPage).
  • Original pages (Doc.OriginalPages).
  • Repository identifier (Job.Repository.Identifier).
  • Sequence in child job (Doc.SequenceInChild).
  • Sequence in original job (Doc.OriginalSequence).
  • Total pages (Job.TotalPages).
Job property defaults
  • Associated properties file:
  • Document properties file: ${getFileName(document,dpf,read)}
  • Document properties to store:
  • File to store: ${getCurrentFile(${Job.InputDatastream})}
  • Job properties to store:
  • Path to override properties file:
  • Repository: Not set
  • Store history records: No
Usage notes
  • You must have at least one repository defined to use this step.
  • You must select at least one job property or one document property to store with the file or history record, in addition to the properties that are stored by default.
  • To store history records for a job, make sure that you have defined and enabled a history record notification object.
  • To store properties related to the job set on objects used by the job, such as printer properties, use the Associated properties file property.
  • If you want to store history information about the job without storing a job file, make sure the File to store property is blank.
  • If you do not specify a file in the File to store property and no history records exist for the job when the step runs, only property values are stored.
  • To store override properties with a job, you must define a text file with the database name of each job property on a separate line. For example, this file specifies three job properties (Customer name, Media required, and Duplex):
    Job.CustomerNameJob.MediaRequiredJob.Duplex

    To add comments to the file, place each comment on a separate line that starts with a pound sign (#).

1.2.10.2.98 SubmitChildFiles

A step that is based on this step template is used internally to create child jobs from the SubmitInputFiles step. It cannot be added to a workflow and cannot be set as a property of an input device; it is invoked automatically when it is needed.
Job property defaults
None
Usage note
You cannot copy or delete this step template.

1.2.10.2.99 SubmitInputFiles

A step that is based on this step template submits a group of input files according to the batching method specified. This type of step cannot be added to a workflow; it is set as the value of the Submit step property of an input device.

If the Create .zip file property for an input device is set to No, the step submits a parent job with a set of child jobs. A single input file is submitted as a single job that is processed by the child workflow, without a parent job. When there is a parent job and a set of child jobs, RICOH ProcessDirector maintains a relationship between the parent and child jobs throughout the time that they remain on the system. If the Merge dataset property for a Download input device is set to No, the input device submits multi-dataset jobs as a parent job with a set of child jobs.

If the Create .zip file property for a hot folder input device is set to Yes, the step collects all of the files that match the value of the Data patterns property and creates a .zip file. The .zip file is submitted as a single job that is processed by the workflow.

Associated property
  • Submit step
Job property defaults
None
Usage notes
  • Set either the Child workflow property or the Child workflow initialization step property for the input device to assign a workflow to the jobs.
  • Set the Batching method property for the input device that uses this type of step to any value except None.
  • If a Job Definition Format (JDF) job ticket contains references to more than one file, the step rewrites the job ticket to reference only the file for each child job.
  • You cannot copy or delete this step template.

1.2.10.2.100 TransformJobIntoAFP

A step that is based on this step template calls a RICOH ProcessDirector Transform to convert a job to AFP.

When a job arrives in this step, the step looks in the spool directory to see if it contains an AFP file:

  • If it does, the step passes the job to the next step.
  • If it does not, the step looks at the values of the Input data stream property and determines whether a RICOH ProcessDirector Transform can convert it to AFP.
    • If it can, the step sends the file to the Transform program, which converts the file and passes the AFP file back to RICOH ProcessDirector.
    • If it cannot, the step puts the job in Error state.

Job property defaults
  • Create IS/3 compliant AFP: Not set
  • External command: itm_driver -C ${getControlFileName()}
  • External control file template: /aiw/aiw1/control_files/external_programs/prepare_transform.cfg
  • External program language: Not set
  • External program code page: Not set
  • Input data stream: Unknown
  • Transform image output format: Not set
  • Transform halftone: Not set
  • Transform page width (inches): 8.5
  • Transform page length (inches): 11.0
  • Transform resolution (dpi): 600
  • Transform RIP for printer: Not set
  • Valid return codes: 0
Usage notes
  • Only use this step template if you have the AFP Support feature installed. One of the RICOH ProcessDirector Transform features must also be installed.
  • If you are using the SAP to AFP transform feature to transform ABAP files, the SAP to AFP transform feature must be installed on the primary server.
  • When you add a step based on this step template to a workflow, you can also include a step based on the DetectInputDatastream step template in the workflow. However, if you plan to process only one input data stream through that workflow, you can omit the DetectInputDatastream step and set the Input data stream value instead.
  • If you transform GIF, JPEG, PDF, PS, or TIFF data to AFP for printing on an InfoPrint 4100-TS or InfoPrint 4100-TD printer using PQI toner, consult your Ricoh support representative to determine the value of the Transform halftone property.
  • The InfoPrint Pro C900AFP printer supports a resolution of 1200 dpi, but the largest value that you can specify for the Transform resolution property is 999. To print at 1200 dpi, change the file specified by the External control file template property to specify a resolution of 1200.
      Important:
    • The RICOH PCL to AFP transform does not support a resolution of 1200.
  • This step template does not send jobs to transforms associated with the Advanced Transform feature. Use the TransformWithAdvancedFeature step template with the Advanced Transform Feature.
  • When you open the properties for this step template in the Workflow tab, the values for the Transform page width and Transform page length properties are in inches. If you open the properties for this step template on the Administration page, they are in inches or millimeters.
  • If you transform PDF data to AFP, you can use either the Adobe PDF Print Engine (APPE) or Configurable PostScript Interpreter (CPSI) conversion program. We recommend using APPE for these reasons:
    • Direct conversion of PDF data to AFP

      CPSI first converts PDF data to PostScript, and then converts PostScript data to AFP.

    • Support for modern PDF capabilities such as transparency and drop shadows
    • Better performance for color jobs

    To convert PDF data with APPE, change the name of the file in the value of the External control file template property to prepare_transform_APPE.cfg. Leave the directory path the same. To convert PDF data with CPSI, keep the default value for the name of the file: prepare_transform.cfg. Both control files convert PostScript, PCL, and SAP data to AFP.

      Note:
    • If your primary server runs Red Hat 6.x or SLES 11, use CPSI to convert PDF data. APPE is not supported on those operating systems.

1.2.10.2.101 TransformJobIntoPDF

A step that is based on this step template calls a RICOH ProcessDirector Transform to convert a file to PDF.

When a job arrives in this step, the step looks in the spool directory to see if it contains a PDF file:

  • If it does, the step passes the job to the next step.
  • If it does not, the step looks at the value of the Input data stream property and determines whether a RICOH ProcessDirector Transform can convert it to PDF.
    • If it can, the step sends the file to the Transform program, which converts the file and passes the PDF file back to RICOH ProcessDirector.
    • If it cannot, the step puts the job in Error state.
  • This step template does not send jobs to transforms associated with the Advanced Transform feature. Use the TransformWithAdvancedFeature step template with the Advanced Transform Feature.

Job property defaults
  • External command: itm_driver -C ${getControlFileName()}
  • External control file template: /aiw/aiw1/control_files/external_programs/pdf_transform.cfg
  • External program language: Not set
  • External program code page: Not set
  • Form definition: F1A10111
  • Input data stream: Unknown
  • Valid return codes: 0
Usage notes
When you add a step based on this step template to a workflow, you can also include a step based on the DetectInputDatastream step template in the workflow. However, if you plan to process only one input data stream through that workflow, you can omit the DetectInputDatastream step and set the Input data stream value instead.

1.2.10.2.102 TransformToPDFWithMediaInfo

A step based on this step template calls the Advanced Transform feature to transform AFP or PostScript input into PDF output. The step creates a PDF file for the job and a JDF job ticket with media information, including page exceptions.
Basic job property defaults
  • Duplex: Not set
  • Page range to transform:
  • Path to ICC profile:
  • Path to custom profiles: ${AIWDATA}/cpt/profiles
  • PDF page scaling factor:
  • Transform input stream: Use current
  • Transform page length:
  • Transform page width:
  • Transform resolution (dpi):
Advanced job property defaults
  • External command: perl ${AIWDATA}/bin/callxform.pl -C ${getControlFileName()} -i ${getCurrentFile(${Job.Transform.InputStream})} -o ${getAbsoluteFileName( print, pdf, write)} -msg.remove AFP2014
  • External control file template: /aiw/aiw1/control_files/external_programs/xform.cfg
  • External program code page: Not set
  • External program language: Not set
  • Font fidelity: Strict
  • Generate PDF TOC: Not set
  • Include fonts in the output: Not set
  • Media information command: perl ${AIWDATA}/bin/callxform.pl -C ${getControlFileName()} -i ${getCurrentFile(${Job.Transform.InputStream})} -type xif -loglevel I -logdate -logtime -logdir ${Job.SpoolFileStem}tmp -logfile ${Job.ID}.xif.log -verbose -relaxed -msg.add PSI3002 -remove abcefhilnoprst01234
  • Path to media mapping file:
  • Path to system fonts:
  • Path to TrueType fonts:
  • Render output as: Text
  • Valid return codes: 0
Usage Notes
  • This step requires at least one of the following input transforms for the Advanced Transform feature:
    • InputAFP
    • InputPS

    The step also requires the OutputPDF output transform.

  • If you are retrieving media information from an AFP data stream, you must edit the value of the Media information command property. Add the -enablefdp argument between the input argument, -i, and the type argument, -type. This example shows the edited command:

    perl ${AIWDATA}/bin/callxform.pl -C ${getControlFileName()} -i ${getCurrentFile(${Job.Transform.InputStream})} -enablefdp -type xif -loglevel I -logdate -logtime -logdir ${Job.SpoolFileStem}tmp -logfile ${Job.ID}.xif.log -verbose -relaxed -msg.add PSI3002 -remove abcefhilnoprst01234

    If you are retrieving media information from a PostScript data stream, the command works without any edits.

  • If the input PostScript or AFP job specifies a combination of simple and duplex pages, the JDF job ticket produced by the step includes a Sides page exception for every page in the job. To speed processing, add an OptimizeJDF step in the workflow after the TransformToPDFWithMediaInfo step.
  • The step creates a JDF file in the spool directory named Job.ID.overrides.jdf, for example, 10000001.overrides.jdf.
  • When the step generates the JDF job ticket, it uses the media names in the AFP or PostScript input, for example, TRAY1. The media names in the JDF job ticket must match the names of RICOH ProcessDirector media objects. You can use any of these methods to make the media names match:
    • You can change the media names in the AFP or PostScript input.
    • You can create RICOH ProcessDirector media objects with the same names as the media names in the AFP or PostScript input.
    • You can create a media mapping file that maps the media names in the AFP or PostScript input to the names of RICOH ProcessDirector media objects.

      This example maps four AFP or PostScript media names (A4, Letter, TRAY1, and TRAY2) to four RICOH ProcessDirector media names:

      # AFPorPSmedia=RPDmedia
      A4=A4 Plain
      Letter=Letter Color
      TRAY1=Letter Preprinted
      TRAY2=A3 Plain

      For information about mapping media names in the AFP or PostScript input to RICOH ProcessDirector media names, refer to the Information Center.

  • If any media name in the JDF job ticket is not defined as a media object in RICOH ProcessDirector, the job goes into the error state. The Reason for wait status value is No matching media.
  • After this step runs, you can see the results by displaying the page exceptions for the job.

  • Steps based on the TransformToPDFWithMediaInfo step template have positional properties. You can place a step with positional properties in a workflow multiple times, and the job properties can take different values when each step is used. In the job property notebook, the phase and step names appear as section names with the properties of the step shown inside the section.

1.2.10.2.103 TransformWithAdvancedFeature

A step that is based on this step template calls the Advanced Transform feature to convert a job from one data stream to another.
Job property defaults
  • Create inline form definition: Not set
  • Default paper size for PostScript: Letter
  • Duplex: Not set
  • External command: perl ${AIWDATA}/bin/callxform.pl -C ${getControlFileName()} -i ${getAbsoluteFileName( print, ${Job.Transform.OutputStream}, write)} -o ${getAbsoluteFileName( print, ${Job.Transform.OutputStream}, write)}
  • External control file template: /aiw/aiw1/control_files/external_programs/xform.cfg (UNIX-based operating systems) C:\AIW\AIW1\control_files\external_programs\xform.cfg (Windows)
  • External program code page: Not set
  • External program language: Not set
  • Generate PDF TOC: Not set
  • Include fonts in the output: Not set
  • Page range to transform:
  • Path to ICC profile:
  • Path to system fonts:
  • Path to TrueType fonts:
  • PDF page scaling factor:
  • Place resources inline: Yes
  • Preserve color in output: Yes
  • Transform input stream:
  • Transform output stream:
  • Transform page width:
  • Transform page length:
  • Transform resolution (dpi):
  • Use outline fonts: No
  • Use full printable area for PCL output: Not set
  • Valid return codes: 0
Usage notes
  • The list of data streams available for the Transform input stream and Transform output stream depends on the transforms that are installed. If those lists are empty, the license keys for the input and output data stream transforms are not installed. You must download and install trial or purchased license keys for the transforms.
  • If you transform AFP files that include object containers with other data stream types, you must install the appropriate input transform to avoid an error. For example, if an AFP file includes a TIFF image in an object container, you must install the InputImage transform. If an AFP file includes a PDF page in an object container, you must install the InputPDF transform.
  • Some properties do not apply to all input and output data streams. If a property does not apply to the data streams you choose, the values are ignored and those fields are grayed out on the properties notebook.
  • You can add this step to a workflow multiple times.

1.2.10.2.104 UpdateDocPropsFromExtResultsFile

A step based on this template merges the properties in the modified results file into the document properties file for the job.
Job property defaults
  • Modified results file:

1.2.10.2.105 UpdateDocumentsInDatabase

A step that is based on the UpdateDocumentsInDatabase step template updates the document properties in the database using the values from the document properties file. For example, you might want to include a step in your workflow that calls an external program to calculate values of some custom document properties; you can use a step based on the UpdateDocumentsInDatabase step template to put those results into the document database. Values in the document properties file are not changed.
Job property defaults
  • None
Usage notes
  • You cannot copy or delete this step template.
  • The document ID in the document properties file must match a document ID of a document associated with the job.
  • If some documents are pulled or made available (so they are no longer associated with the job that includes this step), the update is ignored for them and a message is added to the job log. If a document ID in the properties file does not exist in the database, the step reports an error and the job moves to an error state.
  • The step tries to update all properties that are specified in the document properties file. However, these document properties are read-only and are not updated when processed by this step:
    • Doc.CurrentFirstPage
    • Doc.CurrentPages
    • Doc.ID
    • Doc.Jobs
    • Doc.OriginalFirstPage
    • Doc.OriginalJobID
    • Doc.OriginalPages
    • Doc.OriginalSequence
    • Doc.OriginalSheets
    • Doc.State
    • Doc.CombinedDocument
    • Doc.CombinedOriginalJobID
    • Doc.CombinedSequence
    • Doc.CombinedDocID
    • Doc.MadeAvailableByJobID
    • Doc.SequenceInChild
    • Doc.Associated
    • Doc.DataLen
    • Doc.DataOffset
    • Doc.CurrentJobID
    • Doc.CurrentSequence
    • Doc.CurrentSheets

      Note:
    • Some of these properties might not be available on your system.

1.2.10.2.106 UseInlineFormDefinition

A step that is based on this step template searches the job for an inline form definition (FORMDEF). If it locates an inline form definition, the step removes the value that is set for the Form definition job property. If the Form definition value is null, RICOH ProcessDirector uses the inline form definition.
Job property defaults
None
Usage notes
  • If the job contains more than one inline form definition, RICOH ProcessDirector uses the first one that the step finds.
  • If the workflow includes a step based on this step template, it should run before all of these steps, if they are present:
    • ConvertLineDataJobIntoAFP
    • CreatePageRanges
    • EnableRepositioning
    • PrintJobs

1.2.10.2.107 VerifyPrintedSheetCount

A step that is based on this step template checks to see if the correct number of sheets have been stacked after an AFP job has successfully finished printing. You must explicitly add this step to the workflow. None of the workflows that RICOH ProcessDirector supplies include this step.
Job property defaults
None
Usage notes
  • This step can be used for jobs sent to AFP printers only.
  • When this step starts processing the job, RICOH ProcessDirector determines whether header, separator, and trailer pages are enabled for the printer that printed the job last. It then adds the numbers of copies of these types of banner pages together and does these calculations:
    • Adds the total number of banner pages to the value of the Job size (sheets) job property. Because each banner page prints on its own sheet, each banner page is equal to one sheet.
    • Compares the updated value of the Job size (sheets) property to the value of the Sheets stacked job property.
    • If the values do not match, RICOH ProcessDirector moves the job to an error state when the VerifyPrintedSheetCount step completes. RICOH ProcessDirector also moves the job to an error state if you do a Jump to or a Continue action from a saved position for the job.
  • When adding this step to a workflow, make sure that it follows the PrintJobs step. It is recommended that you set the Allow error override option to Yes for this step so you can continue printing even if the page counts do not match.

1.2.10.2.108 VerifyReceivedSheetCount

A step that is based on this step template compares the page and sheet count values that RICOH ProcessDirector receives from AFP Download Plus with the values that are calculated in the EnableRepositioning step.
Job property defaults

None

Usage notes
  • If the page and sheet counts do not match, RICOH ProcessDirector writes an error message to the job log and moves the job to an error state.
  • A workflow that includes a step based on this step template must also include a step based on the EnableRepositioning step template. This step must occur after the EnableRepositioning step.
  • It is recommended that you set the Allow error override property to Yes for this step so you can continue to print if the page counts do not match.

1.2.10.2.109 Wait

A step based on this step template moves the job to the Waiting state for a certain amount of time. The step waits for either a specific length of time or until a certain time of day.

If you set values for both Wait until and Wait for, the step calculates the end time for each option. You can choose whether to move the job to the next step at the earlier end time or the later end time.

For example, a workflow contains a Wait step with these settings:

  • Wait until: 12:00 PM
  • Time zone: Eastern Standard Time (EST)
  • Wait for: 3 hours

A job reaches that step at 10:00 AM EST. The step determines that the two possible end times are:

  • Wait until: 12:00 PM EST
  • Wait for: 3 hours (1:00 PM EST)

If Complete step after is set to First occurs, the job moves to the next step at 12:00 EST. If Complete step after is set to Last occurs, the job moves to the next step at 1:00 PM EST.

To see the calculated time when the waiting period for a job ends, check the Wait step ends property on the Wait tab of the job property notebook.

Job property defaults
  • Wait until:
  • Time zone:
  • Wait for:
  • Complete step after: First occurs
Usage notes
  • If the Wait until property value is later than the current time in the specified time zone when the Wait step starts, the job stays in the Waiting state until the specified time on the next day.
  • If only one of the Wait for or Wait until property values is specified, the Complete step after property is ignored.
  • You can end the waiting period by using the Go to Next Step action.
  • If no value is set for either the Wait for or Wait until property when the step runs, the job moves to the next step in the workflow without waiting.
  • If the waiting period expires while the server is down, the job completes the Wait step when the server comes up. If the waiting period does not expire while the server is down, the end time of the waiting period does not change.

1.2.10.2.110 WaitForDocumentCompletion

A step that is based on the WaitForDocumentCompletion step template causes the job to wait until all documents associated with that job are in the Complete state. If no documents are associated with the job, the job does not wait and completes this step immediately. This step template is similar to the WaitForRelatedJobs step template, except that WaitForDocumentCompletion is intended for use with jobs that have been processed to be treated as documents.
Usage notes

  • You cannot copy this step template.
  • WaitForDocumentCompletion is not required in workflows that process documents. If the original job creates child jobs for printing, RICOH ProcessDirector makes sure that the parent job stays in the system until the child jobs are removed. Accordingly, because WaitForDocumentCompletion is not being used, you do not need a step based on the CompleteDocuments step template.

1.2.10.2.111 WaitForGroup

A step that is based on this step template waits for all jobs with the same group ID to reach this step before it moves them on to the next step. This step should be run before the PrintJobs step.
Job property defaults
None

1.2.10.2.112 WaitForRelatedJobs

A step that is based on this step template waits to move a job to the next step in the workflow until a parent job and all its associated child jobs are ready to begin the next step. This step must occur in the same phase in the parent and child workflows.
Job property defaults
None

1.2.10.2.113 WriteDocumentsToDatabase

A step that is based on the WriteDocumentsToDatabase step template reads a document properties file for a job and inserts the values of each document property into the database.
Job property defaults
  • None
Usage notes
  • You can have only one WriteDocumentsToDatabase step in a workflow. After using WriteDocumentsToDatabase to initially add document property values to the database, use UpdateDocumentsInDatabase for any future database updates.
  • You cannot copy or delete this step template.
  • If a step based on the WriteDocumentsToDatabase step template finds an incorrect value in the document properties file, the step adds a message in the job's message log for the first error for that document property. The step inserts the value of null ('') in the database instead of the incorrect value. The job does not go to an Error state.

1.2.10.2.114 WriteInserterControlFile

A step based on the WriteInserterControlFile step template creates an inserter control file for the job. The control file tells the inserter how to process each document in the job.
Job property defaults
  • Inserter controller: Not set
  • Inserter job name: ${Job.ID}
  • Load plan: Not set
  • Load plan comment:
Usage notes
  • The default for the Inserter job name property is the job number (Job.ID property). You can put the value of the Inserter job name property in the file name of the inserter control file. You specify the file name of the control file in the Send command property of the inserter controller.
  • If you print more than one copy of a job, RICOH ProcessDirector does not write control files for the copies.
  • You must include a step based on this step template in a workflow if the inserter requires a control file. If the inserter does not require a control file, you can remove this step from the workflow.
  • This step must run before a step based on the SendInserterControlFile step template.
  • If you must send the inserter control file to the inserter before the job prints, you can move this step before the PrintJobs step.
  • This step must run on the primary server.

1.2.10.2.115 WriteJobLog

A step that is based on this step template writes information for the RICOH ProcessDirector job to an audit file.
Job property defaults
  • External program language: Not set
  • External program code page: Not set
  • External command: cp ${getControlFileName()} /aiwdir
  • External control file template: /aiw/aiw1/control_files/audit/print_properties.cfg
  • Valid return codes: 0
Usage notes
  • This step writes one audit file each time it runs. You can add the step to a workflow several times with different control files to write different audit files.
  • This step does not create the directory where the audit file is written. The directory must exist and the aiw user ID must have write access to it.

1.2.10.2.116 WritePropsToReportsDatabase

A step based on this step template lets you choose which job and document properties to store in the Reports database when the step runs. You can insert multiple copies of this step template in a workflow to store different properties at different times during job processing.
These job properties are always stored:
  • Current phase (Job.Phase)
  • Current state (Job.State)
  • Current step (Job.Step)
  • Current time (Job.CurrentTime)
  • Current workflow (Job.Process)
  • Event type (Job.Reports.EventType)
  • Job number (Job.ID)
These document properties are always stored:
  • Associated job number (Doc.CurrentJobID)
  • Original job number (Doc.OriginalJobID)
Job property defaults
  • Document properties file: ${getFileName(document,dpf,read)}
  • Document properties table: doc_workflow_props
  • Document properties to write:
  • Event type:
  • Job properties table: job_workflow_props
  • Job properties to write:
Usage notes
  • This step must run on the primary server.
  • If the table specified in Document properties table or Job properties table does not exist in the Reports database when the step runs, the table is created.
  • Every time a job or document property is added to the database table, a new column is created. The name of the column takes the database name of the job or document property, replacing every period (.) with an underscore (_). For example, the table column for Document.TotalPages is Document_TotalPages.
  • Make sure that the table names are not the same as the names of database tables specified on any of the data collectors.
  • You must select at least one job property or one document property to store, in addition to the properties that are stored by default.
  • If you run the step and later remove items from the list of properties to write, those properties are not recorded the next time the step runs. However, their columns are not deleted from the tables.
  • You must enable data collection from the Database settings page or the job fails during this step.
  • You can select to delete the data stored by the WritePropsToReportsDatabase step during a workflow. Use Workflow Step Collector from the Data Collectors section to configure the retention time. The Workflow Step Collector is enabled by default.

1.2.10.2.117 ZIPFiles

A step based on this step template creates a ZIP file from a comma-separated list of files.

Job property defaults
  • Files to ZIP:

  • Output file:

Usage notes:

  • You can specify any file that RICOH ProcessDirector can access as input to the ZIPFiles step, including files on different drives.
  • You cannot specify a directory as input. To specify all the files in a directory, use this value: directory_path/*
  • You can use RICOH ProcessDirector symbol notation in the comma-separated list of files and in the name of the output file. For more information about symbol notation and how to use it, refer to the help system.
  • The ZIPFiles step archives all files in the top-level directory of the ZIP archive. The step does not create a directory structure.

1.2.10.2.118 No longer supported

This is a list of the step templates that were removed or do not produce any output if used.

These step templates are deprecated:

  • ArchiveInserterData
  • ArchiveDocumentData
  • WriteJobReport
  • ReadDocumentsFromParent

    In early versions of RICOH ProcessDirector, steps based on the ReadDocumentsFromParent step template created a new document properties file for the job by extracting lines from the parent job document properties file. If you need to use the function provided by this step template, use the ReadDocumentsFromDatabase step template instead.

1.2.10.3 Supplied workflows

RICOH ProcessDirector provides workflows that you can use as examples for creating your own workflows.

1.2.10.3.1 AFP

Use this workflow for AFP input files that are submitted to a hot folder input device or with the LPD protocol. This workflow sets values for job properties by using values set in each step in the workflow and by using a job properties file.
The input device specifies a control file, receive_lpd_jobtype.cfg, to change LPD control file parameters for a job to a job properties file in RICOH ProcessDirectorproperty name=value format that is read by the first step in this workflow.

When using this workflow with the LPD protocol, remove ${Job.InputFile} from the Job name property in the SetJobPropsFromTextFile step.

    Note:
  • The EnableRepositioning and CreatePageRanges steps that this workflow contains return messages in the language in which the RICOH ProcessDirector base product is installed.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.2 AssemblePDF

The AssemblePDF workflow assembles a new PDF file based on a markup specified in the plug-in control files. For example, if you split a PDF job into child jobs, use AssemblePDF as the workflow that builds and prints the child jobs.

If the markup you are implementing does not require child jobs to be created, use the EnhancePDFDocuments instead of this one.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.3 ComposeAFPDataRetrieved

Use this workflow to process jobs that include a WFD file and one or more data files that are stored in another location on the network. The workflow finds the data files and sends them to Quadient Inspire Designer with the WFD file to generate an AFP print job. Then it retrieves the job and prints it.

This AFP workflow is available when the Quadient Inspire Connect and AFP Support features are installed.

    Note:
  • The default values of the Data files and Data modules properties of the ComposeAFP step in this workflow are left blank. The blank values indicate that the workflow should look for an overrides file in the job directory with the WFD file. The overrides file contains the values for the Data files and Data modules properties. The workflow sets the values based on the contents of the overrides file.
  • If your jobs use more than one data file, you must use this workflow. You cannot submit multiple data files in a job with a WFD file.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.4 ComposeAFPDataSubmitted

Use this workflow to process a WFD file and one data file. The workflow sends the files to Quadient Inspire Designer to generate an AFP print job, return the job to RICOH ProcessDirector, and print it.

This AFP workflow is available when the Quadient Inspire Connect and AFP Support features are installed.

    Note:
  • For this workflow to complete correctly, you must enter the correct value for the Data modules property of the ComposeAFP step.

    To find the names of all the input and output modules, open a command prompt on the computer that Quadient Inspire Designer is installed on and type:

    PNetTC -? sample.wfd

  • This workflow can only process jobs that include one data file. Use the ComposeAFPDataRetrieved workflow for jobs that include more than one data file.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.5 DownloadAFP

Use this workflow for AFP data sets that are submitted through Download for z/OS or AFP Download Plus or a list of multiple print files that are submitted to a hot folder input device. This workflow sets values for job properties by using values set in each step in the workflow and by using a job properties file.
The input device specifies a control file, receive_jcl_jobtype.cfg, to change JCL parameters for a job to a job properties file in RICOH ProcessDirectorproperty name=value format that is read by the first step in this workflow. The JCL parameters are sent from the z/OS host in a separate file.
    Note:
  • RICOH ProcessDirector messages might refer to this particular type of control file as an overrides file.
  • The EnableRepositioning and CreatePageRanges steps that this workflow contains return messages in the language in which the RICOH ProcessDirector base product is installed.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.6 DownloadLineData

Use this workflow for line data or mixed-mode data sets that are submitted through Download for z/OS or AFP Download Plus. This workflow sets values for job properties by using values set in each step in the workflow and by using a job properties file.

The input device specifies a control file, receive_jcl_jobtype.cfg, to change JCL parameters for a job to a job properties file in RICOH ProcessDirectorproperty name=value format that is read by the first step in this workflow. The JCL parameters are sent from the z/OS host in a separate file.

    Note:
  • RICOH ProcessDirector messages might refer to this particular type of control file as an overrides file.
  • The ConvertLineDataJobIntoAFP step that this workflow contains returns messages in the language that its External program language property specifies.
  • The EnableRepositioning and CreatePageRanges steps that this workflow contains return messages in the language in which the RICOH ProcessDirector base product is installed.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.7 ElectronicFormDocSample

This workflow demonstrates how to combine electronic forms with data in PDF files for jobs that contain documents with page exceptions.

The sample workflow prints some jobs by combining electronic forms with data and other jobs by using preprinted paper:

  • The [1] Electronic branch of the workflow sends jobs with Electronic in the name of the PDF file through the CombinePDFWithForm step, which combines the electronic forms with the data. The jobs then go to the CountPages step.
  • The [2] Preprinted branch sends jobs that do not have Electronic in the name of the PDF file directly to the CountPages step. Those jobs bypass the CombinePDFWithForm step and are printed on preprinted paper.

The Preprinted Forms Replacement feature supplies an ElectronicFormDocFolder sample hot folder, two sample jobs, and a control file that work with the ElectronicFormDocSample workflow. The ElectronicDoc.pdf sample job goes through the [1] Electronic branch, and the PreprintedDoc.pdf sample job goes through the [2] Preprinted branch. After the jobs reach the PrintJobs or RetainCompletedJobs step, you can view the jobs to see the result of combining electronic forms with data.

The ElectronicForm.ctl control file, used by the IdentifyPDFDocuments and BuildPDFFromDocuments steps, specifies page-exception media for jobs that go through the workflow. Electronic forms have been defined for the page-exception media.

Phases and steps

The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.8 ElectronicFormJobSample

This workflow demonstrates how to combine electronic forms with data in PDF files for jobs.

The sample workflow prints some jobs by combining electronic forms with data and other jobs by using preprinted paper:

  • The [1] Electronic branch of the workflow sends jobs with Electronic in the name of the PDF file through the CombinePDFWithForm step, which combines the electronic forms with the data. The jobs then go to the CountPages step.
  • The [2] Preprinted branch sends jobs that do not have Electronic in the name of the PDF file directly to the CountPages step. Those jobs bypass the CombinePDFWithForm step and are printed on preprinted paper.

The Preprinted Forms Replacement feature supplies an ElectronicFormJobFolder sample hot folder and two sample jobs that work with the ElectronicFormJobSample workflow. The ElectronicJob.pdf sample job goes through the [1] Electronic branch, and the PreprintedJob.pdf sample job goes through the [2] Preprinted branch. After the jobs reach the PrintJobs or RetainCompletedJobs step, you can view the jobs to see the result of combining electronic forms with data.

Phases and steps

The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.9 ElectronicPresentmentSample

Use this workflow to demonstrate how Electronic Presentment works.

The sample workflow sets the Customer name and Custom 1 job properties and extracts values for five document properties: Member number, PURL, Address block line 1, Statement date, and Member level.

After the PrintJobs step prints a job, the ToMailroom step holds the job for two minutes and then releases it to the StoreInRepository step. The ToMailroom step is based on the Wait step template.

The StoreInRepository step specifies five job properties and five document properties to store in the ElecPresRepository repository. The job properties are Customer name, Custom 1, Job name, Workflow, and Assigned to printer. The document properties are the ones that the workflow extracts values for.

The StoreInRepository step also stores the history information collected by the EPSampleHistory notification object.

Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Prepare, and Assemble

Print and Complete

1.2.10.3.10 EnhancePDFDocuments

The EnhancePDFDocuments identifies documents and applies markup defined in the RICOH ProcessDirector Plug-in for Adobe Acrobat control files included in a step based on the BuildPDFFromDocuments step.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.11 ErrorMessage

Use this workflow to process line data or mixed-mode error message files that are generated when you use AFP Download Plus to submit multiple-data set jobs. This workflow sets values for job properties by using values set in each step in the workflow and by using a job properties file.
The input device specifies a control file, receive_jcl_jobtype.cfg, to change JCL parameters for a job to a job properties file in RICOH ProcessDirectorproperty name=value format that is read by the first step in this workflow.
    Note:
  • This workflow includes a manual step so that you can see the messages and cancel the job if they indicate problems.
  • A parent workflow that includes ErrorMessage as a child workflow must include a step based on the WaitForGroup step template after the ManualStepWithManualStart step. That step makes the job wait until you complete the manual step of checking the messages before the job is passed to the next phase.
  • Message files from Download for z/OS are sent in line data format. As a result, the ErrorMessage workflow includes a ConvertLineDataJobIntoAFP step. This step converts the message files into AFP so that you can see them and print them. Message files from AFP Download Plus are sent in AFP format, so they do not have to be converted.
  • On a Linux system, the ConvertLineDataJobIntoAFP step that this workflow contains returns messages in the language that its External program language property specifies.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.12 GroupDocsForPostalProcess

Use this workflow to collect document data to send to postal software, update the document data from the output of the postal software, and produce child jobs for each type of mail that the postal software identified.

This sample workflow groups the documents into three different child jobs: one for mail which is qualified to run through additional postal processing, another where the mail is not qualified for additional postal processing, and a third group where the postal software returns the mail as it contains an error or requires nonstandard processing such as international delivery.

This sample workflow uses the RunHotFolderApplication step to write the file that the postal software takes as input to a directory and watch another directory for the postal software to return a file. If you want to manually transfer the files to and from the postal software, replace the RunHotFolderApplication step with a step based on the ManualStepwithAutoStart step template.

Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Complete

1.2.10.3.13 LineData

Use this workflow for ASCII line-data or mixed-mode input files that are submitted to a Hot folder input device or with the LPD protocol. This workflow sets values for job properties by using values set in each step in the workflow and by using a job properties file.

The input device specifies a control file, receive_lpd_jobtype.cfg, to change LPD control file parameters for a job to a job properties file in RICOH ProcessDirectorproperty name=value format that is read by the first step in this workflow.

When using this workflow with the LPD protocol, remove ${Job.InputFile} from the Job name property in the SetJobPropsFromTextFile step.

    Note:
  • The ConvertLineDataJobIntoAFP step that this workflow contains returns messages in the language that its External program language property specifies.
  • The EnableRepositioning and CreatePageRanges steps that this workflow contains return messages in the language in which the RICOH ProcessDirector base product is installed.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.14 MarcomProcessOrders

This workflow and the MarcomProcessJobTicket workflow demonstrate how to exchange data with the MarcomCentral web site using SOAP web services. The demonstration includes a SOAP web service input device and a SOAP web service notification.

The MarcomReceiveOrders SOAP web service input device simulates a call to a MarcomCentral web service. The input device retrieves an XML order from the sample store at the MarcomCentral web site and sends the XML job to the MarcomProcessOrders workflow.

The SetJobPropsFromTextFile step sets the Job name property to Marcom Sample Order.

The DetectInputDataStream step sets the data stream to XML.

The ApplyXSLTransform step uses the orderToOverrides.xslt XSLT style sheet to convert 8 XML elements into 5 RICOH ProcessDirector job properties in an overrides file.

The table lists the job properties in the order that they are specified in the XSLT style sheet and appear in the overrides file.

XML element Database name of job property User interface name of job property
OrderNumber Job.Marcom.OrderNumber MarcomCentral order number
ID Job.Marcom.OrderId MarcomCentral order ID
ShippingAddress/Address1ShippingAddress/CityShippingAddress/StateShippingAddress/Zip Job.Info.Attr1 Custom 1
User/Email Job.CustomerName Customer name
count(OrderDetails/OrderDetail) Job.Info.Attr2 Custom 2

The CallSOAPService step simulates a call to a MarcomCentral web service, and it retrieves 2 job tickets for the XML order. The value in the password field tells RICOH ProcessDirector to run the simulation instead of calling the web service.

The ApplyXSLTransform2 step uses the jobTicketsReceived.xslt XSLT style sheet to compute the value of the Custom 3 property by counting the number of job tickets that have been retrieved. The step puts the value in an overrides file, and overwrites the overrides file in the spool directory for the job with the new overrides file.

The CheckTicketCount step calls a RICOH ProcessDirector web service. The web service checks whether all the job tickets for an order have been retrieved. The step compares the values of Custom 2 (total job tickets) and Custom 3 (retrieved job tickets). If the values match, the step sets the value of Custom 4 (result of comparison) to EQUAL. The step puts the value in an overrides file, and overwrites the overrides file in the spool directory with the new overrides file.

The rule on the [1] All tickets found connector checks whether the value of the Custom 4 job property (result of comparison) is EQUAL.

  • If it is, the number of job tickets retrieved equals the total number of job tickets expected. The workflow sends the job directly to the CreateJobsFromXML step.
  • If it is not, the number of job tickets retrieved is less than the total number of job tickets expected. The rule on the [2] Check for tickets connector checks whether the value of the Custom count 1 job property is less than 10. The first time that the job arrives at the CheckTicketCount step, the value of the Custom count 1 property is 0.
    • If the value is 0 through 9, the workflow sends the job to the Wait step, which waits for 1 minute. The workflow then sends the job to the RunExternalProgram step.

      The RunExternalProgram step runs a Java utility that increments the value of the Custom count 1 property by 1. The workflow then sends the job back to the CallSOAPService step. The step repeats the call to the MarcomCentral web service that returns job tickets for the order. If the number of job tickets retrieved is less than expected, the workflow can send the job through the CallSOAPService step up to 9 times.

    • If the value is 10, the job has been sent to the CallSOAPService step 10 times. After 10 minutes, the number of job tickets retrieved does not equal the number expected. The job does not meet the rule on the [2] Check for tickets connector. The workflow sends the job through the [3] Timeout connector to the FailWithMesssage step and writes a failure message to the job log. The message states: Some job tickets were not found in the time allowed.

        Note:
      • Because the message is a job property, it appears on the Information tab of the job property notebook for all jobs that go through the workflow. The message appears in the job log only when the workflow sends the job through the [3] Timeout connector to the FailWithMesssage step.

The CreateJobsFromXML step uses the //JobTicket XPath expression to parse the XML job ticket information. The step finds 2 job tickets and creates 2 child jobs.

The step submits the 2 child jobs to the MarcomProcessJobTicket workflow.

The original order job is sent to the WaitForRelatedJobs step.

When all the child jobs for the order arrive at the WaitForRelatedJobs step in the MarcomProcessJobTicket workflow, RICOH ProcessDirector sends the order job to the RetainCompletedJobs step. The state of the order job changes to Retained.

When that event occurs, the MarcomCloseoutOrder web service notification simulates a call to a MarcomCentral web service. The web service changes the status of the XML order at the sample store.

If the notification called the web service instead of running the simulation, this change would occur at the sample store. On the Display by Item dialog in the Order Manager, the value in the Order Status column for each item in the order would change from Work in Progress to Shipped.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.15 MarcomProcessJobTicket

This workflow and the MarcomProcessOrders workflow demonstrate how to exchange data with the MarcomCentral web site using SOAP web services. The demonstration includes a SOAP web service input device and a SOAP web service notification.

The MarcomProcessJobTicket workflow receives child jobs from the CreateJobsFromXML step in the MarcomProcessOrders workflow.

The SetJobPropsFromTextFile step sends the child jobs to the DetectInputDataStream step, which sets the data stream to XML.

The ApplyXSLTransform step uses the jobticketToOverrides.xslt XSLT style sheet to convert 10 XML elements into 10 RICOH ProcessDirector job properties in an overrides file.

The table lists the job properties in the order that they are specified in the XSLT style sheet and appear in the overrides file.

XML element Database name of job property User interface name of job property
OrderDetails/OrderDetail/OrderID Job.Marcom.OrderId MarcomCentral order ID
OrderDetails/OrderDetail/SKUDescription Job.Info.Attr1 Custom 1
OrderDetails/OrderDetail/SKU/ID Job.Info.Attr4 Custom 4
OrderDetails/OrderDetail/ProductType Job.Marcom.ProductType MarcomCentral product type
FinalOutputFileURL/URL Job.Info.Attr3 Custom 3
floor(OrderDetails/OrderDetail/Quantity) Job.Copies Job copies requested
floor($var2_current/OrderDetails/OrderDetail/ID) Job.Marcom.JobTicketId MarcomCentral job ticket ID
OrderDetails/OrderDetail/ProductName Job.Name Job name
OrderDetails/OrderDetail/ProductDescription Job.Description Job description
OrderDetails/OrderDetail/Shipping/Method Job.Info.Attr2 Custom 2

The rule on the [1] No SKU Details connector checks whether the job has a stock-keeping unit (SKU).

  • If the value of the Custom 4 (SKU ID) property is not SKU13933967 or SKU15302443, the workflow sends the job directly to the ContinueToNextStep step.
      Note:
    • These 2 SKU IDs match the sample SKU files provided with the sample workflows. When you set up RICOH ProcessDirector to communicate with MarcomCentral, you decide how you want to store information about the items in an order.
  • If the value is SKU13933967 or SKU15302443, the workflow sends the job to the ApplyXSLTransform2 step to process the SKU information.

    The ApplyXSLTransform2 step uses the skuToOverrides.xslt XSLT style sheet to convert 3 XML elements into 3 RICOH ProcessDirector job properties.

    The table lists the job properties in the order that they are specified in the XSLT style sheet and appear in the overrides file.

    XML element Database name of job property User interface name of job property
    Media Job.Media Media
    Duplex Job.Duplex Duplex
    Package Job.Info.Attr5 Custom 5

    The step puts the values in an overrides file, and overwrites the overrides file in the spool directory for the job with the new overrides file.

When the job arrives at the ContinueToNextStep step, the rule on the [1] Warehouse connector checks the value of MarcomCentral product type property. Versioned, Variable, and JobDirect are product types for printable items.

  • If the item does not have a printable product type, the workflow sends the job through the Warehouse branch.
  • If the item has a printable product type, the workflow sends the job through the Print Shop branch.

The printable child jobs go through these steps and connectors in the Print Shop branch of the workflow:

  • When the job arrives at the second ContinueToNextStep step, the rule on the [1] File ready connector checks whether the Custom 3 (URL of download file) property is set to a value.
    • If it is, the print file is ready to download. The workflow sends the job directly to the DownloadFile step.
    • If it is not, the rule on the [2] Check for file connector checks whether the value of the Custom count 1 job property is less than 10. The first time that the job arrives at the second ContinueToNextStep step, the value of the Custom count 1 property is 0.
      • If the value is 0 through 9, the workflow sends the job to the Wait step, which waits for 30 seconds. The workflow then sends the job to the CallSOAPService step.

        The CallSOAPService step simulates a call to a MarcomCentral web service, and it retrieves a job ticket for a printable item.

        The ApplyXSLTransform2 step uses the downloadOverrides.xslt XSLT style sheet to convert the XML element for the URL of the download file into the Custom 3 job property. The step puts the value in an overrides file, and overwrites the overrides file in the spool directory for the job with the new overrides file.

        The RunExternalProgram step runs a Java utility that increments the value of the Custom count 1 property by 1. The workflow then sends the job back to the second ContinueToNextStep step, which sends the job through the Wait step to the CallSOAPService step. The CallSOAPService step repeats the call to the MarcomCentral web service that retrieves a job ticket for a printable item. If the Custom 3 property still does not have a value for the URL, the workflow sends the job through the CallSOAPService step up to 9 times.

      • If the value is 10, the job has been sent to the CallSOAPService step 10 times. After 5 minutes, the Custom 3 property still does not have a value for the file to download. The job does not meet the rule on the [2] Check for file connector. The workflow sends the job through the [3] Timeout connector to the FailWithMesssage step and writes a failure message to the job log. The message states: File was not available to download in the time allowed.

          Note:
        • Because the message is a job property, it appears on the Information tab of the job property notebook for all jobs that go through the workflow. The message appears in the job log only when the workflow sends the job through the [3] Timeout connector to the FailWithMesssage step.

  • The DownloadFile step downloads the PDF file for the printable child job.
  • The OptimizePDF, CountPages, CreatePageRanges, and PrintJobs steps process and print the job on the Sample printer.

The non-printable child jobs go through this step in the Warehouse branch of the workflow:

  • The ManualStepWithAutoStart step waits for the warehouse staff to indicate that the job is ready to ship.

The WaitForRelatedJobs step holds the parent job and each of the child jobs until all the child jobs arrive at the step.

When all the child jobs for the order arrive at the WaitForRelatedJobs step, the workflow sends the parent and child jobs to the RetainCompletedJobs step.

Phases and steps

The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Print and Complete

1.2.10.3.16 OutputAFP

Use this workflow to call the Advanced Transform feature to convert the files from any data stream to AFP.

This workflow includes steps based on the DetectInputDatastream and TransformWithAdvancedFeature step templates:

  • DetectInputDatastream determines the value of the Input data stream property for the job.
  • TransformWithAdvancedFeature uses the Transform input stream property to determine what input transform to use.

    To use the value of the Input data stream property as the transform input stream, set the Transform input stream property to Use current.

In this workflow, the value of the Transform input stream property in the step is set to Use current. As a result, this workflow accepts any input data stream and converts it to the data stream indicated in the Transform output stream property. In this case, that value is AFP.

The TransformWithAdvancedFeature step template can be configured to accept various input data streams and create various output data streams, depending on the advanced transforms that you have installed. If you want to convert job to a different data stream, you can copy the workflow and change the value of the Output data stream property. For example, if you want to accept any input data stream and convert it to PostScript, you could name the copied workflow OutputPS and change the value of the Transform output stream property to PS.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.17 OutputPDF

Use this workflow to produce PDF output from RICOH ProcessDirector. For example, you can use it to copy PDF files into a hot folder that is associated with your printer.
The workflow sets values for job properties by using values set in each step in the workflow.
    Note:
  • This workflow does not use the PrintJobs step template to send print jobs to a RICOH ProcessDirector printer. As a result, you cannot use the Jump to and Print again actions with these jobs.
  • The TransformJobIntoPDF step checks the data stream of the print job to see if it is already PDF:
    • If it is PDF, the step passes the job to the next step.
    • If it is not PDF, the step checks to see if a RICOH ProcessDirector Transform or InfoPrint Transform Manager can convert that data stream to PDF. If it can, the step passes the job to the Transform program.

InfoPrint Transform Manager is a separately orderable product.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.18 ParentNoPrint

Use this workflow for parent input files or data sets that do not contain data and that have one or more associated child files that do contain data.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.19 PDF

Use this workflow for PDF input files that are submitted to a hot folder input device or with the LPD protocol.

This workflow sets values for job properties by using values set in each step in the workflow and by using a job properties file.

On the SetJobPropsFromTextFile and PrintJobs steps, make sure you set the values of the properties that schedule jobs to printers to the values that you want to use. Jobs do not print unless their scheduling properties match the values set on the corresponding properties of the printer. For example:

  • On the SetJobPropsFromTextFile step, change the Customer name property from RicohSample to the value you want to use.
  • On the PrintJobs step, change the Requested printer property to the value that you want to use.

When using this workflow with the LPD protocol, remove ${Job.InputFile} from the Job name property in the SetJobPropsFromTextFile step.

The RunExternalProgram step runs a sample external command using a sample external control file template to produce a CSV file with the values of nine job properties. When using this workflow, delete the RunExternalProgram step or modify it to run an external command that you want to use.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.20 PDFProduction

Use this workflow for PDF input files as an example of conditional processing. Other supplied workflows provide more sample steps for processing jobs.

This workflow uses conditional processing to process small jobs with fewer than 20 pages differently from large jobs. The workflow sets values for job properties by using values set in each step in the workflow.

The workflow sends a job from the Count pages step to either the AssignJobValues step or the AssignJobValues2 step based on the job’s total pages. The connector from Count pages to AssignJobValues has a rule named < 20pg with one condition: Job.TotalPages < ‘20’. The connector to AssignJobValues2 has a rule named else with no conditions. AssignJobValues sets the Custom 1 job property to Small job. AssignJobValues2 sets the Custom 1 job property to Large job. When using this workflow, adjust the conditional processing rules as needed for your workflow.

On the SetJobPropsFromTextFile and PrintJobs steps, make sure you set the values of the properties that schedule jobs to printers to the values that you want to use. Jobs do not print unless their scheduling properties match the values set on the corresponding properties of the printer. For example:

  • On the SetJobPropsFromTextFile step, change the Customer name property from RicohSample to the value you want to use.
  • On the PrintJobs step, change the Requested printer property to the value that you want to use. If you use connectors with conditional processing rules to set which printer gets a job, set the Requested printer property value in the AssignJobValues and AssignJobValues2 steps. Values in steps based on the AssignJobValues step template override values in the PrintJobs step.
      Note:
    • If you put two PrintJobs steps in the same workflow, all property values that you set in one step are shared by the other step.

When using this workflow with the LPD protocol, remove ${Job.InputFile} from the Job name property in the SetJobPropsFromTextFile step.

The RunExternalProgram step runs a sample external command using a sample external control file template to produce a CSV file with the values of ten job properties. When using this workflow, delete the RunExternalProgram step or modify it to run an external command that you want to use.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.21 PreferencesSample

This workflow demonstrates how to update document property values using a preferences file, then process documents differently based on those values.

The sample workflow uses the ApplyPreferences step to map values from the preferences file to document properties, then update the document properties file as needed. The preferences file contains both a value that is used to identify which documents to set values for and what values to set for each document property. Two properties are set, Output type and Email address. The Output type property takes one of three values - Print, Email or Suppress.

The workflow then groups the documents according to the Output type property into three child jobs that are resubmitted to the parent workflow and proceed along separate branches containing the appropriate steps. One child job processes only documents identified with a Print output type and another processes only documents marked for email. The last job contains only documents that are neither printed nor emailed.

Phases and steps

The illustrations below show the sample workflow as a series of phases. Follow the numbers at the end of the first illustration onto the path with the same number in the next illustration.

Receive and Prepare

Assemble, Print, and Complete

1.2.10.3.22 PreviewPrintWithColorManagement

Use this workflow to print two samples of a job to an InfoPrint 5000 using different AFP color management resources (CMRs), then print the entire job using the CMRs you choose.

This workflow includes multiple instances of the ChangeHeader, InsertCMR, and PreviewPrint step templates, each with a different name.

In the Print phase, the workflow creates a snapshot of the print job, then inserts two CMRs, changes the banner page to reflect the current properties, and prints a sample job. That preview print is accepted automatically, so the job can continue processing.

When the InsertAuditCMR_Test2 step runs its external command, it uses the snapshot of the job as its input file, adds a CMR to the file and writes its output to the spool directory. The next steps add another CMR to the job, change the content of the banner page, and prints the second sample job. That preview print is not accepted automatically, so the job waits in the PreviewPrint_Test2 step until an operator compares the samples and chooses which options to use.

The operator must accept the preview print for the job to continue processing. There are two choices:

  • If the job should be printed with the options from Test2, the operator can accept the job and continue processing in the same workflow, because the spool file for the job currently uses those options.
  • If the job should be printed with the options from Test1, the operator can accept the job and continue processing in a different workflow that is only configured to insert the CMRs used in the Test1 sample and print the job. The job is moved to that workflow for further processing and printing.
      Note:
    • When you create this workflow, make sure that the External command property for the first InsertCMR step retrieves the snapshot of the job file as its input file, not the job file that is currently in the spool directory. The job file in the spool directory already has CMRs inserted from the second test.

Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Prepare, and Assemble

Print and Complete

1.2.10.3.23 PrintAndMailJob

Use this workflow to collect document data to send to postal software, update the document data from the output of the postal software and print the job for mailing.

This sample workflow uses the RunHotFolderApplication step to write the file that the postal software takes as input to a directory and watch another directory for the postal software to return a file. If you want to manually transfer the files to and from the postal software, replace the RunHotFolderApplication step with a step based on the ManualStepwithAutoStart step template.

Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble, Print, and Complete

1.2.10.3.24 PrintForPostalProcess

Use this workflow with the GroupDocsForPostalProcess workflow to print Qualified, NonQualified, and other types of mail and ensure the order of documents within each job is correct for each type of mail.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Prepare, and Assemble

Print and Complete

1.2.10.3.25 PrintInsert_I

Use this workflow to print, insert, and reconcile AFP jobs that another workflow has received. You use this workflow when you do not want to send a control file to the inserter controller for the job.
    Note:
  • This AFP workflow is only available when both the full Inserter and AFP Support features are installed.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Assemble, and Print

Insert and Complete

1.2.10.3.26 PrintInsert_II

Use this workflow to print, insert, and reconcile AFP jobs that another workflow has received. The Insert phase contains steps to write and send a control file to the inserter controller for the job.
    Note:
  • This AFP workflow is only available when both the full Inserter and AFP Support features are installed.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Assemble, and Print

Insert and Complete

1.2.10.3.27 PrintPDFInsert_I

Use this workflow to print, insert, and reconcile PDF jobs that another workflow has received. You use this workflow when you do not want to send a control file to the inserter controller for the job.
    Note:
  • This PDF workflow is only available when both the full Inserter and PDF Document Support features are installed.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.28 PrintPDFInsert_II

Use this workflow to print, insert, and reconcile PDF jobs that another workflow has received. The Insert phase contains steps to write and send a control file to the inserter controller for the job.
    Note:
  • This PDF workflow is only available when both the full Inserter and PDF Document Support features are installed.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Assemble, and Print

Insert and Complete

1.2.10.3.29 PrintDocuments

Use the PrintDocuments workflow to print jobs that you create from documents in the Documents table.
After printing completes, RICOH ProcessDirector removes the job immediately. If the possibility exists that you might need to reprint jobs, you can add a manual step after the PrintJobs step to check for adequate quality (for example, before the job is removed).
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.30 ProcessQualifiedDocuments

Used to process the child jobs created by the GroupDocsForPostalProcess workflow if the documents in the job qualified for additional postal processing.

The workflow contains steps that collect document data for the child job to send to postal software, update the document data from the output of the postal software and split the job into sizes that are optimized for printing. Those jobs then move to another workflow, PrintForPostalProcess.

Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Complete

1.2.10.3.31 PullPDFSample

Use this workflow to test how to submit a file that identifies a list of documents to pull from the sample PDF file before they print.

This sample workflow includes a Wait step and a SetDocPropsFromList step. The Wait step pauses the job for 60 seconds for demonstration purposes. In a production environment, the Wait step can be set to pause the job for a set period of time or until a specific time of day. The SetDocPropsFromList step uses the information from the sample pull list file to make sure the job is properly split to suppress the printing of the correct documents. The job also includes two paths, one for the parent job and one for the child jobs that the parent job creates.

The parent job enters the workflow and proceeds through steps that collect information about document boundaries and properties that are associated with each document in the job. Then the job enters the Wait step, where it pauses for 60 seconds. When processing resumes, the SetDocPropsFromList step checks the /aiw/aiw1/testfiles/pull directory for one or more pull list files. The sample pull list contains two account numbers. The SetDocPropsFromList step sets the Pull document property to YES for the documents that match the values in the pull list.

The GroupDocuments step identifies the group of documents to be pulled and the group to be printed based on the Pull document property. Based on that grouping, the CreateJobsFromDocuments step generates child jobs. The child jobs are resubmitted to the original workflow and follow the child job branch out of the SetJobPropsFromTextFile step. The SetDocPropsFromOriginal step copies the job properties from the parent job to the child job so they are not lost. The SetDocPropsFromConditions step uses the information in the sample property conditions file to assign a value to the Custom 1 job property that is used by the rules that send the child job to the Print or Pull branch.

The child jobs then move through their respective Print and Pull branches. At this point the parent job has moved to the WaitForRelatedJobs step and the Print child job progresses to the WaitForRelatedJobs step after printing. The Pull child job has a ManualStepWithAutoStart step. To move the Pull child job to the next step in the workflow, right-click the child job in the Jobs table and select Go to Next Step. Processing for this child job continues and all jobs, the parent job and both child jobs, enter the RetainCompletedJobs step.

The PullPDFSample workflow is shown below. The parent job flows along the path labeled Original job through the Wait and SetDocPropsFromList steps until it reaches the CreateJobsFromDocuments step where the child jobs are created. The parent job then proceeds to the WaitForRelatedJobs step where it waits for the child jobs to finish processing before moving on to the RetainCompletedJobs step.

The child jobs are resubmitted to the original workflow and flow down the path labeled Child job. At the CountPagesChild step the Print and Pull child jobs separate to their respective branches. The Print child job proceeds through to the WaitForRelatedJobs step where it waits for the Pull child job to finish its processing.

The Pull child job proceeds through its processing to the ManualStepWithAutoStart step. When you apply the Go to Next Step action, the Pull child job moves to the WaitForRelatedJobs step and then proceeds to the RetainCompletedJobs step to finish.

Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble, Print, and Complete

1.2.10.3.32 PullAFPSample

Use this workflow to test how to submit a file that identifies a list of documents to pull from the sample AFP file before they print.

This sample workflow includes a Wait step and a SetDocPropsFromList step. The Wait step pauses the job for 60 seconds for demonstration purposes. In a production environment, the Wait step can be set to pause the job for a set period of time or until a specific time of day. The SetDocPropsFromList step uses the information from the sample pull list file to make sure the job is properly split to suppress the printing of the correct documents. The job also includes two paths, one for the parent job and one for the child jobs that the parent job creates.

The parent job enters the workflow and proceeds through steps that collect information about document boundaries and properties that are associated with each document in the job. Then the job enters the Wait step, where it pauses for 60 seconds. Then the SetDocPropsFromList step checks the /aiw/aiw1/testfiles/pull directory for one or more pull list files. The sample pull list contains two account numbers. The SetDocPropsFromList step sets the Pull document property to YES for the documents that match the values in the pull list.

The GroupDocuments step identifies the group of documents to be pulled and the group to be printed based on the Pull document property. Based on that grouping, the CreateJobsFromDocuments step generates child jobs. The child jobs are resubmitted to the original workflow and follow the child job branch out of the SetJobPropsFromTextFile step. The SetDocPropsFromOriginal step copies the job properties from the parent job to the child job so they are not lost. The SetDocPropsFromConditions step uses the information in the sample property conditions file to assign a value to the Custom 1 job property that is used by the rules that send the child job to the Print or Pull branch.

The child jobs then move through their respective Print and Pull branches. At this point the parent job has moved to the WaitForRelatedJobs step and the Print child job progresses to the WaitForRelatedJobs step after printing. The Pull child job has a ManualStepWithAutoStart step. To move the Pull child job to the next step in the workflow, right-click the child job in the Jobs table and select Go to Next Step. Processing for this child job continues and all jobs, the parent job and both child jobs, enter the RetainCompletedJobs step.

The PullAFPSample workflow is shown below. The parent job flows along the path labeled Original job through the Wait and SetDocPropsFromList steps until it reaches the CreateJobsFromDocuments step where the child jobs are created. The parent job then proceeds to the WaitForRelatedJobs step where it waits for the child jobs to finish processing before moving on to the RetainCompletedJobs step.

The child jobs are resubmitted to the original workflow and flow down the path labeled Child job. At the CountPagesChild step the Print and Pull child jobs separate to their respective branches. The Print child job proceeds through to the WaitForRelatedJobs step where it waits for the Pull child job to finish its processing.

The Pull child job proceeds through its processing to the ManualStepWithAutoStart step. When you apply the Go to Next Step action, the Pull child job moves to the WaitForRelatedJobs step and then proceeds to the RetainCompletedJobs step to finish.

Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble, Print, and Complete

1.2.10.3.33 QuadientInserter

This workflow is used when you run the sample workflow that is provided with the Quadient Inserter Express feature.

The workflow receives the pre-submitted sample file and processes it, then sends it to the QuadientInserterSimulator workflow. That workflow acts as a virtual Quadient inserter controller and processes the job, then resubmits it to this workflow to process reprints needed.

    Note:
  • This workflow is available with both the full Inserter and Quadient Inserter Express features.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble and Insert

1.2.10.3.34 QuadientInserterSimulator

This workflow acts as a virtual Quadient inserter controller. It is used when you run the sample workflow that is provided with the Quadient Inserter Express feature.

The workflow receives a control file from the QuadientInserter workflow and processes it as an inserter controller would. It then sends a results file back to the original workflow, so the sample workflow can continue to run.

    Note:
  • This workflow is available with both the full Inserter and Quadient Inserter Express features.
Phases and steps
The illustration below show the sample workflow as a series of phases.

Receive, Prepare, Assemble, and Insert.

1.2.10.3.35 ReceiveInsert_I

Use this workflow to receive AFP jobs into the system and to prepare them for insertion. This workflow passes the job to workflow PrintInsert_I, which does not send a control file to the inserter controller.
    Note:
  • This AFP workflow is only available when both the full Inserter and AFP Support features are installed.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble and Complete

1.2.10.3.36 ReceiveInsert_II

Use this workflow to receive AFP jobs into the system and to prepare them for insertion. This workflow passes the job to workflow PrintInsert_II.
    Note:
  • This AFP workflow is only available when both the full Inserter and AFP Support features are installed.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble and Complete

1.2.10.3.37 ReceivePDFInsert_I

Use this workflow to receive PDF jobs into the system and to prepare them for insertion. This workflow passes the job to PrintPDFInsert_I, which does not send a control file to the inserter controller.
    Note:
  • This PDF workflow is only available when both the full Inserter and PDF Document Support features are installed.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble and Complete

1.2.10.3.38 ReceivePDFInsert_II

Use this workflow to receive PDF jobs into the system and to prepare them for insertion. This workflow passes the job to workflow PrintPDFInsert_II, which sends a control file to the inserter controller.
    Note:
  • This PDF workflow is only available when both the full Inserter and PDF Document Support features are installed.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive and Prepare

Assemble and Complete

1.2.10.3.39 ReformatAFP

Use this workflow when you have an existing AFP file that you want to send to Quadient Inspire Designer to be modified.

This AFP workflow is available when the Quadient Inspire Connect and AFP Support features are installed.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.40 RepositorySample

Use this workflow to test how to store and retrieve documents from the sample PDF file in the sample repository.

The sample workflow sets the Customer name and Custom 1 job properties and extracts the value for a new document property, Member number. The StoreInRepository step specifies those job and document properties to be used for retrieving the documents in the sample file. It also stores the history information collected by the SampleHistoryRecord notification object.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.41 RestfulWebServiceWF

Use this workflow to see how a REST web service input device, a CallRESTService step, and a REST web service notification exchange data using REST web services.

The RestfulWebServiceSample REST web service input device retrieves JSON jobs from RICOH ProcessDirector web services that simulate a web site for ordering books. The input device sends the jobs to the RestfulWebServiceWF workflow.

When a JSON job enters the Parent branch of the workflow, the SetJobPropsFromTextFile step sets values for the Customer name and Custom 1 properties.

The ConvertJSONToXML step converts the job into XML.

The ApplyXSLTransform step uses the orderToOverrides.xslt XSLT style sheet to convert 2 XML elements into 2 RICOH ProcessDirector job properties in an overrides file. The step puts the overrides file in the spool directory for the job. RICOH ProcessDirector uses the values in the overrides file to set the values of the properties for the job.

XML element Job property
orderId Job.Info.Attr3
customername Job.CustomerName

The AssignJobValues step sets the value of the Job name property.

The CallRESTService step makes a GET call to one of the sample web services that simulate the web site for ordering books. The web service returns JSON job ticket information for the order to RICOH ProcessDirector.

The ConvertJSONToXML step converts the JSON job ticket information into XML.

The CreateJobsFromXML step uses the //JobTicket XPath expression to parse the XML job ticket information. The step finds 2 job tickets and creates 2 child jobs. The step submits the 2 child jobs to the RestfulWebServiceWF workflow.

The rule on the [2] Child connector determines whether the jobs are child jobs by checking for a decimal point in the job number. The connector sends child jobs through the Child branch of the workflow.

The original JSON job continues through the Parent branch to the RunHotFolderApplication step. That step puts the JSON job in a hot folder.

One of the sample web services polls the hot folder for jobs. The web service processes each JSON job when it receives a request from the RestfulWebServiceSampleNotify notification.

The ApplyXSLTransform2 step uses the jobticketToOverrides.xslt XSLT style sheet to convert 6 XML elements for each child job into RICOH ProcessDirector job properties in an overrides file:

XML element Job property
file Job.Info.Attr2
itemnumber Job.Info.Attr1
type Job.Info.Attr4
title Job.Info.Attr5
copies Job.Copies
media Job.Media

The DownloadFile step downloads the Brochure.pdf and Cover.pdf files.

The AssignJobValues2 step sets the values of 3 job properties, including Requested printer.

The OptimizePDF, CountPages, CreatePageRanges, and PrintJobs steps process and print the child jobs.

When each child print job arrives at the RetainCompletedJobs step, the RestfulWebServiceSampleNotify web service notification makes a POST call to one of the sample web services. The web service waits until all the child jobs for the original JSON job are in the Retained job state. The web service then creates a PDF file containing the job number and item number of each job ticket in the order, for example:

10000001.2 with item number 278955095 has been processed10000001.1 with item number 913895452 has been processed

The web service puts the PDF file in the retrieval hot folder for the RunHotFolderApplication step.

The RunHotFolderApplication step polls the hot folder, finds the PDF file, and sends the job to the next step.

The AssignJobValues step sets the value of the Input data stream property to PDF and sends the PDF job to the RetainCompletedJobs step.

You can select the PDF job in the jobs table and view it to confirm that the 2 child jobs have been processed.

For an example that includes sample data, see the related task for running the RestfulWebServiceWF workflow.

Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.42 SortAFP

The SortAFP workflow identifies the documents in a single indexed AFP file and sorts them to print in the specified order. If the input AFP is not indexed, you can include a step based on the IndexAFP step template before the IdentifyDocuments step.
The SortAFP workflow does not include the WriteDocumentsToDatabase step, so the sheet counts for documents are not displayed in the Documents table. The EnableRepositioning step is included in the workflow twice. The first execution is needed so that the IdentifyDocuments step can access the starting sheet location of each document when it runs. The second execution is needed after the BuildAFPFromDocuments step because it rearranged the pages in the AFP file based on the sorting criteria.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.43 SortPDF

The SortPDF workflow identifies the documents in a single PDF file and sorts them to print in the specified order.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.44 SortSplitAFP

The SortSplitAFP workflow identifies the documents in a single indexed AFP file and then sorts, groups, and splits the grouped documents to create several print jobs. No step templates are included in the Print phase because the CreateAFPJobsFromDocuments step makes child jobs whose workflows contain the print instructions for the job.
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Prepare, and Assemble

Complete

1.2.10.3.45 SortSplitPDF

The SortSplitPDF workflow identifies the documents in a single PDF file and then sorts, groups, and splits the grouped documents to create several print jobs. No step templates are included in the Print phase because the CreateJobsFromDocuments step makes child jobs whose workflows contain the print instructions for the job.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.46 Transform

Use this workflow to call a RICOH ProcessDirector Transform or InfoPrint Transform Manager to convert the input files to the AFP format.
InfoPrint Transform Manager is a separately orderable product. Do not use this workflow with the Advanced Transform feature; use the OutputAFP workflow.
    Note:
  • The EnableRepositioning and CreatePageRanges steps that this workflow contains return messages in the language in which the RICOH ProcessDirector base product is installed.
Phases and steps
The illustration shows the steps in each phase of the sample workflow.

1.2.10.3.47 VerifySample

Use this workflow to receive PDF or AFP input files into the system and move them through the Automated Verification process.
This workflow requires that a user reconcile the results of the barcode reading to verify that all documents have the correct disposition. If one or more documents are selected to reprint in the Reconcile step of the workflow, a child job is created that enters the sample workflow at the SetJobPropsFromTextFile step. Reprinted jobs bypass the Prepare phase and move directly to the appropriate step in the Assemble phase (either BuildPDFFromDocuments or BuildAFPFromDocuments).
Phases and steps
The illustrations below show the sample workflow as a series of phases.

Receive, Prepare, and Assemble

Print and Complete

1.2.10.4 Supplied form definitions

RICOH ProcessDirector provides AFP form definitions, also called FORMDEFs, that you can use. They are installed in the /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows) directory.

The printer driver component, the line2afp data stream conversion component, and the file viewer component of RICOH ProcessDirector search that directory when they need a resource to process a job.

F1A10111 is the default form definition set in most of the workflows supplied with RICOH ProcessDirector.

1.2.10.4.1 General purpose form definitions

Form definition Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F1A10110(see note 1) 1 1 Portrait Across 0.165, 0.165
F1A10111(see note 1) 1 2 Portrait Across 0.165, 0.165
F1A10112(see note 1) 1 Tumble Portrait Across 0.165, 0.165
F1A10120(see note 1) 2 1 Portrait Across 0.165, 0.165
F1A10121(see note 1) 2 2 Portrait Across 0.165, 0.165
F1A10122(see note 1) 2 Tumble Portrait Across 0.165, 0.165
F1A10130 3 1 Portrait Across 0.165, 0.165
F1A10131 3 2 Portrait Across 0.165, 0.165
F1A10132 3 Tumble Portrait Across 0.165, 0.165
F1A10140 4 1 Portrait Across 0.165, 0.165
F1A10141 4 2 Portrait Across 0.165, 0.165
F1A10142 4 Tumble Portrait Across 0.165, 0.165
F1A10150 5 1 Portrait Across 0.165, 0.165
F1A10151 5 2 Portrait Across 0.165, 0.165
F1A10152 5 Tumble Portrait Across 0.165, 0.165
F1ACIF(see note 1) 1 2 Portrait Across 0.165, 0.165
F1H50110(see note 2) 1 1 Portrait Across 0.165, 0.165
F1H50111(see note 2) 1 2 Portrait Across 0.165, 0.165
F1H50120(see note 2) 2 1 Portrait Across 0.165, 0.165
F1H50121(see note 2) 2 2 Portrait Across 0.165, 0.165
F1HP0110(see note 3) 1 1 Portrait Across 0.165, 0.2
F1HP0111(see note 3) 1 2 Portrait Across 0.165, 0.2
F1HP0120(see note 3) 2 1 Portrait Across 0.165, 0.2
F1HP0121 2 2 Portrait Across 0.165, 0.2
F1MG0110(see note 4) 1 1 Portrait Across 0.33, 0.33
F1MG0111(see note 4) 1 2 Portrait Across 0.33, 0.33
F1MG0120(see note 4) 2 1 Portrait Across 0.33, 0.33
F1MG0121(see note 4) 2 2 Portrait Across 0.33, 0.33
F1MGIMP(see notes 4, 6) 1 1 Portrait Across 0.33, 0.33
F1PP0110(see note 5) 1 1 Portrait Across 0.25, 0.165
F1PP0111(see note 5) 1 2 Portrait Across 0.25, 0.165
F1PP0120(see note 5) 2 1 Portrait Across 0.25, 0.165
F1PP0121(see note 5) 2 2 Portrait Across 0.25, 0.165
F1SAPS(see note 1) 1 1 Portrait Across 0.16525, 0.16525
F1SAP(see note 1) 1 2 Portrait Across 0.16525, 0.16525
    Note:
  • Designed for use with IBM 3820, 3827, and 3835 printers.
  • These form definitions are recommended for printer devices that support the PCL5 and PCL5C data streams. They position the page of data so that the data is not placed in the unprintable area.
  • These form definitions are recommended for printer devices that support the PCL4 and PCL5 data streams. They position the page of data so that the data is not placed in the unprintable area.
  • These form definitions are recommended for the message pages printed by printers that InfoPrint Manager supports.
  • These form definitions are recommended for printer devices that support the PPDS data stream. They position the page of data so that the data is not placed in the unprintable area.
  • The F1MGIMP form definition specifies offset stacking.

1.2.10.4.2 Form definitions for envelopes

Form definition Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F1A000E0 Envelope 1 Landscape Across 0, 0
F1A000M0 Manual 1 Landscape Across 0, 0
F1A101E0 Envelope 1 Landscape Across 0.165, 0.165
F1A101M0 Manual 1 Landscape Across 0.165, 0.165

1.2.10.4.3 Form definitions for banner pages

Form definition Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F1AIWHDR 1 1 Portrait Across 0,0
F1AIWSEP 1 1 Portrait Across 0,0
F1AIWTRL 1 1 Portrait Across 0,0

1.2.10.4.4 Form definitions for 11-by-17 inch paper

Form definition Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F100LS 1, 2, 3, 4, 5 1 Landscape Across 0, 0
F100LD 1, 2, 3, 4, 5 2 Landscape Across 0, 0
F100LT 1, 2, 3, 4, 5 Tumble Landscape Across 0, 0
F100LAND(see the note) 1, 2, 3, 4, 5 2 Landscape Across 0, 0
Note: Used for N_UP of 1.

1.2.10.4.5 Form definitions that specify a 0, 0 offset

Form definition Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F100S 1, 2, 3, 4, 5 1 Portrait Across 0, 0
F100D 1, 2, 3, 4, 5 2 Portrait Across 0, 0
F100T 1, 2, 3, 4, 5 Tumble Portrait Across 0, 0
F1A00010 1 1 Portrait Across 0, 0
F1A00011 1 2 Portrait Across 0, 0
F1A00012 1 Tumble Portrait Across 0, 0
F1A00020 2 1 Portrait Across 0, 0
F1A00021 2 2 Portrait Across 0, 0
F1A00022 2 Tumble Portrait Across 0, 0
F1A00030 3 1 Portrait Across 0, 0
F1A00031 3 2 Portrait Across 0, 0
F1A00032 3 Tumble Portrait Across 0, 0
F1A00040 4 1 Portrait Across 0, 0
F1A00041 4 2 Portrait Across 0, 0
F1A00042 4 Tumble Portrait Across 0, 0
F1A00050 5 1 Portrait Across 0, 0
F1A00051 5 2 Portrait Across 0, 0
F1A00052 5 Tumble Portrait Across 0, 0

1.2.10.4.6 Form definitions that specify N_UP page positioning

Form definition Bin Sides N-UP Page placement Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F1BOOK(see note 2) 1 2 2
Page 1 at 1 Front
Page 2 at 2 Front
Page 3 at 2 Back
Page 4 at 1 Back
Portrait Across 0, 0
F1N2SST1(see note 2) 1, 2, 3, 4, 5 Tumble 2
Page 1 at 1 Front
Page 2 at 1 Back
Page 3 at 2 Front
Page 4 at 2 Back
Portrait Across 0, 0
F1N2SS11(see note 2) 1, 2, 3, 4, 5 2 2
Page 1 at 1 Front
Page 2 at 1 Back
Page 3 at 2 Front
Page 4 at 2 Back
Portrait Across 0, 0
F1N2SS12(see note 1) 1, 2, 3, 4, 5 2 2
Page 1 at 1 Front
Page 2 at 2 Front
Page 3 at 1 Back
Page 4 at 2 Back
Portrait Across 0, 0
F1N2SS13 (see note 2) 1, 2, 3, 4, 5 2 3
Page 1 at 1 Front
Page 2 at 2 Front
Page 3 at 3 Front
Page 4 at 1 Back
Page 5 at 2 Back
Page 6 at 3 Back
Portrait Across 0, 0
F1N20010 1 1 2 Default Portrait Across 0, 0
F1N20011 1 2 2 Default Portrait Across 0, 0
F1N20012 1 Tumble 2 Default Portrait Across 0, 0
F1N20110 1 1 2 Default Portrait Across 0.165, 0.165
F1N20111 1 2 2 Default Portrait Across 0.165, 0.165
F1N20112 1 Tumble 2 Default Portrait Across 0.165, 0.165
F1N20120 2 1 2 Default Portrait Across 0.165, 0.165
F1N20121 2 2 2 Default Portrait Across 0.165, 0.165
F1N20122 2 Tumble 2 Default Portrait Across 0.165, 0.165
F1N20130 3 1 2 Default Portrait Across 0.165, 0.165
F1N20131 3 2 2 Default Portrait Across 0.165, 0.165
F1N20132 3 Tumble 2 Default Portrait Across 0.165, 0.165
F1N20140 4 1 2 Default Portrait Across 0.165, 0.165
F1N20141 4 2 2 Default Portrait Across 0.165, 0.165
F1N20142 4 Tumble 2 Default Portrait Across 0.165, 0.165
F1N20150 5 1 2 Default Portrait Across 0.165, 0.165
F1N20151 5 2 2 Default Portrait Across 0.165, 0.165
F1N20152 5 Tumble 2 Default Portrait Across 0.165, 0.165
F1N201LA 1 1 2 Default Portrait Across 0.0, 0.5
F1N201LD 1 1 2 Default Portrait Across 0.0, 0.5
F1N201PA 1 1 2 Default Portrait Across 0.0, 0.5
F1N201PD 1 1 2 Default Portrait Across 0.0, 0.5
    Note:
  • Specified in inches from the top-left corner of the page.
  • Used with printers that support enhanced N_UP values.

1.2.10.4.7 Form definitions for printing on pre-punched paper

Form definition Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F1H10110 1 1 Portrait Across 1.000, 0.165
F1H10111 1 2 Portrait Across 1.000, 0.165, 0.165, 0.165
F1H10112 1 Tumble Portrait Across 1.000, 0.165, 1.000, 0.165
F1H10120 2 1 Portrait Across 1.000, 0.165
F1H10121 2 2 Portrait Across 1.000, 0.165, 0.165, 0.165
F1H10122 2 Tumble Portrait Across 1.000, 0.165, 1.000, 0.165
F1H10130 3 1 Portrait Across 1.000, 0.165
F1H10131 3 2 Portrait Across 1.000, 0.165, 0.165, 0.165
F1H10132 3 Tumble Portrait Across 1.000, 0.165, 1.000, 0.165
F1H10140 4 1 Portrait Across 1.000, 0.165
F1H10141 4 2 Portrait Across 1.000, 0.165, 0.165, 0.165
F1H10142 4 Tumble Portrait Across 1.000, 0.165, 1.000, 0.165
F1H10150 5 1 Portrait Across 1.000, 0.165
F1H10151 5 2 Portrait Across 1.000, 0.165, 0.165, 0.165
F1H10152 5 Tumble Portrait Across 1.000, 0.165, 1.000, 0.165

1.2.10.4.8 Form definitions for specific models of IBM printers

Form definition Printer type compatibility Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)(see note 1)
F1OG(see note 2) 3800 1 1 Landscape Across 0.0, 0.0
F10101LA 3800 wide forms 1 1 Landscape Across 0.00, 0.50
F10101LD 3800 narrow forms 1 1 Landscape Down 0.00, 0.50
F10101PA 3800 narrow forms 1 1 Portrait Across 0.00, 0.50
F10101PD 3800 wide forms 1 1 Portrait Down 0.00, 0.50
F1C10110(see note 3) Cut sheet 1 1 Landscape Down 0.165, 0.165
F1C1011(see note 4) Cut sheet 1 2 Landscape Down 0.165, 0.165
F1C10112(see note 4) Cut sheet 1 Tumble Landscape Down 0.165, 0.165
    Note:
  • Specified in inches from the paper edge.
  • Created using Overlay Generation Language (OGL). It positions sample overlays.
  • Designed for use with IBM 3835 printers.
  • Designed for use with advanced function printers. Specify these form definitions when printing data that has been formatted for cut-sheet printers.

1.2.10.4.9 Form definitions for IBM 3935 and 3160 printers

Form definition Bin Sides Presentation mode Print direction Page position (in inches from the top-left corner of the page)
F1A1BIN2 12 1 Portrait Across 0.165, 0.165
F1A1BIN3 3 1 Portrait Across 0.165, 0.165
F1A1BIN4 4 1 Portrait Across 0.165, 0.165
F1A1BIN5 5 1 Portrait Across 0.165, 0.165

1.2.10.5 Supplied page definitions

RICOH ProcessDirector provides AFP page definitions, also called PAGEDEFs, that you can use when you use the line2afp transform to convert line data and mixed mode data to AFP. They are installed in the /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows) directory.

The line2afp data stream conversion component of RICOH ProcessDirector searches that directory when it needs a resource to process a job.

1.2.10.5.1 Page definitions for letter-sized paper

Page definition Printable area (width by height, in inches) Print lines per page Print position: Down or across Recommended raster font Recommended outline font Printing direction Page orientation
P1A06462(see notes 1, 2) 8.17 by 10.67 64 at 6.0 lpi 30/0 GT10   Across Portrait
P1A08682(see note 3) 8.17 by 10.67 86 at 8.2 lpi 24/0 GT12   Across Portrait
    Note:
  • This page definition is also valid for 9.5-by-11.0 inch continuous-form paper.
  • Designed for use with IBM 3812, 3816, 3820, 3825, 3827, 3835, 3900, 4028, 4224, and 4234 printers.
  • Designed for use with IBM 3820, 3827, and 3835 printers.

1.2.10.5.2 Page definitions for A4-sized paper

Page definition Printable area (width by height, in inches) Print lines per page Print position: Down or across Recommended raster font Recommended outline font Printing direction Page orientation
P1C09182(see note 1) 7.94 by 11.36 91 at 8.2 lpi 25/0 GT12 Across Portrait
P1CYR182(see notes 1, 5) 7.94 by 11.36 91 at 8.2 lpi 25/0 Across Portrait
P1CYR683(see notes 1, 2, 3, 5) 10.67 by 7.94 66 at 8.5 lpi 24/224     Down Landscape
P1V0436B(see note 2) 10.67 by 7.11 43 at 6.1 lpi 30/0 GT10   Up Landscape
P1V04863(see notes 1, 2) 10.67 by 7.94 48 at 6.1 lpi 30/0 GT10   Down Landscape
P1V0588B(see note 2) 10.67 by 7.11 58 at 8.2 lpi 24/0 GT12   Up Landscape
P1V0598B(see note 2) 10.67 by 7.11 59 at 8.2 lpi 24/0 GT12   Up Landscape
P1V0608B(see notes 2, 3) 10.67 by 7.11 60 at 8.5 lpi 24/224 GT15   Up Landscape
P1V0618B(see notes 2, 3) 10.67 by 7.11 61 at 8.5 lpi 24/224 GT15   Up Landscape
P1V06483(see notes 1, 2) 10.67 by 7.94 64 at 8.2 lpi 24/0 GT12   Down Landscape
P1V06683(see notes 1, 2, 3) 10.67 by 7.94 66 at 8.5 lpi 24/224 GT15   Down Landscape
P1X04763(see notes 2, 4) 10.60 by 7.77 47 at 6.1 lpi 30/0 GT10   Down Landscape
    Note:
  • For use with 3820, 3827, and 3835 printers.
  • For use with letter-sized and A4-sized paper.
  • The printable area is 9.74 by 7.94 inches because of the 224 logical unit offset in the Print position: Down or across column.
  • For use with HPCL and PPDS data streams.
  • For Cyrillic support. This page definition calls the codepage T1001172 (Cyrillic Multilingual with Box Draw) with character set CZ4203 (Courier Normal) and CZ4403 (Courier Bold) directly.

1.2.10.5.3 Page definitions for letter-sized paper and A-4 paper that support multiple up values of 2 and 4

Page definition Printable area (width by height, in inches) Print lines per page Print position: Down or across Recommended raster font Recommended outline font Printing direction Page orientation
P1W1168B 10.67 by 7.11 58 at 8.2 lpi
Page 1  24/0
Page 2  24/1281
GT15   Up Landscape
P1W1188B 10.67 by 7.11 59 at 8.2 lpi
Page 1  24/0
Page 2  24/1281
GT15   Up Landscape
P1W120C2(see the note) 7.94 by 10.67 60 at 12.0 lpi
Page 1  16/160
Page 2  1344/160
GT20   Across Portrait
P1W216FB 10.67 by 7.11 54 at 15.2 lpi
Page 1  16/48
Page 2  890/48
Page 3  16/1322
Page 4  890/1322
GT24   Up Landscape
P1W220FB 10.67 by 7.11 55 at 15.2 lpi
Page 1  16/48
Page 2  890/48
Page 3  16/1322
Page 4  890/1322
GT24   Up Landscape
P1W240F3(see the note) 10.67 by 7.94 60 at 15.2 lpi
Page 1  16/48
Page 2  968/48
Page 3  16/1322
Page 4  968/1322
GT24   Down Landscape
Note: For use with IBM 3820, 3827, and 3835 printers.

1.2.10.5.4 Page definitions for legal-sized paper

Page definition Printable area (width by height, in inches) Print lines per page Print position: Down or across Recommended raster font Recommended outline font Printing direction Page orientation
P1B0446B 13.67 by 7.34 44 at 6.0 lpi 30/0 GT10   Up Landscape
P1B04963(see note 1) 13.67 by 8.17 49 at 6.0 lpi 30/0 GT10   Down Landscape
P1B0608B 13.67 by 7.34 60 at 8.2 lpi 24/0 GT12   Up Landscape
P1B06683(see note 1) 13.67 by 8.17 66 at 8.2 lpi 24/0 GT12   Down Landscape
P1B08262(see note 2) 8.17 by 13.67 82 at 6.0 lpi 30/0 GT10   Across Portrait
P1B11082(see note 1) 8.17 by 13.67 110 at 8.2 lpi 24/0 GT12   Across Portrait
P1R04763(see note 3) 13.6 by 8.0 47 at 6.0 lpi 30/0 GT10   Down Landscape
    Note:
  • For use with IBM 3820, 3827, and 3835 printers.
  • For use with IBM 3812, 3816, 3820, 3825, 3827, 3828, 3835, 3900, 4028, and 4224 printers.
  • For use with HPCL and PPDS data streams.

1.2.10.5.5 Page definitions for B4-sized paper

Page definition Printable area (width by height, in inches) Print lines per page Print position: Down or across Recommended raster font Recommended outline font Printing direction Page orientation
P1D0556B 14.0 by 8.96 55 at 6.1 lpi 30/0 GT10   Up Landscape
P1D06063(see the note) 14.0 by 9.79 60 at 6.1 lpi 30/0 GT10   Down Landscape
P1D0748B 14.0 by 8.96 74 at 8.2 lpi 24/0 GT12   Up Landscape
P1D08083(see the note) 14.0 by 9.79 80 at 8.2 lpi 24/0 GT12   Down Landscape
P1D08462(see the note) 9.79 by 14.0 84 at 6.0 lpi 30/0 GT10   Across Portrait
P1D11382(see the note) 9.79 by 14.0 113 at 8.2 lpi 24/0 GT12   Across Portrait
Note: For use with IBM 3820, 3827, and 3835 printers.

1.2.10.6 Standard fonts that the AFP viewer uses

Although you can map TrueType and OpenType fonts to any available Type 1 or Type 0 fonts, the AFP viewer recognizes a standard set. When you map to any of these fonts, you do not have to update the Type 1 and Type 0 font map.

The AFP file viewer uses these standard Type 1 fonts:

PostScript name Family name Style Weight Italic
AvantGarde-Book AvantGarde SWISS MED 0
AvantGarde-BookOblique AvantGarde SWISS MED 1
AvantGarde-Demi AvantGarde SWISS BOLD 0
AvantGarde-DemiOblique AvantGarde SWISS BOLD 1
Bookman-Demi Bookman ROMAN BOLD 0
Bookman-DemiItalic Bookman ROMAN BOLD 1
Bookman-Light Bookman ROMAN LIGHT 0
Bookman-LightItalic Bookman ROMAN LIGHT 1
Courier Courier MODERN MED 0
Courier-Bold Courier MODERN BOLD 0
Courier-Oblique Courier MODERN MED 1
Courier-BoldOblique Courier MODERN BOLD 1
Helvetica Helvetica SWISS MED 0
Helvetica-Bold Helvetica SWISS BOLD 0
Helvetica-Oblique Helvetica SWISS MED 1
Helvetica-BoldOblique Helvetica SWISS BOLD 1
Helvetica-Condensed Helvetica-Condensed SWISS MED 0
Helvetica-Condensed-Bold Helvetica-Condensed SWISS BOLD 0
Helvetica-Condensed-Oblique Helvetica-Condensed SWISS MED 1
Helvetica-Condensed-BoldOblique Helvetica-Condensed SWISS BOLD 1
Helvetica-Narrow Helvetica-Narrow SWISS MED 0
Helvetica-Narrow-Bold Helvetica-Narrow SWISS BOLD 0
Helvetica-Narrow-Oblique Helvetica-Narrow SWISS MED 1
Helvetica-Narrow-BoldOblique Helvetica-Narrow SWISS BOLD 1
NewCenturySchlbk-Roman NewCenturySchlbk ROMAN MED 0
NewCenturySchlbk-Bold NewCenturySchlbk ROMAN BOLD 0
NewCenturySchlbk-Italic NewCenturySchlbk ROMAN MED 1
NewCenturySchlbk-BoldItalic NewCenturySchlbk ROMAN BOLD 1
Palatino-Roman Palatino ROMAN MED 0
Palatino-Bold Palatino ROMAN BOLD 0
Palatino-Italic Palatino ROMAN MED 1
Palatino-BoldItalic Palatino ROMAN BOLD 1
Times-Roman TimesNewRomanTimes ROMAN MED 0
Times-Bold TimesNewRomanTimes ROMAN BOLD 0
Times-Italic TimesNewRomanTimes ROMAN MED 1
Times-BoldItalic TimesNewRomanTimes ROMAN BOLD 1
Symbol Symbol DISPLAY MED 0
ZapfChancery-MediumItalic ZapfChancery SCRIPT MED 1
ZapfDingbats ZapfDingbats DISPLAY MED 0

The AFP file viewer uses these standard Type 0 fonts:

PostScript name Family name Style Weight Italic
STSongStd-Light ChsSys ROMAN LIGHT 0
AdobeSongStd-Light ChsSys2 ROMAN LIGHT 0
AdobeMingStd-Light ChtSys ROMAN LIGHT 0
MSungStd-Light ChtSys2 ROMAN LIGHT 0
KozGoPro-Medium JpnSys SWISS MED 0
KozMinPro-Regular JpnSys2 ROMAN MED 0
AdobeMyungjoStd-Medium KorSys ROMAN MED 0
HYSMyeongJoStd-Medium KorSys2 ROMAN MED 0

1.2.10.7 Supplied fonts

Five sets of fonts are included with the RICOH ProcessDirector media package. The fonts are not available for download when you download RICOH ProcessDirector. You can request the RICOH ProcessDirector media package when you order RICOH ProcessDirector.

The RICOH ProcessDirector media package provides these fonts:

AFP Outline Fonts (LCD4-5683)
These fonts can be used on Linux and Windows. They include fonts for Japanese, Korean, Simplified Chinese, and Traditional Chinese.
AFP Classic OpenType Fonts (LCD2-20029)
These fonts have four styles: Regular, Bold, Italic, and Bold Italic.
AFP Asian Classic OpenType Fonts (LCD2-20055)
These fonts can be used to replace the older AFP Asian single byte character set (SBCS) fonts.
WorldType Fonts (LCD4-5684)
These are OpenType and TrueType fonts in Microsoft Unicode format.
AFP Raster Fonts (LCD4-5700)
These fonts are distinguished from AFP outline fonts because they have character set and coded font names that are eight characters rather than six characters.

To install these fonts for use with RICOH ProcessDirector, copy all the fonts from the supplied media to the /usr/lpp/ipfonts directory on your primary computer. Be sure to copy all font files from the media subdirectories to /usr/lpp/ipfonts . Do not maintain the subdirectory structure from the source directory, but do make sure that the uppercase file names are preserved.

The AFP printer driver component and the line2afp data stream conversion component of RICOH ProcessDirector search that directory when they need a resource to process a job.

The AFP Support feature also provides a basic set of 240-pel and 300-pel fonts (compatibility fonts). These fonts include both uniformly spaced and mixed-pitch type families. These font families are included:

  • APL
  • Boldface
  • Courier
  • Document
  • Essay
  • Format
  • Gothic
  • Letter Gothic
  • Orator
  • Prestige
  • Roman
  • Script
  • Serif
  • Symbols
  • Text

1.2.10.8 Supplied input devices

RICOH ProcessDirector provides several input devices that you can use in the installation.

1.2.10.8.1 Download input devices

Download input devices receive jobs from Download for z/OS or AFP Download Plus. The device specifies a control file to change JCL parameters for a job to a job properties file in RICOH ProcessDirectorproperty name=value format that the workflow uses.
Note: On a Linux system, if you plan to create Download input devices and you want to receive messages from the Download daemon in a language that is different from the language that you chose when you installed the RICOH ProcessDirector server, set the Device language property of the input device to the appropriate language.

1.2.10.8.1.1 DownloadAFP

Property Value
Input device description Use for AFP data sets that are submitted through Download for z/OS or AFP Download Plus.
Port number 6100
Workflow ParentNoPrint
Child workflow AFP
Folder location /aiw/aiw1/System/dl/AFP(Linux) or C:\aiw\aiw1\System\dl\AFP (Windows)
Maximum errors 10
Host code page ibm-500
Associated expected work Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromRules
Staging location /aiw/aiw1/System/dl/AFP/Staged(Linux) or C:\aiw\aiw1\System\dl\AFP\Staged (Windows)
Device language Not set
Input device location Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Trigger patterns .*\.trg$
Parent workflow pattern Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/receive_jcl_jobtype.cfg(Linux) or C:\aiw\aiw1\control_files\rules\receive_jcl_jobtype.cfg (Windows)
Send return code to host No
Completion method None
Parent workflow parsing rules Not set
Child workflow pattern Not set
Report errors No
Merge dataset No
Destination control file None

1.2.10.8.1.2 DownloadLineData

Property Value
Input device description Use for line-data or mixed-mode data sets that are submitted through Download for z/OS or AFP Download Plus.
Port number 6102
Workflow ParentNoPrint
Child workflow DownloadLineData
Folder location /aiw/aiw1/System/dl/LineData(Linux) or C:\aiw\aiw1\System\dl\LineData (Windows)
Maximum errors 10
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/dl/LineData/Staged(Linux) or C:\aiw\aiw1\System\dl\LineData\Staged (Windows)
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*\.lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/receive_jcl_jobtype.cfg(Linux) or C:\aiw\aiw1\control_files\rules\receive_jcl_jobtype.cfg (Windows)
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$
Destination control file None

1.2.10.8.2 Hot folder input devices

Hot folder input devices are directories that the system monitors. When a print job is copied or sent to a hot folder, the system notices it and begins to process it.

1.2.10.8.2.1 HotFolderAFP

Property Value
Input device description Accepts input files in the line-data, mixed-mode, and AFP formats. Uses a pattern-matching string, *.(JOB_TYPE), to set the workflow from a portion of the input file name. For example, for an input file named ""print.abc"" the workflow is set to ""abc"".
Polling interval (seconds) 30
Workflow ParentNoPrint
Child workflow LineData
Folder location /aiw/aiw1/System/hf/FileName
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromFileName
Staging location /aiw/aiw1/System/hf/FileName/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*\.lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern *.(JOB_TYPE)
Trigger patterns .*\.trg$

1.2.10.8.2.2 HotFolderFileName

Property Value
Input device description Accepts input files in the line-data, mixed-mode, and AFP formats. Uses a pattern-matching string, *.(JOB_TYPE), to set the workflow from a portion of the input file name. For example, for an input file named ""print.abc"" the workflow is set to ""abc"".
Polling interval (seconds) 30
Workflow ParentNoPrint
Child workflow LineData
Folder location /aiw/aiw1/System/hf/FileName
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromFilename
Staging location /aiw/aiw1/System/hf/FileName/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern *.(JOB_TYPE)
Trigger patterns .*\.trg$

1.2.10.8.2.3 HotFolderLineData

Property Value
Input device description Accepts input files in the line-data or mixed-mode formats. Uses the child workflow property to set the workflow to LineData, which sets values for job properties by using values set in each step in the workflow and by using an optional text-based overrides file.
Polling interval (seconds) 30
Workflow ParentNoPrint
Child workflow LineData
Folder location /aiw/aiw1/System/hf/LineData
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/LineData/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.4 HotFolderTransform

Property Value
Workflow ParentNoPrint
Child workflow Transform
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Folder location /aiw/aiw1/System/hf/Transform (Linux) or C:\aiw\aiw1\System\hf\Transform (Windows)
Host code page Not set
Polling interval 30 seconds
Staging location /aiw/aiw1/System/hf/Transform/Staged (Linux) or C:\aiw\aiw1\System\hf\Transform\Staged (Windows)
Batching method None
Input device location Not set
Maximum errors 5
Data patterns .*ps$,.*PS$,.*pcl$,.*PCL$,.*pdf$,.*PDF$,.*tiff$,.*TIFF$,.*tif$,.*TIF$,.*jpeg$,.*JPEG$,.*jpg$,.*JPG$,.*gif$,.*GIF$,.*sap$,.*SAP$,.*abap$,.*ABAP$,.*sapgof$,.*SAPGOF$,.*gof$,.*GOF$,.*otf$,.*OTF$
JDF patterns Not set
List patterns .*lst$
Overrides patterns .*oth$
Trigger patterns .*\.trg$
Completion method Size
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Convert overrides No

1.2.10.8.2.5 HotFolderJDF

Property Value
Input device description Accepts input files (typically in the PCL, PostScript and PDF formats) and associated Job Definition Format (JDF) job tickets, then uses the Child workflow property to set the workflow to Transform.
Polling interval (seconds) 30
Workflow ParentNoPrint
Child workflow PDF
Folder location /aiw/aiw1/System/hf/JDF
Maximum errors 5
Device code page UTF-8
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromRules
Staging location /aiw/aiw1/System/hf/JDF/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Folder location /aiw/aiw1/System/hf/JDF
Batching method JDF
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*\.lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*\.oth$
JDF patterns .*\.jdf$
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/receive_text_jobtype.cfg
Completion method Size
Convert overrides No
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.6 HotFolderPDF

The HotFolderPDF input device has these properties and default values.
Property Value
Input device description Accepts input files in the PDF format. Uses the Child workflow property to set the workflow to PDF, which sets values for job properties by using values set in each step in the workflow and by using an optional text-based overrides file.
Polling interval (seconds) 5
Workflow ParentNoPrint
Child workflow PDF
Folder location /aiw/aiw1/System/hf/defaultPDF
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/defaultPDF/Staged
Input device location Not set
Associated expected work Not set
Connection status Connected
Input files waiting 0
Enabled status Yes
Expected work status Not set
Folder location /aiw/aiw1/System/hf/JDF
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Not set
Data patterns .*$
List patterns .*\.lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Not set
Overrides patterns Not set
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.7 HotFolderReformatAFP

This AFP hot folder is available when the Quadient Inspire Connect and AFP Support features are installed.

Property Value
Input device description Accepts an AFP file accompanied by a WFD file that Quadient Inspire Designer can use to reformat the AFP print job.
Polling interval (seconds) 30
Workflow ParentNoPrint
Child workflow ReformatAFP
Folder location /aiw/aiw1/System/hf/HotFolderReformatAFP (Linux) or C:\aiw\aiw1\System\hf\HotFolderReformatAFP (Windows)
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromRules
Staging location /aiw/aiw1/System/hf/HotFolderReformatAFP/Staged (Linux) or C:\aiw\aiw1\System\hf\HotFolderReformatAFP\Staged (Windows)
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method List
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*lst$
File Pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*wfd$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Yes
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.8 HotFolderComposeAFPDataSubmitted

This AFP hot folder is available when the Quadient Inspire Connect and AFP Support features are installed.

Property Value
Input device description Accepts a data file accompanied by a WFD file that Quadient Inspire Designer can use to create an AFP print job
Polling interval (seconds) 30
Workflow ParentNoPrint
Child workflow ComposeAFPDataSubmitted
Folder location /aiw/aiw1/System/hf/HotFolderComposeAFPDataSubmitted (Linux) or C:\aiw\aiw1\System\hf\HotFolderComposeAFPDataSubmitted (Windows)
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromRules
Staging location /aiw/aiw1/System/hf/HotFolderComposeAFPDataSubmitted/Staged (Linux) or C:\aiw\aiw1\System\hf\HotFolderComposeAFPDataSubmitted\Staged (Windows)
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method List
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*wfd$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*csv$,.*xml$,.*dbf$,.*sap$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Yes
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.9 HotFolderComposeAFPDataRetrieved

This AFP hot folder is available when the Quadient Inspire Connect and AFP Support features are installed.

Property Value
Input device description Accepts a WFD file as an input file and submits it for processing
Polling interval (seconds) 30
Workflow ParentNoPrint
Child workflow ComposeAFPDataRetrieved
Folder location /aiw/aiw1/System/hf/HotFolderComposeAFPDataRetrieved (Linux) or C:\aiw\aiw1\System\hf\HotFolderComposeAFPDataRetrieved (Windows)
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/HotFolderComposeAFPDataRetrieved/Staged (Linux) or C:\aiw\aiw1\System\hf\HotFolderComposeAFPDataRetrieved\Staged (Windows)
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method List
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*wfd$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.10 ElectronicFormJobFolder

Use this sample to submit jobs to the ElectronicFormJobSample workflow provided with the Preprinted Forms Replacement feature.

The first time you enable and connect this input device, two sample jobs (PreprintedJob.pdf and ElectronicJob.pdf) are submitted to the ElectronicFormJobSample workflow on your system.

Property Value
Input device description Sends two sample jobs to the ElectronicFormJobSample workflow, which combines electronic forms with one of the jobs.
Polling interval (seconds) 5
Workflow ParentNoPrint
Child workflow ElectronicFormJobSample
Folder location /aiw/aiw1/System/hf/ElectronicFormJobFolder
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/ElectronicFormJobFolder/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Not set
Data patterns .*$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required Not set
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Not set
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.11 ElectronicFormDocFolder

Use this sample to submit jobs to the ElectronicFormDocSample workflow provided with the Preprinted Forms Replacement feature.

The first time you enable and connect this input device, two sample jobs (PreprintedDoc.pdf and ElectronicDoc.pdf) are submitted to the ElectronicFormDocSample workflow on your system.

Property Value
Input device description Sends two sample jobs to the ElectronicFormDocSample workflow, which combines electronic forms with one of the jobs.
Polling interval (seconds) 5
Workflow ParentNoPrint
Child workflow ElectronicFormDocSample
Folder location /aiw/aiw1/System/hf/ElectronicFormDocFolder
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/ElectronicFormDocFolder/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Not set
Data patterns .*$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required Not set
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Not set
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.12 ElecPresFolder

Use this sample to submit jobs to the sample workflow provided with the Electronic Presentment feature.

The first time you enable and connect this input device, two sample PDF jobs are submitted to the ElectronicPresentmentSample workflow on your system.

Property Value
Input device description Electronic Presentment HotFolder
Polling interval (seconds) 5
Workflow ParentNoPrint
Child workflow ElectronicPresentmentSample
Folder location /aiw/aiw1/System/hf/ElecPres
Maximum errors 5
Device code page Not set
Number of files to batch Not set
Number of pages to batch Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/ElecPres/Staged
Batching method None
Input device location Not set
Create .zip file No
Exceed pages to batch No
File pattern Not set
Spool file type Not set
File pattern sequence Not set
Spool file usage Not set
File pattern required No
Data patterns .*$
Overrides patterns .*oth$
JDF patterns Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Convert overrides Not set
Batching start date Not set
Batching interval Minute
List patterns .*lst$
Trigger patterns .*\.trg$
Completion method Size
Parent workflow pattern Not set
Child workflow pattern Not set
Batching start time Not set
Frequency (minutes) Not set

1.2.10.8.2.13 PostalFolder

Use this sample input device to submit jobs to the sample workflows provided with the Postal Enablement feature. The first time you enable and connect the input device, the sample PDF job is submitted to the PrintAndMailJob workflow on your system.

The PostalFolder input device has these properties and default values.

Property Value
Input device description Accepts input files in any format. Uses the Child workflow property to set the workflow to GroupDocsForPostalProcess, which builds the documents for postal processing.
Polling interval 5 seconds
Workflow ParentNoPrint
Child workflow GroupDocsForPostalProcess
Folder location /aiw/aiw1/System/hf/Postal (UNIX-based operating systems) or C:\aiw\aiw1\System\hf\Postal (Windows)
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/Postal/Staged (UNIX-based operating systems) or C:\aiw\aiw1\System\hf\Postal\Staged (Windows)
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required Not set
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Every minute
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.14 PreferencesFolder

Use this sample to submit jobs to the sample workflow provided with the Preference Management feature.

The first time you enable and connect this input device, the sample job is submitted to the PreferencesSample workflow on your system.

Property Value
Input device description Sends a sample job to the PreferencesSample workflow, which updates document property values based on a preferences file then processes documents differently based on those values.
Polling interval (seconds) 5
Workflow ParentNoPrint
Child workflow PreferencesSample
Folder location /aiw/aiw1/System/hf/pref
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/pref/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Not set
Data patterns .*$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required Not set
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Not set
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.15 QuadientInserterSimulator

The Quadient Inserter Simulator input device has these properties and default values.
Property Value
Workflow ParentNoPrint
Child workflow QuadientInserterSimulator
Workflow initialization step Not set
Child workflow initialization step Not set
Folder location /aiw/aiw1/System/icf/quadient_in
Staging location /aiw/aiw1/System/icf/quadient_in/stage
Batching method None
Input device location Not set
Maximum errors 5
Trigger patterns .*\.trg$
Completion method Size
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Parent workflow pattern Not set
Child workflow pattern Not set

1.2.10.8.2.16 QuadientInserterFolder

The Quadient Inserter Folder input device has these properties and default values.
Property Value
Workflow ParentNoPrint
Child workflow QuadientInserterSample
Workflow initialization step Not set
Child workflow initialization step Not set
Folder location /aiw/aiw1/System/hf/quadient
Staging location /aiw/aiw1/System/hf/quadient/Staged
Batching method None
Input device location Not set
Device code page Not set
Maximum errors 5
Trigger patterns .*\.trg$
Completion method Size
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Parent workflow pattern Not set
Child workflow pattern Not set

1.2.10.8.2.17 RepositoryFolder

Use this sample to submit jobs to the sample workflow provided with the Archive feature.

The first time you enable and connect this input device, the sample PDF job is submitted to the RepositorySample workflow on your system.

Property Value
Input device description Accepts input files in PDF format. Uses the Child workflow property to set the workflow to RepositorySample which stores the job and documents in the sample repository.
Polling interval (seconds) 5
Workflow ParentNoPrint
Child workflow RepositorySample
Folder location /aiw/aiw1/System/hf/Repository
Maximum errors 5
Device code page Not set
Parent server System
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step Not set
Staging location /aiw/aiw1/System/hf/Repository/Staged
Input device location Not set
Associated expected work Not set
Connection status Disconnected
Input files waiting 0
Enabled status No
Expected work status Not set
Batching method None
Number of files to batch Not set
Number of pages to batch Not set
Batching start date Not set
Batching interval Minute
Data patterns .*$
List patterns .*lst$
File pattern Not set
Spool file usage Not set
File pattern required No
Create .zip file No
Matching pattern for sets (.+?)\.[^.]*$|$
Exceed pages to batch No
Batching start time Not set
Frequency (minutes) Not set
Overrides patterns .*oth$
JDF patterns Not set
Spool file type Not set
File pattern sequence Not set
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Completion method Size
Convert overrides Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Trigger patterns .*\.trg$

1.2.10.8.2.18 VerificationFolder

Use this sample to submit jobs to the sample workflow provided with the Automated Verification feature. The first time you enable and connect this input device, the sample PDF job gets submitted to the VerifySample workflow on your system.

The VerificationFolder input device has these properties and default values.

Property Value
workflow ParentNoPrint
Child workflow VerifySample
Submit step SubmitInputFiles
workflow initialization step Not set
Child workflow initialization step Not set
Folder location /aiw/aiw1/System/hf/Verify (UNIX-based operating systems) or C:\aiw\aiw1\System\hf\Verify (Windows)
Device code page Not set
Polling interval 5 seconds
Staging location /aiw/aiw1/System/hf/Verify/Staged (UNIX-based operating systems) or C:\aiw\aiw1\System\hf\Verify\Staged (Windows)
Batching method None
Input device location Not set
Maximum errors 5
Data patterns .*$
JDF patterns Not set
List patterns .*lst$
Overrides patterns .*oth$
Trigger patterns .*\.trg$
Completion method Size
Parent workflow parsing rules Not set
Child workflow parsing rules Not set
Parent workflow pattern Not set
Child workflow pattern Not set
Convert overrides Not set

1.2.10.8.3 LPD input devices

Line printer daemon (LPD) input devices receive jobs submitted using the LPD protocol. The device specifies a control file to change LPD control file parameters for a job to a job properties file in RICOH ProcessDirectorproperty name=value format that the workflow uses.

The name of the LPD input device is the value of the printer option of the print command. If the receive_lpd_jobtype.cfg or receive_lpd_pdf_jobtype.cfg file is configured, the values of the job options of the print command are converted to RICOH ProcessDirector job properties.

You must specify which hosts are allowed to submit jobs to LPD input devices.

1.2.10.8.3.1 LPDAFP

Property Value
Workflow ParentNoPrint
Child workflow AFP
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromRules
Folder location /aiw/aiw1/System/lpd/LPDAFP (Linux) or C:\aiw\aiw1\System\lpd\LPDAFP (Windows)
Staging location /aiw/aiw1/System/lpd/LPDAFP/Staged (Linux) or C:\aiw\aiw1\System\lpd\LPDAFP\Staged (Windows)
Batching method List
Input device location Not set
Maximum errors 10
Data patterns .*\.prt$
List patterns .*list\.lst$
Overrides patterns .*other\.oth$
Trigger patterns .*\.trg$
Completion method Trigger
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/receive_lpd_jobtype.cfg (Linux) or C:\aiw\aiw1\control_files\rules\receive_lpd_jobtype.cfg (Windows)
Parent workflow pattern Not set
Child workflow pattern Not set
Device code page Not set

1.2.10.8.3.2 LPDLineData

Property Value
Workflow ParentNoPrint
Child workflow LineData
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromRules
Folder location /aiw/aiw1/System/lpd/LPDLineData (Linux) or C:\aiw\aiw1\System\lpd\LPDLineData (Windows)
Staging location /aiw/aiw1/System/lpd/LPDLineData/Staged (Linux) or C:\aiw\aiw1\System\lpd\LPDLineData\Staged (Windows)
Batching method List
Input device location Not set
Maximum errors 10
Data patterns .*\.prt$
List patterns .*list\.lst$
Overrides patterns .*other\.oth$
Trigger patterns .*\.trg$
Completion method Trigger
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/receive_lpd_jobtype.cfg (Linux) or C:\aiw\aiw1\control_files\rules\receive_lpd_jobtype.cfg (Windows)
Parent workflow pattern Not set
Child workflow pattern Not set
Device code page Not set

1.2.10.8.3.3 LPDPDF

The LPDPDF input device has these properties and default values.
Property Value
Workflow ParentNoPrint
Child workflow PDF
Submit step SubmitInputFiles
Workflow initialization step Not set
Child workflow initialization step SetJobTypeFromRules
Folder location /aiw/aiw1/System/lpd/LPDPDF (UNIX-based operating systems) or C:\aiw\aiw1\System\lpd\LPDPDF(Windows)
Staging location /aiw/aiw1/System/lpd/LPDPDF/Staged (UNIX-based operating systems) or C:\aiw\aiw1\System\lpd\LPDPDF\Staged (Windows)
Batching method List
Input device location Not set
Maximum errors 10
Data patterns .*\.prt$
List patterns .*list\.lst$
Overrides patterns .*other\.oth$
Trigger patterns .*\.trg$
Completion method Trigger
Parent workflow parsing rules Not set
Child workflow parsing rules /aiw/aiw1/control_files/rules/receive_lpd_pdf_jobtype.cfg
Parent workflow pattern Not set
Child workflow pattern Not set

1.2.10.8.4 Web service input devices

Use these supplied input devices as templates for creating your own REST and SOAP web service input devices.

1.2.10.8.4.1 MarcomReceiveOrders

This supplied SOAP web service input device simulates a call to a MarcomCentral web service, and it retrieves an XML order. The input device submits the order as a job to the MarcomProcessOrders workflow supplied with the MarcomCentral Connect feature.

The value in the Static credential field tells RICOH ProcessDirector to run the simulation instead of calling the web service.

Each time that you enable and connect this input device, RICOH ProcessDirector submits a sample job to the MarcomProcessOrders workflow every 30 seconds. To stop submitting jobs, disable and disconnect the input device.

General

Property Value
Input device description Receives orders from Marcom Ricoh Sample Store.
Parent server System
Polling interval (seconds) 30
Submit step SubmitInputFiles
Workflow ParentNoPrint
Child workflow MarcomProcessOrders
Maximum errors 10
Input device location Not set
Device code page Not set

Request

Property Value
Request URL https://services.printable.com/Trans/1.0/Order.asmx
Request payload
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ord="http://services.printable.com/1.0/order" 
xmlns:sso="http://www.printable.com/sso">
 <soapenv:Header/>
 <soapenv:Body>
  <ord:GetOrdersByDate>
   <sso:OrderRequestByDate version="?">
   <PartnerCredentials>
     <Token>${WebService.StaticCredential}</Token>
    </PartnerCredentials>
    <DateRange>
     <Start>${WebService.LastSuccessRequestTime}</Start>
     <End>${WebService.CurrentRequestTime}</End>
    </DateRange>
    <RequestIdentifier>?</RequestIdentifier>
   </sso:OrderRequestByDate>
  </ord:GetOrdersByDate>
 </soapenv:Body>
 </soapenv:Envelope>
SOAP request Marcom-GetOrdersByDate
Proxy server Proxy server 1
Create jobs from response Only when response pattern matches
Response pattern to match //Order
Create child jobs No
Time zone offset -7

Authentication

Property Value
Static credential Masked value
Authentication request payload  
Authentication request URL  
Authentication SOAP request Not set
Authentication response attribute  
Authentication request password  

Advanced

Property Value
Child workflow parsing rules  
Child workflow pattern  

1.2.10.8.4.2 RestfulWebServiceSample

This supplied REST web service input device makes a GET call to a sample web service and retrieves a JSON job. The input device submits the job to the RestfulWebServiceWF workflow supplied with the Web Services Enablement feature.

Each time that you enable and connect this input device, a sample job is submitted to the RestfulWebServiceWF workflow every 30 seconds. To stop submitting jobs, disable and disconnect the input device.

General

Property Value
Input device description Calls a sample REST web service, retrieves a sample JSON job every 30 seconds, and submits it to the RestfulWebServiceWF sample workflow
Parent server System
Polling interval (seconds) 30
Submit step SubmitInputFiles
Workflow ParentNoPrint
Child workflow RestfulWebServiceWF
Maximum errors 10
Input device location Not set
Device code page Not set

Request

Property Value
Request URL http://localhost:15080/restapi/1.0/sample/order
Request method GET
Request content type JSON
Request payload  
Request header fakename:RPDsample
Request parameters  
Use proxy server No
Create jobs from response Always
Response pattern to match  
Create child jobs No

Authentication

Property Value
Static credential  
Authentication response attribute  
Authentication request URL  
Authentication request method GET
Authentication request password  
Authentication response content type JSON
Authentication request payload  
Authentication request header  
Authentication request parameters  

Advanced

Property Value
Child workflow parsing rules  
Child workflow pattern  

1.2.10.9 Supplied data collectors

RICOH ProcessDirector supplies predefined data collector objects that you can use to configure the capture and data to store in the PostgreSQL database.

1.2.10.9.1 Job Step Duration

Use this data collector to capture information about the duration of steps when they process jobs in your workflows.

General

Property Default value
Database table name job_step_durations
Error log directory /aiw/aiw1/stepdurationdump
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Job properties to capture
  • Custom 1 (Job.Info.Attr1)
  • Custom 2 (Job.Info.Attr2)
  • Custom 3 (Job.Info.Attr3)
  • Custom 4 (Job.Info.Attr4)
  • Custom 5 (Job.Info.Attr5)
  • Customer name (Job.CustomerName)
  • Duplex (Job.Duplex)
  • Input data stream (Job.InputDatastream)
  • Input file name (Job.InputFile)
  • Job arrival time (Job.FileReceiptTime)
  • Job class (Job.Class)
  • Job copies requested (Job.Copies)
  • Job destination (Job.Destination)
  • Job form (Job.Form)
  • Job name (Job.Name)
  • Job priority (Job.Priority)
  • Job size (sheets) (Job.JobSize)
  • Parent server (Job.Instance)
  • Persistence job id (Job.PersistenceID)
  • Previous printer (Job.PreviousPrinter)
  • Promoted (Job.Promote)
  • Promotion time (Job.PromoteTime)
  • Reconciliation user (Job.Insert.ReconcileUser.ID)
  • Requested location (Job.Locations)
  • Requested printer (Job.RequestedPrinter)
  • Reprint count (Job.ReprintCount)
  • Retention period (Job.RetainDuration)
  • Scheduled by (Job.ScheduleUserId)
  • Source input device (Job.SourceInputDeviceName)
  • Time submitted (Job.SubmitTime)
  • Total pages (Job.TotalPages)
  • Total sheets (Job.TotalSheets)
  • Use parent settings (Job.ParentJob)
  • Workflow (Job.JobType)

Usage note: In addition to the default selected job properties, the Job Step Duration data collector always captures data about:

Job number
The unique number that identifies the job on the system.
PostgreSQL database table column name: id.
Creation time
Local time when the event was stored.
PostgreSQL database table column name: created_at.
Creation UTC time
UTC time when the event was stored.
PostgreSQL database table column name: created_at_utc.
Current Workflow
The current workflow used by the job.
PostgreSQL database table column name: job_workflow.
Current phase (Job.Phase)
The name of the workflow phase that is processing the job.
PostgreSQL database table column name: job_phase.
Current step (Job.Step)
The name of the step that is processing the job within the current phase.
PostgreSQL database table column name: job_step.
Record
Automatically generated sequence number.
PostgreSQL database table column name: record.
Step queued duration
Total time the job is queued before running.
PostgreSQL database table column name: step_queued_duration.
Step processing duration
The total time the job is in the processing state.
PostgreSQL database table column name: step_processing_duration.
Step processing end
The time the step ends processing.
PostgreSQL database table column name: step_processing_end.
Step processing start
The time when the step starts processing.
PostgreSQL database table column name: step_processing_start.
Step run duration
The total time the step was in the queued and processing states.
PostgreSQL database table column name: step_run_duration.
Step template
The name of the step template that was used to define the step.
PostgreSQL database table column name: step_template.
Step waiting duration
The total time the step is in waiting state.
PostgreSQL database table column name: step_wait_duration.
Total step duration
The total time the step was queued, processed, and in waiting state.
PostgreSQL database table column name: total_step_duration.

1.2.10.9.2 Job Step Progress

Use this data collector to select the job properties that are captured at the start and completion of each step in the workflow.

General

Property Default value
Database table name job_history
Continue on error Yes
Error log directory /aiw/aiw1/jobhistorydump
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Job properties to capture
  • Custom 1 (Job.Info.Attr1)
  • Custom 2 (Job.Info.Attr2)
  • Custom 3 (Job.Info.Attr3)
  • Custom 4 (Job.Info.Attr4)
  • Custom 5 (Job.Info.Attr5)
  • Customer name (Job.CustomerName)
  • Duplex (Job.Duplex)
  • Input data stream (Job.InputDatastream)
  • Input file name (Job.InputFile)
  • Job arrival time (Job.FileReceiptTime)
  • Job class (Job.Class)
  • Job copies requested (Job.Copies)
  • Job destination (Job.Destination)
  • Job form (Job.Form)
  • Job name (Job.Name)
  • Job size (sheets) (Job.JobSize)
  • Parent server (Job.Instance)
  • Persistence job id (Job.PersistenceID)
  • Previous printer (Job.PreviousPrinter)
  • Promoted (Job.Promote)
  • Promotion time (Job.PromoteTime)
  • Reconciliation user (Job.Insert.ReconcileUser.ID)
  • Requested printer (Job.RequestedPrinter)
  • Reprint count (Job.ReprintCount)
  • Retention period (Job.RetainDuration)
  • Scheduled by (Job.ScheduleUserId)
  • Source input device (Job.SourceInputDeviceName)
  • Time submitted (Job.SubmitTime)
  • Total sheets (Job.TotalSheets)
  • Total pages (Job.TotalPages)
  • Workflow (Job.JobType)

1.2.10.9.3 Job Print Progress

Use this data collector to select the job and printer properties that are captured when a job starts printing, when it finishes printing successfully, and when a job stops printing due to an error.

General

Property Default value
Database table name job_printing
Error log directory /aiw/aiw1/jobprintingdump
Remove expired entries Off
Retention period  
Properties to capture
Property Default value
Job properties to capture
  • Assigned printer (Job.CurrentPrinter)
  • Assigned to printer (Job.Print.AssignPrintTime)
  • Black ink usage (Job.Ink.Black)
  • Custom 1 (Job.Info.Attr1)
  • Custom 2 (Job.Info.Attr2)
  • Customer name (Job.CustomerName)
  • Current phase (Job.Phase)
  • Current Workflow (Job.Process)
  • Current step (Job.Step)
  • Current job state (Job.State)
  • Cyan ink usage (Job.Ink.Cyan)
  • Duplex (Job.Duplex)
  • Input data stream (Job.InputDatastream)
  • Job class (Job.Class)
  • Job copies stacked (Job.CopiesStacked)
  • Job copies requested (Job.Copies)
  • Job destination (Job.Destination)
  • Job form (Job.Form)
  • Job name (Job.Name)
  • Job number (Job.ID)
  • Job priority (Job.Priority)
  • Job size (Job.JobSize)
  • Magenta ink usage (Job.Ink.Magenta)
  • Media (Job.Media)
  • Output bin (Job.OutputBin)
  • Output format (Job.OutputFormat)
  • Pages stacked (Job.PagesStacked)
  • Parent server (Job.Instance)
  • Persistence job id (Job.PersistenceID)
  • Punch (Job.Punch)
  • Previous printer (Job.PreviousPrinter)
  • Print complete time (Job.Print.EndPrintTime)
  • Reconciliation user (Job.Insert.ReconcileUser.ID)
  • Request location (Job.Locations)
  • Reprint count (Job.ReprintCount)
  • Scheduled by (Job.ScheduleUserId)
  • Sheets stacked (Job.SheetsStacked)
  • System (Job.SystemName)
  • Staple (Job.Staple)
  • Total pages (Job.TotalPages)
  • Total sheets (Job.TotalSheets)
  • Yellow ink usage (Job.Ink.Yellow)
  • Workflow (Job.JobType)
Printer properties to capture
  • Customer name (Printer.CustomerName)
  • Printer description (Printer.Description)
  • Printer destination (Printer.Destination)
  • Printer location (Printer.Locations)
  • Printer model (Printer.Model.Specific)
  • Printer name (Printer.ID)
  • Printer paper type (Printer.Model)
  • Printer server (Printer.Instance)
  • Output format (Printer.OutputFormat)
  • Serial number (Printer.SerialNumber)
  • Version (Printer.Version)

1.2.10.9.4 Printer status

Use this data collector to select the printer properties that are captured each time that the Enabled status or Printer status changes.

General

Property Default value
Database table name printer_status
Error log directory /aiw/aiw1/printerstatusdump
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Printer properties to capture
  • Customer name (Printer.CustomerName)
  • Output format (Printer.OutputFormat)
  • Printer description (Printer.Description)
  • Printer destination (Printer.Destination)
  • Printer location (Printer.Locations)
  • Printer model (Printer.Model.Specific)
  • Printer name (Printer.ID)
  • Printer paper type (Printer.Model)
  • Printer server (Printer.Instance)
  • Printer status (Printer.Status)
  • Serial number (Printer.SerialNumber)
  • Version (Printer.Version)

1.2.10.9.5 User Actions on Barcode Readers

Use this data collector to select the barcode reader and user properties that are captured when a user does an action on a barcode reader.

General

Property Default value
Database table name barcode_reader_actions
Error log directory /aiw/aiw1/userhistorydump/barcode_reader_actions/
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Barcode reader properties to capture
  • Barcode reader location (BarcodeReader.Location)
  • Description (BarcodeReader.Description)
  • Name (BarcodeReader.ID)
User properties to capture
  • Allowed locations (User.Location)
  • Group membership (User.Groups)
  • User description (User.Description)
  • User name (User.ID)

1.2.10.9.6 User Actions on Input Devices

Use this data collector to select the input device and user properties that are captured when a user does an action on an input device.

General

Property Default value
Database table name input_device_actions
Error log directory /aiw/aiw1/userhistorydump/input_device_actions/
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Input device properties to capture
  • Device type (InputDevice.Type)
  • Input device description (InputDevice.Description)
  • Input device location (InputDevice.Locations)
  • Input device name (InputDevice.ID)
User properties to capture
  • Allowed locations (User.Location)
  • Group membership (User.Groups)
  • User description (User.Description)
  • User name (User.ID)

1.2.10.9.7 User Actions on Inserters

Use this data collector to select the inserter and user properties that are captured when a user does an action on an inserter.

General

Property Default value
Database table name inserter_actions
Error log directory /aiw/aiw1/userhistorydump/inserter_actions/
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Inserter properties to capture
  • Inserter controller description (InserterSystem.Description)
  • Inserter controller name (InserterController.ID)
  • Location (InserterSystem.Location)
User properties to capture
  • Allowed locations (User.Location)
  • Group membership (User.Groups)
  • User name (User.ID)
  • User description (User.Description)

1.2.10.9.8 User Actions on Jobs

Use this data collector to select the job and user properties that are captured when a user does an action on a job.

General

Property Default value
Database table name job_actions
Error log directory /aiw/aiw1/userhistorydump/job_actions/
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Job properties to capture
  • Custom 1 (Job.Info.Attr1)
  • Custom 2 (Job.Info.Attr2)
  • Custom 3 (Job.Info.Attr3)
  • Custom 4 (Job.Info.Attr4)
  • Custom 5 (Job.Info.Attr5)
  • Job Name (Job.Name)
  • Job Number (Job.ID)
  • Workflow (Job.JobType)
User properties to capture
  • Allowed locations (User.Location)
  • Group membership (User.Groups)
  • User description (User.Description)
  • User name (User.ID)

1.2.10.9.9 User Actions on Printers

Use this data collector to select the printer and user properties that are captured when a user does an action on a printer.

General

Property Default value
Database table name printer_actions
Error log directory /aiw/aiw1/userhistorydump/printer_actions/
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Printer properties to capture
  • Printer description (Printer.Description)
  • Printer destination (Printer.Destination)
  • Printer location (Printer.Locations)
  • Printer model (Printer.Model.Specific)
  • Printer name (Printer.ID)
  • Serial number (Printer.SerialNumber)
  • Printer paper type (Printer.Model)
  • Printer server (Printer.Instance)
  • Printer TCP/IP address or host name (Printer.TCPIP.Address)
  • Type (Printer.Type)
  • Version (Printer.Version)
User properties to capture
  • Allowed locations (User.Location)
  • Group membership (User.Groups)
  • User description (User.Description)
  • User name (User.ID)

1.2.10.9.10 User Actions on Users

Use this data collector to select the target user and user properties that are captured when a user does an action on a target user.

General

Property Default value
Database table name user_actions
Error log directory /aiw/aiw1/userhistorydump/user_actions/
Remove expired entries Off
Retention period  

Properties to capture

Property Default value
Target user properties to capture
  • Allowed locations (User.Location)
  • Group membership (User.Groups)
  • User description (User.Description)
  • User name (User.ID)
User properties to capture
  • Allowed locations (User.Location)
  • Group membership (User.Groups)
  • User description (User.Description)
  • User name (User.ID)

1.2.10.9.11 Workflow Step Collector

Use this data collector to manage the data stored by the WritePropsToReportDatabase step.

General

Property Default value
Database tables affected  
Remove expired entries Off
Retention period  

1.2.10.10 Supplied Tableau workbook

The Reports feature includes a supplied Tableau workbook.

The full path and name of the file containing the Tableau workbook is:

  • /aiw/aiw1/samples/reports/Sample.twb on Linux
  • C:\aiw\aiw1\samples\reports\Sample.twb on Windows

To use the workbook:

  • Install the Reports feature.
  • Configure Reports. When RICOH ProcessDirector captures data, it stores the data in a PostgreSQL database that you specify.
  • Install the Tableau business intelligence tool. The Tableau business intelligence tool is not included with the Reports feature. For more information and purchase options, go to https://www.tableau.com/.
  • Open the workbook in Tableau and connect it to the PostgreSQL database defined on the Database Settings page.

The workbook contains worksheets for pages printed and jobs per customer.

1.2.10.11 Useful PostgreSQL commands

You can use PostgreSQL commands to check the status and contents of the Reports database. Many commands exist; this topic provides a small subset.
    Note:
  • The command examples below assume that you use the default values for the properties on the Database Settings page. If you change any of those values, such as the port number, you might need to use additional arguments on the PostgreSQL commands.

    Type help at the psql command prompt for more information.

  • Only use these commands with the Reports database. Do not run commands on the main RICOH ProcessDirector database unless a Ricoh support representative instructs you to.
Run the commands below at a command prompt on the server that the Reports database is installed on.
Check whether PostgreSQL is running

Linux:

ps -ef | grep postgres

If PostgresSQL is running, you see multiple lines of output. If it is not running, you see nothing.

Windows:

Open the Windows Task Manager. Look for PostgreSQL processes running on the server.

Access the Reports database on the primary server

Linux:

  • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/psql databasePostgreSQL_user_name

    or

  • /usr/pgsql-14/bin/psql database PostgreSQL_user_name

For example, if you use the default values for Database and User name on the Database settings page, enter:

  • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/psql history rpdreports

    or

  • /usr/pgsql-14/bin/psql history rpdreports

Windows:

  • C:\aiw\aiw1\bin\postgresql\Windows\pgsql\bin\psql databasePostgreSQL_user_name

    or

  • <RPD Install Directory>\PostgreSQL\bin\pg_psql database PostgreSQL_user_name

For example, if you use the default values for Database and User name on the Database settings page, enter:

  • C:\aiw\aiw1\bin\postgresql\Windows\pgsql\bin\psql history rpdreports

    or

  • <RPD Install Directory>\PostgreSQL\bin\pg_psql history rpdreports

Expected output:

psql.bin (9.6.4) Type "help" for help.
After accessing the Reports database

Use these commands to retrieve information about the database, database tables, and contents:

\d
List the database tables that exist on the system.
\dt rpt.*
List the databases on the system that are in the rpt schema. Any databases that you migrate from the DB2 database that older versions of the Reports fieature used to save data are in this schema.
\d+ database_table_name
Show the format of the specified table. For example, \d+ job_history shows that format of the job_history database table.
select * from database_table_name;
List all data from the specified table.
select column_name[,column_name2,column_name3,...] from job_history;
List the data from the specified columns in the requested table.
COPY database_table_name TO 'directory_path_and_filename' DELIMITER ',' CSV HEADER;
Write data stored in the database to a CSV file.

For database_table_name, type the name of the PostgreSQL database table that you defined as the value of the Database table name property in the data collector.

For directory_path_and_filename, type the full directory path and name of the CSV that you want to capture the data to.

This example captures data in the job_history table and exports it in CSV format to the test.csv file in the /aiw/aiw1 directory:

COPY job_history TO '/aiw/aiw1/test.csv' DELIMITER ',' CSV HEADER;

\q
Exit PostgreSQL.

Stop the Reports database

Open a command prompt and type this command:

On a Windows server:
  • \aiw\aiw1\bin\postgresql\Windows\pgsql\bin\pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

    or

  • <RPD Install Directory>\PostgreSQL\bin\pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace
On a Linux server:
  • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

    or

  • /usr/pgsql-14/bin/pg_ctl stop -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

Start the Reports database

On a Windows server:
  • \aiw\aiw1\bin\postgresql\Windows\pgsql\bin\pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace

    or

  • <RPD Install Directory>\PostgreSQL\bin\pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D \aiw\aiw1\data -l \aiw\aiw1\trace\postgres.trace
On a Linux server:
  • /aiw/aiw1/bin/postgresql/Linux/pgsql/bin/pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

    or

  • /usr/pgsql-14/bin/pg_ctl start -o "-p 5432" -U rpdreports -P testpassword -D /aiw/aiw1/data/ -l /aiw/aiw1/trace/postrgres.trace

1.2.10.12 Supplied service policies

You can use these sample service policies in your installation.

1.2.10.12.1 24 hour

Use the 24 hour service policy for jobs that must be printed 24 hours after they arrive in the system.
Property Value Description
Adjust for no-service periods No RICOH ProcessDirector does not adjust planned checkpoint times to skip over no-service periods.
Adjustment method None RICOH ProcessDirector does not adjust the default checkpoint start time, which is the time a job arrives in the system.
Deadline calculation method Elapsed time The method that RICOH ProcessDirector uses to calculate the SLA deadline for jobs that use this service policy.
Interval [Receive]   No checkpoint is defined for the Receive phase.
Interval [Prepare] 8 hours A job is expected to complete the Prepare phase in 8 hours from the checkpoint start time.
Interval [Print] 1 day A job is expected to complete the Print phase in 1 day (24 hours) from the checkpoint start time.
Interval [Complete]   No checkpoint is defined for the Complete phase.
Number of days   If the deadline calculation method is Specific time, specifies the number of days from the Checkpoint start time until the SLA deadline for a job.
Reset on reprocess Yes RICOH ProcessDirector records new actual checkpoint times when you select the Print Again or Process Again action.
Service policy description Print in 24 hours from the time a job arrives. Describes the performance commitment.
SLA duration   If the deadline calculation method is Elapsed time, specifies the amount of time allowed, in minutes, hours, or days, between the Checkpoint start time of a job and the SLA deadline.
SLA target time   If the deadline calculation method is Specific time, specifies the time of day for the SLA deadline.
Start time   No start time is specified.
Time zone (GMT+00:00) GMT The time zone.
Note: You can change the phase names to match the functions that you do in that phase better.

1.2.10.12.2 3-day cutoff

Use the 3-day cutoff service policy for jobs that must be printed 3 days after the start time if they arrive in the system by the start time. If they arrive after the start time, they must be printed in 4 days.
Property Value Description
Adjust for no-service periods No RICOH ProcessDirector does not adjust the planned checkpoint times to skip over no-service periods.
Adjustment method Cutoff The checkpoint start time depends on whether a job arrives before or after the start time specified in the service policy. If a job arrives:
  • Before the start time, the checkpoint start time is the start time on the day a job arrives.
  • After the start time, the checkpoint start time is on the next day.
Deadline calculation method Specific time The method that RICOH ProcessDirector uses to calculate the SLA deadline for jobs that use this service policy.
Interval [Receive]   No checkpoint is defined for the Receive phase.
Interval [Prepare] 1 day A job is expected to complete the Prepare phase in 1 day from the checkpoint start time.
Interval [Print] 3 days A job is expected to complete the Print phase in 3 days from the checkpoint start time.
Interval [Complete]   No checkpoint is defined for the Complete phase.
Number of days   If the deadline calculation method is Specific time, specifies the number of days from the Checkpoint start time until the SLA deadline for a job.
Reset on reprocess No RICOH ProcessDirector does not record new actual checkpoint times when you select the Print Again or Process Again action.
Service policy description Print in 3 days from the start time if a job arrives by the start time. Otherwise, print in 4 days. Describes the performance commitment.
SLA duration   If the deadline calculation method is Elapsed time, specifies the amount of time allowed, in minutes, hours, or days, between the Checkpoint start time of a job and the SLA deadline.
SLA target time   If the deadline calculation method is Specific time, specifies the time of day for the SLA deadline.
Start time 9:00 The start time.
Time zone (GMT+00:00) GMT The time zone.
Note: You can change the phase names to match the functions that you do in that phase better.

1.2.10.13 Supplied no-service periods

You can use these sample no-service periods in your installation.

1.2.10.13.1 January 1

Use the January 1 no-service period if your installation does not provide services on January 1. However, first change the Year property.
Property Value Description
Day 1 The no-service period is on the first day of the month.
End time (HH:MM)   The no-service period ends at the end of the day.
Month January The no-service period is in January.
No-service period description New Year's Day 2006, all day Describes the no-service period.
Start time (HH:MM)   The no-service period starts at the beginning of the day.
Year 2006 The no-service period occurs in 2006.

1.2.10.13.2 Every Saturday

Use the Every Saturday no-service period if your installation does not provide services on Saturdays. However, first change the Year property.
Property Value Description
Day Saturday The no-service period is on every Saturday.
End time (HH:MM)   The no-service period ends at the end of the day.
Month Not set The no-service period occurs in every month.
No-service period description Saturdays in 2006, all day Describes the no-service period.
Start time (HH:MM)   The no-service period starts at the beginning of the day.
Year 2006 The no-service period occurs in 2006.

1.2.10.13.3 Every Sunday

Use the Every Sunday no-service period if your installation does not provide services on Sundays. However, first change the Year property.
Property Value Description
Day Sunday The no-service period is on every Sunday.
End time (HH:MM)   The no-service period ends at the end of the day.
Month Not set The no-service period occurs in every month.
No-service period description Sundays in 2006, all day Describes the no-service period.
Start time (HH:MM)   The no-service period starts at the beginning of the day.
Year 2006 The no-service period occurs in 2006.

1.2.10.14 Supplied Passthrough printer

A new installation of RICOH ProcessDirector provides a sample Passthrough printer that you can use to verify the installation.
When a job is sent to the Sample printer, RICOH ProcessDirector adds a message that the job printed to the job log. The job does not print on a real printer.

After you have verified the installation and configured the system, we recommend that you delete the Sample Passthrough printer.

1.2.10.15 Supplied media objects

RICOH ProcessDirector supplies predefined media objects that you can use to schedule jobs to cut sheet printers.
The default supplied Media objects
Supplied Media objects Units Width Height Type Color Weight Recycled Preprinted Prepunched Coating Print sides Stock Opacity Texture
A4 Plain Millimeters 210 297 Paper - - - - - - - - - -
A4 Color Millimeters 210 297 - White - - - - - - - - -
A4 Prepunched Millimeters 210 297 - - - - - Yes - - - - -
A4 Preprinted Millimeters 210 297 - - - - Yes - - - - - -
Letter Plain Inches 8.5 14 Paper - - - - - - - - - -
Letter Color Inches 8.5 11 - White - - - - - - - - -
Letter Prepunched Inches 8.5 11 - - - - - Yes - - - - -
Letter Preprinted Inches 8.5 11 - - - - Yes - - - - - -

1.2.10.15.1 Supplied media objects for Preprinted Forms Replacement

Use these supplied media objects with electronic forms as templates for creating your own media objects.

1.2.10.15.1.1 DetailsDuplex

This sample media specifies electronic forms for sheets with statement details on both sides. If the CombinePDFWithForm step processes a job that uses this media, the step combines the front form with the data on the front pages. The step combines the back form with the data on the back pages.

The media is designed for use with duplex jobs.

The Preprinted Forms Replacement feature supplies two jobs that use this media. When you enable and connect the ElectronicFormDocFolder input device, it submits the jobs to the ElectronicFormDocSample workflow.

The ElectronicJob.pdf job goes through the CombinePDFWithForm step, which combines the electronic forms with the job data. The step does not change or remove the reference to the DetailsDuplex media name.

The PreprintedJob.pdf job does not go through the step. The job still prints on preprinted paper (including preprinted paper with the media name DetailsDuplex) when it reaches the PrintJobs step.

Property Value
Media description Defines a sample electronic form for sheets with statement details on both sides. Sample jobs for the ElectronicFormDocSample workflow use this media.
Product ID  
Send media name in job ticket No
Last modified  
Media units Inches
Media width 8.5
Media height 11
Media weight (gsm)  
Front of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/Details.pdf (Linux)
  • C:\aiw\aiw1\testfiles\Details.pdf (Windows)
Use page 1
Back of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/Details.pdf (Linux)
  • C:\aiw\aiw1\testfiles\Details.pdf (Windows)
Use page 1
Media name for printing Current name
Media type details Paper
Media color Not set
Media is recycled Not set
Recycled content (%)  
Media is preprinted No
Media is prepunched No
Coating (front side) Not set
Print sides Both
Stock Not set
Opacity Not set
Texture None

1.2.10.15.1.2 DetailsAndOffers

This sample media specifies electronic forms for the last sheet of a statement with details on the front and offers on the back. If the CombinePDFWithForm step processes a job that uses this media, the step combines the front form with the data on the front pages. The step combines the back form with the data on the back pages.

The media is designed for use with duplex jobs.

The Preprinted Forms Replacement feature supplies two jobs that use this media. When you enable and connect the ElectronicFormDocFolder input device, it submits the jobs to the ElectronicFormDocSample workflow.

The ElectronicJob.pdf job goes through the CombinePDFWithForm step, which combines the electronic forms with the job data. The step also replaces references to the DetailsAndOffers media name with references to the Letter Plain media name. The job then can print on Letter Plain media.

The PreprintedJob.pdf job does not go through the step. The job still prints on preprinted paper (including preprinted paper with the media name DetailsAndOffers) when it reaches the PrintJobs step.

Property Value
Media description Defines a sample electronic form for the last sheet of a statement that contains details on the front and offers on the back. Sample jobs for the ElectronicFormDocSample workflow use this media.
Product ID  
Send media name in job ticket No
Last modified  
Media units Inches
Media width 8.5
Media height 11
Media weight (gsm)  
Front of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/Details.pdf (Linux)
  • C:\aiw\aiw1\testfiles\Details.pdf (Windows)
Use page 1
Back of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/Offers.pdf (Linux)
  • C:\aiw\aiw1\testfiles\Offers.pdf (Windows)
Use page 1
Media name for printing Selected: Letter Plain
Media type details Paper
Media color Not set
Media is recycled Not set
Recycled content (%)  
Media is preprinted No
Media is prepunched No
Coating (front side) Not set
Print sides Both
Stock Not set
Opacity Not set
Texture None

1.2.10.15.1.3 ElectronicFrontAndBack

This sample media specifies electronic forms for its front and back sides. If the CombinePDFWithForm step processes a job that uses this media, the step combines the front form with the data on the front pages. The step combines the back form with the data on the back pages.

Because the media specifies an electronic form for its back side, the step converts simplex jobs that use the media to duplex.

The Preprinted Forms Replacement feature supplies two jobs that require this media. When you enable and connect the ElectronicFormJobFolder input device, it submits the jobs to the ElectronicFormJobSample workflow.

The ElectronicJob.pdf job goes through the CombinePDFWithForm step, which combines the electronic forms with the job data. The step also removes the reference to the ElectronicFrontAndBack media name. The job then can print on the media that is specified as the default on the printer.

The PreprintedJob.pdf job does not go through the step. The job still prints on preprinted paper (with the media name ElectronicFrontAndBack) when it reaches the PrintJobs step.

Property Value
Media description Defines sample electronic forms for the front and back sides. Sample jobs for the ElectronicFormJobSample workflow use this media.
Product ID  
Send media name in job ticket No
Last modified  
Media units Inches
Media width 8.5
Media height 11
Media weight (gsm)  
Front of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/ConstantFrontJob.pdf (Linux)
  • C:\aiw\aiw1\testfiles\ConstantFrontJob.pdf (Windows)
Use page 1
Back of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/ConstantBackJob.pdf (Linux)
  • C:\aiw\aiw1\testfiles\ConstantBackJob.pdf (Windows)
Use page 1
Media name for printing None
Media type details Paper
Media color Not set
Media is recycled Not set
Recycled content (%)  
Media is preprinted No
Media is prepunched No
Coating (front side) Not set
Print sides Both
Stock Not set
Opacity Not set
Texture None

1.2.10.15.1.4 SummaryAndDetails

This sample media specifies electronic forms for the first sheet of a statement with a summary on the front and details on the back. If the CombinePDFWithForm step processes a job that uses this media, the step combines the front form with the data on the front pages. The step combines the back form with the data on the back pages.

The media is designed for use with duplex jobs.

The Preprinted Forms Replacement feature supplies two jobs that use this media. When you enable and connect the ElectronicFormDocFolder input device, it submits the jobs to the ElectronicFormDocSample workflow.

The ElectronicJob.pdf job goes through the CombinePDFWithForm step, which combines the electronic forms with the job data. The step does not change or remove the SummaryAndDetails media name.

The PreprintedJob.pdf job does not go through the step. The job still prints on preprinted paper (including preprinted paper with the media name SummaryAndDetails) when it reaches the PrintJobs step.

Property Value
Media description Defines a sample electronic form for the first sheet of a statement with a summary on the front and details on the back. Sample jobs for the ElectronicFormDocSample workflow use this media.
Product ID  
Send media name in job ticket No
Last modified  
Media units Inches
Media width 8.5
Media height 11
Media weight (gsm)  
Front of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/Summary.pdf (Linux)
  • C:\aiw\aiw1\testfiles\Summary.pdf (Windows)
Use page 1
Back of form The full path and name of the one-page PDF file selected as the form:
  • /aiw/aiw1/testfiles/Details.pdf (Linux)
  • C:\aiw\aiw1\testfiles\Details.pdf (Windows)
Use page 1
Media name for printing Current name
Media type details Paper
Media color Not set
Media is recycled Not set
Recycled content (%)  
Media is preprinted No
Media is prepunched No
Coating (front side) Not set
Print sides Both
Stock Not set
Opacity Not set
Texture None

1.2.10.16 Supplied repositories

Archive and other features provide repositories that you can use as examples for creating your own repositories.

1.2.10.16.1 SampleRepository

The Archive feature includes a supplied repository named SampleRepository. Use this repository to test how to store and retrieve documents from the sample PDF file.
Property Value
Description Sample Repository
Retention period 3 months
Folder location /aiw/aiw1/archive/sample
Repository location Not set

1.2.10.16.2 ElecPresRepository

The Electronic Presentment feature includes a supplied repository named ElecPresRepository. Use this repository to demonstrate how Electronic Presentment works.
Property Value
Description Electronic Presentment Repository
Retention period 3 months
Folder location /aiw/aiw1/archive/epsample
Repository location Not set

1.2.10.17 Supplied history record notifications

Archive and other features provide history record notifications that you can use as examples for creating your own notifications.

1.2.10.17.1 SampleHistoryRecord

Captures history information for the jobs that pass through the RepositorySample workflow.
If this notification object is enabled when the sample job provided with the Archive feature is submitted to the RepositorySample workflow, you can view the timestamp for each job state change for every step in the workflow when you retrieve the job or document from the archive. To view the history of a search result on the Archive tab, select the result and select the View details action. The History tab on the property notebook shows the job state changes. The property values and history information can also be exported to a CSV file using the Export to CSV function on the Results table.

General

Property Value
Notification description Captures job information when the Current job state property changes in the RepositorySample workflow.
Notification method History record

Event

Property Value
Property Current job state
Action Changes to
Value Complete
Summary (Job.State CHANGES TO Complete)

Conditions

Property Value
Apply any or all of the following conditions All
Property Workflow
Comparison =
Value RepositorySample
Summary Job.JobType = 'RepositorySample'

1.2.10.17.2 EPSampleHistory

This supplied notification captures history information for the jobs that pass through the ElectronicPresentmentSample workflow.

If this notification object is enabled when you submit the sample jobs provided with the Electronic Presentment feature to the ElectronicPresentmentSample workflow, RICOH ProcessDirector stores production history for those jobs in the ElecPresRepository repository. When you retrieve a job or document from the repository, you can view the time when the job state for the PrintJobs or ToMailroom step changed to Complete.

If you add a feature that supports insertion, this notifcation also records the time when the job state for an insert step (such as InsertJobs or CreateInserterReprints) changed to Complete.

General

Property Value
Notification description Electronic Presentment History
Notification method History record

Event

Property Value
Property Current job state
Action Changes to
Value Complete
Summary (Job.State CHANGES TO Complete)

Conditions

Property Value
Apply any or all of the following conditions Custom: 1 and (2 or 3 or 4)
Property 1 Workflow
Comparison 1 =
Value 1 ElectronicPresentmentSample
Property 2 Current step
Comparison 2 like
Value 2 *Print*
Property 3 Current step
Comparison 3 like
Value 3 *Insert*
Property 4 Current step
Comparison 4 like
Value 4 *Mail*
Summary Job.JobType = 'ElectronicPresentmentSample' AND ( Job.Step like '*Print*' OR Job.Step like '*Insert*' OR Job.Step like '*Mail*' )

1.2.10.18 Supplied web service notifications

Web Services Enablement and other features provide web service notifications that you can use as examples for creating your own REST and SOAP web service notifications.

1.2.10.18.1 MarcomCloseoutOrder

This supplied SOAP web service notification simulates a call to a MarcomCentral web service. The notification calls the web service when the state of an order job in the MarcomProcessOrders workflow changes to Retained.

In the sample workflows, the order stays in the Waiting state until the child jobs for all the items in the order reach the WaitForRelatedJobs step. RICOH ProcessDirector then sends the order job and each child job to the RetainedCompletedJobs step, and the notification calls the web service.

If the notification called the web service instead of running the simulation, this change would occur at the sample store on the MarcomCentral web site. On the Display by Item dialog in the Order Manager, the value in the Order Status column for each item in the sample order would change from Work in Progress to Shipped.

The value in the Static credential field tells RICOH ProcessDirector to run the simulation instead of calling the web service.

General

Property Value
Notification description Closeout order received.
Notification method SOAP Web Service Notification

Request

Property Value
Request URL https://services.printable.com/Trans/1.0/Closeout.asmx
SOAP request MarcomCloseoutByOrder
Request payload
<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:clos="http://www.printable.com/WebService/Closeout" 
xmlns:pti="http://www.printable.com/pti">
 <x:Header/>
 <x:Body>
  <clos:CloseoutByOrder>
   <clos:pOrderRequest>
    <PartnerCredentials>
     <Token>${WSNotification.WebService.Credential}</Token>
    </PartnerCredentials>

    <CloseoutRequest>
     <OrderID>
      <ID type="Printable">${Job.Marcom.OrderId}</ID>
     </OrderID>
    </CloseoutRequest>
   </clos:pOrderRequest>
  </clos:CloseoutByOrder>
 </x:Body>
 </x:Envelope>
Proxy server Proxy server 1

Authentication

Property Value
Static credential Masked value
Authentication response attribute  
Authentication request URL  
Authentication request password  
Authentication SOAP request Not set
Authentication request payload  

Event

Property Value
Event type Job
Property Current job state
Action Changes to
Value Retained
Summary (Job.State CHANGES TO 'Retained')

Conditions

Property Value
Apply any or all of the following conditions All
Property 1 Workflow
Comparison 1 =
Value 1 MarcomProcessOrders
Summary Job.JobType = 'MarcomProcessOrders'

1.2.10.18.2 RestfulWebServiceSampleNotify

This supplied REST web service notification makes a POST call to a sample web service and passes 2 parameters: jobTicket and jobId. The notification makes the call when the state of a child job in the RestfulWebServiceWF changes to Retained.

The sample web service waits until all the child jobs for the original job are in the Retained job state. The web service then creates a PDF file with the job number and item number of each job ticket in the order. The web service puts the file in a hot folder that a RunHotFolderApplication step processes.

General

Property Value
Notification description Calls a sample REST web service when the state of a job changes to Retained, and passes the web service 2 parameters: jobTicket and jobId.
Notification method REST Web Service Notification

Request

Property Value
Request URL http://localhost:15080/restapi/1.0/sample/completeJobTicket
Request method POST
Request payload  
Request header  
Request parameters jobTicket:${Job.Info.Attr1}jobId:${Job.ID}
Use proxy server No

Authentication

Property Value
Static credential  
Authentication response attribute  
Authentication request URL  
Authentication request method GET
Authentication response content type JSON
Authentication request payload  
Authentication request header  
Authentication request parameters  

Event

Property Value
Event type Job
Property Current job state
Action Changes to
Value retained
Summary (Job.State CHANGES TO 'Retained')

Conditions

Property Value
Apply any or all of the following conditions All
Property 1 Workflow
Comparison 1 =
Value 1 RestfulWebServiceWF
Property 2 Job number
Comparison 2 like
Value 2 *.*
Summary Job.JobType = 'RestfulWebServiceWF' AND Job.ID like '*.*'

1.2.10.19 Supplied inserter controller objects

Sample inserter controller objects for several inserter manufacturers are provided. You copy the sample inserter controller object for the type of inserter in your installation and modify it to meet your needs.

1.2.10.19.1 BoweSample

On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Auto
Default insert status Not set
Reprint method Open loop
Control File: Rules file /aiw/aiw1/config/fbi/BOWE.icf.halFile.dsc
Control File: Header Yes
Control File: Header rules file /aiw/aiw1/config/fbi/BOWE.icf.halFile.header.dsc
Control File: Format Fixed length record (FLR)
Control File: Send command copy_file.sh -d /aiw/aiw1/System/icf/BOWE_in/${Job.Inserter.JobID}.icf
Second Control File: Rules file  
Second Control File: Header No
Second Control File: Header rules file  
Second Control File: Format Extensible Markup Language (XML)
Second Control File: Send command  
Results File: Parsing rules file /aiw/aiw1/config/fbi/BOWE.icf_results.mslFile.dsc
Results File: Format Fixed length record (FLR)
Results File: Receive command copy_file.sh -s /aiw/aiw1/System/icf/BOWE_out/${Job.Inserter.JobID}.icf
Results File: Job-properties rules file /aiw/aiw1/config/fbi/BOWE.icf_results.process.job.dsc
Results File: Document-properties rules file /aiw/aiw1/config/fbi/BOWE.icf_results.process.doc.dsc
Results File: Polling interval (seconds) 30
Results File: Polling command  

1.2.10.19.2 BoweBellHowellSample

On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Auto
Default insert status Not set
Reprint method Open loop
Control File: Rules file /aiw/aiw1/config/fbi/BBH.icf.idFile.dsc
Control File: Header No
Control File: Header rules file  
Control File: Format Fixed length record (FLR)
Control File: Send command copy_file.sh -d /aiw/aiw1/System/icf/BBH_in/${Job.Inserter.JobID}.icf
Second Control File: Rules file  
Second Control File: Header No
Second Control File: Header rules file  
Second Control File: Format Extensible Markup Language (XML)
Second Control File: Send command  
Results File: Parsing rules file /aiw/aiw1/config/fbi/BBH.icf_results.idFile.dsc
Results File: Format Fixed length record (FLR)
Results File: Receive command copy_file.sh -s /aiw/aiw1/System/icf/BBH_out/${Job.Inserter.JobID}.icf
Results File: Job-properties rules file /aiw/aiw1/config/fbi/BBH.icf_results.process.job.dsc
Results File: Document-properties rules file /aiw/aiw1/config/fbi/BBH.icf_results.process.doc.dsc
Results File: Polling interval (seconds) 30
Results File: Polling command  

1.2.10.19.3 GuntherSample

On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Manual
Default insert status Not set
Reprint method Open loop
Control File: Rules file  
Control File: Header No
Control File: Header rules file  
Control File: Format Fixed length record (FLR)
Control File: Send command  
Second Control File: Rules file  
Second Control File: Header No
Second Control File: Header rules file  
Second Control File: Format Fixed length record (FLR)
Second Control File: Send command  
Results File: Parsing rules file /aiw/aiw1/config/fbi/GUN.icf_results.logFile.dsc
Results File: Format Fixed length record (FLR)
Results File: Receive command  
Results File: Job-properties rules file  
Results File: Document-properties rules file /aiw/aiw1/config/fbi/GUN.icf_results.process.doc.dsc
Results File: Polling interval (seconds) 30
Results File: Polling command copy_file.sh -s "/aiw/aiw1/System/icf/GUN_out/*"

1.2.10.19.4 IronsidesSample

On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Auto
Default insert status Not set
Reprint method Open loop
Control File: Rules file

/aiw/aiw1/config/fbi/IRON.icf.kicFile.dsc

/aiw/aiw1/config/fbi/IRON.icf.jdfFile.dsc

Control File: Header No
Control File: Header rules file  
Control File: Format Fixed length record (FLR)
Control file: Send command copy_file.sh -d /aiw/aiw1/System/icf/IRON_in/${Job.Inserter.JobID}.icf
Second Control File: Rules file  
Second Control File: Header No
Second Control File: Header rules file  
Second Control File: Format Extensible Markup Language (XML)
Second Control File: Send command  
Results File: Parsing rules file /aiw/aiw1/config/fbi/IRON.icf_results.dsc
Results File: Format Fixed length record (FLR)
Results File: Receive command copy_file.sh -s /aiw/aiw1/System/icf/IRON_out/${Job.Inserter.JobID}.icf
Results File: Job-properties rules file /aiw/aiw1/config/fbi/IRON.icf_results.process.job.dsc
Results File: Document-properties rules file /aiw/aiw1/config/fbi/IRON.icf_results.process.doc.dsc
Results File: Polling interval (seconds) 30
Results File: Polling command  
Content and output of sample file IRON.icf.jdfFile.dsc

This is the content of the sample rules file located at /aiw/aiw1/samples/icf/IRON.icf.jdfFile.dsc, excluding comments:

[XmlRecordTag=JobTicket]
[expr=recnum()==1]
JobId,character,8,[expr=Job.Inserter.JobID]
JobType,character,10,[expr="KIC"]
AccountId,character,20,[expr=if(defined(Job.Name),Job.Name,"")]
StartSequence,integer,8,[expr=fmt("%08i",1)]
EndSequence,integer,8,[expr=fmt("%08i",Job.Doc.DocumentCount)]

This is the XML output produced by the statements in the sample file:

<JobTicket>
	<JobID>[value of Job.Inserter.ID]</JobID>
	<JobType>KIC</JobType>
	<AccountID>[value of Job.Name or empty string]</AccountID>
	<StartSequence>00000001</StartSequence>
	<EndSequence>[value of Job.Doc.DocumentCount, formatted to eight digits]</EndSequence>
</JobTicket>

1.2.10.19.5 JetVisionSample

On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Auto
Default insert status Not set
Reprint method Open loop
Control File: Rules file /aiw/aiw1/config/fbi/JET.icf.dsc
Control File: Header No
Control File: Header rules file  
Control File: Format Fixed length record (FLR)
Control File: Send command copy_file.sh -d /aiw/aiw1/System/icf/JET_in/${Job.Inserter.JobID}.icf
Second Control File: Rules file  
Second Control File: Header No
Second Control File: Header rules file  
Second Control File: Format Extensible Markup Language (XML)
Second Control File: Send command  
Results File: Parsing rules file /aiw/aiw1/config/fbi/JET.icf_results.flatFile.dsc
Results File: Format Fixed length record (FLR)
Results File: Receive command copy_file.sh -s /aiw/aiw1/System/icf/JET_out/${Job.Inserter.JobID}.icf
Results File: Job-properties rules file /aiw/aiw1/config/fbi/JET.icf_results.process.job.dsc
Results File: Document-properties rules file /aiw/aiw1/config/fbi/JET.icf_results.process.doc.dsc
Results File: Polling interval (seconds) 30
Results File: Polling command  

1.2.10.19.6 KernSample

On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Auto
Default insert status Not set
Reprint method Open loop
Control File: Rules file /aiw/aiw1/config/fbi/KERN.icf.kicFile.dsc
Control File: Header No
Control File: Header rules file  
Control File: Format Fixed length record (FLR)
Control File: Send command copy_file.sh -d /aiw/aiw1/System/icf/KERN_in/${Job.Inserter.JobID}.icf
Second Control File: Rules file  
Second Control File: Header No
Second Control File: Header rules file  
Second Control File: Format Extensible Markup Language (XML)
Second Control File: Send command  
Results File: Parsing rules file /aiw/aiw1/config/fbi/KERN.icf_results.outputFile.dsc
Results File: Format Fixed length record (FLR)
Results File: Receive command copy_file.sh -s /aiw/aiw1/System/icf/KERN_out/${Job.Inserter.JobID}.icf
Results File: Job-properties rules file /aiw/aiw1/config/fbi/KERN.icf_results.process.job.dsc
Results File: Document-properties rules file /aiw/aiw1/config/fbi/KERN.icf_results.process.doc.dsc
Results File: Polling interval (seconds) 30
Results File: Polling command  

1.2.10.19.7 PitneySample

On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Auto
Default insert status Not set
Reprint method Closed loop
Control File: Rules file /aiw/aiw1/config/fbi/PB.icf.inputFile.dsc
Control File: Header Yes
Control File: Header rules file /aiw/aiw1/config/fbi/PB.icf.inputFile.header.dsc
Control File: Format Fixed length record (FLR)
Control File: Send command copy_file.sh -d /aiw/aiw1/System/icf/PB_in/${Job.Inserter.JobID}.icf
Second Control File: Rules file  
Second Control File: Header No
Second Control File: Header rules file  
Second Control File: Format Fixed length record (FLR)
Second Control File: Send command  
Results File: Parsing rules file /aiw/aiw1/config/fbi/PB.icf_results.outputFile.dsc
Results File: Format Fixed length record (FLR)
Results File: Receive command copy_file.pl -s /aiw/aiw1/System/icf/PB_out/${Job.Inserter.JobID}.icf
Results File: Job-properties rules file /aiw/aiw1/config/fbi/PB.icf_results.process.job.dsc
Results File: Document-properties rules file /aiw/aiw1/config/fbi/PB.icf_results.process.doc.dsc
Results File: Polling interval (seconds) 30
Results File: Polling command  

1.2.10.19.8 QuadientSample

The Quadient Inserter is the only supplied inserter controller object included with the Quadient feature. It is also included with the full Inserter feature.
On Windows, use copy_file.pl instead of copy_file.sh.
Property Value
Completion method Auto
Default insert status Not set
Reprint method Open loop
Control File: Rules file /aiw/aiw1/control_files/inserter/quadient.jaf.inputfile.dsc
Control File: Header Yes
Control File: Header rules file /aiw/aiw1/control_files/inserter/quadient.jaf.inputfile.header.dsc
Control File: Format Fixed length record (FLR)
Control File: Send command copy_file.pl -p 644 -d /aiw/aiw1/System/icf/quadient_in/${Job.Inserter.JobID}.JAF
Second Control File: Rules file  
Second Control File: Header Not set
Second Control File: Header rules file  
Second Control File: Format Not set
Second Control File: Send command  
Results Retrieval: Results handler command /aiw/aiw1/bin/getInserterJobId.pl
Results Retrieval: Results directories /aiw/aiw1/System/icf/quadient_out
Results Retrieval: Results file pattern *.j?f
Results Retrieval: Polling interval (seconds) 5
Results Retrieval: Polling command  
Results Retrieval: Receive command  
Results Retrieval: Delete interval (days)  
Results Processing: Parsing rules file /aiw/aiw1/control_files/inserter/quadient.jrf_results.outputfile.dsc
Results Processing: Format Fixed length record (FLR)
Results Processing: Job-properties rules file /aiw/aiw1/control_files/inserter/quadient.jrf_results.process.job.dsc
Results Processing: Document-properties rules file /aiw/aiw1/control_files/inserter/quadient.jrf_results.process.doc.dsc

1.2.10.20 Supplied barcode format

The Automated Verification feature includes a supplied barcode format named SampleFormat that includes two properties, Job number and Sequence in child job. Job number starts in byte 1 and contains 15 bytes. Sequence in child job starts in byte 16 and contains 4 bytes.
Property Start Length Comparison Type
Job number 1 15 Equals
Sequence in child job 16 4 Equals

1.2.10.22 Supplied property mapping object

The Preference Management feature includes a supplied property mapping object named DelimitedSample. This sample object works with the sample preferences file referenced by the PreferencesSample workflow.

The mapping object is referenced by the ApplyPreferences step in the sample workflow to map values from the sample preferences file (preferences.csv) into the document properties file. These values are then used by the workflow to determine the type of output processing for each document in the job. In addition to the mapping function, the mapping object also defines which document properties are to be set in the document properties file and which property is used to identify the individual documents in the job.

The object has these properties and default values:

  • Name: DelimitedSample
  • File type: CSV
Property Mapping Value
Heading Document property Usage
Account number Member Identify document
Email Address Email address Update property
Output Type Output type Update property

1.2.10.23 Print commands used with the LPD protocol

The LPD protocol defines a print command called lpr. You can use the lpr command, or several other commands that use the LPD protocol, to submit jobs to LPD input devices. You can also send jobs using the LPD protocol from other systems, such as z/OS. The parent server of the LPD input device can be the primary server or a Linux secondary server.

Syntax and available options vary from one print command to another and from one version of lpr to another. You might have to adapt examples of print commands for your own system.

You might also have to configure the sending system to compensate for options that your print command does not provide. For example, if the print command does not have an option for specifying a print server, you must create a remote print queue on the sending system with the same name as the LPD input device.

Here are a few common LPD print commands. For more information about these commands, see the operating system or product documentation.

Linux print commands
Command name Where to get it Printer option Server option Job properties option
lpr Native -P None Varies
Note: Some LPR clients let you send job options with the -o command. See the documentation for your LPR client to determine if you can do this.
lprafp Download from the Ricoh Production Print Web site (downloads for InfoPrint Manager for Windows) -p -s -o
Note: If you submit jobs using lprafp and include options on the -o flag, you must use only single-byte characters in the options. If you use double-byte characters in the options, RICOH ProcessDirector cannot read them and the lprafp request is rejected.
AIX print commands
Command name Where to get it Printer option Server option Job properties option
lpr Native -P None None
enq Native -P None -o
lp Native -d None -o
lprafp InfoPrint Manager for AIX; download latest version from the Ricoh Production Print Web site (downloads for InfoPrint Manager for Windows) -p -s -o
Note: If you submit jobs using lprafp and include options on the -o flag, you must use only single-byte characters in the options. If you use double-byte characters in the options, RICOH ProcessDirector cannot read them and the lprafp request is rejected.
qprt Native -P None None
qprt InfoPrint Manager for AIX -P None -o
Windows print commands
Command name Where to get it Printer option Server option Job properties option
lpr Native -P -S None
Note: The Windows lpr command has an -o option, but it indicates the file type, not job properties.
lprafp Download from the Ricoh Production Print Web site (downloads for InfoPrint Manager for Windows) -p -s -o
Note: If you submit jobs using lprafp and include options on the -o flag, you must use only single-byte characters in the options. If you use double-byte characters in the options, RICOH ProcessDirector cannot read them and the lprafp request is rejected.
Examples

This command submits a file called report.pdf from a Windows system to an LPD input device called LPDPDF that is defined on a server called morris and requests two copies:

lpr -S morris -P LPDPDF -# 2 report.pdf

Either of these commands submits a file called report.afp from an AIX system to an LPD input device called LPDAFP that is defined on a server called morris. To use the AIX lpr command, you must first define a remote print queue for LPDAFP on the AIX system that you are sending the job from.

lpr -P LPDAFP -C A report.afp
lprafp -smorris -pLPDAFP -oclass=A report.afp

1.2.10.24 Using RICOH ProcessDirector methods

When RICOH ProcessDirector creates a job, it also creates a spool directory. The spool directory contains a copy of the input file and other files that provide information about the job. Steps and commands can access the various files in the spool directory and use them during processing. They can also update existing spool files and write new files to the directory.

RICOH ProcessDirector provides these methods for reading and writing files in the spool directory for a job:

  • getFileName
  • getAbsoluteFileName
  • getCurrentFile
  • getCurrentAFPFile
  • getControlFileName
  • getChildFileName
  • getChildFileStem

1.2.10.24.1 Spool directory names

The default spool directory that RICOH ProcessDirector creates for a job is /aiw/aiw1/spool/default/JobNumber.

For example:

  • /aiw/aiw1/spool/default/10000006

The default spool directory that it creates for a child job is /aiw/aiw1/spool/default/JobNumber.Number. For example:

  • /aiw/aiw1/spool/default/10000006.4

RICOH ProcessDirector messages and the properties notebook for a job refer to the spool directory as the Root file path.

RICOH ProcessDirector always uses these naming conventions for the names of the default spool directories. Authorized users cannot change the default naming conventions.

You can create additional spool directories. Additional spool directories have names in this format: /aiw/aiw1/spool/SpoolName/JobNumber and /aiw/aiw1/spool/SpoolName/JobNumber.Number. SpoolName is the subdirectory name that the authorized user assigned.

1.2.10.24.2 Spool file names

When RICOH ProcessDirector processes a job, it generates spool files for the job. Formats for RICOH ProcessDirector spool file names are:

Syntax 1, parent or standalone job:

JobNumber.Usagetype.Datatype

Syntax 2, child job:

JobNumber.Usagetype.Datatype.ChildGroupID

where:

Usagetype
Describes the purpose or role of the spool file within the job. Usage-type keywords are case-sensitive. Although RICOH ProcessDirector has usage-type keywords other than the ones listed here, these are the usage-type keywords for spool files that external programs might want to read from or write to:
aiwlist
Contains an entry for each input file in the job and its submit type. Depending on the job, RICOH ProcessDirector might have generated one or more of the input files or they might have accompanied the input file that contained the initial job data. The aiwlist file can be useful in problem determination.

This example shows what the file contents might look like when RICOH ProcessDirector generates one or more of the input files. The information in the first column is the submit type.

Data;/aiw/aiw1/System/hf/PDF/Staged/
sample.PRD.AIW_TS.2006-04-27-08.57.31.476
Other;/aiw/aiw1/System/hf/PDF/Staged/
sample.JCL.AIW_TS.2006-04-27-08.57.31.593
List;/aiw/aiw1/System/hf/PDF/Staged/
sample.lst.AIW_TS.2006-04-27-08.57.31.534
AIWList;/aiw/aiw1/System/hf/PDF/Staged/
AIWList.AIW_TS.2006-04-27-08.57.31.794
control
A special RICOH ProcessDirector-generated control file. It contains processing parameters that were specified in a control file template that accompanied the input file for the job. RICOH ProcessDirector generates the control file from the file specified in the External control file template property for the job. When it creates the control file, it resolves any RICOH ProcessDirector-specific entries from the control file template. For example, the PDF workflow runs a RunExternalProgram step during the Prepare phase. The RunExternalProgram step specifies this External command property:

/aiw/aiw1/bin/copy_files.pl ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv

The RunExternalProgram step specifies this External control file template property:

/aiw/aiw1/control_files/external_programs/job_info.cfg

The job_info.cfg control file template contains this information:

Job.ID,Job.Name,Job.JobType,Job.SubmitTime,Job.RequestedPrinter,
Job.InputFile.Size,Job.JobSize,Job.TotalPages,Job.TotalSheets

${Job.ID},${Job.Name},${Job.JobType},${Job.SubmitTime},
${Job.RequestedPrinter},${Job.InputFile.Size},${Job.JobSize},
${Job.TotalPages},${Job.TotalSheets}

When RICOH ProcessDirector creates a control file from this template, it resolves the values for the ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime}, ${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages}, and ${Job.TotalSheets} symbols to the actual RICOH ProcessDirector job properties. For example:
${Job.ID}=10000001
${Job.Name}=Demo.pdf
${Job.JobType}=PDF
${Job.SubmitTime}=10:02.35
${Job.RequestedPrinter}=Sample
${Job.InputFile.Size}=2608549
${Job.JobSize}=26
${Job.TotalPages}=26
${Job.TotalSheets}=26
    Note:
  • Not all jobs that RICOH ProcessDirector creates have associated control files in their spool directories.
overrides
Contains a copy of the job-specific parameters that accompany the input file for the job. RICOH ProcessDirector can use these parameters with a control file to set job properties for the job.

For example, jobs that RICOH ProcessDirector receives through Download for z/OS or AFP Download Plus when the AFP Support feature is installed include datasetname.JCL files that the Download daemon generates. These files contain information that represents the values that were specified for JCL parameters. This example shows the contents of an overrides file that contains JCL values for parameters:

"-odatat=line -ofileformat=record -occ=yes -occtype=a -ochars=GF10 
-opagedef=P1A 06462 -of=F1A10110 -ocop=001 -odatac=block -ojobn=PAYROLL 
-ous=ADMIN1 -ono=BLD PDEVL -opr=KÿSMITH -opa=forms=STD,class=C,
destination=CHI3,jobid=JOB 02357,OUTGRP=NEXT"

A control file, such as receive_jcl_jobtype.cfg in /aiw/aiw1/samples/rules/ that RICOH ProcessDirector provides, can process the overrides file.

    Note:
  • Not all jobs that RICOH ProcessDirector creates have associated overrides files in their spool directories.
print
A print file that contains the data for the job. The data might match the format of the input file that RICOH ProcessDirector received or it might be in a different format. The format depends on the processing that has occurred for the job. For example, an input file might be converted to PostScript during processing.

In addition to the usage-type keywords that RICOH ProcessDirector uses, authorized users can specify their own usage-type keywords when they use RICOH ProcessDirector methods to manipulate files in the spool directory. However, user-defined keywords should not be variations of the RICOH ProcessDirector keywords if RICOH ProcessDirector will further process a file that an external program writes to the spool directory. For example, do not use a usage type of PRINT or Print; RICOH ProcessDirector only recognizes print.

Datatype
Describes the content or the data stream type of the spool file. Whether the spool directory for a given job contains a spool file of a specific data type depends on the processing that has occurred for the job. Datatype keywords are case-sensitive. The keywords that RICOH ProcessDirector provides are:
afp
Advanced Function Presentation (AFP) format. The spool file contains job print data.
gif
Graphic Interchange Format (GIF). The spool file contains image data.
jdf
Job Definition Format (JDF). The spool file contains job-specific parameters from the job ticket.
jpeg
Joint Photographic Experts Group (JPEG) format. The spool file contains image data.
json
JavaScript Object Notation (JSON) format.
linedata
Line-data format or mixed-mode format. The spool file contains job input data.
mjm
Multipurpose Internet Mail Extensions (MIME) package with data in Portable Document Format (PDF), Job Definition Format (JDF), and Job Messaging Format (JMF). The spool file contains job input data and job-specific parameters from the job ticket.
pcl
Printer control language (PCL) format. The spool file contains job input data.
pdf
Portable Document Format (PDF). The spool file contains job input data.
ps
PostScript format. The spool file contains job input data.
text
The data stream is a plain text file. The spool file can contain non-job data, such as processing parameters or information created by an external program.
tiff
Tagged Image File Format (TIFF). The spool file contains image data.
xml
Extended Markup Language (XML) format. The spool file contains well-structured XML.
zip
Data-compression and archiving format for one or more files. The spool file can contain job input data, image data, or non-job data, depending on the format of the files in the zip file.
unknown
The data stream is of an unknown format. This is the datatype keyword that RICOH ProcessDirector initially sets for the spool file that is a copy of the original input file for the job. For more detailed information, see the description of the Input data stream job property. Files with a datatype keyword of unknown might only be in the spool directory for a very short period of time after RICOH ProcessDirector creates the job.

In addition to the datatype keywords that RICOH ProcessDirector uses, authorized users can specify their own datatype keywords when they use RICOH ProcessDirector methods to let external programs write files to the spool directory. However, user-defined keywords for the data type should not be variations of the RICOH ProcessDirector keywords if RICOH ProcessDirector will further process a file that an external program writes to the spool directory. For example, do not use a datatype of PDF or Pdf; RICOH ProcessDirector only recognizes pdf.

ChildGroupID
A unique numeric value that RICOH ProcessDirector uses to identify and group all files that relate to a child job that an external program creates. The child group ID keyword is in addition to the datatype keyword; parent jobs or single jobs do not include a child group ID keyword.

1.2.10.24.3 getFileName and getAbsoluteFileName syntax

You can use the getFileName and getAbsoluteFileName methods to return the name of a specific file in the spool directory. This is useful because RICOH ProcessDirector assigns a unique job number for each job and includes the job number in file names. The main difference between the two methods is that getAbsoluteFileName fails if the specifically requested file does not exist; getFileName can return the name of an alternate spool file.

To use the RICOH ProcessDirectorgetFileName method or the getAbsoluteFileName method, use symbol notation to refer to them as RICOH ProcessDirector symbol formulas. Use one of these syntaxes:

Syntax 1, single search:

${getFileName(UsageKeyword, DatatypeKeyword, FileaccessKeyword)}

${getAbsoluteFileName(UsageKeyword, DatatypeKeyword, FileaccessKeyword)}

Syntax 2, iterative search:

${getFileName(UsageKeyword, (DatatypeKeyword1, DatatypeKeyword2...), 
FileaccessKeyword)}

${getAbsoluteFileName(UsageKeyword, (DatatypeKeyword1, 
DatatypeKeyword2...), FileaccessKeyword)}

where:

UsageKeyword
A case-sensitive keyword that identifies the usage type of the spool file. The values that authorized users can specify are the same values that the usage-type portion of the spool file name can contain. For example, you can specify these RICOH ProcessDirector-supplied keywords: aiwlist, control, overrides, or print. You can also specify your own user-defined keywords.
DatatypeKeyword or (DatatypeKeyword1, DatatypeKeyword2...)
A case-sensitive keyword that specifies the datatype of the spool file. The values that authorized users can specify are the same values that the datatype portion of the spool file can contain. For example, you can specify RICOH ProcessDirector-supplied keywords, such as jdf, pdf, or gif. You can also specify your own user-defined keywords.

If you want RICOH ProcessDirector to continue to search for another spool file if it does not find a spool file of the initial type, you can specify multiple datatype keywords. Separate them with commas and enclose them in parentheses. For example:

${getFileName(UsageKeyword, (print, pdf), FileaccessKeyword)}

In this example, the getFileName method first looks for a spool file with a datatype of print. If it does not find a matching spool file name, it looks for a spool file with a datatype of pdf. If it still does not find a matching spool file name, it looks for a spool file with a datatype of unknown. If that spool file does not exist, RICOH ProcessDirector issues an error message.

Note: The processing point at which RICOH ProcessDirector attempts to resolve the name of the file determines whether the method locates the file. If the workflow includes the SetJobPropsFromTextFile step, use the getAbsoluteFileName method instead of the getFileName method. The SetJobPropsFromTextFile step tries to resolve the file name that the getFileName method represents immediately after the input device creates the job, and not all spool files are available at that point in processing. RICOH ProcessDirector does not try to resolve the file name that the getAbsoluteFileName method represents immediately after job creation.

You can also specify multiple datatype values with the getAbsoluteFileName method, such as:

${getAbsoluteFileName(UsageKeyword, (pdf, postscript, text), 
FileaccessKeyword)}

The getAbsoluteFileName method looks for spool files in the same manner as the getFileName method, with one exception. If no spool files exist with any of the specified datatypes, the default is that the getAbsoluteFileName method does not look for a spool file with a datatype of unknown.

FileaccessKeyword
The file-access keyword, which is either read or write, specifies whether the external program reads the file from the spool directory or writes the file to the spool directory. RICOH ProcessDirector creates files in subdirectories of the spool directory, depending on whether the external program reads or writes a file:
/checkpoints subdirectory
When the external program makes changes to the file through a write operation, RICOH ProcessDirector moves the original version of the file to this subdirectory. If an authorized user subsequently requests a process-again action, RICOH ProcessDirector can restore the original spool file from the /checkpoints subdirectory. This makes sure that the external program has the same input available for its write operation as the first time that it processed the file.
/tmp subdirectory
When the external program creates a new file, RICOH ProcessDirector stores the new file in this subdirectory until the external step that calls the external program completes. When the step completes, RICOH ProcessDirector moves the new file to the spool directory.
Note: External programs that create child jobs must write them to the /children subdirectory of the spool directory for the job. The file name of the child job that the external program creates must be in this format:
JobNumber.Usagetype.Datatype,ChildGroupID,Job.JobType=JobType
The ChildGroupID must be the same for all files associated with a single child job. If the external program generates more than one child job, it must increment the ChildGroupID for each set of files associated with a new child job.

The external program appends ,Job.JobType= to the file name, which is the database name for the workflow property. JobType value is the name of the workflow that the child job requires; this workflow must exist and it must be enabled.

getFileName and getAbsoluteFileName read examples

All of these examples use the spool directory:

  • /aiw/aiw1/spool/default/10000006 (Linux)

The spool directory contains these spool files:

10000006.banner_attributes.text
10000006.control.text
10000006.overrides.text
10000006.print.pdf
10000006.print.unknown
10000006.resources.pdf
10000006.resources.log
10000006.resources.outlines

For the purpose of these examples, the value of the Input data stream job property was not set through any manner, such as through a job default in the workflow or a detection step. Therefore, a spool file with a datatype of unknown is present in the spool directory:

  • To return the path and name of the control file for the job, which is /aiw/aiw1/spool/default/10000006/10000006.control.text , so that the external program can do a read operation on the file:
    ${getFileName(control, text, read)}
    
    ${getAbsoluteFileName(control, text, read)}
  • To return the path and name of the input file for the job, which is /aiw/aiw1/spool/10000006/10000006.print.unknown , so that the external program can do a read operation on the file:
    ${getFileName(print, unknown, read)}
    
    ${getAbsoluteFileName(print, unknown, read)}

This examples use the spool directory:

  • /aiw/aiw1/spool/default/10000009

The spool directory contains these spool files:

10000009.banner_attributes.text
10000009.control.text
10000009.overrides.text
10000009.print.ps
10000009.resources.pdf
10000009.resources.log
10000009.resources.outlines

In this example, the type of the input data stream was detected and 10000009.print.ps is the copy of the original input file. To search for an input file in one of the supported PostScript formats:

${getFileName(print, (pdf, ps), read)}

${getAbsoluteFileName(print, (pdf, ps), read)}

Both methods first look for a spool file with the name 10000009.print.pdf. Because that spool file is not present, the methods continue to look for a spool file with the name 10000009.print.ps.

getFileName and getAbsoluteFileName write examples

All of these examples use the spool directory:

  • /aiw/aiw1/spool/default/10000006
  • To set up for a write operation by an external program that writes a new statistics record file to the spool directory:
    ${getFileName(statistics, record, write)}
    
    ${getAbsoluteFileName(statistics, record, write)}

    RICOH ProcessDirector provides the external program with the path and file name /aiw/aiw1/spool/default/10000006/10000006.statistics.record .

  • To set up for a write operation by an external program that updates the PDF print file in the spool directory:
    ${getFileName(print, pdf, write)}
    
    ${getAbsoluteFileName(print, pdf, write)}

    RICOH ProcessDirector checkpoints a file with the name 10000006.print.pdf, if it exists, into the checkpoints subdirectory of the spool directory for the job.

    RICOH ProcessDirector also provides the external program with the path and file name /aiw/aiw1/spool/default/10000006/tmp/10000006.print.pdf .

    • If the program fails, the spool directory for the job is unchanged because the external program wrote to a file that RICOH ProcessDirector moved to the /tmp subdirectory. RICOH ProcessDirector only moves the file to the spool directory if the external step that calls the external program completes successfully.
    • If the program succeeds, RICOH ProcessDirector moves the file from the /tmp subdirectory into the spool directory. If a file by that name already exists in the spool directory, RICOH ProcessDirector moves that file to the checkpoint subdirectory, then moves the newly created file from /tmp to the spool directory for the job.

1.2.10.24.4 getCurrentFile syntax

The getCurrentFile method returns the name of a print file in the spool directory for the job. If a file exists that contains a page range selected from the original print file, it returns the name of that file. If not, it returns the name of the original print file. This is useful for allowing the same command to work on the full job as well as a subset of the job, as is often the case with reprints.

Authorized users can use this format for the method:

${getCurrentFile(datatype)}

where:

datatype
The datastream of the print file. AFP can be specified, which makes this method identical to the getCurrentAFPFile method. You can use symbolic notation, such as ${Job.InputDataStream}, for this parameter.

getCurrentFile example

To submit a job to a Passthrough printer using lpr on a UNIX-based system, you could use this command for the value of the Printer command property:

lpr -Pmyprinter ${getCurrentFile(${Job.InputDataStream})}

The first time the job is sent to the printer, the entire job prints. If the job is processed again to print a subset of pages, only the subset is printed.

1.2.10.24.5 getCurrentAFPFile syntax

The getCurrentAFPFile method returns the name of an AFP print file in the spool directory for the job. If a file that contains a page range selected from the original print file exists, it returns the name of that file. If not, it returns the name of the original print file. This is useful for working with reprinted jobs, which can contain a subset of the original job.

The method uses no parameters. Authorized users must always use this format for the method:

${getCurrentAFPFile()}
getCurrentAFPFile example

A workflow contains an external step in the Print phase, before the PrintJobs step, that specifies this property and value:

External command [Print][RunExternalProgram]
Value: itm_driver -C ${getControlFileName()} -F"-itm_in_files ${getCurrentAFPFile()} -itm_out_files ${getFileName(print,pdf,write)}"

The first time that a job of this type is printed, RICOH ProcessDirector copies the print file to the tmp subdirectory as 10000004.print.afp. The external command converts the AFP file to PDF for printing.

When the job is reprinted, the operator selects a range of pages from the original print file. RICOH ProcessDirector copies only the selected pages to the tmp subdirectory as 10000004.print_range.afp. The external command converts 10000004.print_range.afp to PDF format.

1.2.10.24.6 getControlFileName syntax

The getControlFileName method returns the name of the resolved control file for the job.

The method uses no parameters. Always use this format for the method:

${getControlFileName()}
getControlFileName example

This example uses this spool directory:

  • /aiw/aiw1/spool/default/10000003
It describes how RICOH ProcessDirector creates files and generates values when you use the getControlFileName method.

A workflow contains an external step in the Prepare phase that specifies these properties and values:

External control file template [Prepare][RunExternalProgram]
Value:
  • /aiw/aiw1/control_files/external_programs/job_info.cfg
External command [Prepare][RunExternalProgram]
Value:
  • cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv

Just before running the external step, RICOH ProcessDirector copies the external control file template to the /tmp subdirectory of the spool directory and resolves any symbols that the control file template contains. This is the procedure that RICOH ProcessDirector uses to create the resulting control file. For example, it generates this file:

/aiw/aiw1/spool/default/10000003/tmp/job_info.control.text

When RICOH ProcessDirector creates the job that uses the workflow and sets its initial property values, it uses the value that the getControlFileName method returned to resolve the external command. The command is:

cp /aiw/aiw1/spool/default/10000003/tmp/job_info.control.text /aiw/aiw1/samples/10000003.info.csv

1.2.10.24.7 getChildFileName syntax

You can use the getChildFileName method when an external program creates only one child job and its associated files. This method returns a file name for a child job. When the external program starts to write the data for the child job, it writes the data to a file with the name that the getChildFileName method returns.

To use the RICOH ProcessDirectorgetChildFileName method, use symbol notation to reference it as a RICOH ProcessDirector symbol formula. Use this syntax:

${getChildFileName(UsageKeyword, DatatypeKeyword, ChildGroupID)}

where:

UsageKeyword
A case-sensitive keyword that identifies the usage type of the spool file. The use of UsageKeyword with the getChildFileName method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.
DatatypeKeyword
A case-sensitive keyword that identifies the datatype of the spool file. The use of DatatypeKeyword with the getChildFileName method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.
ChildGroupID
A unique numeric value that RICOH ProcessDirector uses to identify the files that belong to the same child job. Typically, when the external program generates a single child job, the value is set to 1.

1.2.10.24.8 getChildFileStem syntax

You can use the getChildFileStem method when the external program creates more than one child job or when you do not know how many child jobs the external program will generate. This method generates a root child job file name that an external program can use to generate as many child job file names as it needs.

To use the RICOH ProcessDirectorgetChildFileStem method, use symbol notation to reference it as a RICOH ProcessDirector symbol formula. Use this syntax:

${getChildFileStem(UsageKeyword, DatatypeKeyword)}

where:

UsageKeyword
A case-sensitive keyword that identifies the usage type of the spool file. The use of UsageKeyword with the getChildFileStem method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.
DatatypeKeyword
A case-sensitive keyword that identifies the datatype of the spool file. The use of DatatypeKeyword with the getChildFileStem method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.

1.2.10.25 RICOH ProcessDirector symbol notation

You can use RICOH ProcessDirector symbol notation in formulas to describe the information source that RICOH ProcessDirector evaluates to set the value of a job property.
Symbol syntax

In RICOH ProcessDirector, this is the basic syntax of a symbol, which you can use in symbol formulas:

${Name}

Name is a database property name in RICOH ProcessDirector or a parameter that is passed with the job. RICOH ProcessDirector evaluates parameters that are passed with a job through a control file such as a rules file that parses JCL parameters and values. Name can also be a method in RICOH ProcessDirector, such as getFileName, getAbsoluteFileName, getControlFileName, or getChildFileName. The Name value is case-sensitive.

Examples
${Get*Method}
This symbol causes RICOH ProcessDirector to call an internal method and return an evaluated value. To see how RICOH ProcessDirector can use this type of symbol, see the RunExternalProgram step in the Prepare phase of the PDF workflow. The RunExternalProgram step specifies this External Command property:
  • Linux: cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv

The ${getControlFileName()} symbol instructs RICOH ProcessDirector to copy the external control file template into the tmp subdirectory of the spool directory and resolve any symbols that the control file contains.

The RunExternalProgram step in the Prepare phase of the PDF workflow specifies this External control file template property:

  • Linux: /aiw/aiw1/control_files/external_programs/job_info.cfg

When RICOH ProcessDirector creates the job that uses the workflow and sets its initial property values, it uses the value that the getControlFileName method returned to resolve the external command to this:

  • Linux: cp /aiw/aiw1/spool/default/10000003/tmp/job_info.control.text /aiw/aiw1/samples/10000003.info.csv

${Job.PropertyName}
This symbol causes RICOH ProcessDirector to query its database for the value of a specific RICOH ProcessDirector job property.

To see how RICOH ProcessDirector can use this type of symbol, review the contents of the job_info.cfg control file template. This control file template is in /aiw/aiw1/control_files/external_programs .

When RICOH ProcessDirector creates a control file from this template, it resolves the values for the ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime}, ${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages}, and ${Job.TotalSheets} symbols to the actual RICOH ProcessDirector job properties. For example:

${Job.ID}=10000001
${Job.Name}=Demo.pdf
${Job.JobType}=PDF
${Job.SubmitTime}=10:02.35
${Job.RequestedPrinter}=Sample
${Job.InputFile.Size}=2608549
${Job.JobSize}=26
${Job.TotalPages}=26
${Job.TotalSheets}=26

    Note:
  • You can also use any of the system properties in a symbol formula that RICOH ProcessDirector evaluates. For example, ${WorkflowSystem.Transform.Server.Address}.
${Math}
This symbol causes RICOH ProcessDirector to add, subtract, multiply, or calculate the modulus of two values which can be job properties or numbers. It can also generate a random number in a specified range.
The syntax of this symbol is:

${Math(value1,operator,value2)}

  • value1 and value2 are job properties in symbolic notation (such as ${Job.CurrentTime}) or numbers. Numbers can contain fractional values, such as 2.45, if the property using the symbol formula supports floating point values.
  • operator is +, -, *, or mod for addition, subtraction, multiplication, and modulus respectively.

For example, to add 5 minutes to the current time and store it in the Job.Info.Attr2 property, use ${Math(${Job.CurrentTime}, +, 5)}.

Only properties that use integer, numeric, or timestamp values can be used in the value fields in this formula. Only properties that support symbol notation values can be set using this formula.
If either value is a timestamp property, the only operators supported are + and -, and the other value must be an integer. The units of the integer value are minutes.
Some properties appear to have timestamp values (such as Job.TimeSubmitted) but are defined as strings, so they cannot be used as values in a Math symbol. The Math symbol can be entered in fields on step templates in the Workflow Builder, including the AssignJobValues step template, and in fields in job property notebooks.
For modulus, value1 must be an integer which is 0 or greater and value2 must be an integer which is 1 or greater.
For random number generation, the syntax of this symbol is:
  • ${Math(rand, value1, value2)}
For example, to generate a random number from 1 through 10, use ${Math(rand, 1, 10)}.
    Note:
  • value1 and value2 are job properties in symbolic notation (such as ${Job.Copies}) or numbers.
  • value1 and value2 must be integers which are zero or greater.
  • The result returned is an integer between value1 and value2, inclusive.
  • The random numbers that are generated are not cryptographically random.
${RulesFileParameter}
This symbol causes RICOH ProcessDirector to query a parameter file that accompanies an input file. It queries for a parameter value that is specific to another program or product.

For example, when the LPDPDF input device receives an input file, it uses the receive_lpd_pdf_jobtype.cfg control file to parse parameters that accompany the input file.

The receive_lpd_pdf_jobtype.cfg control file is located in this directory:

  • Linux: /aiw/aiw1/control_files/rules

A receive_lpd_pdf_jobtype.cfg control file might contain this information:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

The symbols for these parameter values are:

${ORIGHOST}
${ORIGUSER}
${ORIGNAME}

To see how RICOH ProcessDirector can use this type of symbol, review the receive_lpd_pdf_jobtype.cfg file in this directory:

  • Linux: /aiw/aiw1/samples/rules

Usage notes for symbol formulas

These usage restrictions apply to using RICOH ProcessDirector symbol formulas:

Supported objects
RICOH ProcessDirector supports the use of symbol formulas only to set the values of job properties. You cannot use symbol formulas to set property values for any other object type, such as an input device or a printer. The symbol formula that RICOH ProcessDirector evaluates to set the value can be another job property, a primary server property, or a method call, such as: ${Job.InputFile}, ${Printer.Model}, and ${getControlFileName()}. However, a given symbol formula cannot contain both a job property and a system property or a method call at the same time.
    Note:
  • Changing the value of a system property might affect many symbol formulas for job properties. Because RICOH ProcessDirector updates all the symbol formulas at once, the operation can take a long time to complete.
Excluded properties
RICOH ProcessDirector does not support setting the value of the Job.Class property with a symbol formula.
Appearance in the RICOH ProcessDirector user interface
You can specify symbol formulas in workflows and in step templates through the Administration page of the RICOH ProcessDirector interface.

When viewing the property notebooks for these objects, symbol formulas always display in their formula format, such as ${Job.InputFile} as the value for the Job name property. In the properties notebook for a job that uses a workflow with steps that specify symbol formulas, the affected job properties display their evaluated values from the formulas. For example, the value of the Job name property is the actual name of the input file, such as reports.pdf.

Multiple levels of formulas
The evaluation of formulas can extend to a group of related formulas. For example:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Locations}
In this case, when the Job.Locations job property has a value, RICOH ProcessDirector sets the value of the Job.CustomerName property. This, in turn, lets RICOH ProcessDirector set the value of the Job.Description property, and then set the value of the Job.Name property.
Circular formulas
A circular formula is one in which a property receives a value from a symbol formula, and then is used to provide a value for another related property. For example:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Name}

RICOH ProcessDirector does not support this usage and issues an error message.

Maximum depth for multiple levels of formulas
In the multiple levels of formulas example, the formula depth is three. RICOH ProcessDirector supports a depth of up to 99 related formulas. It issues an error message if it encounters a formula depth that is greater than 99.
Use of positional properties in symbol formulas to set values for non-positional job properties
Positional properties are properties than can appear in multiple phases and steps and that might have different values in each place. For example, an administrator could configure a workflow so that the Valid return codes job property on the RunExternalProgram step appears in multiple phases and steps in the workflow and has a different value each time. The phase and step names are the names of sections on the job property notebook with the individual property names and values for each instance shown in its own section. RICOH ProcessDirector does not let you use positional properties in symbol formulas that set values for non-positional properties because there is no mechanism to specify which occurrence of the positional property to use.
Use of positional properties in symbol formulas to set values for other positional job properties
Positional properties can use symbol formulas that specify other positional properties. RICOH ProcessDirector looks for the value of the positional property that it evaluates in the symbol formula in the same phase and step that the requesting positional property specifies.
Precedence of property values set by symbol formulas
When multiple methods that specify a value for the same property exist, RICOH ProcessDirector always uses the value that the symbol formula specifies. When a symbol formula exists for a property value, RICOH ProcessDirector does this:
  • Discards any value specified in a control file.

    For example, assume that the workflow specifies ${Job.InputFile} as the value of the Job name property and a control file, such as /aiw/aiw1/control_files/rules/receive_lpd_pdf_jobtype.cfg, specifies: DEFINE ${Job.Name} AS "${ORIGHOST}".

    RICOH ProcessDirector sets the value of the Job name property to the name of the input file for the job, not to the value that the ORIGHOST parameter for the job specifies.

  • Discards any explicitly specified value in the job properties notebook for a job property that the workflow defaults with a symbol formula. You must delete the symbol formula from the workflow and process the job again to use an explicitly specified value.
Validation of symbol formulas
RICOH ProcessDirector validates the syntax and the content of the symbol formula and issues messages for error conditions. For example, both of these would result in errors: Job.Description=${Job.CustomerName and Job.Description=${Job.XYZ} The first example is a syntax error with no closing brace and the second example is an unknown job property name.

1.2.10.26 Syntax for RICOH ProcessDirector control files

Various parts of RICOH ProcessDirector use the information in control files or control file templates to set and pass values for different properties. You can copy the control files and control file templates that RICOH ProcessDirector provides and modify them to meet the needs of the installation.

1.2.10.26.1 Sample control files for rules

RICOH ProcessDirector provides sample control files for rules that parse JCL parameters, LPD control file parameters, or JDF values to set workflows and to set job property values.

The sample control files (receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, receive_lpd_pdf_jobtype.cfg, and receive_text_jobtype.cfg) for rules are installed in the /aiw/aiw1/samples/rules/ directory.

To create your own control file, you can copy and rename one of the sample files to the /aiw/aiw1/control_files/rules/ directory, then edit it to meet your needs.

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples directory, but they do not overwrite files in the /aiw/aiw1/control_files directory. We recommend copying sample files into the /aiw/aiw1/control_files directory and making all your changes in the copied file.

1.2.10.26.1.1 receive_jcl_jobtype.cfg

The sample receive_jcl_jobtype.cfg file sets the workflow and job properties for jobs received from Download for z/OS and AFP Download Plus.

RICOH ProcessDirector can use this control file to interpret a JCL file that accompanies a PRD dataset that RICOH ProcessDirector receives from a Download input device. For example, the JCL file might contain this information:

"-odatat=af -oburst=no -occ=yes -occtype=m -ocop=1 -odatac=unblock 
-ofileformat=stream -of=F1HPSTP1 -ojobn=HPUNCH05 -ono=BLDPDEV9 
-opr=HPUNCH -ous=WAITE 
-opa=class=B,dest=LOCAL,forms=STD,jobid=JOB00105"

To use a control file, set the value of the Child workflow initialization step property for the input device to SetJobTypeFromRules or SetJobTypeFromFileName, and then set the value of the Child workflow parsing rules property to the path and file name of the control file. The SetJobTypeFromRules step uses the control file to set the workflow for the job, convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both; the SetJobTypeFromFileName step uses the control file for setting job properties. All the information in the control file is case-sensitive.

Note: You cannot use a control file to set job properties that are read-only in the Job Properties notebook.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the JCL file.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the JCL file. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. Always use the "FILE" value for control files that process JCL files. The double quotation marks in the value are required.
ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the JCL file parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.
NORMALIZER_PROGRAM
This keyword specifies the name of a program that modifies the JCL file so all the properties it defines are in the form "keyword=value". RICOH ProcessDirector supplies the normalize_jcl.pl program to modify the various styles of JCL parameters into the "keyword=value" form.

For example, consider this JCL string:

"-odatat=af -oburst=no -opa=class=B,dest=LOCAL,forms=STD,jobid=JOB00105"
When RICOH ProcessDirector uses the normalize_jcl.pl program specified in the control file, it replaces the JCL string with this value:
datat=af,burst=no,class=B,dest=LOCAL,forms=STD,jobid=JOB00105,

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the JCL file. It is commented out in the sample file because the program defined by the NORMALIZER_PROGRAM keyword converts the JCL file.

For example, this statement replaces all occurrences of -opa= (note the initial space) with commas:

#s! -opa=!,!

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow and job properties from the values for parameters that are passed in the JCL file with the job. Some examples of the types of DEFINE statements that the section can contain are:
DEFINE ${Job.JobType} AS "BILLS" WHEN (${DEST} == "LOCAL")
DEFINE ${Job.Class} AS "${CLASS}"
DEFINE ${Job.InputDatastream} AS "AFP" WHEN (${DATAT} == "af")
DEFINE ${Job.Destination} AS "${DEST}"
DEFINE ${Job.RequestedPrinter} AS "${DEST}"
DEFINE ${Job.Customer} AS "XYZ" WHEN (${CLASS} == "Z") FINALLY QUIT

The first DEFINE statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.JobType property to BILLS when the value of the DEST parameter from the JCL file is LOCAL. If the DEST parameter has any other value, RICOH ProcessDirector does not set the workflow from the control file. It sets it using another method, such as by using the workflow that is assigned to the Download input device.

The second DEFINE statement is a non-conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.Class job property to the value of the CLASS parameter that is passed with the job. Therefore, if the original JCL string that RICOH ProcessDirector receives contains -opa=class=B, RICOH ProcessDirector sets the value of the Job.Class property to B.

The third DEFINE statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.InputDataStream job property to AFP when the value of the DATAT parameter from the JCL is af. If the DATAT parameter has any other value, RICOH ProcessDirector does not set the value of the Job.InputDataStream property.

The fourth and fifth DEFINE statements are non-conditional statements that set the values of two different job properties to the value of the same parameter.

The last DEFINE statement is a conditional statement that can cause RICOH ProcessDirector to stop reading any more DEFINE statements in the control file. If the condition that the statement defines is true, RICOH ProcessDirector stops reading the control file. If the condition is false, RICOH ProcessDirector continues to evaluate any other DEFINE statements that follow the FINALLY QUIT statement.

1.2.10.26.1.1.1 Using the -ooutbin parameter in JCL and LPD jobtype files

The receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, and receive_lpd_pdf_jobtype.cfg control files provided with RICOH ProcessDirector map the value of the -ooutbin parameter to the Job.OutputBin property.

To use the -ooutbin parameter in JCL and LPD jobtype files:

  1. Fill in this table with information from your application, printers, and bins. Each row reflects information about one bin.
    Column 1: Values used in -ooutbin parameter (property value) Column 2: Name of the bin in Properties notebook (object name, outputBin name) Column 3: Printer model (printerModel name) Column 4: Printer bin number (binNumber)
    Example: 9 Example: Stacker9 Example: InfoPrint 2085 Example: 9
           
           
           
  2. Copy this text into a blank text file:
    <IPPD_UpdateData version="1.0" xmlns"xsi="http://www.w3.org/2001/
    XMLSchema-instance">
         <object name="Stacker9" type="OutputBin">
              <property name="OutputBin.BinNumber" value="9"/>
         </object>
         <printerModel name="InfoPrint 2085">
              <outputBin name="Stacker9" binNumber="9"/>
         </printerModel>
    </IPPD_UpdateData>
  3. Edit the text file with the values that you entered in the table:
    1. Copy the <object> and <printerModel> tag sets so you have one set for each row in the table.
    2. Use the values from column 1 for the value attribute of the property tag.
    3. Use the values from column 2 for the name attribute of both the object and outputBin tags.
    4. Use the values from column 3 for the name attribute of the printerModel tag.
    5. Use the values from column 4 for the binNumber attribute of the outputBin tag.
  4. Save the file.
  5. Click the Administration tab.
  6. In the left pane, click Utilities Import Objects.
  7. Click and navigate to the XML file that you just created. Click Open.
  8. Click Import.

1.2.10.26.1.2 receive_lpd_jobtype.cfg

The sample receive_lpd_jobtype.cfg file sets the workflow and job properties for AFP jobs received through the LPD protocol.

The AFP Support feature provides the receive_lpd_jobtype.cfg file.

RICOH ProcessDirector can use this control file to interpret an LPD control file that accompanies an AFP print job received through the LPD print protocol. The format of the LPD control file depends on the operating system of the sending host. For example, an LPD control file received from Windows might contain this information:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

To use a control file, set the value of the Child workflow initialization step property for the input device to SetJobTypeFromRules or SetJobTypeFromFileName, and then set the value of the Child workflow parsing rules property to the path and file name of the control file. The SetJobTypeFromRules step uses the control file to set the workflow for the job, convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both; the SetJobTypeFromFileName step uses the control file for setting job properties. All the information in the control file is case-sensitive.

Note: You cannot use a control file to set job properties that are read-only in the Job Properties notebook.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the LPD control file parameters.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the LPD control file. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. The double quotation marks in the value are required.

A value of "RECORD" for the file mode causes RICOH ProcessDirector to read the information in the file on a record-by-record basis. The double quotation marks in the value are required.

ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the LPD control file parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the LPD control file. It is commented out in the sample file. You will probably not need to use it.

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow and job properties from the values in the LPD control file that was passed with the job. Some examples of the types of DEFINE statements that the section can contain are:

Example for Linux:

DEFINE ${Job.JobType} AS "PDF" WHEN (${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Name} AS "${ORIGNAME}"
DEFINE ${Job.Host.UserID} AS "${ORIGUSER}"
DEFINE ${Job.InputDatastream} AS "PDF" WHEN 
(${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Customer} AS "XYZ" WHEN 
(${ORIGUSER} == "xyzadmin") FINALLY QUIT

The DEFINE ${Job.JobType} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.JobType property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the workflow from the control file. It sets it using another method, such as by using the workflow that is assigned to the LPD input device.

The DEFINE ${Job.Name} statement sets the value of the Job.Name property to the name of the original input file.

The DEFINE ${Job.Host.UserID} statement is a non-conditional statement. In this example, RICOH ProcessDirector sets the value of the Job.Host.UserID job property to the value of the ORIGUSER parameter in the LPD control file. Therefore, if the original LPD control file that RICOH ProcessDirector receives contains origuser=annsmith, RICOH ProcessDirector sets the value of the Job.Host.UserID property to annsmith.

The DEFINE ${Job.InputDatastream} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.InputDataStream job property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the value of the Job.InputDataStream property.

The DEFINE ${Job.Customer} statement is a conditional statement that can cause RICOH ProcessDirector to stop reading any more DEFINE statements in the control file. If the condition that the statement defines is true, RICOH ProcessDirector stops reading the control file. If the condition is false, RICOH ProcessDirector continues to evaluate any other DEFINE statements that follow the FINALLY QUIT statement.

1.2.10.26.1.2.1 Using the -ooutbin parameter in JCL and LPD jobtype files

The receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, and receive_lpd_pdf_jobtype.cfg control files provided with RICOH ProcessDirector map the value of the -ooutbin parameter to the Job.OutputBin property.

To use the -ooutbin parameter in JCL and LPD jobtype files:

  1. Fill in this table with information from your application, printers, and bins. Each row reflects information about one bin.
    Column 1: Values used in -ooutbin parameter (property value) Column 2: Name of the bin in Properties notebook (object name, outputBin name) Column 3: Printer model (printerModel name) Column 4: Printer bin number (binNumber)
    Example: 9 Example: Stacker9 Example: InfoPrint 2085 Example: 9
           
           
           
  2. Copy this text into a blank text file:
    <IPPD_UpdateData version="1.0" xmlns"xsi="http://www.w3.org/2001/
    XMLSchema-instance">
         <object name="Stacker9" type="OutputBin">
              <property name="OutputBin.BinNumber" value="9"/>
         </object>
         <printerModel name="InfoPrint 2085">
              <outputBin name="Stacker9" binNumber="9"/>
         </printerModel>
    </IPPD_UpdateData>
  3. Edit the text file with the values that you entered in the table:
    1. Copy the <object> and <printerModel> tag sets so you have one set for each row in the table.
    2. Use the values from column 1 for the value attribute of the property tag.
    3. Use the values from column 2 for the name attribute of both the object and outputBin tags.
    4. Use the values from column 3 for the name attribute of the printerModel tag.
    5. Use the values from column 4 for the binNumber attribute of the outputBin tag.
  4. Save the file.
  5. Click the Administration tab.
  6. In the left pane, click Utilities Import Objects.
  7. Click and navigate to the XML file that you just created. Click Open.
  8. Click Import.

1.2.10.26.1.2.2 Supported pdpr flags, -x options, and mappings

When you submit a job using the pdpr command, the options that you specify are mapped to options that can be passed on the lprafp command and then to RICOH ProcessDirector job properties. Not all pdpr options are supported in RICOH ProcessDirector.
Flags
These flags are supported on the pdpr command in RICOH ProcessDirector.
-d destination name
Sets the destination that you want to submit the job to. In InfoPrint Manager, this is the logical destination; in RICOH ProcessDirector, this is the input device. If no value is specified, the pdpr command uses the PDPRINTER environment variable on the submitting computer to determine the destination.

When you migrate from InfoPrint Manager to RICOH ProcessDirector, you can create an input device for each logical destination that already exists and use rules in the pdpr.cfg file to send files that are intended for a specific logical destination to the corresponding input device instead.

-f FileName
Specifies an additional file to include in a job. Use this flag when you submit multiple files with the pdpr command and you want to specify different options for each file.
    Note:
  • In InfoPrint Manager, submitting additional files using -f generates a single print job. In RICOH ProcessDirector, each file is submitted as a separate job. You cannot use -f to combine files into a single job in RICOH ProcessDirector.
-i [ipm|ippd]
Forces the pdpr script to send the job to either RICOH ProcessDirector or InfoPrint Manager. You can use this flag when you are testing your configuration to make sure that your clients can send jobs to both systems, if needed. If this flag is specified on the pdpr command, the pdpr.cfg file is bypassed and the job is sent to the system specified with the flag.
-t JobName
Sets the name of the job with the Job name property in RICOH ProcessDirector.
-n CopyCount
Sets the number of copies of the job to print with the Job copies requested property in RICOH ProcessDirector.
-x options
Let you pass a variety of processing options to InfoPrint Manager or RICOH ProcessDirector. For example, to indicate which form definition the job uses, you could submit a job using this command:
pdpr -d myprinter -x "form-definition=F12UP" myprintfile.afp
Options that can be passed on the -x flag
The first table below shows the options that you can pass on the -x flag on the pdpr command, along with the lprafp command options and RICOH ProcessDirector job properties that they map to.

Most of the mappings are already included in the sample receive_lpd_jobtype.cfg and receive_lpd_pdf_jobtype.cfg files, so you can use one of those files for the Child workflow parsing rules property of your input devices to map the pdpr command options to RICOH ProcessDirector job properties without editing it. The sample files are installed in /aiw/aiw1/samples/rules/ (Linux) or C:\aiw\aiw1\samples\rules\ (Windows).

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples/ (Linux) or C:\aiw\aiw1\samples\ (Windows) directory, but they do not overwrite files in the /aiw/aiw1/control_files/ (Linux) or C:\aiw\aiw1\control_files\ (Windows) directory. We recommend copying sample files into the /aiw/aiw1/control_files/ (Linux) or C:\aiw\aiw1\control_files\ (Windows) directory and making all your changes in the copied file.

The second table shows options that are not included in the sample receive_lpd_jobtype.cfg or receive_lpd_pdf_jobtype.cfg file, but that can be added if you want to use them. The third table shows options that have no direct mapping RICOH ProcessDirector job properties.

Options that are mapped in the sample receive_lpd_jobtype.cfg file
pdpr option & information lprafp command options RICOH ProcessDirector property & information
address1-text
address2-text
address3-text
address4-text

1-4095 characters for each option

address1
address2
address3
address4

1-90 characters for each option

Job.Info.Address1
Job.Info.Address2
Job.Info.Address3
Job.Info.Address4

1-128 characters (bytes) for each property

auxiliary-sheet-selection

Values:

  • end
  • none
  • sep
  • sep-end
  • start
  • start-end
  • start-sep
  • start-sep-end

header= yes | no
trailer= yes | no
separator= yes | no

Mappings:

  • end
    header=no 
    trailer=yes 
    separator=no
  • none
    header=no 
    trailer=no 
    separator=no
  • sep
    header=no 
    trailer=no
    separator=yes
  • sep-end
    header=no
    trailer=yes
    separator=yes
  • start
    header=yes
    trailer=no
    separator=no
  • start-end
    header=yes
    trailer=yes
    separator=no
  • start-sep
    header=yes
    trailer=no
    separator=yes
  • start-sep-end
    header=yes
    trailer=yes
    separator=yes

Job.Print.HeaderCopies= 0 | 1
Job.Print.SeparatorCopies= 0 | 1
Job.Print.TrailerCopies= 0 | 1

Mappings:

  • end
    Job.Print.HeaderCopies=0
    Job.Print.SeparatorCopies=0
    Job.Print.TrailerCopies=1
  • none
    Job.Print.HeaderCopies=0
    Job.Print.SeparatorCopies=0
    Job.Print.TrailerCopies=0
  • sep
    Job.Print.HeaderCopies=0
    Job.Print.SeparatorCopies=1
    Job.Print.TrailerCopies=0
  • sep-end
    Job.Print.HeaderCopies=0
    Job.Print.SeparatorCopies=1
    Job.Print.TrailerCopies=1
  • start
    Job.Print.HeaderCopies=1
    Job.Print.SeparatorCopies=0
    Job.Print.TrailerCopies=0
  • start-end
    Job.Print.HeaderCopies=1
    Job.Print.SeparatorCopies=0
    Job.Print.TrailerCopies=1
  • start-sep
    Job.Print.HeaderCopies=1
    Job.Print.SeparatorCopies=1
    Job.Print.TrailerCopies=0
  • start-sep-end
    Job.Print.HeaderCopies=1
    Job.Print.SeparatorCopies=1
    Job.Print.TrailerCopies=1

building-text

1-4095 characters

building

1-90 characters

Job.Info.Building

1-128 characters (bytes)

chars chars Job.Line2AFP.CHARS
class
mvs-class
class Job.Class
copy-count copies Job.Copies
data-fidelity-problem-reported

Values:

  • all
  • character
  • print-positioning
  • none

datack

Values:

  • block
  • blkchar
  • blkpos
  • unblock

Job.Print.DataCheck

Values:

  • Block
  • BlkChar
  • BlkPos
  • Unblock

department-text

1-4095 characters

department

1-90 characters

Job.Info.Department

1-128 characters (bytes)

document-format

Values:

  • ascii
  • dbcs-ascii
  • ditroff
  • gif
  • jpeg
  • line-data
  • modca-p
  • pcl
  • pdf
  • postscript
  • ppml
  • sap
  • tiff

datatype

Values:

  • ascii(as)
  • afpds(af)
  • dbcsascii(db)
  • ditroff(d)
  • gif
  • jpeg
  • line(l)
  • modcap(mo)
  • pcl(pc)
  • pdf
  • postscript(ps)
  • ppml
  • sap
  • tiff

Job.InputDatastream

Values:

  • afp
  • gif
  • jdf
  • jpeg
  • lcds
  • linedata
  • metacode
  • pcl
  • pdf
  • ps
  • text
  • tiff
  • unknown

form-definition

1-8 characters

formdef

1-8 characters

Job.Line2AFP.Formdef

1-8 characters (bytes)

image-out-format

Values:

  • ioca-uncompressed
  • im1
  • io1
  • io1-g4
  • io1-mmr
  • as-is

imageout

Values:

  • ioca
  • as-is

Job.Line2AFP.IMAGEOUT

Values:

  • IOCA
  • ASIS

    Note:
  • All other options are discarded.
job-name

1-4095 characters

jobname

1-255 characters

Job.Name

1-128 characters (bytes)

mvs-destination

1-8 characters

destination

1-8 characters

Job.Destination

1-32 characters (bytes)

new-line-options

Values:

  • counted-4-octetaligned
  • record,n
  • lf
  • cr-and-lf

fileformat

Values:

  • record
  • record,n
  • stream,lf
  • stream,crlf

Job.Line2AFP.FILEFORMAT
node-id-text

1-4095 characters

no/nodeid

1-20 characters

Job.Info.NodeID

1-128 characters (bytes)

output-bin outbin Job.OutputBin
overlay

1-8 characters

overlay

1-8 characters

Job.Print.Overlay

1-8 characters (bytes)

page-definition

1-8 characters

pagedef

1-8 characters

Job.Line2AFP.PAGEDEF
programmer-text

1-4095 characters

programmer

1-90 characters

Job.Info.Programmer
room-text

1-4095 characters

room

1-90 characters

Job.Info.Room

1-128 characters (bytes)

shift-out-shift-in

Values:

  • one
  • two
  • aaaaaaaa

prmode

Values:

  • SOSI1
  • SOSI2
  • aaaaaaaa

Job.Line2AFP.PRMODE
table-reference-characters

Values:

  • yes
  • no
  • fixed value

trc

Values:

  • yes
  • no
  • fixed value

Job.Line2AFP.TRC
title-text

1-4095 characters

title

1-90 characters

Job.Info.Title

1-128 characters (bytes)

user-id-text

1-4095 characters

us

1-90 characters

Job.Info.User
x-image-shift

This value is in millimeters.

xoffset

Value:

  • float

Job.Print.Xoffset

This value is in inches. The pdpr script converts the value from millimeters to inches.

y-image-shift

This value is in millimeters.

yoffset

Value:

  • float

Job.Print.Yoffset

This value is in inches. The pdpr script converts the value from millimeters to inches.

Options that are not mapped in the sample receive_lpd_jobtype.cfg file, but can be added
pdpr option & information lprafp command options RICOH ProcessDirector property & information
carriage-control-type

Values:

  • ansi-ascii
  • ansi-ebcdic
  • machine
  • none

cctype

Values:

  • z
  • a
  • m

Job.Line2AFP.CC_TYPE
maximum-messages-printed

0-9999 characters

msgcount

0-9999 characters

Job.Print.MessageCount

0-9999 characters

resource-context
resource-context-user
resource-context-font

1-255 characters

respath Job.Print.ResourcePath

Up to 4096 characters (bytes)

Options in the table below have no direct mapping to RICOH ProcessDirector job properties. However, some of them can be mapped to existing job properties that you do not currently use. For example, you could map the account-textpdpr and lprafp option to the Job.CustomerName job property if you do not use Job.CustomerName to hold other information. Options that contain specific values and are used to set printing options, such as default-character-mapping, cannot be mapped effectively.

Options that have no direct mapping to RICOH ProcessDirector job properties
pdpr option & information lprafp command options
account-text

1-4095 characters

account

1-90 characters

default-input-tray bin
default-character-mapping

Values:

  • ibm-437
  • ibm-860
  • ibm-863
  • ibm-865

codepage

Values:

  • 437
  • 860
  • 863
  • 865

document-file-name

1-4095 characters

docname

1-255 characters

mvs-segment-id

1-10 characters

segmentid

1-10 characters

name-text

1-4095 characters

name

1-90 characters

new-line-option-data-encoding

Values:

  • utf-8
  • utf-16
  • ebcdic
  • ascii

newlineencoding

Values:

  • utf8
  • utf16
  • ebcdic
  • ascii

1.2.10.26.1.3 receive_text_jobtype.cfg

The sample receive_text_jobtype.cfg file sets the Workflow from a text overrides file.

The RICOH ProcessDirector-supplied SetJobTypeFromRules step can use the receive_text_jobtype.cfg control file to set the workflow from the jobID.overrides.text file. The step can also use this control file to convert an optional Job Definition Format (JDF) job ticket file, jobID.overrides.jdf, to a temporary text-based overrides file that it can use with the jobID.overrides.text file to set the workflow.

All the information in the control file is case-sensitive.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the job ticket parameters.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the job ticket. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. The double quotation marks in the value are required.

A value of "RECORD" for the file mode causes RICOH ProcessDirector to read the information in the file on a record-by-record basis. The double quotation marks in the value are required.

ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the job ticket parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the job ticket. It is commented out in the sample file. You will probably not need to use it.

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow from a value in the job ticket that was passed with the job. This is the type of DEFINE statement that RICOH ProcessDirector typically uses to set the workflow:
DEFINE ${Job.JobType} AS "Transform"
DEFINE ${Job.JobType} AS "PDF" WHEN (${Job.InputDatastream} == "pdf")

The first DEFINE statement sets the default workflow. The second DEFINE statement is conditional. In this example, RICOH ProcessDirector sets the value of the Job.JobType property to PDF when the value of the Job.InputDatastream parameter in the text overrides file is pdf. If the Job.InputDatastream parameter has any other value, RICOH ProcessDirector uses the default workflow.

1.2.10.26.1.4 receive_lpd_pdf_jobtype.cfg

The sample receive_lpd_pdf_jobtype.cfg file sets the workflow and job properties for PDF jobs received through the LPD protocol.

RICOH ProcessDirector can use this control file to interpret an LPD control file that accompanies a PDF print job received through the LPD print protocol. The format of the LPD control file depends on the operating system of the sending host. For example, an LPD control file received from Windows might contain this information:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

To use a control file, set the value of the Child workflow initialization step property for the input device to SetJobTypeFromRules or SetJobTypeFromFileName, and then set the value of the Child workflow parsing rules property to the path and file name of the control file. The SetJobTypeFromRules step uses the control file to set the workflow for the job, convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both; the SetJobTypeFromFileName step uses the control file for setting job properties. All the information in the control file is case-sensitive.

    Note:
  • You cannot use a control file to set job properties that are read-only in the Job Properties notebook.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the LPD control file parameters.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the LPD control file. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. The double quotation marks in the value are required.

A value of "RECORD" for the file mode causes RICOH ProcessDirector to read the information in the file on a record-by-record basis. The double quotation marks in the value are required.

ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the LPD control file parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the LPD control file. It is commented out in the sample file. You will probably not need to use it.

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow and job properties from the values in the LPD control file that was passed with the job. Some examples of the types of DEFINE statements that the section can contain are:
DEFINE ${Job.JobType} AS "PDF" WHEN (${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Name} AS "${ORIGNAME}"
DEFINE ${Job.Host.UserID} AS "${ORIGUSER}"
DEFINE ${Job.InputDatastream} AS "PDF" WHEN 
(${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Customer} AS "XYZ" WHEN 
(${ORIGUSER} == "xyzadmin") FINALLY QUIT

The DEFINE ${Job.JobType} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.JobType property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the workflow from the control file. It sets it using another method, such as by using the workflow that is assigned to the LPD input device.

The DEFINE ${Job.Name} statement sets the value of the Job.Name property to the name of the original input file.

The DEFINE ${Job.Host.UserID} statement is a non-conditional statement. In this example, RICOH ProcessDirector sets the value of the Job.Host.UserID job property to the value of the ORIGUSER parameter in the LPD control file. Therefore, if the original LPD control file that RICOH ProcessDirector receives contains origuser=annsmith, RICOH ProcessDirector sets the value of the Job.Host.UserID property to annsmith.

The DEFINE ${Job.InputDatastream} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.InputDataStream job property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the value of the Job.InputDataStream property.

The DEFINE ${Job.Customer} statement is a conditional statement that can cause RICOH ProcessDirector to stop reading any more DEFINE statements in the control file. If the condition that the statement defines is true, RICOH ProcessDirector stops reading the control file. If the condition is false, RICOH ProcessDirector continues to evaluate any other DEFINE statements that follow the FINALLY QUIT statement.

1.2.10.26.2 Regular expression syntax

You use regular expression syntax in RICOH ProcessDirector in several places: control files; step templates such as CompressFiles and SetJobTypeFromFileName; input device properties, and in RICOH ProcessDirector features and extended features. This section contains a summary of regular expression syntax and some examples.

For more information on regular expression syntax, see Open Group Base Specifications Issue 6, Chapter 9 here: http://pubs.opengroup.org/onlinepubs/007904875/basedefs/xbd_chap09.html. If you want to test the match results for your expression before using it in your workflow, you can find many free utilities on the Web. For example, this is a free browser-based expression testing tool: http://gskinner.com/RegExr/.

Syntax summary
  • Period (.) matches a single occurrence of any character (letter or number).
  • Asterisk (*) matches zero or more occurrences of the preceding character, up to the maximum file name length.
  • Backslash (\) is the escape character that means that the next character is interpreted literally.
  • Dollar sign ($) means that a match signifies the end of the expression.
  • Question mark (?) makes the preceding token optional; for example, colou?r would match color or colour.
  • Plus sign (+) matches one or more of the preceding token.

Characters in the value are case-sensitive. For example, .*PDF$,.*AFP$ represent patterns that are different from .*pdf$,.*afp$.

Separate multiple patterns by commas; do not type a space between them.

Note that although you commonly see *. used as a matching term (for example, when searching for files on a Windows system), this sequence of characters is not valid regular expression syntax.

This is an example of a regular expression that uses the first four alphanumeric characters of the file name:

[A-Za-z0-9]{4}

The pattern in square brackets, [A-Za-z0-9], matches any characters in the ranges A–Z, a–z, or 0–9. The number in braces, {4}, indicates the number of characters to use.

1.2.10.26.3 Content Expression Language (CEL)

RICOH ProcessDirector Content Expression Language (CEL) lets you define expressions that specify content and placement of enhancements (barcodes, text, and hidden areas) to documents in AFP files. If you have the Inserter feature, CEL lets you define expressions in inserter rules files that write inserter control files, and analyze and interpret inserter results files.
Operators

This table shows the order of operator precedence from highest to lowest precedence.

Operator name Description
( ) Function parameter delimiter
( ) Grouping
+, - Unary
*, /, % Multiply, divide, modulo
+, - Addition, subtraction
==, !=, >, >=, <, <= Relational
(implicit) Concatenation

Example:f(3+x)*5 is f(3+x) multiplied by 5.

Language
Pattern Template example Real example Result
concatenation 'string1' 'string2' 'a' func 'b' aVARb if func='VAR'
relational expressions func1 [relational_operator] func2 func1 > func2 True if func1=5 and func2=1
or condition or(expr1,expr2,....) or(a>100,a==0,b==1) True if any of the expressions evaluate to true
and condition and(expr1,expr2,...) and(a>3,a<10) True if all of the expressions evaluate to true
not condition not(expr1) not(a==b) True if all of the expressions evaluate to false
decision if(relational_expression,trueexpr,falseexpr) if(a>v,1,0) If the relational expression is true, the value is set to trueexpr. If the relational expression is false, the value is set to falseexpr.
decision if(value,trueexpr,falseexpr) if(func2,'true','false') If func2 has a numeric value not equal to 0 or a string value not equal to the empty string, the string literal is true, otherwise false.
Equivalent statements
Base Equivalent Comments
a a() Variables are functions without ().
'*' a '*'a() Concatenation does not require spaces between inputs, and the function a can be represented either way.
EBNF Language Definition

In this Extended Backus-Naur Form (EBNF), a CEL expression is represented by the expr production. The relational and numeric operations behave as their C-language counterparts. Consecutive expressions are strung together to produce a result.

expr = "(", expr, ")" | catenation | numexpr | relexpr | ("+" | "-"), expr | function call | string | number;catenation = expr, expr;numexpr = expr, ("+" | "-" | "*" | "/" | "%"), expr;relexpr = expr, ("==" | "!=" | "<" | ">" | "<=" | ">="), expr;function call = identifier, [ "(", parameters, ")" ];parameters = expr, { ",", expr };identifier = (alpha | "_"), { (alpha | "_" | digit ) };string = "'", (* sequence of characters, with standard \\ escapes *), "'";number = (digit { digit }) | ({ digit } . {digit});

Note: There are no variables, only function calls; a function call without a parameter specification looks and behaves exactly like a variable.

Built-in context functions
Function name Syntax Description
substr substr(f,start [,length]) start is a position from the end of the string. start is zero based. start can be negative.
trim trim(string [, charsToTrim]) Trim blanks (or the list of characters specified in charsToTrim) from the left and the right of string.
rtrim rtrim(string [, charsToTrim]) Trim blanks (or the list of characters specified in charsToTrim) from the right of string.
ltrim ltrim(string [, charsToTrim]) Trim blanks (or the list of characters specified in charsToTrim) from the left of string.
indexof indexof(string, substr [, start ]) Return the start index location of the substring within the string. If the substr is not found, -1 is returned.
fmt fmt(formatString [,values]... ) Format the values using the formatString.
tr tr(string, fromChars [, toChars]) Translate the characters that match fromChars in the string into the corresponding toChars. If the fromChars character does not have a corresponding character in toChars (position match), the fromChar is removed from the input string. If toChars is omitted, all characters listed in fromChars are removed in the returned value.
bin bin(string [, trueChar ]) Using trueChar as on-bits in the string, the input string is converted into a number. If trueChar is omitted, "1" is the on-bit.
fmtbase fmtbase(value, numChars [, baseString ]) If baseString is omitted, it is assumed to be "0123456789ABCDEF", returning the rightmost numChars after converting value into the base represented by baseString. baseString can be any list of characters, assuming that the leftmost character represents zero and the rightmost represents the highest value of the base system being converted into.
exists exists(value) Evaluates to true if the value evaluates to true. (This function is equivalent to the defined function.)
defined defined(value) Evaluates to true if the value evaluates to true. If the value is a RICOH ProcessDirector property name, this function returns true if the property is defined in the database. If a property is defined in the database, you can refer to it in other CEL functions.
len len(string) Returns the number of characters in the input string.
nil nil Returns a value that you can use in CEL functions to represent a null value.
aggr [aggr=sum] [aggr=max] [aggr=min] Returns the sum, maximum, or minimum value of an expression (expr) evaluated against all documents in the job. If you have the Inserter feature, you can use this function in the rules file for the inserter control file header record.
Record context functions
Function name Syntax Description
field_name field_name or field_name() The value of the field for the current record in the context.
recnum recnum or recnum() The record number of the current record being used in the context.
Record caching context functions
Function name Syntax Description
field_name field_name or field_name(offset) If offset is 0 or missing, the value of the field for the current record in the context. If offset is a positive number, the value of the field for the record offset ahead. If offset is a negative number, the value of the field for the record offset behind. The maximum number of records currently cached behind is 10. The number of records cached ahead can be any value and is dynamically determined during processing.
recnum recnum or recnum() The record number of the current record being used in the context.
Examples
Expression Explanation
if(or(a>100,a==0),1,0) If the value of a is either greater than 100 or equal to 0, this expression evaluates to 1; otherwise it evaluates to 0.
if(and(a>3,a<10),1,0) If the value of a is greater than 3 and less than 10, this expression evaluates to 1; otherwise it evaluates to 0.
if(fld,fld,'') Treats a missing value as an empty string; otherwise, treats the missing value as undefined, which is different from a blank value.
fmtbase(if(output_bin=='2',1,0) + if(output_bin=='3',2,0) + if(meter == '1', 4,0) , 1) Returns a hexadecimal number, where the low-order bit (from the right) indicates whether output_bin is set to 2, the second bit indicates whether output_bin is set to 3, and the third bit indicates whether meter is set to 1.
fmtbase(if(meter=='2',1,0) + if(substr(mch_isrt_bins,0,1)=='Y',2,0) + if(substr(mch_isrt_bins,1,1)=='Y',4,0) , 1 ) Returns a hexadecimal number, where the low-order bit (from the right) indicates whether meter is set to 2, the second bit indicates whether the first character of mch_isrt_bins is set to 'Y', and the third bit indicates whether the second character of mch_isrt_bins is set to 'Y'.
fmtbase(63,2,"0123456789ABCDFGHJKLMNPQRSTVWXYZ") Converts 63 into "1Z". Any string can be used as the base.
tr('abc', 'b') Removes all 'b' characters.
tr('00101', '01', 'NY') Converts '0' to 'N' and '1' to 'Y'. Results in 'NNYNY'.
tr('00101', '0123456789Y', 'YYYYYYYYYYN') == 'YYYYY' Evaluates to true if all the characters in '00101' are digits. '00101' can be replaced by a function value of 5 characters.
len(tr('00101','0')) Evaluates to 2. Removes all '0's from the input string, and returns the length of the remaining characters. Effectively counts the number of '1's in the input string.
[expr=Doc.TotalSheets] [aggr=sum] Returns the sum of all the values in the Doc.TotalSheets property in all documents in the job.
[expr=Doc.TotalSheets] [aggr=max] Returns the maximum value in the Doc.TotalSheets property in all documents in the job.
[expr=Doc.TotalSheets] [aggr=min] Returns the minimum value in the Doc.TotalSheets property in all documents in the job.
[expr=recnum>1] Ignore the first line of the file. (Read only record numbers greater than 1.)

1.2.10.26.3.1 Supplied CEL examples for AFP Enhancer

Eight examples of Content Expression Language (CEL) are supplied with the AFP Enhancer mode of RICOH Visual Workbench. These examples define the content of barcodes and text.

Document account number, current page in document

fmt("%08d", Doc.AccountNbr) fmt("%02d", cur_page_in_mp)

This example creates a 10-digit barcode or 10 digits of text.

  • The first 8 digits specify the value of the Doc.AccountNbr document property.
  • The last 2 digits specify the page in the document on which the barcode or text is placed.

If a value has fewer digits, RICOH Visual Workbench adds leading zeroes.

The pre-defined keyword cur_page_in_mp specifies the current page in the document (mailpiece).

Current sheet in document, total sheets in document

fmt("%02d",cur_sheet_in_mp) fmt("%02d",total_sheets_in_mp)

This example creates a 4-digit barcode or 4 digits of text.

  • The first 2 digits specify the sheet in the document on which the barcode or text is placed.
  • The last 2 digits specify the total number of sheets in the document.

If a value has fewer digits, RICOH Visual Workbench adds leading zeroes.

The pre-defined keywords cur_sheet_in_mp and total_sheets_in_mp specify the current sheet in the document (mailpiece) and the total number of sheets in the document.

Text

'My literal text'

This example creates a line of text that reads: My literal text

Job number, current document in job

fmt("%06d", print_job_id) fmt("%06d", cur_mp_in_pj)

This example creates a 12-digit barcode or 12 digits of text.

  • The first 6 digits specify the job number.
  • The last 6 digits specify the document in the job on which the barcode or text is placed.

You can use this example to create a barcode for the Automated Verification feature.

If a value has fewer digits, RICOH Visual Workbench adds leading zeroes.

The pre-defined keywords print_job_id and cur_mp_in_pj specify the job number and the current document (mailpiece) in the job.

    Note:
  • If you use the Job number (Job.ID) job property and the Sequence in child job (Doc.SequenceInChild) document property, you get the same results:

    fmt("%06d", Job.ID) fmt("%06d", Doc.SequenceInChild)

Job number, Document number, Insert sequence, current sheet in document, total sheets in document, and Document inserts

fmt("%08d",Job.ID) fmt("%08d",Doc.ID) fmt("%03d",Doc.Insert.Sequence%1000) fmt("%02d",cur_sheet_in_mp) fmt("%02d",total_sheets_in_mp) fmt("%01d",Doc.Custom.Inserts)

This example creates a 24-digit barcode or 24 digits of text.

  • The first 8 digits specify the value of the Job number (Job.ID) job property.
  • The next 8 digits specify the value of the Document number (Doc.ID) document property.
  • The next 3 digits specify the value of the Insert sequence (Doc.Insert.Sequence) document property.
  • The next 2 digits specify the sheet in the document on which the barcode or text is placed.
  • The next 2 digits specify the total number of sheets in the document.
  • The final digit specifies the value of the Document inserts (Doc.Custom.Inserts) document property.

You can use this example to create a barcode for the Inserter feature.

If a value has fewer digits, RICOH Visual Workbench adds leading zeroes.

The pre-defined keywords cur_sheet_in_mp and total_sheets_in_mp specify the current sheet in the document (mailpiece) and the total number of sheets in the document.

Job number, Sequence in child job

substr('000000000000000' Job.ID, -15) fmt("%04d", cur_mp_in_pj)

This example creates a 19-character barcode or 19 characters of text.

  • The first 15 characters specify the Job number (Job.ID) job property. The parameter –15 specifies that the job number ends on the 15th character. Job numbers with fewer than 15 characters are padded with zeroes. For example, the 11–character job number 10000001.12 is padded with 3 zeroes: 000100000001.12.
  • The last 4 digits specify the document in the job on which the barcode or text is placed.

You can use this example to create a barcode for the Automated Verification feature.

If a value has fewer digits, RICOH Visual Workbench adds leading zeroes.

The pre-defined keyword cur_mp_in_pj specifies the current document (mailpiece) in the job. The value of the cur_mp_in_pj keyword is the same as the value of the Sequence in child job (Doc.SequenceInChild) document property.

    Note:
  • You get the same results using the Sequence in child job (Doc.SequenceInChild) document property:

    substr('000000000000000' Job.ID, -15) fmt("%04d", Doc.SequenceInChild)

Sequence in child job, Job number

fmt("%04d", cur_mp_in_pj) substr('000000000000000' Job.ID, -15)

This example creates a 19-character barcode or 19 characters of text. The example has the same values as the previous example, but the order of the values is reversed.

Digits, Mailer ID, Zip code, more digits

'04260' Job.Postal.MailerID fmt("%05d",Doc.Address.ZipCode) '00'

This example creates a barcode or text with either 18 or 21 digits.

  • The first 5 digits are 04260.
  • The next 6 or 9 digits specify the value of the Mailer ID (Job.Postal.MailerID) document property.
  • The next 5 digits specify the value of the Zip code (Doc.Address.ZipCode) document property.
  • The final 2 digits are 00.
You can use this example to create an Intelligent Mail barcode. For 04260, substitute your 2-digit Barcode ID and your 3-digit Service type ID.

If a value has fewer digits, RICOH Visual Workbench adds leading zeroes.

1.2.10.26.4 Sample control files for job audit information

RICOH ProcessDirector logs audit information when a step based on the WriteJobLog step template runs or when it deletes a job from the system. RICOH ProcessDirector deletes a job when its retention period expires or when it completes processing and has no retention period. It also deletes a job when it receives a specific request from an authorized user. The audit files for jobs are in the Comma Separated Value (CSV) format, and use RICOH ProcessDirector symbol notation to represent specific job properties.

Control files define the content of audit files.

  • The WriteJobLog step writes a single audit file based on the control file that the External control file template job property specifies to the directory that the External control file template job property specifies.
  • When it deletes a job, RICOH ProcessDirector writes an audit file based on each control file in the /aiw/aiw1/control_files/audit/ directory to the /aiw/aiw1/audit/Job directory.

Note: Always modify your own copies of control files, not the sample files. The sample files might be overwritten by service updates. The names of the copies determine the names of the files whose contents they define. For example, if you copy job_properties.cfg as my_job_properties.cfg, RICOH ProcessDirector creates both jobnumber.yy-mm-dd_hh-mm-ss.job_properties.cfg.csv and jobnumber.yy-mm-dd_hh-mm-ss.my_job_properties.cfg.csv when it deletes the job.

RICOH ProcessDirector installs control file templates for job-audit information in the /aiw/aiw1/samples/audit/ directory. To customize a control file, copy it into the /aiw/aiw1/control_files/audit/ directory and edit it.

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples directory, but they do not overwrite files in the /aiw/aiw1/control_files directory. We recommend copying sample files into the /aiw/aiw1/control_files directory and making all your changes in the copied file.

RICOH ProcessDirector provides these control files for job-audit information:

job_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.job_properties.cfg.csv audit file in the /aiw/aiw1/audit/Job directory. The control file causes RICOH ProcessDirector to record basic information about the job, such as the name and size of the input file and the total numbers of pages and sheets that the job contains.
job_info_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.job_info_properties.cfg.csv audit file. RICOH ProcessDirector records values of certain JCL parameters, such as ADDRESS and BUILDING. For jobs that were submitted through a hot folder, RICOH ProcessDirector records only the job number for the job in the audit file. If the AFP Support feature is installed, the control file causes RICOH ProcessDirector to record information that is specific to jobs that were received through Download for z/OS or AFP Download Plus.
print_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.print_properties.cfg.csv audit file. The control file causes RICOH ProcessDirector to record information that is specific to the printing step for the job. It records the values of print-related properties, such as the duplex mode for the job and the name of the printer that printed the job. If the workflow for the job does not specify a print step, RICOH ProcessDirector records only the job number for the job in the audit file.

The AFP Support feature provides these control files for job-audit information:

line2afp_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.line2afp_properties.cfg.csv audit file. The control file causes RICOH ProcessDirector to record information that is specific to line data jobs that it converts to the AFP format. RICOH ProcessDirector records the values of line2afp command parameters, such as CHARS and IMAGEOUT. If RICOH ProcessDirector does not use the line2afp command to process the job, it records only the job number for the job in the audit file.
transform_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.transform_properties.cfg audit file. The control file causes RICOH ProcessDirector to record information that is specific to processing that is done through the RICOH ProcessDirector user interface by a RICOH ProcessDirector Transform feature or InfoPrint Transform Manager. It records the values of transform-related properties, such as page width and page length specifications. If the workflow for the job does not specify an external step for the transform, RICOH ProcessDirector records only the job number for the job in the audit file.

Note: RICOH ProcessDirector also writes audit information about other types of objects, such as input devices. It writes the information to files in separate subdirectories of /aiw/aiw1/audit, and the audit information consists of messages that pertain to the object. For example, the messages might record changes to property values. RICOH ProcessDirector does not provide control files to control the content of audit files for object types other than jobs.

1.2.10.26.5 Sample control files for banner pages

You can configure RICOH ProcessDirector to print banner pages for jobs. Banner pages can include a header page that prints before the first data page of the job and a trailer page that prints after the last data page of the job. For a multi-copy AFP job, banner pages can include a separator page that prints between copies.

RICOH ProcessDirector provides control files for banner pages in /aiw/aiw1/samples/banner_pages/ and in /aiw/aiw1/control_files/banner_pages/. The banner page control files define what field names and property values print in the information fields on the banner pages. The control files can direct RICOH ProcessDirector to print barcodes on banner pages.

Note: Updates might overwrite files in the /aiw/aiw1/samples/banner_pages/ directory, but they do not overwrite files in the /aiw/aiw1/control_files/banner_pages/ directory. We recommend copying sample files into the /aiw/aiw1/control_files/banner_pages/ directory and making all your changes in the copied file.

RICOH ProcessDirector provides these configuration files for PDF banner pages:

  • header.jrxml
  • trailer.jrxml

RICOH ProcessDirector provides these configuration files for AFP banner pages with the AFP Support feature:

  • header.cfg
  • header.impact.cfg
  • header.narrow.cfg
  • header.wide.cfg
  • separator.cfg
  • separator.impact.cfg
  • separator.narrow.cfg
  • separator.wide.cfg
  • trailer.cfg
  • trailer.impact.cfg
  • trailer.narrow.cfg
  • trailer.wide.cfg

1.2.10.26.5.1 Banner page fields

You can change the banner-page control file for an individual AFP job after it is in the system.

Examples of entries in the banner-page control files are:

Field301 Class;JobTicketField;[Job.Class.NameAndValue];X0CR5M;XZE26F;5.390625;3.34375;0
Field302 Form;JobTicketField;[Job.Form];X0CR5M;XZE26F;5.390625;3.640625;0
Field303 Destination;JobTicketField;[Job.Destination];X0PCLR12;;5.390625;3.9375;0
Field304 Customer;JobTicketField;[Job.CustomerName.Value];X0PCLR12;;5.390625;4.234375;0
Field305 Duplex;JobTicketField;[Job.Duplex.NameAndValue];X0CR5M;XZE26F;5.390625;4.546875;0
Field306 PlannedTime;JobTicketField;[Job.SLA.PlannedTime.Complete.Default.NameAndValue];X0PCLR12;;1.000;5.75;0

This table describes the fields of the lines in a banner-page control file, except for the fields used only for printing barcodes. All fields of the line that follow the file identifier are separated by semicolons (;).

Banner field names and descriptions
Field name Description
FieldX Each line must begin with FieldX, where X is a unique number from 1 through 1000. Use a trailing space to separate FieldX from the next field on the line.
FieldName A user-selected name that identifies the line. It must be unique within the control file. It can be up to 32 characters.
FieldType Field type values are:
JobTicketField
RICOH ProcessDirector prints the value, or the resolved name and value that the next field specifies on the banner page. For this field type, the next field is a modified database property name.
ExitData
RICOH ProcessDirector prints the resolved value that the next field specifies. For this field type, the next field is an exit key for the printer driver component that RICOH ProcessDirector uses.
Literal
RICOH ProcessDirector prints the literal text that the next field specifies on the banner page.
[TicketKey] Ticket key values are:
[DataBasePropertyName.Value]
RICOH ProcessDirector prints only the value of the specified property on the banner page. Delimit the property-name string with brackets ([]). For example, if the value of this field is [Job.Copies.Value], and only a single copy of the job was requested, RICOH ProcessDirector prints 1 on the banner page. The preceding FieldType value must be JobTicketField. The database property name that you specify must be in /aiw/aiw1/control_files/banner_pages/banner_page_property_values.cfg (Linux) or C:\aiw\aiw1\control_files\banner_pages\banner_page_property_values.cfg (Windows)
[DataBasePropertyName.NameAndValue]
RICOH ProcessDirector prints the name of the property that displays in the properties notebook, followed by the value for the property. Delimit the property-name string with brackets ([]). For example, if the value of this field is [Job.Copies.NameAndValue], and only a single copy of the job was requested, RICOH ProcessDirector prints Job copies requested: 1 on the banner page. The preceding FieldType value must be JobTicketField. The database property name that you specify must be in /aiw/aiw1/control_files/banner_pages/banner_page_property_values.cfg (Linux) or C:\aiw\aiw1\control_files\banner_pages\banner_page_property_values.cfg (Windows).
Text String
A user-defined text string that can include spaces. The preceding FieldType value must be Literal. The coded fonts that the line specifies control the length of the text string; the maximum length is the number of characters that can fit in the printable area, lengthwise on the page. The larger the point size of the coded font, the fewer characters the text string can contain.
PSFExitKey
A keyword for the printer driver component that RICOH ProcessDirector uses. The preceding FieldType value must be ExitData. Valid values are:
Copy
The printer driver returns the copy number for the printed pages that follow. Use this only in control files for separator banner pages.
ExtDate
The printer driver returns the date on which it started to send the job to the printer hardware.
Time
The printer driver returns the time at which it started to send the job to the printer hardware.
ExtendedSpoolID
The printer driver returns the spool ID number by which it recognizes the job. This value is the same as the value of the RICOH ProcessDirectorJob.Print.SpoolID job property.
CodedFontForSingleByteChars The name of a single-byte coded font. The value is alphanumeric. It can be up to 8 characters.
CodedFontForDoubleByteChars The name of a double-byte character set (DBCS) coded font. The value is alphanumeric. It can be up to 8 characters. You need to specify this field only if you will actually print DBCS characters on the banner page. You can omit this field, as necessary. However, you still need to include its semicolon delimiter for the position.
InchesFromLeft A numeric value that specifies the distance, in inches, from the left edge of the banner page at which RICOH ProcessDirector starts to print the information that this line defines. The value can include decimal places.
InchesFromTop A numeric value that specifies the distance, in inches, from the top edge of the banner page at which RICOH ProcessDirector starts to print the information. The value can include decimal places.
Rotation A numeric value that specifies the amount of rotation, in the clockwise direction, that RICOH ProcessDirector rotates the printed information. Valid values are 0, 90, 180, and 270.

1.2.10.26.5.2 Banner page fields for barcodes in AFP jobs

The fields in a banner-page control file that are used to print barcodes in AFP jobs are a little different from the fields used to print other information.

This table describes the barcode fields. All fields of the line that follow the file identifier are separated by semicolons (;).

Barcode banner page fields
Field name Description
FieldX Each line must begin with FieldX, where X is a unique number from 1 through 1000. Use a trailing space to separate FieldX from the next field on the line.
FieldName A user-selected name that identifies the line. It must be unique within the control file. It can be up to 32 characters.
FieldType Field type values are:
JobTicketField
RICOH ProcessDirector prints a barcode that represents the numeric value of the property that the next field specifies. The next field is a modified database property name.
ExitData
RICOH ProcessDirector prints a barcode that represents the numeric value of the property that the next field specifies. The next field is an exit key for the printer driver component that RICOH ProcessDirector uses. The exit key must have a numeric value.
Literal
RICOH ProcessDirector prints a barcode that represents the numeric value or alphanumeric value of the next field. The value for the next field is a value that you specify.
Note: Only specific types of barcodes can include alphanumeric values.
[Key] Key values are:
[DataBasePropertyName.Value]
RICOH ProcessDirector prints the barcode only for the specified property on the banner page. Delimit the property-name string with brackets ([]), such as [Job.ID.Value]. The preceding FieldType value must be JobTicketField.
[DataBasePropertyName.NameAndValue]
RICOH ProcessDirector prints the name of the property that displays in the properties notebook followed by the barcode that represents the value of the property. Delimit the property-name string with brackets ([]), such as [Job.ID.NameAndValue]. The preceding FieldType value must be JobTicketField.
NumericOrAlphaNumericString
A user-defined number or a user-defined alphanumeric string. Do not delimit the value. The preceding FieldType value must be Literal.
PSFExitKey
A keyword for the printer driver component that RICOH ProcessDirector uses. The preceding FieldType value must be ExitData. Valid values are:
Copy
The printer driver returns the copy number for the printed pages that follow. Use this only in control files for separator banner pages.
ExtDate
The printer driver returns the date on which it started to send the job to the printer hardware.
Time
The printer driver returns the time at which it started to send the job to the printer hardware.
ExtendedSpoolID
The printer driver returns the spool ID number by which it recognizes the job. This value is the same as the value of the RICOH ProcessDirectorJob.Print.SpoolID job property.
;;; Enter three semicolons to separate the key field and the next field. Barcode entries do not use the single-byte coded font and double-byte coded font fields.
InchesFromLeft A numeric value that specifies the distance, in inches, from the left edge of the banner page at which RICOH ProcessDirector starts to print the barcode. The value can include decimal places.
InchesFromTop A numeric value that specifies the distance, in inches, from the top edge of the banner page at which RICOH ProcessDirector starts to print the barcode. The value can include decimal places.
Rotation A numeric value that specifies the amount of rotation, in the clockwise direction, that RICOH ProcessDirector rotates the barcode. Valid values are 0, 90, 180, and 270.
BarCodeType Valid barcode types are:
3of9
A Code 39 barcode, which is common in industrial applications.
MSI
A Modified Plessey barcode, which is common in retail applications.
UPC-A
A Universal Product Code type A barcode, which is the most common type of barcode.
UPC-E
A Universal Product Code type E barcode, which is a more compact version of a UPC-A barcode.
UPC-2DIGIT
A UPC barcode that includes a smaller two-digit barcode in addition to the initial barcode.
UPC-5DIGIT
A UPC barcode that includes a smaller five-digit barcode in addition to the initial barcode.
EAN-8
A wider version of a UPC-E barcode.
EAN-13
A variation of the UPC-A barcode.
Industrial2of5
An Industrial 2 of 5 barcode, which is common in warehouse applications.
Matrix2of 5
A Matrix 2 of 5 barcode.
Interleaved2of5
An Interleaved 2 of 5 barcode, which is common in warehouse applications.
Codabar
A Codabar barcode, which is common in library applications.
Code128
A Code 128 barcode, which can include alphanumeric data.
EAN-2DIGIT
A UPC/EAN Extension 2 barcode, which is common in publication applications.
EAN-5DIGIT
A UPC/EAN Extension 5 barcode, which is common in publication applications.
POSTNET
A POSTNET barcode, which is common in postal applications.
RM4SCC
A Royal Mail 4-State Customer Codes barcode, which is common in postal applications.
JapanPostal
A Japan Postal barcode, which is common in postal applications.
DataMatrix
A DataMatrix barcode, which is two-dimensional.
Height A numeric value that specifies the height, in inches, of the barcode. The value can include decimal places. The height value does not apply to any human-readable information in the barcode, as specified by the HRI field.
Note: Use the NumberOfRows field, not the Height field, to specify the height of a DataMatrix two-dimensional barcode.
Modifier Specifies the Bar Code Object Content Architecture (BCOCA) modifier value, which varies by bar-code type. See the Bar Code Object Content Architecture Reference for details.
Asterisk Valid values that control asterisks are:
yes
RICOH ProcessDirector prints leading and trailing asterisks before and after the barcode.
no
RICOH ProcessDirector does not print leading and trailing asterisks before and after the barcode.
HRI Valid values for barcodes that contain human-readable information are:
none
RICOH ProcessDirector does not print any human-readable information.
above
RICOH ProcessDirector prints the human-readable information above the barcode.
below
RICOH ProcessDirector prints the human-readable information below the barcode.
See the Bar Code Object Content Architecture Reference for details.
ModuleWidth A numeric value that specifies the width, in inches, of a narrow bar within the barcode. The value can include decimal places. You can omit this field, as necessary. However, you still need to include its semicolon delimiter for the position.
Note: Use the RowSize field, not the ModuleWidth field, to specify the width of a DataMatrix two-dimensional barcode.
WideNarrowRatio A numeric value that specifies the ratio between wide and narrow bars within the barcode. Common values are 2.0 and 3.0. See the Bar Code Object Content Architecture Reference for details. You can omit this field, as necessary. However, you still need to include its semicolon delimiter for the position.
RowSize A numeric value that specifies the number of modules in each row of a DataMatrix two-dimensional barcode. You can omit this field, as necessary. However, you still need to include its semicolon delimiter for the position.
Note: Use the RowSize field, not the ModuleWidth field, to specify the width of a DataMatrix two-dimensional barcode.
NumberOfRows A numeric value that specifies the number of rows in a DataMatrix two-dimensional barcode. You can omit this field, as necessary. However, you still need to include its semicolon delimiter for the position.
Note: Use the NumberOfRows field, not the Height field, to specify the height of a DataMatrix two-dimensional barcode.

1.2.10.26.5.3 Sample .jrxml file for PDF banner pages

Sample header.jrxml and trailer.jrxml files are provided in /aiw/aiw1/control_files/banner_pages/.

If you use the provided header.jrxml file or trailer.jrxml file, the banner page that is printed contains these job properties and their values:

  • System identifier

    The system identifier is included if you set a value for the System identifier system property.

  • Job ID

    The job ID is included in both human-readable and barcode formats.

  • Job name
  • Job copies requested
  • Page range
  • Current total sheets
  • Current total pages
  • Job priority
  • Job class
  • Job form
  • Job destination
  • Customer name
  • Duplex
  • Workflow
  • Job description
  • Time submitted
  • Assigned to printer
  • Assigned printer

If you need to include different information in your header or trailer pages, you can create customized JRXML files using Jaspersoft Studio.

    Note:
  • If you use specific fonts in your JRXML files, make sure that the fonts are available on your server.

    If a specific font is not available, find a compatible font and update the JRXML to use it instead. For example, if you installed DejaVu fonts and need a font that is compatible with Lucida Sans, open a command prompt and type:

    fc-match "Lucida Sans"

    Update the JRXML with the compatible font.

1.2.10.26.6 Sample control file templates for external programs

RICOH ProcessDirector provides sample control file templates for use with external programs in the /aiw/aiw1/samples/external_programs/ directory.

The external program control file that RICOH ProcessDirector generates from the control file template passes information between RICOH ProcessDirector and the external program. Authorized users can copy and modify the sample control file templates that RICOH ProcessDirector provides. They then put the customized control file template in any directory that is accessible to RICOH ProcessDirector. Use the External control file template job property to specify the name and location of the control file template.

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples directory, but they do not overwrite files in the /aiw/aiw1/control_files directory. We recommend copying sample files into the /aiw/aiw1/control_files directory and making all your changes in the copied file.

RICOH ProcessDirector supplies one control file template for external programs:

job_info.cfg
This control file is used by the sample PDF workflow. The control file has a list of symbols for nine job properties. When RICOH ProcessDirector creates a control file from this template, it resolves the values for the ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime},${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages}, and ${Job.TotalSheets} symbols to the actual RICOH ProcessDirector job properties.

The AFP Support feature supplies these additional control file templates for external programs:

prepare_line2afp.cfg
This control file template uses RICOH ProcessDirector symbol formulas to set parameter values for the line2afp command. RICOH ProcessDirector uses this command to convert line-data jobs into the AFP format. These are examples of the entries in the control file template:
DUPLEX=${Job.Duplex}
FILEFORMAT=${Job.Line2AFP.FILEFORMAT}
FORMDEF=${Job.Line2AFP.FORMDEF}
MCF2REF=${Job.Line2AFP.MCF2REF}
PAGEDEF=${Job.Line2AFP.PAGEDEF}

The keywords to the left of the equal sign are IBM AFP Conversion and Indexing Facility (ACIF) parameters. The values to the right are symbol formulas for RICOH ProcessDirector job properties. Using FILEFORMAT=${Job.Line2AFP.FILEFORMAT} as an example, RICOH ProcessDirector sets the value of the FILEFORMAT parameter that the line2afp command uses to the value of the Line data file format job property.

The control file template also uses the RICOH ProcessDirectorgetFileName method to return the names of files that the data-conversion program needs to read and write in the spool directory for the job. The spool directory for a job is /aiw/aiw1/spool/default/JobNumber, where JobNumber is the actual spool ID that RICOH ProcessDirector assigns to the job. Authorized users can also create additional spool directories. Additional spool directories have names that are in this format: /aiw/aiw1/spool/SpoolName/ JobNumber. These entries in the control file template use methods:

INPUTDD=${getFileName(print, (linedata, afp), read)}
Provides the name of the data file for the job to the data-conversion program. The method returns the name of the line data spool file (JobNumber.print.linedata), if it is present. If it is not present, the method returns the name of the AFP spool file (JobNumber.print.afp), if it is present. If neither is present, the method returns JobNumber.print.unknown. The data-conversion program reads this file and uses it as its initial input.
OUTPUTDD=${getFileName(print, afp, write)}
Provides the name of the converted file that the data-conversion program should write to the spool directory. The format of this file name is JobNumber.print.afp; this file contains the output from the data-conversion program.
RESOBJDD=${getFileName(resources, afp, write)}
Provides the name of the resource file that the data-conversion program should write to the spool directory. The format of this file name is JobNumber.resources.afp. This file contains optional output from the data-conversion program.
prepare_line2afp_ascii.cfg
This control file template does the same functions as the prepare_line2afp.cfg control file template with one exception. This control file template calls an input exit, apka2e, that converts the job from the ASCII format into the EBCDIC format. For detailed information about the INPEXIT parameter, see AFP Conversion and Indexing Facility User's Guide, G550-1342.
prepare_transform.cfg and prepare_transform_APPE.cfg
These control file templates pass information between RICOH ProcessDirector and a RICOH ProcessDirector Transform feature or InfoPrint Transform Manager. They use symbol formulas to set values of transform flags and method calls to read and write files in the spool directory. These are examples of the entries in the prepare_transform.cfg and prepare_transform_APPE.cfg control files:
# Input file to transform
-itm_in_files = ${getITMInputFileName()}
# Output file to create
-itm_out_files = ${getFileName(print, ${Job.Transform.Datastream}, write)}
# Page size
-w = ${truncate(3, ${Job.PageWidth})}i
-l = ${truncate(3, ${Job.PageLength})}i
# Halftone
-gcorr = ${get.HalftoneFileNameTf()}
-thresh = ${get.HalftoneFileNameTa()}

For detailed information about transform flags, see the RICOH ProcessDirector Transform feature information center or InfoPrint Transform Manager for Linux and Windows: Planning and Installing, G550-20160.

1.2.10.26.7 Sample control file templates for Passthrough printers

RICOH ProcessDirector provides a sample control file template for use with Passthrough printers. This template is called passthru.cfg and is installed in: /aiw/aiw1/samples/passthru/.

If the printer command that you specify for a Passthrough printer uses a control file, the control file that RICOH ProcessDirector generates from the control file template specifies options for the printer command. Authorized users can copy and modify the sample control file template that RICOH ProcessDirector provides. They then put the customized control file template in any directory that is accessible to RICOH ProcessDirector. Use the Control file template printer property to specify the name and location of the control file template.

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples directory, but they do not overwrite files in the /aiw/aiw1/control_files directory. We recommend copying sample files into the /aiw/aiw1/control_files directory and making all your changes in the copied file.

The passthru.cfg control file template uses RICOH ProcessDirector symbol formulas to set printer command parameter values. These are examples of the entries in the control file template:

JobID=${Job.ID}

JobCopies=${Job.Copies}

PrinterId=${Printer.ID}

CustomerName=${Printer.CustomerName}
The keywords to the left of the equal sign are sample parameters.

Note: Not all printer commands can use control files. If yours can, it might use different parameter names.

The values to the right are symbol formulas for RICOH ProcessDirector job properties. Using JobCopies=${Job.Copies} as an example, RICOH ProcessDirector sets the value of the JobCopies parameter to the value of the Job.Copies job property. For example, if you wanted the original input filename preserved when the job was sent to the printer, you could substitute ${Job.Inputfile} for ${Job.ID} in the control file template entry for the JobID parameter.

1.2.10.26.8 Sample control file for job audit information with Deadline Tracker

The Deadline Tracker feature provides a control file that writes job information specific to the checkpoint tracking function into audit files in the /aiw/aiw1/audit/Job (UNIX-based operating systems) or C:\aiw\aiw1\audit\Job (Windows) directory. The audit files for jobs are in the Comma Separated Value (CSV) format.
policy_properties.cfg

This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.policy_properties.cfg.csv audit file in the /aiw/aiw1/audit/Job (UNIX-based operating systems) or C:\aiw\aiw1\audit\Job (Windows) directory. The control file causes RICOH ProcessDirector to record information such as the name of the service policy used to calculate the job checkpoints and the final checkpoint status of the job.

RICOH ProcessDirector automatically records information about the planned and actual checkpoints of the job in the jobnumber.yy-mm-dd_hh-mm-ss.positional_attributes.csv audit file. No control file is required for the jobnumber.yy-mm-dd_hh-mm-ss.positional_attributes.csv audit file.

1.2.10.26.9 Syntax for inserter rules files

The system uses information in inserter rules files to write inserter control files and to parse and interpret inserter results files. You can copy the sample rules files that are provided and modify them to meet the needs of the installation.

1.2.10.26.9.1 Rules files for inserter control files

The rules file defines the fields in each record (except for the header record) of the inserter control file and specifies the value to put in each field of the record. This file is required. RICOH ProcessDirector uses the rules file to write the inserter control file records. RICOH ProcessDirector writes one record for each document in the document properties file. The records follow the header record (if any). Typically, this process creates one record for each document in a job.
Purpose

RICOH ProcessDirector uses the rules file to write the inserter control file records. It writes one record for each document in the job.

RICOH ProcessDirector provides these sample rules files in the inserter directory:

  • /aiw/aiw1/samples/control_files/inserter (Linux)

  • C:\aiw\aiw1\samples\control_files\inserter (Windows)

Inserter manufacturer Rules file
Bowe BOWE.icf.halFile.dsc
Bowe with JetVision camera systems JET.icf.dsc
Bowe Bell & Howell BBH.icf.idFile.dsc
Gunther None (no control file used)
Inserters with Ironsides camera systems
IRON.icf.kicFile.dsc
IRON.icf.jdfFile.dsc
Kern KERN.icf.kicFile.dsc
Pitney Bowes PB.icf.inputFile.dsc
Quadient quadient.jaf.inputfile.dsc

In each field, RICOH ProcessDirector can put a fixed value (such as blanks or zeroes) or the value of any of these RICOH ProcessDirector properties:

  • Job properties: Inserter job name (Job.Inserter.JobID), Job name (Job.Name), and Load plan comment (Job.Insert.LoadPlan.Comment)
  • Any document property (document properties start with Doc)
    Note:
  • If you need to put the value of another job property in the inserter control file, add a line for the job property in file /aiw/aiw1/config/fbi/icf_job_del_properties.cfg.

RICOH ProcessDirector properties for rules files lists some of the properties that you might want to put in the inserter control file. You specify properties by their database property names.

RICOH ProcessDirector properties for rules files
Property (field name) Property (database name) Description Type Length (characters)
Inserter job name Job.Inserter.JobID The job name that the inserter uses for the job. The default value is the Job number (Job.ID) property. character 255
Job name Job.Name The job name. character 128
Load plan comment Job.Insert.LoadPlan.Comment The names of the materials (or inserts) that the operator should load into each inserter bin. character 128
Document number Doc.ID A unique number that identifies the document in the system. RICOH ProcessDirector assigns this number. bigint 16
Insert sequence Doc.Insert.Sequence A number that indicates the position of the document in the job. RICOH ProcessDirector assigns this number. integer 8
Original sheets Doc.OriginalSheets The number of sheets in the document. RICOH ProcessDirector assigns this number. integer 4
Bin Triggers Doc.Insert.BinTriggers The inserter bins that should deliver inserts for the document. Y or 1 in a bin position can mean that the bin should deliver an insert. N or 0 can mean that the bin should not deliver an insert. To use this property, you must use Document Property Designer to link it to an index tag in the document that identifies which bins should deliver inserts. character 64

Format
Comment lines start with a pound sign (#).

Each line in the rules file defines a field in a record in the body of the control file. Each line has this format:

field_name,field_type,field_length,[expr=content_language_expression]
field_name
Specifies a descriptive name for the field. The name must not contain blank characters. You can specify any name in this field. The name does not need to match the field name in the inserter specifications.
field_type
Specifies the type of data in the field. Allowed values: character, varchar, integer, bigint, smallint, timestamp, time, date, double, float, real.
field_length
Specifies the length (in characters) of the field. This field is required for control files with fixed-length records. It is optional for control files with comma-delimited records and files that are in XML format.
[expr=content_language_expression]
Specifies an expression in the RICOH ProcessDirector Content Expression Language (CEL). RICOH ProcessDirector evaluates the CEL expression to determine what value to place in the field. In the expression, you can specify a fixed value (such as blanks or zeroes), or you can specify the value of a RICOH ProcessDirector property. You can also use CEL functions. For information about the CEL language and functions, see the related Reference topic.

This parameter is optional. If you omit it, the field in the control file contains zeroes or blanks, depending on the data type of the field.

Example
This example defines the first two fields of each record:
#The first 8 characters contain the value of the Job.Inserter.JobID property.JobID,character,8,[expr=Job.Inserter.JobID]#The next 6 characters contain the value of the Doc.Insert.Sequence property.PieceID,integer,6,[expr=Doc.Insert.Sequence]
Assume that the value or the Job.Inserter.JobID property is 10000034 and the job contains 5 documents. If the inserter control file format is fixed-length records, the first five records look like this:
1000003400000110000034000002100000340000031000003400000410000034000005

1.2.10.26.9.2 Header rules files for inserter control files

The header rules file defines the fields in the header record and specifies the value to put in each field of the record. RICOH ProcessDirector uses the header rules file to write the header record at the top of the inserter control file. Typically, RICOH ProcessDirector creates one header record in an inserter control file. Some inserters generate several XML elements in the header, but these elements occur only once in the XML output file. This file is required only if the inserter control file format specifies a header record.

Not all inserter control files require a header record. In this case, no header rules file is required.

Purpose

RICOH ProcessDirector uses the header rules file to write the header record of the inserter control file.

RICOH ProcessDirector provides these sample header rules files in the inserter directory:

  • /aiw/aiw1/samples/control_files/inserter (Linux)

  • C:\aiw\aiw1\samples\control_files\inserter (Windows)

Inserter manufacturer Header rules file
Bowe BOWE.icf.halFile.header.dsc
Bowe with JetVision camera systems None (no header record)
Bowe Bell & Howell None (no header record)
Gunther None (no control file used)
Inserters with Ironsides camera systems None (no header record)
Kern None (no header record)
Pitney Bowes PB.icf.inputFile.header.dsc
Quadient quadient.jaf.inputfile.dsc

In each field, RICOH ProcessDirector can put a fixed value (such as characters, blanks or zeroes) or the value of any of these RICOH ProcessDirector properties:

  • Job properties: Inserter job name (Job.Inserter.JobID), Job name (Job.Name), and Load plan comment (Job.Insert.LoadPlan.Comment)

      Note:
    • If you need to put the value of another job property in the inserter control file, add a line for the job property in file /aiw/aiw1/config/fbi/icf_job_del_properties.cfg.

  • Any document property (document properties start with Doc)

    For example, you put the values of the Doc.CurrentSheets and Doc.Insert.BinTriggers properties in a CEL aggr function to add the number of sheets and inserts in all documents in a job. The function places the total in the PlannedSheetCount field of the header record. An example is in the PB.icf.inputFile.header.dsc sample header rules file.

RICOH ProcessDirector properties for header rules files lists some of the properties that you might want to put in the header record of an inserter control file. You specify properties by their database property names.

RICOH ProcessDirector properties for header rules files
Property (field name) Property (database name) Description Type Length (characters)
Inserter job name Job.Inserter.JobID The job name that the inserter uses for the job. The default value is the Job number (Job.ID) property. character 255
Job name Job.Name The job name. character 128
Load plan comment Job.Insert.LoadPlan.Comment The names of the materials (or inserts) that the operator should load into each inserter bin. character 128

Format
Comment lines start with a pound sign (#).

Each line in the rules file defines a field in the header record. Each line has this format:

field_name,data_type,length,[expr=content_language_expression]
field_name
Specifies a descriptive name for the field in the header record. The name must not contain blank characters.
data_type
Specifies the type of data in the field. Allowed values: character, varchar, integer, bigint, smallint, timestamp, time, date, double, float, real.
length
Specifies the length (in characters) of the field. This field is required for inserter control files with fixed-length records. It is optional for control files with comma-delimited records and files that are in XML format.
[expr=content_language_expression]
Specifies an expression in the RICOH ProcessDirector Content Expression Language (CEL). RICOH ProcessDirector evaluates the CEL expression to determine what value to place in the field. In the expression, you can specify a fixed value (such as blanks or zeroes), or you can specify the value of a RICOH ProcessDirector property. You can also use CEL functions. For information about the CEL language and functions, see the related Reference topic.

This parameter is optional. If you omit it, the field in the control file contains zeroes or blanks, depending on the data type of the field.

Example
This example defines the first two fields of the header record in the inserter control file:
JobID,character,8,[expr=Job.Inserter.JobID]RunID,character,15,[expr="           TEST"]
Assume that the value of the Job.Inserter.JobID property is 10000034. If the inserter control file format is fixed-length records, the header record looks like this:
10000034           TEST

1.2.10.26.9.3 Parsing rules files for inserter results files

The parsing rules file defines the fields in each record of the inserter results files.
Purpose

RICOH ProcessDirector uses the parsing rules file to parse (analyze) the inserter results file. It uses the parsing rules file together with the document-properties rules file and the job-processing rules files to set RICOH ProcessDirector document and job properties after a job has completed insertion.

RICOH ProcessDirector provides these sample parsing rules files in directory /installation_path/extensions/fbi-basic/samples/icf_results:

Inserter manufacturer Parsing rules file
Bowe BOWE.icf_results.mslFile.dsc
Bowe Bell & Howell BBH.icf_results.idFile.dsc
Bowe Bell & Howell with JetVision camera systems JET.icf_results.flatFile.dsc
Gunther GUN.icf_results.logFile.dsc
Inserters with Ironsides camera systems IRON.icf_results.dsc
Kern KERN.icf_results.outputFile.dsc
Pitney Bowes PB.icf_results.outputFile.dsc
Quadient quadient.jrf_results.outputfile.dsc

Format
Comment lines start with a pound sign (#).

Each line in the rules file defines a field in a record of the results file. Each line has this format:

field_name,field_type,field_length
field_name
Specifies a descriptive name for the field that the job-properties and document-properties rules files can refer to. The name must not contain blank characters. It is case-sensitive. The document-properties and job-properties rules files must specify this field name to map the value in the field to a document or job property.
field_type
Specifies the type of data in the field. Allowed values: character, varchar, integer, bigint, smallint, timestamp, time, date, double, float, real.
field_length
Specifies the length (in characters) of the field. This field is required for results files with fixed-length records. It is optional for results files with comma-delimited records and files that are in XML format.

Example
This example defines the first two fields in each record of the results file:
JobID,character,8
PieceID,integer,6
...

1.2.10.26.9.4 Document-properties rules files for inserter results files

The document-properties rules file specifies how to map values in the inserter results file to RICOH ProcessDirector document-property values.
Purpose

RICOH ProcessDirector uses the document-properties rules file to set values of RICOH ProcessDirector document properties. It uses the document-properties rules file together with the parsing rules file that defines each field in the results file.

RICOH ProcessDirector provides sample document-properties rules files in the inserter directory:
  • /aiw/aiw1/samples/control_files/inserter on Linux

  • C:\aiw\aiw1\samples\control_files\inserter on Windows

Inserter manufacturer Document-properties rules
Bowe BOWE.icf_results.process.doc.dsc
Bowe Bell & Howell BBH.icf_results.process.doc.dsc
Bowe Bell & Howell with JetVision camera systems JET.icf_results.process.doc.dsc
Gunther GUN.icf_results.process.doc.dsc
Inserters with Ironsides camera systems IRON.icf_results.process.doc.dsc
Kern KERN.icf_results.process.doc.dsc
Pitney Bowes PB.icf_results.process.doc.dsc
Quadient quadient.jrf_results.outputfile.dsc

RICOH ProcessDirector document properties set in rules files lists some of the document properties that you might want to set in the document-properties rules file. The rules files must set the value of document properties that are marked Required.

RICOH ProcessDirector document properties set in rules files
Property (field name) Property (database name) Required Description Type Length (characters)
Insert sequence Doc.Insert.Sequence One of these is required for job-specific results files:
  • Doc.Insert.Sequence
  • Doc.ID
The numeric position of the document in the job. The value must match the value that RICOH ProcessDirector assigned to the document. integer 8
Document number Doc.ID Required if the inserter results files is not job-specific (such as Gunther results files) The document number. The value must match the value that RICOH ProcessDirector assigned to the document. bigint 16
Status Doc.Insert.Status Yes The insert status of the document. Allowed values:
  • Attention
  • Damaged
  • OK
  • Pulled
Note: If the rules file does not set a value for this property, RICOH ProcessDirector sets it to the value of the Default insert status property of the inserter controller.
character 16
Action Doc.Insert.Disposition Required if the inserter results files is not job-specific (such as Gunther results files) The action that RICOH ProcessDirector takes during automatic reconciliation and the default action for manual reconciliation. Allowed values:
  • null value
  • OK
  • Pull
  • Reprint
Note: If the inserter results file is job-specific, do not set this property because RICOH ProcessDirector sets it.
character 16
Status code Doc.Inserter.StatusCode No The status code for the document. character 16
Extended status code Doc.Inserter.StatusCodeExtended No The extended status code for the document. character 128
Insert date and time Doc.Insert.TimeStamp No The date and time that the inserter processed the document. character 15
Inserter name Doc.Insert.InserterID No The name of the inserter that processed the document. character 64
Bin results Doc.Insert.BinResults No The inserter bins that delivered inserts for this document. Y or 1 in a bin position can mean that the bin delivered an insert. N or 0 can mean that the bin did not deliver an insert. character 64
Operator name Doc.Insert.OperatorID No The name or user ID of the operator who was logged in to the inserter when this document was processed. character 64
Format

Comment lines start with a pound sign (#).

The first non-comment line is optional. It identifies which records in the results file contain information. The first line has this format:

[expr=content_language_expression]

For example, if the first line of the results file is a header and you want to ignore it, use this expression:

[expr=recnum>1]

If all records in the results files contain information, omit this line.

Each subsequent line in the rules file sets a document property. Each line has this format:

property_name,property_type,property_length,[expr=content_language_expression]
property_name
Specifies the database name of the RICOH ProcessDirector document property.
property_type
Specifies the type of data in the property value. Allowed values: character, varchar, integer, bigint.
property_length
Specifies the number of characters that the property allows in the value.
[expr=content_language_expression]
Specifies an expression in the RICOH ProcessDirector Content Expression Language (CEL). The expression is evaluated and the result becomes the value of the document property. In the expression, you can specify a fixed value, or you can specify the value of a field in the results file. The parsing rules file defines the fields in the results file. You can also use CEL functions. For information about the CEL language and functions, see the related Reference topic.

Examples
This example specifies that the records in the results file that contain document information have RecordType=5 and SubRecordType=0. The RecordType and SubRecordType fields must be defined in the parsing rules file.
[expr=and(RecordType=="5",SubRecordType=="0")]
This example sets the Doc.Insert.Sequence property value equal to the value of the PieceID field in the results file. The parsing rules file must define the PieceID field.
Doc.Insert.Sequence,integer,8,[expr=PieceID]
This example sets the value of the Doc.Insert.Status property based on the value of the Disposition field in the inserter results file. The parsing rules file must define the Disposition field.
  • If Disposition is 0, 1, or 6, Doc.Insert.Status is null.
  • If Disposition is 2, 3, 4, or 7, Doc.InsertStatus is Damaged.
  • If Disposistion is 5 or 8, Doc.Insert.Status is OK.
  • If Disposition is 9, Doc.InsertStatus is Pulled.
  • If the Disposition is another value, Doc.Insert.Status is Damaged.
Doc.Insert.Status,character,16,[expr=if(or(Disposition==0,Disposition==1,Disposition==6),"",if(or(Disposition==2,Disposition==3,Disposition==4,Disposition==7),"Damaged",if(or(Disposition==5,Disposition==8),"OK",if(Disposition==9,"Pulled","Damaged"))))]

1.2.10.26.9.5 Job-properties rules files for inserter results files

The job-properties rules file specifies how to map values in the inserter results file to RICOH ProcessDirector job-property values.
Purpose

RICOH ProcessDirector uses the job-properties rules file to set values of RICOH ProcessDirector job properties. It uses the job-properties rules file together with the parsing rules file that defines the fields in the results file.

RICOH ProcessDirector provides these sample job-properties rules files in directory /installation_path/extensions/fbi-basic/samples/icf_results:

Inserter manufacturer Job-properties rules
Bowe BOWE.icf_results.process.job.dsc
Bowe with JetVision camera systems JET.icf_results.process.job.dsc
Bowe Bell & Howell None (not supported)
Gunther GUN.icf_results.process.job.dsc
Inserters with Ironsides camera systems IRON.icf_results.process.job.dsc
Kern KERN.icf_results.process.job.dsc
Pitney Bowes PB.icf_results.process.job.dsc
Quadient quadient.jrf_results.outputfile.dsc

RICOH ProcessDirector job properties set in rules file lists the job properties that you can set in a rules file.

    Note:
  • If you need to set the value of another job property, an authorized user must add a line for the job property in file /aiw/aiw1/config/fbi/icf_job_del_properties.cfg.

RICOH ProcessDirector job properties set in rules file
Property (field name) Property (database name) Required Description Type Length (characters)
Inserter name Job.Inserter.ID No The name of the inserter that processed the job. varchar 255
Job name Job.Name No The job name. character 128
Format

Comment lines start with a pound sign (#).

The first non-comment line is optional. It identifies which records in the results file contain information. The first line has this format:

[expr=content_language_expression]

For example, if the first line of the results file is a header and you want to ignore it, use this expression:

[expr=recnum>1]

If all records in the results files contain information, omit this line.

Each subsequent line in the rules file sets the value of a RICOH ProcessDirector job property. Each line has this format:

property_name,property_type,property_length,[expr=content_language_expression]
property_name
Specifies the database name of the RICOH ProcessDirector job property.
property_type
Specifies the type of data in the property value. Allowed values: character, varchar, integer, bigint.
property_length
Specifies the maximum number of characters allowed in the property value.
[expr=content_language_expression]
Specifies an expression in the RICOH ProcessDirector Content Expression Language (CEL). The expression is evaluated and the result becomes the value of the job property. In the expression, you can specify a fixed value, or you can specify the value of a field in the results file. The parsing rules file defines the fields in the results file. You can also use CEL. For information about the CEL language and functions, see the related Reference topic.

Examples
This example sets the Job.Inserter.ID property value equal to the value of the MachineID field in the results file. The MachineID field must match a field name defined in the parsing rules file.
Job.Inserter.ID,varchar,255,[expr=MachineID]

1.2.10.26.10 Font mapping files

RICOH Visual Workbench 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.

RICOH Visual Workbench provides sample installation font-mapping files that you can edit in directory /aiw/aiw1/lib/AVE/resources (UNIX-based operating systems) or C:\aiw\aiw1\lib\AVE\resources (Windows).

1.2.10.26.10.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 /aiw/aiw1/lib/AVE/resources/CharacterSets.properties (Linux) or C:\aiw\aiw1\lib\AVE\resources\CharacterSets.properties (Windows) .

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.2.10.26.10.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 /aiw/aiw1/lib/AVE/resources/CodedFonts.properties (Linux) or C:\aiw\aiw1\lib\AVE\resources\CodedFonts.properties (Windows) .

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.2.10.26.10.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 /aiw/aiw1/lib/AVE/resources/CodePages.properties (Linux) or C:\aiw\aiw1\lib\AVE\resources\CodePages.properties (Windows) .
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.2.10.26.10.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 /aiw/aiw1/lib/AVE/resources/SampleCodePointMap.cp (Linux) or C:\aiw\aiw1\lib\AVE\resources\SampleCodePointMap.cp (Windows) .

Purpose
The SampleCodePointMap.cp file lets you map code points in a custom AFP code page to Unicode code points so that RICOH Visual Workbench 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.2.10.26.11 Control file for restarting the Web server

RICOH ProcessDirector provides a control file that you can copy and edit to change the automatic Web server restart settings.
Note: Always modify your own copy of the control file, not the sample file. The sample file might be overwritten by service updates.

RICOH ProcessDirector provides a script that automatically restarts the Web server if it fails. The control file WebserverChecker.cfg lets you set options for automatic restarts. The WebserverChecker.cfg file is installed in the /aiw/aiw1/config/ directory.

You can deactivate automatic restart using the stopchecker command. For example, you might want to deactivate the script if you need to diagnose a problem related to the Web server. If you deactivate automatic restart, or if the server has reached the maximum number of automatic restarts, you can activate the script by entering the startaiw command.

This example shows the default entries in the WebserverChecker.cfg file:

# Indicate whether the WebServer should be restarted automatically 
# if it fails (Yes or No)
autorestart=Yes

# Set the maximum number of times the WebServer can be automatically 
# restarted in any 24 hour period (1-1440)
number_of_restarts_per_day=3

# Set the maximum number of times to retry restarting the WebServer 
# if the first attempt fails (0-3)
number_of_consecutive_restart_attempts=1

# Set the full path and file name of where trace information should be written
# Note: aiw1 must have write permission to this folder
copy_tracing_to=/aiw/aiw1/trace/webserverchecker.trace

1.2.10.26.12 Control files for the AFP Support feature

In addition to the control files for all document processing features, the AFP Support feature uses control files for processing AFP documents.

1.2.10.26.12.1 Enhance AFP control file

Steps based on the BuildAFPFromDocuments and CreateAFPJobsFromDocuments step templates use an Enhance AFP control file to change the content of AFP files. Work with your support representative to create control files that contain rules for the changes.

Documentation and examples for using Enhance AFP are located on the product CD in the /samples directory. After installation, you can find them in the directory /path/extensions/doc/samples/. On Linux, the path is /opt/infoprint/ippd. On Windows, the path is C:\Program Files\Ricoh\ProcessDirector.

These are examples of the changes you can make using Enhance AFP:

  • Insert new barcodes or text.
  • Remove obsolete content, such as barcodes, text, or OMR marks.
  • Find variable text or barcode content to use as a basis for generating new content.
  • Insert, find, or remove index tags (TLEs).

Messages and some of the instructions related to Enhance AFP refer to the function as adf_extract.

If you make enhancements using the AFP Enhancer plugin, they are saved in the Visual Workbench control file.

Visit the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/) for the most recent version of the documentation.

1.2.10.26.12.2 Creating the Enhance AFP control file

You can create an Enhance AFP control file to define where to place AFP data on a page. For example, you can apply barcodes, mask text by creating hidden areas (cover blocks), or add text.

The BuildAFPFromDocuments, CreateAFPJobsFromDocuments, and BuildEnhanceAFPFile (Advanced Document Pool extended feature only) step templates can make enhancements to AFP files. When you set up steps based on these step templates, you enter the location of the Enhance AFP control file that the step uses to manipulate the AFP data.

After installation, you can find examples for using Enhance AFP in the enhanceAfp.cfg file located in the directory /path/extensions/doc/samples/. For example, on Linux, the path is /opt/infoprint/ippd. On Windows, the path is C:\Program Files\Ricoh\ProcessDirector.

  1. Log in as the RICOH ProcessDirector system user (aiw1 is the default).
  2. Create a directory to store the Enhance AFP control file.
    We recommend the /aiw/aiw1/control_files/enhanceafp directory, because files in this directory are backed up when you do an aiwbackup process. This directory should be owned by the RICOH ProcessDirector system user or a member of the RICOH ProcessDirector group (aiwgrp1 is the default), with the same permissions (775) as the control_files directory.
  3. Open RICOH Visual Workbench and select AFP Enhancer mode.
  4. Use AFP Enhancer to create a control file that defines setup attributes and update requests.
  5. Save the RICOH Visual Workbench control file.
  6. Select Export EnhanceAFP Control file and save the file in the directory that you created in step 2.

Specify the path to this file in the Enhance AFP control file property of the step in the workflow that creates the AFP file.

1.2.10.26.12.3 AFP data standards and requirements

The AFP data standard for AFP document processing features defines general characteristics of AFP print data.

  • Each document in an AFP file must be bounded by Begin Named Group (BNG) and End Named Group (ENG) structured fields.
  • Each document in an AFP file must use one or more Tagged Logical Element (TLE) structured fields to identify the document and its properties. These are often called index tags.
  • The AFP file must conform to certain formatting rules so that text, barcode, and cover block enhancements can be added to its documents.
  • AFP resources including fonts, form definitions, page segments, and overlays must be included as an inline resource group or as external files in the resource path. External resource groups are not supported.

1.2.10.26.12.3.1 AFP data stream preparation

You can prepare the AFP data stream to conform to the standard before it reaches RICOH ProcessDirector, or prepare the data in RICOH ProcessDirector. You do not need to prepare the data at all if document-level processing is not required. To prepare the data in RICOH ProcessDirector, you use AFP Indexer and other utility programs.

The degree of preparation done before the AFP file is submitted to RICOH ProcessDirector as a job determines how much processing RICOH ProcessDirector might need to do. You add different steps to your workflows depending on the amount of processing that you want RICOH ProcessDirector to do.

1.2.10.26.12.3.2 Standardized AFP requirements

Standardized AFP is the required input for document tracking and manipulation. This topic describes document delineation, document indexing, and document manipulation requirements.

Document delineation

Begin Named Group (BNG) and End Named Group (ENG) structured fields surround each document in the AFP file.

Each page contained by the group delimiters is included; therefore, banners or separator pages that are not to be enclosed in an envelope should not be included in the group. Pages outside the groups at the beginning and end of the file or between groups through the file are discarded before printing, because each document becomes a unique entity that is no longer required to remain with the other documents in the print file.

This standard applies to each document, whether or not the document is ever physically printed or mailed.

Document indexing

Each document includes at least one Tagged Logical Element (TLE) structured field that lets an operator identify the document. You can specify additional document properties that contain values from the index tags in the data.

Documents that are to be sorted or grouped need TLEs to define the grouping and sorting criteria. Some criteria can be defined in job properties instead of in individual document TLEs.

This is a sample of standard AFP structure:

BDT (Begin Document)
		BPG (Begin Page – Header page (s)
		EPG (End Page)
	BNG (Begin Named Group – Document)
		IMM
		TLE (Tagged Logical Element) – CustomerAcctNo
		TLE (Tagged Logical Element) – CustomerAddr<1-6>
		TLE (Tagged Logical Element) – MailRecipient
		TLE (Tagged Logical Element) – CustomerZIP
		TLE (Tagged Logical Element) - CustomerInsertBins
		BPG (Begin Page)
			Page data
		EPG (End Page)
		BPG (Begin Page)
			Page data
		EPG (End Page)
	ENG (End Named Group)
EDT (End Document)

Document manipulation

The AFP file must adhere to the formatting rules listed here to allow the addition of text, barcodes, or cover blocks. Those additions can be made with the Enhance AFP control file that is specified on the CreateAFPJobsFromDocuments and BuildAFPFromDocuments step templates. These rules are in addition to the document indexing rules and define a consistent set of documents throughout the file.

Requirements and Examples
Valid AFP The AFP data must conform to the Data Stream and Object Architecture: MO:DCA Reference.
BDT/EDT(s) The AFP data can contain more than one pair of Begin Document (BDT) and End Document (EDT) structured fields, but they cannot be nested.
Example:
BDT
 ...
EDT
BDT
 ...
EDT
Named Groups - BNG/ENG(s) Named page groups for document boundaries must be present. If there are nested page groups, only the outer level is used to define document boundaries.
Example: 2 mailpieces
BNG (1st mailpiece)
BNG/../ENG (nesting allowed)
BNG/../ENG\
ENG
BNG (2nd mailpiece)
ENG
Pages - BPG/EPG(s) Pages outside of named groups are ignored. These pages are not indexed or printed.
Example: 2 banner pages
BDT
	BPG/EPG (discarded)
	BPG/EPG (discarded)
	BNG
	BPG/EPG (1st document)
	ENG
EDT
Index Tags - TLE(s) Index tags cannot occur outside of existing named page group boundaries. One instance of each required index tag is found in the bounds of the named group. These index tags can be in nested named groups or pages.

There is only one value for each required index tag, regardless of how many TLEs of the same name have been provided. Therefore, multiples of the same index tag, such as CustomerName in a group, are not supported.

Example: valid TLEs
BDT
	BNG
		TLE 1
		BPG
			TLE 2
		EPG
		TLE 3
	ENG
Invoke Medium Maps - IMM(s) An Invoke Medium Map structured field must be included after the BNG structured field that marks the beginning of each document, and before the first BPG structured field that marks the beginning of the first page of the document.
Example:
BDT
	BNG/IMM/../ENG
	BNG/IMM/../ENG
	BNG/IMM/../ENG
	...
EDT
Units Measurement units in any Presentation Text Descriptor (PTD) structured field in the document must match the units set in the Page Descriptor (PGD) structured field.
Enhanced N-Up The form definition used for the AFP data can use the enhanced N-up function but it cannot specify pagination between the partitions.
Constant Pages If the constant pages function of the form definition is used, it must specify only constant pages that fit a consistent pattern, such as all backs, all fronts, first back of each document, and so on.
Mixed Plex The form definition used for the AFP data must not change back and forth between simplex and duplex.
Form definition functions The form definition must not contain these structured fields: Presentation Finishing Control (PFC), Map Suppression (MSU), and Medium Finishing Control (MFC).

1.2.10.26.12.3.3 Indexable AFP requirements

The basic requirement for indexable AFP is that AFP Indexer can be used to establish document boundaries and to add index tags to form standardized AFP. Note that AFP Indexer only does document delineation and document indexing. It does not change AFP data to conform to the document manipulation requirements of standardized AFP, such as including an inline medium map inside each document.

Begin Named Group (BNG) and End Named Group (ENG) structured fields that already exist in the input AFP data can be either recognized and retained by AFP Indexer, or removed and replaced using AFP Indexer to define a new document trigger.

If existing named page groups are retained, the levels of nesting to be retained can be selected during configuration. The system determines documents based on the outermost named page groups.

When named page groups are preserved, existing index tags (TLEs) can also be preserved.

This section describes the requirements of the AFP data to be input to AFP Indexer.

Requirements and Examples
Valid AFP The AFP data must conform to the Data Stream and Object Architecture: MO:DCA Reference.
BDT/EDT(s) The AFP data can contain more than one pair of Begin Document (BDT) and End Document (EDT) structured fields, but they cannot be nested.
Example:
BDT
...
EDT
BDT
...
EDT
Pages – BPG/EPG(s) Pages before the start of named groups are not indexed.
Example: 2 banner pages discarded
BDT
	BPG/EPG
	BPG/EPG 
	BNG
	BPG/EPG (1st document)
	ENG
	...
EDT
Existing Named Page Groups – BNG/ENG(s) Named page groups for document boundaries can be present. The nesting level is specified when you select to keep the existing named page groups.

You can remove named page groups and redefine boundaries by setting a new document trigger.

Existing TLEs are removed if the document trigger is redefined.

Example: 2 documents
BNG (1st document)
	BNG/../ENG (nesting allowed)
	BNG/../ENG\
ENG
BNG (2nd document)
ENG
Existing Indexes – TLE(s) Existing index tags can be retained if named page groups are maintained. Index tags cannot occur outside of existing named page group boundaries.
Document Triggers To add named page groups for document delineation, you must define a document trigger.

The AFP text field must be in a constant physical (print) location, in the same sequence in the case of multiple fields in that location.

If parsing is required, the parsing rules must apply consistently to the document trigger text for every document in the file.

Only Presentation Text Object Content Architecture (PTOCA) within an AFP page is supported. AFP Image, Draw Rules, Bar Code Object Content Architecture (BCOCA) objects, or PTOCA in page segments or overlays are not supported as document triggers.

Sample document trigger: 
BPG
	PTX
		TRN (full trigger text)
EPG
Index tags Index tags can be created from either AFP text or No Operation (NOP) records in the AFP data.

A NOP record causes an application to move to the next instruction for processing without taking any other action. Page group NOPs are found outside the logical AFP pages--they are contained in structured fields that are in the page group but not on the current page. NOP records in the AFP file are not viewable or printable, but you can use the RICOH Visual Workbench to create index tags from the data contained in them.

To make an index tag from AFP text, the AFP text must be in a constant physical (print) location or area, and in the same sequence in the case of multiple text blocks in that location. If parsing is required, the parsing rules must apply consistently to the index data for every document in the file.

Presentation Text data is the only type of data in an AFP page that is supported for use as an index tag. AFP Image, Draw Rules, BCOCA objects, or PTOCA in page segments or overlays are not supported as index tag data.

Sample index tag:

BPG
	PTX
		TRN (index text here)
BPG

1.2.10.26.13 Control files for document processing features

Document processing features use a variety of control files and properties files to manage document processing.

1.2.10.26.13.1 docCustomDefinitions.xml file

The document properties configuration file (docCustomDefinitions.xml) defines properties that are used to manage documents. The installation process places a sample file in /aiw/aiw1/samples/config on UNIX-based operating systems, and in C:\aiw\aiw1\samples\config on Windows.

    Note:
  • If you change the docCustomDefinitions.xml file after installing Advanced Document Pool, AFP Support, or PDF Document Support:
    • Run the docCustom utility and install or upgrade the Custom Document Properties feature.
    • For the PDF Document Support feature, load the document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
    • For the AFP Support feature, access RICOH Visual Workbench from the RICOH ProcessDirector user interface. New document properties are loaded to RICOH Visual Workbench when it opens on your workstation.

Database properties and limited properties

You can define two types of document properties:

  • Database properties
  • Limited properties

You can store and manipulate both types of properties in a document properties file, but only database properties are stored in the database.

You can work with both types of properties in these ways:

  • You can use them with steps in a workflow to group or sort documents (for example, with the SortDocuments step template).
  • You can link them to AFP index tags using the RICOH Visual Workbench Document Property Designer.
  • You can map document data in PDF jobs to them using RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • If you have the Archive feature, you can store them in a repository. After you store them, you can use them to search the repository and retrieve jobs, documents, and history information. The values of the properties appear on the Properties tab when you click Show details on the Results table.
  • If you have the Preference Management feature, you can use an external preferences file to set the values of the properties.

You can work with database properties, but not limited properties, in these ways:

  • You can use them to search for documents on the Documents portlet on the Main page of the user interface.
  • When you select a document on the Documents portlet, the values of database properties are displayed.
  • You can use them to search for documents to display in the viewer.
  • You can determine their values in one job, update their values in another job, and use the updated values in the original job.
  • If you have the Automated Verification or Inserter feature, you can use database properties to search for documents to reconcile or reprint.
  • If you have the Advanced Document Pool extended feature, you can use selectors to manipulate documents based on their property values.

Limited properties offer these advantages:

  • You can use them to avoid displaying sensitive property values in the user interface, such as Social Security numbers or check amounts.
  • They maximize system performance. Database property manipulation can degrade performance if you process a significant number of documents.

Work with your support representative to determine your needs for database and limited document properties.

Sections in sample file

The sample docCustomDefinitions.xml file contains several sections. This table summarizes them.

Sections in the docCustomDefinitions.xml file
Section Purpose
Schema The schema section identifies the schema and the unique character string for the custom document properties. Only the support representative should edit this section.
Database properties This section defines database document properties.
Limited properties This section defines limited document properties.
User authorization properties This section is optional. User authorization properties specify custom authority groups for access to database properties.

Schema section

The Schema section contains one docCustomDefinitions element and one schema element. Only support representatives should edit the schema section.

Database properties section

The Database properties section contains the docProperty element.

    Note:
  • Do not define a property as both a database property and a limited property. Unexpected behavior might occur.
  • Do not define a document property with the same name as a property that RICOH ProcessDirector defines automatically. For a list, see Automatically defined document properties.
<docProperty>
Defines document properties that are in the database.
Attributes for the docProperty element
docProperty attribute Required? Notes
name Yes The database name (internal name) for the property. Programs that read or write properties use this name. We recommend that you use a consistent naming convention for your custom property names, so they are unique across the entire system. For example, the sample docCustomDefinitions.xml file uses the prefix Doc.Custom to make its properties unique from those of the base product.

Do not use any special characters (such as @, #, $, %, or - (dash)) or spaces in the property name. You can use periods and underscores.

Do not use a number immediately after the period (.) in the property database name. For example, the property Doc.3rdLineAddress is not valid.

access No The user access level for the property. You can use an access level that is already defined in the product, or you can create a custom access level if an existing one does not meet your needs. See the Access section for more information.
datatype Yes The data type to use for the property. See the next table.
dbType No A database parameter that specifies the type of data.
    Note:
  • The dbType property has been deprecated and is no longer used. Use the datatype property instead.
caption Yes The user interface name (default caption) for the property. If you are setting up captions in only one language, define them in this file. If you are setting up user interface names in more than one language, create additional document properties names files (docCustomDefinitions_language.properties) for the other languages.
shortCaption Yes The default short caption displayed for this property where required, such as in table column headings. If you are setting up short captions in only one language, define them in this file. If you are setting up short captions in more than one language, create additional document properties names files (docCustomDefinitions_language.properties) for the other languages.
description Yes The default description of the document property, which displays in the user interface as help text. If you are setting up descriptions in only one language, define them in this file. If you are setting up descriptions in more than one language, create additional document properties names files (docCustomDefinitions_language.properties) for the other languages.

You can use these data types and database types in database property definitions. Keep in mind that the database definition might further restrict the values that can be stored, in addition to the validation rules shown in this table. For example, a SMALLINT can store integers from 0 to 32,767. Database type values are not case-sensitive.

Data types and database types for docProperty definitions
Data type Database type (used in SQL) Validation for data type
String VARCHAR(128) VARCHAR: variable length, 1–128 characters
IntegerNonNeg SMALLINTBIGINTINTEGER SMALLINT: 2 bytesBIGINT: 4 bytesINTEGER: 8 bytesMinimum=0
Timestamp TIMESTAMP TIMESTAMP: Must contain values for day (D), month (M), and year (Y).Those components can appear in one of these formats:MM DD YYYYDD MM YYYYYYYY MM DDDay and month must be represented by a two-digit number.You can add a time of day in this format:hh:mm:ss
XdkString10 VARCHAR(10) VARCHAR: variable length, 1–10 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString20 VARCHAR(20) VARCHAR: variable length, 1–20 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString30 VARCHAR(30) VARCHAR: variable length, 1–30 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString40 VARCHAR(40) VARCHAR: variable length, 1–40 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString50 VARCHAR(50) VARCHAR: variable length, 1–50 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString128 VARCHAR(128) VARCHAR: variable length, 1–128 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

Limited properties section

The Limited properties section contains one or more docProperty elements.

    Note:
  • Do not define a property as both a database property and a limited property. Unexpected behavior might occur.
  • Do not define a document property with the same name as a property that RICOH ProcessDirector defines automatically. For a list, see Automatically defined document properties.
<docProperty>
Defines document properties that are manipulated only in the document properties file and not in the database.
Attributes for the docProperty element
docProperty attribute Required? Notes
name Yes We recommend that you use a consistent naming convention for your custom property names, so that they are unique across the entire system. For example, the sample docCustomDefinitions.xml file uses the prefix Doc.Custom to make its properties unique from the base product.

Do not use any special characters (such as @, #, $, %, or - (dash)) or spaces in the property name. You can use periods and underscores.

Do not use a number immediately after the period (.) in the property database name. For example, the property Doc.3rdLineAddress is not valid.

datatype No See the next table.
caption No The caption displayed in lists in the user interface for this property. If you are setting up captions in only one language, define them in this file. If you are setting up captions in more than one language, create a document properties names file (docCustomDefinitions_language.properties) for the other languages. See the related information center topic for details.

You can use these data types in docProperty definitions:

Data types for the docProperty element
Data type Validation for data type
String
None
IntegerNonNeg
Integer between 0 and 2147483647
Timestamp TIMESTAMP: Must contain values for day (D), month (M), and year (Y).Those components can appear in one of these formats:MM DD YYYYDD MM YYYYYYYY MM DDDay and month must be represented by a two-digit number.You can add a time of day in this format:hh:mm:ss

User authorization properties section

The User authorization properties section is optional. User authorization properties specify custom authority groups for access to database properties. This section contains one or more access elements.

<access>
Used to define the ability to read or edit custom properties. You use these access levels in the docProperty element. You can use one of the default security groups that RICOH ProcessDirector provides, or define your own. These are the attributes:
Attributes for the access element
access attribute Notes
name Name of the access level.
groupAttributeAccess Ability of the user group to read or edit the attribute.
These are the default access levels and authorizations that RICOH ProcessDirector provides:
Default access levels and authorizations
Access name Group name Access level
generic AnyAuthenticated Attribute access: read
Operator Attribute access: read
Supervisor Attribute access: read
Administrator Attribute access: write
attrWriteAdmin Operator Attribute access: read
Supervisor Attribute access: read
Administrator Attribute access: write
Everyone Attribute access: read
Monitor Attribute access: read
attrWriteAdminSuper Operator Attribute access: read
Supervisor Attribute access: write
Administrator Attribute access: write
Everyone Attribute access: read
Monitor Attribute access: read
attrWriteAdminSuperOper Operator Attribute access: write
Supervisor Attribute access: write
Administrator Attribute access: write
Everyone Attribute access: read
Monitor Attribute access: read
actionAdmin Operator Action access: false
Supervisor Action access: false
Administrator Action access: true
Everyone Action access: false
Monitor Action access: false
actionAdminSuper Operator Action access: false
Supervisor Action access: true
Administrator Action access: true
Everyone Action access: false
Monitor Action access: false
actionAdminSuperOper Operator Action access: true
Supervisor Action access: true
Administrator Action access: true
Everyone Action access: false
Monitor Action access: false
Automatically defined document properties

This table lists document properties that RICOH ProcessDirector automatically defines during installation. Do not define these properties in the docCustomDefinitions.xml file.

Automatically defined document properties
Property database name Packaged with... Notes
Doc.Address.1 Postal Enablement Specifies the first line of the address block in the document.
Doc.Address.Company Postal Enablement Specifies the company name in the document.
Doc.Address.PostalCode Postal Enablement Specifies the zip code in the document.
Doc.Address.ZipCode Postal Enablement Specifies the zip code in the document.
Doc.AV.ScanCount Automated Verification Shows the number of times the barcode on a document is scanned.
Doc.ChildJobID All document processing features A grouping identifier for child jobs. Although the value is initially defined in IdentifyDocuments or IdentifyPDFDocuments, it can be updated by any step that changes the document properties file, such as SplitDocuments or CreateJobsFromDocuments.
Doc.CurrentFirstPage All document processing features The page number of the first page of the document in the current print file.
Doc.CurrentJobID All document processing features The associated job number.
Doc.CurrentPages All document processing features The number of pages for the document in the current job.
Doc.CurrentSequence All document processing features The sequence of the document in the current job.
Doc.CurrentSheets All document processing features The number of sheets for the document in the current job.
Doc.Custom.MemberLevel Electronic Presentment The customer’s level of membership at the time the statement was created.
Doc.Custom.PURL Electronic Presentment A personalized URL linking to the location where the customer can retrieve the statement.
Doc.Custom.StatementDate Electronic Presentment The date of when the statement was first issued.
Doc.DataLen All document processing features The length (in bytes) of the document in the print file.
Doc.DataOffset All document processing features The byte offset of the document in the print file of the original job. This value is used by BuildAFPFromDocuments and CreateAFPJobsFromDocuments to locate the AFP to extract from the original job.
Doc.DocSize.PieceThickness Postal Enablement Specifies the thickness of a mail piece when the mail pieces in a job have different thicknesses.
Doc.DocSize.PieceWeight Postal Enablement Specifies the weight of a mail piece when the mail pieces in a job have different weights.
Doc.Email.Sent All document processing features Specifies whether an email with an attached document has been created and delivered to the SMTP server by the EmailDocuments step in a workflow.
Doc.EmailAddress All document processing features The email address associated with the document.
Doc.ID All document processing features A unique identifier for the document.
Doc.Insert.BinTriggers Inserter The inserter bins that should deliver inserts for this document.
Doc.Insert.DivertBin Inserter The number of the inserter output bin to which the document is diverted after insertion.
Doc.Insert.OriginalBarCode Inserter The data in the barcode that controls insertion of the document.
Doc.Insert.RecipientName Inserter The name of the person to whom this document is mailed.
Doc.Insert.ReprintJobId Inserter For an inserter reprint job, the parent job ID that created the job.
Doc.Member.Number Archive Specifies the member number in the document. The RepositorySample supplied workflow uses this property.
Doc.OriginalFirstPage All document processing features The page number of the first page of the document.
Doc.OriginalJobID All document processing features The job ID of the original job.
Doc.OriginalPages All document processing features The number of pages in the document.
Doc.OriginalSequence All document processing features The sequence of the document in the original job. The system gives the first document the sequence value 1, the next document has the sequence value 2, and so on.
Doc.OriginalSheets All document processing features The number of sheets needed to print the document.
Doc.Postal.AddressProcessingRC Postal Enablement A value returned from postal software to indicate if an address change is available for the document.
Doc.Postal.Category Postal Enablement Specifies the pallet break mark for the document.
Doc.Postal.ChangeAddressRC Postal Enablement Specifies the pallet number for the document.
Doc.Postal.ContainerBreakMark Postal Enablement Specifies the container break mark for the document.
Doc.Postal.ContainerNumber Postal Enablement Specifies the container number for the document.
Doc.Postal.HandlingUnitBreakMark Postal Enablement Specifies the package break mark for the document.
Doc.Postal.HandlingUnitNumber Postal Enablement Specifies the package number for the document.
Doc.Postal.PackageBreakMark Postal Enablement Specifies the postage rate for the document.
Doc.Postal.PackageNumber Postal Enablement Specifies the postage rate code for the document.
Doc.Postal.PostageRate Postal Enablement Specifies the presort sequence number for the document.
Doc.Postal.PostageRateCode Postal Enablement A value returned from postal sorting software to indicate the result of its processing.
Doc.Postal.SequenceNumber Postal Enablement The sequence of the document in the child job.
Doc.Postal.SequencingProcessingRC Postal Enablement The state of the document.
Doc.Pref.Member Preference Management Can be used with a property mapping object to identify the documents in a job. The DelimitedSample supplied property mapping object and PreferencesSample supplied workflow use this property.
Doc.Pref.Output Preference Management Can be used with a property mapping object to indicate the output type (such as Email, Print, or Suppress) for a document. The DelimitedSample supplied property mapping object and PreferencesSample supplied workflow use this property.
Doc.Pull All document processing features Can be used with the SetDocPropsFromList step template to indicate that a document should be removed from a job. The PullPDFSample and PullAFPSample supplied workflows use this property.
Doc.PullProp All document processing features Can be used with the SetDocPropsFromList step template to identify which document property determines the documents to be removed from a job. The PullPDFSample and PullAFPSample supplied workflows use this property.
Doc.SequenceInChild All document processing features The sequence of a document in a child job. Although the value is initially defined in IdentifyDocuments, it can be updated by any step that changes the document properties file, such as SortDocuments or CreateJobsFromDocuments.
Doc.SourceFileName All document processing features The name of the input file that contained the document.
Doc.State All document processing features The current state of the document.
Doc.TT.BarcodeStatus1 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus2 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus3 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus4 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus5 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.Verification.Recipient Automated Verification Specifies information, such as account name, that helps you to identify a document.

1.2.10.26.13.2 docCustomDefinitions.properties file

The document properties names file (docCustomDefinitions.properties) defines user interface information for custom document properties. The entries in the docCustomDefinitions.properties file correspond to the docProperty elements in the docCustomDefinitions.xml file.
    Note:
  • If you change the docCustomDefinitions.properties file or any docCustomDefinitions_language.properties files after installing the feature:
    • Run the docCustom utility and install or upgrade the Custom Document Properties feature.
    • For PDF document processing features, load the document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see RICOH ProcessDirector: Installing Document Processing Features.
    • For AFP document processing features, access RICOH Visual Workbench from the RICOH ProcessDirector user interface. New document properties are loaded to RICOH Visual Workbench when it opens on your workstation.

The entries in the docCustomDefinitions.properties file are used in the RICOH ProcessDirector user interface when you select custom document properties from lists, or when you view field help for a custom document property. A sample file is in the /samples directory on the feature CD, and the installation process places a sample file in /aiw/aiw1/samples/config on Linux, and in C:\aiw\aiw1\samples\config on Windows.

Create a separate docCustomDefinitions_language.properties file for each additional language that you want to support, using a language identifier in each file name. For example:

  • docCustomDefinitions_de.properties (German)
  • docCustomDefinitions_en.properties (English)
  • docCustomDefinitions_es.properties (Spanish)
  • docCustomDefinitions_fr.properties (French)
  • docCustomDefinitions_it.properties (Italian)
  • docCustomDefinitions_ja.properties (Japanese)
  • docCustomDefinitions_pt.properties (Brazilian Portuguese)

You create a stanza of caption and description values for every document property.

[property]
The full property name.
[property].Description
A description of the property. Use HTML tags if you want to format the text. This content appears in the field help when the user clicks the ? button.

For example:

Doc.Custom.Zip=ZIP code
Doc.Custom.Zip.Description=The ZIP code of an address

    Note:
  • Do not rename the default docCustomDefinitions.properties file; a file with this name must exist in your configuration directory (/aiw/aiw1/config). Copy the file and name the copy with the appropriate language identifier as needed.
  • The docCustomDefinitions.properties file and any docCustomDefinitions_language.properties files must use the ISO-8859-1 character encoding (code page). If you create your docCustomDefinitions.properties files in a different format (such as Shift JIS or UTF-8), you must convert the file to ISO-8859-1 when placing it in the /aiw/aiw1/config directory.

1.2.10.26.13.3 Document properties template file

The document properties template file, if it exists, determines which properties go into the document properties file for each job. The template file lets you control the number of document properties to be used, as well as the order of the columns in the document properties file. If you need to maximize performance on your system by assigning only a subset of document properties, make sure that any properties needed by your workflow steps are listed in the document properties template file.

A sample document properties template file is located on the product CD in the /samples directory. After installation, you can find it in the directory /path/extensions/doc/samples/. For example, on Linux, the path is /opt/infoprint/ippd. On Windows, the path is C:\Program Files\Ricoh\ProcessDirector.

The document properties template file lists the database names of document properties. You can include all entries on a single line with a space or a tab character between each property, or you can place each entry on a separate line. When a step based on the ReadDocumentsFromDatabase step template creates the document properties file, it copies the first line from the template file. Then the step creates a separate line for each document associated with the job. Each document description line lists the property values, separated by a tab or space character, in the same order that they appear in the first line. If a value is Not set, an empty string ('') is placed in the file.

Using a document properties template file is optional, but recommended if you need to maximize performance. If you do not use it, all document properties are included in the generated document properties file.

The document properties template file must include all the properties needed by steps that process the document properties file. In addition, the document properties template file must include certain properties, depending on the step that is using the template file. These properties are required by BuildPDFFromDocuments, CreateAFPJobsFromDocuments, and BuildAFPFromDocuments:

  • Doc.ChildJobID (*)
  • Doc.OriginalJobID (*)
  • Doc.OriginalSequence (*)
  • Doc.SequenceInChild (*)
  • Doc.OriginalSheets
  • Doc.DataOffset (for AFP jobs)
  • Doc.DataLen (for AFP jobs)

Document properties marked with an asterisk (*), as well as the Doc.ID property, are automatically included in the document properties file whether or not they are defined in the template.

1.2.10.26.13.4 Document properties file

RICOH ProcessDirector uses information from the document properties file in these processes:

  • Steps that sort, group, and split documents. For example, if you want to use a step to sort documents by ZIP code, a property such as Doc.Custom.ZipCode must be in the document properties file.
  • External programs that process document properties.
  • Steps that process document properties files for use with postal software. The Postal Enablement feature provides these steps: BuildExternalDocPropsFle, MapExternalResultsFileToDocProps, and UpdateDocPropsFromExtResultsFile. For these steps to run successfully, the Doc.ID or Doc.SequenceInChild property must be included in the document properties file.
  • Steps that process document properties files for use with values from external files. All document processing features provide the SetDocPropsFromList and EmailDocuments steps. The Preference Management feature provides the ApplyPreferences step.
  • Steps that process AFP documents, such as steps based on the CreateAFPJobsFromDocuments and BuildAFPFromDocuments step templates. For either the CreateAFPJobsFromDocuments or BuildAFPFromDocuments steps to run successfully, these properties must be included in the document properties file:
    • Doc.OriginalJobID
    • Doc.ChildJobId
    • Doc.SequenceInChild
    • Doc.OriginalSequence
    • Doc.OriginalSheets
    • Doc.DataOffset
    • Doc.DataLen
  • Steps that process PDF documents, such as steps based on the BuildPDFFromDocuments step template. For the BuildPDFFromDocuments steps to run successfully, these properties must be included in the document properties file:
    • Doc.OriginalJobID
    • Doc.ChildJobId
    • Doc.SequenceInChild
    • Doc.OriginalSequence
    • Doc.OriginalSheets

The first line in the document properties file contains the information from the document properties template file. Each additional line contains values for each of the properties from one document.

These steps automatically create the document properties file:

  • A step based on the IdentifyDocuments step template creates the document properties file using the Visual Workbench control file as a guide.
  • A step based on the IdentifyPDFDocuments step template creates the document properties file using the RICOH ProcessDirector Plug-in for Adobe Acrobat control file as a guide.
  • A step based on the ReadDocumentsFromDatabase step template creates the document properties file using a document properties template file as a guide.
  • A step based on the CreateJobsFromDocuments or CreatePDFJobsFromDocuments step template creates the document properties file for child jobs using the document properties file of the parent (current) job as a guide.

These steps can manipulate the document properties file:

  • GroupDocuments
  • SortDocuments
  • SplitDocuments
  • SetDocPropsFromList
  • ApplyPreferences (Preference Management only)
  • UpdateDocPropsFromExtResultsFile (Postal Enablement only)
The document properties file might also be used by an external program or a custom step that you create.

A document properties file always contains the properties Doc.ChildJobId and Doc.SequenceInChild. If a step (such as GroupDocuments) that creates document groups runs, the document properties file will contain more than one value for Doc.ChildJobId.

RICOH ProcessDirector provides methods, including getFileName and getAbsoluteFileName, that let you provide access for external programs to read and write spool files in the spool directory for the job. For more information, see Using RICOH ProcessDirector methods such as getFileName.

The document properties file is stored in the spool directory for the job. When the IdentifyDocuments or IdentifyPDFDocuments step creates the file, the file name is in the format: jobid.original.dpf (for example, 10000009.original.dpf). When the WriteDocumentsToDatabase step runs, it copies the file and adds additional properties, including Doc.ID. The new file is saved with a file name in this format: jobid.document.dpf (for example, 10000009.document.dpf). The values are in UTF-8 format and separated by tabs.

Some information in the document properties file is not stored in the database but is used only during the processing of steps. This information, for example, is in the document properties file but not in the database:

Doc.DataOffset
The offset of the print data for the document in the original job's AFP print file.
Doc.DataLen
The length of the print data for the document in the original job's AFP print file.

1.2.10.26.13.5 Property conditions file

Steps based on the SetDocPropsFromConditions step template set document properties or job properties in the current job using a property conditions file. The conditions defined in the file use a comma-separated value (CSV) format. A sample property conditions file is in/aiw/aiw1/samples/doc/DocPropConditions.csv. If you have the Postal Enablement feature, more sample files are in /aiw/aiw1/samples/control_files/postal.
    Important:
  • When you edit the property conditions file, open it in a text editor. Do not edit the file in Microsoft Excel.

You can use the property conditions file to set values for properties with conditions or without conditions. You can also use a separate include file to define properties using a property = value format.

Setting values using conditions

The first line in the property conditions file is a header row that lists the database names of document or job properties, separated by commas. Normally the leftmost part of the header row specifies the properties to test for one or more conditions, although this order is not required.

The header row is followed by one or more condition rows that define the conditions, and the property values to be set when all the conditions in that row are true. You can think of each condition row as representing an if-then statement. All specified conditions in a row are logically ANDed together and must all be true. If any of the conditions in a row are not true, none of the values in that row are set. The values in the condition rows are separated by commas.

This example shows the contents of a property conditions file that sets property values based on conditions:

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE
=USPS,,Yes
=USPS,~XYZ*,No
=NonUSPS,,No
=Exception,,No

The first if-then condition specifies that if a mailpiece category is USPS, RICOH ProcessDirector sets the Doc.Run.PAVE property to Yes. The second row sets the value of Doc.Run.PAVE to No when the job name begins with XYZ.

We recommend that you place all properties that are part of conditions to the left of the properties that are receiving values.

Properties that are part of conditions use condition characters from this set:

Condition characters in the conditions file
Condition characters Condition Example/Notes
=[value] equal to =Fir
<>[value] not equal to <>Fir
<[value] less than <4900000
>[value] greater than >61000
<=[value] less than or equal to <=61207
>=[value] greater than or equal to >=61207
~[value] like ~INSURE*.PDF
!~[value] not like !~*.PDF
"([val1],[val2],...)" in (must start and end with parentheses surrounded by quotation marks) "(PRTA, PRTB)"
"!([val1],[val2],...)" not in (must start and end with parentheses surrounded by quotation marks) "!(PRTA, PRTB)"
(blank) wildcard (*) When a condition is blank, it is considered always true.

    Note:
  • You can use the pound sign (#) to add comments. Only complete lines can be comments; the # character must be in the first position in the line.
  • Spaces can separate keyword characters from condition values.
  • When setting positional properties, you can choose one of these two formats: property-name[process-name][phase-name][step-name] or [phase-name][step-name]. You cannot use positional properties to set other properties.
  • The ? and * characters are wildcard characters used with the like and not like conditions. The question mark matches single characters and the asterisk matches any number of characters.
  • You can use RICOH ProcessDirector symbol notation in the conditions file to set conditions or assign values based on the current value of a particular document or job property. See the topic titled RICOH ProcessDirector symbol notation in the Information Center for a description of symbol notation syntax. You can also use symbol notation with literal string values; see below for more information.
  • If a condition field has an equal sign (=) without a value, the condition is true if the job's property value is null. If a field has an empty value, the property is ignored for that row; it is not part of any condition and its value is not changed. Because of this rule, the step cannot set a job property to null. To set a property to null manually, use the expression ${null}.
  • Each row is evaluated independently.
  • All rows with conditions that match a job's or document's properties are applied. The rows are applied in the order that they occur in the conditions file. Within each row, property values are applied from left to right.
  • Leading and trailing blanks are removed from field values before any comparison or set operation takes place. Blanks within a value (not leading or trailing) are retained.
Using a segment of a property value with symbol notation and the substring specifier

If you want to use only a portion of a property in a condition - such as using only the first 5 characters of a property's value - you can use the substring specifier to indicate the portion of the property that you want to use.

The syntax is:

  • ${property_name;substr;start;length}
where:
  • property_name is the name of the property, such as Job.Name.
  • start is the position in the string that you want to start from.
  • length is the number of characters to use in the condition; if you enter a length that is more than the number of characters in the property, the rest of the property is used.

    Note:
  • The string is zero-base indexed; for example, the first character is in position 0 and the fifth character is in position 4.

This table shows some examples:

Examples of substring values
Property conditions file contains... Property value Result
${Job.Name;substr;0;4} Job.Name = USPS-FullService USPS
${Job.Name;substr;5;8} Job.Name = USPS-OversizeFlat Oversize

Creating concatenated values with symbol notation

In addition to using symbol notation to set conditions or assign values based on the current value of a particular property, you can combine symbols to create a concatenated single value, or use them with literal strings.

This table shows some examples:

Examples of concatenating property values
Property conditions file contains... Actual property values Result
Job.Custom.A,Job.Custom.Z

${Job.Custom.D}${Job.Custom.E},4

Job.Custom.D=5 and Job.Custom.E=9 Job.Custom.A=59

Job.Custom.Z=4

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE

=USPS,${Job.Custom.D} Flat,No

Doc.Custom.MailCategory=USPS and Job.Custom.D=Oversize

Job.Name=Oversize Flat

Doc.Run.PAVE=No

Setting values without defining conditions

The format of the conditions file is the same, with a header row that contains property database names and a second row that lists property values. However, the conditions file contains only two rows. If you include more than one row of property values, only the values specified in the last row are saved.

This example shows the contents of a property conditions file that sets property values without using conditions:

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE
USPS,PostalDiscount,Yes

Setting values with a separate include file

If you have a collection of properties that remain the same for several workflows, you can define those properties in a separate include file that you refer to in the property conditions file.

To refer to a separate include file, put @include in the header row of the property conditions file, and specify the relative or absolute path to the include file in the second row of the property conditions file.

    Important:
  • Use the Linux delimiting character (/) to specify the absolute directory path to the include file on a Windows system. For example, if the include file on a Windows system is at C:\Projects\data.txt, specify /Projects/data.txt.

This example shows the contents of a property conditions file that contains @include and a path to a separate include file:

Doc.Custom.MailCategory,Job.Name,@include
USPS,Priority,../prop-assignments/usps-properties.txt

In this example, the Mail Category property is assigned the value of USPS, the Job Name property is assigned the value Priority, and the relative path to the include file usps-properties.txt is specified.

The include file defines property values using the format Property name = Value. This example shows the format of the include file:

Doc.Insert.RecipientName=George Rogers
Job.CustomerName=CerbCo

The conditions file is processed from left to right and from top to bottom. This table contains examples to show how the property conditions file and the include file can override properties that were previously set. (These examples are for illustration only and are not intended as actual uses of the conditions file.)

Examples of processing order for the conditions file and include file
Property conditions file contains... Include file contains... Result
Job.Name,@include

=,../prop-assignments/usps-properties.txt

Job.Name=FlatFold If the Job Name is not already defined, the include file defines it as FlatFold.
Doc.Custom.Zip, Doc.Custom.Location, Doc.Custom.Location, @include

<50000, EAST, NEW HAMPSHIRE, /Projects/data.txt

Job.CityPopulation = 42400 If Zip is <50000, the conditions file sets Location = EAST, then the conditions file sets Location = NEW HAMPSHIRE, then the include file /Projects/data.txt sets CityPopulation = 42400.

Doc.Custom.Location = NEW HAMPSHIRE

Job.CityPopulation = 42400

Doc.Custom.Zip, Doc.Custom.Location, @include, Doc.Custom.Location

<50000, EAST, /Projects/data.txt, NEW HAMPSHIRE

Doc.Custom.Location = CONCORD

Job.CityPopulation = 42400

If Zip is <50000, the conditions file sets Location = EAST, then the include file /Projects/data.txt sets Location = CONCORD and CityPopulation = 42400, then the conditions file sets Location = NEW HAMPSHIRE.

Doc.Custom.Location = NEW HAMPSHIRE

Job.CityPopulation = 42400

Doc.Custom.Zip, Doc.Custom.Location, @include, @include

<50000, EAST, /Projects/data.txt, /Projects/data2.txt

/Projects/data.txt

Doc.Custom.Location = CONCORD

Job.CityPopulation = 42400

/Projects/data2.txt

Doc.Custom.Location = US ROUTE 202

Job.CityPopulation = 52400

If Zip is <50000, the conditions file sets Location = EAST, then the include file /Projects/data.txt sets Location = CONCORD and Population = 42400, then the include file /Projects/data2.txt sets Location = US ROUTE 202 and CityPopulation = 52400.

Doc.Custom.Location = US ROUTE 202

Job.CityPopulation = 52400

    Note:
  • You can use RICOH ProcessDirector symbol notation as part of the include file name. For example, if you use the include file name ${Job.RequestedPrinter}.equipmentprops.txt, the system can choose the correct set of properties to define for each requested printer (for each value of Job.RequestedPrinter). See the related Reference topic for a description of symbol notation syntax.

1.2.10.26.14 File system mapping file for job tickets

The sample system_map.cfg found in /aiw/aiw1/samples/config/ translates the file paths in JDF job tickets to the file paths of a mounted file system. You can copy this file into the /aiw/aiw1/control_files/config/ directory and edit it as necessary.

Each line of the file system mapping file is in this format:

client_file_path;host_file_path
client_file_path
The client file path is the file path as it appears in the job ticket. It must include at least one backslash (\) or slash (/) character. It can include an asterisk (*) as a wild card representing the drive letter.
host_file_path
The host file path is the file path where the RICOH ProcessDirector server can locate input files. It must include at least one backslash (\) or slash (/) character. It must not include wild cards.

This line converts any Windows file path to a Linux file path:

*:\;/

Example

Suppose that the file system mapping file contains these lines:

C:\production\siteA;/BankFiles/prod
*:\production\siteA\test;/BankFiles/test
*:\;/

The job ticket refers to a file called C:\production\siteA\test\justAtest.pdf. RICOH ProcessDirector searches for justAtest.pdf in these directories:

  1. /BankFiles/prod/test/
  2. /BankFiles/test/
  3. /production/siteA/test/
  4. The staging location of the hot folder input device

1.2.10.27 Supplied utilities

Some features provide utilities that help you configure RICOH ProcessDirector or troubleshoot jobs.

Utilities provided by features are listed here.

1.2.10.27.1 cmt utility: Builds color mapping table source and object files

The Color Mapping Table Utility (cmt) generates source and object files. If the input file is an object color mapping table, cmt generates a source file. If the input file is a source file, cmt generates an object file. Object color mapping tables are used to map OCA (Object Content Architecture) colors and fills to printer-specific colors.
Syntax
cmt
-iinput file
-ooutput file
-ninternal CMT name
-t
cmt -i input file [-o output file] [-n internal CMT name] [-t]
Flags

The cmt utility uses these flags:

-iinput file
The file name of the input file. The input file can be a source or object file. When you use the cmt utility, you must specify this flag.
-ooutput file
The file name of the output file. If this flag is not specified, standard output (stdout) is used. This is an optional flag.
-ninternal CMT name
The name that appears on the MO:DCA Begin Object Container (BOC) structured field. This is an optional flag.
-t
Use this flag to turn on trace. This is an optional flag.
Color mapping table source file

The source file describes the contents of the color mapping table object file.

Each mapping definition of one source color or fill to a target color is bracketed by the keywords BeginMappingDef: and EndMappingDef:. The cmt utility requires one mapping definition for each source target mapping.

Each source definition in a mapping definition is bracketed by the keywords BeginSourceDef: and EndSourceDef:. The cmt utility requires one source definition for each mapping definition. Valid keywords and values for a source definition are:

ColorSpace
Specify OCA, Highlight, or GOCA.
ColorValue
Specify a value that depends on the value of ColorSpace:
  • When ColorSpace=OCA, ColorValue has one component, one of the values from this list; for example, ColorValue: Red:
    • Black
    • Blue
    • Brown
    • Cyan
    • Dark_Blue
    • Dark_Green
    • Dark_Turquoise
    • Default
    • Gray
    • Green
    • Magenta
    • Medium
    • Mustard
    • Orange
    • Pink
    • Purple
    • Red
    • Turquoise
    • White
    • Yellow
      Note:
    • The cmt utility supports the binary representation for all OCA colors.
    • When you specify the colors that are two words, specify an underscore between the two words; for example, Dark_Blue.
  • When ColorSpace=Highlight, ColorValue has one component, an integer from 0 through 3; for example: ColorValue: 2.
  • When ColorSpace=GOCA, ColorValue has one component, an integer from 0 through 16 or from 0 through 64; for example: ColorValue: 13.

Each target definition in a mapping definition is bracketed by the keywords BeginTargetDef: and EndTargetDef:. The cmt utility requires one target definition in each mapping definition. Valid keywords and values for a target definition are:

ColorSpace
Specify RGB, CMYK, Highlight, or CIELAB.
ColorValue
Specify a value that depends on the value of ColorSpace:
  • When ColorSpace=RGB, ColorValue has three components. Each component is an integer from 0 through 255; for example, ColorValue: 33 167 247.
  • When ColorSpace=CMYK, ColorValue has four components. Each component is an integer from 0 through 255; for example, ColorValue: 135 26 37 255.
  • When ColorSpace=CIELAB, ColorValue has three components. The first component is an integer from 0 through 100; and the second and third components are integers from -127 through 127; for example, ColorValue: 65 -120 111.
PercentShading
Valid values are integers from 0 through 100. This value is optional. The default is 100.
PercentCoverage
Valid values are integers 0 through 100. This value is optional. The default is 100.

1.2.10.27.2 itm_driver command syntax

itm_driver is a command-line application that you can use to send jobs with their properties to a Ricoh transform server.
Syntax
itm_driver-Sserver_address-Pport_number-F-itm_in_filesfilename1 [,filename2,...]-itm_out_filesfilename3 [,filename4,...]-stransform_ID [-tfilename] [-rnumber] [-Llocale] [-Eencoding] [-Cfilename]
Flags

-S server_address
The Ricoh transform server IP address or host name.
-P port_number
The Ricoh transform server port number.
-F “-itm_in_files filename -itm_out_files filename
An input and output file for the transform. Include the full path to each file. Enclose the value after the flag in double quotation marks. You can include other options inside the quotation marks as well. Those options vary based on the transform that you use.
-s [transform_ID]
The ID of the transform to use, based on the type of input file submitted. Valid values are:
8000
Converts JPEG, GIF, and TIFF image files to AFP.
8009
Converts DSC-compliant PostScript to AFP.
8010
Converts Encapsulated PostScript to AFP.
8011
Converts PostScript to AFP.
8012
Converts PDF to AFP using the CPSI transform.
8013
Converts PDF to AFP using the Monza transform.
8033
Converts PCL to AFP.
8040
Converts AFP to PDF.
8050
Converts SAP output to AFP.
9000
The Transform Feature detects the type of input file submitted and chooses the correct transform.
-t filename
Enables tracing for the Ricoh transform driver. The value of filename is the path to a log file that the driver writes trace information into. The path can be absolute or relative. This flag is optional.
-r n
Tells the Ricoh transform to report status after it transforms the specified number of pages. The value of n is the number of pages transformed. After the specified number of pages has been transformed, a message is written to stdout. This flag is optional.
-L locale
The language for messages from the Transform Feature. This flag is optional. Valid values for locale are:
de_DE
German
en_US
English
es_ES
Spanish
fr_FR
French
it_IT
Italian
ja_JP
Japanese
pt_BR
Brazilian Portuguese
-E encoding
The encoding for messages from the Transform Feature. This flag is optional. The only valid value for encoding is utf8.
-C filename
The path to a control file that specifies options for this command. The control can be used instead of the command flags. If you specify a control file, the values in the control file override any corresponding values specifies on the command. This flag is optional.

Example

This command sends a job to the local Transform server (localhost) on port 6986. D:\afp\chateau.afp is the input file and D:\out.pdf is the output file. The transform ID 9000 instructs the Transform program to choose the correct transform based on the type of input file.

itm_driver-S localhost-P 6986-F "-itm_in_files D:\afp\chateau.afp -itm_out_files D:\out.pdf" -s 9000

Control file syntax

If you choose store transform option in a control file and use the -C flag, use these attribute/value pairs in the control file.

Enter each item on a separate line.

server = server_address
Ricoh transform server IP address or host name. Corresponds to the -S flag.
port = port_number
Ricoh transform server port number. Corresponds to the -P flag.
trans_flags
The list of input and output files. Corresponds to the -F flag. The value must be written in this format:
trans_flags = {
	-itm_in_files = filename1
	-itm_out_files = filename2
	...
}
transform_id = transform_ID
IThe transform ID. Corresponds to the -s flag. Refer to the previous list for valid values.
trace = filename
Enables tracing for the Ricoh transform driver program. Corresponds to the –t flag. This item is optional.
page_report = n
Tells the Ricoh transform to report status after it transforms the specified number of pages. The value of n is the number of pages transformed. After the specified number of pages has been transformed, a message is written to stdout. This flag is optional.
cat_dir = path
Specifies the path for the message catalog. This item is optional.
Example

This command uses a control file to complete the same action as the previous example. The command uses a control file to send a job to the local Transform server (localhost) on port 6986. D:\afp\chateau.afp is the input file and D:\out.pdf is the output file. The transform ID 9000 instructs the Transform driver program to choose the correct transform based on the type of input file.

itm_driver -C D:\cfile.ctl

The contents of cfile.ctl are:

server = localhost
port = 6986
transform_id = 9000
trans_flags = {
-itm_in_files = D:\afp\chateau.afp
-itm_out_files = D:\out.pdf
}

1.2.10.28 Examples for processing orders in an XML file

This topic contains examples of XML input files, XPath expressions, XSLT style sheets, and RICOH ProcessDirector overrides files produced by the XSLT style sheets. These examples work with the usage scenario for processing orders in an XML file.
XML input file

<?xml version="1.0" encoding="utf-8"?>
<seller id="000364">
  <order number="00060310">
      <customername>Metropolis Real Estate</customername>
      <shipto>
           <address1>100 Main St</address1>
           <address2>></address2>
           <city>Metropolis</city>
           <state>OH</state>
           <zip_code>45416</zip_code>
      </shipto>
      <item number="001">
            <printfile>http://www.metropolishomeexperts.com/brochures/br096.pdf</printfile>
            <quantity>10</quantity>
      </item>
      <item number="002">
            <printfile>http://www.metropolishomeexperts.com/posters/po014.pdf</printfile>
            <quantity>5</quantity>
      </item>
      <item number="003">
            <stock number="mug036"></stock>
            <quantity>5</quantity>
      </item>
  </order>
  <order number="00060311">
      <customername>Town Point Realty</customername>
      <shipto>
           <address1>450 Broadway</address1>
           <address2>Suite 12</address2>
           <city>Parkview</city>
           <state>IL</state>
           <zip_code>60404</zip_code>
      </shipto>
      <item number="001">
           <printfile>http://http://www.townpointrealty.com/print/0196.pdf</printfile>
           <quantity>20</quantity>
      </item>
      <item number="002">
            <stock number="cap0342"></stock>
            <quantity>10</quantity>
      </item>
  </order>
</seller>

Note: To keep the sample XML input file from causing errors in the DownloadFile step, substitute URLs to print files at your web site for the URLs in the sample.

First Xpath expression

/seller/order

XML files created for jobs
Order number 00060310
<?xml version="1.0" encoding="UTF-8"?>
<order number="00060310">
      <customername>Metropolis Real Estate</customername>
      <shipto>
           <address1>100 Main St</address1>
           <address2>></address2>
           <city>Metropolis</city>
           <state>OH</state>
           <zip_code>45416</zip_code>
      </shipto>
      <item number="001">
            <printfile>http://www.metropolishomeexperts.com/brochures/br096.pdf</printfile>
            <quantity>10</quantity>
      </item>
      <item number="002">
            <printfile>http://www.metropolishomeexperts.com/posters/po014.pdf</printfile>
            <quantity>5</quantity>
      </item>
      <item number="003">
            <stock number="mug036"/>
            <quantity>5</quantity>
      </item>
  </order>
Order number 00060311
<?xml version="1.0" encoding="UTF-8"?>
<order number="00060311">
      <customername>Town Point Realty</customername>
      <shipto>
           <address1>450 Broadway</address1>
           <address2>Suite 12</address2>
           <city>Parkview</city>
           <state>IL</state>
           <zip_code>60404</zip_code>
      </shipto>
      <item number="001">
           <printfile>http://www.impactonthenet.com/buildsales.pdf</printfile>
           <quantity>20</quantity>
      </item>
      <item number="002">
            <stock number="cap0342"/>
            <quantity>10</quantity>
      </item>
  </order>
XSLT style sheet for first ApplyXSLTransform step

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0">
    <xsl:output method="text" encoding="UTF-8"/>
    <xsl:template match="/">
        <xsl:variable name="var1_initial" select="."/>
        <xsl:for-each select="order">
            <xsl:variable name="var2_current" select="."/>
            <xsl:value-of select="concat('Job.Info.Attr1=', @number, '&#10;', 'Job.CustomerName=', customername)"/>
        </xsl:for-each>
    </xsl:template>
</xsl:stylesheet>

Overrides files created by first ApplyXSLTransform step

Order number 00060310
Job.Info.Attr1=00060310Job.CustomerName=Metropolis Real Estate
Order number 00060311
Job.Info.Attr1=00060311Job.CustomerName=Town Point Realty

Second XPath expression

/order/item/printfile/ancestor::item

XML files created for print item jobs

When the XML input file contains order number 00060310, RICOH ProcessDirector creates these XML files.

Item 001
<?xml version="1.0" encoding="utf-8"?>
<item number="001">
     <printfile>http://www.metropolishomeexperts.com/brochures/br096.pdf</printfile>
     <quantity>10</quantity>
</item>
Item 002
<?xml version="1.0" encoding="utf-8"?>
<item number="002">
     <printfile>http://www.metropolishomeexperts.com/posters/po014.pdf</printfile>
     <quantity>5</quantity>
</item>

Third XPath expression

/order/item/stock/ancestor::item

XML file created for promotional item job

When the XML input file contains order number 00060310, RICOH ProcessDirector creates this XML file.

<?xml version="1.0" encoding="utf-8"?>
<item number="003">
     <stock number="mug036"/>
     <quantity>5</quantity>
</item>

XSLT style sheet for second ApplyXSLTransform step (print items)

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0">
    <xsl:output method="text" encoding="UTF-8"/>
    <xsl:template match="/">
        <xsl:variable name="var1_initial" select="."/>
        <xsl:for-each select="item">
            <xsl:variable name="var2_current" select="."/>
            <xsl:value-of select="concat('Job.DownloadFile=', printfile, '&#10;', 'Job.Copies=', quantity)"/>
        </xsl:for-each>
    </xsl:template>
</xsl:stylesheet>

Overrides files created by second ApplyXSLTransform step

Item 001
Job.DownloadFile=http://www.metropolishomeexperts.com/brochures/br096.pdfJob.Copies=10
Item 002
Job.DownloadFile=http://www.metropolishomeexperts.com/posters/po014.pdfJob.Copies=5

XSLT style sheet for third ApplyXSLTransform step (promotional items)

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0">
    <xsl:output method="text" encoding="UTF-8"/>
    <xsl:template match="/">
        <xsl:variable name="var1_initial" select="."/>
        <xsl:for-each select="item">
            <xsl:variable name="var2_current" select="."/>
            <xsl:value-of select="concat('Job.Info.Attr2=', stock/@number, '&#10;', 'Job.Copies=', quantity)"/>
        </xsl:for-each>
    </xsl:template>
</xsl:stylesheet>

Overrides file created by third ApplyXSLTransform step

Job.Info.Attr2=mug036Job.Copies=5

1.2.10.29 Default tables in the Reports database

By default, one database containing these database tables are defined by the data collectors supplied with the Reports feature.
Database Table Purpose Default Properties
job_history Holds the values of job properties specified in the Job Step Progress collector. Values are stored at the beginning and end of processing in each step of a workflow.
  • Job.Instance
  • Job.TotalSheets
  • Job.TotalPages
  • Job.SubmitTime
  • Job.JobType
  • Job.PersistenceID
  • Job.InputDatastream
  • Job.InputFile
  • Job.CustomerName
  • Job.RetainDuration
  • Job.Promote
  • Job.PromoteTime
  • Job.ParentJob
  • Job.FileReceiptTime
  • Job.SourceInputDeviceName
  • Job.JobSize
  • Job.RequestedPrinter
  • Job.Destination
  • Job.Form
  • Job.Class
  • Job.Duplex
  • Job.Copies
  • Job.Name
  • Job.PreviousPrinter
  • Job.ReprintCount
  • Job.Info.Attr1
  • Job.Info.Attr2
  • Job.Info.Attr3
  • Job.Info.Attr4
  • Job.Info.Attr5
job_printing Holds the values of job and printer properties specified in the Job Print Progress collector. Values are stored when a job starts printing and when it finishes printing successfully.
  • Job.ID
  • Job.PersistenceID
  • Job.Phase
  • Job.Process
  • Job.Step
  • Job.State
  • Job.Instance
  • Job.JobType
  • Job.TotalSheets
  • Job.TotalPages
  • Job.Priority
  • Job.InputDatastream
  • Job.CustomerName
  • Job.Locations
  • Job.SystemName
  • Job.JobSize
  • Job.Media
  • Job.Staple
  • Job.Punch
  • Job.OutputBin
  • Job.RealPageRange
  • Job.Print.EndPrintTime
  • Job.Info.Attr1
  • Job.Info.Attr2
  • Job.OutputFormat
  • Job.Ink.Cyan
  • Job.Ink.Magenta
  • Job.Ink.Yellow
  • Job.Ink.Black
  • Job.SheetsStacked
  • Job.PagesStacked
  • Job.CopiesStacked
  • Job.CurrentPrinter
  • Job.Destination
  • Job.Form
  • Job.Class
  • Job.Duplex
  • Job.Copies
  • Job.Name
  • Job.Print.AssignPrintTime
  • Job.ReprintCount
  • Job.PreviousPrinter
  • Printer.ID
  • Printer.CustomerName
  • Printer.Description
  • Printer.Destination
  • Printer.DeviceModelSNMP
  • Printer.Instance
  • Printer.Locations
  • Printer.Model
  • Printer.Model.Specific
  • Printer.OutputFormat
  • Printer.SerialNumber
  • Printer.SystemName
  • Printer.Version
job_step_durations Holds the values of job properties specified in the Job Step Duration collector. Values are stored at the completion of each step in the workflow.
  • Job.Class
  • Job.Copies
  • Job.CustomerName
  • Job.Destination
  • Job.Duplex
  • Job.FileReceiptTime
  • Job.Form
  • Job.JobSize
  • Job.JobType
  • Job.Info.Attr1
  • Job.Info.Attr2
  • Job.Info.Attr3
  • Job.Info.Attr4
  • Job.Info.Attr5
  • Job.InputDatastream
  • Job.InputFile
  • Job.Insert.ReconcileUser.ID
  • Job.Instance
  • Job.Locations
  • Job.Name
  • Job.ParentJob
  • Job.PersistenceID
  • Job.PreviousPrinter
  • Job.Priority
  • Job.Promote
  • Job.PromoteTime
  • Job.RequestedPrinter
  • Job.ReprintCount
  • Job.RetainDuration
  • Job.ScheduleUserId
  • Job.SourceInputDeviceName
  • Job.SubmitTime
  • Job.TotalPages
  • Job.TotalSheets
printer_status Holds the values of printer properties specified in the Printer Status collector. Values are stored each time that the Enabled status or Printer status changes.
  • Printer.Status
  • Printer.ID
  • Printer.CustomerName
  • Printer.Description
  • Printer.Destination
  • Printer.DeviceModelSNMP
  • Printer.Instance
  • Printer.Locations
  • Printer.Model
  • Printer.Model.Specific
  • Printer.OutputFormat
  • Printer.SerialNumber
  • Printer.SystemName
  • Printer.Version
barcode_reader_actions Holds the values of barcode reader and user properties specified in the User Actions on Barcode Readers collector.
  • BarcodeReader.ID
  • BarcodeReader.Description
  • BarcodeReader.Location
  • User.ID
  • User.Description
  • User.Groups
  • User.Location
input_device_actions Holds the values of input device and user properties specified in the User Actions on Input Devices collector.
  • InputDevice.ID
  • InputDevice.Type
  • InputDevice.Locations
  • InputDevice.Description
  • User.ID
  • User.Description
  • User.Groups
  • User.Location
inserter_actions Holds the values of inserter controller and user properties specified in the User Actions on Inserters collector.
  • InserterController.ID
  • InserterSystem.Location
  • InserterSystem.Description
  • User.ID
  • User.Description
  • User.Groups
  • User.Location
job_actions Holds the values of job and user properties specified in the User Actions on Jobs collector.
  • Job.ID
  • Job.Name
  • Job.JobType
  • Job.ParentJob
  • Job.Info.Attr1
  • Job.Info.Attr2
  • Job.Info.Attr3
  • Job.Info.Attr4
  • Job.Info.Attr5
  • User.ID
  • User.Description
  • User.Groups
  • User.Location
printer_actions Holds the values of printer and user properties specified in the User Actions on Printers collector.
  • Printer.ID
  • Printer.TCPIP.Address
  • Printer.Type
  • Printer.Description
  • Printer.Destination
  • Printer.DeviceModelSNMP
  • Printer.Instance
  • Printer.Locations
  • Printer.Model
  • Printer.Model.Specific
  • Printer.SerialNumber
  • Printer.Version
  • User.ID
  • User.Description
  • User.Groups
  • User.Location
user_actions Holds the values of user and target user properties specified in the User Actions on Users collector.
  • User.ID
  • User.Description
  • User.Groups
  • User.Location
Additional database tables
The WritePropsToReportsDatabase step also stores property values in database tables. The step always stores these job property values in the database tables that you specify for the Job properties table and Document properties table properties:
  • Job.ID
  • Job.Phase
  • Job.Process
  • Job.Reports.EventType
  • Job.State
  • Job.Step
You choose the names of those tables when you add the step to a workflow. The default table names are:
  • job_workflow_props

    In addition to the properties listed above, the step stores property values for the job properties that you select in the Job properties to write field.

  • doc_workflow_props

    In addition to the properties listed above, the step stores document property values for the document properties that you select in the Document properties to write field.

Property values are stored every time the step runs.

    Note:
  • Some properties have blank values until the job passes a certain point in a workflow. If the WritePropsToReportsDatabase step runs before a value is set for a property, the property name is included as a column in the database table, but no value is recorded.

1.2.10.30 Database property names

RICOH ProcessDirector messages might refer to properties by their database names instead of the field names that appear in property notebooks. Most of the database property names are similar to the names in the property notebooks, but they are written in a different format.

When you install RICOH ProcessDirector features, you add additional database properties. Lists of these database property names are found in the Information Center for RICOH ProcessDirector.

1.2.10.30.1 Database property names for barcode formats

Messages about barcode formats might refer to properties by their database names. You can use the database property names in symbol formulas and in control files.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Barcode format properties
Database name Tab name: field name Brief description Editable
BarcodeFormat.ID General: Barcode format name Specifies the name of the barcode format. Yes
BarcodeFormat.Description General: Barcode format description Describes the barcode format. Yes

1.2.10.30.2 Database property names for groups

Messages about security groups might refer to properties by their database names, which begin with Group.

In the Editable column:

  • Yes means that a user can change the value after the group is created.
  • No means that a user cannot change the value.

Group properties
Database name Field name Brief description Editable
Group.Actions Allowed actions Lists the actions that users in this group are authorized to do. Yes
Group.Attributes Allowed attributes Lists the object properties that users in this group are authorized to edit. Yes
Group.Description Group description Contains text that describes the group. Yes
Group.ID Displayed in the page title Contains the name of the group. No
Group.SourceID Group source ID Contains the name of the group that this group was copied from. No

1.2.10.30.3 Database property names for input devices

Messages about input devices might refer to properties by their database names. Some properties are specific to Hot folder input devices; their database property names begin with HotFolder. Others are specific to Download input devices; their database property names begin with zOSDownload. Properties whose names begin with InputDevice apply to all types of input devices.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the input device has been created.
  • No means that an authorized user cannot change the value.

Input device properties
Database name Notebook tab: field name Brief description Internal values Editable
HotFolder.CodePage General: Device code page The code page that the input device uses to read the contents of any files that accompany the print files, such as trigger files and list files.
  • euc_jp
  • iso8859_1
  • iso8859_15
  • utf8
Yes
HotFolder.SetPattern Batching: Matching pattern for sets Specifies the file name pattern that an input device uses when it creates sets. This pattern is a regular expression that indicates the portion of the input file names that must match within a set. The input files that make up a set are determined by the values for the Data patterns, JDF patterns, Overrides patterns, and File Patterns properties.   Yes
InputDevice.BatchingMethod Batching: Batching method Specifies how the input device groups multiple input files or sets of files and submits them as a single job or parent and child jobs. You can change this value for Hot folder input devices, but not for Download input devices or for LPD input devices.
  • AutoBatch
  • JDF
  • ListFile
  • MVSOutGrp
  • None
  • PatternBased
  • NumberOfFiles
  • NumberOfPages
  • NumberOfSets
  • PagesInSets
  • SetsByTime
  • Time
Yes (HotFolder) No (Download, LPD)
InputDevice.Child.InitJobTypeStep General: Child workflow initialization step Specifies the name of the step that the input device uses to initialize the workflow for single jobs or child jobs, convert an optional overrides file submitted with a job to a text file in property name=value format for setting job properties, or both.   Yes
InputDevice.Child.JobType General: Child workflow Specifies the name of the workflow that the input device assigns to jobs that contain only a single file or jobs that are children of a parent job.   Yes
InputDevice.Child. JobType ParsingRules Advanced: Child workflow parsing rules Contains the path and file name of a control file.   Yes
InputDevice.Child. JobTypeFilename Pattern Advanced: Child workflow pattern Contains a pattern-matching string that indicates what part of the file name should be used for the workflow for single and child jobs.   Yes
InputDevice. ConvertOverrides Advanced: Convert overrides Specifies whether a control file is required to convert the overrides file submitted with a job to a job properties file in RICOH ProcessDirectorproperty name=value format.
  • No
  • Yes
Yes (HotFolder) No (Download, LPD)
InputDevice.CreateZip Batching: Create .zip file Specifies whether the input device submits data files as individual jobs or collects them in a .zip file and submits them as a single job.
  • No
  • Yes
Yes
InputDevice.Description General: Input device description Contains text that describes the input device.   Yes
InputDevice.Enabled Status: Enabled status Specifies whether this input device can submit input files that it receives to create the corresponding RICOH ProcessDirector jobs.
  • No
  • Yes
No
InputDevice.FileCompletion Advanced: Completion method Specifies how the input device determines that file transmission is complete for an input file.
  • CheckOpen
  • CheckSize
  • None
  • Trigger
Yes (HotFolder) No (Download, LPD)
InputDevice.FileDataPatterns Batching: Data patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify the input files that the input device should accept for processing as single jobs.   Yes (HotFolder) No (Download, LPD)
InputDevice.FileJDFPatterns Batching: JDF patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify Job Definition Format (JDF) job tickets.   Yes (HotFolder) No (Download, LPD)
InputDevice.FileListPatterns Batching: List patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify list files.   Yes (HotFolder) No (Download, LPD)
InputDevice.FileOtherPatterns Batching: Overrides patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify files that it must process with a list file and the input files that the list file specifies, or with another single input file.   Yes (HotFolder) No (Download, LPD)
InputDevice. FileTrigger Patterns Advanced: Trigger patterns Contains one or more user-defined pattern-matching strings that RICOH ProcessDirector uses to identify trigger files.   Yes (HotFolder) No (Download, LPD)
InputDevice.FolderLocation General: Folder location Contains the name of the directory that the input device monitors for incoming jobs.   Yes
InputDevice.Frequency Batching: Batching interval Indicates the time interval used to submit a batch of input files.   Yes
InputDevice.ID Displayed in the property notebook title Contains the name of the input device.   No
InputDevice.InitJobTypeStep General: Workflow initialization step Specifies the name of the step that the input device uses to initialize the parent workflow for the input files that the input device receives, convert an optional overrides file submitted with a job to a text file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both.   Yes
InputDevice.Instance General: Parent server Specifies the name of the RICOH ProcessDirector server that receives and records messages for this input device.   Yes
InputDevice.JobType General: Workflow Specifies the name of the workflow that the input device assigns to the job.   Yes
InputDevice. JobTypeFilename Pattern Advanced: Parent workflow pattern Contains a pattern-matching string that indicates what part of the file name should be used for the workflow for the parent job.   Yes
InputDevice. JobTypeParsing Rules Advanced: Parent workflow parsing rules Contains a path and file name of a control file.   Yes
InputDevice.LastModified General: Last modified The date and time that the input device was last changed.   No
InputDevice.Locations General: Input device location Contains the location associated with the input device.   Yes
InputDevice.MaxErrors General: Maximum errors Contains the number of communication errors that can occur for the input device before RICOH ProcessDirector disables the input device.   Yes
InputDevice.ModifiedBy General: Modified by user Specifies the user name of the user who made the last change to this input device.   No
InputDevice.NumberOfFiles Batching: Number of files to batch Specifies the number of files that are combined in a single submission when you choose the Number batching method in the General tab.   Yes
InputDevice.NumberOfPages Batching: Number of pages to batch Specifies the maximum number of PDF pages that should be combined in a single submission when you choose the Pages batching method in the General tab.   Yes
InputDevice.PageThreshold Batching: Exceed pages to batch Specifies whether the Hot folder should include the file that exceeds the value for the Number of pages to batch property when it submits a collection of PDF files.   Yes
InputDevice.PollInterval General: Polling interval (unit) Specifies the time interval at which RICOH ProcessDirector checks for files in the directory that the Folder location property of the Hot folder input device specified.   Yes
InputDevice.ScheduleDaily Batching: Frequency (days) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleHourly Batching: Frequency (hours) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleMinute Batching: Frequency (minutes) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleMonthly Batching: Frequency (months) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleWeekly Batching: Frequency (weeks) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.StagingLocation General: Staging location Contains the name of the directory into which the input device moves the input file before submitting it as a job.   Yes
InputDevice.StartDate Batching: Batching start date Specifies the date when the Time batching method takes effect for the input device.   Yes
InputDevice.StartDateAndTime Batching: Batching start date and time Specifies the date and time when the Time or Sets by time batching method takes effect for the input device.   Yes
InputDevice.Status Status: Connection status Lists the current status of the input device: connected, disconnected, or unable to connect.
  • Connected
  • Disconnected
  • UnableToConnect
No
InputDevice.SubmitStep General: Submit step Contains the name of the submit step to which the input device sends the input file for job processing.   Yes
InputDevice.WaitingFileCount Status: Input files waiting Contains the number of input files that the input device has received but has not yet submitted to create the corresponding RICOH ProcessDirector jobs.   No
InputFilePattern.FilePattern Batching: File Pattern Specifies one or more file pattern-matching strings.   Yes
InputFilePattern.Required Batching: File pattern required Specifies whether a file that matches the input file pattern must exist in the Hot folder before submitting the job.
  • No
  • Yes
Yes
InputFilePattern.Sequence Batching: File pattern sequence Specifies the priority of the file pattern. Patterns are checked in this order.   Yes
InputFilePattern.SpoolFileType Batching: Spool file type Specifies the content or the data stream type of the file.   Yes
InputFilePattern.SpoolFileUsage Batching: Spool file usage Specifies the purpose or role of the file within the job.   Yes
LPD.Codepage General: Device code page Specifies the code page that the LPD input device uses to read the contents of any files that accompany the print files, such as control files and list files.
  • euc_jp
  • iso8859_1
  • iso8859_15
  • utf8
Yes

1.2.10.30.3.1 Database property names for web service input devices

Some parts of the system and messages about web service input devices refer to properties by their database names. If a property is specific to REST web service input devices, its database property name begins with REST. Properties whose names begin with WebService apply to both REST and SOAP web service input devices.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you set the value of a property in an overrides file or an external program, use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the input device has been created.
  • No means that you cannot change the value.

Web service input device properties
Database name Notebook tab: field name Brief description Internal values Editable
RESTWebService.AuthRequestHeader Authentication: Authentication request header Specifies the HTTP header field the web service input device uses to authenticate to another application.   Yes
RESTWebService.AuthRequestParams Authentication: Authentication request parameters Specifies the parameters the web service input device sends to an external application and receives the authentication back. Examples of these parameters are the user ID and password.   Yes
RESTWebService.AuthResponseContentType Authentication: Authentication response content type Specifies the response format the web service input device receives for authentication.
  • JSON
  • XML
Yes
RESTWebService.RequestHeader Request: Request header Specifies the HTTP header field the web service input device uses to request data for another application.   Yes
RESTWebService.RequestParams Request: Request parameters Specifies the parameters the web service input device sends to an external application.   Yes
RESTWebService.ResponseContentType Request: Response content type Specifies the response format the web service input device receives data in.
  • JSON
  • XML
Yes
WebService.AuthRequestMethod Authentication: Authentication request method Specifies the method type the web service input device calls for authentication.
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Yes
WebService.AuthRequestPayload Authentication: Authentication request payload Specifies the payload to be passed to the specified web service.   Yes
WebService.AuthRequestPwd Authentication: Authentication request password A password that is used to get a single-use credential for a session. You reference the password in the Authentication request payload property as a symbol. The web site returns a token when authentication is successful.   Yes
WebService.AuthRequestURL Authentication: Authentication request URL Specifies the URL that RICOH ProcessDirector uses to authenticate with a web site or application.   Yes
WebService.AuthResponseAttribute Authentication: Authentication response attribute Specifies the XPath or JSONPath to the element in the response to the authentication request that contains the credential for the session. This value is stored as the Static credential for the session.   Yes
WebService.LastSuccessRequestTime Status: Time of last successful request Shows the date and time when the web service input device last successfully requested a response from a web service for an external application.   No
WebService.RequestMethod Request: Request method Specifies the method type the web service input device calls for processing.
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Yes
WebService.RequestPayload Request: Request payload Specifies the payload the web service passes to an external application.   Yes
WebService.RequestURL Request: Request URL Specifies the URL of the web service that the web service input device communicates with.   Yes
WebService.StaticCredential Authentication: Static credential The authorization code that RICOH ProcessDirector uses to connect to an external application that requires multiple-use authentication.   Yes
WebService.UseProxy Request: Use proxy Specifies whether the web service input device communicates through a proxy server.
  • Yes
  • No
Yes

1.2.10.30.3.1.1 Database property names for web service input devices that do not appear in the user interface

Some properties for web service input devices do not appear in the user interface. These properties can be used in RICOH ProcessDirector symbols or for writing external programs.

The Internal values column describes restrictions on property values. If a property has specific internal values, use one of them when you set the property value in an overrides file or an external program.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

Properties for web service input devices that do not appear in the user interface
Database name Brief description Internal values Editable
WebService.Credential The static credential or token that the web service input device transmits with the call to the web service that exchanges data with RICOH ProcessDirector.

To specify the credential or token in the Request payload property, use a symbol for the WebService.Credential property. This example uses XML:

<Token>${WebService.Credential}</Token>

  No
WebService.CurrentRequestTime The date and time when the web service input device last requested a response from a web service for an external application.

RICOH ProcessDirector sets the value of this property at the start of the interval specified by the Polling interval property.

  No

1.2.10.30.4 Database property names for input files

Messages about input files might refer to properties by their database names, which begin with InputFile.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the input file has been created.
  • No means that an authorized user cannot change the value.

Input file properties
Database name Column heading: Input files table Brief description Internal values Editable
InputFile.JobType Workflow Contains the name of the workflow that the input device assigns to the input file when it submits the file for job processing.   No
InputFile.Location Input file Specifies the path to and the name of the input file.   No
InputFile.Status Status Contains the current status of the input file.
  • Error
  • Processing
  • Queued
  • Waiting
No
InputFile.SubmitGroup Group Identifies a member of a set of input files that were submitted as a group through a list file.   No
InputFile.SubmitType Submit type Contains the submission type for the input file.
  • AIWList
  • Data
  • List
  • Other
  • Trigger
 
InputFile.Timestamp Rec'd Contains the date and time when the input file arrived at the input device. Dates and times are stored as Coordinated Universal Time (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No

1.2.10.30.5 Database property names for jobs

Some messages about jobs refer to job properties by their database names, which begin with Job. You can use the database property names for job properties in symbol formulas that you specify for RICOH ProcessDirector external programs. You can also specify symbol formulas for job properties in RICOH ProcessDirector control files.

Some of the values that you see in lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the job has been submitted.
  • No means that you cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket that is used to submit the job.
  • No means that the property cannot be set from values in the job ticket.

Job properties
Database name Notebook tab: field name Brief description Internal values Editable Job ticket
Job.Add.BlankPage Add blank page Adds a blank page at the end of each PDF file with an odd number of pages when combining PDF files contained in a ZIP file.
  • No
  • Yes
Yes No
Job.Collate Print: Collation Specifies the type of collation that the printer uses when printing multiple copies of the job.
  • Not set
  • Off
  • Collate
Yes No
Job.Binding Binding Set the binding settings for the job you are printing.
  • None
  • Perfect
  • Ring
  • Ring and punch
Yes Yes
Job.Cjfx.FailOnMissingXpath XML: Stop when no matching elements Specifies whether a step based on the CreateJobsFromXML step template puts a job in the error state when no elements match the XPath expression.
  • No
  • Yes
Yes No
Job.Cjfx.FileToSplit XML: XML input file Specifies the name of the XML file that a step based on the CreateJobsFromXML step template uses as input to create jobs.   Yes No
Job.Cjfx.TypeOfJob XML: Create as child job Specifies whether a step based on the CreateJobsFromXML step template creates child jobs or independent jobs from the original job.
  • No
  • Yes
Yes No
Job.Cjfx.Workflow XML: Workflow for new jobs Specifies the workflow that a step based on the CreateJobsFromXML step template submits new XML jobs to.   Yes No
Job.Cjfx.Xpath XML: XPath expression to create jobs Specifies an XPath expression that identifies an element. Each time a step based on the CreateJobsFromXML step template finds a matching element in the XML input file, it creates an XML file and submits it as a job.   Yes No
Job.CompressAllFiles Job Defaults tab of RetainCompletedJobs step template property notebook: Compress all files Specifies whether to compress all spool and checkpoint files for the job when the job is retained.   Yes No
Job.CompressFilePatterns Job Defaults tab of CompressFiles step template property notebook: Compress file patterns Specifies the job files that the step compresses.   Yes No
Job.Copies General and Status: Job copies requested Contains the number of job copies that have been requested.   Yes Yes
Job.CopiesStacked Status: Job copies stacked Contains the current number of job copies that have completed printing and that have reached the output stacker of the printer device.   No No
Job.CreateJobFromFiles.JobType Create Job: Workflow Specifies the workflow to use for the child job.   Yes No
Job.CreateJobFromFiles.JobName Create Job: Job name Specifies the name of the child job.   Yes No
Job.CreateJobFromFiles.DestUsage Create Job: Group ID Specifies the role of the destination file.   Yes No
Job.CreateJobFromFiles.DestType Create Job: Group size Specifies the destination file type.   Yes No
Job.CreateJobFromFiles.Source1 Create Job: First source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source2 Create Job: Second source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source3 Create Job: Third source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source4 Create Job: Fourth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source5 Create Job: Fifth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source6 Create Job: Sixth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source7 Create Job: Seventh source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source8 Create Job: Eighth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CurrentPrinter Status: Assigned printer Contains the name of the printer that RICOH ProcessDirector has assigned to print this job.   No No
Job.CustomerName Scheduling: Customer name Identifies the customer who is associated with this job.   Yes Yes
Job.Description General: Job description Contains text that describes the job.   Yes Yes
Job.DownloadFile URL for download file Specifies the URL of the file to download.   Yes No
Job.DownloadFileToCreate Path to downloaded file Specifies the file name and location where RICOH ProcessDirector saves the file.   Yes No
Job.Duplex General: Duplex Indicates whether duplexed printing is active for the job and, if so, the type of duplexed printing.
  • No
  • Tumble
  • Yes
Yes Yes
Job.EJB.SMTPserver SMTP server type Specifies whether you want this step to use the system default email server or an alternate email server.
  • System
  • Alternate
Yes No
Job.EmailAddressBCC Blind copy address One or more email addresses to send a blind copy of the email to.   Yes No
Job.EmailAddressCC Copy address One or more email addresses to send a copy of the email to.   Yes No
Job.EmailAddressTo Recipient address One or more email addresses to send the job to.   Yes No
Job.EmailMessage Message Specifies text to include in the body of the email.   Yes No
Job.Email.PageRange Page range to send Shows a numeric string that describes which pages in the print file are extracted, made into a separate file, and attached to the email.   Yes No
Job.Email.RangeData Stream Page range data stream Specifies the data stream of the print file used to create the file with the page range indicated in the Page range to send property.
  • Use current
  • AFP
  • PDF
Yes No
Job.Email.Secure Connection Secure connection Specifies whether the connection with the mail server should use SSL or TLS security.
  • None
  • SSL
  • TLS
Yes No
Job.EmailSendFrom Sender address The email address used in the From: field of the email.   Yes No
Job.EmailSubject Subject line Specifies the text to include in the subject line of the email.   Yes No
Job.External.CodePage External: External program code page Specifies the code page to use to write the contents of the files that are sent to the external command for processing, such as the control file template. This code page is also used to read messages that the external command writes to stderr and stdout, as well as other files that the external command might create.
  • UTF-8
  • ISO8859_1
  • ISO8859_15
  • EUC_JPEUC_JP
Yes No
Job.External.Command External: External command Specifies a command string that a step can execute during processing.   Yes No
Job.External.ControlFileTemplate External: External control file template Specifies the path and name of the control file template that the external command uses.   Yes No
Job.External.Language External: External program language Specifies what language the external command should use when it returns messages to RICOH ProcessDirector.
  • de_DE
  • en_US
  • es_ES
  • fr_FR
  • it_IT
  • ja_JP
Yes No
Job.External.ValidRCs External: Valid return codes Lists return code values that the external command can issue, that indicate that the command ran successfully. You can specify multiple return code values by separating the values with commas. For example, 0,4.   Yes No
Job.FileToEmail Attachments Specifies the full paths to one or more files that should be attached to the email and sent to the recipients.   Yes No
Job.FoldOptions Fold Options Specifies how to fold the job or large sheets in the job, whether to fold all the sheets together (overlap or collate), and whether the front side of the sheet ends up on the outside, rather than the inside, of the fold.
  • None
  • Z fold
  • Z fold for large paper
  • Double parallel fold
  • Gate fold
  • Letter fold in
  • Letter fold out
  • Saddle
  • Saddle down
Yes Yes
Job.HeaderConfig Header page configuration file Specifies the path to and the name of the configuration file that RICOH ProcessDirector uses to create the content and format of the header page placed before each file that is contained in the ZIP file. Authorized users can specify one of the configuration files for header pages that RICOH ProcessDirector provides, or specify a customized configuration file.   Yes No
Job.HotFolder.ApplicationLogFile Hot Folder: Application log file The directory where the external program stores its log files. You can specify this property.   Yes No
Job.HotFolder.FileToSend Hot Folder: File to send Names the file that RICOH ProcessDirector puts in the sending folder to submit to the external program. You can edit this property.   Yes No
Job.HotFolder.FileVerificationCount Hot Folder: File verification count The number of times that RICOH ProcessDirector polls the retrieval folder and finds that the size of the retrieved file has not changed before deciding that the retrieved file is complete.   Yes No
Job.HotFolder.PollInterval Hot Folder: Poll interval The time between 2 consecutive polls of the retrieval folder. The unit of time for the value can be seconds, minutes, or hours.   Yes No
Job.HotFolder.RetrievalFolder Hot Folder: Retrieval folder Names the output hot folder for the external program. RICOH ProcessDirector looks in the retrieval folder for the retrieved file using the retrieval pattern. You can edit this property.   Yes No
Job.HotFolder.RetrievalPattern Hot Folder: Retrieval pattern The pattern-matching string that RICOH ProcessDirector uses to identify a returned job in the retrieval folder.   Yes No
Job.HotFolder.RetrievedFile Hot Folder: Retrieved file The name to use to rename the retrieved file.   Yes No
Job.HotFolder.SendingFolder Hot Folder: Sending folder Names the hot folder where RICOH ProcessDirector puts the job file to send to the external program.   Yes No
Job.HotFolder.TimeOutInterval Hot Folder: Timeout interval The time in minutes before a job goes into an error state when the retrieved file is not found or not complete.   Yes No
Job.ID Displays in the properties notebook title. Contains a unique number that identifies the job on the system.   No No
Job.Info.Attr1 Information: Custom 1 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr2 Information: Custom 2 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr3 Information: Custom 3 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr4 Information: Custom 4 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr5 Information: Custom 5 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr6 Information: Custom 6 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr7 Information: Custom 7 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr8 Information: Custom 8 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr9 Information: Custom 9 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr10 Information: Custom 10 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.InputDatastream General: Input data stream Specifies the format of data that the input file for this job contains.
  • afp
  • gif
  • jdf
  • jpeg
  • json
  • lcds
  • linedata
  • metacode
  • pcl
  • pdf
  • ps
  • text
  • tiff
  • unknown
  • xml
No Yes
Job.InputFile General: Input file name Contains the name of the original input file from which RICOH ProcessDirector created the job.   No Yes
Job.InputFile.Size General: Input file size (bytes) Specifies the size, in bytes, of the original input file that RICOH ProcessDirector used to create the job.   No No
Job.Instance General: Parent server Contains the name of the RICOH ProcessDirector server that owns the submit step for the input file.   No No
Job.JDF.JobID General: JDF job ID Shows the value of the job ID in the JDF job ticket received by RICOH ProcessDirector with the job.   No Yes
Job.JDF.JobPartID General: JDF part ID Shows the value of the part ID for the job in the JDF job ticket received by RICOH ProcessDirector with the job.   No Yes
Job.JobSize Status: Job size (sheets) Contains a calculated value that RICOH ProcessDirector uses when it schedules jobs to printers. It also uses the value of this property when a workflow uses the VerifyPrintedSheetCount step to validate the actual number of sheets that print for a job.   No No
Job.JobType General: Workflow Contains the name of the workflow that defines the processing phases and steps for the job.   No No
Job.JobType.History Status: Workflow history Contains a list of workflows that define processing phases and steps that the job has passed through and where you can restart the job.   No No
Job.Locations Scheduling: Requested location Specifies the location where the job should print.   Yes No
Job.Media Scheduling: Media (ready | supported | all) Specifies the media to use for the job.   Yes Yes
Job.MediaRequired Media required Shows the names of the media objects specified for the entire job or page exception. You cannot change the value of this property.   No Yes
Job.Name General: Job name Contains the name of the job.   Yes Yes
Job.OutputBin Scheduling: Output bin (requested | available | all) Specifies the output bin to use for the job.   Yes Yes
Job.OutputFormat Scheduling: Output format Used to specify whether the first page or the last page of a job prints first. The value can also indicate whether the job needs to be transformed to a different data stream before it is printed.
  • AtoZforAFP
  • AtoZforPDF
  • ZtoAforAFP
  • ZtoAforPDF
  • Transform
No No
Job.PageLength Transform: Transform page length (unit) Specifies the length in inches or millimeters of the image that the Transform program generates.   Yes No
Job.PageRange Print: Pages to print again Specifies which pages in the current job are printed again.   No No
Job.PageWidth Transform: Transform page width (unit) Specifies the width in inches or millimeters of the image that the Transform program generates.   Yes No
Job.PagesStacked Status: Pages stacked Contains the number of logical pages that have printed and that have reached the output stacker of the printer device.   No No
Job.PDF.ActionList Enhance PDF: Action list Specifies one or more actions that a step based on the EnhancePDF step template uses to manipulate or evaluate a PDF file.   Yes No
Job.PDFCheckResult Enhance PDF: PDF results check Shows whether the content of a PDF file meets PDF specifications. To check the content, you add a step based on the EnhancePDF step template to your workflow. In the step, specify the CheckPDF action with the -RPDproperty set to Job.PDFCheckResult.   No No
Job.PDF.FinisherOrderConfiguration PDF: Finisher order For 2-up printing, specifies whether to place the content on the left page first and then the right, or on the right page first and then the left.
  • LeftToRight
  • RightToLeft
Yes No
Job.PDF.NUpConfiguration PDF: N-Up Specifies how many pages print side by side on the same sheet.
  • 1
  • 2
Yes No
Job.PDF.Orientation PDF orientation Specifies the orientation to be used to print the job.
  • Not set (default)
  • Portrait
  • Landscape
No No
Job.PDF.PageRotationFromOriginal PDF: Additional page rotation Specifies whether to change the print orientation of the pages in the job beyond any rotation added by the Leading edge into finisher property.
  • 0
  • 90
  • 180
  • 270
Yes No
Job.PDF.RollConfiguration PDF: Leading edge into finisher Specifies which edge of the print job enters the finisher first.
  • JobEndEdgeIntoFinisher
  • JobStartEdgeIntoFinisher
Yes No
Job.Phase Status: Current phase Contains the name of the RICOH ProcessDirector phase that is currently processing the job.
  • Complete
  • Prepare
  • Print
  • Receive
No No
Job.PhaseProgress Status: Progress within the current phase Contains the progress status for the job within the phase that the Job phase property identifies.
  • Error
  • Manual
  • Staging
  • Working
No No
Job.Preview.AcceptedBy Preview Print: Accepted by Shows the user ID of the user who accepted the preview print.   No No
Job.Preview.AutoAccept Preview Print: Accept preview print automatically Specifies whether RICOH ProcessDirector accepts the preview print automatically and moves the job to the next step in the workflow.
  • No
  • Yes
Yes No
Job.Preview.PageRange Preview Print: Page range for preview print Shows a numeric string that describes which pages in the job are printed as samples in the PreviewPrint step.   Yes No
Job.Preview.Requested Printer Preview Print: Requested printer for preview print Specifies the name of the printer that the PreviewPrint step sends the preview print job to.   Yes No
Job.Print.AssignPrintTime Status: Assigned to printer Specifies the date and time when the printer received the job. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.Print.CumulativePagesStacked Status: Cumulative pages stacked Contains the total number of logical pages that have printed and reached the output stacker of the printer, including any reprinted pages.   No No
Job.Print.CumulativeSheetsStacked Status: Cumulative sheets stacked Contains the total number of physical sheets that have printed and reached the output stacker of the printer throughout the life of the job on the RICOH ProcessDirector system.   No No
Job.Print.EndPrintTime Status: Time printing completed Shows the date and time when the printer finished printing the job successfully. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.Print.HeaderConfig Banner Pages: Header page configuration file Specifies the path to and the name of the configuration file that RICOH ProcessDirector uses to create the content and format of the header page for the job.   Yes No
Job.Print.HeaderCopies Banner Pages: Header copies Contains the number of copies of the job header page that RICOH ProcessDirector should print before it begins to print the job itself.   Yes No
Job.Print.SpoolID General: Spool ID Identifies the spool ID that RICOH ProcessDirector generates for the job before it sends the job to its printer driver component.   No No
Job.Print.TrailerConfig Banner Pages: Trailer page configuration file Specifies the path to and the name of the configuration file that RICOH ProcessDirector uses to create the content and format of the trailer page for the job.   Yes No
Job.Print.TrailerCopies Banner Pages: Trailer copies Contains the number of copies of the job trailer page that RICOH ProcessDirector should print after the job prints.   Yes No
Job.Priority Scheduling: Job priority Contains the printing priority of the job.   Yes Yes
Job.ProcessGroupId General: Process group ID Specifies the number of the processing group, if any, to which the job belongs.   No No
Job.ProcessGroupOrder General: Process group order Identifies the position of the job, if any, in a group of jobs.   No No
Job.Punch Scheduling: Punch Specifies the number and position of holes to punch in the output.
  • 2_at_bottom
  • 2_at_left
  • 2_at_right
  • 2_at_top
  • 3_at_bottom
  • 3_at_left
  • 3_at_right
  • 3_at_top
  • 4_at_bottom
  • 4_at_left
  • 4_at_right
  • 4_at_top
  • Multiple_at_bottom
  • Multiple_at_left
  • Multiple_at_left
  • Multiple_at_top
Yes Yes
Job.ReprintCount Status: Reprint count Shows how many times a job has been reprocessed for printing.   No No
Job.RequestedPrinter Scheduling: Requested printer Contains the name of the printer that was requested for the job.   Yes Yes
Job.Resolution Transform: Transform resolution (dpi) For the standard transform features, specifies the resolution of the full page of image output that the data transform program generates. Specify a value that is appropriate for the model of the printer that prints the job.   Yes No
Job.RestartSteps Displays as the Phase and step list on the Process job again page Shows the phases and associated steps that authorized users can select to start processing the job again.   No No
Job.RetainDuration General: Retention period (unit) Controls the amount of time in minutes, hours, or days that RICOH ProcessDirector retains a job after it reaches the RetainCompletedJobs step in the Complete phase.   Yes Yes
Job.RetainStartTime General: Retention start time Contains the time at which the retention period for a job in the Complete phase began. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.SavedSearches Saved Filters Lets you select from the filters you previously saved to the Job table.   No No
Job.SetJobOverrides Job values file Specifies the full path and file name of a configuration file that is used to set property values.   Yes No
Job.SetJobOverrides Job values file Specifies the full path and file name of a configuration file that is used to set property values.   Yes No
Job.SheetsStacked Status: Sheets stacked Shows the number of physical sheets that have printed and that have reached the output stacker of the printer device.   No No
Job.SnapshotJobFile.FileToBeCopied File type to be copied Specifies the usagetype and datatype of the file this step should find in the spool directory and copy for later use.   Yes No
Job.SnapshotJobFile.NewFileDescriptor Snapshot file descriptor The text that the step inserts in the file name between the job ID and the datatype when it saves the snapshot of the job file.   Yes No
Job.SourceInputDeviceName General: Source input device Shows the name of the input device for the job on the system where the job originated.   No No
Job.SpoolFileStem General: Root file path Specifies the directory location for all files associated with this job.   No No
Job.Staple Scheduling: Staple Specifies the number and position of staples to use in the output.
  • 2_at_bottom
  • 2_at_center
  • 2_at_left
  • 2_at_right
  • 2_at_top
  • Bottom_left
  • Bottom_right
  • Top_left
  • Top_left_diagonal
  • Top_left_horizontal
  • Top_left_vertical
  • Top_right
  • Top_right_diagonal
  • Top_right_horizontal
  • Top_right_vertical
Yes Yes
Job.StapleRequired Stapling required Shows whether this job or any of its page exceptions must be stapled. You cannot change the value of this property.   No Yes
Job.State Status: Current job state Contains the current processing state of the job.
  • Assigned
  • Complete
  • Creating
  • Error
  • ManualWaiting
  • ManualWorking
  • Printing
  • Processing
  • Queued
  • Release
  • Retained
  • Spooling
  • Stopped
  • Unassigned
  • Waiting
No No
Job.Step Status: Current step Contains the name of the step that is processing the job.   No No
Job.StopAtPhase Status: Stop when entering phase Specifies whether RICOH ProcessDirector stops a job when it enters the first step of a specific phase.
  • Complete
  • Prepare
  • Print
  • Receive
Yes No
Job.SubmitTime Scheduling: Time submitted Contains the date and time when the input device submitted the input file and created the corresponding RICOH ProcessDirector job. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.TestJob General: Test job Specifies whether the job is a test job or a production job.
  • No
  • Yes
Yes No
Job.TotalPages Status: Total pages Contains the total number of logical pages in the job.   No No
Job.TotalSheets Status: Total sheets Contains the total number of physical sheets in the job.   No No
Job.TrailerConfig Trailer page configuration file Specifies the path and name of the configuration file that RICOH ProcessDirector uses to create the content and format of the trailer page placed after each file that is contained in the ZIP file. Authorized users can specify one of the configuration files for trailer pages that RICOH ProcessDirector provides or they can specify a customized configuration file.   Yes No
Job.UseProxy Use proxy server Specifies whether the DownloadFile step uses a proxy server to resolve the URL of the file to be downloaded.
  • No
  • Yes
Yes No
Job.Validate.FileTo Check File Structure: File to check Specifies the full path and name of the JSON or XML file that a step based on the CheckFileStructure step validates by checking the file syntax.   Yes No
Job.Validate.FileType Check File Structure: File format Specifies the format of the file that a step based on the CheckFileStructure step template validates.
  • XML
  • JSON
Yes No
Job.Wait.Amount Wait: Wait for Specifies the amount of time the job waits before moving to the next step.   Yes No
Job.Wait.TimeOfDay Wait: Wait until Specifies the specific time when the job moves to the next step.   Yes No
Job.Wait.TimeZone Wait: Time zone Specifies the time zone to use with the Wait until property.   Yes No
Job.Wait.WaitUntil Wait: Wait step ends Shows the date and time when the waiting period ends and the job moves to the next step.   Yes No
Job.Wait.WhenToMove Wait: Complete step after When values are set for both the Wait until and the Wait for properties, this property specifies whether the Wait step completes when the earlier or later of the two times is reached.
  • First occurs
  • Last occurs
Yes No
Job.WaitReason Status: Reason for wait status Identifies the condition that is preventing RICOH ProcessDirector from further processing of the job.
  • DeviceUnavailable
  • NoMatchingDevice
  • ServerUnavailable
  • StepTemplateDisabled
No No
Job.XML.JSONInputFile XML: JSON input file Specifies the JSON file to be converted into XML format.   Yes No
Job.XML.XMLOutputFile XML: XML output file Specifies the location and name of the XML file created by the step.   Yes No
Job.ZipFIle.FilesToZip ZIP Files: Files to ZIP Specifies a comma-separated list of files that a step based on the ZIPFiles step template copies to create a ZIP file.   Yes No
Job.ZipFIle.ZipToSave ZIP Files: Output file Specifies the full path and name of the output file created by a step based on the ZIPFiles step template.   Yes No
Job.ZipFilesToEmail Email: Attach ZIP file Specifies whether the file or files should be packaged as a ZIP file before they are attached to the email.
  • No
  • Yes
Yes No

1.2.10.30.5.1 Database property names for jobs that do not appear in the user interface

Some job properties do not appear in the user interface. These properties can be useful for writing external programs.

The Internal values column on values describes restrictions on property values. Some properties have specific internal values, so if you want to use them in Web services requests or set them using an overrides file, you must use one of those values.

In the Editable column:

  • Yes means that an authorized user can change the value after the job has been submitted.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket that is used to submit the job.
  • No means that the property cannot be set from values in the job ticket.

Job properties that do not appear in the user interface
Database name Brief description Internal values Editable Job ticket
Job.ContinueState Specifies what state to return an interrupted job to when the job continues.   No No
Job.ConvertOverrides Specifies whether the overrides file submitted with a job is converted to a job properties file in RICOH ProcessDirectorproperty name=value format.
  • No (default)
  • Yes
Default is Yes for LPD input devices.
No No
Job.External.ControlFile Specifies a formula that resolves to the name of the temporary control file that the external program uses. 1–255 characters No No
Job.FileReceiptTime Specifies the date and time when the last input file for the job arrived in the system.   No No
Job.HoldPending Specifies whether RICOH ProcessDirector holds the job after it completes the processing that the current step does.
  • No (default)
  • Yes
Yes No
Job.InitJob.TypePattern Specifies a pattern-matching string that consists of a regular expression and can include (JOB_TYPE) to indicate what part of the file name should be used to determine the workflow. The Workflow initialization step or Child workflow initialization step property of the input device must be SetJobTypeFromFileName. 1-255 characters (case-sensitive) No No
Job.NextChildJobID Specifies the job ID to be assigned to the next child job created for this job.   No No
Job.PreviousPrinter Shows the printer that was previously assigned to the job or that previously printed the job.   No No
Job.PrintCommand Shows the print command that was used to submit the job.   No No
Job.Print.CurrentPage Shows the page number of the page that is currently printing on the assigned printer.   No No
Job.Print.CurrentTotalPages Shows the total number of pages in the job.   No No
Job.Print.CurrentTotalSheets Shows the total number of physical sheets in the job.   No No
Job.Print.FormLength Specifies the form length in millimeters.   No No
Job.PSFINSeglist Lists the segment files into which an AFP job is broken for processing.   No No
Job.Print.PSFINSegmentSize Specifies the size of the segment files, in kilobytes, into which RICOH ProcessDirector breaks up AFP jobs for processing.   Yes No
Job.Process Specifies the process within the current phase that is processing the job.   No No
Job.Promote Specifies whether an authorized user has promoted the job.
  • No
  • Yes
No No
Job.PromoteTime Specifies the time when an authorized user promoted the job.   No No
Job.ReleaseState Specifies what state to return a stopped job to when the job is released.   No No
Job.ResumeKey Specifies a key that the printer driver component returns when an operator interrupts a job. When the operator resumes the job, the printer driver uses this key to determine the page number at which it is to resume printing.   No No
Job.StateType Shows the state type for the job.
  • Queued
  • Processing
  • Complete
  • Error
  • Manual
No No
Job.StopIssued Specifies whether an authorized user has stopped the job.   No No

1.2.10.30.5.2 Database property names for jobs with Quadient Inspire Connect

Messages about print jobs that go through a step based on the ComposeAFP or ComposePDF step templates might refer to properties by their database names, which begin with Job.GMC. The Quadient Inspire Connect feature provides steps to run the Quadient Inspire Designer program.

In the Editable column:

  • Yes means that an authorized user can change the value after the workflow has been created.
  • No means that an authorized user cannot change the value.

Properties
Database name Notebook field name Brief description Editable
Job.GMC.WFDFileLocation WFD File A formatting file generated when you use Quadient Inspire Designer to design a print layout. This file contains the application layout and input data that Quadient Inspire Designer uses to generate a print job. Yes
Job.GMC.DataFilesLocation Data files The file or files containing the variable data that is sent to Quadient Inspire Designer to be included in a new print job. Yes
Job.GMC.DataFilesModule Data modules Lists the name of the data module or modules in Quadient Inspire Designer that process the variable data files. Yes
Job.GMC.FixedDataFilesLocation Fixed data files A file containing data that is the same for all jobs processed through this step. The file is sent to Quadient Inspire Designer to be included in a new AFP print job. Yes
Job.GMC.FixedDataFilesModule Fixed data modules Lists the name of the data module in Quadient Inspire Designer that processes a fixed data file. Yes
Job.GMC.JobFile Quadient JOB file The production configuration file that Quadient Inspire Designer generates. This file contains configuration information for the printer, so jobs are printed correctly. Yes
Job.GMC.SetupFiles Not present in the property notebook Concatenates the values of the Data files, Data modules, Fixed data files, and Fixed data modules properties in the correct order. You can use this property in commands and symbol formulas that require more than one of those values. No

1.2.10.30.5.3 Database properties for jobs with RICOH Visual Workbench

Messages about jobs might refer to job properties that are related to RICOH Visual Workbench. The database names of all job properties begin with Job. Administrators can use the database property names for job properties in symbol formulas that they specify for RICOH ProcessDirector external programs. Administrators can also specify symbol formulas for job properties in RICOH ProcessDirector control files.
Job Properties for RICOH Visual Workbench
Database name Notebook tab: field name Brief description
Job.EditFirst Edit first Specifies whether RICOH ProcessDirector should edit a job using the AFP Editor feature before creating white space.
Job.IndexerControlFile Visual Workbench control file Specifies the path and file name of the Visual Workbench control file.
Job.IndexerFirst Index first Specifies whether RICOH ProcessDirector indexes a job using AFP Indexer before making other enhancements to it.

1.2.10.30.5.4 Database property names for web service jobs

Some parts of the system and messages about web service jobs refer to properties by their database names.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you set the value of a property in an overrides file or an external program, use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the notification has been created.
  • No means that you cannot change the value.

Web service job properties
Database name Notebook tab: field name Brief description Internal values Editable
Job.WebService.Header Call Web Services: Request header Specifies the HTTP header field that the step includes in a web service request to send a request to an application.   Yes
Job.WebService.Parameter Call Web Services: Request parameters Specifies the parameters that the step includes in the web services request to an external application.   Yes
Job.WebService.Payload Call Web Services: Request payload Specifies the body of the web services request that the step submits to an application.   Yes
Job.WebService.PayloadType Call Web Services: Request payload type Specifies whether the value in the Request payload property is a path to a file or a string.
  • File
  • Text
Yes
Job.WebService.PosPassword Call Web Services: Password Specifies the password that the step uses to authenticate with a web service.   Yes
Job.WebService.Proxy Call Web Services: Use proxy Specifies whether the step communicates through a proxy server and if so, specifies the proxy server to communicate through.
  • Proxy server 1
  • Proxy server 2
Yes
Job.WebService.RequestMethod Call Web Services: Request method Specifies the method that the step uses to send the request to the application.
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Yes
Job.WebService.RequestURL Call Web Services: Request URL Specifies the URL that the step uses to submit the request to an application.   Yes
Job.WebService.ResponseFile Call Web Services: Response file Specifies the full file path and name that RICOH ProcessDirector uses to store the response from the application.   Yes

1.2.10.30.5.4.1 Database property names for web service jobs that do not appear in the user interface

Some properties for web service jobs do not appear in the user interface. These properties can be used in RICOH ProcessDirector symbols or for writing external programs.

The Internal values column describes restrictions on property values. If a property has specific internal values, use one of them when you set the property value in an overrides file or an external program.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

Properties for web service jobs that do not appear in the user interface
Database name Brief description Internal values Editable
Job.WebService.Password Lets RICOH ProcessDirector replace the symbol for this property with the value in the Password property for a step based on the CallRESTService or CallSOAPService step template.
Important:
Do not use this property for another purpose. If you do, substituting the property for the password in a CallRESTService or CallSOAPService step does not work.
  No

1.2.10.30.6 Database property names for locations

Messages about locations might refer to properties by their database names, which begin with Location.

In the Editable column:

  • Yes means that an authorized user can change the value after the location has been created.
  • No means that an authorized user cannot change the value.

Location properties
Database name Field name Brief description Editable
Location.Description Location description Describes the location. For example, the description might include the city name or the building name and floor where printers are located. Yes
Location.ID Location name Specifies the name of the location. No
Location.LastModified Last modified The date and time that the location was last changed. No
Location.Modified Modified by user Specifies the user name of the user who made the last change to this location. No

1.2.10.30.7 Database property names for media

Messages about media might refer to properties by their database names, which begin with Media.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the media has been created.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property is compared to one or more values in the job ticket that is used to submit the job in order to set the Media property for the job.
  • No means that the property is not compared to values in the job ticket.

Media properties
Database name Field name Brief description Internal values Editable Job ticket
Media.Description Media description Contains user-defined text that describes the media.   Yes No
Media.ID Displayed in the properties notebook title: Media name Contains the name of the media.   No Yes
Media.LastModified Last modified The date and time that the media was last changed.   No No
Media.MappedMedia Mapped system media Specifies the system media that you want to map to this printer media.   Yes Yes
Media.MappedMedia.PrinterFilter Printer Specifies what printers to display media mappings for in the table.
  • All
Yes Yes
Media.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this media.   No No
Media.Printer Printer Specifies the name of the printer that this printer media is associated with.   No Yes
Media.ProductId Product ID Specifies the product ID of the media. This property is used only with jobs sent to Ricoh PDF printers with a Data stream to send value of JDF/PDF.   Yes Yes
Media.SendName Send media name in job ticket Specifies whether the media name is sent to the Ricoh PDF printer in the JDF job ticket.   Yes No
MediaSize.Height Media height Specifies the height of the media.   Yes Yes
MediaSize.Units Media units Specifies the unit of measure for the media height and width.
  • Inches
  • Millimeters
  • Points
Yes No
Note: Media dimensions in the job ticket are always in points.
MediaSize.Width Media width Specifies the width of the media.   Yes Yes
MediaType.Color Media color Specifies the color of the media.
  • Blue
  • Buff
  • Goldenrod
  • Gray
  • Green
  • Ivory
  • None
  • Orange
  • Pink
  • Purple
  • Red
  • User
  • White
  • Yellow
Yes Yes
MediaType.Details Media details Specifies the general category to which the media belongs; for example, letterhead or transparency.
  • Bond
  • Cardstock
  • Envelope
  • Labels
  • Letterhead
  • Paper
  • Special
  • Tabstock
  • Translucent
  • Transparent
Yes Yes
MediaType.Preprinted Media is preprinted Specifies whether the media is preprinted.
  • No
  • Yes
Yes Yes
MediaType.Punched Media is prepunched Specifies whether the media is prepunched.
  • No
  • Yes
Yes Yes
MediaType.Recycled Media is recycled Specifies whether the media is recycled.
  • No
  • Yes
Yes Yes
MediaType.Weight Media (gsm) Specifies the weight of the media in grams per square meter (gsm).   Yes Yes

1.2.10.30.8 Database property names for notification objects

Messages might refer to Notification properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Workflow properties
Database name Notebook field name Brief description Editable
User.EmailAddress Email address Specifies the email address for the user. Yes
Notification.AnyAllCustom Apply any or all of the following conditions Specifies how the conditions for a notification object are combined. Yes
Notification.BCC Blind copy address One or more email addresses to send a blind copy of the notification email to. This value is used in the BCC: field of the email. Yes
Notification.CC Copy address One or more email addresses to send a copy of the notification email to. This value is used in the CC: field of the email. Yes
Notification.Condition Conditions Lets you define one or more conditions for a notification object. Conditions limit the notifications that are sent for the specified event. Each condition consists of an object property, a comparison, and a value. Yes
Notification.Condition.NotifyWhen Notify when Specifies how the conditions for a notification object are combined. Yes
Notification.Description Notification description The description might indicate when a notification is sent. For example, the description might say: "Email second shift operators if any printer is disabled after midnight." Yes
Notification.EmailMessage Message Specifies the message to include in the body of the notification email. Messages can consist of plain text, HTML, and embedded images. Yes
Notification.EmailSubject Subject line Specifies the text to include in the subject line of the notification email. Yes
Notification.Enabled.Description Enabled status Specifies whether this notification object can send a notification. No
Notification.Event Event Lets you define one or more properties to monitor for a notification object. Each event consists of an object property, an action, and optionally a value. The type of object whose properties are shown is set in the Event type property on the General tab of the Notification property notebook. Yes
Notification.EventType Event type Specifies the type of object to be monitored for notification. You can only use one type of Event type for each notification object. Yes
Notification.ID Notification name Specifies the name of the notification object. No
Notification.JsonCondition Conditions Lets you define one or more conditions for a notification object. Conditions limit the notifications that are generated for the specified event. No
Notification.SecureConnection Secure connection Specifies whether the connection with the mail server should use SSL or TLS security for sending notification emails. The SMTP server must support SSL or TLS connections for this property to function. Yes
Notification.SendLog Attach log Specifies whether the input device, job or printer log is attached to the notification email when a certain input device, job or printer event occurs, providing more information to the email recipients. Yes
Notification.Threshold Notification limit Lets you specify how many notifications can be sent within a period of time. For example, if you specify 10 messages within 2 hours, a timer starts after the first notification is sent. If nine more notifications are sent in the next 30 minutes, no more notifications are sent until the timer reaches the 2 hour limit. Yes
Notification.To Recipient address One or more email addresses to send the notification to. This value is used in the To: field of the email. Yes
Notification.Type Notification method Specifies how notifications are delivered. Yes
WorkflowSystem.EmailFrom Sender email address The email address used in the From: field for all notification emails. Yes

1.2.10.30.8.1 Database property names for web service notifications

Some parts of the system and messages about web service notifications refer to properties by their database names.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you set the value of a property in an overrides file or an external program, use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the notification has been created.
  • No means that you cannot change the value.

Web service notification properties
Database name Notebook tab: field name Brief description Internal values Editable
WSNotification.WebService.AuthContentType Authentication: Authentication response content type Specifies the response format the web service notification receives for authentication.
  • JSON
  • XML
Yes
WSNotification.WebService.AuthRequestHeader Authentication: Authentication request header Specifies the HTTP header field the web service notification uses to authenticate to another application.   Yes
WSNotification.WebService.AuthRequestMethod Authentication: Authentication request method Specifies the method type the web service notification calls for authentication.
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Yes
WSNotification.WebService.AuthRequestParams Authentication: Authentication request parameters Specifies the parameters the web service notification sends to an external application. Examples of these parameters are the user ID and password.   Yes
WSNotification.WebService.AuthRequestPayload Authentication: Authentication request payload Specifies the payload to be passed to the specified web service.   Yes
WSNotification.WebService.AuthRequestPwd Authentication: Authentication request password A password that is used to get a single-use credential for a session. You reference the password in the Authentication request payload property as a symbol. The web site returns a token when authentication is successful.   Yes
WSNotification.WebService.AuthRequestURL Authentication: Authentication request URL Specifies the URL that RICOH ProcessDirector uses to authenticate with a web site or application.   Yes
WSNotification.WebService.AuthResponseAttribute Authentication: Authentication response attribute Specifies the XPath or JSONPath to the element in the response to the authentication request that contains the credential for the session. This value is stored as the Static credential for the session.   Yes
WSNotification.WebService.Proxy Request: Use proxy Specifies whether the web service notification communicates through a proxy.
  • Yes
  • No
Yes
WSNotification.WebService.RequestHeader Request: Request header Specifies the HTTP header field the web service notification uses to request data.   Yes
WSNotification.WebService.RequestMethod Request: Request method Specifies the method type the web service notification calls for processing.
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Yes
WSNotification.WebService.RequestParams Request: Request parameters Specifies the parameters the web service notification sends to an external application.   Yes
WSNotification.WebService.RequestPayload Request: Request payload Specifies the payload the web service passes to an external application.   Yes
WSNotification.WebService.RequestURL Request: Request URL Specifies the URL of the web service that the web service notification communicates with.   Yes
WSNotification.WebService.StaticCredential Authentication: Static credential The authorization code that RICOH ProcessDirector uses to connect to an external application that requires multiple-use authentication.   Yes
WSNotification.WebService.Username Authentication: HTTP authentication user name Specifies the user name that RICOH ProcessDirector uses to connect to an external application.   Yes

1.2.10.30.8.1.1 Database property names for web service notifications that do not appear in the user interface

Some properties for web service notifications do not appear in the user interface. These properties can be used in RICOH ProcessDirector symbols or for writing external programs.

The Internal values column describes restrictions on property values. If a property has specific internal values, use one of them when you set the property value in an overrides file or an external program.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

Properties for web service notifications that do not appear in the user interface
Database name Brief description Internal values Editable
WSNotification.WebService.Credential The static credential or token that the web service notification transmits with the call to the web service that exchanges data with RICOH ProcessDirector.

To specify the credential or token in the Request payload property, use a symbol for the WSNotification.WebService.Credential property. This example uses XML:

<Token>${WSNotification.WebService.Credential}</Token>

  No

1.2.10.30.9 Database property names for printers

Messages about printers might refer to properties by their database names. Not all properties are applicable to all types of printers.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the printer has been created.
  • No means that an authorized user cannot change the value.

Printer properties
Database name Notebook tab: field name Brief description Internal values Editable
CustomPDFPrinter.ImportPrinter General: Custom PDF Printer Server Select the printer server where you want to define a Custom PDF printer device.   No
CustomPDFPrinter.PrinterType General: Custom printer type Specifies the type of printer to define as a Custom PDF printer object.   Yes
JdfDirectPrinter.VPName General: Virtual printer name Specifies the name of the virtual printer as defined on the Ricoh TotalFlow printer object.   Yes
JdfOutputPrinter.PrinterType General: Type of printer Specifies the printer type. The list of all printers that can be connected as Ricoh PDF printers. Yes
JdfOutputPrinter.BannerPage.Tray Banner Pages: Banner page input tray Specifies the printer’s input tray that holds the paper for header and trailer pages.   Yes
JdfOutputPrinter.JobStatusPolling General: Job status polling interval Defines how frequently the Ricoh PDF or Custom PDF printer requests updates about the status of a job.   Yes
JdfOutputPrinter.MergeBanner Banner Pages: Merge banner pages into PDF print file Specifies whether or not header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
JdfOutputPrinter.Port General: Printer port Specifies the communications port for the printer.   Yes
JdfOutputPrinter.URL General: Printer URL Specifies the host name or TCP/IP address that is used to communicate with the printer.   Yes
PassThroughPrinter.CodePage General: Code page Specifies the code page that the printer uses to interpret the printer command.   Yes
PassThroughPrinter.Command General: Printer command The command that is used to submit jobs to the printer.   Yes
PassThroughPrinter. ControlFileTemplate General: Control file template Specifies the full path name of the control file template that maps job properties to printer command parameters.   Yes
PassThroughPrinter.MergeBanner Banner Pages: Merge banner pages into PDF print file Specifies whether or not header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
PassThroughPrinter.ValidRCs General: Valid return codes Contains a list of return code values that the printer command can issue to indicate that the job printed successfully.   Yes
Printer.CommunityName SNMP: Community name Specifies the name of the Simple Network Management Protocol (SNMP) community to which the printer belongs.   Yes
Printer.CurrentJobID Status: Current job number Specifies the job number of the job that is currently assigned to the printer.   No
Printer.CurrentJobName Status: Current job name Specifies the name of the job that is currently assigned to the printer.   No
Printer.CurrentJobPagesStacked Status: Current job pages printed Shows the number of pages that have been printed for the job that is currently assigned to the printer.   No
Printer.CurrentJobProgress Status: % Printed Shows the current page that is printing for the job that is currently assigned to the printer, as a percentage of the total pages in the job.   No
Printer.CurrentJobTotalPages Status: Total pages in current job Shows the total number of pages in the job that is currently assigned to the printer.   No
Printer.CurrentStatus Status: Last status message If the printer status is Disconnected or Needs attention, contains the most recent error or warning message received about the printer. Otherwise, contains the most recent informational message received about the printer.   No
Printer.CustomerName Scheduling: Customer name Specifies the customer name that is assigned to the printer.   Yes
Printer.Description General: Printer description Contains text that describes the printer object.   Yes
Printer.Enabled Status: Enabled status Specifies whether RICOH ProcessDirector can schedule jobs to the printer.   No
Printer.EnhancePDFFilter General: Action list Specifies one or more actions that can be applied to a PDF file and JDF file before it is sent to the Ricoh PDF or Ricoh TotalFlow printer.   Yes
Printer.FirstSegmentSize General: PDF first segment size Specifies the size, in pages, of the first PDF job segment that is sent to the printer.   No
Printer.FoldCapable Scheduling: Folding capable Specifies whether the printer can fold pages in different ways depending on the job assigned.   Yes
Printer.HeaderExit Banner Pages: Enable header pages Controls whether the printer prints a header page at the beginning of each job.
  • No
  • Yes
Yes
Printer.ID Displayed in the properties notebook title: Printer name Contains the name of the printer.   No
Printer.Instance General: Printer server Specifies the name of the RICOH ProcessDirector server that sends jobs to this printer.   Yes
Printer.JobSize Scheduling: Job size supported Specifies the size of the jobs in sheets that RICOH ProcessDirector can schedule to the printer.   Yes
Printer.Language General: Printer language Indicates what language the printer driver component uses when it returns messages to RICOH ProcessDirector.   Yes
Printer.LastModified General: Last modified The date and time that the printer was last changed.   No
Printer.Locations Scheduling: Printer location Specifies the location of the printer.   Yes
Printer.MaxConcurrentJobs General: Maximum concurrent jobs Specifies the maximum number of jobs that the printer driver component of RICOH ProcessDirector can control at the same time.   Yes
Printer.Media Scheduling: Media supported Specifies the media that the printer supports.   Yes
Printer.MediaCatalog Media: Media to use Specifies whether the media information sent to the printer for a job is system media or printer media.
  • Printer
  • System
Yes
Printer.Model General: Printer paper type Contains the type of the printer; for example, continuous-form or cut sheet.   Yes
Printer.Model.Specific General: Printer model Contains the model number of the printer.   Yes
Printer.ModifiedBy General: Modified by user Specifies the user name of the user who made the last change to this printer.   No
Printer.OutputBin Scheduling: Output bins available Lists the output bins that can be installed on the printer.   Yes
Printer.OutputFormat Scheduling: Output format Specifies whether the printer is set up to print the first page or the last page of a job first, usually based on finishing or other post-processing requirements. The value can also indicate that the job must be transformed to a different datastream before it can be printed.
  • AtoZforAFP
  • AtoZforPDF
  • ZtoAforAFP
  • ZtoAforPDF
  • Transform
Yes
Printer.PerfectBindingCapable Scheduling: Perfect binding capable Specifies whether the printer can glue a cover onto the binding edge of paper.   Yes
Printer.PunchCapable Scheduling: Punch capable Specifies whether a finisher attached to the printer can punch holes in the output.   Yes
Printer.Retry Connection: Printer connection retry count Specifies how many times RICOH ProcessDirector tries to connect to the printer if an earlier attempt failed.   Yes
Printer.RetryInterval Connection: Retry interval Specifies how often RICOH ProcessDirector tries to connect to the printer if an earlier attempt failed.   Yes
Printer.RingBindingCapable Scheduling: Ring binding capable Specifies whether the printer can insert rings along the binding edge of paper.   Yes
Printer.S2VBarcode AFP: Send blank pages after job Specifies the number of blank pages to send to the printer after the last job that is queued to the printer prints.   Yes
Printer.SegmentSize General: PDF segment size Specifies the size, in pages, of PDF job segments that are sent to the printer.   Yes
Printer.SerialNumber Status: Serial number Contains the serial number of the printer.   No
Printer.SNMPStatus Status: SNMP status Indicates whether SNMP is connected, disconnected, or disabled.   No
Printer.StapleCapable Scheduling: Staple capable Specifies whether a finisher attached to the printer can staple the output.   Yes
Printer.Status Status: Printer status Contains the current status of the printer.   No
Printer.TCPIP.Address General: Printer TCP/IP address or host name Specifies either the network TCP/IP address or the fully qualified host name of the printer hardware.   Yes
Printer.TrailerExit Banner Pages: Enable trailer pages Specifies whether the printer prints a trailer page at the end of each job.
  • No
  • Yes
Yes
Printer.UseSNMP SNMP: Use SNMP Specifies whether RICOH ProcessDirector uses SNMP to monitor the printer.   Yes
Printer.UseSnmpUpdateMedia SNMP: Get tray information from printer Specifies whether RICOH ProcessDirector uses the Simple Network Management Protocol (SNMP) to update media.
  • No
  • Yes
Yes
Printer.Version Status: Version Contains the printer version returned by SNMP.   No

1.2.10.30.9.1 Database property names for printers that do not appear in the user interface

Some printer properties do not appear in the user interface. These properties can be useful for writing external programs.

In the Editable column:

  • Yes means that an authorized user can change the value after the job has been submitted.
  • No means that an authorized user cannot change the value.

Printer properties that do not appear in the user interface
Database name Brief description Values Editable
Printer.InputTray Specifies the input tray of the printer.   No
Printer.MediaReady Specifies the media that are ready in the printer.   No
Printer.Type Specifies the data stream that the printer accepts. IPDS No

1.2.10.30.10 Database property names for servers

Messages about servers might refer to properties by their database names, which begin with Instance.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the server has been created.
  • No means that an authorized user cannot change the value.

Server properties
Database name Notebook field name Brief description Internal values Editable
Instance.Description Server description Contains user-defined text that describes the RICOH ProcessDirector server.   Yes
Instance.Enabled Enabled status Specifies whether the server can do tasks.
  • No
  • Yes
No
Instance.ID Displayed in the properties notebook title: Server name Contains the name of the server.   No
Instance.IPAddress Server IP address or host name Specifies either the network IP address or the fully qualified host name of the computer that the server is running on.   Yes
Instance.InGeneralServerPool In general server pool Specifies whether the server is a general-usage server or a restricted-usage server.
  • No
  • Yes
Yes
Instance.LastModified Last modified The date and time that the server was last changed.   No
Instance.MaxHighUsageSteps Maximum resource-intensive step count Controls how many resource-intensive steps the server lets run concurrently.   Yes
Instance.MaxLowUsageSteps Maximum step count for other steps Controls how many non-resource-intensive steps the server lets run concurrently.   Yes
Instance.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this server.   No
Instance.Status Connection status Shows the current status of the server.
  • Connected
  • Disconnected
No

1.2.10.30.11 Database property names for step templates

Messages about step templates might refer to properties by their database names, which begin with StepTemplate.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the step template has been created.
  • No means that an authorized user cannot change the value.

Step template properties
Database name Notebook tab: field name Brief description Internal values Editable
Step.Color Step color Specifies the color of the step as it appears in the workflow builder.
  • Red
  • Orange
  • Gray
  • Blue
  • Purple
  • Not set
Yes
Step.Description Step description Describes the purpose of the step. For example, it might describe how the step processes a job.   Yes
Step.DisplayName General: Step name The name given to a step when it is added to a workflow.   Yes
Step.ID General: Step identifier Specifies the internal name for this step. This value is derived from the name of the step.   No
Step.Template.CreatedBy General: Template created by Specifies the name of the feature or extension that created the step template.   No
StepTemplate.Color Step color Specifies the color of the step as it appears in the workflow builder.
  • Red
  • Orange
  • Gray
  • Blue
  • Purple
  • Not set
Yes
StepTemplate.Description General: Template description Contains text that describes the function of the step template.   Yes
StepTemplate.Enabled General: Enabled status Specifies whether the step template is enabled.
  • No
  • Yes
No
StepTemplate.HighResourceUsage Tuning Properties page: Concurrent step limit Specifies where the limits are set for the number of steps created from the step template that can run at the same time.
  • Use limits set here
  • Use limits set on server
Use limits set here
StepTemplate.ID Displayed in the properties notebook title: Step template name Contains the name of the step template.   No
StepTemplate.LastModified Last modified The date and time that the step was last changed.   No
StepTemplate.MaximumActiveCount Tuning Properties page: Limit the number of concurrent steps active in the system to radio button Specifies how many occurrences of the step template, and any steps that are created from it, can run concurrently on a specific type of RICOH ProcessDirector object.   Yes
StepTemplate.MaximumActiveUnit Tuning Properties page: for each drop-down list Specifies the type of RICOH ProcessDirector object to which the value of the Maximum active count property for the step template applies.
  • PerInputDevice
  • PerPrinter
  • PerServer
  • PerSystem
Yes
StepTemplate.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this step.   No
StepTemplate.ModuleType General: Module type Identifies the type of function the step template provides.
  • Cleanup
  • InitJobType
  • Java
  • Manual
  • Print
  • Submit
  • SubmitChild
No
StepTemplate.Servers Tuning Properties page: Run only on the selected server or servers radio button Lists all the restricted-usage servers and general-usage servers on which any steps that are created from the step template can run.   Yes
StepTemplate.SourceID General: Step template source ID Specifies the name of the step template that was used to create this step template.   No
StepTemplate.UseGeneralServerPool Tuning Properties page: Servers to use Specifies which computers can run the steps created by the step template.
  • Run on specific servers
  • Run on servers in general server pool
Run on servers in general server pool

1.2.10.30.12 Database property names for system properties

Messages about the RICOH ProcessDirector system might refer to properties by their database names, which begin with WorkflowSystem.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

System properties
Database name Field name Brief description Internal values Editable
WorkflowSystem.AdLdap.TestUserName LDAP test user name Specifies the LDAP user name used to test the LDAP settings.   Yes
WorkflowSystem.AltSMTPAddress Alternate SMTP server Specifies either the network IP address or the fully-qualified host name of the SMTP server that RICOH ProcessDirector uses to send emails when the SMTP server type property on a job step is set to Alternate.   Yes
WorkflowSystem.AltSMTPPassword Alternate SMTP password Specifies the password that the primary server uses to log in to the alternate SMTP Server.   Yes
WorkflowSystem.AltSMTPPort Alternate SMTP port Specifies TCP/IP port that the alternate SMTP server uses.   Yes
WorkflowSystem.AltSMTPSSLPort Alternate SMTP SSL port If the alternate SMTP server uses SSL security, specifies the TCP/IP port that the SSL connection uses.   Yes
WorkflowSystem.AltSMTPTLSPort Alternate SMTP TLS port If the alternate mail server uses TLS security, specifies the TCP/IP port that the TLS connection uses.   Yes
WorkflowSystem.AltSMTPUserName Alternate SMTP user name Specifies the user name that the RICOH ProcessDirector server uses to log in to the alternate SMTP Server.   Yes
WorkflowSystem.CaptureFileName Capture file Specifies the name of the capture file that is created when you capture system data.   Yes
WorkflowSystem.CaptureLevel Data to capture Shows the amount of information that is included in the capture file.   Yes
WorkflowSystem.CaptureServer Servers to capture data from Shows the server or servers that information is collected from when the capture file is created.   Yes
WorkflowSystem.Child.MaxJobID Largest child job number Specifies the largest job number that RICOH ProcessDirector can assign to a child job.   Yes
WorkflowSystem.Child.MinJobID Smallest child job number Specifies the smallest job number that RICOH ProcessDirector can assign to a child job.   Yes
WorkflowSystem.CopyTracesToTemp Back up files before capture Shows whether trace files are copied to a temporary directory before they are added to the capture file.   Yes
WorkflowSystem.CredentialExpiration Login inactivity timer (minutes) Specifies the number of minutes before an inactive user is automatically logged out.   Yes
WorkflowSystem.Email.SSLPort Email SSL port If the mail server uses SSL security, the TCP/IP port that the SSL connection uses.   Yes
WorkflowSystem.Email.TLSPort Email TLS Port If the mail server uses TLS security, the TCP/IP port that the TLS connection uses.   Yes
WorkflowSystem.FileSystemMapping File system mapping file Specifies the name of a file that maps file paths to mount points on the RICOH ProcessDirector server.   Yes
WorkflowSystem.GUILoggingLevel Web server logging level When the Custom option is selected for the Trace level property, shows the trace level that is active for the system.   Yes
WorkflowSystem.JobDisplayTag Job identifier to use Specifies whether the Printers portlet, printer console, and PSF Job completion log show the job name or the job number.
  • Job.ID
  • Job.Name
Yes
WorkflowSystem.LastCaptureFilename File name for last capture Specifies the name of the last capture file created when system data was most recently captured.   No
WorkflowSystem.LastCaptureTimestamp Last capture completed The date and time that the capture was most recently completed. RICOH ProcessDirector updates the value whenever the capture completes.   No
WorkflowSystem.LPDHostnames Hosts allowed to submit LPD jobs Specifies the host names or IP addresses of systems that can submit jobs to RICOH ProcessDirector using the LPD protocol.   Yes
WorkflowSystem.MaxJobID Largest job number Specifies the largest job number that RICOH ProcessDirector can assign to a job.   Yes
WorkflowSystem.MediaTolerance.RecyclingPercentage Recycled content tolerance Specifies the acceptable variation in recycled content for a media object.   Yes
WorkflowSystem.MediaTolerance.Size Size tolerance Specifies the acceptable variation in size for a media object.   Yes
WorkflowSystem.MediaTolerance.Weight Weight tolerance Specifies the acceptable variation in weight for a media object.    
WorkflowSystem.PrinterProgress Print progress bar Specifies whether the print progress bar is displayed in the Printers portlet.
  • No
  • Yes
Yes
WorkflowSystem.MaxPasswordAge Maximum password age before expiration Specifies the number of days passwords can be used until they expire.   Yes
WorkflowSystem.MinJobID Smallest job number Specifies the smallest job number that RICOH ProcessDirector can assign to a job.   Yes
WorkflowSystem.Primary.MaxLowUsageSteps Maximum step count for other steps Controls how many non-resource-intensive steps the primary RICOH ProcessDirector server lets run concurrently.   Yes
WorkflowSystem.Primary.MaxHighUsageSteps Maximum resource-intensive step count Controls how many resource-intensive steps the primary RICOH ProcessDirector server lets run concurrently.   Yes
WorkflowSystem.ProxyPassword Proxy server 1 password Specifies the password that the primary server uses to log in to proxy server 1.   Yes
WorkflowSystem.ProxyPassword2 Proxy server 2 password Specifies the password that the primary server uses to log in to proxy server 2.   Yes
WorkflowSystem.ProxyPort Proxy server 1 port Specifies TCP/IP port that RICOH ProcessDirector uses to communicate with proxy server 1.   Yes
WorkflowSystem.ProxyPort2 Proxy server 2 port Specifies TCP/IP port that RICOH ProcessDirector uses to communicate with proxy server 2.   Yes
WorkflowSystem.ProxyServer Proxy server 1 Specifies either the network IP address or the fully qualified host name of the proxy server 1. RICOH ProcessDirector uses a proxy server to connect to external web sites.   Yes
WorkflowSystem.ProxyServer2 Proxy server 2 Specifies either the network IP address or the fully qualified host name of the proxy server 2. RICOH ProcessDirector uses a proxy server to connect to external web sites.   Yes
WorkflowSystem.ProxyUser Proxy server 1 user Specifies the user name that RICOH ProcessDirector uses when proxy server 1 connects to an external web site.   Yes
WorkflowSystem.ProxyUser2 Proxy server 2 user Specifies the user name that RICOH ProcessDirector uses when proxy server 2 connects to an external web site.   Yes
WorkflowSystem.RememberPrinterStatus Remember enabled status of printers Specifies whether RICOH ProcessDirector restores the state of enabled printers after a system shutdown.
  • No
  • Yes
Yes
WorkflowSystem.RetainPollInterval Retention polling interval (minutes) Controls how often RICOH ProcessDirector polls jobs that are retained on the system to determine if any further action is necessary.   Yes
WorkflowSystem.SMTPPassword SMTP password Specifies the password that RICOH ProcessDirector uses to login to the SMTP Server.   Yes
WorkflowSystem.SMTPPort SMTP port Specifies the TCP/IP port that the SMTP server uses.   Yes
WorkflowSystem.SMTPServer SMTP server Specifies either the network IP address or the fully-qualified host name of the SMTP server that RICOH ProcessDirector uses to send email.   Yes
WorkflowSystem.SMTPUsername SMTP user name Specifies the user name that RICOH ProcessDirector uses to connect to the SMTP Server.   Yes
WorkflowSystem.SystemIdentifier System identifier Specifies an alternate name for the system to show in the user interface.   Yes
WorkflowSystem.TraceCustomTraceLevel Custom trace level When the Custom option is selected for the Trace level property, shows the trace level that is active for the system.   Yes
WorkflowSystem.TraceFileCount Maximum number of trace files Shows the maximum number of trace files that can be created on the system.   Yes
WorkflowSystem.TraceFileSize Maximum trace file size Shows the upper size limit in kilobytes (KB) for trace files that the system creates.   Yes
WorkflowSystem.TraceLevel Trace level Shows the level of tracing that is active on the system.   Yes

1.2.10.30.13 Database property names for users

Messages about users and their passwords might refer to properties by their database names, which begin with User.

In the Editable column:

  • Yes means that a user can change the value after the user is created.
  • No means that a user cannot change the value.

User properties
Database name Field name Brief description Editable
User.Description User description Contains text that describes the user name. Yes
User.Groups Group membership Contains the name of the group or groups that the user belongs to. Yes
User.ID Displayed in the page title Contains the user name for an authorized user of RICOH ProcessDirector. No
User.LastModified Last Modified The date and time that the user was last changed. RICOH ProcessDirector updates the value whenever the user changes. No
User.Login.Status Logged in Specifies whether a user is logged in to RICOH ProcessDirector. No
User.LocationFilterPreference Locations to show Shows which locations are currently used to filter the user interface. Only objects from locations selected in this list are displayed. Yes
User.LocationSettings Allowed locations Several objects such as jobs, printers, and input devices have a Location property. The Allowed locations property lets you specify which locations a user can access. The setting affects which objects the user can see in the user interface. The user can select which location to use to filter the user interface using the Locations to show property. Yes
User.ModifiedBy Modified by user Specifies the user who made the last change to this input device. RICOH ProcessDirector maintains the value of this property, and updates the value whenever the input device changes. No
User.Password User password Accepts the password for the user. Yes
User.PasswordConfirm Confirm new user password Specifies the password for the new user. Must match the New user password value. Yes
User.PasswordLastChanged Password last changed Specifies the date and time when the password was last changed. No
User.PasswrodNew New user password Specifies the password for the new user. Yes
User.StartPage Start page Specifies which page RICOH ProcessDirector displays after you log in. When a new user is created, this control is not available until a Group membership value is selected. Yes

1.2.10.30.14 Database property names for workflows

Messages about jobs might refer to workflow properties by their database names, which begin with JobType.

In the Editable column:

  • Yes means that an authorized user can change the value after the workflow has been created.
  • No means that an authorized user cannot change the value.

Workflow properties
Database name Notebook field name Brief description Editable
Connector.AnyOrAllFieldHelp Apply any or all of the following conditions Specifies whether a job must meet all of the conditions specified by a rule or any one of the conditions. Yes
Connector.ConditionPredicate Summary The Summary field shows your selections in the Conditions area in a database query format. The value changes as you modify conditions. Yes
Connector.JsonRule Conditions Lets you define one or more conditions for a rule. Each condition consists of a job property, a comparison, and a value. Yes
Connector.Order Order of execution When multiple connectors exit a single step, RICOH ProcessDirector must determine which connector the job should follow to the next step. This value indicates which connector RICOH ProcessDirector should evaluate first, second, third, and so on, when it tries to choose which connector the job should use. Yes
Job.CurrentDay Current day Specifies the current day of the week of the server RICOH ProcessDirector is running on when a condition requesting it is evaluated. Yes
Job.CurrentTime Current time Specifies the current time of the server that RICOH ProcessDirector is running on when a condition requesting it is evaluated. Yes
JobType.ChangeId Alternate ID Specifies an alternate ID for the workflow. Yes
JobType.CreatedBy Created by Specifies the ID of the extension that created the workflow. No
JobType.Description Description Contains text that describes the workflow. Yes
JobType.GroupName Group name Specifies the name of the group the workflow belongs to. Yes
JobType.LastModified Last modified The date and time that the workflow was last changed. No
JobType.Location Workflow location Specifies the location associated with a workflow. Yes
JobType.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this workflow. No
JobType.Owner Owner Specifies the owner of the workflow. Yes
JobType.SourceID Source ID Specifies the ID of the workflow. No
StepChain.Color Color Specifies the color of the step chain as it appears in the workflow. Yes
StepChain.Description Step chain description Describes the function of the step chain. Yes
StepChain.ID Step chain name Specifies the name for the step chain. No
StepChain.LastModified Last modified The date and time that the step chain was last changed. No
StepChain.ModifiedBy Modified by user Specifies the name of the user who made the last change to this step chain. No
StepChain.Owner Owner Specifies the owner of the step chain. Yes
StepChain.Usage Step chain usage Specifies what the group of steps in the step chain are used for. Yes

1.2.10.30.15 Database property names for AFP

Messages might refer to AFP properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

AFP properties
Database name Notebook field name Brief description Internal values Editable
AFP2PCL.Command Printer command Specifies the command that is used to submit jobs to the printer.   Yes
AFP2PCL.OutputDataStream Printer output data stream Specifies the data stream that the AFP input data stream is converted into before it is sent to the printer.
  • PCL4
  • PCL5
  • PCL5C
Yes
AFPPrinter.AccountingExit Enable accounting exit Specifies whether RICOH ProcessDirector calls an accounting exit program to collect data used for job accounting.
  • Yes
  • No
Yes
AFPPrinter.AccountingExitName Accounting exit program Specifies the name of an accounting exit program to collect data used for job accounting.   Yes
AFPPrinter.BannerPageType Banner page type Specifies the type of header, trailer, and separator sheets that print for jobs.
  • Impact
  • Narrow
  • Wide
Yes
AFPPrinter.CSESheetEject Force new CSE sheet on jog Specifies whether RICOH ProcessDirector should insert a blank sheet between copies or copy groups when jogging.
  • Yes
  • No
Yes
AFPPrinter.CSESheetEjectEOJ Force new CSE sheet at end of job Specifies whether RICOH ProcessDirector should eject the last sheet at the end of each job, forcing the job through the paper path after the last sheet is printed.
  • Yes
  • No
Yes
AFPPrinter.Duplex Duplex Specifies the type of duplexed printing that the printer does if no other duplex information is received for the job.
  • Yes
  • No
  • Tumble
Yes
AFPPrinter.FontFidelity Font fidelity Specifies whether the printer continues printing the job when it cannot locate a font that the job requires.
  • Continue
  • Stop
Yes
AFPPrinter.FontResolution Font resolution Specifies the resolution of the AFP fonts that the printer uses.
  • 240
  • 300
  • Outline
Yes
AFPPrinter.ForceMicrFontPrint Override MICR setting Specifies whether or not jobs that request magnetic ink character recognition (MICR) fonts should be sent to a printer that is not enabled for MICR printing.
  • No
  • Yes
Yes
AFPPrinter.HeaderExitFormdef Header page form definition Specifies the name of the AFP form definition that the printer uses when it prints the header page for the job.   Yes
AFPPrinter.HeaderExitName Header page exit program Specifies the path to, and the name of the exit program that generates the header page for the job. 1–255 characters (case-sensitive) Yes
AFPPrinter.IMPFormdef Interrupt message page form definition Identifies the form definition to use when formatting interrupt message pages.   Yes
AFPPrinter.InactivityTimer Inactivity timer (seconds) Specifies the number of seconds that the printer driver component of RICOH ProcessDirector maintains the connection to an idle printer.   Yes
AFPPrinter.IndataExit Enable input data exit Specifies whether RICOH ProcessDirector calls an input data exit program before it prints the job.
  • No
  • Yes
Yes
AFPPrinter.IndataExitName Input data exit program Specifies the path and the name of the input data exit program.   Yes
AFPPrinter.InterruptMessagePage Interrupt message page Specifies whether an interrupt message page prints if the printer receives an interrupt request for the job.
  • No
  • Yes
Yes
AFPPrinter.JobCompletionExit Enable job completion exit Specifies whether RICOH ProcessDirector calls a job completion exit program after it prints the job.
  • No
  • Yes
Yes
AFPPrinter.JobCompletionExitName Job completion exit program Specifies the path to and the name of the job completion exit program.   Yes
AFPPrinter.JobMessageLog Save messages in log Specifies whether RICOH ProcessDirector saves messages, such as data stream errors, in a log or prints them with the job.
  • No
  • Yes
Yes
AFPPrinter.MaxContainers Maximum presentation objects Specifies the maximum number of AFP presentation object containers that the printer should retain in memory between jobs.   Yes
AFPPrinter.MaxFonts Maximum number of fonts Specifies the maximum number of AFP fonts that the printer should retain in memory between jobs.   Yes
AFPPrinter.MaxOverlays Maximum number of overlays Specifies the maximum number of AFP overlays that the printer should retain in memory between jobs.   Yes
AFPPrinter.MaxSegments Maximum number of page segments Specifies the maximum number of AFP page segments that the printer should retain in memory between jobs.   Yes
AFPPrinter.MessageFontType Message page font type Specifies the font that the printer uses to print any message pages for jobs.
  • Condensed
  • Normal
Yes
AFPPrinter.MessageFormdef Message page form definition Specifies the form definition that the printer uses to print any message pages for jobs.   Yes
AFPPrinter.MIDReleaseTimer IPDS printer connection timer (seconds) Specifies the number of seconds that the printer driver component of RICOH ProcessDirector maintains control of an idle physical printer.   Yes
APFPrinter.MIDSupportEnabled Share printer connection Specifies whether the printer driver can release control of the physical printer to let it receive jobs from another input source, such as a hot folder.
  • No
  • Yes
Yes
AFPPrinter.OutDataExit Enable output data exit Specifies whether RICOH ProcessDirector calls an output data exit program that monitors data from the server to the AFP printer.
  • No
  • Yes
Yes
AFPPrinter.OutDataExitName Output data exit program Specifies the name of a program that monitors output data from the server to the AFP printer.   Yes
AFPPrinter.Overlay Default overlay Specifies an AFP overlay that is assigned to the printer.   Yes
AFPPrinter.PresentationCheck Presentation check errors Specifies the type of presentation errors that cause the printer to stop printing the job.
  • All
  • Barcode
  • Image
  • None
Yes
AFPPrinter.PSFTraceCustomizedTraceGroup Custom trace group When the Custom option is selected for the PSF trace group property, shows the PSF trace level that is active for the system.   Yes
AFPPrinter.PSFTraceGroup PSF trace group Shows the level of PSF tracing that is active on the system.   Yes
AFPPrinter.PSFTraceTraceFileSize Maximum PSF trace file size Shows the upper size limit in kilobytes (KB) for the PSF trace file.   Yes
AFPPrinter.PSFTraceWrapping Wrap PSF trace file Shows how RICOH ProcessDirector records the information collected by the PSFAPI trace.   Yes
AFPPrinter.ResourcePath AFP resource path Specifies one or more directories that RICOH ProcessDirector searches for the AFP resources that the job requires.   Yes
AFPPrinter.SeparatorExitFormdef Separator page form definition Specifies the name of the AFP form definition that the printer uses when it prints separator pages between copies in multi-copy jobs.   Yes
AFPPrinter.SeparatorExitName Separator page exit program Specifies the path and name of the exit program that generates the separator page for the job. 1–255 characters (case-sensitive) Yes
AFPPrinter.TrailerExitFormdef Trailer page form definition Specifies the name of the AFP form definition that the printer uses when it prints the trailer page for the job.   Yes
AFPPrinter.TrailerExitName Trailer page exit program Specifies the path and name of the exit program that generates the trailer page for the job. 1–255 characters (case-sensitive) Yes
Printer.Class Printer class Specifies the output class or classes for the printer.   Yes
Printer.Destination Printer destination Specifies a destination name for the printer.   Yes
Printer.Form Printer form Specifies the form name that is assigned to the printer.   Yes
Printer.SeparatorExit Enable separator pages Specifies whether the printer prints a separator page after the last page of each copy of a job.
  • No
  • Yes
Yes
PSFPrinter.AccountingMark Accounting page edge marks Specifies whether the printer prints page edge marks (also called mark forms) on the accounting page for the job.
  • No
  • Yes
Yes
PSFPrinter.AckInterval Acknowledgement interval (pages) Specifies how often RICOH ProcessDirector sends requests to the printer to acknowledge that pages have stacked.   Yes
PSFPrinter.AuditMark Audit page edge marks Specifies whether the printer prints page edge marks (also called mark forms) on the audit page for the job.
  • No
  • Yes
Yes
PSFPrinter.CMT Color mapping table Specifies the color mapping table (CMT) to use for printing jobs when the job Color mapping table property has no value.   Yes
PSFPrinter.ConnectionTimeout Connection timer (seconds) Specifies the amount of time, in seconds, that RICOH ProcessDirector waits before it stops trying to communicate with the printer when it cannot make a connection.   Yes
PSFPrinter.CSE Cut sheet Emulation Specifies whether the printer prints with cut sheet emulation.
  • No
  • Yes
Yes
PSFPrinter.EdgeMarks Job edge marks Specifies whether the printer prints print edge marks (also called copy marks) on each sheet of the job.
  • No
  • Yes
Yes
PSFPrinter.HeaderMark Header page edge marks Specifies whether the printer prints page edge marks (also called mark forms) marks on the header page for the job.
  • No
  • Yes
Yes
PSFPrinter.IMPMark Interrupt message page edge marks Specifies whether the printer prints page edge marks (also called mark forms) on the interrupt message page for the job.
  • No
  • Yes
Yes
PSFPrinter.NPROTimer NPRO timer (seconds) Specifies the number of seconds that a continuous-forms printer waits for the next job to arrive, after the last page of the current job prints.   Yes
PSFPrinter.SeparatorMark Separator page edge marks Specifies whether the printer prints page edge marks (also called mark forms) on the separator pages for the job.
  • No
  • Yes
Yes
PSFPrinter.TCPIP.Port Printer TCP/IP port number Specifies the communications port for the printer.   Yes
PSFPrinter.TrailerMark Trailer page edge marks Specifies whether the printer prints page edge marks (also called mark forms) on the trailer page for the job.
  • No
  • Yes
Yes
WorkflowSystem.ITMCapture Capture transform data Shows whether information about RICOH Transform features (excluding the Advanced Transforms) is included in the capture file.
  • No
  • Yes
Yes
WorkflowSystem.PSFAPI PSFAPI trace Shows whether tracing for the print driver component is enabled.
  • Off
  • On
Yes
WorkflowSystem.PSFAPI.Wrap PSFAPI trace wrap Shows whether wrapping is enabled for the print driver component trace.
  • Off
  • On
Yes
WorkflowSystem.PSFAPI.Wrap.Size PSFAPI trace wrap size Shows the upper size limit in megabytes (MB) for the psfapi.log file that the system creates.   Yes
WorkflowSystem.PSFCapture Capture PSF data Shows whether information about the print driver component is included in the capture file.
  • No
  • Yes
Yes
WorkflowSystem.PSFIN PSFIN trace Shows whether additional internal tracing for the print driver component is enabled.
  • No
  • Yes
Yes
WorkflowSystem.SaveSegmentFiles Save segment files Shows whether the segment files created by the print driver are included in the capture file.
  • No
  • Yes
Yes
WorkflowSystem.Transform.ServerAddress Transform server IP address or host name Specifies either the network IP address or the host name of the RICOH ProcessDirector Transform feature or InfoPrint Transform Manager server.   Yes
WorkflowSystem.Transform.ServerPort Transform server port number Specifies the communications port through which RICOH ProcessDirector communicates with the data transform program.   Yes
zOSDownload.EParm Report errors Specifies whether the input device reports internal processing errors to AFP Download Plus to assist with problem determination.
  • No
  • Yes
Yes
zOSDownload.HostCodePage Host code page Specifies the code page that the input device uses to read the contents of any files that accompany print files, such as JCL and list files.   Yes
zOSDownload.Language Device language Specifies the language that the programs that interact with the input device should use when they return messages.
  • de_DE
  • en_US
  • es_ES
  • fr_FR
  • it_IT
  • ja_JP
Yes
zOSDownload.MDFile Destination control file Specifies the full path and name of a file that the Download input device reads to set the AFP resource path used to search for resources for each data set.   Yes
zOSDownload.MergeDataset Merge dataset Specifies whether the system merges a multi-dataset job from Download for z/OS or AFP Download Plus into a single job.
  • No
  • Yes
Yes
zOSDownload.PortNumber Port number Specifies the port through which a Download input device listens for new input files.   Yes
zOSDownload.WParm Send return code to host Specifies some rules for communication between RICOH ProcessDirector and the host system that submits jobs to this input device using AFP Download Plus.
  • No
  • Yes
Yes

1.2.10.30.16 Database property names for AFP jobs

Messages might refer to AFP job properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

AFP properties
Database name Notebook field name Brief description Internal values Editable Job ticket
Job.AfpZip.ExternalCommand External command Specifies a command string that launches a command on each individual file within the ZIP file. The command is executed for each AFP file in the ZIP file before it is combined into a single AFP file.   Yes No
Job.BannerFormDef Banner page form definition Specifies the name of the AFP form definition that the BuildAFPFromZip step uses when it adds a header or trailer page to the job it creates. The form definition controls the placement of data on the banner pages. It also defines other formatting information, such as a bin number for the printer device. For example, with cut-sheet printers, the header page can print on paper that is a different color than the paper color for the job.   Yes No
Job.Class Job class Contains the output class for the job   Yes No
Job.CMR.ColorMode Color mode Specifies whether the step should insert a color or monochrome CMR in the job.
  • Color
  • Monochrome
Yes No
Job.CMR.InkType Ink type Specifies whether the printer uses pigment or dye ink so the step can insert the correct type of CMR.
  • Pigment
  • Dye
Yes No
Job.CMR.InputCMYKProf Audit color CMR Specifies the audit CMR that this step inserts for color print jobs. The printer uses this CMR to convert jobs to the device-independent color space; it should correspond to the color profile or CMR that was used to create the color elements of the job, such as logos or images.   Yes No
Job.CMR.InputGrayProf Audit grayscale CMR Specifies the audit CMR that this step inserts for grayscale print jobs. The printer uses this CMR to convert jobs to the device-independent color space; it should correspond to the color profile or CMR that was used to create the grayscale elements of the job, such as charts or images.   Yes No
Job.CMR.Mode Processing mode Specifies whether the step should insert an audit or instruction CMR into the job.
  • Audit
  • Instruction
Yes No
Job.CMR.OutputCMYKProf Instruction color CMR Specifies the instruction CMR that this step inserts for color print jobs. The printer uses this CMR to convert jobs to a device-specific color space for the printer.   Yes No
Job.CMR.OutputGrayProf Instruction grayscale CMR Specifies the instruction CMR that this step inserts for grayscale print jobs. The printer uses this CMR to convert jobs to a device-specific color space for the printer.   Yes No
Job.CMR.PrinterType Printer type Specifies the type of printer that is going to print the job.
  • InfoPrint 5000 - 32/64 m/min
  • InfoPrint 5000 - 128 m/min
Yes No
Job.CMR.RenderingIntent Rendering intent Specifies the rendering intent that this step should associate with the job. Rendering intents inform the printer what action to take when a print job includes colors that lie outside the color range of the printer.
  • Perceptual
  • Media-Relative Colorimetric
  • Saturation
  • ICC-Absolute Colorimetric
Yes No
Job.Destination Job destination Specifies the name of the job destination. RICOH ProcessDirector uses this value to schedule the job to a printer that has the same destination value assigned to its Printer destination property.   Yes No
Job.EnableHeader Include header pages Specifies whether the BuildAFPFromZip step adds header pages before each file that it adds to the job.
  • Yes
  • No
Yes No
Job.EnableTrailer Include trailer pages Specifies whether the BuildAFPFromZip step adds trailer pages after each file that it adds to the job.
  • Yes
  • No
Yes No
Job.Form Job form Specifies the name of the form that the job requires. RICOH ProcessDirector uses the form value to schedule the job to a printer that has the same form value for its Printer form property.   Yes No
Job.Host.Device Host device Specifies the device name that was passed with the input file from z/OS. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by the Download input device.   Yes No
Job.Host.GroupName Host group name Specifies the group name. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by the Download input device.   Yes No
Job.Host.JesID JES job ID Specifies the JES job ID that was assigned to the data set on z/OS.   Yes No
Job.Host.UserID Host user ID Specifies the name of the z/OS user who submitted the data set on the z/OS system.   Yes No
Job.Host.Writer Host writer name Specifies the name of the z/OS external writer. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by a Download input device.   Yes No
Job.Info.Address1 Address line 1 Specifies the first line of address information for the job. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by a Download input device.   Yes No
Job.Info.Address2 Address line 2 Specifies the second line of address information for the job. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by a Download input device.   Yes No
Job.Info.Address3 Address line 3 Specifies the third line of address information for the job. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by a Download input device.   Yes No
Job.Info.Address4 Address line 4 Specifies the fourth line of address information for the job. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by a Download input device.   Yes No
Job.Info.Building Building information Specifies building information for the job. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by a Download input device.   Yes No
Job.Info.Department Department information Specifies department information for the job. RICOH ProcessDirector sets the value of this property when it reads the JCL file for the data set that was received by a Download input device.   Yes Yes
Job.Info.DownloadFileType Download file type Specifies the job file type. RICOH ProcessDirector sets the value of this property from the -ofiletype parameter in the JCL file for a data set received from AFP Download Plus.
  • dshdr
  • jobhdr
  • jobtrl
  • message
  • userdata
No No
Job.Info.NodeID Node ID Specifies the name of the z/OS system that submitted the data set to RICOH ProcessDirector through AFP Download Plus or Download for z/OS.   Yes No
Job.Info.Programmer Programmer information Specifies the name of the programmer that was passed with the data set when it was received by a Download input device.   Yes No
Job.Info.RecdTotalPages Received pages Shows the number of pages that AFP Download Plus created for this job.   No No
Job.Info.RecdTotalSheets Received sheets Shows the number of sheets that AFP Download Plus created for this job.   No No
Job.Info.Room Room information Specifies room information for the job.   Yes No
Job.Info.Title Title information Specifies title information for the job.   Yes No
Job.Line2AFP.CC Carriage controls present Specifies whether carriage controls are present in the job.
  • No
  • Yes
Yes No
Job.Line2AFP.CC_TYPE Carriage control type Specifies the type of carriage controls that are present in the job.
  • A
  • M
  • Z
Yes Yes
Job.Line2AFP.CHARS CHARS Specifies the file names of up to four AFP coded fonts.   Yes No
Job.Line2AFP.CPGID Code page global identifier Specifies a three-character or four-character identifier for an IBM-registered code page.   Yes No
Job.Line2AFP.EXTENSIONS Extended options Specifies the extended options that the line2afp data-stream conversion component of RICOH ProcessDirector uses when it converts the job into the AFP format.
  • ALL
  • BOX
  • CELLED
  • FRACLINE
  • PASSOID
  • PRCOLOR
  • RESORDER
  • SPCMPRS
  • PASSPF

Multiple values can be submitted using a comma-separated list.

Yes No
Job.Line2AFP.FILEFORMAT Line data file format Specifies whether the data in the job is record oriented or stream oriented.   Yes No
Job.Line2AFP.FORMDEF Form definition Specifies the form definition to use with the job.   Yes Yes
Job.Line2AFP.IMAGEOUT Image output format Specifies how the line2afp data-stream conversion component of RICOH ProcessDirector converts IM1 format images in input files, overlays, and page segments.
  • ASIS
  • IOCA
Yes No
Job.Line2AFP.MCF2REF Map Coded Font Format 2 method Specifies how to build Map Coded Font Format 2 (MCF-2) structured fields.   Yes No
Job.Line2AFP.PAGEDEF Page definition Specifies the AFP page definition to use with the job.   Yes Yes
Job.Line2AFP.PRMODE Processing mode Specifies the type of data in the input file, and whether the RICOH ProcessDirectorline2afp data-stream conversion component must perform any optional processing of the data.   Yes No
Job.Line2AFP.RESTYPE Resource type Specifies the type or types of AFP resources that RICOH ProcessDirector should retrieve from the AFP resource directories for the job.
  • ALL
  • BCOCA
  • CMRALL
  • CMRGEN
  • FDEF
  • FONT
  • GOCA
  • INLINE
  • INLONLY
  • IOCA
  • OBJCON
  • OVLY
  • PSEG

Multiple values can be submitted using a comma-separated list.

Yes No
Job.Line2AFP.TRC Table reference characters Specifies whether table reference characters are present in the job.
  • No
  • Yes
Yes Yes
Job.Line2AFP.ValidRCs Valid return codes Lists return code values that the line2afp program can issue, which indicate that the program ran successfully.   Yes No
Job.Print.CMT Color mapping table Specifies the color mapping table (CMT) to use for printing the job.   Yes No
Job.Print.DataCheck Data check errors Specifies whether the AFP printer blocks certain types of errors.
  • BlkChar
  • BlkPos
  • Block
  • Unblock
Yes No
Job.Print.FontFidelity Font fidelity Specifies whether the AFP printer continues printing the job when it cannot locate a font that the job requires.
  • Continue
  • Stop
Yes No
Job.Print.FontMessages Font substitution messages Specifies whether the AFP printer driver program issues messages when font substitutions occur.
  • No
  • Yes
Yes No
Job.Print.FontResolution Font resolution Specifies the resolution of the fonts that the AFP printer uses for the job.
  • 240
  • 300
  • Outline
Yes No
Job.Print.JogCopies Jog output copies Specifies whether the AFP printer jogs the output copies for the job.
  • No
  • Yes
Yes Yes
Job.Print.MessageCount Number of messages to print Specifies how many messages the AFP printer prints for the job.   Yes No
Job.Print.Overlay Overlay Specifies the name of an overlay that prints on every page of the job.   Yes No
Job.Print.PSFINSegmentSize AFP segment size (kilobytes) Specifies the size, in kilobytes, of the segment files into which RICOH ProcessDirector breaks up AFP jobs for printing.   Yes No
Job.Print.ResourcePath AFP resource path Specifies one or more directories in which RICOH ProcessDirector searches for the AFP resources that the job requires.   Yes No
Job.Print.SeparatorConfig Separator page configuration file Specifies the path to and the name of the configuration file that RICOH ProcessDirector uses to create the content and format of the separator page that prints between copies of a multi-copy AFP job.   Yes No
Job.Print.SeparatorCopies Separator copies Specifies the number of separator pages that RICOH ProcessDirector should print between copies of a multi-copy AFP job.   Yes No
Job.Print.TerminateMessageCount Number of messages to stop job Specifies how many error messages can be issued while the job prints on an AFP printer before RICOH ProcessDirector ends the job.   Yes No
Job.Print.Xoffset X offset Specifies the offset in the x or horizontal direction of the logical page origin from the media origin.   Yes Yes
Job.Print.Yoffset Y offset Specifies the offset in the y or vertical direction of the logical page origin from the media origin.   Yes Yes
Job.Transform.Datastream Transform output data stream Specifies the format of the print job that InfoPrint Transform Manager returns to RICOH ProcessDirector.
  • afp
  • pcl
  • pdf
  • ps
No No
Job.Transform.GenerateIS3 Create IS/3 compliant AFP Specifies whether the AFP produced by the TransformJobIntoAFP step template meets the requirements of the IS/3 interchange set of the AFP architecture.
  • Yes
  • No
Yes No
Job.Transform.Halftone Transform halftone Specifies the halftone that is applied to the job during transform processing.
  • ibm106lpiRot90_accutone
  • ibm106lpiRot90_dark
  • ibm106lpiRot90_dark2
  • ibm106lpiRot90_ highlight_midtones
  • ibm106lpiRot90_standard
  • ibm106lpi_accutone
  • ibm106lpi_dark
  • ibm106lpi_dark2
  • ibm106lpi_dark_enhtoner
  • ibm106lpi_highlight _midtones
  • ibm106lpi_highlight _midtones _enhtoner
  • ibm106lpi_standard
  • ibm106lpi_standard _enhtoner
  • ibm121lpiRot90_accutone
  • ibm121lpiRot90_dark
  • ibm121lpiRot90_dark2
  • ibm121lpiRot90_ highlight_midtones
  • ibm121lpiRot90_standard
  • ibm121lpi_accutone
  • ibm121lpi_dark
  • ibm121lpi_dark2
  • ibm121lpi_highlight _midtones
  • ibm121lpi_standard
  • ibm141lpiRot90_accutone
  • ibm141lpiRot90_dark
  • ibm141lpiRot90_dark2
  • ibm141lpiRot90_ highlight_midtones
  • ibm141lpiRot90_standard
  • ibm141lpi_accutone
  • ibm141lpi_dark
  • ibm141lpi_dark2
  • ibm141lpi_dark_enhtoner
  • ibm141lpi_highlight _midtones
  • ibm141lpi_highlight_ midtones_enhtoner
  • ibm141lpi_standard
  • ibm141lpi_standard _enhtoner
  • ibm150lpi_dark
  • ibm150lpi_highlight _midtones
  • ibm150lpi_standard
  • ibm200lpi_dark
  • ibm200lpi_highlight _midtones
  • ibm200lpi_standard
  • ibm71lpiRot90_accutone
  • ibm71lpiRot90_dark
  • ibm71lpiRot90_dark2
  • ibm71lpiRot90_ highlight_midtones
  • ibm71lpiRot90_standard
  • ibm71lpi_accutone
  • ibm71lpi_dark
  • ibm71lpi_dark2
  • ibm71lpi_dark_enhtoner
  • ibm71lpi_highlight_ midtones
  • ibm71lpi_highlight_ midtones_enhtoner
  • ibm71lpi_standard
  • ibm71lpi_standard_enhtoner
  • ibm85lpiRot90_accutone
  • ibm85lpiRot90_dark
  • ibm85lpiRot90_dark2
  • ibm85lpiRot90_highlight_ midtones
  • ibm85lpiRot90_standard
  • ibm85lpi_accutone
  • ibm85lpi_dark
  • ibm85lpi_dark2
  • ibm85lpi_dark_enhtoner
  • ibm85lpi_highlight_ midtones
  • ibm85lpi_highlight_ midtones_enhtoner
  • ibm85lpi_standard
  • ibm85lpi_standard_enhtoner
  • ibm85lpiRot90_accutone
  • ibm85lpiRot90_dark
  • ibm85lpiRot90_dark2
  • ibm85lpiRot90_ highlight_midtones
  • ibm85lpiRot90_standard
  • ibm85lpi_accutone
  • ibm85lpi_dark
  • ibm85lpi_dark2
  • ibm85lpi_dark_enhtoner
  • ibm85lpi_highlight_ midtones
  • ibm85lpi_highlight_ midtones_enhtoner
  • ibm85lpi_standard
  • ibm85lpi_standard_enhtoner
Yes No
Job.Transform.ImageOut Transform image output format Specifies the type of AFP image that the data transform program generates.
  • FS45
  • IM1
  • IO1
  • IO1_G4
  • IO1_MMR
Yes No
Job.Transform.RipFor Transform RIP for printer Specifies the printer model that the job is transformed for. Authorized users can set this property.
  • IBM_Infoprint1120
  • IBM_Infoprint1125
  • IBM_Infoprint1130
  • IBM_Infoprint1140
  • IBM_Infoprint1145
  • IBM_Infoprint1226
  • IBM_Infoprint1332
  • IBM_Infoprint1352
  • IBM_Infoprint1372
  • IBM_Infoprint20
  • IBM_Infoprint2000
  • IBM_Infoprint2000AFP
  • IBM_Infoprint2060ES
  • IBM_Infoprint2075ES
  • IBM_Infoprint2085
  • IBM_Infoprint2090ES
  • IBM_Infoprint21
  • IBM_Infoprint2105
  • IBM_Infoprint2105ES
  • IBM_Infoprint2190
  • IBM_Infoprint2210
  • IBM_Infoprint2235
  • IBM_Infoprint3000
  • IBM_Infoprint32
  • IBM_Infoprint40
  • IBM_Infoprint4000
  • IBM_Infoprint4000_708
  • IBM_Infoprint4000_ID5_ID6
  • IBM_Infoprint4000_IR3_IR4
  • IBM_Infoprint4100_ HD1_HD2
  • IBM_Infoprint4100_ HD3_HD4
  • IBM_Infoprint4100_ HD5_HD6
  • IBM_Infoprint4100_HS1
  • IBM_Infoprint4100_HS2
  • IBM_Infoprint4100_HS3
  • IBM_Infoprint4100_ MD1_MD2
  • IBM_Infoprint4100_MS1
  • IBM_Infoprint4100_PD1_PD2
  • IBM_Infoprint4100_PD3_PD4
  • IBM_Infoprint4100_PS1
  • IBM_Infoprint4100_PS2
  • IBM_Infoprint45
  • IBM_Infoprint60
  • IBM_Infoprint70
  • IBM_InfoprintColor100AFP
  • IBM_InfoprintColor130Plus
  • InfoPrint5000_AD1_AD2
  • InfoPrint5000_AS1
  • RequestedPrinter
Yes No

1.2.10.30.17 Database property names for the Advanced Transform feature

Messages might refer to advanced transform properties by their database names. Administrators can use the database property names in symbol formulas that they specify for external programs. Administrators can also specify symbol formulas for properties in control files.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties. If an internal value is listed as a Timestamp, it is stored as a Coordinated Universal Time (UTC). UTC values are stored in this format: yyyy-mm-dd hh:mm:ss.fffffffff

  • yyyy is the 4-digit year
  • mm is the 2-digit numerical abbreviation for the month
  • dd is the 2-digit day
  • hh is the 2-digit hour
  • mm is the 2-digit minute
  • ss is the 2-digit second
  • fffffffff is the fraction of a second to 9 decimal places and is optional

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket.
  • No means that the property cannot be set from values in the job ticket.

Advanced Transform feature properties
Database name Notebook tab: field name Brief description Internal values Editable Job ticket
Job.Transform.AutoFormdef Transform: Create inline form definition Specifies whether the transform generates a form definition for AFP files.
  • No
  • Yes
Yes, for appropriate data stream No
Job.Transform.ColorOutput Transform: Preserve color in output Specifies whether the color information is preserved in the generated output.
  • No
  • Yes
Yes, for appropriate data stream No
Job.Transform.DefaultPaperSize Transform: Default paper size for PostScript Specifies the paper size to use when the input file does not include paper size information.
  • A3
  • A4
  • A4Tab
  • ledger
  • legal
  • letter
  • letterTab
  • manual
  • legalTab
Yes, for appropriate data stream No
Job.Transform.Duplex Transform: Duplex Specifies whether the transform should create duplex or simplex output.
  • No
  • Yes
Yes No
Job.Transform.EmbedFonts Transform: Include fonts in the output Specifies whether the transform embeds fonts into the PDF output file.
  • No
  • Yes
Yes, for appropriate data stream No
Job.Transform.FontFidelity Transform: Font fidelity Specifies whether the transform can substitute fonts in the AFP output if the requested fonts cannot be found.
  • Not set
  • Relaxed
  • Strict
Yes No
Job.Transform.GeneratePDFTOC Transform: Generate PDF TOC Specifies whether the transform generates a PDF table of contents based on the AFP index tags included in the input file.
  • No
  • Yes
Yes, for appropriate data stream No
Job.Transform.ICCProfile Transform: Path to ICC profile Specifies the fully qualified path to the ICC profile that the transform should use when it generates the output file.   Yes No
Job.Transform.ImageResolution Transform: IOCA transform resolution (dpi) For the AFP output of the Advanced transform feature, specifies the resolution of the IOCA images produced. The resolution of raster fonts is set with the Transform resolution property.   Yes No
Job.Transform.InputStream Transform: Transform input stream Specifies the file format of the input to the transform step. This list contains the input file formats that correspond with the installed advanced transform inputs.
  • afp
  • bmp
  • gif
  • jpeg
  • pcl
  • pdf
  • png
  • ps
  • tiff
Yes No
Note: If the value for this property is set to Use current, RICOH ProcessDirector uses the value of the Input data stream property as the input data stream for the transform. Input data stream can be set using the job ticket and the transform can use that value.
Job.Transform.OutlineFonts Transform: Use outline fonts Specifies whether the transform produces outline fonts for the AFP output file.
  • No
  • Yes
Yes, for appropriate data stream No
Job.Transform.OutputStream Transform: Transform output stream Specifies the output format that the transform step produces. This list contains the output file formats that correspond with the installed advanced transform outputs.
  • afp
  • pcl
  • pdf
  • ps
Yes No
Job.Transform.PageRange Transform: Page range to transform Specifies the page or page range that the transform should extract and convert to the output data stream.   Yes No
Job.Transform.PCLFullPrintableArea Transform: Use full printable area for PCL output Specifies whether the PCL output should use the full printable area on the page instead of the PCL standard area.
  • No
  • Yes
Yes, for appropriate data stream No
Job.Transform.PDFPageScalingFactor Transform: PDF page scaling factor Specifies the multiplier that the transform uses to scale the logical page of the output file.   Yes, for appropriate data stream No
Job.Transform.ProfilePath Transform: Path to custom profiles The name of the path where the transform profile files for the job are stored.   Yes No
Job.Transform.Render Transform: Render output as Determines the format of the AFP output produced by the transform.
  • Not set
  • All image
  • Text
  • Text as image
Yes No
Job.Transform.SelfContained Transform: Place resources inline Specifies whether the AFP file generated by the transform should include the form definition, medium map, overlay, code page, and character set resources that it uses inline with the job.
  • No
  • Yes
Yes, for appropriate data stream No
Job.Transform.SystemFontPath Transform: Path to system fonts Specifies the fully qualified path to the system fonts directory.   Yes No
Job.Transform.TrueTypePath Transform: Path to TrueType fonts Specifies the fully qualified path to the TrueType fonts directory.   Yes No

1.2.10.30.17.1 Database property names for OutputPDF and OutputPS transform options

Messages, configuration files, and functions in the user interface can refer to properties by their database names.

In the Editable column:

  • Yes means that you can change the value in the user interface. The value is stored with read and write access.
  • No means that you cannot change the value in the user interface. The value is stored with read access only.

Properties for OutputPDF and OutputPS transform options
Database name Notebook tab: field name Brief description Editable
Job.PER.OutputJDFFile Transform: Output JDF file Specifies the name of the JDF file containing the page exceptions produced by the step based on the GetTransformPageExceptions step template. Yes
Job.PER.TransformStepName Transform: Transform step name Specifies the name of a step based on the TransformWithAdvancedFeature step template. In the workflow, that step provides AFP input to the step based on the GetTransformPageExceptions step template. Yes

1.2.10.30.18 Database property names for Archive

Messages might refer to Archive properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Archive properties
Database name Notebook field name Brief description Editable
Doc.Member.Number User interface name: Member number (not displayed as field in property notebook) Specifies the member number in the document. The RepositorySample supplied workflow uses this property. No
Job.Exportrep.ExportInput Search criteria Specifies the properties and values the ExportFromRepository step uses to search the repository for data to export. Yes
Job.Exportrep.ExportInputType Criteria type Specifies whether the value in the Search criteria property is a file or a string. Yes
Job.Exportrep.ExportOutputFile Export results file Specifies the full path or symbolic name of the Comma Separated Values (CSV) file where the step writes the exported data. Yes
Job.Exportrep.HeaderFile Results file descriptor Specifies the path and file name to the file that lists which property values you want the ExportFromRepository step to retrieve from the repository and include in the export results file. Yes
Job.Exportrep.Repository Repository Specifies the repository to search for information to export. Yes
Job.Repository.DocPropToArchive Document properties to store Document properties that can be stored with the file. Yes
Job.Repository.EntryType Archive entry type Adds a custom label for the information that is stored in the repository by this step, such as Original job file, Preflight, Print data, or History only. Yes
Job.Repository.FileToArchive File to store Specifies the file you want to store in the repository. Yes
Job.Repository.JobPropToArchive Job properties to store Job properties that are stored for use in retrieving the file or history information. Yes
Job.Repository.LastNumOfRecordsExported Last number of records exported Specifies the number of records exported the last time that the ExportFromRepository step ran. No
Job.Repository.Overrides Path to override properties file Specifies the path and name of a text file that contains a list of job properties whose values you want to preserve for use when the job or its documents are resubmitted to a workflow. Yes
Job.Repository.RefAttributes Associated properties file Specifies the full path or symbolic name of the file that the StoreInRepository step can use to store one or more properties that are associated with the job, but that are properties of other objects. Yes
Job.Repository.Repository Repository Specifies the repository where the file is stored. Yes
Job.Repository.ResubmitFileName Repository Specifies the name of the file to resubmit. Yes
Job.Repository.StoreHistory Store history records Specifies whether the step stores production history collected by one or more history record notification objects. Yes
Job.Repository.DocFileToArchive Document properties file Specifies the name of a tab-delimited file containing property values to store in the repository. The file can contain values for document properties, fields that are not defined as RICOH ProcessDirector document properties, or a combination of both. Yes
Repository.Description Description Describes the repository. For example, it might describe the type of data that is deposited here. Yes
Repository.DiskSpace Disk space used (GB) Shows how much disk space is used by files in the repository. No
Repository.FileLocation Folder location Specifies the directory where the repository stores the data. The property can be changed by using the Change folder location action. No
Repository.FilesStored Files stored Shows the total number of Archive entries containing job or document data stored in the repository. Archive entries containing only history information or properties are not counted. No
Repository.ID Name Specifies the name of the repository. No
Repository.LastModified Last modified The date and time that the repository was last changed. No
Repository.Location Location Specifies the location associated with a repository. Yes
Repository.NextDelete Next deletion of expired files Shows the date and time when the next file with an expired Retention period is deleted. Yes
Repository.RetainDuration Retention period Specifies the period of time to store an archive entry in this repository. The unit of time for the value can be days, weeks, months, or years. The property can be changed by using the Change retention period action. No

1.2.10.30.19 Database property names for Automated Verification

Some messages refer to Automated Verification properties.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

Automated Verification properties
Database name Field name Brief description Internal values Editable
BarcodeReader.BarcodeFormat Barcode Format Specifies the barcode format used to determine where the values for the Job number and Document sequence number properties can be found in the set of data returned by the camera or barcode scanner.   Yes
BarcodeReader.Description Description Describes a barcode reader object. For example, the description might include details of where the camera or barcode scanner is placed, such as on an inserter exit or a printer output bin.   Yes
BarcodeReader.ID Name The name of the barcode reader.   Yes
BarcodeReader.IpAddress IP Address Specifies the IP address or hostname that RICOH ProcessDirector uses to connect to the camera or barcode scanner that you want to use with this barcode reader object.   Yes
BarcodeReader.LastModified Last modified The date and time when the barcode reader was last changed.   No
BarcodeReader.Location Barcode reader location Specifies the location associated with the barcode reader.   Yes
BarcodeReader.Port Port Specifies the port that RICOH ProcessDirector uses to connect to the camera or barcode scanner that you want to use with this barcode reader object.   Yes
BarcodeReader.State Barcode reader state Specifies whether the barcode reader detected invalid data.
  • OK
  • Attention
No
BarcodeReader.Status Connection status Specifies the status of the barcode reader.
  • Connected
  • Disconnected
No
Doc.AV.ScanCount Scan count Shows the total number of times the barcode on a document is scanned.   No
Doc.ChildJobID Not displayed in property notebook The job ID of the job that added the document   No
Doc.CurrentFirstPage Not displayed in property notebook The page number of the first page of the document in the current print file.   No
Doc.CurrentPages Not displayed in property notebook The number of pages for the document in the current job.   No
Doc.CurrentSheets Current sheets The number of sheets for the document in the current job.   No
Doc.DataLen Not displayed in property notebook The length of the document in bytes in the original file.   No
Doc.DataOffset Not displayed in property notebook The offset of the document in bytes from the start of the original file.   No
Doc.ID Document number A unique identifier for a document in the document database; defined automatically when WriteDocumentsToDatabase runs.   No
Doc.Insert.Sequence Insert sequence Shows the position of the document in the job.   No
Doc.OriginalFirstPage Original first page The page number of the first page of the document in the original job.   No
Doc.OriginalJobID Original job number The number of the job that received the document into the system.   No
Doc.OriginalPages Original pages The number of pages in the document in the original job.   No
Doc.OriginalSequence Sequence in original job The relative position of this document in the original job. For example, the first document in the job displays a value of 1, the second document in the job displays a value of 2.   No
Doc.OriginalSheets Sheets The number of sheets for the document in the original job.   No
Doc.SequenceInChild Not displayed in property notebook The sequence of the document in the child job.   No
Doc.State State The state of the document.   No
Doc.TT.BarcodeScanTime1 Document scanned 1 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime2 Document scanned 2 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime3 Document scanned 3 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime4 Document scanned 4 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeScanTime5 Document scanned 5 Shows the date and time when a camera or barcode scanner associated with a ReadBarcodeData step reads the barcode on a document.   No
Doc.TT.BarcodeStatus1 Document status 1 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus2 Document status 2 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus3 Document status 3 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus4 Document status 4 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.TT.BarcodeStatus5 Document status 5 Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
  • OK
  • Attention
  • Duplicate
No
Doc.Verification.Recipient Verification recipient Specifies information, such as account name, that helps you to identify a document.   No
Job.Conditions.ChangeJobType New workflow Specifies the new workflow to which this job is transferred.   Yes
Job.Doc.ChildJobType Child workflow Specifies the workflow for the child jobs that are created.   Yes
Job.Doc.CreatedDocumentCount Created document count Specifies the number of documents created by the first WriteDocumentsToDatabase step that processes a job. This value represents the number of documents that were contained in the original job; it does not change as the job moves through its workflow, even if documents are reprinted.   No
Job.Doc.DocumentCount Document count Specifies the total number of documents in a job. The value of this property displays only after a step based on WriteDocumentsToDatabase or UpdateDocumentsInDatabase runs.   No
Job.Doc.DocumentPropertyTemplate Document property template Specifies the path and name of a template file that contains the document properties.   Yes
Job.Doc.EnhanceAFPControlFile Enhance AFP control file Specifies a control file that defines more processing for documents in the job.   Yes
Job.Doc.PropertyCSV Property conditions file Specifies the CSV file containing job document property conditions and property values to set when those conditions are true.   Yes
Job.TrackAndTrace.AutoComplete Complete step when all barcodes are read Specifies whether RICOH ProcessDirector moves the job to the next step after all the documents for the job are detected.
  • Yes
  • No
Yes
Job.TrackAndTrace.BarCodeReader Barcode reader Specifies one or more barcode readers that are used to record barcodes read for this step.   Yes
Job.TrackAndTrace.Status Document status property Specifies which document status property should be updated with a status of OK when the barcode on a document is read by the camera or barcode scanner associated with the ReadBarcodeData step in a workflow.
  • DocTTStatus1
  • DocTTStatus2
  • DocTTStatus3
  • DocTTStatus4
  • DocTTStatus5
  • DocTTStatusInsertJobs
Yes
Job.TT.WaitTime Results file inactivity timer Specifies the amount of time that RICOH ProcessDirector waits after a barcode is recorded in the results file for the job before it moves the job to the next step.   Yes
Job.TT.DocScanned Document scan time property Specifies which Document scanned property to update with the date and time when a camera or barcode scanner reads the barcode on a document. The ReadBarcodeData step in a workflow sets values for both the camera or barcode scanner and the Document scanned property.
  • DocTTTime1
  • DocTTTime2
  • DocTTTime3
  • DocTTTime4
  • DocTTTime5
Yes

1.2.10.30.20 Database property names for Avanti Slingshot Connect

Messages can refer to Avanti Slingshot Connect properties.

Some of the values that you see in lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

Avanti Slingshot Connect properties
Database name Notebook tab or section: field name Brief description Internal values Editable
Job.Avanti.JobId General: Avanti job number Shows the identifier of the job as it is defined on the Avanti Slingshot system.   No
Job.Pages.Black General: Black pages The number of black pages that RICOH ProcessDirector reports to Slingshot for the most recent printing pass of a job.   No
Job.Pages.Color General: Color pages The number of color pages that RICOH ProcessDirector reports to Slingshot for the most recent printing pass of a job.   No
Job.Pages.CumulativeBlank General: Cumulative black pages The total number of black pages that RICOH ProcessDirector reports to Slingshot for all printing passes of a job.   No
Job.Pages.CumulativeColor General: Cumulative color pages The number of color pages that RICOH ProcessDirector reports to Slingshot for the most recent printing pass of a job.   No
Printer.Avanti.StackedValueToReport Avanti Slingshot: Print unit to report Specifies whether RICOH ProcessDirector reports print volume to Avanti Slingshot in pages or sheets.
  • pages
  • sheets
Yes
Printer.AvantiCostCenter Avanti Slingshot: Slingshot cost center Specifies the Avanti Slingshot cost center that is associated with a printer.   Yes
Printer.JobColorType Avanti Slingshot: Job color to report Specifies whether RICOH ProcessDirector reports to Avanti Slingshot that all pages in a job were printed in full color or only in black.
  • Black
  • Color
  • From job
Yes
Step.AvantiCostCenter General: Slingshot cost center Shows the Avanti Slingshot cost center that is associated with the step.   Yes
Step.AvantiType General: Slingshot milestone status Specifies what information is provided to Avanti Slingshot when this step processes a job. The status is associated with the cost center defined in the Slingshot cost center property.
  • AvantiType.InProgress
  • AvantiType.Complete
Yes
StepTemplate.AvantiCostCenter General: Slingshot cost center Shows the Avanti Slingshot cost center that is associated with the step.   Yes
StepTemplate.AvantiType General: Slingshot milestone status Specifies what information is provided to Avanti Slingshot when this step processes a job. The status is associated with the cost center defined in the Slingshot cost center property.
  • AvantiType.InProgress
  • AvantiType.Complete
Yes
WorkflowSystem.AvantiCostCenters Avanti Slingshot Settings page: List of cost centers Shows the list of Avanti Slingshot Connect cost centers that have been defined in the Avanti Slingshot Connect configuration file.   No
WorkflowSystem.AvantiURL Avanti Slingshot Settings page: Avanti URL Specifies the URL for the Avanti Slingshot Connect server that RICOH ProcessDirector communicates with.   Yes

1.2.10.30.21 Database property names for Deadline Tracker

Messages can refer to Deadline Tracker properties.

Some of the values that you see in lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

In the Notebook tab: field name column:

  • Deadline means that the property is on the Deadline tab of the job properties notebook.
  • Job Defaults (SetDeadline) means that the property is on the Job Defaults tab of the SetDeadline step template.
  • General (all step templates) means that the property is on the General tab of all step templates.

Deadline Tracker properties
Database name Notebook tab: field name Brief description Internal values Editable
ExpectedWork.ID Expected work name Specifies the name of the expected work object.   No
ExpectedWork.SLA.Description Description Describes the expected work object.   Yes
ExpectedWork.SLA.FilePatterns File patterns Specifies one or more pattern-matching strings that can be used to identify jobs based on their file names.   Yes
ExpectedWork.SLA.Frequency Expected work interval Indicates the time interval used to monitor work that is expected to arrive in the system.
  • Hour
  • Day
  • Week
  • Month
  • Year
  • Calendar Date
Yes
ExpectedWork.SLA.NumberofJobsExpected Number of jobs expected Indicates the number of jobs that are expected to be processed during the specified time period.   Yes
ExpectedWork.SLA.ScheduleCalendarData End date Specifies the date when the expected work interval ends.   Yes
ExpectedWork.SLA.ScheduleDaily Frequency (days) Specifies how often the expected work object reports the status of expected work.   Yes
ExpectedWork.SLA.ScheduleHourly Frequency (hour) Specifies how often the expected work object reports the status of expected work.   Yes
ExpectedWork.SLA.ScheduleMonthly Frequency (monthly) Specifies how often the expected work object reports the status of expected work.   Yes
ExpectedWork.SLA.ScheduleWeekly Frequency (weekly) Specifies how often the expected work object reports the status of expected work.   Yes
ExpectedWork.SLA.ScheduleYearly Frequency (yearly) Specifies how often the expected work object reports the status of expected work.   Yes
ExpectedWork.SLA.StartDateAndTime Start date and time Specifies the date and time that the expected work takes effect. Status is reported for the expected work based on this date and time.   Yes
InputDevice.SLA.ExpectedWork General: Associated expected work Specifies the name of the expected work object associated with this input device.   Yes
InputDevice.SLA.LateWork Status: Expected work status Shows whether all expected work for the input device arrived on time.
  • OK
  • Late
No
Job.DT.CurrentDeadlineStep Deadline: Current deadline step Specifies the name of the step that a job must complete to meet its current deadline.   No
Job.DT.DayOfMonth Job Defaults (SetDeadline): Day of month Specifies the day of the month for the Deadline date.   Yes
Job.DT.DayOfWeek Job Defaults (SetDeadline): Day of week Specifies the day of the week for the Deadline date.   Yes
Job.DT.DeadlineStep Job Defaults (SetDeadline): Deadline step Specifies the name of the step that a job must complete to meet its deadline.   Yes
Job.DT.DeadlineTime Deadline: Deadline Shows the date and time by which the job must complete the deadline step. If the job does not complete the Deadline step before the time on the date shown for this property, the Deadline outcome for the job is set to Missed.   No
Job.DT.InheritDeadline Job Defaults (SetDeadline): Inherit deadline from parent job Specifies whether a child job inherits a deadline from its parent job.   Yes
Job.DT.JobTimestampAttr Job Defaults (SetDeadline): Property Specifies the job property used to calculate the deadline when the Deadline date property is set to Relative to property value.   Yes
Job.DT.OutcomeStatus Deadline: Deadline outcome Shows whether the deadline for a job has been met or missed.   No
Job.DT.OverrideDeadline Job Defaults (SetDeadline): Override existing deadline Specifies whether the deadline specified on this SetDeadline step overrides an existing deadline for the job.   Yes
Job.DT.PercentComplete Deadline: Percent complete Specifies what percentage of the estimated durations specified by the steps in the predicted workflow for the job are completed.   No
Job.DT.Period Job Defaults (SetDeadline): Deadline date Specifies the settings used to set the date for the deadline.   Yes
Job.DT.PlusMinus Job Defaults (SetDeadline): Plus or minus Specifies the number of minutes, hours, or days to add or subtract from the date or time set by the user in the Deadline time and Deadline date properties.   Yes
Job.DT.PredictedCompletion Deadline: Predicted completion Specifies the date and time that RICOH ProcessDirector predicts for the job to finish processing the last step in its workflow that is included in the estimated duration.   No
Job.DT.PredictedOutcome Deadline: Predicted outcome Uses the predicted path of the job in its workflow and the estimated durations of the steps remaining in the predicted path through the Deadline step, to determine if there is enough time to run the remaining steps before the deadline time.   No
Job.DT.PredictedStatus Deadline: Tracking status Shows whether the progress of a job through a workflow is ahead of or behind the estimated time to complete the current step and all steps that have been run up to this point.   No
Job.DT.Time Job Defaults (SetDeadline): Deadline time Specifies the time of day for the deadline.   Yes
Job.DTSLA.DeadlineSlaStatus Column on Jobs table: Schedule risk

The heading of the column is blank. To see the name, hover over the heading area.

Shows jobs that are at risk for missing or have already missed their delivery deadline or service level agreement (SLA).
  • SLA_MISSED
  • DEADLINE_MISSED
  • PREDICTED_MAY_MISS
  • TRACKING_BEHIND
  • CHECKPOINT_LATE
  • OK
No
Job.FileReceiptTime Checkpoints: Job arrival time Contains the actual date and time when the last input file for the job arrived in the system.

Timestamp

No
Job.SLA.ActualOutcome Checkpoints: SLA target step time Contains the date and time that the job completed the SLA target step. Timestamp No
Job.SLA.ActualTime Checkpoints: Actual [Phase] Contains the date and time that the job completed this processing phase.

Timestamp

No
Job.SLA.AnchorStartTime Checkpoints: Checkpoint start time Contains the date and time that RICOH ProcessDirector uses as the start time to calculate the planned checkpoints for the job.

Timestamp

No
Job.SLA.Outcome Checkpoints: SLA outcome Shows whether a job has completed the SLA target step before the SLA deadline.
  • Met
  • Missed
No
Job.SLA.PlannedCompletionTime Checkpoints: Planned completion Contains the date and time that the job is expected to complete the last checkpointed processing phase. Timestamp No
Job.SLA.PlannedOutcome Checkpoints: SLA deadline Contains the date and time by which the job must complete the SLA target step. Timestamp No
Job.SLA.PlannedTime Checkpoints: Planned [Phase] Contains the date and time that the job is expected to complete this phase.

Timestamp

No
Job.SLA.Policy Checkpoints: Service policy Specifies the name of the service policy associated with the job.   Yes
Job.SLA.PrintDuration Status: Estimated print duration Shows the estimated amount of time that the current requested printer requires to print the job. You can show the time in seconds, minutes, hours, or days.   No
Job.SLA.ResetOnReprocess Checkpoints: Reset on reprocess Specifies whether RICOH ProcessDirector records new actual checkpoint times when you select the Print Again or Process Again action.
  • No
  • Yes
Yes
Job.SLA.StartTime Checkpoints: Adjusted arrival time Contains the date and time (by default, the job arrival time) that RICOH ProcessDirector uses to calculate the checkpoint start time. Timestamp Yes
Job.SLA.Status Checkpoints: Checkpoint status Specifies whether the job is late meeting its planned checkpoints.
  • Late
  • Ok
No
JobType.SLA.Measurement SLA target step Specifies the name of the step that represents the true goal of the SLA.
  • Met
  • Missed
No
JobType.SLA.Policy Service policy Specifies the name of the service policy associated with the workflow.   Yes
NonProduction.ID Appears in the property notebook title Specifies the name of the no-service period.   No
NonProduction.SLA.Description No-service period description Describes the no-service period.   Yes
NonProduction.SLA.EndTime End time (HH:MM) Specifies the time that the no-service period ends. This time is expressed as a 2-digit hour (00-23), a 2-digit minute (00-59), and a 2-digit second (00) separated by colons (:). Yes
NonProduction.SLA.LastModified Last modified The date and time that the no-service period was last changed.   No
NonProduction.SLA.SlaDay Day Specifies the day of the no-service period.
  • A number from 1 through 31
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
  • All
Yes
NonProduction.SLA.SlaMonth Month Specifies the month of the no-service period.
  • January
  • February
  • March
  • April
  • May
  • June
  • July
  • September
  • October
  • November
  • December
Yes
NonProduction.SLA.SlaYear Year Specifies the year of the no-service period. This value is a 4-digit year, from 2000 through 9999. Yes
NonProduction.SLA.StartTime Start time (HH:MM) Specifies the time that the no-service period starts. This time is expressed as a 2-digit hour (00-23), a 2-digit minute (00-59), and a 2-digit second (00) separated by colons (:). Yes
Policy.ID Appears in the property notebook title Specifies the name of the service policy.   No
Policy.SLA.AdjMethod General: Adjustment method Specifies the method that RICOH ProcessDirector uses to adjust the checkpoint start time.
  • Cutoff
  • None
  • Start
Yes
Policy.SLA.AdjNonProd General: Adjust for no-service periods Specifies whether RICOH ProcessDirector adjusts the checkpoint start time and planned checkpoint times to skip over no-service periods, such as holidays.
  • No
  • Yes
Yes
Policy.SLA.Description General: Service policy description Describes the service policy.   Yes
Policy.SLA.Interval Checkpoints: Interval [Phase] (unit) Specifies the time interval between the checkpoint start time and when a job is expected to complete the phase. The checkpoint start time is the same time for all intervals. Therefore, the time interval for a phase should include the time intervals for all previous phases. The interval is stored in the database in minutes. Yes
Policy.SLA.LastModified Last modified The date and time that the service policy was last changed.   No
Policy.SLA.Measurement General: SLA duration If the deadline calculation method is Elapsed time, specifies the amount of time allowed between the Checkpoint start time of a job and the SLA deadline.   Yes
Policy.SLA.MeasurementDays General: Number of days If the deadline calculation method is Specific time, specifies the number of days from the Checkpoint start time until the SLA deadline of a job.   No
Policy.SLA.MeasurementMethod General: Deadline calculation method Specifies the method that RICOH ProcessDirector uses to calculate the SLA deadline for jobs that use this service policy.
  • Elapsed time
  • Specific time
Yes
Policy.SLA.MeasurementTime General: SLA target time If the deadline calculation method is Specific time, specifies the time of day for the SLA deadline.   Yes
Policy.SLA.ResetOnReprocess General: Reset on reprocess Specifies whether RICOH ProcessDirector records new actual checkpoint times when you select the Print Again or Process Again action.
  • No
  • Yes
Yes
Policy.SLA.StartTime General: Start time (HH:MM) Specifies the checkpoint start time when the Adjustment method is Cutoff or Start. This time is expressed as a 2-digit hour (00-23), a 2-digit minute (00-59), and a 2-digit second (00) separated by colons (:). Yes
Policy.SLA.TimeZone General: Time zone Specifies the time zone of the location where jobs are printed. These internal values are derived from the time zones defined in your Java runtime environment. To determine the internal value, find the time zone in the list for this property, then remove the GMT reference times from the beginning and end of the value. For example, if the value in the list is (GMT-05:00) America/New_York DST(GMT-04:00), the internal value is America/New_York. Yes
Printer.SLA.PPM General: Pages per minute Shows the number of pages the printer can print in a minute.   Yes
StepTemplate.DT.IncludeStepTime General (all step templates): Include in estimated duration Specifies whether the Estimated duration of the step and actual processing time is used to calculate the Tracking status of a job.   Yes
StepTemplate.DT.Weight General (all step templates): Estimated duration Specifies the estimated amount of time it takes for a step to complete processing a job.   Yes

1.2.10.30.22 Database property names for document processing features

Several different kinds of properties are supplied with document processing features.

1.2.10.30.22.1 Database property names for document properties supplied with document processing features

Some messages about documents refer to document properties by their database names, which begin with Doc.
Document properties
Database name User interface name Description
Doc.Associated Associated The job ID that currently gives the status of the job.
Doc.ChildJobID Child job ID The job ID of the job that added the document.
Doc.CurrentFirstPage Current first page The page number of the first page of the document in the current print file.
Doc.CurrentJobID Associated job number The associated job number.
Doc.CurrentPages Current pages The number of pages for the document in the current job.
Doc.CurrentSequence Sequence in job The sequence of the document in the current job.
Doc.CurrentSheets Current Sheets The number of sheets for the document in the current job.
Doc.Custom.MemberLevel Member Level The customer’s level of membership at the time the statement was created.
Doc.Custom.PURL PURL A personalized URL linking to the location where the customer can retrieve the statement.
Doc.Custom.StatementDate Statement Date The date of when the statement was first issued.
Doc.DataLen Data length The length of the document in bytes in the original file.
Doc.DataOffset Data offset The offset of the document in bytes from the start of the original file.
Doc.Email.Sent This property does not appear in the user interface. Specifies whether an email with an attached document has been created and delivered to the SMTP server by the EmailDocuments step in a workflow. Values are Yes or No. Yes indicates that the document was delivered to the SMTP server. No indicates that the document was not delivered. If the EmailDocuments step is run twice on the same document, the value of this property is set to the result of the last step that was run.
Doc.EmailAddress Email address The email address associated with the document.
Doc.FinderSavedSearches Saved Searches Lets you select from the searches you previously saved to start a new search.
Doc.ID Document number A unique identifier for a document in the document database; defined automatically when WriteDocumentsToDatabase runs.
Doc.Insert.Disposition Action Shows the action that the system takes when it processes this document after reconciliation.
Doc.Insert.PendingDisposition Requested action Shows the action that the operator has requested during reconciliation.
Doc.Insert.Sequence Insert sequence Shows the position of the document in the job.
Doc.OriginalFirstPage Original first page The page number of the first page of the document in the original job.
Doc.OriginalJobID Original job number The number of the job that received the document into the system.
Doc.OriginalPages Original pages The number of pages in the document in the original job.
Doc.OriginalSequence Sequence in original job The relative position of this document in the original job. For example, the first document in the job displays a value of 1, and the second document in the job displays a value of 2.
Doc.OriginalSheets Sheets The number of sheets for the document in the original job.
Doc.Pull Pull document Can be used with the SetDocPropsFromList step template to indicate that a document should be removed from a job. The PullPDFSample and PullAFPSample supplied workflows use this property.
Doc.PullProp Pull property Can be used with the SetDocPropsFromList step template to identify which document property determines the documents to be removed from a job. The PullPDFSample and PullAFPSample supplied workflows use this property.
Doc.SequenceInChild Sequence in child job The sequence of the document in the child job.
Doc.SourceFileName All document processing features The name of the input file that contained the document.
Doc.State State The state of the document.

1.2.10.30.22.2 Database property names for job properties supplied with document processing features

Some messages about documents or jobs refer to job properties supplied with document processing features by the database names for the properties. The names of these properties begin with Job.
Job properties
Database name Notebook page: field name (if applicable) Description
Job.BuildPDFControlFile1 Build PDF control file 1 Specifies the path and file name of a control file that the system uses for the BuildPDFFromDocuments step. This property is only available with PDF Document Support.
Job.BuildPDFControlFile2 Build PDF control file 2 Specifies the path and file name of a control file that the system uses for the BuildPDFFromDocuments step. This property is only available with PDF Document Support.
Job.BuildPDFControlFile3 Build PDF control file 3 Specifies the path and file name of a control file that the system uses for the BuildPDFFromDocuments step. This property is only available with PDF Document Support.
Job.BuildPDFControlFile4 Build PDF control file 4 Specifies the path and file name of a control file that the system uses for the BuildPDFFromDocuments step. This property is only available with PDF Document Support.
Job.BuildPDFControlFile5 Build PDF control file 5 Specifies the path and file name of a control file that the system uses for the BuildPDFFromDocuments step. This property is only available with PDF Document Support.
Job.Conditions.ChangeJobType New job type Specifies the new workflow to which this job is transferred.
Job.Doc.AssociateDocsToChildren Associate documents with children Specifies (Yes/No) whether documents are to be associated with child jobs.
Job.Doc.ChildJobType Child job type Specifies the workflow for the child jobs that are created.
Job.Doc.CreatedDocumentCount Documents: Created Document Count Specifies the number of documents created by a step based on WriteDocumentsToDatabase.
Job.Doc.DocumentCount Documents: Document Count Specifies the total number of documents in a job. The value of this property displays only after a step based on WriteDocumentsToDatabase or UpdateDocumentsInDatabase runs.
Job.Doc.DocumentPropertyTemplate Document property template Specifies the path and name of a template file that contains the document properties.
Job.Doc.EnhanceAFPControlFile Enhance AFP control file Specifies a control file that defines more processing for documents in the job. This property is only available with AFP Support.
Job.Doc.FailWhenNoDocsFound Stop when no documents are found Specifies whether the IdentifyDocuments step moves the job into an error state when no documents are found. This property is only available with AFP Support.
Job.Doc.GroupFirst Split: Group first Specifies the primary grouping criterion for documents. The system creates a child job for each distinct combination of values of the six grouping properties.
Job.Doc.GroupSecond Split: Group second Specifies the secondary grouping criterion for documents. The system creates a child job for each distinct combination of values of the six grouping properties.
Job.Doc.GroupThird Split: Group third Specifies the third grouping criterion for documents. The system creates a child job for each distinct combination of values of the six grouping properties.
Job.Doc.GroupFourth Split: Group fourth Specifies the fourth grouping criterion for documents. The system creates a child job for each distinct combination of values of the six grouping properties.
Job.Doc.GroupFifth Split: Group fifth Specifies the fifth grouping criterion for documents. The system creates a child job for each distinct combination of values of the six grouping properties.
Job.Doc.GroupSixth Split: Group sixth Specifies the sixth grouping criterion for documents. The system creates a child job for each distinct combination of values of the six grouping properties.
Job.Doc.HonorGroups Split: Honor groups on sort GroupDocuments can merge existing groups before applying grouping criteria.
Job.Doc.MaxDocsPerChildJob Maximum documents per child job Specifies the maximum number of documents in a child job created by a step based on the SplitDocuments step template.
Job.Doc.MaxSheetsPerChildJob Maximum sheets per child job Specifies the maximum number of physical sheets in a child job created by a step based on the SplitDocuments step template.
Job.Doc.OriginalDocumentCount Original document count Specifies the original number of documents associated with the job.
Job.Doc.OriginalFormdef Original form definition Specifies the form definition in effect at the time the IdentifyDocuments step runs. This property is only available with AFP Support.
Job.Doc.PropertyCSV Property conditions file Specifies the CSV file containing job document property conditions and property values to set when those conditions are true.
Job.Doc.SortDirectionFirst Sort: First sort direction Specifies the sort direction for a primary sort.
Job.Doc.SortDirectionSecond Sort: Second sort direction Specifies the sort direction for a secondary sort.
Job.Doc.SortDirectionThird Sort: Third sort direction Specifies the third sort direction.
Job.Doc.SortDirectionFourth Sort: Fourth sort direction Specifies the fourth sort direction.
Job.Doc.SortDirectionFifth Sort: Fifth sort direction Specifies the fifth sort direction.
Job.Doc.SortDirectionSixth Sort: Sixth sort direction Specifies the sixth sort direction.
Job.Doc.SortFirst Sort: Sort first Specifies a primary sorting criterion.
Job.Doc.SortSecond Sort: Sort second Specifies a secondary sorting criterion.
Job.Doc.SortThird Sort: Sort third Specifies a third sorting criterion.
Job.Doc.SortFourth Sort: Sort fourth Specifies a fourth sorting criterion.
Job.Doc.SortFifth Sort: Sort fifth Specifies a fifth sorting criterion.
Job.Doc.SortSixth Sort: Sort sixth Specifies a sixth sorting criterion.
Job.Doc.SplitBalance Split: Split balance Specifies the type of job size balancing to be performed. Although the objective of a balanced split is to create jobs of equal size, the result depends on the number of documents in the source job, the number of sheets in each document, and the value of the split boundary property.
Job.Doc.SplitBoundaryProperty Split: Split boundary Specifies the name of the document property to be used as the child job split boundary.
Job.Doc.SplitBoundaryExceedMax Split: Exceed maximum split to reach boundary You can change the point at which a job is split using the Split boundary property and the Exceed maximum split to reach boundary property.
Job.DocDelimiter Documents: Delimiter Specifies the delimiter used in the list file to separate the values contained on each line in the list file processed by the SetDocPropsFromList step.
Job.DocPathToPullList Documents: List file directory Specifies the full path name to the directory that contains one or more list files to use for the SetDocPropsFromList step. When the step runs, RICOH ProcessDirector processes all files in this directory.
Job.DocPropToSet Documents: Document property to set Specifies which single document property is added or set for each document in the job when the SetDocPropsFromList step processes the job.
Job.DocPropToSetDefValue Documents: Value for other documents Specifies what value is applied to the property specified in Document property to set by the SetDocPropsFromList step. All of the documents in the document properties file that do not match the Columns in list file properties in the list file are set to this value.
Job.DocPropToSetValue Documents: Value for matching documents Specifies what value is applied to the property specified in Document property to set by the SetDocPropsFromList step. All of the documents in the document properties file that match the Columns in list file properties in the list file are set to this value.
Job.DocPropToSet.DocMatch Documents: Matching documents found Shows whether at least one document in the job matches an entry in one of the processed list files. These list files are processed by steps based on the SetDocPropsFromList step template in the workflow.
Job.DocPropToSet.FilesRead Documents: List files processed Shows the names of the files found in the List file directory that were processed by the SetDocPropsFromList step. The file names are separated by a semicolon (;).
Job.DocPropToSet.OptFail Documents: Stop for excess columns Specifies whether a step based on the SetDocPropsFromList step template fails when the number of columns in the list file is greater than the number of properties specified in the Selected column of the Columns in list file property.
Job.DocPullIdentifier Documents: Columns in list file Specifies one or more document properties that correspond to columns in the list file.
Job.Document.AttachDocToEmail Attach document Specifies whether a document is extracted from the file specified in the Source file for attachment property and attached to each individual email sent by the EmailDocuments step.
Job.Document.AttachmentName Name of attachment Specifies the file name for the attachments created and delivered to the SMTP server by the EmailDocuments step. Use this value to make the name of the attachment more meaningful to the email recipient.
Job.Document.EmailAttachment Source file for attachment Specifies the full path or symbolic name of the PDF file you want to extract documents from. The documents are attached to each email sent by the EmailDocuments step.
Job.Document.EmailBCC Blind copy address One or more email addresses to send a blind copy of the document to. This value is used in the BCC: field of the email.
Job.Document.EmailCC Copy address One or more email addresses to send a copy of the document to. This value is used in the CC: field of the email.
Job.Document.EmailMessage Message Specifies the message to include in the body of the email. Messages can consist of plain text, HTML, and embedded images.
Job.Document.EmailSubject Subject line Specifies the text to include in the subject line of the email.
Job.Document.EmailTo Recipient address One or more email addresses to send the document to. This value is used in the To: field of the email.
Job.IdentifyPDFControlFile Identify PDF control file Specifies the path and file name of the control file that the system uses for the IdentifyPDFDocuments step. This property is only available with PDF Document Support.
Job.Insert.AutomaticReconcile Automatic reconciliation Indicates whether RICOH ProcessDirector reconciles and reprints documents automatically (without operator intervention) that are marked for reprinting during insertion or the ReadBarcodeData step.
Job.Insert.AutoReconcileThreshhold Maximum documents to reprint Specifies the maximum percentage of documents in a job that the system can schedule for reprint during automatic reconciliation. If the percentage exceeds the maximum, the system places the job in the Waiting to reconcile state, requiring manual reconciliation.
Job.Insert.ReconcileUser.ID Reconciliation user Shows the user name of the user who is currently reconciling the job.
Job.Insert.ReprintPrinter Requested reprint printer Specifies the name of the printer to reprint any documents that are marked for reprinting during insertion, the ReadBarcodeData step, or manual reconciliation.
Job.PDF.BuildPDFMergeDocValue Maximum documents in memory Specifies the maximum number of documents that are in memory when the BuildPDFFromDocuments step adds documents to the PDF file. This property is only available with PDF Document Support.
Job.PDFW.PickPlex Page exceptions for sides Specifies how to process page exceptions for sides that are included in the JDF file for a job.
Job.ScanBarcodeFormat Barcode format to use Specifies the barcode format that describes the layout of properties in the barcode that you are scanning on the documents.

1.2.10.30.22.3 Database property names for system properties supplied with document processing features

Messages about documents might refer to system properties supplied with document processing features by the database names for the properties. The names of these properties begin with WorkflowSystem.
System properties
Database name Notebook page: field name (if applicable) Description
WorkflowSystem.Docsearch.MaxDocuments System Settings: Max documents to display Specifies the maximum number of documents to display in the Documents table for a search.

1.2.10.30.23 Database property names for Inserter

Messages about print jobs, documents, and inserter controllers might refer to properties by their database names. You can use the database property names in symbol formulas and in control files.

In the Editable column:

  • Yes means that a user can change the value after the job has been submitted.
  • No means that a user cannot change the value.

Inserter properties
Database name Notebook tab: field name Brief description Editable
Doc.Insert.BinResults Insert: Bin results Shows which inserter bins delivered inserts for this document. No
Doc.Insert.BinTriggers Insert: Bin triggers Specifies which inserter bins should deliver inserts for this document. No
Doc.Insert.Disposition Insert: Action Shows the action that RICOH ProcessDirector takes when it processes this document after reconciliation. No
Doc.Insert.DivertBin Insert: Divert indicator Specifies the number of the inserter output bin to which this document is diverted after insertion. No
Doc.Insert.InserterID Insert: Inserter name Shows the name of the inserter that processed this document. No
Doc.Insert.Iteration Insert: Insert count Shows the number of times RICOH ProcessDirector has processed the document. No
Doc.Insert.OperatorID Insert: Operator name Shows the name or user ID of the operator who was logged in to the inserter when this document was processed. No
Doc.Insert.OriginalBarCode Insert: Original barcode data Shows the data in the original barcode that controls insertion. No
Doc.Insert.PendingDisposition Insert: Requested action Shows the action that the operator has requested during reconciliation. Yes
Doc.Insert.RecipientName Insert: Mail recipient Shows the name of the person to whom this document is mailed. No
Doc.Insert.Sequence Insert: Insert sequence Shows the position of the document in the job. No
Doc.Insert.Status Insert: Status Shows the status for this document. No
Doc.Insert.TimeStamp Insert: Insert date and time Shows the date and time that this document was inserted. No
Doc.Inserter.StatusCode Insert: Status code Shows the status code that the inserter controller reported for this document in the results file. No
Doc.Inserter.StatusCodeExtended Insert: Extended status code Shows the extended status code that the inserter controller reported for this document in the results file. No
Doc.ReconcileSavedSearches Saved Searches Lets you select from the searches you previously saved to start a new search. No
InserterSystem.ActiveJobCount Status: Active jobs Shows the number of jobs associated with this inserter controller that are ready to be inserted, being inserted, waiting to be reconciled, or being reconciled. No
InserterSystem.Completion.Format Results File: Format Specifies the format of records in the inserter results file. Yes
InserterSystem.Completion.ProcessDocRules Results File: Document-properties rules file Specifies the path and file name of the rules file that RICOH ProcessDirector uses to set document property values from information in the inserter results file. Yes
InserterSystem.Completion.ProcessJobRules Results file: Job-properties rules file Specifies the path and file name of the rules file that RICOH ProcessDirector uses to set job property values from information in the inserter results file. Yes
InserterSystem.Completion.Rules Results File: Parsing rules file Specifies the path and file name of the rules file that RICOH ProcessDirector uses to parse (analyze) the records in the inserter results file. Yes
InserterSystem.Completion.TransferCommand Results file: Receive command Specifies the command or script that RICOH ProcessDirector uses to receive the inserter results file for a job from the inserter controller. Yes
InserterSystem.Control.Format Control File: Format Specifies the format of records in the inserter control file. Yes
InserterSystem.Control.Header.Indicator Control File: Header Indicates whether the inserter control file contains a header record. Yes
InserterSystem.Control.Header.Rules Control File: Header rules file Specifies the path and file name of the rules file that RICOH ProcessDirector uses to create the header record of the inserter control file. Yes
InserterSystem.Control.Rules Control File: Rules file Specifies the path and file name of the rules file that RICOH ProcessDirector uses to create the inserter control file that RICOH ProcessDirector sends to the inserter controller before each job begins insertion. Yes
InserterSystem.Control.TransferCommand Control File: Send command Specifies the command or script that RICOH ProcessDirector uses to send the inserter control file to the inserter controller. Yes
InserterSystem.Control2.Format Second Control File: Format (2) Specifies the format of records in the second inserter control file. Yes
InserterSystem.Control2.Header.Indicator Second Control File: Header (2) Indicates whether the second inserter control file contains a header record. Yes
InserterSystem.Control2.Header.Rules Second Control File: Header rules file (2) Specifies the path and file name of the rules file that RICOH ProcessDirector uses to create the header record of the second inserter control file. Yes
InserterSystem.Control2.Rules Second Control File: Rules file (2) Specifies the path and file name of the rules file that RICOH ProcessDirector uses to create the second inserter control file for each job. Yes
InserterSystem.Control2.TransferCommand Second Control File: Send command (2) Specifies the command or script that RICOH ProcessDirector uses to send the second inserter control file to the inserter controller. Yes
InserterSystem.Default.Status General: Default insert status Specifies the insert status that RICOH ProcessDirector sets for a document when the inserter controller does not report a status for the document, or when the inserter controller does not return a results file to RICOH ProcessDirector. Yes
InserterSystem.Delete.Interval Results File: Delete interval (days) Specifies the number of days after successful completion before inserter results files and log files are deleted. Yes
InserterSystem.Description General: Inserter controller description Describes the inserter controller. Yes
InserterSystem.Enabled Status: Enabled status Shows whether RICOH ProcessDirector can communicate with this inserter controller. No
InserterSystem.ID General: Inserter controller name

Also, displayed in the properties notebook title

Specifies the name of the inserter controller object. Yes
InserterSystem.InsertCompletionMethod General: Completion method Specifies the method that RICOH ProcessDirector uses to determine that the inserter controller has finished inserting a job. Yes
InserterSystem.LastModified General: Last modified The date and time when the inserter controller was last changed. RICOH ProcessDirector updates the value whenever the inserter controller changes. You cannot change the value of this property. No
InserterSystem.Location General: Location Specifies the location of the inserter controller. Yes
InserterSystem.Polling.Interval Results file: Polling interval Specifies how often RICOH ProcessDirector checks for results files from the inserter controller. Yes
InserterSystem.Polling.TransferCommand Results File: Polling command Specifies the command or script that RICOH ProcessDirector uses to receive inserter results files that are not specific to one job. Yes
InserterSystem.ReprintMethod General: Reprint method Specifies how RICOH ProcessDirector reprints documents after insertion. Yes
Job.Conditions.ChangeJobType Documents: New workflow Specifies the new workflow to which this job will be transferred. Yes
Job.Doc.DocumentCount Documents: Document count Specifies the total number of documents in a job. No
Job.Doc.DocumentPropertyTemplate Documents: Document property template Specifies the path and name of a template file that contains the document properties that RICOH ProcessDirector can use. Yes
Job.Insert.AutomaticReconcile Insert: Automatic reconciliation Indicates whether RICOH ProcessDirector reconciles and reprints automatically (without operator intervention) documents that are marked for reprinting during insertion or the ReadBarcodeData step. Yes
Job.Insert.AutoReconcileThreshhold Insert: Maximum documents to reprint Specifies the maximum percentage of documents in a job that the system can schedule for reprint during automatic reconciliation. If the percentage exceeds the maximum, the system places the job in the Waiting to reconcile state, requiring manual reconciliation. Yes
Job.Insert.LoadPlan.Comment Insert: Load plan comment Specifies the number of inserter bins, followed by a comma and a comma-delimited list of the materials loaded in each bin of the inserter. Yes
Job.Insert.LoadPlan.ID Insert: Load plan Specifies the name of the load plan that RICOH ProcessDirector assigns to the job. Yes
Job.Insert.ReconcileAttentionAsDamaged Insert: Reprint Attention documents Indicates whether RICOH ProcessDirector reprints documents that have an insert status of Attention during automatic reconciliation. Yes
Job.Insert.ReconcileUser.ID Insert: Reconciliation user Shows the user name of the user who is currently reconciling the job. Yes
Job.Insert.ReprintJobID Insert: Reprint job ID For a reprint job, this property shows the parent job ID that created the job. Yes
Job.Insert.ReprintJobType Insert: Reprint workflow The workflow specified for child jobs created for reprints. Yes
Job.Insert.ReprintPrinter Insert: Requested reprint printer Specifies the name of the printer to reprint any documents that are marked for reprinting during insertion, the ReadBarcodeData step, or manual reconciliation. Yes
Job.Inserter.ID Insert: Inserter name Specifies the name of the inserter on which to load the job, or the name of the inserter that actually processed the job. Yes
Job.Inserter.JobID Insert: Inserter job name Specifies the job name that the inserter controller uses to identify this job. Yes
Job.InserterSystem.ID Insert: Inserter controller Specifies the name of the inserter controller object that RICOH ProcessDirector assigns to the job. Yes

1.2.10.30.24 Database property names for Kodak PDF printers

Messages might refer to properties for Kodak PDF printers.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Kodak PDF printer properties
Database name Notebook tab: field name Brief description Internal values Editable
Kodak.PDFPrinter.BannerPage.Tray Banner page input tray Specifies the printer input tray that holds the paper that should be used for header and trailer pages.   Yes
Kodak.PDFPrinter.MergeBanner Merge banner pages into PDF print file Specifies whether header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
Kodak.PrinterQueue Kodak printer queue Specifies the name of the LPR print queue used for the Kodak printer.   Yes

1.2.10.30.25 Database property names for MarcomCentral Connect

Messages can refer to MarcomCentral Connect properties.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

MarcomCentral Connect properties
Database name Notebook tab: field name Brief description Internal values Editable
Job.Marcom.JobTicketId MarcomCentral: MarcomCentral job ticket Specifies the ID of a job ticket in an order retrieved from a store at the MarcomCentral web site.   Yes
Job.Marcom.OrderID MarcomCentral: MarcomCentral order ID Specifies the ID of an order retrieved from a store at the MarcomCentral web site.   Yes
Job.Marcom.OrderNumber MarcomCentral: MarcomCentral order number Specifies the number of an order retrieved from a store at the MarcomCentral web site.   Yes
Job.Marcom.ProductType MarcomCentral: MarcomCentral product type Specifies the product type of a job ticket in an order retrieved from a store at the MarcomCentral web site.   Yes

1.2.10.30.26 Database property names for OutputPDF transform option

Configuration files, functions, and messages about the OuputPDF transform option in the user interface can refer to properties by their database names.

Some of the property values that you see in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you set the value of a property in an overrides file or an external program, use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value in the user interface.
  • No means that you cannot change the value.

Properties for OutputPDF transform option
Database name Notebook tab or section: field name Brief description Internal values Editable
Job.Transform.MapOfJDFToRPDMedia Transform: Path to media mapping file Specifies the full path and name of a file that maps media names in the JDF file created by the TransformToPDFWithMediaInfo step to RICOH ProcessDirector media names.   Yes
Job.XIF.Command Transform: Media information command Specifies the command that retrieves media information from the AFP or PostScript data stream that is input to a step based on the TransformToPDFWithMediaInfo step template.   Yes

1.2.10.30.27 Database property names for PitStop Connect

Messages might refer to properties that are specific to PitStop Connect by their database names. Administrators can use the database property names in symbol formulas that they specify for external programs, including commands that are sent to PitStop Server. Administrators can also specify symbol formulas for properties in control files.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket.
  • No means that the property cannot be set from values in the job ticket.

PitStop Connect feature properties
Database name Notebook tab: field name Brief description Editable Job ticket
Job.Pitstop.ActionListOrProfile PitStop action list or PDF profile Specifies the full path and file name to the PitStop action list (.eal) or PDF profile (.ppp) file that RICOH ProcessDirector sends to PitStop Server. Yes No

1.2.10.30.28 Database property names for Postal Enablement

Messages might refer to various properties.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Postal Enablement
Database name Field name Brief description Internal values Editable
Doc.Address.1 Address block line 1 Specifies the first line of the address block in the document.   No
Doc.Address.Company Postal company name Specifies the company name in the document.   No
Doc.Address.PostalCode Postal code Specifies the zip code in the document.   No
Doc.Address.ZipCode Zip code Specifies the zip code in the document.   No
Doc.ChildJobID Not displayed in property notebook The job ID of the job that contains the document.   No
Doc.CurrentFirstPage Not displayed in property notebook The page number of the first page of the document in the current print file.   No
Doc.CurrentPages Not displayed in property notebook The number of pages for the document in the current job.   No
Doc.CurrentSheets Current sheets The number of sheets for the document in the current job.   No
Doc.DataLen Not displayed in property notebook The length of the document in bytes in the original file. (AFP jobs only).   No
Doc.DataOffset Not displayed in property notebook The offset of the document in bytes from the start of the original file.(AFP jobs only).   No
Doc.DocSize.PieceThickness Variable mail piece thickness Specifies the thickness of a mail piece when the mail pieces in a job have different thicknesses.   No
Doc.DocSize.PieceWeight Variable mail piece weight Specifies the weight of a mail piece when the mail pieces in a job have different weights.   No
Doc.ID Document number A unique identifier for a document in the document database; defined automatically when WriteDocumentsToDatabase runs.   No
Doc.OriginalFirstPage Original first page The page number of the first page of the document in the original job.   No
Doc.OriginalJobID Original job number The number of the job that received the document into the system.   No
Doc.OriginalPages Original pages The number of pages in the document in the original job.   No
Doc.OriginalSequence Sequence in original job The relative position of this document in the original job. For example, the first document in the job displays a value of 1, the second document in the job displays a value of 2, and so on.   No
Doc.OriginalSheets Sheets The number of sheets for the document in the original job.   No
Doc.Postal.AddressProcessingRC Address processing return code A value returned from postal software to indicate the result of its address correction processing.   No
Doc.Postal.Category Processing category Specifies the grouping of postal processing determined by the postal software for the document.   No
Doc.Postal.ChangeAddressRC Change of address return code A value returned from postal software to indicate if an address change is available for the document.   No
Doc.Postal.ContainerBreakMark Pallet break mark Specifies the pallet break mark for the document.   No
Doc.Postal.ContainerNumber Pallet number Specifies the pallet number for the document.   No
Doc.Postal.HandlingUnitBreakMark Container break mark Specifies the container break mark for the document.   No
Doc.Postal.HandlingUnitNumber Container number Specifies the container number for the document.   No
Doc.Postal.PackageBreakMark Package break mark Specifies the package break mark for the document.   No
Doc.Postal.PackageNumber Package number Specifies the package number for the document.   No
Doc.Postal.PostageRate Postage rate Specifies the postage rate for the document.   No
Doc.Postal.PostageRateCode Postage rate code Specifies the postage rate code for the document.   No
Doc.Postal.SequenceNumber Presort sequence number Specifies the presort sequence number for the document.   No
Doc.Postal.SequencingProcessingRC Presort processing return code A value returned from postal sorting software to indicate the result of its processing.   No
Doc.SequenceInChild Not displayed in property notebook The sequence of the document in the child job.   No
Doc.State State The state of the document.   No
Job.Conditions.ChangeJobType New workflow Specifies the new workflow to which this job will be transferred.   Yes
Job.Doc.ChildJobType Child workflow Specifies the workflow for the child jobs that are created.   Yes
Job.Doc.ColumnsToKeep Columns to keep Specifies a comma-separated list of the names of column headings in the external results file.   Yes
Job.Doc.ContainsHeader External results contain column headings Specifies whether the external results file returned from the external program contains headings for the document property columns.
  • Yes
  • No
Yes
Job.Doc.CreatedDocumentCount Created document count Specifies the number of documents created by the first WriteDocumentsToDatabase step that processes a job. This value represents the number of documents that were contained in the original job; it does not change as the job moves through its workflow, even if documents are reprinted.   No
Job.Doc.DocumentCount Document count Specifies the total number of documents in a job. The value of this property displays only after a step based on WriteDocumentsToDatabase or UpdateDocumentsInDatabase runs.   No
Job.Doc.DocumentPropertyTemplate Document property template Specifies the path and name of a template file that contains the document properties.   Yes
Job.Doc.EnhanceAFPControlFile Enhance AFP control file Specifies a control file that defines additional processing for documents in the job.(AFP jobs only).   Yes
Job.Doc.PropertyCSV Property conditions file Specifies a comma-separated file which is used to update document properties based on existing property settings.   Yes
Job.Doc.DocPropForHeading Document properties Specifies document properties in the order that they should be added as column headings in the modified results file that is produced by a step based on the MapExternalResultsFiletoDocPropsstep template.   Yes
Job.Doc.DocPropToOutput Document properties Specifies document properties that will be written to the external document properties file that is produced by a step based on the BuildExternalDocPropsFile step template..   Yes
Job.Doc.ExternalHeadings Column headings Specifies the column headings to use in the external document properties file that is produced by a step based on the BuildExternalDocPropsFile step template.   Yes
Job.Doc.InputFileName External results file Specifies the name of the comma-separated or tab-delimited file containing the document properties and other information returned from the external program. This file is input to a step based on the MapExternalResultsFiletoDocProps step template.   Yes
Job.Doc.InputFileType File type Specifies the type of the external results file, which is input to a step based on the MapExternalResultsFiletoDocProps step template.   Yes
Job.Doc.OutputFileDPFName Modified results file Specifies the name of the tab-delimited file containing the document properties that you selected from the document properties in the external results file. A step based on the MapExternalResultsFiletoDocProps step template creates this file as output.   Yes
Job.Doc.OutputFileName External document properties file Specifies the fully qualified output filename for the external document properties file that is produced by a step based on the BuildExternalDocPropsFile step template.   Yes
Job.Doc.OutputFileType File type Specifies the output file type for the External document properties file.   Yes
Job.DocSize.DefaultPieceHeight Mail piece height Specifies the height of the mail piece.   Yes
Job.DocSize.DefaultPieceLength Mail piece length Specifies the length of the mail piece.   Yes
Job.DocSize.DefaultPieceThickness Identical mail piece thickness Specifies the thickness of a mail piece when all mail pieces in a job have the same thickness.   Yes
Job.DocSize.DefaultPieceWeight Identical mail piece weight Specifies the weight of a mail piece when all mail pieces in a job have the same weight.   Yes
Job.DocSize.VaryingWeightAndThickness Use variable measurements Specifies whether the mail pieces in the job have the same weight and thickness or different weights and thicknesses.
  • Yes
  • No
Yes
Job.DPF.MergeFile Modified Results File The name of the tab-delimited file containing the properties selected from the external results file. This file is produced by a step based on the MapExternalResultsFiletoDocProps step template.   Yes
Job.Postal.Category Processing category Specifies a grouping of postal processing that can be determined by the postal software.   Yes
Job.Postal.Class Mail class Specifies the class of mail for the job. For example, the class of mail for the United States Postal Service might be first class, standard, or parcel.   Yes
Job.Postal.ContainerMaxWeight Maximum weight of pallet Indicates the maximum possible weight of a pallet for mailing. When the weight of individual documents is known, this property can be used to group documents into jobs so that the maximum weight is not exceeded.   Yes
Job.Postal.ContainerMinWeight Minimum weight of pallet Indicates the minimum possible weight of a pallet for mailing.   Yes
Job.Postal.ContainerSize Pallet size Shows the size of an individual pallet.   Yes
Job.Postal.HandlingUnit Container size Specifies the size of the container.   Yes
Job.Postal.HandlingUnitMaxWeight Maximum weight of container Specifies the maximum weight that your postal service accepts for a container.   Yes
Job.Postal.HandlingUnitMinWeight Minimum weight of container Specifies the minimum weight that your postal service accepts for a container.   Yes
Job.Postal.MailerID Mailer ID Specifies the identification number of the company sending the mail.   Yes
Job.Postal.MailStream Presort process Specifies the type of sorting that the job qualifies for based on the requirements set by your postal service.   Yes
Job.Postal.PieceType Mail type Specifies the shape of the mail pieces in the job.   Yes
Job.Postal.PostageStatementDate Postage statement date Specifies the date the job is sent to the postal service and the date that the postal service receives payment for the job.   Yes
Job.Postal.Type Mail rate type Specifies the type of mail rate for the job.   Yes

1.2.10.30.29 Database property names for Preference Management

Messages might refer to Preference Management properties.

In the Editable column:

  • Yes means that you can change the value in the user interface. The value is stored with read and write access.
  • No means that you cannot change the value in the user interface. The value is stored with read access only.
  • The values of document properties are only set and changed by steps in the workflow.

Preference Management properties
Database name Notebook tab: field name Brief description Editable
CsvTabMapping.FileType Property mapping object: General: File type Specifies the file type of the preferences file that is processed by a step based on the ApplyPreferences step template using this property mapping object. Yes
CsvTabMapping.PropertyMapping Property mapping object: Property mapping Lets you map headings in a preferences file to document properties in the system. No
Doc.Pref.Member User interface name: Member (not displayed as field in property notebook) Can be used with a property mapping object to identify the documents in a job. The DelimitedSample supplied property mapping object and PreferencesSample supplied workflow use this property. Depends on workflow
Doc.Pref.Output User interface name: Output type (not displayed as field in property notebook) Can be used with a property mapping object to indicate the output type (such as Email, Print, or Suppress) for a document. The DelimitedSample supplied property mapping object and PreferencesSample supplied workflow use this property. Depends on workflow
Job.Pref.ExternalFile Job: Document: Preferences file Specifies the full path or symbolic name of the preferences file that the ApplyPreferences step uses to add or change property values in the document properties file (DPF) for each document in the job. The step uses a property mapping object to interpret the contents of the preferences file. Yes
Job.Pref.PropMapping Job: Document: Property mapping Specifies the property mapping object that the ApplyPreferences step uses to interpret the preferences file specified in the Preferences file property. Yes
PropertyMapping.Description Property mapping object: General: Property mapping description The description can include information about what values from the file are applied to the job or document properties. Yes
PropertyMapping.ID Property mapping object: General: Property mapping name Specifies the name of the property mapping object. No
PropertyMapping.LastModified Property mapping object: Last modified The date and time that the property mapping was last changed. RICOH ProcessDirector updates the value whenever the property mapping changes. Yes

1.2.10.30.30 Database property names for Preprinted Forms Replacement

Some parts of the system and messages about Preprinted Forms Replacement refer to properties by their database names.

Some of the property values that you see in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you set the value of a property in an overrides file or an external program, use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the media object has been created.
  • No means that you cannot change the value.

Preprinted Forms Replacement properties for media objects
Database name Notebook tab or section: field name Brief description Internal values Editable
Media.ElectronicFormMedia Media Electronic Form: Media name for printing Specifies the name of the media that RICOH ProcessDirector uses to print jobs that require this media after the CombinePDFWithForm or CombineAFPWithForm step processes the jobs.
  • CURRENT_MEDIA
  • REMOVE_MEDIA
  • SELECTED
Yes
Media.TemplateBack Media Electronic Form: Back of form Specifies the electronic form that the CombinePDFWithForm or CombineAFPWithForm step uses for the back of the media.   Yes
Media.TemplateBackPage Media Electronic Form: Use page Specifies the page in the selected file to use to create the back of the form.   Yes
Media.TemplateFront Media Electronic Form: Front of form Specifies the electronic form that the CombinePDFWithForm or CombineAFPWithForm step uses for the front of the media.   Yes
Media.TemplateFrontPage Media Electronic Form: Use page Specifies the page in the selected file to use to create the front of the form.   Yes
Job.AFPPreForm.OutputAFP Jobs AFP: Combined AFP file Specifies the full path and name of the AFP output file created by a step based on the CombineAFPWithForm step template.   Yes
Job.AFPPreForm.TrayToMedia Jobs AFP: Tray mapping file Specifies the full path and name of a file that maps trays in AFP medium maps to RICOH ProcessDirector media names. Medium maps are specified in AFP form definitions.   Yes
Job.PDFLayer.MixPlex Jobs PDF: Simplex sheet processing Specifies how the step processes jobs where some sheets that were set up to print simplex now use a media that specifies an electronic form on some back sides.
  • Insert blank back pages
  • Add Sides page exceptions to JDF
Yes
Job.PDFLayer.OutputJDFFile Jobs PDF: JDF output file Specifies the full path and name of the JDF output file created by a step based on the CombinePDFWithForm step template.   Yes
Job.PDFLayer.OutputPDFFile Jobs PDF: Combined PDF file Specifies the full path and name of the PDF output file created by a step based on the CombinePDFWithForm step template.   Yes

1.2.10.30.31 Database property names for Reports

Messages about data collectors and print jobs might refer to properties added by the Reports feature by their database names.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket that is used to submit the job.
  • No means that the property cannot be set from values in the job ticket.

Database name Field name or column heading Brief description Internal values Editable Job ticket
BarcodeReaderActionsCollector.UserProps User properties to capture Specifies the properties that this data collector captures about the user who does an action on a barcode reader.   Yes  
BarcodeReaderActionsCollector.BarcodeReaderProps Barcode reader properties to capture Specifies properties that this data collector captures about a barcode reader when a user does an action on it.   Yes  
Collector.Cleanup Remove expired entries Specifies whether the data collector removes database entries after a specified retention time.
  • On
  • Off
Yes  
Collector.Description Description Describes the type of data collected by the data collector.   No  
Collector.Enabled Enabled Status Specifies whether the data collector is writing data to its PostgreSQL database table.
  • Yes
  • No
Yes  
Collector.FailureDirectory Error log directory Specifies the full path and name of the directory that RICOH ProcessDirector writes a file to when it cannot put the property values in the database table.   Yes  
Collector.ID Name Specifies the name of the data collector.   No  
Collector.LastModified Last modified Specifies the date and time that the data collector was last changed.   No  
Collector.ModifiedBy Modified by Specifies the name of the person who last changed the data collector.   No  
Collector.Retention Retention period Specifies how long to keep entries in the database table used by a data collector.   Yes  
Collector.Table Database table name Specifies the name of the database table where the data collector writes its information.   Yes  
InputDeviceActionsCollector.UserProps User properties to capture Specifies the properties that this data collector captures about the user who does an action on an input device.   Yes  
InputDeviceActionsCollector.InputDeviceProps Input device properties to capture Specifies the properties that this data collector captures about an input device when a user does an action on it.   Yes  
InserterActionsCollector.UserProps User properties to capture Specifies the properties that this data collector captures about the user who does an action on an inserter controller.   Yes  
InserterActionsCollector.InserterProps Inserter properties to capture Specifies the properties that this data collector captures about an inserter controller when a user does an action on it.   Yes  
JobActionsCollector.UserProps User properties to capture Specifies the properties that this data collector captures about the user who does an action on a job.   Yes  
JobActionsCollector.JobProps Job properties to capture Specifies the properties that this data collector captures about a job when a user does an action on it.   Yes  
JobPrintCollector.JobProps Job properties to capture Specifies the job properties that the Job Print Progress data collector captures when a job starts printing and when a job stops printing.   Yes  
JobPrintCollector.PrinterProps Printer properties to capture Specifies the printer properties that the Job Print Progress data collector captures when a job starts printing and when a job stops printing.   Yes  
Job.Reports.DocFileToStore Document properties file Specifies the name of a tab-delimited file containing property values to write to the database.   Yes No
Job.Reports.DocPropToStore Document properties to write Specifies the document properties to write to the database.   Yes No
Job.Reports.DocumentTableName Document properties table Specifies the name of the table where the selected document properties are stored in the database.   Yes No
Job.Reports.EventType Event type Adds a custom label for the information that the step stores in the database.   Yes No
Job.Reports.JobPropToStore Job properties to write Specifies the job properties to write to the database.   Yes No
Job.Reports.JobTableName Job properties table Specifies the name of the table where the selected job properties are stored in the database.   Yes No
JobStepCollector.ContinueOnFailure Continue on error Specifies whether jobs continue to process in their workflows if the Job Step Progress data collector fails to capture information.
  • Yes
  • No
Yes  
JobStepCollector.JobProps Job properties to capture Specifies the job properties that the Job Step Progress data collector captures at the beginning and end of each workflow step.   Yes  
PrinterActionsCollector.UserProps User properties to capture Specifies the properties that this data collector captures about the user who does an action on a printer.   Yes  
PrinterActionsCollector.PrinterProps Printer properties to capture Specifies the properties that this data collector captures about a printer when a user does an action on it.   Yes  
PrinterStatusCollector.PrinterProps Printer properties to capture Specifies the printer properties that the Printer Status data collector captures when the printer’s Enabled status or Printer status property changes.   Yes  
StepCollector.DatabaseTables Database tables affected Specifies the names of the database tables that steps based on the WritePropsToReportsDatabase step template write data into. A list with all tables defined for a WritePropsToReportsDatabase step that exist in the Reports database whether these tables contain data or not. No  
StepDurationCollector.JobProps Job properties to capture Specifies the job properties that the Job Step Duration data collector captures during each workflow step.   Yes  
UserActionsCollector.UserProps User properties to capture Specifies the properties that this data collector captures about the user who does an action on a target user.   Yes  
UserActionsCollector.TargetUserProps Target user properties to capture Specifies the properties that this data collector captures about a target user when a user does an action on it.   Yes  
WorkflowSystem.Capture.Database Database Specifies the name of the PostgreSQL database to use for storing the information collected for reporting.   Yes  
WorkflowSystem.Capture.Hostname PostgreSQL server IP address or host name Specifies either the network IP address or the host name of the computer where the PostgreSQL database that stores job and printer data is stored   Yes  
WorkflowSystem.Capture.Password Password Specifies the password that you want RICOH ProcessDirector to use for logging in to the PostgreSQL reports database.   Yes  
WorkflowSystem.Capture.Port PostgreSQL server port Specifies the port number to use for communicating with the PostgreSQL reports database.   Yes  
WorkflowSystem.Capture.Username User name Specifies the user name that you want RICOH ProcessDirector to use for logging in to the PostgreSQL reports database.   Yes  

1.2.10.30.32 Database property names for Security

Messages might refer to Security properties.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Security properties
Database name Notebook tab: Field name Brief description Internal values Editable
User.AccountStatus Security Users: Account status Shows the current status of the user account.
  • Active
  • Locked-Inactive
  • Locked-Password Failure
Yes
User.LastLogin Security Users: Last login Specifies the date and time when the user last logged in.   No
WorkflowSystem.AdLdap.EmailAddress Settings LDAP: Email attribute Specifies the LDAP attribute that RICOH ProcessDirector gets user email addresses from.   Yes
WorkflowSystem.AdLdap.GroupMap Settings LDAP: LDAP Group Specifies the mapping of RICOH ProcessDirector groups to LDAP groups.   Yes
WorkflowSystem.AdLdap.GroupSearchBase Settings LDAP: Group search base Specifies the branch of the LDAP external directory tree that RICOH ProcessDirector searches to identify the organizational unit (OU) that contains LDAP groups.   Yes
WorkflowSystem.AdLdap.GroupSearchFilter Settings LDAP: Group search filter Specifies the filter that RICOH ProcessDirector uses to determine if a group with the specified name exists within the LDAP group search base.   Yes
WorkflowSystem.AdLdap.GroupSearchMember Settings LDAP: Group search member Specifies the LDAP attribute RICOH ProcessDirector uses to get the distinguished names of LDAP group members.   Yes
WorkflowSystem.AdLdap.ManagerDN Settings LDAP: Manager distinguished name Specifies the full distinguished name (DN) of the user that binds to the LDAP server for user searches.   Yes
WorkflowSystem.AdLdap.ManagerPassword Settings LDAP: Manager password Specifies the password for the user listed in the Manager distinguished name property.   Yes
WorkflowSystem.AdLdap.rootDN Settings LDAP: Root distinguished name Specifies the distinguished name (DN) that is not limited by administrative limit restrictions or access control restrictions for the database.   Yes
WorkflowSystem.AdLdap.Server Settings LDAP: LDAP server Specifies either the network IP address or the fully-qualified host name of one or more LDAP servers and the ports that the system uses for authentication.   Yes
WorkflowSystem.AdLdap.SyncLdapGrp Settings LDAP: Synchronize with LDAP groups Specifies if RICOH ProcessDirector updates the product security groups for a user, based on the values for the Product to LDAP group mapping property, each time the user logs in.
  • Yes
  • No
Yes
WorkflowSystem.AdLdap.UserSearchBase Settings LDAP: User search base Tells the server which part of the external directory tree to search, relative to the base distinguished name (DN) in the LDAP URL.   Yes
WorkflowSystem.AdLdap.UserSearchFilter Settings LDAP: User search filter Specifies the filter that RICOH ProcessDirector uses to determine if a distinguished name (DN) of the user exists in LDAP.   Yes
WorkflowSystem.AdLdap.YesNo Settings LDAP: Authenticate with LDAP Specifies whether users can log in to RICOH ProcessDirector with a user ID that is defined in the existing Lightweight Directory Access Protocol (LDAP) server.
  • Yes
  • No
Yes
WorkflowSystem.ComplexRules Settings Security: Enforce password complexity rules Specifies whether all users must use complex passwords.
  • Yes
  • No
Yes
WorkflowSystem.InactiveLength Settings Security: Account inactivity period Specifies the number of days that RICOH ProcessDirector lets a user account be inactive before that user is locked out of the system.   Yes
WorkflowSystem.LockOutLength Settings Security: Lockout duration Specifies the amount of time that RICOH ProcessDirector locks a user out of the system after the user exceeds the Account login threshold. The unit of time for the value can be minutes, hours, or days. Use the toggle control to the right of the property name to select the unit of time for the value.   Yes
WorkflowSystem.MaxLoginAttempts Settings Security: Account lockout threshold Specifies the number of unsuccessful login or password change attempts that are allowed before the user is locked out.   Yes
WorkflowSystem.MinPasswordLength Settings Security: Minimum password length Specifies the minimum number of characters required for a password.   Yes
WorkflowSystem.PasswordReuseCount Settings Security: Password reuse count Specifies how many times a user must enter a unique password before they can reuse an old password.   Yes

1.2.10.30.33 Database property names for Ultimate Impostrip® Connect

Messages might refer to properties that are specific to Ultimate Impostrip® Connect. You can use the database property names in symbol formulas for external programs and for properties in control files.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket.
  • No means that the property cannot be set from values in the job ticket.

Ultimate Impostrip® Connect feature properties
Database name Notebook tab: field name Brief description Editable Job ticket
Job.ULT.ImpostripQueue Ultimate Impostrip®: Ultimate Impostrip® input hot folder Specifies the name of the Ultimate Impostrip® hot folder that is configured to imposition the job correctly. Yes No
Job.ULT.JobName Ultimate Impostrip®: Ultimate Impostrip® job name Specifies the name that RICOH ProcessDirector assigns to a job when it sends the job to the Ultimate Impostrip® server. Yes No
WorkflowSystem.ULT.ConfigSource Ultimate Impostrip® Settings: Ultimate Impostrip® configuration Specifies the method that RICOH ProcessDirector uses to retrieve the list of Ultimate Impostrip® hot folders that can receive print jobs. Yes No
WorkflowSystem.ULT.INIFileLocation Ultimate Impostrip® Settings: Ultimate Impostrip® configuration, Use .ini file option Specifies the full path to the initialization file that RICOH ProcessDirector uses to retrieve the list of Ultimate Impostrip® hot folders that can receive print jobs. Yes No
WorkflowSystem.ULT.Remote Ultimate Impostrip® Settings: Ultimate Impostrip® host system Specifies whether Ultimate Impostrip® is installed on a Windows computer that also runs a RICOH ProcessDirector server. Yes No
WorkflowSystem.ULT.RpdSpoolMount Ultimate Impostrip® Settings: Ultimate Impostrip® Mapping: Print spool directory Mounts the RICOH ProcessDirector print spool to a directory on the Ultimate Impostrip® server. Yes No
WorkflowSystem.ULT.URL Ultimate Impostrip® Settings: Ultimate Impostrip® configuration, Use URL option Specifies the URL of the Ultimate Impostrip® server that RICOH ProcessDirector contacts to retrieve the list of Ultimate Impostrip® hot folders that can receive print jobs. Yes No
WorkflowSystem.ULT.XmlRedirectMount Ultimate Impostrip® Settings: Ultimate Impostrip® Mapping: XML Ticket Input folder Mounts the directory specified as the XML Ticket Input Folder in Ultimate Impostrip® to a directory on the RICOH ProcessDirector primary server. Yes No

1.2.10.30.34 Database property names for WPM Connect

Messages might refer to WPM properties. Administrators can use the database property names in symbol formulas that they specify for RICOH ProcessDirector external programs. Administrators can also specify symbol formulas for properties in RICOH ProcessDirector control files.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket.
  • No means that the property cannot be set from values in the job ticket.

WPM feature properties
Database name Notebook tab: field name Brief description Editable Job ticket
Job.WPM.AcrisId ACRISID The ACRIS key and destination code for the e-form document. Yes No
Job.WPM.CellDefFile CELL_DEF_FILE Specifies the name of the cell definition file. Yes No
Job.WPM.DbcsFontheightRatio DBCS_FONTHEIGHT_RATIO Specifies the DBCS font height adjustment ratio, expressed as a percentage. Yes No
Job.WPM.DelDate DELDATE The expiration date for the e-form document. Yes No
Job.WPM.DoubleByteCodedFont User Information Page DBCS coded font The double-byte coded font used to generate the WPM UIP. Yes No
Job.WPM.FormDate FORMDATE Specifies date associated with the document in YYYYMMDD. Normally date of document generated. No No
Job.WPM.FormId FORMID The ID of the form that WPM uses for the job. Yes No
Job.WPM.FormName FORMNAME The name of the form that WPM uses for the job. Yes No
Job.WPM.FormNo FORMNO The form number that WPM uses for the job. Yes No
Job.WPM.FormSize FORMSIZE Specifies name of the form size to use. Yes No
Job.WPM.FormType FORMTYPE The type of form that WPM uses for the job. Yes No
Job.WPM.MoveDate MOVE_DATE The date when the e-form document is moved to another location. Yes No
Job.WPM.MoveDir MOVE_DIR Specifies the directory that the e-form document is moved to. Yes No
Job.WPM.OutputDir OUTPUT_DIR Specifies the directory where WPM creates and stores the e-form document. Yes No
Job.WPM.SbcsFontheightRatio SBCS_FONTHEIGHT_RATIO Specifies the SBCS font height adjustment ratio, expressed as a percentage. Yes No
Job.WPM.SecClass SECCLASS The security class that is used to control access to the e-form document. Yes No
Job.WPM.SendDate SENDDATE The date when the e-form document is sent to WPM. No No
Job.WPM.ShiftCharsRatio SHIFT_CHARS_RATIO Specifies position adjustment ratio for text characters, expressed as a percentage of the character width. Yes No
Job.WPM.SingleByteCodedFont User Information Page SBCS coded font The single-byte coded font used to generate the WPM UIP. Yes No
Job.WPM.SystemFlag SYSTEM_FLAG Specifies the flag that controls the system behavior of WPM. Yes No
Job.WPM.Title TITLE Specifies the title of the e-form document. Yes No
Printer.WPM.SendToWPM Create User Information Page Specifies whether this printer object should create a User Information Page (UIP) for this job and send it to the printer with the job. Yes No

1.2.10.30.35 Database property names for Xerox PDF printers

Messages might refer to properties for Xerox PDF printers.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Xerox PDF printer properties
Database name Notebook tab: field name Brief description Internal values Editable
Xerox.PDFPrinter.BannerPage.Tray Banner Pages: Banner page input tray Specifies the printer input tray that holds the paper that should be used for header and trailer pages.   Yes
XeroxPDFPrinter.MergeBanner Banner Pages: Merge banner pages into PDF print file Specifies whether header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
XeroxPDFPrinter.PrinterDriver General: Xerox printer driver Specifies the available Xerox printer driver and version you can use to create a Xerox PDF printer.   Yes
XeroxPDFPrinter.PrinterType General: Xerox printer type Specifies the available Xerox printer types you can use to create a Xerox PDF printer.   Yes
XeroxPrinter.PrinterQueue General: Xerox printer queue Specifies the name of the LPR print queue used for the Xerox printer.   Yes

1.2.10.31 Job properties that can be set from the job ticket

When you submit a job with a job ticket, RICOH ProcessDirector sets some job properties from values in the job ticket.

Job properties are mapped to attributes in the job ticket. In most cases, RICOH ProcessDirector sets the job property to a value that corresponds to the value of the attribute in the Job ticket attribute column. (The values are not always identical.) The Notes column explains variations in this process.

When a job ticket refers to more than one print file, RICOH ProcessDirector creates a child job for each file. In the Per job or per ticket column:

  • Job means that the property is mapped to an attribute in the job ticket that applies to individual print files, so it can have a different value for each child job.
  • Ticket means that the property is mapped to an attribute that applies to the entire job ticket, so it must have the same value for all jobs created for the job ticket.
  • Job or ticket means that the property is mapped to both types of attribute, so it can have the same value or different values depending on the attributes in the job ticket.

Job properties that can be set from the job ticket
Database name Notebook tab: field name Brief description Per job or per ticket JDF attribute name Notes
Job.Binding Binding Set the binding settings for the job you are printing. Job or ticket job-binding  
Job.Copies General and Status: Job copies requested Contains the number of job copies that have been requested. Job or ticket job-copies  
Job.CustomerName Scheduling: Customer name Identifies the customer who is associated with this job. Job or ticket job-contact-info  
Job.Description General: Job description Contains text that describes the job. Job or ticket jt-comment  
Job.Duplex General: Duplex Indicates whether duplexed printing is active for the job and, if so, the type of duplexed printing. Job or ticket job-sides  
Job.FoldOptions Fold Options Specifies how to fold the job or large sheets in the job, whether to fold all the sheets together (overlap or collate), and whether the front side of the sheet ends up on the outside rather than the inside of the fold. Job or ticket job-folding  
Job.Info.Department Information: Department information Contains a department description for the job. Job or ticket job-contact-info  
Job.InputDatastream General: Input data stream Specifies the format of data that the input file for this job contains. Job document-format  
Job.Line- 2AFP. CC_TYPE AFP: Carriage control type Indicates the type of carriage controls that are present in the job. Ticket job-carriage-control-characters This property is only available if the AFP Support Feature is installed.
Job.Line-2AFP. FORMDEF AFP and Print: Form definition Identifies the form definition to use with the job. Ticket job-form-definition This property is only available if the AFP Support Feature is installed.
Job.Line-2AFP. PAGEDEF AFP: Page definition Identifies the AFP page definition to use with the job. Ticket job-page-definition This property is only available if the AFP Support Feature is installed.
Job.Line-2AFP.TRC AFP: Table reference characters Indicates whether table reference characters are present in the job. Ticket job-table-reference-characters This property is only available if the AFP Support Feature is installed.
Job.Media Scheduling: Media (ready | supported | all) Specifies the media to use for the job. Job or ticket The job media database name maps to several job-media and document-media attributes in JDF. RICOH ProcessDirector uses the media detection setting to determine how this value is set.

If a job ticket specifies both page-level and job-level media values, multiple values are set for this property. However, if you update the value of the Media property, it cannot be written back to the job ticket, because you cannot indicate the page range that the media should be used for. The media values in the job ticket remain unchanged.

Job.Name General: Job name Contains the name of the job. Job or ticket job-name  
Job.OutputBin Scheduling: Output bin (requested | available | all) Specifies the output bin to use for the job. Job or ticket document-output-bin-name, job-output-bin-name  
Job.Print.JogCopies Print: Jog output copies Controls whether the printer jogs the output copies for the job. Ticket job-jog-offset  
Job.Print.Xoffset Print: X offset (unit) Identifies the offset, in inches or millimeters, in the x or horizontal direction of the logical page origin from the media origin. Job or ticket image-shift-front-x This value applies to both the front and back of the page.

This property is only available if the AFP Support Feature is installed.

Job.Print.Yoffset Print: Y offset (unit) Identifies the offset, in inches or millimeters, in the y or vertical direction of the logical page origin from the media origin. Job or ticket image-shift-front-y This value applies to both the front and back of the page.

This property is only available if the AFP Support Feature is installed.

Job.Priority Scheduling: Job priority Contains the printing priority of the job. Job or ticket job-priority  
Job.Punch Scheduling: Punch Specifies the number and position of holes to punch in the output. Job or ticket document-hole-making, job-hole-making  
Job.RequestedPrinter Scheduling: Requested printer Contains the name of the printer that was requested for the job. Job or ticket job-logical-destination-name  
Job.RetainDuration General: Retention period (unit) Controls the amount of time in minutes, hours, or days that RICOH ProcessDirector retains a job after it reaches the RetainCompletedJobs step. Job or ticket job-retain  
Job.Staple Scheduling: Staple Specifies the number and position of staples to use in the output. Job or ticket job-stitching, document-stitching  

1.2.10.32 Supported Kodak printers

Kodak printer devices support the following printers:
Digimaster EX 110
Digimaster EX 125
Digimaster EX 138
Digimaster EX 150
Digimaster EX 300

1.2.10.33 Supported RICOH printers

These printers can be defined in RICOH ProcessDirector as Ricoh PDF printers. Find your printer and controller/DFE below to determine which datastream and port values to use when you define the printer.
    Note:
  • Some printers support more than one controller. As a result, printer models might be listed in more than one table.
Printers with the Ricoh standard internal controller

These printers must have the PostScript option installed. For these printers, set the Datastream to send value to PostScript and the Port value to 9100.

  • Gestetner DSm7110
  • Gestetner DSm7135
  • Gestetner DSm790
  • Gestetner P7675
  • IM C6500
  • IM C8000
  • Infoprint 2190
  • Infoprint 2210
  • Infoprint 2235
  • Lanier LD1100
  • Lanier LD1135
  • Lanier LD190
  • Lanier LD260c
  • Lanier LD275c
  • Lanier LD365C
  • Lanier LD375C
  • Lanier LP275
  • Lanier SP 9100
  • MP 1100
  • MP 1350
  • MP 9000
  • MP C6000
  • MP C6501SP
  • MP C7500
  • MP C7501SP
  • Pro 1106EX
  • Pro 1107
  • Pro 1107EX
  • Pro 1107EXP
  • Pro 1356EX
  • Pro 1357
  • Pro 1357EX
  • Pro 1357EXP
  • Pro C5100S
  • Pro C7100SX
  • Pro C5110S
  • Pro C5200S
  • Pro C5210S
  • Pro C5300S
  • Pro C5300SL
  • Pro C5310S
  • Pro 6100
  • Pro 6100HE
  • Pro 6100HT
  • Pro C7100
  • Pro C7100S
  • Pro C7100X
  • Pro C7110
  • Pro C7110S
  • Pro C7110SX
  • Pro C7110X
  • Pro C7200
  • Pro C7200e
  • Pro C7200S
  • Pro C7200SL
  • Pro C7200SX
  • Pro C7200X
  • Pro C7210
  • Pro C7210S
  • Pro C7210SX
  • Pro C7210X
  • Pro 8100EX
  • Pro 8100S
  • Pro 8100Se
  • Pro 8110
  • Pro 8110e
  • Pro 8110S
  • Pro 8110Se
  • Pro 8120e
  • Pro 8120S
  • Pro 8120Se
  • Pro 8200S
  • Pro 8210
  • Pro 8210S
  • Pro 8220
  • Pro 8220S
  • Pro 8300S
  • Pro 8310
  • Pro 8310S
  • Pro 8320
  • Pro 8320S
  • Pro 906EX
  • Pro 907
  • Pro 907EX
  • Pro 907EXP
  • Savin C6055
  • Savin C7570
  • SAVIN 8090
  • SAVIN 8110
  • SAVIN 8135
  • Savin C9065
  • Savin C9075
  • Savin MLP175n
  • SP 9100DN
Printers with the RICOH TotalFlow Print Server

For these printers, set the Datastream to send value to JDF/PDF. Use the default value for the Port setting.

  • Pro C7100
  • Pro C7100S
  • Pro C7100SX
  • Pro C7100X
  • Pro C7110
  • Pro C7110S
  • Pro C7110SX
  • Pro C7110X
  • Pro C7200
  • Pro C7200e
  • Pro C7200S
  • Pro C7200SX
  • Pro C7200X
  • Pro C7210
  • Pro C7210S
  • Pro C7210SX
  • Pro C7210X
  • Pro C9100
  • Pro C9110
  • Pro C9200
  • Pro C9210
Printers with N- series EFI Fiery controllers

For these printers, set the Datastream to send value to Ricoh API for Fiery. Use the default value for the Port setting.

  • Pro C7500
  • Pro C7500H
  • Pro C7500HT (Japan only)
  • Pro C9500
  • Pro C9500H
  • Pro Z75
  • Pro Z75 (Japan version)
Printers with E- and EB- series EFI Fiery controllers

For these printers, set the Datastream to send value to JDF/PDF. Set the Port value to 9102 to send jobs to the Print queue or 9103 to send jobs to the hold queue.

Note: RICOH ProcessDirector only supports these printers with the controllers listed. If your printer uses a different controller, it cannot be defined as a Ricoh PDF printer.

Printer model Controller   Printer model Controller
  • Gestetner DSm7110
  • Gestetner DSm7135
  • Gestetner DSm790
  • EB-135
 
  • Pro C550EX
  • Pro C700EX
  • E-8100
  • Lanier LD1100
  • Lanier LD1135
  • Lanier LD190
  • EB-135
 
  • Pro C5300SL
  • E-27B
  • Lanier LD260c
  • Lanier LD275c
  • E-7100 with Fiery V1.1 and higher
 
  • Savin C6055
  • Savin C7570
  • E-7100 with Fiery V1.1 and higher
  • Lanier LD365C
  • Lanier LD375C
  • E-7200
 
  • Pro C651EX
  • Pro C751
  • Pro C751EX
  • E-41A
  • MP 1100
  • MP 1350
  • MP 9000
  • EB-135
 
  • Pro C7100
  • Pro C7100S
  • Pro C7100SX
  • Pro C7100X
  • Pro C7110
  • Pro C7110S
  • Pro C7110SX
  • Pro C7110X
  • E-43A/E-83
  • MP C6000
  • MP C7500
  • E-7100 with Fiery V1.1 and higher
  • E-8100 with Fiery V1.1 and higher
 
  • Pro C720
  • Pro C720S
  • E-40
  • MP C6501SP
  • MP C7501SP
  • E-7200
 
  • Pro C7200
  • Pro C7200e
  • Pro C7200S
  • Pro C7200SX
  • Pro C7200X
  • Pro C7210
  • Pro C7210S
  • Pro C7210SX
  • Pro C7210X
  • E-45A/E-85A
  • E-46A/E-86A
  • Pro 1106EX
  • Pro 1356EX
  • Pro 906EX
  • EB-135
 
  • Pro C7200SL
  • E-35A
  • E-36A
  • Pro 1107EX
  • Pro 1357EX
  • Pro 907EX
  • EB-1357 with Fiery V1.1 and higher
 
  • Pro C900
  • Pro C900S
  • E-40/E-80 with Fiery V4.0 and higher
  • Pro 8100EX
  • Pro 8100S
  • Pro 8100Se
  • Pro 8110
  • Pro 8110e
  • Pro 8110S
  • Pro 8110Se
  • Pro 8120
  • Pro 8120e
  • Pro 8120S
  • Pro 8120Se
  • EB-32
 
  • Pro C901
  • Pro C901S
  • E-41/E-81
  • E-42/E82
  • Pro 8200S
  • Pro 8210
  • Pro 8210S
  • Pro 8220
  • Pro 8220S
  • EB-34
 
  • Pro C9100
  • Pro C9110
  • E-43/E-83
  • Pro 8300S
  • Pro 8310
  • Pro 8310S
  • Pro 8320
  • Pro 8320S
  • EB-35
 
  • Pro C9200
  • Pro C9210
  • E-45/E-85
  • E-46/E-86
  • Pro C5100S
  • Pro C5110S
  • E-22B/E-42B
 
  • SAVIN 8135
  • SAVIN 8110
  • SAVIN 8090
  • EB-135
  • Pro C5200S
  • Pro C5210S
  • E-24B/E-44B
 
  • Savin C9065
  • Savin C9075
  • E-7200
  • Pro C5300S
  • Pro C5310S
  • E-27B/E-47B
     

1.2.10.34 Supported Xerox printers

Xerox printer devices support the following printers with DocuSP V1.0, V3.8, V4.2, or V5.0 drivers:
DocuTech 6100
DocuTech 6115
DocuTech 6135
DocuTech 6155
DocuTech 6180
DocuTech 75
DocuTech 90
DocuTech 350
DocuTech 425
DocuTech 500
DocuTech 700
DocuTech 850
DocuTech 1000
DocuTech 128HLV
DocuTech 155HLC
DocuTech 180HLC
DocuPrint 100EPS
DocuPrint 115EPS
DocuPrint 135EPS
DocuPrint 155EPS
DocuPrint 180EPS
DocuColor 250
DocuColor 2045
DocuColor 2060
DocuColor 6060
DocuColor 7000
DocuColor 8000
DocuColor 250
iGen3
Nuvera 100DCP
Nuvera 120DCP
Nuvera 100DPS
Nuvera 120DPS
XDP 4110
XDP 4590

                           

1.2.10.35 Accessibility

Ricoh strives to provide products with usable access for everyone, regardless of age or ability.

For more information about the commitment that we have made to accessibility, refer to the Accessibility page on the Ricoh website.

Accessibility features

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

The major accessibility features in this product let you:

  • Use screen readers, screen magnifiers, and other assistive technologies.
  • Use a keyboard instead of a mouse.
  • Change attributes such as volume, color, contrast, and font size.

In addition, the information center and the publications for the product are in an accessible format.

To enable assistive technology support in the installer, specify the console option at the end of the setup command. For example, to enable assistive technology on Linux computers, enter:

./setup -console

Keyboard navigation

This product uses standard Microsoft Windows navigation keys.

    Important:
  • You cannot use the Workflow tab, the AFP Indexer mode of RICOH Visual Workbench (which is part of the AFP Support feature), the AFP Editor feature, or the Whitespace Manager feature with the keyboard alone. They require a mouse.
RICOH ProcessDirector user interface shortcut keys

When the Jobs table on the Main page or a table on the Administration page has focus, you can use these shortcut keys:

User interface shortcut keys
Description Ctrl + key
Select all objects in the table. a
Open the field help for the currently selected property. F1

When viewing a job in a workflow, you can use these shortcut keys:

View job in workflow shortcut keys
Description Ctrl + key
Zoom in. +
Zoom out. -
Return to the default zoom level. 0
RICOH ProcessDirector workflow shortcut keys

On the Workflow Editor, you can use these shortcut keys:

Workflow shortcut keys
Description Ctrl + key
Save the workflow. Ctrl + s
Undo a previous action, including changes made on a step or connector property notebook. Ctrl + z
Reverse an Undo action, including changes made on a step or connector property notebook. Ctrl + y or Ctrl + Shift + z
Show or hide the Step Templates window. Ctrl + e
Show or hide the Map. Ctrl + m
Zoom in. Ctrl + +
Zoom out. Ctrl + -
Reset the zoom to the default value. Ctrl + 0
Reset the default size and location of the Map window. Ctrl + d
Copy one or more steps. Steps must be selected first. Ctrl + c
Delete one or more steps. Steps must be selected first. Delete

1.2.10.36 Trademarks

RICOH ProcessDirector and RICOH InfoPrint Manager are trademarks of Ricoh Company, Ltd. in the United States, other countries, or both.

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

Amazon® is a registered trademark of Amazon.com LLC.

EFI®, Fiery®, and the Fiery logo are either registered trademarks or trademarks of Electronics For Imaging, Inc. in the U.S. and/or certain other countries.

Firefox® is a registered trademark of the Mozilla Foundation.

Google Chrome is a trademark of Google, Inc.

IBM®, AIX, DB2®, MVS, POWER, Print Services Facility, and z/OS® are either registered trademarks or trademarks of International Business Machines Corporation in the United States and/or other countries.

Impostrip® is a registered trademark of Ultimate TechnoGraphics Inc.

Kodak® is a registered trademark of Eastman Kodak Company.

Linux® is a registered trademark of Linus Torvalds.

MarcomCentral® is a registered trademark of MarcomCentral, a Ricoh Company.

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®, Java®, and OpenJDK™ are trademarks or registered trademarks of Oracle and/or its affiliates.

PostgreSQL® is a registered trademark of PostgreSQL Community Association of Canada.

Quadient® is a registered trademark of Quadient Group AG.

Tableau Software® and Tableau® are registered trademarks of Tableau Software.

UNIX® is a registered trademark of The Open Group.

VMware® is a registered trademark of Vmware, Inc.

Xerox® is a registered trademark of Xerox Corporation.

Thales Group code: The license management portion of this Licensee Application is based on one or more of the following copyrights:

Sentinel RMS
Copyright 1989-2022 Thales Group 
All rights reserved.

Sentinel Caffe (TM)
Copyright 2008-2022 Thales Group 
All rights reserved.

Sentinel EMS
Copyright 2008-2022 Thales Group 
All rights reserved.

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

  • Windows XP:
    • Microsoft Windows XP Professional
    • Microsoft Windows XP Enterprise
  • Windows 7:
    • Microsoft Windows 7 Professional
    • Microsoft Windows 7 Ultimate
    • Microsoft Windows 7 Enterprise
  • Windows 10:
    • Microsoft Windows 10 Pro
    • Microsoft Windows 10 Enterprise
  • Windows 11:
    • Microsoft Windows 11 Pro
  • Windows Server 2008:
    • Microsoft Windows Server 2008 Standard
    • Microsoft Windows Server 2008 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

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.2.11 Related publications

If you are looking for more information about RICOH ProcessDirector, use the related publications for each specific technology.

1.2.11.1 Related publications and information centers

RICOH ProcessDirector uses a variety of technologies. Advanced users can review publications and information centers that are specific to those technologies. Publications listed here do not represent the entire library of publications for a given product.

In addition to this information center, you might find these publications useful:

  • RICOH ProcessDirector for Linux: Planning and Installing, G550-1042
  • RICOH ProcessDirector: Integrating with Other Applications, S550-1069
  • InfoPrint Manager: PSF and Server Messages, and Transform Messages , G550-1053
  • Advanced Function Presentation: Programming Guide and Line Data Reference, S544-3884
  • AFP Conversion and Indexing Facility User's Guide, G550-1342
  • Data Stream & Object Architectures: MO:DCA Reference, SC31-6802
  • IBM Print Services Facility for z/OS: AFP Download Plus, S550-0433
  • IBM Print Services Facility for z/OS: Customization, S550-0427
  • IBM Print Services Facility for z/OS: Download for z/OS, S550-0429
  • IBM Print Services Facility for z/OS: User's Guide, S550-0435

You can download these publications from the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/).

1.3 Integrating with Other Applications

1.3.1 Introduction

1.3.1.1 Important

To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use 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.2 Cautions regarding this guide

  • Some illustrations or explanations in this guide could differ from your product due to improvements or changes 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.
  • Throughout this publication, references to directory paths indicate the default paths only. If you install RICOH ProcessDirector or any of its components in a different location, including a different drive, you must adjust the paths accordingly.

    For example, if you install RICOH ProcessDirector on the D: drive of a computer running a Windows operating system, replace C: with D: in the directory paths.

1.3.1.3 Publications for this product

The RICOH ProcessDirector publications CD includes the RICOH ProcessDirector publications.
Instruction manuals

These instruction manuals are included:

  • RICOH ProcessDirector: Integrating with Other Applications (this publication)

    This guide provides technical information about the ways that you can configure RICOH ProcessDirector to exchange data with other applications.

  • RICOH ProcessDirector for Linux or Windows: Planning and Installing

    This guide explains planning and installation procedures for RICOH ProcessDirector on your operating system. The publications CD includes the version of this manual for your operating system: Linux or Windows.

  • RICOH ProcessDirector: Installing Document Processing Features

    This guide explains how to install RICOH ProcessDirector features that control and track both jobs and the individual documents in jobs.

  • RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat

    This guide explains how to use RICOH ProcessDirector Plug-in for Adobe Acrobat. You can use the Adobe Acrobat plug-in to define text, barcodes, images, and other enhancements in a PDF file. After you save your enhancements in a control file, RICOH ProcessDirector workflows can use the control file to make similar enhancements to PDF files.

  • Font Summary

    This guide explains font concepts and the different types of fonts in the InfoPrint Font Collection. The Font Summary is available only in English.

  • White Paper–Using the Enhance AFP Function

    This guide explains how to configure and use Enhance AFP control files. The guide is available only in English.

  • The RICOH ProcessDirector readme file (readme.html)

    This file tells you how to access the other publications. The readme file is available only in English.

  • The RICOH ProcessDirector release notes

    These release notes provide information about the RICOH ProcessDirector release, including new functions and updates; known limitations, problems, and workarounds; and code change requests. The release notes are available only in English.

You can also download publications from the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/).

RICOH ProcessDirector Information Center

The Information Center contains topics that help administrators, supervisors, and operators learn about and use RICOH ProcessDirector. The Information Center is available from the user interface and provides quick navigation and search features.

Help

Field help is available on many screens to provide information for specific tasks and settings.

1.3.1.4 How to read the documentation

1.3.1.4.1 Before using RICOH ProcessDirector

This manual contains instructions and cautions for configuring RICOH ProcessDirector to exchange data with other applications. Before using RICOH ProcessDirector to exchange data with other applications, read this manual thoroughly and completely. Keep this manual handy for future reference.

1.3.1.4.2 How to use the manuals

Use the instruction manuals according to your needs.
To learn how to plan for, install, and start RICOH ProcessDirector:
See RICOH ProcessDirector for Linux or Windows: Planning and Installing. The publications CD includes the version of this manual for your operating system: Linux or Windows.
To learn about the functions and operations of RICOH ProcessDirector and its installed features:
See the RICOH ProcessDirector Information Center.
To learn how to set property values in the user interface:
See the field help.
To learn how to configure RICOH ProcessDirector to exchange data with other applications:
See RICOH ProcessDirector: Integrating with Other Applications.
To learn how to install a document processing feature:
See RICOH ProcessDirector: Installing Document Processing Features.
To learn how to use the functions and operations of RICOH ProcessDirector Plug-in for Adobe Acrobat
See RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.
Displaying the publications

The RICOH ProcessDirector publications are available on the publications CD, so you can access them before you install the application.

    Note:
  • A PDF viewer, such as Adobe Acrobat Reader, is required to view the publications.

To access the RICOH ProcessDirector publications CD on Windows:

  1. Insert the CD in the CD drive.

    If the Windows system is configured to autorun CDs, Windows Explorer opens automatically to show the contents of the CD.

  2. If Windows Explorer does not start automatically, open it and display the contents of the CD drive.
  3. Open the readme.html file for information about the contents of the CD.

Some of these publications are also available from RICOH ProcessDirector user interface.

    Note:
  • You must log in to the RICOH ProcessDirector user interface to view the publications.

In the banner of the RICOH ProcessDirector user interface, click the Information button and select one of the following publications to download:

  • RICOH ProcessDirector: Integrating with Other Applications
  • RICOH ProcessDirector: Installing Document Processing Features
  • RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat
  • RICOH ProcessDirector: Release Notes

Displaying the Information Center

The RICOH ProcessDirector Information Center is available from the user interface.

To display the Information Center:

  • In the banner of the RICOH ProcessDirector user interface, click the Information button and select Help.

In addition, you can bookmark the location of the Information Center in your browser and open it at any time outside of RICOH ProcessDirector.

Information about use the functions and operations of features are available only when the features are installed in the system.

1.3.1.5 Related information

For information about our products, see:

For information about related products, see:

  • InfoPrint Manager for AIX: Getting Started, G550-1061
  • InfoPrint Manager for AIX: Planning Guide, G550-1060
  • InfoPrint Manager for Linux: Getting Started, G550-20263
  • InfoPrint Manager for Linux: Planning Guide, G550-20262
  • InfoPrint Manager for Windows: Getting Started, G550-1072
  • InfoPrint Manager for Windows: Planning Guide, G550-1071
  • InfoPrint Manager: PSF and Server Messages, G550-1053
  • RICOH InfoPrint XT for Linux: Installation and User's Guide, G550-20375
  • RICOH InfoPrint XT for Windows: Installation and User's Guide, GLD0-0025
  • AFP Conversion and Indexing Facility User's Guide, G550-1342
  • IBM Print Services Facility for z/OS: AFP Download Plus, S550-0433
  • IBM Print Services Facility for z/OS: Download for z/OS, S550-0429

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

1.3.1.7 Abbreviations

AFP
Advanced Function Presentation
API
Application Programming Interface
CSV
Comma-Separated Values
DNS
Domain Name System
HTTP
Hyper Text Transfer Protocol
IP
Internet Protocol
JDF
Job Definition Format
LPD
Line printer daemon
PDF
Portable Document Format
PSF
Print Services Facility
REST
Representational State Transfer
SMIT
System Management Interface Tool
SOAP
Simple Object Access Protocol
SSL
Secure Sockets Layer
YaST
Yet Another Setup Tool

1.3.1.8 Trademarks

RICOH ProcessDirector and RICOH InfoPrint Manager are trademarks of Ricoh Company, Ltd. in the United States, other countries, or both.

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

IBM, AIX, MVS, Print Services Facility, and z/OS are either registered trademarks or trademarks of International Business Machines Corporation in the United States and/or other countries.

Impostrip® is a registered trademark of Ultimate TechnoGraphics Inc.

Kodak is a registered trademark of Eastman Kodak Company.

Linux is a registered trademark of Linus Torvalds.

MarcomCentral is a registered trademark of MarcomCentral, a Ricoh Company.

Microsoft, Windows, Windows Server, and Internet Explorer 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.

UNIX is a registered trademark of The Open Group.

Xerox is a registered trademark of Xerox Corporation.

Thales Group code: The license management portion of this Licensee Application is based on one or more of the following copyrights:

Sentinel RMS
Copyright 1989-2022 Thales Group 
All rights reserved.

Sentinel Caffe (TM)
Copyright 2008-2022 Thales Group 
All rights reserved.

Sentinel EMS
Copyright 2008-2022 Thales Group 
All rights reserved.

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

  • Windows 10:
    • Microsoft Windows 10 Pro
    • Microsoft Windows 10 Enterprise
  • The product name of Windows 11 is:
    • Microsoft Windows 11 Pro
  • Windows Server 2012 R2:
    • Microsoft Windows Server 2012 R2 Standard
    • Microsoft Windows Server 2012 R2 Enterprise
  • Windows Server 2016:
    • Microsoft Windows Server 2016 Standard
    • Microsoft Windows Server 2016 Datacenter
  • Windows Server 2019:
    • Microsoft Windows Server 2019 Standard
  • The product name of Windows Server 2022 is:
    • Microsoft Windows Server 2022 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.3.2 Overview

RICOH ProcessDirector provides several mechanisms for interacting with other applications. The mechanism you use depends on your goal and on the capabilities of the application.

The general goals that you might want to accomplish when you use RICOH ProcessDirector with another application are:

  1. Submit a job for processing and printing.

    Your application can copy print files to hot folder input devices, which are directories that RICOH ProcessDirector monitors at configurable intervals. RICOH ProcessDirector accepts the print files and converts them into print jobs.

    You can send jobs to hot folders using a variety of methods. If you submit Job Definition Format (JDF) job tickets with your print files, the hot folder input device can use the job ticket to set job properties. The JDF job ticket stays with the job during processing. Most job properties and the values in the job ticket are synchronized whenever the job ticket is requested. You can also send jobs into a hot folder with the JDF batching method with the PDF, JDF and JMF information in a single MIME package. The JMF must reference the name of the hot folder as the DeviceID.

    If your application uses the line print (LPR) function to transmit files, it can send them to a line printer daemon (LPD) input device. LPD input devices are similar to hot folder input devices, but they can only receive files that are sent using LPR.

  2. Add processing capabilities that are not available in RICOH ProcessDirector to your print workflows.

    If your application provides processing that can be incorporated into print workflows (such as address cleansing, data stream transformation, or impositioning), you can create steps that send the print job from RICOH ProcessDirector to your application, wait for a valid return code, and then continue processing in RICOH ProcessDirector.

    If your application monitors hot folders, the steps you create can copy print jobs to and from those hot folders. If your application has a command line, the step can run the appropriate command and wait for the resulting file to be returned.

    If you submit jobs with JDF job tickets, the application can use values in the job ticket, even if they are not supported by RICOH ProcessDirector. If the application updates values in the job ticket, the new values can be reflected in RICOH ProcessDirector.

    RICOH ProcessDirector provides features that make it easier to integrate with other programs into workflows.

    RICOH ProcessDirector Feature Associated Program
    Avanti Slingshot Connect Avanti Slingshot
    Quadient Inspire Connect Quadient Inspire Designer
    Marcom Central Connect Marcom Central
    PitStop Connect Enfocus PitStop Server 10 or higher
    Ultimate Impostrip® Connect Ultimate Impostrip®

    RICOH ProcessDirector also provides the Postal Enablement feature. The Postal Enablement feature lets you connect to your choice of external postal software. Examples of postal software include TEC Mailing Solutions MailPreparer or the Bell and Howell BCC Mail Manager.

  3. Access RICOH ProcessDirector using a REST API.

    You can use the REST APIs provided with RICOH ProcessDirector to integrate with the Web services for your application. With these REST APIs you can make requests and issue commands using Web services.

    Making requests using Web services includes retrieving the status of objects in the system, property values, and log files, among other things. For example, if you want to collect the same information about various jobs in the system for use in a report or to display in a different user interface, you can create a Web services request to ask for that information.

    Issuing commands using Web services includes connecting and disconnecting input devices, enabling and disabling objects, and setting object properties. For example, if you want to enable and connect an input device, you can create a Web service request that issues the correct commands.

Later chapters provide more information about each goal and the ways to achieve them. Before you read those chapters, make sure that you understand the basic information about RICOH ProcessDirector that this chapter explains.

1.3.2.1 System objects

The RICOH ProcessDirector system contains objects that represent hardware, software, files, paper, and processes. You can configure the properties of the objects to meet your needs.

The base product provides many kinds of system objects, such as:

  • Primary server

    The system that RICOH ProcessDirector is installed on. This system holds most of the product components, including the internal database, Web server, print driver, help system, and message logs.

  • Secondary servers

    Other Linux systems that can connect to the primary server. Secondary servers can be used to offload resource-intensive process steps and improve processing speed.

    Secondary servers can also be used to access applications that run on different computers.

    Secondary servers can only be used with RICOH ProcessDirector for Linux.

  • Application servers

    Application servers share the database that the primary server uses and work with the primary server to process jobs effectively. Application servers are installed on Windows computers. They can run steps that require applications on Windows and can be used as parent servers for input devices, Ricoh PDF printers, Custom PDF printers, Ricoh TotalFlow printers, Kodak printers, Xerox printers, and Passthrough printers. They cannot run other steps (such as PrintJobs) or be used as the parent server for other kinds of printers.

    Application servers can only be used with RICOH ProcessDirector for Linux.

  • Step templates

    Step templates are the basic building blocks for processing in the RICOH ProcessDirector system. Each step template contains code that does a specific action, such as setting job properties, transforming from one data stream to another, or retaining a job for a given time period.

    A step template becomes instantiated as a step when it is added to a workflow.

  • Workflows

    A workflow is a set of steps, arranged and configured to meet the needs of the print provider. A print job moves from step to step in a workflow until it completes the workflow without error or reaches the end of a processing path. In some cases, a job might be processed through more than one workflow. Workflows can be linear or conditional. In a linear workflow, each step can receive jobs from one step and send jobs to one step. In a conditional workflow, each step can receive jobs from one or more steps and send jobs to one or more steps. When a step sends jobs to multiple steps, the connectors between the steps specify conditions that control which step each job is sent to.

      Important:
    • When you use the Workflow Editor to edit a job type created in a previous version of RICOH ProcessDirector, the job type becomes a workflow. It can no longer be opened on the Administration page by clicking Workflow Job Types.
  • Input devices

    Input devices receive input files, create print jobs from those files, assign the print jobs to workflows, and submit the jobs for processing. There are several kinds of input devices. You choose which kind to use based on how jobs are submitted to them.

  • Printers

    Printers represent the printer hardware that is connected to the system and that can receive jobs from RICOH ProcessDirector.

Optional features and extended features can add other types of objects to the system.

When RICOH ProcessDirector interacts with other applications, the key objects are secondary servers, application servers, input devices, and step templates.

For a list of available system objects, you can use objecttypes API found in the utility section of the RICOH ProcessDirector REST API documentation. See Using RICOH ProcessDirector REST API documentation for more information.

1.3.2.1.1 Secondary servers

Secondary servers let you distribute processing, so that your RICOH ProcessDirector system runs more efficiently.

You can use secondary servers to do some of the more processing-intensive steps in your various workflows and to prevent the primary server from becoming overloaded. The primary server works with the secondary servers to coordinate the movement of all jobs across the system. The secondary servers do not have their own embedded databases for storing system information. All the servers work with the database that is installed on the primary computer.

Secondary servers can manage all types of RICOH ProcessDirector objects, such as input devices, steps, and printers. They can also run external programs that RICOH ProcessDirector accesses through external steps. External programs can do more processing or special types of processing.

For installations that have many printers and a high volume of jobs, adding secondary servers to the system can increase job throughput. The throughput increases because each server has a smaller number of printers and jobs to monitor and control.

1.3.2.1.2 Application server

An application server is a Windows system configured to communicate with RICOH ProcessDirector. If your workflows require processing by applications that run on Windows, you can access those applications by installing RICOH ProcessDirector application server code on a Windows computer.

Application servers work with primary computers running Linux. They do not work with primary computers running Windows.

Application servers share the database that the primary server uses and work with the primary server to process jobs effectively. Because application servers are installed on Windows computers, they can run steps that require applications on Windows. They cannot run other steps, such as PrintJobs.

Application servers can be the parent servers for Ricoh PDF printers, Custom PDF printers, and Passthrough printers. They cannot be the parent servers for other kinds of printers.

You can install application servers on these operating systems:

  • Windows 10 Pro or Enterprise 64-bit
  • Windows 11 Pro
  • Windows Server 2019 64-bit
  • Windows Server 2022 64-bit

1.3.2.1.3 Input devices

Input devices receive input files, create jobs, and assign the jobs to workflows for processing.

RICOH ProcessDirector provides these types of input devices:

  • Hot folder input devices are directories that the system monitors. When a print job is copied or sent to a Hot folder, the system notices it and begins to process it.
  • Line printer daemon (LPD) input devices receive jobs that are submitted using the LPD protocol. LPD input devices specify a control file, receive_lpd_jobtype.cfg or receive_lpd_pdf_jobtype.cfg, to convert LPD control file parameters for the job to a text-based job property file.
  • REST web service input devices call a Representational State Transfer web service to retrieve XML or JSON files from a third-party application. The input device can create a job containing the entire XML or JSON file, or it can examine the file using an XPath or JSONPath expression. If the input device finds XML elements or JSON objects specified by the expression, it can create a single job containing the entire file. Alternatively, it can create one or more jobs, each containing a portion of the file. This device type is only available if the Web Services Enablement feature is installed.
  • SOAP web service input devices call a Simple Object Access Protocol web service to retrieve XML files from a third-party application. The input device can create a job containing the entire XML file, or it can examine the file using an XPath expression. If the input device finds XML elements specified by the expression, it can create a single job containing the entire file. Alternatively, it can create one or more jobs, each containing a portion of the file. This device type is only available if the Web Services Enablement feature is installed.

The AFP Support feature provides Download input devices. These input devices receive data sets from Download for z/OS or AFP Download Plus. For information about submitting jobs to Download input devices, see Print Services Facility for z/OS: Download for z/OS (S550-0429) or Print Services Facility for z/OS: AFP Download Plus (S550-0433).

1.3.2.1.3.1 Hot folder input devices

Hot folder input devices are directories on a primary or secondary server that the system monitors for input files.

To move input files into hot folders, you can use a copy command, file transfer protocol (FTP), secure copy protocol (SCP), or any other method that lets you transfer files to a specified location.

RICOH ProcessDirector provides several predefined hot folder input devices that you can copy and modify to fit your environment.

1.3.2.1.3.2 LPD input devices

LPD input devices receive jobs that are submitted using an LPR command. LPD input devices specify a control file, receive_lpd_jobtype.cfg or receive_lpd_pdf_jobtype.cfg, to convert LPD control file parameters for the job to a text-based job property file.

RICOH ProcessDirector provides several predefined LPD input devices that you can use.

1.3.2.1.3.3 Download input devices

Download input devices receive jobs from Download for z/OS® or AFP Download Plus. Download input devices specify a control file to change JCL parameters for a job to a job properties file in RICOH ProcessDirector property name=value format that the workflow uses.

The AFP Support feature provides several predefined download input devices that you can use.

1.3.2.1.4 Step templates

Step templates are separate units of processing code. They can be assembled into workflows based on what you need to do to an input file.

RICOH ProcessDirector provides many step templates that you can incorporate into workflows; optional features can add even more. You can either use those step templates as they are, or copy and modify them to work in your environment.

Note: Some step templates cannot be copied; but you can edit their properties.
You cannot write your own step templates and include them in workflows. However, if you write a script or other program that can be invoked from the command line, you can access it using the RunExternalProgram step template.

Some step templates are particularly important for interacting with other applications:

  • SetJobType step templates

    Input devices use SetJobType steps to determine which workflow to use to process a print job. The SetJobType step templates are:

    • SetJobTypeFromFileName

      Uses a pattern-matching string to set the workflow from a portion of the input-file name, such as the file extension. For example, all jobs with the file extension .AFP can be sent to the workflow AFP or all jobs with the extension .pdf can be sent to the workflow pdf. The step can also convert an optional overrides file submitted with a job to a text-based file, jobID.overrides.text, which the SetJobPropsFromTextFile step uses to set job properties.

    • SetJobTypeFromRules

      Uses a control file to select the workflow based on the value of a parameter in an overrides files that accompanies the input file. The step can also convert an optional overrides file submitted with a job to a text-based file, which the SetJobPropsFromTextFile step uses to set job properties.

    Print system administrators might want to coordinate the output of a print submission application with the values in these steps.

  • SubmitInputFiles step template

    Input devices use the SubmitInputFiles step to send print jobs to the first step in their workflows. It submits a group of input files as a parent job and child jobs according to the batching method specified. It submits a single input file as a single job of the child workflow, without a parent job.

  • SetJobPropsFromTextFile step template

    The SetJobPropsFromTextFile step is usually the first step in a workflow. It uses a text file that accompanies the input file to set job properties. The text file specifies which properties to set. Values in the text file overwrite any values that have been set previously. After processing an optional jobID.overrides.text file, the step looks for an optional Job Definition Format (JDF) job ticket file, jobID.overrides.jdf, and uses it to set additional properties of the job.

  • External steps

    External steps send print jobs to applications outside of RICOH ProcessDirector for processing such as data stream transforms, address cleansing, and impositioning. The external step templates are:

    • RunExternalProgram

      Submits the print job to an external program using a command line interface.

    • RunHotFolderApplication

      Puts the print job in a hot folder that another application monitors. That application picks up the print job, processes it according to its configuration settings, and puts it into an output folder. RICOH ProcessDirector monitors that output folder and retrieves the job when it is ready.

1.3.2.2 Web services in RICOH ProcessDirector

RICOH ProcessDirector provides Web services that use Representational State Transfer (REST) software architecture principles so you can access its functions from other applications.

RESTful Web services send requests and receive results using the Hypertext Transfer Protocol (HTTP). Each Web service has a Universal Resource Indicator (URI) associated with it. When you create requests, you modify the URI to include specific information about the object that you are interested in or the action that you want to do. These modifications can be simple, such as inserting the name of a printer object into the URI, or highly complex, such as using Extensible Markup Language (XML) to describe the criteria to use when searching for objects and how they should be sorted when they are returned. If you code XML elements to include in your requests, they must be Universal Resource Locator (URL)-encoded before they are added to the URI.

With RICOH ProcessDirector, you can use Web services to request information about print jobs and other objects in the system. You can also use them to set properties and do actions such as enabling and disabling objects, modifying properties, and starting and stopping printers.

1.3.2.2.1 Usage notes

The Web services provided with RICOH ProcessDirector follow specific conventions. When you integrate Web services with your application, refer to these usage notes to make sure that your implementation functions properly.

  • You must use the POST /users/login/ Web service to establish a connection and receive a credential token from the RICOH ProcessDirector server before you can use any other Web services. All of the other Web services require that you include a credential token in the request header of the URI. If you do not, you receive an immediate 401 Unauthorized HTTP error.
  • You cannot translate actions and URIs into other languages because they are fixed-character strings. For example, "token:" remains the same for all languages.
  • Record sets retrieved might change between invocations of any service, especially when you use sorting or filtering functions; successive identical requests might not yield the same records.
  • If you activate Secure Sockets Layer (SSL) or Transport Layer Security (TLS) support, RICOH ProcessDirector uses the SSL protocol for all HTTP communications, including Web services. If SSL or TLS support is active, you must use a Web services client that supports SSL or TLS to invoke Web services.
  • RICOH ProcessDirector Web services only return JavaScript Object Notation (JSON) data. XML is not supported.

1.3.3 Submitting jobs from other applications

If your application is a document composition or a job submission tool, you can use hot folder or LPD input devices to get print jobs into RICOH ProcessDirector to be processed and printed.

If your application can use REST web services, you can use the submitFile utility to submit a file to a workflow or hot folder. See Preparing to submit jobs using web services for more detailed information about this implementation.

The key functions of input devices are to:

  • Receive jobs into the system.
  • Assign jobs to workflows.
  • Send jobs to the first step in the workflow to begin processing.

Hot folder input devices can receive a variety of print jobs, including those that are submitted with JDF job tickets. LPD input devices can receive print jobs submitted using a line printer (LPR) command.

Note: Neither type of input device returns information to the submitting application when print jobs are received. For example, if you send a print job to a hot folder input device, the hot folder does not send the job number back to the submitting application so it can monitor the progress of the job.

1.3.3.1 Hot folder input devices

Hot folder input devices can receive print jobs that include a single file, jobs that include multiple files, and jobs that include JDF job tickets.

When you configure a hot folder, you determine what types of jobs it should handle. Then, you have to make sure that jobs are submitted to the correct hot folder so they are processed correctly. Otherwise, print jobs can encounter errors before they even start to process through a workflow.

Input files can be processed individually or as groups. To process them as groups, you can create a batch. Some batching methods require additional supporting files that must be submitted with the input files.

The figure Hot folder input device processing shows how a hot folder input device processes jobs. The input device acts on jobs based on the value of the batching method and passes the job to the Submit step.

Hot folder input device processing
This figure shows how a hot folder input device processes jobs. The input device acts on jobs based on the value of the batching method, as described in the text.
Permissions

All users who submit jobs to a hot folder (including the user IDs that job submission applications run under) must have the appropriate permissions for that folder. The easiest way to make sure that users have the correct permissions is to add all submitters to the RICOH ProcessDirector group (aiwgrp1 is the default), which is created when RICOH ProcessDirector is installed.

1.3.3.1.1 Batching methods

The way that hot folder and SFTP input devices submit jobs is determined by the Batching method property of the input device.

By default, using any batching method except None causes an input device to create jobs as groups that use the parent/child structure. A parent job contains no data; it is a container that maintains the relationship between other jobs. Those jobs are child jobs. Each input file that a batching method includes in a group becomes a child job.

For all batching methods except None, JDF, and List, RICOH ProcessDirector for Windows processes child jobs in the order that the files were last modified. The Windows Date Modified value is shown as the value of the Time submitted job property. Because the Date Modified value does not change when the file is received by the input device, a file created in 2010 and submitted in 2011 shows a Time submitted from 2010.

    Note:
  • If you set the Create .zip file property of an input device to Yes, the input device does not create groups of jobs that use the parent/child structure. Instead, the input device gathers all the input files in the group and creates a ZIP file to hold them. The ZIP file is submitted as a single job. You must have a step in the workflow that unzips the file unless the other steps can process a file in ZIP file format.
  • You can submit all the input files in an input device with the Batch all action on the input device as long as the Batching method is not JDF or Pattern. The Batch all action does not wait for the Polling interval to be reached before creating the jobs.

1.3.3.1.1.1 Batch

When the batching method is Batch, the input device submits one or more files as a group, based on the files that an operator selects.

The Batch batching method prevents the input device from submitting jobs immediately. The input device receives files but does nothing until an operator selects one or more data files and clicks Make batch. The input device creates a list file that contains the names of all the data files and submits the job.

When you use the Batch batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the data files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Data patterns: A pattern that matches some part of the file name of your files. For hot folder and SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.3.3.1.1.2 JDF

When the batching method is JDF, the hot folder or SFTP input device submits one or more files as a group, based on the contents of the job ticket.

The hot folder or SFTP input device looks for a job ticket containing a list of all the files that make up the job. When the hot folder or SFTP input device finds a job ticket, it reads the ticket and looks for all the files; as soon as it finds all the files, it submits them as a single job. The files print in the order specified in the job ticket.

The file name of the job ticket must match the pattern specified in the JDF patterns property. The default pattern matches files that have the extension .jdf.

The list of files in the job ticket might look like this:

myfile1.pdf
myfile2.pdf
myfile3.pdf
another.pdf

The job ticket might also contain information that is used to set job properties.

When you use the JDF batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs. If the job ticket specifies different settings for different input files and the Create .zip file property is set to Yes, the settings for the first input file name in the job ticket are used for all input files.
  • JDF patterns: A pattern that matches some part of the file name of your job tickets.

    For all input devices except HotFolderJDF the default value is null. For HotFolderJDF this value is the regular expression .*\jdf$.

  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.3.3.1.1.3 List

When the batching method is List, the hot folder or SFTP input device submits one or more files as a group, based on the contents of a list file that is received by the input device.

The hot folder or SFTP input device looks for a text-based list file containing a list of all the files that make up the job. When the hot folder or SFTP input device finds a list file, it reads the list and looks for all the files; as soon as it finds all the files, it submits them as a single job. The files print in the order specified in the list file.

The list file must meet these criteria:

  • The file name must match the pattern specified in the List patterns property. The default pattern matches files that have the extension .lst.
  • Each file in the print job must be on a separate line in the list file.
  • The file names listed in the list file must include only file names, not path information; all files must be in the same directory.
The contents of the list file might look like this:
afpinput1.afp
afpinput2.afp
afpinput3.afp
inputfile.afp

When you use the List batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • List patterns: A pattern that matches some part of the file name of your list files.

    By default, this value is the regular expression .*lst$.

  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

    If a print file is listed in the list file, but the file name does not match the Data patterns value, the input device does not identify the file as a print file. Because a listed print file appears to be missing, the input device waits for it and does not create the job.

  • Overrides patterns: if you use overrides files, a pattern that matches some part of the file name of your overrides files.

1.3.3.1.1.4 None

When the batching method is None, the hot folder or SFTP input device submits every file as a separate print job.

1.3.3.1.1.5 Number

When the batching method is Number, the hot folder or SFTP input device submits a specific number of files as a group. Only files that match the Data patterns property of the hot folder or SFTP input device are counted and submitted.

The hot folder or SFTP input device parses the file name and determines if it matches the value of the Data patterns property. If the name matches the pattern, the hot folder or SFTP input device counts the file. When the number of files reaches the value set for the Number of files to batch property, the hot folder or SFTP input device submits the files as a single group.

    Note:
  • RICOH ProcessDirector for Windows processes child jobs in the order that the files were last modified. The Windows Date Modified value is shown as the value of the Time submitted job property. Because the Date Modified value does not change when the file is placed in the input device, a file created in 2010 and submitted in 2011 shows a Time submitted from 2010.

When you use the Number batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Number of files to batch: The number of files that the hot folder or SFTP input device waits to receive before submitting the files as a single group.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.3.3.1.1.6 Number of sets

When the batching method is Number of sets, the hot folder or SFTP input device submits one or more jobs after a specific number of sets of files are received. Only complete sets of files are counted and submitted.

For a set to be complete, all of these conditions must be true:

  • A file matching the value in the Data patterns property is present.
  • If a value is entered for the Overrides patterns or JDF patterns properties, a file matching one or both of those values is present.
  • If there are any entries specified for File patterns, a file matching each value is present.

When the number of complete sets reaches the value set for the Number of files to batch property, the hot folder or SFTP input device submits the sets as a group with one set in each child job. If the Create .zip file property is set to Yes, a single job containing all of the files in all of the sets is submitted in ZIP file format.

When you use the Number of sets batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all of the files are combined as a ZIP file and submitted as a single job. If this value is set to No, each set is submitted as a child job.
  • Number of files to batch: The number of sets that the hot folder or SFTP input device waits to receive before submitting them as a single group.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.
  • File Patterns: A collection of patterns that can define files that are required to be included in a set.
  • JDF patterns: One or more pattern-matching strings used to identify Job Definition Format (JDF) job tickets. If this property has a value specified, a JDF job ticket is required for the set to be complete.
  • Overrides patterns: One or more pattern-matching strings used to identify files that contain values for job properties.

1.3.3.1.1.7 Pages

When the batching method is Pages, the hot folder or SFTP input device submits one or more PDF files as a group, based on the number of pages in the files that are received by the input device. This method is only valid for PDF files.

The hot folder or SFTP input device examines PDF files as they arrive and determines how many pages they contain. The hot folder or SFTP input device maintains a count of the total number of PDF pages currently in the input device. When the total number of PDF pages matches or exceeds the value set for the Number of pages to batch property, the hot folder or SFTP input device submits a group of files.

    Note:
  • RICOH ProcessDirector for Windows processes child jobs in the order that the files were last modified. The Windows Date Modified value is shown as the value of the Time submitted job property. Because the Date Modified value does not change when the file is placed in the input device, a file created in 2010 and submitted in 2011 shows a Time submitted from 2010.

The PDF file that makes the total number of pages exceed the value set for the Number of pages to batch property is only included in the group if the Exceed pages to batch property is set to Yes. If the Exceed pages to batch property is set to No, this PDF file remains in the hot folder or SFTP input device as the first set of pages for the next batch.

If a single file contains more pages than the value set for the Number of pages to batch property and the Exceed pages to batch property is set to Yes, the file is submitted for printing, either as a batch with the rest of the PDF files that are waiting to print or as a batch that contains only one file. However, if the Exceed pages to batch property is set to No, the file cannot be submitted. Processing for the hot folder or SFTP input device stops until that input file is deleted, the value of the Number of pages to batch property is increased to at least the number of pages in the file, or the Exceed pages to batch property is changed to Yes so the file can be submitted.

    Note:
  • The Pages batching method does not support encrypted or password-protected PDF files. If an encrypted or password-protected PDF file is submitted to a hot folder or SFTP input device that uses the Pages batching method, RICOH ProcessDirector issues an error message because it cannot open the file to count the number of pages.

When you use the Pages batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Number of pages to batch: the number of pages that the hot folder or SFTP input device waits to receive before submitting the files as a single group.
  • Exceed pages to batch: If this property is set to Yes, a PDF file that contains enough pages to make the total number of pages in the hot folder or SFTP input device exceed the value set for Number of pages to batch property will be submitted with the rest of the files. If this property is set to No, this file will remain in the hot folder or SFTP input device as the first set of pages for the next batch.
  • Data patterns: a pattern that matches PDF file names, such as .*pdf$ or .*PDF$.

1.3.3.1.1.8 Pages in sets

When the batching method is Pages in sets, the hot folder or SFTP input device submits one or more jobs after a set of PDF files with a specified page count is received by the in put device. This method is only valid for PDF files.

For a set to be complete, all of these conditions must be true:

  • A file matching the value in the Data patterns property is present.
  • If a value is entered for the Overrides patterns or JDF patterns properties, a file matching one or both of those values is present.
  • If there are any entries specified for File patterns, a file matching each value is present.

The hot folder or SFTP input device examines the PDF files as they arrive and determines how many pages they contain. The hot folder or SFTP input device maintains a count of the total number of PDF pages in complete sets currently in the input device. When the total number of PDF pages in complete sets matches or exceeds the value set for the Number of pages to batch property, the hot folder or SFTP input device submits the sets as a group with one set in each child job. If the Create .zip file property is set to Yes, a single job containing all of the files in all of the sets is submitted in ZIP file format.

The set containing a PDF file that makes the total number of pages exceed the value set for the Number of pages to batch property is only included in the group if the Exceed pages to batch property is set to Yes. If the Exceed pages to batch property is set to No, this set remains in the hot folder or SFTP input device as the first set for the next batch.

If a single set contains more pages than the value set for the Number of pages to batch property and the Exceed pages to batch property is set to Yes, the set is submitted for printing, either as a batch with the rest of the sets that are waiting to print or as a batch that contains only one data file. However, if the Exceed pages to batch property is set to No, the set cannot be submitted. Processing for the hot folder or SFTP input device stops until that input file is deleted, the value of the Number of pages to batch property is increased to at least the number of pages in the set, or the Exceed pages to batch property is changed to Yes so the set can be submitted.

    Note:
  • The Pages in sets batching method does not support sets with encrypted or password-protected PDF files. If a set with an encrypted or password-protected PDF file is submitted to a hot folder or SFTP input device that uses the Pages in sets batching method, RICOH ProcessDirector issues an error message because it cannot open the file to count the number of pages.

When you use the Pages in sets batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all of the files are combined as a ZIP file and submitted as a single job. If this value is set to No, each set is submitted as a child job.
  • Number of pages to batch: The number of pages that the hot folder or SFTP input device waits to receive before submitting the files as a single group.
  • Exceed pages to batch: If this property is set to Yes, a PDF file that contains enough pages to make the total number of pages in the hot folder or SFTP input device exceed the value set for Number of pages to batch property will be submitted with the rest of the files. If this property is set to No, this file will remain in the hot folder or SFTP input device as the first set of pages for the next batch.
  • Data patterns: A pattern that matches PDF file names, such as .*pdf$ or .*PDF$.
  • File Patterns: A collection of patterns that can define files that are required to be included in a set.
  • JDF patterns: One or more pattern-matching strings used to identify Job Definition Format (JDF) job tickets. If this property has a value specified, a JDF job ticket is required for the set to be complete.
  • Overrides patterns: One or more pattern-matching strings used to identify files that contain values for job properties.

1.3.3.1.1.9 Pattern

When the batching method is Pattern, the hot folder or SFTP input device copies one print file and its related files to the spool file directory for the job as soon as it has all the required files. All these files must match the values set for the Data patterns property and the properties on the Batching tab of the input device properties notebook.

When you use the Pattern batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: No

For example, you might want to send a JDF job ticket file along with an overrides file and a data file for a job. If a job ticket input file ends in .jdf and should have spool file usage "overrides" and spool file type "jdf", you can associate those three patterns with each other. Using RICOH ProcessDirector regular expression syntax, you define a series of input file name patterns that a hot folder or SFTP input device will recognize and include in the new job it creates. This table shows a simple example of files that can be processed together using pattern-matching.

Data pattern File pattern File usage File type Spool file type Example matching file name Example spool file name Notes
.*$ .*jdf$ overrides Other jdf abc000317.jdf /aiw/aiw1/spool/default/10000143/10000143.overrides.jdf JDF job ticket
.*$ .*oth$ overrides Other txt abc00317.oth /aiw/aiw1/spool/default/10000143/10000143.overrides.txt Overrides file
.*$ .*pdf$ print Data pdf abc00317.pdf /aiw/aiw1/spool/default/10000143/1000143.print.pdf PDF file

You can use the Data patterns property and the File Patterns property to create precise file name and file type matches. If you want to use parts of the pattern from the Data patterns field as part of a file pattern, surround those parts of the Data patterns expression in parentheses, forming a backreference that you express in the File Patterns field with a backslash and a number. This table shows the results of pattern matching using a backreference:

Tab Field Value Description
Batching Data patterns (.*)\.pdf The expression (.*) defines a backreference to the data file name without the extension. When a data file name matches this pattern, all the characters that match (.*) are assigned to backreference \1.
Batching File pattern \1\.jdf Matches the data file name, but changes the extension to .jdf. Job1.pdf and Job1.jdf are considered a match and are included in the job, but Job2.jdf does not match.

In a more complex example:

Tab Field Value Description
Batching Data patterns (abc)(def)\.pdf,.*-(12)-.*\.pdf

The data file must match one of these two comma-separated patterns.

Data pattern 1: \1 = abc and \2 = def

The expressions (abc) and (def) define backreferences to the data file name. The extension must be .pdf.

A data file that matches pattern 1 is abcdef.pdf.

Data pattern 2: \1 = 12

The expression (12) defines a backreference requiring that the data file is for the month of December (assuming the date format of a data file is year-month-day. The extension must be .pdf.

A data file that matches pattern 2 is 2011-12-02.pdf.

Batching Overrides patterns \1\.oth

The overrides file must be named abc.oth to match data pattern 1.

Batching File pattern 2011-(\1)\.jdf

The file 2011-12.jdf matches data pattern 2.

File usage overrides
File type jdf
Required Yes
Sequence 1
Batching File pattern \2\1\.jdf

The file defabc.jdf matches data pattern 1.

File usage overrides
File type jdf
Required Yes
Sequence 2
Batching File pattern \1\.txt

The file 12.txt matches data pattern 2.

File usage file
File type txt
Required No
Sequence 3

To edit the Batching tab:

  • To add a file pattern, type values in the fields on the Batching tab, and click Add. Type values in the fields and click Save.
  • To remove a file pattern, select the checkbox for that file pattern and click Remove.
  • To edit a file pattern, select the checkbox for that file pattern and click Edit. The values display in the file pattern entry fields; change them as needed and click Save.
  • If you create two file patterns that are the same, or if a pattern's file type and usage match another pattern's file type and usage, a warning message displays, but you can still add the pattern. The first file pattern encountered is processed, based on the value of the Sequence property.
  • To cancel a change, click Cancel. The system cancels the last unsaved change.

Keep these tips in mind as you set up patterns on the Batching tab:

  • We recommend that you define your patterns carefully, especially for required files, so that only one file matches the specified pattern. It is not possible to specify that more than one file must match a pattern; as soon as one required file matches the pattern, the system considers the requirement met, and will start processing the job when at least one matching required file for each defined pattern is present in the hot folder or SFTP input device.
  • Remember to click OK to save your changes before leaving the page. If you leave the page without saving your changes, the changes are discarded.
  • The rules that you specify in the table are processed in sequence order (from top to bottom); if any conflicting rows exist in your table, the first pattern in the sequence will be used.
  • When you use the Pattern batching method, use these guidelines for the fields in the Advanced tab:
    • Use the Overrides pattern field in the Advanced tab, not in the Batching tab.
    • Do not use the JDF patterns field in the Advanced tab; define those patterns in the Batching tab.

1.3.3.1.1.10 Sets by time

When the batching method is Sets by time, the hot folder or SFTP input device submits one or more jobs containing complete sets of files that arrive within a specified time period. The time period is determined by the values set for the Batching start date, Batching start time, Batching interval, and Batching date or Frequency properties.

For a set to be complete, all of these conditions must be true:

  • A file matching the value in the Data patterns property is present.
  • If a value is entered for the Overrides patterns or JDF patterns properties, a file matching one or both of those values is present.
  • If there are any entries specified for File patterns, a file matching each value is present.

The hot folder or SFTP input device waits until the date and time specified in the Batching start date and Batching start time properties, then submits one or more complete sets of input files at a specific time or time interval determined by the values set for the Batching interval and Batching date or Frequency properties. The hot folder or SFTP input device submits the sets as a group with one set in each child job. If the Create .zip file property is set to Yes, a single job containing all of the files in all of the sets is submitted in ZIP file format. The files print in the order specified by their Last modified timestamp.

    Note:
  • If complete sets of files exist in the hot folder or SFTP input device prior to the initial date and time set in the Batching start date and Batching start time properties, those sets will be included in the first batch submitted by the input device.
  • For the Batching start time property, use the time zone of your browser. The value is displayed based on the time zone of the computer that you use to open the user interface, but it is stored in a generic format. The hot folder or SFTP input device interprets the generic time format based on the time zone of its parent server and creates batches at the specified time.

When you use the Sets by time batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all of the files are combined as a ZIP file and submitted as a single job. If this value is set to No, each set is submitted as a child job.
  • Batching start date: The date when the input device begins to use the Sets by time batching method.
  • Batching start time: The time when the input device begins to use the Sets by time batching method.
  • Batching interval: The time interval used to determine when or how often to submit a group of files.
  • Batching date or Frequency: Used with the Batching interval property, this property specifies exact values for when or how often to submit a group of files.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.
  • File Patterns: A collection of patterns that can define files that are required to be included in a set.
  • JDF patterns: One or more pattern-matching strings used to identify Job Definition Format (JDF) job tickets. If this property has a value specified, a JDF job ticket is required for the set to be complete.
  • Overrides patterns: One or more pattern-matching strings used to identify files that contain values for job properties.

1.3.3.1.1.11 Time

When the batching method is Time, the hot folder or SFTP input device submits one or more files as a group. Only files that match the Data patterns property and that arrive during the time period determined by the values set for the Batching start date, Batching start time, Batching interval, and Batching date or Frequency properties are submitted.

The hot folder or SFTP input device waits until the date and time specified in the Batching start date and Batching start time properties, then submits one or more groups of input files at a specific time or time interval determined by the values set for the Batching interval and Batching date or Frequency properties. The files print in the order specified by their Last modified timestamp.

    Note:
  • RICOH ProcessDirector for Windows processes child jobs in the order that the files were last modified. The Windows Date Modified value is shown as the value of the Time submitted job property. Because the Date Modified value does not change when the file is placed in the input device, a file created in 2010 and submitted in 2011 shows a Time submitted from 2010.

    Note:
  • If files exist in the hot folder or SFTP input device prior to the initial date and time set in the Batching start date and Batching start time properties, those files will be included in the first batch submitted by the input device.
  • For the Batching start time property, use the time zone of your browser. The value is displayed based on the time zone of the computer that you use to open the user interface, but it is stored in a generic format. The hot folder or SFTP input device interprets the generic time format based on the time zone of its parent server and creates batches at the specified time.

When you use the Time batching method, set these input device properties as indicated:

  • Workflow: ParentNoPrint
  • Child workflow: The workflow that is appropriate for the print files in the job.
  • Submit step: SubmitInputFiles
  • Create .zip file: If this property is set to Yes, all input files that match the value set in the Data patterns property are combined as a ZIP file and submitted as a single job. If this value is set to No, all input files are submitted as child jobs.
  • Batching start date: The date when the input device begins to use the Time batching method.
  • Batching start time: The time when the input device begins to use the Time batching method.
  • Batching interval: The time interval used to determine when or how often to submit a group of files.
  • Batching date or Frequency: Used with the Batching interval property, this property specifies exact values for when or how often to submit a group of files.
  • Data patterns: A pattern that matches some part of the file name of your print files. For hot folder or SFTP input devices, the default value is the regular expression: .*$. That pattern matches all file names.

1.3.3.1.2 Files for batch jobs

Hot folder input devices can submit every file they receive as a separate print job, or they can group print files together to create larger jobs, called batch jobs. The simplest batch jobs contain only print files. More complex batch jobs include files that locate the print files and files that set job properties.

1.3.3.1.2.1 Overrides files

When you create a workflow, you can set default values for many job properties. However, those default values might not be appropriate for every job. If you want to send different values with a print job, you can use an overrides file.

An overrides file is a text file that contains property and value pairs for job properties; it can be submitted with a print file. When the job is sent to a workflow, the SetJobPropsFromTextFile step can use the information in the overrides file to replace the default values.

The overrides file must meet these criteria:

  • The overrides file must arrive in the hot folder or SFTP input device after the print file.
  • You must create a separate overrides file for each print file in the job.
  • The file name must match the pattern specified in the Overrides patterns property. The default pattern matches files that have the extension .oth.
  • Each property and value pair must be on a separate line.
  • For hot folder or SFTP input devices, each pair must be expressed as: database property name=value, with no spaces before or after the equal sign (=).
    Note: Overrides files that are used with Download input devices follow a different format and requires the AFP Support feature to be installed.

You can use either of these formats for an overrides file:

  • Use the RICOH ProcessDirector database names for the properties, and list each property and value on a separate line. For example:
    Job.Duplex=Yes
    Job.CustomerName=BankName
    Job.Location=Boulder
  • If the AFP Support feature is installed and the overrides arrive in JCL format from a Download input device, the receive_jcl_jobtype.cfg file is configured to interpret JCL format. The mainframe program creates the overrides file in JCL format.

To submit one or more print files and their accompanying overrides files in the same job, you must use the List batching method and submit a list file with the job. The list file contains the name of each print and overrides file; a print file must be listed before the associated overrides file. The list file might look like this:

input1.pdf
values.oth
input2.pdf
morevalues.oth
input3.pdf
values3.oth
inputfile.pdf
inputfile.oth

Use the RICOH ProcessDirector database names for the properties, and list each property and value on a separate line. For example:

Job.Duplex=Yes
Job.CustomerName=BankName

1.3.3.1.2.2 JDF job tickets

When you submit a job using a JDF job ticket, the hot folder input device reads the job ticket and uses the contents to find the print files and to set properties for the job. The job is created after all the print files have been found.

The figure Hot folder input device processing with JDF job tickets shows how hot folder input devices process jobs that are submitted with JDF job tickets. The input device accepts job files, processes them based on their batching methods, and sends them to the SubmitInputFiles step.

Hot folder input device processing with JDF job tickets
This image shows how hot folder input devices process jobs that are submitted with JDF job tickets. The input device accepts job files including job tickets, which it treats as overrides files, and processes them as described in the text.

1.3.3.1.2.2.1 Setting job properties from the JDF job ticket

RICOH ProcessDirector can use the values that it supports in the JDF job ticket to set job properties.

RICOH ProcessDirector supports functions defined in the JDF Specification that the system requires, including a subset of the JDF Integrated Digital Printing Interoperability Conformance Specification (IDP ICS) and the associated Application Note. The IDP ICS is based on the JDF combined digital printing process, which is intended for integrated digital printers.

RICOH ProcessDirector does not support all possible values in the JDF job ticket. If RICOH ProcessDirector cannot use a value to set a job property, it will remove unsupported values from the job ticket.

    Note:
  • The IdentifyPDFDocuments step can receive multiple sets of PDF files and job tickets. The step combines them into a single PDF file and a single job ticket. When the step creates the combined job ticket, it includes only values that RICOH ProcessDirector supports. It does not include unsupported values in the combined job ticket. The IdentifyPDFDocuments step is provided by the PDF Document Support feature.

For a list of job properties that can be updated from values in a JDF job ticket, see Job properties that can be set from the job ticket.

After the property values are set, RICOH ProcessDirector stores the job ticket with the job files. If the job ticket is requested by a step, RICOH ProcessDirector updates the job ticket with the most current job property values in its database and sends the job ticket to the application called by the step. When the application returns the JDF job ticket, RICOH ProcessDirector updates any supported job property values that have changed, and these can be seen in the job property notebook in RICOH ProcessDirector.

The value of the Media property is a special case, because it depends on the setting for Media Matching:

  • If Media Matching is set to Use media product ID or media name, RICOH ProcessDirector uses one of these media names as the value of the Media property for a job:
    • The name of the media object with the matching product ID specified in the job ticket.
    • The name of the media specified in the job ticket.

    RICOH ProcessDirector first checks whether the job ticket specifies a media product ID. If it does, RICOH ProcessDirector looks for a system media object with the same product ID. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job. If RICOH ProcessDirector does not find a match, it looks for a media object with the media name specified in the JDF job ticket. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the Media property for the job.

  • If Media Matching is set to Use the properties selected below, RICOH ProcessDirector uses the media properties (such as size) listed in the job ticket to search the existing system media objects and find one that matches. When it finds an appropriate media object, the name of that object is set as the value of the Media property for the job.

    You can choose the properties that are used for Media Matching based on the needs of your installation.

    If more than one media object matches, RICOH ProcessDirector tries to determine which one is the best match based on the rest of the media properties in the job ticket, including the name of the media. If the system cannot determine the best match or if no media objects match, the job goes to Error state. You can use the Correct Media action on the job to select the media and move the job out of Error state.

If a job ticket specifies values for media and stapling, you can view and change them in the job properties notebook. On the Scheduling tab, the Media required property lists the media values for both the job and any page exceptions. The Stapling required property shows whether stapling is required. You can set the job values in the Media and Staple properties on the Scheduling tab. You can change the page values on the Page Exception tab using the Page exceptions action.

If a job ticket specifies values for sides exceptions, you can view them using the Page Exceptions action on the job. You cannot change the Sides page exceptions.

Available punching and stapling options vary from printer to printer. You can configure some RICOH ProcessDirector printers to be punch-capable or staple-capable, but you cannot configure their finishing patterns for punching or stapling. Therefore, RICOH ProcessDirector might schedule a job to a printer that does not support the punch or staple patterns that you requested. When this happens, the printer applies its best equivalent punch or staple pattern.

1.3.3.1.2.2.2 Viewing the JDF job ticket

Some values in the JDF job ticket are not shown in the RICOH ProcessDirector user interface, but the workflow might call an application that uses these values. Therefore, you might need to view the JDF job ticket.

To view the JDF job ticket:

  1. Find the JDF job ticket in the spool file directory for the job.
    The spool file directory name is /aiw/aiw1/spool/default/JobNumber (Linux) or C:\aiw\aiw1\spool\default\JobNumber (Windows). The name of the JDF job ticket is JobNumber.filename.jdf.

    If the JDF job ticket has been modified by an overrides file or an application, you might find more than one JDF job ticket with different file names. The date of the last change tells you which JDF job ticket is most recent.

  2. Use a text editor or a Web browser to view the JDF job ticket.
    The JDF job ticket is in XML format.
    Note: RICOH ProcessDirector does not keep the user interface and the JDF job ticket synchronized at all times; it only updates values in the job ticket when it receives a request for the job ticket. When you look at the job ticket, some values listed might not match the values of RICOH ProcessDirector job properties.

1.3.3.1.2.2.3 Locating files

Applications that submit jobs with JDF job tickets can either send the files along with the job ticket, or leave the files in another location on the network. The job ticket is not required to list the files that the job contains. However, if the job ticket does list the files, it can use either relative path names or absolute path names.

Regardless of how RICOH ProcessDirector finds the files, it copies them into the location specified in the Folder location property of the hot folder input device (if they are not there already) and starts to process the job. RICOH ProcessDirector does not automatically delete all the files that are used in jobs that are submitted with JDF job tickets. It only deletes the files in the Folder location. It does not delete files that are in subfolders of the Folder location or that are on other file systems. You must plan to delete the files that are left in the those locations as part of your system maintenance.

Not listing files in JDF

If the job ticket does not list the files, RICOH ProcessDirector expects to receive the job ticket and all the files in the location specified in the Folder location property of the hot folder input device. If any of the files are missing, RICOH ProcessDirector continues to wait for them.

In this case, you must use the List batching method and submit a list file with the job.

Listing files using relative path names

If the job ticket lists the files using relative path names, RICOH ProcessDirector expects to find all the files in subfolders of the Folder location; they cannot be in parallel folders or on any other file systems. For example, if the job ticket includes the file path printfiles/test.pdf, the hot folder expects to find the file in: [folder location]/printfiles/test.pdf.

  • You can use these formats for a relative path name:
    dir/filename
    filename
  • These formats are supported but not recommended:
    file://dir/filename
    file://dir\filename
    dir\filename
    file://./dir/filename
    file://.\dir\filename
    ./dir/filename
    .\dir\filename

Listing files using absolute path names

If the job ticket lists the files using absolute path names, the files can be anywhere on your network that is accessible from the RICOH ProcessDirector primary server. RICOH ProcessDirector uses the absolute path statements in conjunction with a mapping file to find the files. A mapping file is a file that matches the file paths in the job ticket to file paths on mounted file systems. The mapping file is stored on the primary server. Only one mapping file is needed for a primary server; it can list as many file paths as needed.

When RICOH ProcessDirector looks for the files listed in the job ticket with absolute paths, it looks in each location listed in the mapping file until it finds them. If it reaches the end of the mapping file without finding the files, it looks for files received in the Folder location. If it still does not find the files, it waits and checks again at the next poll interval.

  • You can use these formats for an absolute path name:

    On Linux:

    file://hostname/drive:/dir/filename

    On Windows:

    file:///drive:/dir/filename
    Omit drive: for files on systems that do not use drive letters.
  • These formats are supported but not recommended:
    file:///drive:\dir\filename
    file://drive:/dir/filename
    file://drive:\dir\filename
    drive:\dir\filename
    drive:/dir/filename

  • These formats are not supported:
    file://IP_address/drive:/dir/filename
    file://localhost/drive:/dir/filename
    
    Note:
  • You need a file system mapping file if the file paths include identical directory names but have different formats. For example, if the job ticket specifies file:\\\C:\myfiles\testfiles\test1.pdf and the actual file path is /myfiles/testfiles/test1.pdf, you must create a file system mapping file to convert the file path from Windows to Linux format.
  • You need a file system mapping file if the file paths include identical directory names but have different drives. For example, if the job ticket specifies file:\\\D:\myfiles\testfiles\test1.pdf and the actual file path is file:\\\C:\myfiles\testfiles\test1.pdf, you must create a file system mapping file to convert the file path from the D drive to the C drive. The mapping looks like this:
    D:\;C:\

1.3.3.1.2.2.4 Using a mapping file to find input files

If you use a Job Definition Format (JDF) job ticket to submit jobs to a Hot folder device, you do not have to copy all the input files to the Hot folder. When the job ticket is placed in the Hot folder, RICOH ProcessDirector reads it and searches for the input files that it lists.

If the file paths in the job ticket do not match the directory names on a mounted file system, RICOH ProcessDirector uses a file system mapping file to search for the input files.

RICOH ProcessDirector provides a sample file system mapping file, system_map.cfg, in /aiw/aiw1/samples/config/ (Linux) or C:\aiw\aiw1\samples\config\ (Windows). You can copy and edit this file as necessary. Copy the file to the /aiw/aiw1/control_files/config/ (Linux) or C:\aiw\aiw1\control_files\config\ (Windows) directory before customizing it. Comments in the sample file explain the file format.

To specify the file system mapping file:

  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the File system mapping file field, type the file path of the mapping file.
  4. Click SAVE.

You do not have to restart the system.

1.3.3.1.2.3 List files

You can use list files to process multiple files with or without a JDF job ticket or to process overrides files with files.

The limitations of using a list file with a job ticket include:

  • The files must be submitted with the job ticket; they cannot be located on another system and accessed using a mapping file.
  • All the files must be submitted directly to the Folder location, not to a subfolder.

If you use a list file, you must use the List batching method.

You can use list files in these ways:

  • If the job ticket does not include the names of all the input files, the list file can include them along with the name of the job ticket file. When all the files are present, the job is submitted.
  • You can create a generic job ticket, which uses placeholder file names instead of real file names, so you can reuse the ticket with different jobs. The list file contains the names of the specific files that are used for the job. The order of the file names in the list file must correspond to the placeholder file names in the job ticket; the first file listed in the list file must correspond to the first placeholder file listed in the job ticket.

    For example, if your application prints various booklets that all contain four files (a front cover, a fly leaf, the body of the booklet, and a back cover), you can create a job ticket that includes four files in the order that they should print:

    frontcover.pdf
    flyleaf.pdf
    bookletbody.pdf
    backcover.pdf
    Note: In this case, the job ticket must include only file names without any path information.

    For each booklet, you can then create a list file that lists the specific files in the same order:

    • Booklet 1 list file contains:
      booklet1fc.pdf
      booklet1fl.pdf
      booklet1body.pdf
      booklet1bc.pdf
    • Booklet 2 list file contains:
      booklet2fc.pdf
      booklet2fl.pdf
      booklet2body.pdf
      booklet2bc.pdf

  • You can create a list file that contains the name of the input file or files and the overrides files that are associated with them. The name of the overrides file must appear immediately after the input file that it is associated with in the list. The names of the input files and overrides files are case-sensitive and each file name must be on a separate line. Do not include directory information with the file name. For example, the list file might contain this information:
    input1.pdf
    prop1.oth
    input2.pdf
    prop.oth
    input3.pdf
    duplex.oth
    input4.pdf
    inputfiles.oth

1.3.3.1.3 Assigning workflows

When an input file enters the RICOH ProcessDirector system, one of the first actions that the input device does is to assign a workflow to it. After the input device assigns the workflow, the job can begin to move through the processing steps. There are several methods through which the input device can assign the workflow. You configure the method to meet the requirements of the installation.

Use one of these methods to assign the workflow:

  • The easiest way to assign a workflow to a job is to use the Child workflow property on the input device. When you set the Child workflow on an input device, the device assigns that workflow to every job that it processes. All input devices that RICOH ProcessDirector supplies use this method to assign the workflow for the data sets or input files that they receive.
      Note:
    • Jobs that consist of multiple input files are processed as child jobs of the parent job that groups them. The parent job takes the workflow that is set by the Workflow property on the input device, while the child jobs take the workflow that is set by the Child workflow property on the input device.
  • You can set the workflow for a job using a Child workflow initialization step on the input device. If you select this method, all jobs that arrive on the input device pass through the initialization step you specify; the initialization step assigns the workflow. If your jobs have multiple input files, also set the Workflow initialization step property. Parent jobs pass through that initialization step to have their workflow assigned. RICOH ProcessDirector provides these step templates that you can use for a workflow initialization step:
    • The SetJobTypeFromRules step template points to a control file that the input device can use to determine the workflow. The control file lists job parameters that accompany jobs when they are submitted, such as LPR control file parameters, and their corresponding RICOH ProcessDirector properties. For example, you could edit the control file to map the value of the Copies LPR parameter to the value of the Child workflow property. You specify the control file that the input device uses with the Child workflow parsing rules property on the input device.
    • The SetJobTypeFromFileName step template parses the file name of the input file to determine what workflow to assign. To use this step, you specify text that always appears in the name of a certain type of input file and map it to a workflow. Use the Child workflow pattern property to define the string you want to use for the workflow.

      Make sure that you have created and enabled workflows with names that correspond to the strings you specify. These strings are case-sensitive.

  • You can set both the Child workflow and the Child workflow initialization step properties for an input device. If the Child workflow initialization step property is set, the step tries to set the workflow using that method. If the step cannot set the workflow, it assigns the workflow that the Child workflow property specifies. If that property has no value, RICOH ProcessDirector issues an error message. You can also set both the Workflow and the Workflow initialization step properties for an input device to assign the workflow for parent jobs. RICOH ProcessDirector uses the same assignment hierarchy.

1.3.3.1.3.1 Defining a workflow to copy a file to a printer hot folder

You can define a workflow that accepts a print job in a format such as PDF or PostScript or a JDF job ticket and copies it to a hot folder that is associated with a printer.
To define a workflow to copy a file to a printer hot folder:
  1. Click the Workflow tab.
  2. Right-click the PDF workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. Right-click the PrintJobs step and select Delete.
  5. If you plan to send PostScript jobs to this workflow, delete the CountPages and CreatePageRanges steps.
  6. Add a CopyToFolder step to the Print phase
  7. Connect the CopyToFolder step to the RetainCompletedJobs step.
    1. Hover over the edge of the CopyToFolder step. Click and hold a highlighted section () to make the connector appear.
    2. Drag the connector onto the RetainCompletedJobs step.
  8. Connect the CopyToFolder step to the step on its left ( CreatePageRanges for PDF workflows or RunExternalProgram for PostScript).
  9. Right-click the CopyToFolder step and select Properties.
  10. Click External.
  11. Delete the contents of the External Command property and replace it with one of these commands.

    To copy a print file:

    • Linux: cp ${getCurrentFile(${Job.InputDatastream})} destinationHotFolder/${Job.ID}
    • Windows: copy ${getCurrentFile(${Job.InputDatastream})} destinationHotFolder\${Job.ID}

    To copy a JDF job ticket:

    • Linux: cp ${getFileName(overrides,jdf,read)} destinationHotFolder/${Job.ID}
    • Windows: copy ${getFileName(overrides,jdf,read)} destinationHotFolder\${Job.ID}

    In this text, replace destinationHotFolder with the name of the directory that the printer uses as a hot folder.
  12. Click OK.
  13. Save the workflow.
If you also define an AFP printer device to represent the same physical printer, set these properties for the AFP printer device:
  • Set the Share printer connection property to Yes.
  • Set the IPDS printer connection timer property to a lesser value than the Inactivity timer property. If the IPDS printer connection timer property is greater than the Inactivity timer property, RICOH ProcessDirector drops the connection to the printer before it can share the printer with the hot folder.

1.3.3.1.3.2 Defining a workflow to print to a Passthrough Printer

You can define a workflow that accepts a print job in PDF or PostScript format and sends it to a Passthrough printer.
To define a workflow to print to a Passthrough printer:
  1. Click the Workflow tab.
  2. Right-click the PDF workflow and select Copy.
  3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
  4. If the new workflow does not process PDF jobs, right-click the CreatePageRanges step, and select Delete.
    Do not delete this step if the new workflow processes PDF jobs. It is needed to reprint a range of pages in PDF jobs.
  5. Connect the RunExternalProgram step to the PrintJobs step.
  6. Right-click the PrintJobs step, and select Properties.
  7. In the Scheduling tab, change the values of the Binding, Fold options, Requested location, Media, Output bin, Punch, and Staple properties to match the scheduling properties of the Passthrough printer that you want to print on. If you have the AFP Support feature installed, change the values of the Job class, Job form, and Job destination properties as well. Other scheduling properties may be defined in a configuration file.
  8. If the workflow processes PDF files and the value of the Create .zip file property for the hot folder that assigns jobs to this workflow is set to Yes, add a step based on the BuildPDFFromZIP step template to the workflow before the first step that expects PDF input (for example, CreatePageRanges or PrintJobs ).
  9. Click OK.
  10. Save the workflow.

1.3.3.1.4 Setting up hot folder input devices to process batch jobs

To set up a hot folder input device to process batch jobs, you must configure it to use the appropriate batching method and to recognize the input files.
    Note:
  • All batching methods submit input files when some criteria is met, such as several files are received, a time of day is reached, or a list of expected files arrives. Sometimes, you want to submit the input files before that criteria is met and before the current polling interval ends.

    For example, you have one hour until the end of your shift and there are 3857 input files waiting. The input device uses the Number batching method and submits jobs when there are 5000 input files waiting. You can use the Batch all action for the input device to submit those 3857 files immediately, instead of waiting for more files.

    You cannot use the Batch all action with the JDF or Pattern batching method.

To set up a hot folder input device to process batch jobs:

  1. Create and save any files that are needed for processing, such as JDF job tickets, list files, or overrides files, or make sure that your process generates these files as needed.
  2. Log in to RICOH ProcessDirector.
  3. In the Input Devices portlet, find the input device that you want to use to process batch jobs.
  4. Right-click the input device and select Properties.
  5. In the left pane, click Show all tabs to fully expand the notebook.
  6. For any batching method, set these input device properties as follows:
    Workflow
    ParentNoPrint.
    Child workflow
    The workflow that is appropriate for the print files in the job.
      Note:
    • If you use the List batching method, to be sure that the jobs print in order, select a workflow that includes a step based on the WaitForGroup step template before the PrintJobs step.
    • If you use overrides files, select a workflow that includes a step based on the SetJobPropsFromTextFile step template.
    Data patterns
    One or more pattern-matching strings that define which characters in the data file should be matched with the other file names that might arrive in the input device. If you specify more than one data pattern, the file is considered a match if it matches any pattern. The data pattern is a regular expression.
    Submit step
    SubmitInputFiles
  7. Set these input device properties depending on your batching method:
    JDF
    JDF patterns
    A pattern that matches some part of the name of your job tickets. By default for all input devices except HotFolderJDF this value is null. For HotFolderJDF this value is the regular expression .*\jdf$.
    List
    List patterns
    A pattern that matches some part of the file name of your list files. By default, this value is the regular expression .*lst$.
    Overrides patterns (optional)
    A pattern that matches some part of the file name of your overrides files.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property and that are included in a list file are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs.
    Number and Number of sets
    Number of files to batch
    The number of files or complete sets that the input device should wait to receive before submitting them as a single group.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs. This property is not available for the Number of sets batching method.
    Pages and Pages in sets
    Exceed pages to batch
    • Yes: A PDF file or complete set of PDF files that contains enough pages to make the total number of pages in the input device exceed the value set for Number of pages to batch is submitted with the rest of the files.
    • No: This file or set remains in the input device as the first set of pages for the next batch.
    Number of pages to batch
    The number of pages that the input device should wait to receive before submitting the files or complete sets as a single group.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs. This property is not available for the Pages in sets batching method.
    Time and Sets by time
    Batching start date
    The date when the input device should begin to use this batching method.
    Batching start time
    The time when the input device should begin to use this batching method.
    Batching interval
    The time interval that the input device should use to determine when or how often to submit a job.
    Batch date or Frequency
    Used with the Batching interval property, specifies exact values for when or how often to submit a job.
    Create .zip file
    If this property is set to Yes, all input files that match the value set in the Data Patterns property are combined as a .zip file and submitted as a single job. If this property is set to No, all input files are submitted as child jobs. This property is not available for the Sets by time batching method.
    Pattern
    Data pattern
    One or more pattern-matching strings that define which characters in the data file should be matched with the other file names that might arrive in the input device. If you specify more than one data pattern, the file is considered a match if it matches any pattern. The data pattern is a regular expression.
    File pattern (one value for each type of input file)
    A pattern-matching string that defines a particular type of input file, for example, .*jdf$ for a job ticket.
    Spool file usage (one value for each type of input file)
    A value that identifies what the input file is used for, for example, ticket for a job ticket or print for a print file.
    Spool file type (one value for each type of input file)
    The file extension for the input file.
    File pattern required (one value for each type of input file)
    Whether the job must contain this type of input file.

    The job starts to process when all the required files are present. Make sure any optional files are already in the input device before the required files; otherwise they will not be included in the job.

    File pattern sequence (one value for each type of input file)
    If two or more File pattern values are the same, or if two or more File pattern properties are associated with the same Spool file usage and Spool file type values, the order in which the set of values is applied.
  8. Click OK.
    If the input device is enabled and connected, you see a confirmation window asking you if you want to disable and disconnect the input device. To save your changes, the input device must be disabled and disconnected.
  9. To use the input device, select it and click Enable and Connect.
After you configure an input device to use a batching method, make sure that the input files you submit are appropriate for the batching method selected. Unidentified input files remain in the staging location for the input device with a status of Waiting.

1.3.3.1.5 Configuring to use JDF job tickets

Before you can submit jobs with JDF tickets, you must configure the input devices that receive the jobs. You also must configure the workflows that the jobs are assigned to. Printers defined as Ricoh PDF printers can manage PDF jobs with JDF tickets better than printers defined as Passthrough or Custom PDF printers can.

If you have Kodak printers that accept PDF, you can send some JDF information to the printer in the KDK data stream recommended by the manufacturer. The Cut Sheet Support for Kodak feature is required.

If you have Xerox printers that accept PDF, you can send some JDF information in the XPIF or XRX data streams recommended by the manufacturer. The Cut Sheet Support for Xerox feature is required.

Before you begin this procedure, review the supplied workflows to see if any of them contain some or all the steps that you want to include. If you find a good workflow, you can copy it and modify it to meet your needs. The workflow must contain a step based on the SetJobPropsFromTextFile step template.

    Note:
  • This step template can use an optional jobID.overrides.jdf file to set more properties on the job.

In addition, determine whether you can use a hot folder input device that RICOH ProcessDirector provides or whether the installation requires a customized input device. RICOH ProcessDirector provides several hot folder input devices that you can use with only minor modifications or that you can copy to create a customized hot folder input device.

Finally, decide which batching method you want to use. The JDF, List, and Pattern batching methods are all suitable for jobs with JDF job tickets.

To configure to use JDF job tickets:
  1. Copy and modify a workflow that contains the processing steps that you want the jobs that are submitted with JDF job tickets to follow:
    1. Click the Workflow tab.
    2. Right-click the workflow that you want to copy and select Copy.
    3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    4. Right-click each step and select Properties. Modify the properties as necessary.
    5. Save and enable the workflow by changing , the Save & Enable/Disable switch, to the On position.
    6. Repeat these steps if you want to create more workflows.
  2. On the RICOH ProcessDirector system, configure an input device so that it assigns the correct workflow for JDF job tickets. We recommend that you copy and rename the supplied HotFolderJDF input device, then verify or update the settings described in the following steps.
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Right-click the HotFolderJDF input device and select Copy.
    4. In the left pane, click Show all to display all the properties for this input device.
    5. Verify or update the values for these properties:
      Workflow
      ParentNoPrint
      Child workflow
      The workflow that is appropriate for the data files in the job.
        Note:
      • If you use the List batching method, select a workflow that includes a step based on the WaitForGroup step template before the PrintJobs step. These steps ensure that the jobs print in order.
      • If you use overrides files, select a workflow that includes a step based on the SetJobPropsFromTextFile step template.
      Data patterns
      One or more pattern-matching strings. The strings define the characters in the name of the data file to match with the names of other files that arrive in the hot folder. If you specify more than one data pattern, the file is considered a match if it matches any pattern. The data pattern is a regular expression.

      If the value of the Create .zip file property is Yes, only files that match the data pattern are included in the .zip file.

      Submit step
      SubmitInputFiles
    6. Verify or update the values for these properties, depending on the batching method that you want to use:
      Property Value when the batching method is JDF Value when the batching method is List Value when the batching method is Pattern
      JDF patterns A pattern that matches some part of the name of your job tickets. For HotFolderJDF, the default value is the regular expression .*\jdf$.    
      List patterns   A pattern that matches some part of the file name of your list files. By default, this value is the regular expression .*lst$.  
      Overrides patterns A pattern that matches some part of the file name of your overrides files. For some supplied hot folder input devices, this value is the regular expression .*oth$. A pattern that matches some part of the file name of your overrides files. For some supplied hot folder input devices, this value is the regular expression .*oth$.  
      Create .zip file
      • Yes: all input files that match the value set in the Data patterns property are combined as a .zip file and submitted as a single job. If the job ticket specifies different settings for different input files and the Create .zip file property is set to Yes, the settings for the first input file name in the job ticket are used for all input files.
      • No: all input files are submitted as child jobs.
      • Yes: all input files that match the value set in the Data patterns property are combined as a .zip file and submitted as a single job. If the job ticket specifies different settings for different input files and the Create .zip file property is set to Yes, the settings for the first input file name in the job ticket are used for all input files.
      • No: all input files are submitted as child jobs.
      No
      File pattern (1 value for each type of input file)     A pattern-matching string that defines a particular type of input file, for example, .*jdf$ for a job ticket or .*pdf$ for a print file.
      Spool file usage (1 value for each type of input file)     A value that identifies what the input file is used for, for example, ticket for a job ticket or print for a print file.
      Spool file type (1 value for each type of input file)     The file extension for the input file.
      File pattern required (1 value for each type of input file)     Whether the job must contain this type of input file.
      File pattern sequence (1 value for each type of input file)     If two or more File pattern values are the same, or if two or more File pattern properties are associated with the same Spool file usage and Spool file type values, the order in which the set of values is applied.
  3. Make sure that the new input device is connected and enabled.
  4. Submit jobs to the new input device. If errors occur, correct the errors that messages from RICOH ProcessDirector or any application that it calls identify.

1.3.3.2 LPD input devices

If your application submits jobs using the lpr client or another command that uses the LPD protocol, the jobs must be sent to an LPD input device. You use the name of the input device as the name of the target printer in the command.
Note: Because some lpr commands truncate printer names, we recommend limiting the names of your LPD input devices to 8 characters.

In general, the LPD protocol provides more limited function than other job submission methods. However, some lpr clients have more options than others; be sure that you know the capabilities of the lpr client that your application uses before you start to configure your input devices.

LPD input device processing shows how the LP daemon and an LPD input device process print jobs. Input files are submitted using the LPD protocol. The LP daemon receives the files and creates an overrides file, a list file, and a trigger file. The daemon sends all the files to the LPD input device, which passes the files to the submit step.

LPD input device processing
This image shows how the LP daemon and an LPD input device process print jobs. Input files are submitted using the LPD protocol. The LP daemon receives the files and creates an overrides file, a list file, and a trigger file. It sends all the files to the LPD input device, which passes the files to the submit step and then on to the first step of the workflow.
Note: On Linux primary and secondary servers, RICOH ProcessDirector installs and uses its own LPD.

As a result, you must shut down any other LPDs that are installed; the RICOH ProcessDirector LPD must be the only one running. The RICOH ProcessDirector LPD uses port 515 to receive jobs; no other processes can use that port.

Permissions

You can restrict the systems that have permission to submit jobs to LPD input devices by host name or IP address. If your RICOH ProcessDirector system includes Linux primary or secondary servers, you set that list by logging in to RICOH ProcessDirector as an authorized user and updating the Hosts allowed to submit LPD jobs system property.

LPD options

Generally, lpr clients have a limited number of parameters that you can specify. However, if the client you use accepts the -o option, you can submit values that can be mapped to RICOH ProcessDirector properties.

LPD input devices on Linux read the statements that are submitted on the -o option and copy them directly into an overrides file. Later in the workflow, a step interprets the overrides file based on the mappings in a control file. RICOH ProcessDirector provides a sample control file, receive_lpd_overrides.cfg, in /aiw/aiw1/samples/rules/ (Linux) or C:\aiw\aiw1\samples\rules\ (Windows). You can copy the file and update it to assign values differently if necessary. To modify the file, copy the file to /aiw/aiw1/control_files/rules/ (Linux) or C:\aiw\aiw1\control_files\rules\ (Windows) and make your changes in that directory.

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples/ (Linux) or C:\aiw\aiw1\samples\ (Windows) directory, but they do not overwrite files in the /aiw/aiw1/control_files (Linux) or C:\aiw\aiw1\control_files (Windows) directory. We recommend copying sample files into the /aiw/aiw1/control_files (Linux) or C:\aiw\aiw1\control_files (Windows) directory and making all your changes in the copied file.

For example, if you need to submit a job to an LPD input device on a Linux server, you can use this command:

lpr -S morris -P LPDPDF -O outbin=3 /aiw/aiw1/testfiles/Demo.pdf
The LPD input device creates an overrides file that looks like this, with some of the required values filled in from the command and others filled in with default values:
orighost=prtroom2.ricoh.com 
origuser=root 
bannername=/aiw/aiw1/testfiles/Demo.pdf 
bannerclass=9.17.160.63 
printbanner=Yes 
origname=/aiw/aiw1/testfiles/Demo.pdf 
outbin=3
If the job is submitted to an input device that uses the default control file (receive_lpd_pdf_jobtype.cfg), the values are mapped to these properties:
  • Job.Info.NodeID=prtroom2.ricoh.com
  • Job.Host.UserID=root
  • Job.Name=/aiw/aiw1/testfiles/Demo.pdf
  • Job.OutputBin=3
The values for bannerclass and printbanner are left unmapped because they do not appear in the default control file.

Processing flow

LPD input devices always have these settings; you cannot change them:

  • Batching method: List
  • Completion method: Trigger
  • Data patterns: .*\.prt$

    The lp daemon adds the suffix .prt to all the print files it receives, so this pattern always matches. The names of your print files do not have to include those characters.

  • List patterns: .*list\.lst$
  • Overrides patterns: .*other\.oth$
  • Trigger patterns: .*\.trg$

When a job is submitted to an LPD input device, the LPD receives the print file and any options (flags) that were set on the command. The LPD creates an overrides file for the job and writes the options into it, in a format that can be interpreted by a later step. If the lpr command supports the -o option for including additional job properties, those properties are also written into the overrides file. The file is saved with the extension .oth.

The LPD also creates a list file for the job. The list file includes the names of the print file (or print files, if multiple files are submitted) and the overrides file, and has the extension .lst. The names of print files are added to the list file in the order they are received. Although some lpr clients send files in the order they are listed in the command, not all of them do. Files might arrive in random order.

When the LPD finishes creating the overrides and list files, it creates a trigger file. A trigger file does not contain any data; its presence indicates to the input device that the input file is ready to be processed. When the Completion method of an input device is set to Trigger, the input device waits until it detects a file that matches one of the Trigger patterns set on the device.

After the input device finds the trigger file, it submits the job to the first step of the workflow for processing. That step should be based on the SetJobPropsFromTextFile step template. The step uses the control file that the input device specifies specified in the Child workflow parsing rules property to interpret the overrides file and assign values to job properties. The default control file is receive_lpd_jobtype.cfg or receive_lpd_pdf_jobtype.cfg.

1.3.3.2.1 Configuring to use the LPD protocol

Before a user can use the line printer daemon (LPD) protocol to submit jobs to the RICOH ProcessDirector system, an administrator must do configuration tasks on the RICOH ProcessDirector system to configure the input devices that receive the jobs, to configure the workflows that the jobs are assigned to, and to define the hosts that can use the LPD protocol to submit jobs to RICOH ProcessDirector. The administrator might also have to do some configuration tasks on these hosts.
Before you begin this procedure, review the supplied workflows. If you find one that contains some or all the steps that you want to include in your workflow, you can copy it and modify it to meet your needs.

In addition, determine whether you can use one of the LPD input devices that RICOH ProcessDirector provides or whether the installation requires a customized input device. RICOH ProcessDirector provides LPD input devices that you can use with only minor modifications or that you can copy to create a customized LPD input device.

To configure to use the LPD protocol:
  1. If any LPD daemons or processes that do not belong to RICOH ProcessDirector (for example, the Common UNIX Printing System [CUPS] LPD daemon) are running on the same system as the parent server for the input device, stop them.
    • On SUSE Linux, start YaST, then click System Network Services to find the LPD services.
    • On Red Hat 6.7 through latest 6.X, choose System Administration Services to find the LPD services.
    • On Red Hat 7.1 through latest 7.X, choose Applications Utilities Terminal and use this command: systemctl list-units --type service --all.

      To stop an LPD service, use this command: systemctl stop <LPD_service>.

    • On Windows, to stop the LPD service or the TCP/IP print server, go to the Control Panel and double-click Services. Select the service and click Stop. To stop other LPD processes, see the documentation for your LPD product.
      Important:
    • Do not uninstall CUPS.
  2. If the parent server of the input device is defined on a Linux computer or a Windows primary computer, update the system setting to specify the hosts that can submit jobs using the LPD protocol.
    1. Click the Administration tab.
    2. In the left pane, click Settings System.
    3. In the Hosts allowed to submit LPD jobs field, type the allowed host names or IP addresses.
      Separate host names and IP addresses with semicolons.
        Note:
      • You can use wild cards in host names and IP addresses (for example, *.acmeproducts.com or 192.*). A value of * means that all hosts are allowed to submit jobs. Values that contain only numbers, decimal points, and wild cards are compared to IP addresses. Values that contain wild cards and at least one alphabetic character are compared to host names. An empty value means that no hosts are allowed to submit jobs.
      • The default value is *.
      • If the base product is installed on Linux, you cannot submit jobs to LPD input devices from the primary computer.
      • If you experience long wait times or missing jobs, set the LPD host entries to IP addresses or fully qualified host names (such as hostserver.co.acmeproducts.com instead of *.acmeproducts.com).
    4. Click SAVE.
  3. On each system that you authorized to submit LPD jobs, determine if the print command lets you specify a server name. If it does not, do one of the following steps to create a print queue on the system to send jobs to the LPD input device.
      Note:
    • The LPR client that is supplied with the base operating system in some versions of Windows and that is available as an optional feature of other versions lets you specify a server name. If you use this LPR client or an equivalent, you do not have to create a print queue on Windows.
  4. To create a print queue on SLES 12.0:
    1. Log in as the root user.
    2. Start YaST.
    3. Click Hardware Printer. With Printer Configurations highlighted, click Add. Click Connection Wizard, and then select Line Printer Daemon (LPD) Protocol.
    4. In the IP Address or Host Name field, type the host name or IP address of the system where the LPD input device is defined.
    5. Type the name of the LPD input device in the Queue Name field, and click OK.
    6. In the Set Arbitrary Name field, type the name of the LPD input device. This name must be unique on this Linux system. Although LPD input device names are case-sensitive, Linux does not allow you to define multiple LPD input device names that are alike except for case. For example, you cannot define one LPD input device called HotFolderLPD and another called hotfolderlpd.
    7. Click OK.
  5. To create a print queue on Red Hat 6.7 through latest 6.X:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications System Tools Terminal.
    3. In the terminal window, type system-config-printer.
    4. Select Printer on the New drop-down menu.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the system where the LPD input device is defined.
    7. Type the name of the LPD input device in the Queue field, and then click Forward.
    8. In the New Printer window, click Forward.
    9. Click Forward again.
    10. Type a name for the LPD input device in the Printer Name field.
    11. Click Apply.
  6. To create a print queue on Red Hat 7.1 through latest 7.X:
    1. Log in to the operating system as the root user.
    2. From the Gnome Desktop, click Applications Utilities Terminal.
    3. In the terminal window, type system-config-printer.
    4. Select Printer on the Add drop-down menu.
    5. Click Network Printer and select LPD/LPR Host or Printer.
    6. In the Host field, type the host name or IP address of the system where the LPD input device is defined.
    7. Type the name of the LPD input device in the Queue field, and then click Forward.
    8. In the New Printer window, click Forward.
    9. Click Forward again.
    10. Type a name for the LPD input device in the Printer Name field.
    11. Click Apply.
  7. On the RICOH ProcessDirector system, copy and modify a workflow that contains the processing steps that you want the jobs that are submitted using the LPD protocol to follow.

    To copy and modify one or more workflows:

    1. Click the Workflow tab.
    2. Right-click the workflow that you want to copy, and click Copy.
    3. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    4. Right-click each step and select Properties. Modify the properties as necessary.
      Remove ${Job.InputFile} from the Job name property in the SetJobPropsFromTextFile step.
    5. If you have the AFP Support feature installed and the AFP resources (such as fonts, overlays, and page segments) required by the jobs that are processed through this workflow are not going to be sent inline with the input file, make sure that those resources are available to the RICOH ProcessDirector system. We recommend that you move these resources to /aiw/aiw1/resources (Linux) or C:\aiw\aiw1\resources (Windows) or /usr/lpp/psf/reslib (Linux) or C:\Program Files (x86)\Ricoh\PSF\reslib (Windows), so that they are available to all the components of RICOH ProcessDirector. If you cannot use those directories, you can set the AFP resource path property on one of the steps in the workflow to refer to the directory or directories that hold the resources.
        Note:
      • The AFP resource path can be set as a default job property on various step templates, including EnableRepositioning, PrintJobs, and ConvertLineDataJobIntoAFP. You only need to set the value on one of the steps; the others inherit the value.
    6. To use the workflow, save and enable it by changing , the Save & Enable/Disable switch, to the On position.
    7. Repeat these steps if you want to create additional workflows.
  8. On the RICOH ProcessDirector system, configure an input device so that it assigns the correct workflow or workflows for the input files that it receives. We recommend that you copy and rename one of the supplied LPD input devices, then verify or update the settings described below.
    1. Click the Administration tab.
    2. In the left pane, click Devices Input Devices.
    3. Right-click the input device that you want to copy and select Copy.
        Note:
      • The new input device is the same type as the copied input device. For example, you cannot create a new LPD input device by copying a hot folder.
    4. In the left pane, click Show all tabs to display all the properties for this input device.
    5. Verify or update the values for these properties:
      Input device name
      Make sure that the input device name does not include any spaces. The LPR client cannot process names with spaces.

      It is best to limit the input device name to 8 characters. Depending on the print command that you use, you might have to create a print queue on the sending system with the same name as the input device. Some systems truncate print queue names to 8 characters.

      Folder location
      The directory on the primary computer that receives jobs from authorized hosts. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that the LPR client sends without filling the file system.
      Staging location
      The directory that RICOH ProcessDirector moves input files to before they are submitted as jobs. Make sure that the file system is set up so that the directory you list here is large enough to handle the amount of data that the LPR client sends without filling the file system. Remember that there might be two copies of an input file in the system at any time, one in the Folder location directory and one in the Staging location directory.
      Parent server
      The RICOH ProcessDirector server where the files will be received; for example, a submitter would specify this server name on the lpr or lprafp command. The server specified here must be configured to accept jobs over the LPD protocol.
    6. To assign workflows to jobs, with either single or multiple input files:
        Note:
      • Input devices with a Linux parent server cannot create a parent job with multiple children. Instead, one parent job and one child job are created for each input file.
      1. Set the Submit step property to SubmitInputFiles and the Workflow property to ParentNoPrint.
      2. Determine how you want the input device to assign the workflow for each single job or child job. You can select one of these:
        • Set the Child workflow initialization step property to SetJobTypeFromRules and use the Child workflow parsing rules property to specify the name of the control file that can set the workflow from a value of an option of the print command.

          RICOH ProcessDirector provides two sample control files that are used to set the workflow. The sample control files, called receive_lpd_jobtype.cfg and receive_lpd_pdf_jobtype.cfg, are installed in the /aiw/aiw1/samples/rules/ (Linux) or C:\aiw\aiw1\samples\rules\ (Windows) directory. You can copy one of the files to the /aiw/aiw1/control_files/rules/ (Linux) or C:\aiw\aiw1\control_files\rules\ (Windows) directory and modify it to meet your needs, then update the value of the Child workflow parsing rules property to point to your file.

        • Set the Child workflow initialization step property to SetJobTypeFromFileName and use the Child workflow pattern property to specify the string that RICOH ProcessDirector should look for in the input file name and use as the workflow name. If you use this method, you must make sure that a workflow with the corresponding name exists.
  9. If the control file that you created in the previous step sets job scheduling properties such as Media or Job size based on the values of options of the print command, make sure that the corresponding scheduling properties are set on the target printers in RICOH ProcessDirector. If the scheduling properties do not match, the jobs are not automatically scheduled to those printers.
  10. Make sure that the LPD input devices are connected and enabled.
      Note:
    • The LPD input device does not return status information in response to the lpq command.
  11. From a host system that you authorized, submit some test jobs. If errors occur, correct the errors that messages from the host system or RICOH ProcessDirector identify.

1.3.3.2.2 Print commands used with the LPD protocol

The LPD protocol defines a print command called lpr. You can use the lpr command, or several other commands that use the LPD protocol, to submit jobs to LPD input devices.

Syntax and available options vary from one print command to another and from one version of lpr to another. You might have to adapt examples of print commands for your own system.

You might also have to configure the sending system to compensate for options that your print command does not provide. For example, if the print command does not have an option for specifying a print server, you must create a remote print queue on the sending system with the same name as the LPD input device.

Here are a few common LPD print commands. For more information about these commands, see the operating system or product documentation.

Linux print commands
Command name Where to get it Printer option Server option Job properties option
lpr Native -P None Varies
Note: Some LPR clients let you send job options with the -o command. See the documentation for your LPR client to determine if you can do this.
lprafp Download from the Ricoh Production Print Web site (downloads for InfoPrint Manager for Windows) -p -s -o
Note: If you submit jobs using lprafp and include options on the -o flag, you must use only single-byte characters in the options. If you use double-byte characters in the options, RICOH ProcessDirector cannot read them and the lprafp request is rejected.
AIX print commands
Command name Where to get it Printer option Server option Job properties option
lpr Native -P None None
enq Native -P None -o
lp Native -d None -o
lprafp InfoPrint Manager for AIX; download latest version from the Ricoh Production Print Web site (downloads for InfoPrint Manager for Windows) -p -s -o
Note: If you submit jobs using lprafp and include options on the -o flag, you must use only single-byte characters in the options. If you use double-byte characters in the options, RICOH ProcessDirector cannot read them and the lprafp request is rejected.
qprt Native -P None None
qprt InfoPrint Manager for AIX -P None -o
Windows print commands
Command name Where to get it Printer option Server option Job properties option
lpr Native -P -S None
Note: The Windows lpr command has an -o option, but it indicates the file type, not job properties.
lprafp Download from the Ricoh Production Print Web site (downloads for InfoPrint Manager for Windows) -p -s -o
Note: If you submit jobs using lprafp and include options on the -o flag, you must use only single-byte characters in the options. If you use double-byte characters in the options, RICOH ProcessDirector cannot read them and the lprafp request is rejected.
Examples

This command submits a file called report.pdf from a Windows system to an LPD input device called LPDPDF that is defined on a server called morris and requests two copies:

lpr -S morris -P LPDPDF -# 2 report.pdf

Either of these commands submits a file called report.afp from an AIX system to an LPD input device called LPDAFP that is defined on a server called morris. To use the AIX lpr command, you must first define a remote print queue for LPDAFP on the AIX system that you are sending the job from.

lpr -P LPDAFP -C A report.afp
lprafp -smorris -pLPDAFP -oclass=A report.afp

1.3.3.2.3 Restricting use of the LPD protocol to submit jobs

You can limit the hosts that can use the LPD protocol to submit jobs to all the input devices with the same parent server. The default is to allow input from all systems.
To restrict the use of the LPD protocol:
  1. Click the Administration tab.
  2. In the left pane, click Settings System.
  3. In the Hosts allowed to submit LPD jobs field, type a list of authorized host names or IP addresses separated with semicolons.

    You can use an asterisk (*) to represent zero or more characters. Values that contain only digits (0–9), decimal points (.), and asterisks (*) are compared to the IP address of the incoming connection. Values that contain one or more alphabetic characters (A–Z, a-z) are compared to the host name of the incoming connection.

    A list value of * means that all hosts are allowed to submit jobs. An empty list value means that no hosts are allowed to submit jobs.

  4. Click SAVE.

1.3.4 Adding functions to workflows

RICOH ProcessDirector workflows can be configured to send print jobs to other applications for additional processing and then receive them back into the system. The other applications can run on the server that holds the primary server, on a secondary server, or on an application server.

If your application provides processing that can be incorporated into print workflows (such as address cleansing or impositioning), you can create steps that send the print job from RICOH ProcessDirector to your application, wait for the application to finish, and then continue processing in RICOH ProcessDirector. The RICOH ProcessDirector documentation calls these steps external steps.

In a conditional workflow, external steps can receive input from multiple steps and run different programs based on the input. In the PDFProduction sample workflow, the external step receives different properties based on a job’s page count. External steps can write results to multiple places and send output to multiple steps. For example, an external step can send jobs to three different steps based on a value computed by an external program. An external step can terminate a branch of a conditional workflow.

These step templates for external steps are included with RICOH ProcessDirector:

  • RunExternalProgram

    Submits the print job to an external program using a command line interface.

  • RunHotFolderApplication

    Puts the print job in a hot folder that another application monitors. That application picks up the print job, processes it according to its configuration settings, and puts it into an output folder. RICOH ProcessDirector monitors that output folder and retrieves the job when it is ready.

Choosing which step template to use depends primarily on how the external application can accept jobs. If the application has a command line interface, the workflow can include RunExternalProgram; if the application monitors hot folders for input, the workflow can include RunHotFolderApplication. If the application has both interfaces, you can decide which step to use.

RICOH ProcessDirector provides optional features that integrate with external programs. These features include additional step templates that you can use:

  • Quadient Inspire Connect

    • ComposePDF

      Uses Quadient Inspire Designer to generate a new PDF file from a WFD file and one or more raw data files. The step waits for the new file to be returned.

    • ComposeAFP

      Uses Quadient Inspire Designer to generate a new AFP file from a WFD file and one or more raw data files. The step waits for the new file to be returned. ComposeAFP is only available when the Quadient Inspire Connect and AFP Support features are installed.

  • MarcomCentral Connect

    • ApplyXSLTransform

      Converts information in MarcomCentral format to RICOH ProcessDirector job properties.

    • CallSOAPService

      Calls the MarcomCentral Job Tickets web service and retrieves the job tickets for each order.

    • CreateJobsFromXML

      Uses the information returned by the MarcomCentral web service to create a job for each job ticket. The step submits the jobs to the MarcomProcessJobTicket workflow.

  • Pitstop Connect
    • RunPitStopOnJob

      Submits a PDF print job to PitStop Server along with an action list or PDF profile. Ricoh ProcessDirector waits for PitStop Server to process and return the job so it can move to the next step in the workflow.

  • Postal Enablement

    • SetPostalJobProps

      Lets you set job properties needed by postal software to determine how to process the mail piece information contained within the external document properties file.

    • BuildExternalDocPropsFile

      Lets you extract document data from the document properties file and create a file with the document data and headings that you need to send to an external program. The file you create is called an external document properties file.

    • MapExternalResultsFiletoDocProps

      Maps document properties that you select from an external results file to the document properties included in a modified results file. The external results file is produced by an external program.

    • UpdateDocPropsFromExternalResultsFile

      Merges the properties in the modified results file into the document properties file for the job.

  • Ultimate Impostrip® Connect
    • RunImpostripOnJob

      Submits a PDF print job to the Ultimate Impostrip® input hot folder that is set up to perform the appropriate impositioning functions on the job. RICOH ProcessDirector waits for the Ultimate Impostrip® server to return the updated job, then continues processing with the next step in the workflow.

Consider these points when deciding which step to use:

  • RunExternalProgram
    • Requires you to write a command and specify all of the necessary options. If you are not familiar with writing commands or do not have the syntax of the command to run the application, this step might be more difficult to configure.
      Note: All output that external programs write to stdout and stderror appears in the RICOH ProcessDirector job log. If your command runs a program or system command that writes all its output to stdout, we recommend that you use a script to call the external program so you can redirect the output to a different location.
    • Lets you specify the code page and language to be sent to the other application.
    • Lets you specify the return codes that the program can provide without sending the print job into an error state.
    • Lets you use a control file that contains processing parameters that the external application can use, if the program can accept one.
  • RunHotFolderApplication
    • Lets you send one or more files to the other application.
    • Requires you to configure the sending and retrieval folders correctly. The sending folder and retrieval folder can be the same one, if the file name of the file to send does not match the retrieval pattern. The Retrieval pattern is a pattern-matching string used to identify a returned job.

      For example, if the external application converts files from PostScript to PDF, the retrieval pattern could look for a file with the extension .PDF. The step can copy printfile.ps into the directory and not mistake it for the converted file, because it is looking for printfile.PDF.

      However, if you use the hot folder to send a PDF file to a preflight application, that application sends back another PDF file, most likely with the same name. In that case, the sending and retrieving folders must be different locations.

    • Does not provide the option to specify valid return codes.

      If the external application returns the expected file, the step picks up the file and moves the process to the next step without checking for errors. As a result, the other application should be configured so it does not copy a file with errors to the output directory. If the hot folder is set to time out, the job eventually goes into an error state and the issue can be resolved; if the hot folder is configured to wait indefinitely, the job continues to wait until an operator intervenes.

In some environments, the steps can be configured to work together. For example, if you want to use FTP or SCP to transfer the input file to the other program, you can create a step based on RunExternalProgram to transfer the files. Then, you can add a step based on RunHotFolderApplication, leaving the Sending folder property blank. The step does not send any files to an outgoing hot folder, but it polls the retrieving folder for the resulting file.

Processing flow: RunExternalProgram

Steps based on the RunExternalProgram step template can access files in the spool directory for a job. When an input device creates a job from an input file, it also creates a unique spool directory for the job. The spool directory contains a copy of the input file and other files that provide information about the job. External steps can call programs that update existing files in the spool directory and write new files to the directory.

When you create a step based on the RunExternalProgram step template, you can include values for these properties:

  • External command
  • External control file template
  • External program code page
  • External program language
  • Valid return codes

The next figure shows how the RunExternalProgramStep step processes a job. The step resolves methods and symbols in the command, creates a control file if needed, runs the command, receives a return code when the other program finishes processing, and updates job properties if the program sends an overrides file back. Then the job moves to the next step.

RunExternalStep step template processing
This figure shows how the RunExternalProgramStep step processes a job. The step resolves methods and symbols in the command, creates a control file if needed, runs the command, receives a return code when the other program finishes processing, and updates job properties, if the programs sends an overrides file back. Then the job moves to the next step.

When a job enters the RunExternalProgram step, the step tries to run the command provided in the External command property. If any part of the command is written in RICOH ProcessDirector symbol notation, the step resolves all references before it issues the command:

  • The command must contain two file names: the input file name (the file that the other program picks up) and the output file name (the file that the other program returns to RICOH ProcessDirector). The step must generate these names using the RICOH ProcessDirector method getFileName(). Instead of using actual file names in the command, the method is used as a symbol for the file names.

    For example, the input file name might be represented by the symbol: ${getFileName(print,pdf,read)} and the output file name might be represented by the symbol: ${getFileName(print,pdf,write)}. Using this method ensures that the application can find and return the files correctly.

  • The command can include symbols for RICOH ProcessDirector properties; if it does, those property values are entered into the command.

    For example, if the other application needs to know the job name, you can include the symbol: ${Job.Name}. The step finds the value of the Job name property and includes it in the command.

  • The application might accept property values in a parameter or control file.

    If it does, the command should include the getControlFileName() method to create a name for the control file. The step uses the control file template listed in the External control file template property to build the contents of the control file, then inserts the file name in the command.

  • The application might accept values in a JDF job ticket.

    If it does, the command should include the getFileName() method to generate the name of the JDF job ticket. An example of this syntax is ${getFileName(overrides,jdf,read)}.

After all of the symbols have been resolved, the command runs.

The external application does its processing, copies its output files to the correct locations, and returns a return code. The output files can include:

  • The modified print file, named based on the value of the getFileName() symbol that was included in the command
  • A file used to pass property values back into RICOH ProcessDirector

    RICOH ProcessDirector that can accept property values from external programs in these ways:

    • In a file named jobid.overrides.txt or .text, which contains a list of RICOH ProcessDirector attribute/value pairs
    • In an empty file with a file name that includes the attribute/value pairs, which is created in the spool file location if the file contains property value pairs on the output parameter of the command

The step compares the return code to the values listed in the Valid return codes property for the step. If it matches one of the codes, processing continues; if it does not match, the job goes into an error state.

The step looks for the file that carries the property values. If it finds a file, it reads the file (or file name) and updates the property values. Then the step completes its processing. It might pass the job to another step or terminate a branch of the workflow.

Processing flow: RunHotFolderApplication

When you create this step, you can include values for these properties:

  • File size verification count
  • File to send
  • Poll interval
  • Retrieval folder
  • Retrieval pattern
  • Retrieved file
  • Sending folder
  • Timeout interval

The next figure shows how the RunHotFolderApplication step processes a job. The step resolves the method and symbol for the name of the file to send, copies the file into the sending location, then waits as the external program processes the file. The step monitors the retrieving location for the file and retrieves the file when it has been fully copied into the location. Then the job moves to the next step.

The step can process jobs that have a single file or multiple files.

RunHotFolderApplication step template processing
This figure shows how the RunHotFolderApplication step processes a job. It resolves the method and symbol for the name of the file to send, copies the file into the sending location, then waits as the external program processes the file. The step monitors the retrieving location for the file, and retrieves the file when it has been fully copied into the location. Then the job moves to the next step.

When a job enters the step, the step resolves the value of the File to send property and locates that file in the spool directory. The step copies the print file into the location specified in the Sending folder property. The step expects the other application to pick the file up from that location.

After the file is copied, the step starts to monitor the directory listed in the Retrieval folder property. The step looks in the folder for a file whose name matches the pattern specified in the Retrieval pattern directory. If no file that meets the criteria is present, the step waits for the amount of time specified in the Polling interval property and checks again.

The step continues to check for the file for a given period of time. This length of time is determined by the value of the Timeout interval property. The timeout interval is calculated from the time the print file is copied into the Sending folder. If the modified file does not appear in the Retrieval folder before the timeout interval elapses, the job goes into an error state.

When the step finds the expected file in the directory for the first time, it notes the size of the file, but does nothing else. The step must make sure that the entire file has been transferred from the other application before it continues processing. After the polling interval has elapsed, the step checks again, finds the file, and compares the file size to the previous size.

  • If the file is larger than the previous size, the step continues to wait and checks the size again after the polling interval has elapsed.
  • If the file is the same size as it was on the previous check, the step notes that the file size has not changed; the size has been the same two times.

    The step looks at the value of the File size verification count. This value is the number of times that the file size must remain the same before the step can consider the file fully copied. If the file size verification count is equal to the number of times the file size has been the same, the step considers the file complete.

When the file is complete, the step renames the file based on the value of the Retrieved file property and copies it back into the spool directory for the job. Then the step completes its processing. It might pass the job to another step or terminate a branch of the workflow.

Note: RICOH ProcessDirector offers separately priced features that provide interfaces with specific external programs. These include Avanti Slingshot Connect, Quadient Inspire Connect, PitStop Connect, and Ultimate Impostrip® Connect. Postal Enablement works with more than one external program.
  • Avanti Slingshot Connect provides an interface with the Avanti Slingshot Management Information System.
  • PitStop Connect provides an interface with Enfocus PitStop Server 10 or higher.
  • Postal Enablement provides an interface with postal cleansing software such as Bell and Howell BCC Mail Manager and TEC Mailing Solutions MailPreparer.
  • Quadient Inspire Connect provides an interface with Quadient Inspire Designer, version 8 and higher.
  • Ultimate Impostrip® Connect provides an interface with Ultimate Impostrip® Automation or Scalable on Windows.

RICOH ProcessDirector does not supply the external program software with these features.

1.3.4.1 Setting up external programs

Before you start the configuration tasks for an external step, you need to set up the external program that the external step calls.
Install the external program and, if applicable, the application/secondary server software before you start this procedure.

Important points to remember when you install the base product or application/secondary servers and the other application:

  • When you install the RICOH ProcessDirector software on a Linux system, the installation program creates the RICOH ProcessDirector system user (aiw1 is the default). When you verify the operation of an external program that runs on a Linux system, use the RICOH ProcessDirector system user to do your verification testing.
  • RICOH ProcessDirector does not automatically create a system user account for RICOH ProcessDirector on a Windows application server. The installation program prompts for the name of the user account to use as the RICOH ProcessDirector user. Verify the operation of the external program from the user account for the RICOH ProcessDirector user on the Windows application server.
  • When the RICOH ProcessDirector primary computer is a Linux system, make sure that the RICOH ProcessDirector system user and the user that the other application uses have the appropriate permissions for the directories and file systems that they use.
  • If the RICOH ProcessDirector primary computer is a Windows system and the other application is on a mapped network drive, edit the mountDrives.bat file to map the network drive whenever RICOH ProcessDirector starts. The file is located in the c:\aiw\aiw1\bin\ directory.
  • Make sure that the RICOH ProcessDirector system user on a Linux primary computer or RICOH ProcessDirector on a Windows primary computer can find and execute the other application. Use one of these methods:
    • Include the full path to the application in the command that you create.
    • Add the application to the PATH environment variable for the Windows primary computer or the RICOH ProcessDirector system user on a Linux primary computer.

      This option works best if the other application runs on the same system as the primary server. If the application runs on an application/secondary server, this option only works if you mount the directory that the other application is installed in.

    • On a Linux primary computer, create a symbolic link to the other application, storing the link in /aiw/aiw1/bin.

      Storing a symbolic link in that directory provides some important benefits. RICOH ProcessDirector adds that directory to the PATH environment variable when it creates the RICOH ProcessDirector system user, so the application can be recognized without separately editing the PATH. The directory is not deleted when you apply service, although some of the files in it might be updated. The link file should not be affected.

      In addition, application and secondary servers can access this directory. As a result, they can also use the symbolic link to locate the external application if it is located within the /aiw file system. The external application cannot run on both a Linux primary computer and a Windows application server.

To set up the external program:

  1. Use the documentation for the external program and verify that it runs without errors as a standalone program.
  2. If you plan to use RunExternalProgram:
    1. If the application runs on a Linux computer, log in as the RICOH ProcessDirector system user. If it runs on a Windows computer, log in as an administrator.
    2. Compose the command that you can use to invoke the program from the command line and use it to submit an input file to the program.
      Record the command that works correctly so you can use it as the model when you configure your step template.
    3. Create a control file template for the step to use.

      If the external program reads the property values that it requires from a parameter file that accompanies the print file, the RunExternalProgram step can build that file. To generate the file, the step uses a control file template. To create the control file template:

      1. Make a copy of a parameter file that the application can use.
      2. Replace all of the property values in the file with the RICOH ProcessDirector symbol notation representation of the property. If the value is the file name for a file in the job, replace it with the appropriate RICOH ProcessDirector method call to determine the file name.

        During processing, the step uses the template to build the parameter file by resolving all the references and filling in the values for the current job.

      3. Copy the control file template into a directory in the RICOH ProcessDirector shared file system (/aiw/aiw1/ (Linux) or C:\aiw\aiw1\ (Windows).)

        Sample control file templates for external programs are installed in /aiw/aiw1/samples/external_programs/ (Linux) or C:\aiw\aiw1\samples\external_programs\ (Windows). You can copy these files to the /aiw/aiw1/control_files/external_programs/ (Linux) or C:\aiw\aiw1\control_files\external_programs\ (Windows) directory and customize them, or add your own control files to the /aiw/aiw1/control_files/external_programs/ (Linux) or C:\aiw\aiw1\control_files\external_programs\ (Windows) directory. Note the directory location of your control file template.

      4. On a Linux system, verify that the file permissions for the control file template provide access for the other class of system users. For example, set the permissions for the control file template to 666.
      5. Make sure one external command passes the control file in the parameter it expects (the -o option for including additional job properties, for example).

    4. On a Linux system, create a symbolic link to the application on the primary computer:
      1. Log on to the system that the RICOH ProcessDirector base product runs on as the RICOH ProcessDirector system user.
      2. Use the stopaiw command to stop the primary server.
      3. Use this command to create the symbolic link:
        ln -s application_file /aiw/aiw1/bin/link_file
        Replace application_file with the full path to the executable file for the application, and replace link_file with the name of the symbolic link file you want to create. The executable file must be located within the /aiw file system.
      4. Use the startaiw command to start the primary server.
  3. If you plan to use RunHotFolderApplication:
    1. Log on to the primary computer. On Linux systems, log in as the RICOH ProcessDirector system user.
    2. Copy or transfer a sample print file into the input folder for the application.
    3. Check the other application to make sure that it starts to process the file.
    4. Monitor the output folder for the resulting file. When it arrives, copy or transfer it to another directory, then verify that it is correct.
    5. Navigate to the directory that holds the log files for the other application and make sure that you can open and view the log files.

1.3.4.2 External steps

1.3.4.2.1 External commands

If you choose to use the RunExternalProgram step template, figure out the command that you want to use before you start to create your step template. Here are some example commands that use RICOH ProcessDirector symbol notation.

Copy a newer print file to a destination

In this example, the Linux cp command only copies the JobNumber.print.pdf file from the spool directory for the job when the source file is newer than the destination file:
cp -u ${getAbsoluteFileName(print, pdf, read)} /tmp/jobarchives

${getAbsoluteFileName(print, pdf, read)} is the RICOH ProcessDirector symbol formula that returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, an error occurs.

Update a print file and write it to the spool directory

In this example, the external program myprogram reads the JobNumber.print.pdf file from the spool directory and writes an updated version of the file to the spool directory using redirection:
myprogram -i ${getFileName(print, pdf, read)} > 
${getFileName(print, pdf, write)}

${getFileName(print, pdf, read)} is the RICOH ProcessDirector symbol formula that returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, RICOH ProcessDirector returns the name of the input file for the job, which is JobNumber.print.unknown. If that file does not exist in the spool directory, an error occurs.

Read the overrides file for a print job and write a statistics file to the spool directory

In this example, the external program auditstatistics reads the JobNumber.overrides.text file from the spool directory and writes a new statistics file JobNumber.statistics.text to the spool directory:
auditstatistics inputfile=${getFileName(overrides, text, read)} 
outputfile=${getFileName(statistics, text, write)}

Use a separate file to pass property values to an external program with the print file

In this example, the Linux cp command produces a CSV file for which a corresponding RICOH ProcessDirector control file exists. The control file lists the symbols for nine RICOH ProcessDirector job properties:
cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv

${getControlFileName()} is the RICOH ProcessDirector symbol formula that returns the name of the resolved control file. RICOH ProcessDirector generates the control file from the control file template that you specify.

The control file can use the getChildFileName method to return the name of a child file so that the external program can write a file to the children subdirectory in the spool directory. The external program must write the file names of child-job files in this format:

JobNumber.UsageType.DataType.n,Job.JobType=JobTypeName
JobTypeName is the name of the workflow that the child job requires. The workflow must exist and it must be enabled.

When you add a step based on the RunExternalProgram step template to a workflow using the Job Types property notebook, the properties that show [Receive] in the job defaults change to reflect the actual phase to which you add the step.

Invoke a command using a full path name

This example uses a full path name to invoke the user-supplied external program mytransform to transform a file to PDF format. mytransform reads the names of the input and output files from a control file:
/opt/myprograms/bin/mytransform -c ${getControlFileName()}

Archive a print file to a Windows system

In this example, the external step uses the Windows copy command to write a copy of the JobNumber.print.pdf file from the spool directory to an archive directory on the Windows system:
copy ${getAbsoluteFileName(print,pdf,read)} d:\archive\pdf
    Note:
  • The Windows system directory must have RICOH ProcessDirector installed and the Windows application server must be connected to the primary server.
  • Specify the Windows directory by using the native Windows format for the directory name.
  • Use native Windows commands instead of Windows Services for UNIX (SFU) commands where appropriate; for example, use the copy command instead of the cp command. Not all SFU commands are available on Windows systems.
  • Depending on the command, a directory on the Windows system might not need to exist. The command can create the directory on the Windows system.
  • Make sure that you tune the step template to only run on a Windows application server. Because of the different formats for directory names on Linux, a step based on this step template will fail if RICOH ProcessDirector tries to run the step on a non-Windows system.

1.3.4.2.2 Using RICOH ProcessDirector methods

When RICOH ProcessDirector creates a job, it also creates a spool directory. The spool directory contains a copy of the input file and other files that provide information about the job. Steps and commands can access the various files in the spool directory and use them during processing. They can also update existing spool files and write new files to the directory.

RICOH ProcessDirector provides these methods for reading and writing files in the spool directory for a job:

  • getFileName
  • getAbsoluteFileName
  • getCurrentFile
  • getCurrentAFPFile
  • getControlFileName
  • getChildFileName
  • getChildFileStem

1.3.4.2.2.1 Spool directory names

The default spool directory that RICOH ProcessDirector creates for a job is /aiw/aiw1/spool/default/JobNumber (Linux) or C:\aiw\aiw1\spool\default\JobNumber (Windows).

For example:

  • /aiw/aiw1/spool/default/10000006 (Linux)
  • C:\aiw\aiw1\spool\default\10000006 (Windows)

The default spool directory that it creates for a child job is /aiw/aiw1/spool/default/JobNumber.Number (Linux) or C:\aiw\aiw1\spool\default\JobNumber.Number (Windows). For example:

  • /aiw/aiw1/spool/default/10000006.4 (Linux)
  • C:\aiw\aiw1\spool\default\10000006.4 (Windows)

RICOH ProcessDirector messages and the properties notebook for a job refer to the spool directory as the Root file path.

RICOH ProcessDirector always uses these naming conventions for the names of the default spool directories. Authorized users cannot change the default naming conventions.

You can create additional spool directories. Additional spool directories have names in this format: /aiw/aiw1/spool/SpoolName/JobNumber (Linux) or C:\aiw\aiw1\spool\SpoolName\JobNumber (Windows) and /aiw/aiw1/spool/SpoolName/JobNumber.Number (Linux) or C:\aiw\aiw1\spool\SpoolName\JobNumber.Number (Windows). SpoolName is the subdirectory name that the authorized user assigned.

1.3.4.2.2.2 Spool file names

When RICOH ProcessDirector processes a job, it generates spool files for the job. Formats for RICOH ProcessDirector spool file names are:

Syntax 1, parent or standalone job:

JobNumber.Usagetype.Datatype

Syntax 2, child job:

JobNumber.Usagetype.Datatype.ChildGroupID

where:

Usagetype
Describes the purpose or role of the spool file within the job. Usage-type keywords are case-sensitive. Although RICOH ProcessDirector has usage-type keywords other than the ones listed here, these are the usage-type keywords for spool files that external programs might want to read from or write to:
aiwlist
Contains an entry for each input file in the job and its submit type. Depending on the job, RICOH ProcessDirector might have generated one or more of the input files or they might have accompanied the input file that contained the initial job data. The aiwlist file can be useful in problem determination.

This example shows what the file contents might look like when RICOH ProcessDirector generates one or more of the input files. The information in the first column is the submit type.

Linux:

Data;/aiw/aiw1/System/hf/PDF/Staged/
sample.PRD.AIW_TS.2006-04-27-08.57.31.476
Other;/aiw/aiw1/System/hf/PDF/Staged/
sample.JCL.AIW_TS.2006-04-27-08.57.31.593
List;/aiw/aiw1/System/hf/PDF/Staged/
sample.lst.AIW_TS.2006-04-27-08.57.31.534
AIWList;/aiw/aiw1/System/hf/PDF/Staged/
AIWList.AIW_TS.2006-04-27-08.57.31.794

Windows:

Data;C:\aiw\aiw1\System\hf\PDF\Staged\
sample.PRD.AIW_TS.2006-04-27-08.57.31.476
Other;C:\aiw\aiw1\System\hf\PDF\Staged\
sample.JCL.AIW_TS.2006-04-27-08.57.31.593
List;C:\aiw\aiw1\System\hf\PDF\Staged\
sample.lst.AIW_TS.2006-04-27-08.57.31.534
AIWList;C:\aiw\aiw1\System\hf\PDF\Staged\
AIWList.AIW_TS.2006-04-27-08.57.31.794
control
A special RICOH ProcessDirector-generated control file. It contains processing parameters that were specified in a control file template that accompanied the input file for the job. RICOH ProcessDirector generates the control file from the file specified in the External control file template property for the job. When it creates the control file, it resolves any RICOH ProcessDirector-specific entries from the control file template. For example, the PDF workflow runs a RunExternalProgram step during the Prepare phase. The RunExternalProgram step specifies this External command property:

/aiw/aiw1/bin/copy_files.pl ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv

The RunExternalProgram step specifies this External control file template property:

/aiw/aiw1/control_files/external_programs/job_info.cfg (Linux)

C:\aiw\aiw1\control_files\external_programs\job_info.cfg (Windows)

The job_info.cfg control file template contains this information:

Job.ID,Job.Name,Job.JobType,Job.SubmitTime,Job.RequestedPrinter,
Job.InputFile.Size,Job.JobSize,Job.TotalPages,Job.TotalSheets

${Job.ID},${Job.Name},${Job.JobType},${Job.SubmitTime},
${Job.RequestedPrinter},${Job.InputFile.Size},${Job.JobSize},
${Job.TotalPages},${Job.TotalSheets}

When RICOH ProcessDirector creates a control file from this template, it resolves the values for the ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime}, ${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages}, and ${Job.TotalSheets} symbols to the actual RICOH ProcessDirector job properties. For example:
${Job.ID}=10000001
${Job.Name}=Demo.pdf
${Job.JobType}=PDF
${Job.SubmitTime}=10:02.35
${Job.RequestedPrinter}=Sample
${Job.InputFile.Size}=2608549
${Job.JobSize}=26
${Job.TotalPages}=26
${Job.TotalSheets}=26
    Note:
  • Not all jobs that RICOH ProcessDirector creates have associated control files in their spool directories.
overrides
Contains a copy of the job-specific parameters that accompany the input file for the job. RICOH ProcessDirector can use these parameters with a control file to set job properties for the job.

For example, jobs that RICOH ProcessDirector receives through Download for z/OS or AFP Download Plus when the AFP Support feature is installed include datasetname.JCL files that the Download daemon generates. These files contain information that represents the values that were specified for JCL parameters. This example shows the contents of an overrides file that contains JCL values for parameters:

"-odatat=line -ofileformat=record -occ=yes -occtype=a -ochars=GF10 
-opagedef=P1A 06462 -of=F1A10110 -ocop=001 -odatac=block -ojobn=PAYROLL 
-ous=ADMIN1 -ono=BLD PDEVL -opr=KÿSMITH -opa=forms=STD,class=C,
destination=CHI3,jobid=JOB 02357,OUTGRP=NEXT"

A control file, such as receive_jcl_jobtype.cfg in /aiw/aiw1/samples/rules/ (Linux) or C:\aiw\aiw1\samples\rules\ (Windows) that RICOH ProcessDirector provides, can process the overrides file.

    Note:
  • Not all jobs that RICOH ProcessDirector creates have associated overrides files in their spool directories.
print
A print file that contains the data for the job. The data might match the format of the input file that RICOH ProcessDirector received or it might be in a different format. The format depends on the processing that has occurred for the job. For example, an input file might be converted to PostScript during processing.

In addition to the usage-type keywords that RICOH ProcessDirector uses, authorized users can specify their own usage-type keywords when they use RICOH ProcessDirector methods to manipulate files in the spool directory. However, user-defined keywords should not be variations of the RICOH ProcessDirector keywords if RICOH ProcessDirector will further process a file that an external program writes to the spool directory. For example, do not use a usage type of PRINT or Print; RICOH ProcessDirector only recognizes print.

Datatype
Describes the content or the data stream type of the spool file. Whether the spool directory for a given job contains a spool file of a specific data type depends on the processing that has occurred for the job. Datatype keywords are case-sensitive. The keywords that RICOH ProcessDirector provides are:
afp
Advanced Function Presentation (AFP) format. The spool file contains job print data.
gif
Graphic Interchange Format (GIF). The spool file contains image data.
jdf
Job Definition Format (JDF). The spool file contains job-specific parameters from the job ticket.
jpeg
Joint Photographic Experts Group (JPEG) format. The spool file contains image data.
json
JavaScript Object Notation (JSON) format.
linedata
Line-data format or mixed-mode format. The spool file contains job input data.
mjm
Multipurpose Internet Mail Extensions (MIME) package with data in Portable Document Format (PDF), Job Definition Format (JDF), and Job Messaging Format (JMF). The spool file contains job input data and job-specific parameters from the job ticket.
pcl
Printer control language (PCL) format. The spool file contains job input data.
pdf
Portable Document Format (PDF). The spool file contains job input data.
ps
PostScript format. The spool file contains job input data.
text
The data stream is a plain text file. The spool file can contain non-job data, such as processing parameters or information created by an external program.
tiff
Tagged Image File Format (TIFF). The spool file contains image data.
xml
Extended Markup Language (XML) format. The spool file contains well-structured XML.
zip
Data-compression and archiving format for one or more files. The spool file can contain job input data, image data, or non-job data, depending on the format of the files in the zip file.
unknown
The data stream is of an unknown format. This is the datatype keyword that RICOH ProcessDirector initially sets for the spool file that is a copy of the original input file for the job. For more detailed information, see the description of the Input data stream job property. Files with a datatype keyword of unknown might only be in the spool directory for a very short period of time after RICOH ProcessDirector creates the job.

In addition to the datatype keywords that RICOH ProcessDirector uses, authorized users can specify their own datatype keywords when they use RICOH ProcessDirector methods to let external programs write files to the spool directory. However, user-defined keywords for the data type should not be variations of the RICOH ProcessDirector keywords if RICOH ProcessDirector will further process a file that an external program writes to the spool directory. For example, do not use a datatype of PDF or Pdf; RICOH ProcessDirector only recognizes pdf.

ChildGroupID
A unique numeric value that RICOH ProcessDirector uses to identify and group all files that relate to a child job that an external program creates. The child group ID keyword is in addition to the datatype keyword; parent jobs or single jobs do not include a child group ID keyword.

1.3.4.2.2.3 getFileName and getAbsoluteFileName syntax

You can use the getFileName and getAbsoluteFileName methods to return the name of a specific file in the spool directory. This is useful because RICOH ProcessDirector assigns a unique job number for each job and includes the job number in file names. The main difference between the two methods is that getAbsoluteFileName fails if the specifically requested file does not exist; getFileName can return the name of an alternate spool file.

To use the RICOH ProcessDirectorgetFileName method or the getAbsoluteFileName method, use symbol notation to refer to them as RICOH ProcessDirector symbol formulas. Use one of these syntaxes:

Syntax 1, single search:

${getFileName(UsageKeyword, DatatypeKeyword, FileaccessKeyword)}

${getAbsoluteFileName(UsageKeyword, DatatypeKeyword, FileaccessKeyword)}

Syntax 2, iterative search:

${getFileName(UsageKeyword, (DatatypeKeyword1, DatatypeKeyword2...), 
FileaccessKeyword)}

${getAbsoluteFileName(UsageKeyword, (DatatypeKeyword1, 
DatatypeKeyword2...), FileaccessKeyword)}

where:

UsageKeyword
A case-sensitive keyword that identifies the usage type of the spool file. The values that authorized users can specify are the same values that the usage-type portion of the spool file name can contain. For example, you can specify these RICOH ProcessDirector-supplied keywords: aiwlist, control, overrides, or print. You can also specify your own user-defined keywords.
DatatypeKeyword or (DatatypeKeyword1, DatatypeKeyword2...)
A case-sensitive keyword that specifies the datatype of the spool file. The values that authorized users can specify are the same values that the datatype portion of the spool file can contain. For example, you can specify RICOH ProcessDirector-supplied keywords, such as jdf, pdf, or gif. You can also specify your own user-defined keywords.

If you want RICOH ProcessDirector to continue to search for another spool file if it does not find a spool file of the initial type, you can specify multiple datatype keywords. Separate them with commas and enclose them in parentheses. For example:

${getFileName(UsageKeyword, (print, pdf), FileaccessKeyword)}

In this example, the getFileName method first looks for a spool file with a datatype of print. If it does not find a matching spool file name, it looks for a spool file with a datatype of pdf. If it still does not find a matching spool file name, it looks for a spool file with a datatype of unknown. If that spool file does not exist, RICOH ProcessDirector issues an error message.

Note: The processing point at which RICOH ProcessDirector attempts to resolve the name of the file determines whether the method locates the file. If the workflow includes the SetJobPropsFromTextFile step, use the getAbsoluteFileName method instead of the getFileName method. The SetJobPropsFromTextFile step tries to resolve the file name that the getFileName method represents immediately after the input device creates the job, and not all spool files are available at that point in processing. RICOH ProcessDirector does not try to resolve the file name that the getAbsoluteFileName method represents immediately after job creation.

You can also specify multiple datatype values with the getAbsoluteFileName method, such as:

${getAbsoluteFileName(UsageKeyword, (pdf, postscript, text), 
FileaccessKeyword)}

The getAbsoluteFileName method looks for spool files in the same manner as the getFileName method, with one exception. If no spool files exist with any of the specified datatypes, the default is that the getAbsoluteFileName method does not look for a spool file with a datatype of unknown.

FileaccessKeyword
The file-access keyword, which is either read or write, specifies whether the external program reads the file from the spool directory or writes the file to the spool directory. RICOH ProcessDirector creates files in subdirectories of the spool directory, depending on whether the external program reads or writes a file:
checkpoints subdirectory
When the external program makes changes to the file through a write operation, RICOH ProcessDirector moves the original version of the file to this subdirectory. If an authorized user subsequently requests a process-again action, RICOH ProcessDirector can restore the original spool file from the checkpoints subdirectory. This makes sure that the external program has the same input available for its write operation as the first time that it processed the file.
tmp subdirectory
When the external program creates a new file, RICOH ProcessDirector stores the new file in this subdirectory until the external step that calls the external program completes. When the step completes, RICOH ProcessDirector moves the new file to the spool directory.
Note: External programs that create child jobs must write them to the children subdirectory of the spool directory for the job. The file name of the child job that the external program creates must be in this format:
JobNumber.Usagetype.Datatype,ChildGroupID,Job.JobType=JobType
The ChildGroupID must be the same for all files associated with a single child job. If the external program generates more than one child job, it must increment the ChildGroupID for each set of files associated with a new child job.

The external program appends ,Job.JobType= to the file name, which is the database name for the workflow property. JobType value is the name of the workflow that the child job requires; this workflow must exist and it must be enabled.

getFileName and getAbsoluteFileName read examples

All of these examples use the spool directory:

  • /aiw/aiw1/spool/default/10000006 (Linux)
  • C:\aiw\aiw1\spool\default\10000006 (Windows)

The spool directory contains these spool files:

10000006.banner_attributes.text
10000006.control.text
10000006.overrides.text
10000006.print.pdf
10000006.print.unknown
10000006.resources.pdf
10000006.resources.log
10000006.resources.outlines

For the purpose of these examples, the value of the Input data stream job property was not set through any manner, such as through a job default in the workflow or a detection step. Therefore, a spool file with a datatype of unknown is present in the spool directory:

  • To return the path and name of the control file for the job, which is /aiw/aiw1/spool/default/10000006/10000006.control.text (Linux) or C:\aiw\aiw1\spool\default\10000006\10000006.control.text (Windows), so that the external program can do a read operation on the file:
    ${getFileName(control, text, read)}
    
    ${getAbsoluteFileName(control, text, read)}
  • To return the path and name of the input file for the job, which is /aiw/aiw1/spool/10000006/10000006.print.unknown (Linux) or C:\aiw\aiw1\spool\10000006\10000006.print.unknown (Windows), so that the external program can do a read operation on the file:
    ${getFileName(print, unknown, read)}
    
    ${getAbsoluteFileName(print, unknown, read)}

This examples use the spool directory:

  • /aiw/aiw1/spool/default/10000009 (Linux)
  • C:\aiw\aiw1\spool\default\10000009 (Windows)

The spool directory contains these spool files:

10000009.banner_attributes.text
10000009.control.text
10000009.overrides.text
10000009.print.ps
10000009.resources.pdf
10000009.resources.log
10000009.resources.outlines

In this example, the type of the input data stream was detected and 10000009.print.ps is the copy of the original input file. To search for an input file in one of the supported PostScript formats:

${getFileName(print, (pdf, ps), read)}

${getAbsoluteFileName(print, (pdf, ps), read)}

Both methods first look for a spool file with the name 10000009.print.pdf. Because that spool file is not present, the methods continue to look for a spool file with the name 10000009.print.ps.

getFileName and getAbsoluteFileName write examples

All of these examples use the spool directory:

  • /aiw/aiw1/spool/default/10000006 (Linux)
  • C:\aiw\aiw1\spool\default\10000006 (Windows)
  • To set up for a write operation by an external program that writes a new statistics record file to the spool directory:
    ${getFileName(statistics, record, write)}
    
    ${getAbsoluteFileName(statistics, record, write)}

    RICOH ProcessDirector provides the external program with the path and file name /aiw/aiw1/spool/default/10000006/10000006.statistics.record on Linux and C:\aiw\aiw1\spool\default\10000006\10000006.statistics.record on Windows.

  • To set up for a write operation by an external program that updates the PDF print file in the spool directory:
    ${getFileName(print, pdf, write)}
    
    ${getAbsoluteFileName(print, pdf, write)}

    RICOH ProcessDirector checkpoints a file with the name 10000006.print.pdf, if it exists, into the checkpoints subdirectory of the spool directory for the job.

    RICOH ProcessDirector also provides the external program with the path and file name /aiw/aiw1/spool/default/10000006/tmp/10000006.print.pdf on Linux and C:\aiw\aiw1\spool\default\10000006\tmp\10000006.print.pdf on Windows.

    • If the program fails, the spool directory for the job is unchanged because the external program wrote to a file that RICOH ProcessDirector moved to the tmp subdirectory. RICOH ProcessDirector only moves the file to the spool directory if the external step that calls the external program completes successfully.
    • If the program succeeds, RICOH ProcessDirector moves the file from the tmp subdirectory into the spool directory. If a file by that name already exists in the spool directory, RICOH ProcessDirector moves that file to the checkpoint subdirectory, then moves the newly created file from tmp to the spool directory for the job.

1.3.4.2.2.4 getCurrentFile syntax

The getCurrentFile method returns the name of a print file in the spool directory for the job. If a file exists that contains a page range selected from the original print file, it returns the name of that file. If not, it returns the name of the original print file. This is useful for allowing the same command to work on the full job as well as a subset of the job, as is often the case with reprints.

Authorized users can use this format for the method:

${getCurrentFile(datatype)}

where:

datatype
The datastream of the print file. AFP can be specified, which makes this method identical to the getCurrentAFPFile method. You can use symbolic notation, such as ${Job.InputDataStream}, for this parameter.

getCurrentFile example

To submit a job to a Passthrough printer using lpr on a UNIX-based system, you could use this command for the value of the Printer command property:

lpr -Pmyprinter ${getCurrentFile(${Job.InputDataStream})}

The first time the job is sent to the printer, the entire job prints. If the job is processed again to print a subset of pages, only the subset is printed.

1.3.4.2.2.5 getCurrentAFPFile syntax

The getCurrentAFPFile method returns the name of an AFP print file in the spool directory for the job. If a file that contains a page range selected from the original print file exists, it returns the name of that file. If not, it returns the name of the original print file. This is useful for working with reprinted jobs, which can contain a subset of the original job.

The method uses no parameters. Authorized users must always use this format for the method:

${getCurrentAFPFile()}
getCurrentAFPFile example

A workflow contains an external step in the Print phase, before the PrintJobs step, that specifies this property and value:

External command [Print][RunExternalProgram]
Value: itm_driver -C ${getControlFileName()} -F"-itm_in_files ${getCurrentAFPFile()} -itm_out_files ${getFileName(print,pdf,write)}"

The first time that a job of this type is printed, RICOH ProcessDirector copies the print file to the tmp subdirectory as 10000004.print.afp. The external command converts the AFP file to PDF for printing.

When the job is reprinted, the operator selects a range of pages from the original print file. RICOH ProcessDirector copies only the selected pages to the tmp subdirectory as 10000004.print_range.afp. The external command converts 10000004.print_range.afp to PDF format.

1.3.4.2.2.6 getControlFileName syntax

The getControlFileName method returns the name of the resolved control file for the job.

The method uses no parameters. Always use this format for the method:

${getControlFileName()}
getControlFileName example

This example uses this spool directory:

  • /aiw/aiw1/spool/default/10000003(Linux)
  • C:\aiw\aiw1\spool\default\10000003(Windows)
It describes how RICOH ProcessDirector creates files and generates values when you use the getControlFileName method.

A workflow contains an external step in the Prepare phase that specifies these properties and values:

External control file template [Prepare][RunExternalProgram]
Value:
  • /aiw/aiw1/control_files/external_programs/job_info.cfg(Linux)
  • C:\aiw\aiw1\control_files\external_programs\job_info.cfg(Windows)
External command [Prepare][RunExternalProgram]
Value:
  • cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv(Linux)
  • copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv(Windows)

Just before running the external step, RICOH ProcessDirector copies the external control file template to the tmp subdirectory of the spool directory and resolves any symbols that the control file template contains. This is the procedure that RICOH ProcessDirector uses to create the resulting control file. For example, it generates this file: For example, it generates this file on Linux:

/aiw/aiw1/spool/default/10000003/tmp/job_info.control.text
And this file on Windows:
C:\aiw\aiw1\spool\default\10000003\tmp\job_info.control.text

When RICOH ProcessDirector creates the job that uses the workflow and sets its initial property values, it uses the value that the getControlFileName method returned to resolve the external command. The command is:

cp /aiw/aiw1/spool/default/10000003/tmp/job_info.control.text /aiw/aiw1/samples/10000003.info.csv

Or, on Windows, to this:

copy C:\aiw\aiw1\spool\default\10000003\tmp\job_info.control.text C:\aiw\aiw1\samples\10000003.info.csv

1.3.4.2.2.7 getChildFileName syntax

You can use the getChildFileName method when an external program creates only one child job and its associated files. This method returns a file name for a child job. When the external program starts to write the data for the child job, it writes the data to a file with the name that the getChildFileName method returns.

To use the RICOH ProcessDirectorgetChildFileName method, use symbol notation to reference it as a RICOH ProcessDirector symbol formula. Use this syntax:

${getChildFileName(UsageKeyword, DatatypeKeyword, ChildGroupID)}

where:

UsageKeyword
A case-sensitive keyword that identifies the usage type of the spool file. The use of UsageKeyword with the getChildFileName method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.
DatatypeKeyword
A case-sensitive keyword that identifies the datatype of the spool file. The use of DatatypeKeyword with the getChildFileName method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.
ChildGroupID
A unique numeric value that RICOH ProcessDirector uses to identify the files that belong to the same child job. Typically, when the external program generates a single child job, the value is set to 1.

1.3.4.2.2.8 getChildFileStem syntax

You can use the getChildFileStem method when the external program creates more than one child job or when you do not know how many child jobs the external program will generate. This method generates a root child job file name that an external program can use to generate as many child job file names as it needs.

To use the RICOH ProcessDirectorgetChildFileStem method, use symbol notation to reference it as a RICOH ProcessDirector symbol formula. Use this syntax:

${getChildFileStem(UsageKeyword, DatatypeKeyword)}

where:

UsageKeyword
A case-sensitive keyword that identifies the usage type of the spool file. The use of UsageKeyword with the getChildFileStem method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.
DatatypeKeyword
A case-sensitive keyword that identifies the datatype of the spool file. The use of DatatypeKeyword with the getChildFileStem method is the same as described earlier in this topic for spool files and the getFileName and getAbsoluteFileName methods.

1.3.4.3 Setting up step templates for external steps

You create a step template that contains the command that calls the external program. Then, you tune the step template so that it will run on the Linux or Windows system on which the external program is installed.

1.3.4.3.1 Setting up step templates for external steps that use the command line or control files

Use this process to set up a step template for external steps that use the command line or a control file to pass parameters between RICOH ProcessDirector and the external program.
    Note:
  • If each job has different requirements for external programs, you do not need to set up a step template. Use the RunExternalProgram step template to add a step to a workflow and then update the External command, Valid return codes, and External program language properties for the step, as described below.
To set up a step template for an external step:
  1. Click the Workflow tab.
  2. In the left pane, click Step Templates.
  3. Select the checkbox next to the RunExternalProgram step template.
  4. Click Copy.
  5. Specify a name and description for the new step template.
  6. Click the External tab.
  7. Update the External command property.
    This value is the actual command and any command-line parameters that RICOH ProcessDirector issues to run the external program. The command string can include RICOH ProcessDirector symbol notation.
  8. If you created a control file template for use with the external program, update the External control file template property. Set the value to the directory location and name of the control file template. If the external program only receives its parameters as command line arguments, delete any value for this property.
  9. Update the Valid return codes property.
    In this context, a valid return code is any return code from the external program that does not require a user action. Separate multiple return code numbers with commas. RICOH ProcessDirector moves the job to the error state if the external program returns any values that are not included in this value. It also issues a message in the log for the job to alert you to a problem that the external program reported.

    For example, if the value of the valid-return-codes property is 0,4, and the external program finishes with a return code of 16, RICOH ProcessDirector issues a message similar to this:

    AIWI6073E External step cp /aiw/aiw1/spool/default/10000016/10000016.print.unknown /archive/directory finished with a return code of 16, which is a defined as an error.

  10. If the installation has specific language requirements, you can also instruct the external program to return messages in a language that it supports. The drop-down list for the External program language property lists the languages that RICOH ProcessDirector supports.
  11. Click OK.
  12. Select the new step template and click Enable.

1.3.4.3.2 Setting up step templates for external steps that use hot folders

Use this process to set up a step template for external steps that use hot folders to pass input and output between RICOH ProcessDirector and the external program.
To set up a step template for an external step:
  1. Click the Workflow tab.
  2. In the left pane, click Step templates.
  3. Right-click the RunHotFolderApplication step template and select Copy.
  4. Specify a name and description for the new step template.
  5. Click Hot Folder.
  6. Update the Sending folder property.
    The value of this property is the name of the input hot folder for the external program. RICOH ProcessDirector places the job in this folder to submit it to the external program.
      Note:
    • The value must be the name of a folder that exists. RICOH ProcessDirector does not create the folder.
    • The folder must be accessible to both RICOH ProcessDirector and the external program. It can be:
      • In the RICOH ProcessDirector shared file system, /aiw/aiw1/ (Linux) or C:\aiw\aiw1\ (Windows), on the computer that has the primary server installed.
      • In a file system that is shared using file sharing software, such as Samba.
    • Even if the folder is on a Windows system, specify the path using Linux format. For example, if the folder is C:\Sending, type /Sending.
    • If this value is null, no file is copied and the step waits.
  7. Update the File to send property.
    The value of this property is a symbol formula that resolves to the name of the file that RICOH ProcessDirector sends to the external program.
      Note:
    • The default value is getAbsoluteFileName(print, pdf, read), which returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, an error occurs.
  8. Update the Retrieval folder property.
    The value of this property is the name of the output hot folder for the external program. RICOH ProcessDirector retrieves the job from this folder after the external program has processed it.
      Note:
    • The value must be the name of a folder that already exists. RICOH ProcessDirector does not create the folder.
    • The folder must be accessible to both RICOH ProcessDirector and the external program. It can be:
      • In the RICOH ProcessDirector shared file system, /aiw/aiw1/ (Linux) or C:\aiw\aiw1\ (Windows), on the computer that has the primary server installed.
      • In a file system that is shared using file sharing software, such as Samba.
    • Even if the folder is on a Windows system, specify the path using Linux format. For example, if the folder is C:\Retrieval, type /Retrieval.
    • When you set the Clean up retrieval folder property to No, the file that the step retrieves can be in the retrieval folder when a job arrives at the step. The step retrieves the file and puts the file specified by the File to send property in the sending folder. The step then sends the job and the retrieved file to the next step in the workflow. The step does not wait for a new file to be placed in the retrieval folder.
  9. Update the Retrieval pattern property.

    The value of this property is the pattern-matching string that RICOH ProcessDirector uses to identify the output files to retrieve from the output hot folder of an external program.

    For example, the value ${Job.ID}.* matches any file whose file name is the same as the job ID, with any file extension.

  10. Update the Retrieved file property.
    The value of this property is a symbol formula that resolves to the name that RICOH ProcessDirector uses to rename the retrieved file.
  11. Update the Clean up retrieval folder property.

    When a job enters the step, this value tells RICOH ProcessDirector whether to remove any file in the retrieval folder whose file name matches the Retrieval pattern.

  12. Update the Application log file property.
    The value of this property is the folder where the external program writes log files. This value can be blank.
  13. Update the Poll interval property.
    The value of this property is the interval in seconds at which RICOH ProcessDirector checks the output hot folder for completed jobs.
  14. Update the File size verification count property.
    The value of this property is the number of times that RICOH ProcessDirector polls the output hot folder and finds a file that has not changed in size. RICOH ProcessDirector then decides that the file is complete.
  15. Update the Timeout interval property.
    The value of this property is the time limit in minutes for retrieving a job from the output hot folder of an external program. If the job has not been received or is not complete when the time limit is reached, the job is in error.
      Note:
    • Make the timeout interval longer than the poll interval times the file verification count.
    • If the timeout interval is 0, RICOH ProcessDirector waits forever.
  16. Click OK.
  17. Update any settings on the Tuning tab to run the step on the computers where the external program is installed.
    See Tuning step templates for instructions.
  18. Select the new step template and click Enable.

1.3.4.3.3 Tuning step templates

Tuning a step template lets you specify how much system resource the step requires for processing. You can also specify which computers can run the steps created from the step template.

Step templates that let RICOH ProcessDirector access applications on other computers must be tuned to run on the server that those applications are installed on.

The RunExternalProgram and RunHotFolderApplication step templates (and any copies of them) can be tuned to run on the primary server, an application server, or a secondary server.

If the RICOH ProcessDirector primary computer is a Linux system, step templates installed by some features must be tuned to run on application servers. These step templates (and any copies of them) must be tuned to run on application servers:

  • RunPitStopOnJob

Some step templates installed by features (including document processing features) can only run on the primary server. If your environment includes RICOH ProcessDirector application or secondary servers, you must tune these step templates to run only on the primary server:

  • CreateInserterReprints
  • CreateJobsFromDocuments
  • CreateReprints
  • GroupDocuments
  • InsertJobs
  • ReadBarcodeData
  • ReadDocumentsFromDatabase
  • ReadDocumentsFromParent
  • SendInserterControlFile
  • SetDocPropsFromConditions
  • SetInsertProperties
  • SetJobPropsFromOriginal
  • UpdateDocumentsInDatabase
  • WaitForDocumentCompletion
  • WriteDocumentsToDatabase
  • WriteInserterControlFile
  • WritePropsToReportsDatabase

To tune a step template:

  1. Click the Workflow tab.
  2. In the left pane, click Step Templates.
  3. Click the name of the step template that you want to tune.
  4. Click the Tuning tab.
  5. In the Concurrent step limit section, specify where the limits are set for the number of steps created from the step template that can run at the same time.
  6. Click OK.

1.3.4.4 Setting up workflows for external steps

After you create a step template to call an external program and tune the step template to run on the server that the external program is installed on, you add a step that is based on the step template to a workflow. You then assign the workflow to an input device, or use another method to assign the workflow to specific jobs.
To set up a workflow for an external step:
  1. Click the Workflow tab.
  2. Determine whether you can use a copy of an existing workflow or if you need a new workflow. Do one of these:
    • Right-click one of the workflows and select Copy. Name the copy of the workflow, fill in or edit other values that you need, and click Continue.
    • Click Add and specify a name and description for the new workflow.
  3. To add the external step:
    1. In the workflow editor, click Step Templates in the top right corner of the window.
    2. Click the external step and drag it into the workflow editor. Place the step where you want it.
    3. If you want to rename the step, right-click the step. Select Properties, and then click General. For the Step name property, type a name for the new step and click OK.
  4. Edit the properties for processing behavior as needed.
  5. Connect the step to other steps.
    The external step can use conditional processing to receive a job from multiple steps and send it to multiple steps. You can attach rules with conditions to the connectors, and you can set job properties for different branches of the workflow by adding steps based on the AssignJobValues step template.
  6. Add or update the other steps in the workflow if necessary. A workflow can contain more than one step that calls an external program.
  7. Save and enable the workflow.
  8. Test the external program.

1.3.5 Using Web Services

If your application provides a different interface for displaying information about the RICOH ProcessDirector system, or if it needs to extract information from RICOH ProcessDirector to do more processing, you can use web services to request different kinds of information and manage system objects.
Preparing RICOH ProcessDirector to receive web service requests

Before you can submit web services requests, you must create a RICOH ProcessDirector user and password for web services to use. Be sure that the user ID has the appropriate level of authority in RICOH ProcessDirector to do the actions provided in the web service. For the examples in this chapter, Operator authority is sufficient. If you are using Lightweight Directory Access Protocol (LDAP) for authentication, create a user in LDAP for web services to use. The LDAP user must belong to a group that has the appropriate level of authority in RICOH ProcessDirector.

Because all users must change their passwords the first time they log in, log in to the RICOH ProcessDirector user interface using the user ID that you created and change the password. If you have passwords set to expire after a given time period, you must log in and change this password as needed.

Preparing web service requests

When you create requests, keep these points in mind :

  • The web services user must log in before doing any actions.

    To submit any web service requests, you must first use the GET /users/login web service to log in to RICOH ProcessDirector as the web service user and receive a credential token. That token must be included in the header of all the web service requests that you submit until you submit the POST /users/logout/{name} web service.

  • Property names must be expressed in the database format, not in the user interface format.

    When you include a property name in a request, you must use the database property name. For example, if you want to use GET /objects/{objectType} to retrieve the Class value of a job, you insert Job.Class as the attribute value in the request. Database property names are available in the field help for each property, in the product help system, in results received from some of the web services, and in Database property names.

  • Property values must be expressed in the database format, not in the user interface format.

    When you include a value in a query, you must make sure that it is a valid value. Usually, numerical fields require numerical values and text fields require text values. However, some properties have limited lists of values.

    Any property that provides a drop-down list can only accept certain values. In addition, the values that appear in those lists are not always the same values that are stored in the database. For example, in the user interface, the values for the Staple property include:

    • 2 at left
    • 2 at right
    • Top left
    • Top left vertical
    • Bottom left
    However, the database values are:
    • 2_at_left
    • 2_at_right
    • Top_left
    • Top_left_vertical
    • Bottom_left

    In web service requests, you must use the database value. The database values for properties are available in the product help system and in Database property names.

  • Positional job properties must include the phase, step, and workflow names in that order following the property name. Enclose each of the three names in brackets.

    This example JSON string specifies a control file on a Linux system as the value of the Identify PDF control file job property (database name Job.IdentifyPDFControlFile):

    "Job.IdentifyPDFControlFile[Prepare][IdentifyPDFDocuments][PullPDFSample]":"/aiw/aiw1/testfiles/PullPDF.ctl"

    The job property is on the IdentifyPDFDocuments step in the Prepare phase of the PullPDFSample workflow.

1.3.5.1 Using RICOH ProcessDirector REST API documentation

RICOH ProcessDirector provides REST APIs for web service integration. Interactive documentation is provided with these APIs and provides live testing and information for each available API.

The REST API documentation includes many APIs that an application can use to integrate with RICOH ProcessDirector. You can use the REST API documentation and testing interface to test your parameter settings. When you use the interface to test web services, you access the RICOH ProcessDirector primary server. Actions such as creating, deleting, and enabling objects are executed on the primary server and are reflected in the RICOH ProcessDirector user interface. As a result, we suggest creating objects specifically for testing purposes.

These steps demonstrate how to request the log files for an object using REST APIs. These steps log you in to RICOH ProcessDirector, request the log files for the Sample printer, and log you out.

  1. Open a Web browser and enter your RICOH ProcessDirector hostname or IP address into the address bar. Add /restapi/ to the end of your hostname or IP address to access the REST API documentation. For example, http://hostname:15080/restapi/
  2. In the users section and find POST /users/login.
  3. Click Try it out.
  4. Log in to RICOH ProcessDirector by entering your RICOH ProcessDirector credentials:
    • For the name parameter, enter your RICOH ProcessDirector user name.
    • For the pwd parameter, enter the password associated with your RICOH ProcessDirector user name.
  5. Click Execute.
    The REST API documentation uses the values you enter to build a Curl command and a Request URL. Then it submits the request to the request URL and logs you in.

    RICOH ProcessDirector sends a response indicating whether you successfully logged in. The response includes additional information including the token and the actions that this User ID is allowed to do.

  6. In the Response Body box, find and copy the token value.

  7. In the objects section, scroll down until you find POST /objects/log/{objectType}/{name}.
  8. Click Try it out.
  9. Retrieve the log messages for the Sample printer by entering these parameters:
    1. For the token parameter, paste the token you copied above.
    2. For the objectType parameter, type Printer.
      The values for objectType are case-sensitive. You can use the web service POST /util/objecttypes to get a list of object types available on your system. The web service POST /util/objecttypes is found in the util section.
    3. For the name parameter, type Sample.
  10. Click Execute.
    The log entries for the Sample printer are returned in the Response Body box.

    The Curl and Request URL values are also returned.

  11. In the users section find POST /users/logout/{name}.
  12. Click Try it out.
  13. Log out of RICOH ProcessDirector:
    • For the token parameter, paste the token you copied above.
    • For the name parameter, enter your RICOH ProcessDirector user name.
  14. Click Execute.
    You are logged out of RICOH ProcessDirector.
  15. Example values are included with certain APIs. With example values you can update the sample code and modify it for testing.

    These steps demonstrate how to use a REST API to connect a hot folder using an example value. These steps log you in to RICOH ProcessDirector, set the Input Device to accept files from HotFolderPDF, and log you out.

  16. Open the REST API interface as above.
  17. In the users section and find POST /users/login.
  18. Click Try it out.
  19. Log in to RICOH ProcessDirector by entering your RICOH ProcessDirector credentials:
    • For the name parameter, enter your user name.
    • For the pwd parameter, enter the password associated with your user name.
  20. Click Execute.
  21. In the Response Body box, find and copy the token value.
  22. In the objects section, scroll until you find POST /objects/{objectType}/connect.
  23. Click Try it out.
  24. Connect HotFolderPDF by entering these parameters:
    1. For the token parameter, paste the token you copied above.
    2. For the objectType parameter, type InputDevice.
      The values for objectType are case-sensitive. You can use the web service POST /util/objecttypes to get a list of object types available on your system. The web service POST /util/objecttypes is found in the util section.
    3. For the body parameter, click Edit Value. Example text displays in a code box. Replace the word “string” with “HotFolderPDF”. Make sure the double quotes are around the name of the object.
  25. Click Execute.
    The properties and settings for HotFolderPDF are returned in the Response Body box. The Response Code and Response Headers are also returned.
  26. In the users section find POST /users/logout/{name}.
  27. Click Try it out.
  28. Log out of RICOH ProcessDirector:
    • For the token parameter, paste the token you copied above.
    • For the name parameter, enter your RICOH ProcessDirector user name.
  29. Click Execute.
    You are logged out of RICOH ProcessDirector.

1.3.5.2 Preparing to submit jobs using web services

RICOH ProcessDirector provides a REST web service utility that you can use to submit jobs. If you can configure your application to use REST web services, you can use the submitFile utility to submit a file to a workflow or hot folder.
Depending on the requirements of your web service application, you need either a Curl command or Request URL to invoke the web service. Use the RICOH ProcessDirector REST API documentation to determine the correct syntax.

To prepare to submit a job using a web service:

  1. Decide how RICOH ProcessDirector receives the file for processing.
    You can submit a file to RICOH ProcessDirector using a hot folder input device or you can submit directly to a workflow.
    • Submit files directly to a workflow when there is only one input file per job or you do not need to use the batching functions available in RICOH ProcessDirector.
    • Submit files to hot folders when you want to use the batching functions in RICOH ProcessDirector. You can only submit one file at a time with the web service. If a job has multiple input files, including job tickets, list files, or other resources, you must invoke the web service for each file.

      Note the name of the workflow or hot folder.

  2. Evaluate your web service application and see what information the application requires to submit a file to RICOH ProcessDirector.
    The RICOH ProcessDirector REST API documentation provides both a Curl command and a Request URL. Either can be used depending on what your web service application requires.
  3. Use the RICOH ProcessDirector REST API documentation for the submitFile utility to help create the web service calls to submit your file.
    Open a web browser and enter your RICOH ProcessDirector hostname or IP address into the address bar. Add /restapi/ to the end of your hostname or IP address to access the REST API documentation. For example: http://hostname:15080/restapi/.

    Open the util section and find POST /util/ submitFile/{objectType}/{name}.

  4. Update your web service application with the command or URL that you developed in previous step. Use the application to submit one or more files to RICOH ProcessDirector.
  5. Verify that your web service application is configured correctly to submit a file to RICOH ProcessDirector.
    • If you submit to a hot folder, verify that the file is in the folder location in the hot folder. Connect and disable the hot folder if you want to check that the files are received in the correct directory without actually submitting the job. If you want the input device to submit the job, make sure it is both enabled and connected when your application submits the file.
    • If you submit to a workflow, verify that a job is created with the file you submitted. Make sure the workflow is enabled when you submit the file.

1.3.6 RICOH ProcessDirector symbol notation

You can use RICOH ProcessDirector symbol notation in formulas to describe the information source that RICOH ProcessDirector evaluates to set the value of a job property.
Symbol syntax

In RICOH ProcessDirector, this is the basic syntax of a symbol, which you can use in symbol formulas:

${Name}

Name is a database property name in RICOH ProcessDirector or a parameter that is passed with the job. RICOH ProcessDirector evaluates parameters that are passed with a job through a control file such as a rules file that parses JCL parameters and values. Name can also be a method in RICOH ProcessDirector, such as getFileName, getAbsoluteFileName, getControlFileName, or getChildFileName. The Name value is case-sensitive.

Examples
${Get*Method}
This symbol causes RICOH ProcessDirector to call an internal method and return an evaluated value. To see how RICOH ProcessDirector can use this type of symbol, see the RunExternalProgram step in the Prepare phase of the PDF workflow. The RunExternalProgram step specifies this External Command property:
  • Linux: cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv
  • Windows: copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv

The ${getControlFileName()} symbol instructs RICOH ProcessDirector to copy the external control file template into the tmp subdirectory of the spool directory and resolve any symbols that the control file contains.

The RunExternalProgram step in the Prepare phase of the PDF workflow specifies this External control file template property:

  • Linux: /aiw/aiw1/control_files/external_programs/job_info.cfg
  • Windows: C:\aiw\aiw1\control_files\external_programs\job_info.cfg

When RICOH ProcessDirector creates the job that uses the workflow and sets its initial property values, it uses the value that the getControlFileName method returned to resolve the external command to this:

  • Linux: cp /aiw/aiw1/spool/default/10000003/tmp/job_info.control.text /aiw/aiw1/samples/10000003.info.csv
  • Windows: copy C:\aiw\aiw1\spool\default\10000003\tmp\job_info.control.text C:\aiw\aiw1\samples\10000003.info.csv

${Job.PropertyName}
This symbol causes RICOH ProcessDirector to query its database for the value of a specific RICOH ProcessDirector job property.

To see how RICOH ProcessDirector can use this type of symbol, review the contents of the job_info.cfg control file template. This control file template is in /aiw/aiw1/control_files/external_programs on Linux or C:\aiw\aiw1\control_files\external_programs on Windows.

When RICOH ProcessDirector creates a control file from this template, it resolves the values for the ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime}, ${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages}, and ${Job.TotalSheets} symbols to the actual RICOH ProcessDirector job properties. For example:

${Job.ID}=10000001
${Job.Name}=Demo.pdf
${Job.JobType}=PDF
${Job.SubmitTime}=10:02.35
${Job.RequestedPrinter}=Sample
${Job.InputFile.Size}=2608549
${Job.JobSize}=26
${Job.TotalPages}=26
${Job.TotalSheets}=26

    Note:
  • You can also use any of the system properties in a symbol formula that RICOH ProcessDirector evaluates. For example, ${WorkflowSystem.Transform.Server.Address}.
${Math}
This symbol causes RICOH ProcessDirector to add, subtract, multiply, or calculate the modulus of two values which can be job properties or numbers. It can also generate a random number in a specified range.
The syntax of this symbol is:

${Math(value1,operator,value2)}

  • value1 and value2 are job properties in symbolic notation (such as ${Job.CurrentTime}) or numbers. Numbers can contain fractional values, such as 2.45, if the property using the symbol formula supports floating point values.
  • operator is +, -, *, or mod for addition, subtraction, multiplication, and modulus respectively.

For example, to add 5 minutes to the current time and store it in the Job.Info.Attr2 property, use ${Math(${Job.CurrentTime}, +, 5)}.

Only properties that use integer, numeric, or timestamp values can be used in the value fields in this formula. Only properties that support symbol notation values can be set using this formula.
If either value is a timestamp property, the only operators supported are + and -, and the other value must be an integer. The units of the integer value are minutes.
Some properties appear to have timestamp values (such as Job.TimeSubmitted) but are defined as strings, so they cannot be used as values in a Math symbol. The Math symbol can be entered in fields on step templates in the Workflow Builder, including the AssignJobValues step template, and in fields in job property notebooks.
For modulus, value1 must be an integer which is 0 or greater and value2 must be an integer which is 1 or greater.
For random number generation, the syntax of this symbol is:
  • ${Math(rand, value1, value2)}
For example, to generate a random number from 1 through 10, use ${Math(rand, 1, 10)}.
    Note:
  • value1 and value2 are job properties in symbolic notation (such as ${Job.Copies}) or numbers.
  • value1 and value2 must be integers which are zero or greater.
  • The result returned is an integer between value1 and value2, inclusive.
  • The random numbers that are generated are not cryptographically random.
${RulesFileParameter}
This symbol causes RICOH ProcessDirector to query a parameter file that accompanies an input file. It queries for a parameter value that is specific to another program or product.

For example, when the LPDPDF input device receives an input file, it uses the receive_lpd_pdf_jobtype.cfg control file to parse parameters that accompany the input file.

The receive_lpd_pdf_jobtype.cfg control file is located in this directory:

  • Linux: /aiw/aiw1/control_files/rules
  • Windows: C:\aiw\aiw1\control_files\rules

(Linux)

(Windows)

A receive_lpd_pdf_jobtype.cfg control file might contain this information:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

The symbols for these parameter values are:

${ORIGHOST}
${ORIGUSER}
${ORIGNAME}

To see how RICOH ProcessDirector can use this type of symbol, review the receive_lpd_pdf_jobtype.cfg file in this directory:

  • Linux: /aiw/aiw1/samples/rules
  • Windows: C:\AIW\AIW1\samples\rules

Usage notes for symbol formulas

These usage restrictions apply to using RICOH ProcessDirector symbol formulas:

Supported objects
RICOH ProcessDirector supports the use of symbol formulas only to set the values of job properties. You cannot use symbol formulas to set property values for any other object type, such as an input device or a printer. The symbol formula that RICOH ProcessDirector evaluates to set the value can be another job property, a primary server property, or a method call, such as: ${Job.InputFile}, ${Printer.Model}, and ${getControlFileName()}. However, a given symbol formula cannot contain both a job property and a system property or a method call at the same time.
    Note:
  • Changing the value of a system property might affect many symbol formulas for job properties. Because RICOH ProcessDirector updates all the symbol formulas at once, the operation can take a long time to complete.
Excluded properties
RICOH ProcessDirector does not support setting the value of the Job.Class property with a symbol formula.
Appearance in the RICOH ProcessDirector user interface
You can specify symbol formulas in workflows and in step templates through the Administration page of the RICOH ProcessDirector interface.

When viewing the property notebooks for these objects, symbol formulas always display in their formula format, such as ${Job.InputFile} as the value for the Job name property. In the properties notebook for a job that uses a workflow with steps that specify symbol formulas, the affected job properties display their evaluated values from the formulas. For example, the value of the Job name property is the actual name of the input file, such as reports.pdf.

Multiple levels of formulas
The evaluation of formulas can extend to a group of related formulas. For example:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Locations}
In this case, when the Job.Locations job property has a value, RICOH ProcessDirector sets the value of the Job.CustomerName property. This, in turn, lets RICOH ProcessDirector set the value of the Job.Description property, and then set the value of the Job.Name property.
Circular formulas
A circular formula is one in which a property receives a value from a symbol formula, and then is used to provide a value for another related property. For example:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Name}

RICOH ProcessDirector does not support this usage and issues an error message.

Maximum depth for multiple levels of formulas
In the multiple levels of formulas example, the formula depth is three. RICOH ProcessDirector supports a depth of up to 99 related formulas. It issues an error message if it encounters a formula depth that is greater than 99.
Use of positional properties in symbol formulas to set values for non-positional job properties
Positional properties are properties than can appear in multiple phases and steps and that might have different values in each place. For example, an administrator could configure a workflow so that the Valid return codes job property on the RunExternalProgram step appears in multiple phases and steps in the workflow and has a different value each time. The phase and step names are the names of sections on the job property notebook with the individual property names and values for each instance shown in its own section. RICOH ProcessDirector does not let you use positional properties in symbol formulas that set values for non-positional properties because there is no mechanism to specify which occurrence of the positional property to use.
Use of positional properties in symbol formulas to set values for other positional job properties
Positional properties can use symbol formulas that specify other positional properties. RICOH ProcessDirector looks for the value of the positional property that it evaluates in the symbol formula in the same phase and step that the requesting positional property specifies.
Precedence of property values set by symbol formulas
When multiple methods that specify a value for the same property exist, RICOH ProcessDirector always uses the value that the symbol formula specifies. When a symbol formula exists for a property value, RICOH ProcessDirector does this:
  • Discards any value specified in a control file.

    For example, assume that the workflow specifies ${Job.InputFile} as the value of the Job name property and a control file, such as /aiw/aiw1/control_files/rules/ (Linux) or C:\aiw\aiw1\control_files\rules\ (Windows)receive_lpd_pdf_jobtype.cfg, specifies: DEFINE ${Job.Name} AS "${ORIGHOST}".

    RICOH ProcessDirector sets the value of the Job name property to the name of the input file for the job, not to the value that the ORIGHOST parameter for the job specifies.

  • Discards any explicitly specified value in the job properties notebook for a job property that the workflow defaults with a symbol formula. You must delete the symbol formula from the workflow and process the job again to use an explicitly specified value.
Validation of symbol formulas
RICOH ProcessDirector validates the syntax and the content of the symbol formula and issues messages for error conditions. For example, both of these would result in errors: Job.Description=${Job.CustomerName and Job.Description=${Job.XYZ} The first example is a syntax error with no closing brace and the second example is an unknown job property name.

1.3.7 File system mapping file for job tickets

The sample system_map.cfg found in /aiw/aiw1/samples/config/ (Linux) or C:\aiw\aiw1\samples\config\ (Windows) translates the file paths in JDF job tickets to the file paths of a mounted file system. You can copy this file into the /aiw/aiw1/control_files/config/ (Linux) or C:\aiw\aiw1\control_files\config\ (Windows) directory and edit it as necessary.

Each line of the file system mapping file is in this format:

client_file_path;host_file_path
client_file_path
The client file path is the file path as it appears in the job ticket. It must include at least one backslash (\) or slash (/) character. It can include an asterisk (*) as a wild card representing the drive letter.
host_file_path
The host file path is the file path where the RICOH ProcessDirector server can locate input files. It must include at least one backslash (\) or slash (/) character. It must not include wild cards.

On Linux, this line converts any Windows file path to a Linux file path:

*:\;/

Example

Suppose that the file system mapping file contains these lines:

C:\production\siteA;/BankFiles/prod
*:\production\siteA\test;/BankFiles/test

The job ticket refers to a file called C:\production\siteA\test\justAtest.pdf. RICOH ProcessDirector searches for justAtest.pdf in these directories on Linux:

  1. /BankFiles/prod/test/
  2. /BankFiles/test/
  3. /production/siteA/test/
  4. The staging location of the hot folder input device

And in these directories on Windows:

  1. D:\BankFiles\prod\test\
  2. D:\BankFiles\test
  3. The staging location of the hot folder input device

1.3.8 Syntax for RICOH ProcessDirector control files

Various parts of RICOH ProcessDirector use the information in control files or control file templates to set and pass values for different properties. You can copy the control files and control file templates that RICOH ProcessDirector provides and modify them to meet the needs of the installation.

1.3.8.1 Sample control files for rules

RICOH ProcessDirector provides sample control files for rules that parse JCL parameters, LPD control file parameters, or JDF values to set workflows and to set job property values.

The sample control files (receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, receive_lpd_pdf_jobtype.cfg, and receive_text_jobtype.cfg) for rules are installed in the /aiw/aiw1/samples/rules/ (Linux) or C:\aiw\aiw1\samples\rules\ (Windows) directory.

To create your own control file, you can copy and rename one of the sample files to the /aiw/aiw1/control_files/rules/ (Linux) or C:\aiw\aiw1\control_files\rules\ (Windows) directory, then edit it to meet your needs.

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples/ (Linux) or C:\aiw\aiw1\samples\ (Windows) directory, but they do not overwrite files in the /aiw/aiw1/control_files (Linux) or C:\aiw\aiw1\control_files (Windows) directory. We recommend copying sample files into the /aiw/aiw1/control_files (Linux) or C:\aiw\aiw1\control_files (Windows) directory and making all your changes in the copied file.

1.3.8.1.1 receive_jcl_jobtype.cfg

The sample receive_jcl_jobtype.cfg file sets the workflow and job properties for jobs received from Download for z/OS and AFP Download Plus.

The AFP Support feature provides the receive_jcl_jobtype.cfg file.

RICOH ProcessDirector can use this control file to interpret a JCL file that accompanies a PRD dataset that RICOH ProcessDirector receives from a Download input device. For example, the JCL file might contain this information:

"-odatat=af -oburst=no -occ=yes -occtype=m -ocop=1 -odatac=unblock 
-ofileformat=stream -of=F1HPSTP1 -ojobn=HPUNCH05 -ono=BLDPDEV9 
-opr=HPUNCH -ous=WAITE 
-opa=class=B,dest=LOCAL,forms=STD,jobid=JOB00105"

To use a control file, set the value of the Child workflow initialization step property for the input device to SetJobTypeFromRules or SetJobTypeFromFileName, and then set the value of the Child workflow parsing rules property to the path and file name of the control file. The SetJobTypeFromRules step uses the control file to set the workflow for the job, convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both; the SetJobTypeFromFileName step uses the control file for setting job properties. All the information in the control file is case-sensitive.

Note: You cannot use a control file to set job properties that are read-only in the Job Properties notebook.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the JCL file.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the JCL file. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. Always use the "FILE" value for control files that process JCL files. The double quotation marks in the value are required.
ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the JCL file parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.
NORMALIZER_PROGRAM
This keyword specifies the name of a program that modifies the JCL file so all the properties it defines are in the form "keyword=value". RICOH ProcessDirector supplies the normalize_jcl.pl program to modify the various styles of JCL parameters into the "keyword=value" form.

For example, consider this JCL string:

"-odatat=af -oburst=no -opa=class=B,dest=LOCAL,forms=STD,jobid=JOB00105"
When RICOH ProcessDirector uses the normalize_jcl.pl program specified in the control file, it replaces the JCL string with this value:
datat=af,burst=no,class=B,dest=LOCAL,forms=STD,jobid=JOB00105,

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the JCL file. It is commented out in the sample file because the program defined by the NORMALIZER_PROGRAM keyword converts the JCL file.

For example, this statement replaces all occurrences of -opa= (note the initial space) with commas:

#s! -opa=!,!

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow and job properties from the values for parameters that are passed in the JCL file with the job. Some examples of the types of DEFINE statements that the section can contain are:
DEFINE ${Job.JobType} AS "BILLS" WHEN (${DEST} == "LOCAL")
DEFINE ${Job.Class} AS "${CLASS}"
DEFINE ${Job.InputDatastream} AS "AFP" WHEN (${DATAT} == "af")
DEFINE ${Job.Destination} AS "${DEST}"
DEFINE ${Job.RequestedPrinter} AS "${DEST}"
DEFINE ${Job.Customer} AS "XYZ" WHEN (${CLASS} == "Z") FINALLY QUIT

The first DEFINE statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.JobType property to BILLS when the value of the DEST parameter from the JCL file is LOCAL. If the DEST parameter has any other value, RICOH ProcessDirector does not set the workflow from the control file. It sets it using another method, such as by using the workflow that is assigned to the Download input device.

The second DEFINE statement is a non-conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.Class job property to the value of the CLASS parameter that is passed with the job. Therefore, if the original JCL string that RICOH ProcessDirector receives contains -opa=class=B, RICOH ProcessDirector sets the value of the Job.Class property to B.

The third DEFINE statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.InputDataStream job property to AFP when the value of the DATAT parameter from the JCL is af. If the DATAT parameter has any other value, RICOH ProcessDirector does not set the value of the Job.InputDataStream property.

The fourth and fifth DEFINE statements are non-conditional statements that set the values of two different job properties to the value of the same parameter.

The last DEFINE statement is a conditional statement that can cause RICOH ProcessDirector to stop reading any more DEFINE statements in the control file. If the condition that the statement defines is true, RICOH ProcessDirector stops reading the control file. If the condition is false, RICOH ProcessDirector continues to evaluate any other DEFINE statements that follow the FINALLY QUIT statement.

1.3.8.1.2 receive_lpd_jobtype.cfg

The sample receive_lpd_jobtype.cfg file sets the workflow and job properties for AFP jobs received through the LPD protocol.

The AFP Support feature provides the receive_lpd_jobtype.cfg file.

RICOH ProcessDirector can use this control file to interpret an LPD control file that accompanies an AFP print job received through the LPD print protocol. The format of the LPD control file depends on the operating system of the sending host. For example, an LPD control file received from Windows might contain this information:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

To use a control file, set the value of the Child workflow initialization step property for the input device to SetJobTypeFromRules or SetJobTypeFromFileName, and then set the value of the Child workflow parsing rules property to the path and file name of the control file. The SetJobTypeFromRules step uses the control file to set the workflow for the job, convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both; the SetJobTypeFromFileName step uses the control file for setting job properties. All the information in the control file is case-sensitive.

Note: You cannot use a control file to set job properties that are read-only in the Job Properties notebook.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the LPD control file parameters.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the LPD control file. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. The double quotation marks in the value are required.

A value of "RECORD" for the file mode causes RICOH ProcessDirector to read the information in the file on a record-by-record basis. The double quotation marks in the value are required.

ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the LPD control file parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the LPD control file. It is commented out in the sample file. You will probably not need to use it.

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow and job properties from the values in the LPD control file that was passed with the job. Some examples of the types of DEFINE statements that the section can contain are:

Example for Linux:

DEFINE ${Job.JobType} AS "PDF" WHEN (${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Name} AS "${ORIGNAME}"
DEFINE ${Job.Host.UserID} AS "${ORIGUSER}"
DEFINE ${Job.InputDatastream} AS "PDF" WHEN 
(${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Customer} AS "XYZ" WHEN 
(${ORIGUSER} == "xyzadmin") FINALLY QUIT

The DEFINE ${Job.JobType} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.JobType property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the workflow from the control file. It sets it using another method, such as by using the workflow that is assigned to the LPD input device.

The DEFINE ${Job.Name} statement sets the value of the Job.Name property to the name of the original input file.

The DEFINE ${Job.Host.UserID} statement is a non-conditional statement. In this example, RICOH ProcessDirector sets the value of the Job.Host.UserID job property to the value of the ORIGUSER parameter in the LPD control file. Therefore, if the original LPD control file that RICOH ProcessDirector receives contains origuser=annsmith, RICOH ProcessDirector sets the value of the Job.Host.UserID property to annsmith.

The DEFINE ${Job.InputDatastream} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.InputDataStream job property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the value of the Job.InputDataStream property.

The DEFINE ${Job.Customer} statement is a conditional statement that can cause RICOH ProcessDirector to stop reading any more DEFINE statements in the control file. If the condition that the statement defines is true, RICOH ProcessDirector stops reading the control file. If the condition is false, RICOH ProcessDirector continues to evaluate any other DEFINE statements that follow the FINALLY QUIT statement.

1.3.8.1.3 receive_lpd_pdf_jobtype.cfg

The sample receive_lpd_pdf_jobtype.cfg file sets the workflow and job properties for PDF jobs received through the LPD protocol.

RICOH ProcessDirector can use this control file to interpret an LPD control file that accompanies a PDF print job received through the LPD print protocol. The format of the LPD control file depends on the operating system of the sending host. For example, an LPD control file received from Windows might contain this information:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

To use a control file, set the value of the Child workflow initialization step property for the input device to SetJobTypeFromRules or SetJobTypeFromFileName, and then set the value of the Child workflow parsing rules property to the path and file name of the control file. The SetJobTypeFromRules step uses the control file to set the workflow for the job, convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both; the SetJobTypeFromFileName step uses the control file for setting job properties. All the information in the control file is case-sensitive.

    Note:
  • You cannot use a control file to set job properties that are read-only in the Job Properties notebook.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the LPD control file parameters.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the LPD control file. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. The double quotation marks in the value are required.

A value of "RECORD" for the file mode causes RICOH ProcessDirector to read the information in the file on a record-by-record basis. The double quotation marks in the value are required.

ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the LPD control file parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the LPD control file. It is commented out in the sample file. You will probably not need to use it.

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow and job properties from the values in the LPD control file that was passed with the job. Some examples of the types of DEFINE statements that the section can contain are:
DEFINE ${Job.JobType} AS "PDF" WHEN (${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Name} AS "${ORIGNAME}"
DEFINE ${Job.Host.UserID} AS "${ORIGUSER}"
DEFINE ${Job.InputDatastream} AS "PDF" WHEN 
(${ORIGHOST} == "mywindowshost")
DEFINE ${Job.Customer} AS "XYZ" WHEN 
(${ORIGUSER} == "xyzadmin") FINALLY QUIT

The DEFINE ${Job.JobType} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.JobType property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the workflow from the control file. It sets it using another method, such as by using the workflow that is assigned to the LPD input device.

The DEFINE ${Job.Name} statement sets the value of the Job.Name property to the name of the original input file.

The DEFINE ${Job.Host.UserID} statement is a non-conditional statement. In this example, RICOH ProcessDirector sets the value of the Job.Host.UserID job property to the value of the ORIGUSER parameter in the LPD control file. Therefore, if the original LPD control file that RICOH ProcessDirector receives contains origuser=annsmith, RICOH ProcessDirector sets the value of the Job.Host.UserID property to annsmith.

The DEFINE ${Job.InputDatastream} statement is a conditional statement. In the example, RICOH ProcessDirector sets the value of the Job.InputDataStream job property to PDF when the value of the ORIGHOST parameter from the LPD control file is mywindowshost. If the ORIGHOST parameter has any other value, RICOH ProcessDirector does not set the value of the Job.InputDataStream property.

The DEFINE ${Job.Customer} statement is a conditional statement that can cause RICOH ProcessDirector to stop reading any more DEFINE statements in the control file. If the condition that the statement defines is true, RICOH ProcessDirector stops reading the control file. If the condition is false, RICOH ProcessDirector continues to evaluate any other DEFINE statements that follow the FINALLY QUIT statement.

1.3.8.1.4 receive_text_jobtype.cfg

The sample receive_text_jobtype.cfg file sets the Workflow from a text overrides file.

The RICOH ProcessDirector-supplied SetJobTypeFromRules step can use the receive_text_jobtype.cfg control file to set the workflow from the jobID.overrides.text file. The step can also use this control file to convert an optional Job Definition Format (JDF) job ticket file, jobID.overrides.jdf, to a temporary text-based overrides file that it can use with the jobID.overrides.text file to set the workflow.

All the information in the control file is case-sensitive.

The control file contains these sections:

CONFIGURATION section
This is a global settings section consisting of keywords that define how RICOH ProcessDirector interprets the job ticket parameters.
FILE_MODE
This keyword controls how RICOH ProcessDirector processes the job ticket. A value of "FILE" instructs RICOH ProcessDirector to treat all the information in the file as a single record. In this mode, RICOH ProcessDirector can do search and replace actions. The double quotation marks in the value are required.

A value of "RECORD" for the file mode causes RICOH ProcessDirector to read the information in the file on a record-by-record basis. The double quotation marks in the value are required.

ATTRIBUTE_PATTERN
This keyword specifies a regular expression that defines how RICOH ProcessDirector recognizes the names of properties. As supplied by RICOH ProcessDirector, the value is "\$\{Job.*\}". The double quotation marks delimit the expression and the backslash characters are escape characters that precede the special characters in the expression.

The "\$\{Job.*\}" value instructs RICOH ProcessDirector to recognize property names as strings that begin with Job. and that are followed by zero or more characters. RICOH ProcessDirector job property names match this convention, such as Job.Duplex and Job.Print.CumulativeSheetsStacked.

KEYWORD_CASE
This keyword defines the case of the characters in the job ticket parameter names. Depending on settings on the sending system, parameters might be passed as all uppercase or all lowercase characters. Use a value of "UPPER" or "LOWER" based on the requirements of the installation.

Delimit the beginning and ending of the CONFIGURATION section with CONFIGURATION and ENDCONFIGURATION.

REPLACE section
This section uses sed commands to replace strings in the job ticket. It is commented out in the sample file. You will probably not need to use it.

Delimit the beginning and ending of the REPLACE section with REPLACE and ENDREPLACE.

PATTERN KEY_VALUE section
This section describes how RICOH ProcessDirector finds keywords and values, and converts them into tokens by using regular expression groups. As supplied by RICOH ProcessDirector, the section looks like this:
PATTERN KEY_VALUE
"(.*?)=(.*?),"
ENDPATTERN
The pattern is delimited by double quotation marks and the pattern to the left of the equals sign represents the keyword. The pattern to the right represents the value. This pattern creates a comma-delimited list of keyword and value pairs.
DEFINE statements section
This section uses symbol formulas to set the RICOH ProcessDirector workflow from a value in the job ticket that was passed with the job. This is the type of DEFINE statement that RICOH ProcessDirector typically uses to set the workflow:
DEFINE ${Job.JobType} AS "Transform"
DEFINE ${Job.JobType} AS "PDF" WHEN (${Job.InputDatastream} == "pdf")

The first DEFINE statement sets the default workflow. The second DEFINE statement is conditional. In this example, RICOH ProcessDirector sets the value of the Job.JobType property to PDF when the value of the Job.InputDatastream parameter in the text overrides file is pdf. If the Job.InputDatastream parameter has any other value, RICOH ProcessDirector uses the default workflow.

1.3.8.1.5 Using the -ooutbin parameter in JCL and LPD jobtype files

The receive_jcl_jobtype.cfg, receive_lpd_jobtype.cfg, and receive_lpd_pdf_jobtype.cfg control files provided with RICOH ProcessDirector map the value of the -ooutbin parameter to the Job.OutputBin property.

To use the -ooutbin parameter in JCL and LPD jobtype files:

  1. Fill in this table with information from your application, printers, and bins. Each row reflects information about one bin.
    Column 1: Values used in -ooutbin parameter (property value) Column 2: Name of the bin in Properties notebook (object name, outputBin name) Column 3: Printer model (printerModel name) Column 4: Printer bin number (binNumber)
    Example: 9 Example: Stacker9 Example: InfoPrint 2085 Example: 9
           
           
           
  2. Copy this text into a blank text file:
    <IPPD_UpdateData version="1.0" xmlns"xsi="http://www.w3.org/2001/
    XMLSchema-instance">
         <object name="Stacker9" type="OutputBin">
              <property name="OutputBin.BinNumber" value="9"/>
         </object>
         <printerModel name="InfoPrint 2085">
              <outputBin name="Stacker9" binNumber="9"/>
         </printerModel>
    </IPPD_UpdateData>
  3. Edit the text file with the values that you entered in the table:
    1. Copy the <object> and <printerModel> tag sets so you have one set for each row in the table.
    2. Use the values from column 1 for the value attribute of the property tag.
    3. Use the values from column 2 for the name attribute of both the object and outputBin tags.
    4. Use the values from column 3 for the name attribute of the printerModel tag.
    5. Use the values from column 4 for the binNumber attribute of the outputBin tag.
  4. Save the file.
  5. Click the Administration tab.
  6. In the left pane, click Utilities Import Objects.
  7. Click and navigate to the XML file that you just created. Click Open.
  8. Click Import.

1.3.8.2 Sample control file templates for Passthrough printers

RICOH ProcessDirector provides a sample control file template for use with Passthrough printers. This template is called passthru.cfg and is installed in: /aiw/aiw1/samples/passthru/ (Linux) or C:\aiw\aiw1\samples\passthru\ (Windows).

If the printer command that you specify for a Passthrough printer uses a control file, the control file that RICOH ProcessDirector generates from the control file template specifies options for the printer command. Authorized users can copy and modify the sample control file template that RICOH ProcessDirector provides. They then put the customized control file template in any directory that is accessible to RICOH ProcessDirector. Use the Control file template printer property to specify the name and location of the control file template.

    Note:
  • Updates might overwrite files in the /aiw/aiw1/samples/ (Linux) or C:\aiw\aiw1\samples\ (Windows) directory, but they do not overwrite files in the /aiw/aiw1/control_files (Linux) or C:\aiw\aiw1\control_files (Windows) directory. We recommend copying sample files into the /aiw/aiw1/control_files (Linux) or C:\aiw\aiw1\control_files (Windows) directory and making all your changes in the copied file.

The passthru.cfg control file template uses RICOH ProcessDirector symbol formulas to set printer command parameter values. These are examples of the entries in the control file template:

JobID=${Job.ID}

JobCopies=${Job.Copies}

PrinterId=${Printer.ID}

CustomerName=${Printer.CustomerName}
The keywords to the left of the equal sign are sample parameters.

Note: Not all printer commands can use control files. If yours can, it might use different parameter names.

The values to the right are symbol formulas for RICOH ProcessDirector job properties. Using JobCopies=${Job.Copies} as an example, RICOH ProcessDirector sets the value of the JobCopies parameter to the value of the Job.Copies job property. For example, if you wanted the original input filename preserved when the job was sent to the printer, you could substitute ${Job.Inputfile} for ${Job.ID} in the control file template entry for the JobID parameter.

1.3.8.3 Control files for the Archive feature

The RICOH ProcessDirector Archive feature can use an Associated properties file and a Document properties file as input to the StoreInRepository step. The Associated properties file defines properties you want to store in the repository that are associated with a job but are properties of other objects. The Document properties file is a tab-delimited file containing property values to store in the repository. Neither file is required for Archive processing, but they may be useful to capture data your company desires about the production history of a job in its workflow.
The Archive feature can also produce a file containing the properties stored about a job or document when it was written to the repository. That file is produced by the ExportFromRepository step template and is called the Export results file

1.3.8.3.1 Creating an associated properties file

You can create an associated properties file to specify one or more properties that are associated with a job, but that are properties of other objects. When a step based on the StoreInRepository step template runs, these properties and their values are stored in a repository along with job and document data. For example, you can store the model of the printer requested for a job or the color of the media specified to print a job.

    Note:
  • You can also specify positional job properties in an associated properties file and store their values in a repository. You cannot select a positional job property as a value for the Job properties to store property on the StoreInRepository step. In a workflow, the values of positional properties can be different for different steps based on the same step template.

Positional job properties

To store values for a positional job property, you specify the property, the phase that the step is in, the internal name of the step with the property, and a property label. The syntax is:

Job_property[Phase][Step_identifier]:Property_label

For example, you have the Automated Verification feature, and you want to store the name of the barcode reader that the ReadBarcodeData step in the Insert phase uses to track the documents in a job through an inserter.

When you create the associated properties file, you type this line into a text editor:

Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Property_label

The property label might be Job.BarcodeReader.

When the StoreInRepository step runs, RICOH ProcessDirector:

  1. Gets the value of the Barcode reader job property (database name Job.TrackAndTrace.BarcodeReader) for the ReadBarcodeData step in the Insert phase.

    This value might be BarcodeReader1.

  2. Stores the value of the Barcode reader property along with other information for the job and its documents in the repository.

To see whether a property on a step template is positional, click the ? icon and check the Usage notes in the help.

Properties associated with a job

To store the value for a property of another object, you must be able to create a chain of relationships to that property. The chain must start with a job property that specifies an object as a value. The next property in the chain must be a property of the object specified by the job property. The chain must end with the property whose values you want to store.

Although you can start the chain with any job property that specifies an object as a value, these job properties satisfy most needs.

Object User interface name of job property Database name of job property Base product or feature
Barcode reader Barcode reader Job.TrackAndTrace.BarcodeReader Automated Verification
Input device None Job.SourceInputDeviceName Base product
Inserter Inserter controller Job.InserterSystem.ID Inserter
Media Media Job.Media Base product
Printer Requested printer Job.RequestedPrinter Base product

The following line shows a simple version of the syntax for specifying associated properties:

Property_to_store@Job_property:Property_label
    Note:
  • If you chose Any printer on the PrintJobs step, you cannot use the Job.RequestedPrinter database name. Replace that name with Job.PreviousPrinter.

The system starts at the colon and reads the properties from right to left. The number of properties in the chain can vary. An @ symbol separates the properties. To the right of the colon is a property label. The property label is required.

These examples give the user interface names of properties with the database names in parentheses. Use the database names when you create the associated properties file.

  • You want to store values for the Printer model printer property (database name Printer.Model.Specific). You can chain the Requested printer job property (database name Job.RequestedPrinter) directly to the printer property.

    When you create the associated properties file, you type this line into a text editor:

    Printer.Model.Specific@Job.RequestedPrinter:Property_label

    The property label might be Job.PrinterModel.

    When the StoreInRepository step runs, RICOH ProcessDirector:

    1. Gets the value of the Requested printer property.

      This value might be Printer4.

    2. Uses the Printer. portion of the Printer.Model.Specific property to identify the next object in the chain: a printer object.
    3. Gets the value of the Printer model property for Printer4.

      This value might be Ricoh Pro C901.

    4. Stores the value of the Printer model property along with other information for the job and its documents in the repository.
        Important:
      • The link between the job property and the object portion of the next property is critical. You must link the Requested printer job property to a printer property. The database name of a printer property starts with Printer. An example at the end of this topic shows how to link a job property to another property through an intermediate property.

  • You have the Automated Verification feature, and you want to store values for the Barcode Format property (database name BarcodeReader.BarcodeFormat). You can chain the Barcode reader job property (database name Job.TrackAndTrace.BarcodeReader) directly to the Barcode Format property. Because the Barcode reader property is positional, you need to specify the Phase and Step identifier.

    You have two different steps that read barcodes, and the barcode readers in the two steps use a different barcode format. You want the barcode reader that the ReadBarcodeData step in the Insert phase uses.

    When you create the associated properties file, you type this line into a text editor:

    BarcodeReader.BarcodeFormat@Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Property_label

    The property label might be Job.BarcodeFormat.

    When the StoreInRepository step runs, RICOH ProcessDirector:

    1. Gets the value of the Barcode reader property for the ReadBarcodeData step in the Insert phase.

      This value might be BarcodeReader2.

    2. Uses the BarcodeReader. portion of the BarcodeReader.BarcodeFormat property to identify the next object in the chain: a barcode reader object.
    3. Gets the value of the Barcode Format property for BarcodeReader2.

      This value might be BarcodeFormat2.

    4. Stores the value of the Barcode Format property along with other information for the job and its documents in the repository.

To create an associated properties file:
  1. With a text editor, create a new file.
  2. Type a line for the first property whose values you want to store.

    Use this syntax:

    Property_to_store@Intermediate_property@Job_property[Phase][Step_identifier]:Property_label

    where:

    • Property_to_store is the database name of the property you want to store.
    • Intermediate_property is the database name of an intermediate property, if needed, that links the job property to the property you want to store by identifying an intermediate object, such as Media. If you need to specify two intermediate properties, separate them with an @ symbol.

      You can link many job properties directly to properties you want to store without an Intermediate_property.

    • Job_property[Phase][Step_identifier] has these parts:
      • Job_property is the database name of the job property that identifies an object such as a printer.

        If you are storing a positional job property, which you cannot select as a value for the Job properties to store property on the StoreInRepository step, Job_property is the database name of the positional job property. You do not need to specify any additional properties.

      • If the property is positional, Phase is the name of the phase that the step is in, and Step_identifier is the internal name of the step with the property.

        If the property is not positional, do not type a [Phase] or [Step_identifier].

    • Property_label is the name that appears on the Properties tab when you click Show details on the Results table of the Archive tab. We recommend the format Job.MyProperty. The property label for each property in the associated properties file must be unique.

    For example, you might type:

    Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Job.BarcodeReader

  3. If you want to store values for a second property, type a line break, and then repeat the previous step for the second property.

    For example, you might type:

    Printer.Model.Specific@Job.RequestedPrinter:Job.PrinterModel

  4. Save the text file.
    For example, you might name the file associatedproperties.txt.
  5. Send the associated properties file to the RICOH ProcessDirector server in a directory that the RICOH ProcessDirector system user has access to.

The file is now available to use as the value of the Associated properties file property for a StoreInRepository step in a workflow.

When the StoreInRepository step runs, RICOH ProcessDirector stores (with each document and job) the value of each stored property specified in the associated properties file.

  • If the value is null for any stored property on a line of the associated properties file, RICOH ProcessDirector stores a null value for the property.
  • If a property allows multiple selections, RICOH ProcessDirector stores the multiple selections separated by a vertical bar (|). For example, the value of a stored property might be BarcodeReader1|BarcodeReader2.
  • If multiple values are selected for both a job property and the associated object property, RICOH ProcessDirector adds an underscore and the name of the job property value to the property label. RICOH ProcessDirector stores each job property value separately. For example:
    Job.BarcodeFormat_BarcodeReader1    Job.BarcodeFormat_BarcodeReader2
    BarcodeFormat1|BarcodeFormat2          BarcodeFormat3

Users cannot search a repository for these properties. After you search on the Archive tab for job or document properties, RICOH ProcessDirector displays the values of associated properties on the Properties tab when you click Show details on the Results table.

Examples

Storing the model of the printer requested to print a job
  • File contents:
    Printer.Model.Specific@Job.RequestedPrinter:Job.PrinterModel
  • Value of Printer model property:
    Ricoh Pro C901
  • Information stored in the repository for a specific job and each document in the job:
    Job.PrinterModelRicoh Pro C901
  • Information displayed in the properties notebook for the results of a search:

    Job.PrinterModel: Ricoh Pro C901

      Note:
    • When processing an associated properties file, RICOH ProcessDirector does not store or display the value of the Job_property_identifying_object property or any Property_identifying_intermediate_object property.
    • If you chose Any printer on the PrintJobs step, you cannot use the Job.RequestedPrinter database name. Replace that name with Job.PreviousPrinter.

Storing the barcode format used by a barcode reader
  • File contents:
    BarcodeReader.BarcodeFormat@Job.TrackAndTrace.BarcodeReader[Insert][ReadBarcodeData]:Job.BarcodeFormat
  • Barcode readers selected on the ReadBarcodeData step:
    • BarcodeReader1
    • BarcodeReader2
  • Barcode formats selected for BarcodeReader1:
    • BarcodeFormat1
    • BarcodeFormat2
  • Barcode format selected for BarcodeReader2: BarcodeFormat3.
  • Information stored in the repository for a specific job and each document in the job:
    Job.BarcodeFormat_BarcodeReader1    Job.BarcodeFormat_BarcodeReader2
    BarcodeFormat1|BarcodeFormat2          BarcodeFormat3
  • Information displayed in the properties notebook for the results of a search:

    Job.BarcodeFormat_BarcodeReader1: BarcodeFormat1|BarcodeFormat2

    Job.BarcodeFormat_BarcodeReader2: BarcodeFormat3

Storing the reprint method used by an inserter
  • File contents:
    InserterSystem.ReprintMethod@Job.InserterSystem.ID:Job.InserterReprintMethod
  • Value of Reprint method property (database name InserterSystem.ReprintMethod):
    Open loop
  • Information stored in the repository for a specific job and each document in the job:
    Job.InserterReprintMethod
    Open loop
  • Information displayed in the properties notebook for the results of a search:

    Job.InserterReprintMethod: Open loop

Storing the folder location of the input device that received a job
  • File contents:
    InputDevice.FolderLocation@Job.SourceInputDeviceName:Job.InputDeviceFolder
  • Value of Folder location property (database name InputDevice.FolderLocation):
    /aiw/aiw1/System/hf/defaultPDF
  • Information stored in the repository for a specific job and each document in the job:
    Job.InputDeviceFolder
    /aiw/aiw1/System/hf/defaultPDF
  • Information displayed in the properties notebook for the results of a search:

    Job.InputDeviceFolder: /aiw/aiw1/System/hf/defaultPDF

Storing the color of the media requested to print a job
  • File contents:
    MediaType.Color@Media.MediaTypeID@Job.Media:Job.MediaColor
  • Value of Media color property (database name MediaType.Color):
    Ricoh Pro C901
  • Information stored in the repository for a specific job and each document in the job:
    Job.MediaColor
    Blue
  • Information displayed in the properties notebook for the results of a search:

    Job.MediaColor: Blue

    Note:
  • You can replace the Media color property with other media type properties such as Media weight (database name MediaType.Weight) and Media details (database name MediaType.Details).

    To store the values of a media size property, such as Media height (database name MediaSize.Height), use this line:MediaSize.Height@Media.MediaSizeID@Job.Media:Job.MediaHeight

1.3.8.3.2 Document properties file

The Document properties file contains values for document properties as well as properties that are not defined to RICOH ProcessDirector to be stored in a repository. The file can contain either or both types of properties that you want to store in the repository as part of your workflow. If the property is not defined as a RICOH ProcessDirector property, you cannot use it to retrieve a job or document from the archive, but you can see the value the job or document had for the property when it was stored.

If all of the property values to store are selected from the Document properties to store list, then the regular document properties file is used. If additional fields not known to RICOH ProcessDirector are used, then you must create a unique document properties file. This unique document properties file must be specified in the Document properties file property of the StoreInRepository step. Additionally, you must select ALL in the Document properties to store list to ensure that the values for the additional fields are saved in the document properties file.

The file requires a header row followed by value rows in a tab-delimited format like the regular document properties file. The data in the file might look like this: (spacing between entries has been altered for clarity)

Doc.Email.Address   Doc.Custom1.AwardLevel   Member since   Anvrsry date
John_Doe@mail.com   Gold                     3_1999         03_15
Jane_Doe@mail.com   Silver                   7_2009         07_23
Bob_Smith@mail.com  Tin                      9_2013         09_14

1.3.8.3.3 Export results file

The export results file contains values for document properties that you have chosen to export from the repository as a comma-separated value (CSV) file. The file is created by the ExportFromRepository step.

The properties to be exported are selected by a query as specified on the ExportFromRepository property notebook. The query can either be drawn from a file or from direct entry in the Search criteria property. You must choose either File or Text in the Criteria type property to specify the source of the query. The query must appear in the same format as the search criteria on the Results portlet on the Archive tab.

If more than one ExportFromRepository step is used in a workflow, the additional results overwrite the results from any previous ExportFromRepository step unless you specify different results files in the Export results file property of subsequent ExportFromRepository steps.

The export results file contains a header row followed by value rows in a comma-delimited format. The headers and the values are all enclosed in double quotes. Null value returns are indicated by a dash surrounded by double quotes (“-”). The data in the file might look like this:

"Doc.OriginalSequence","Doc.OriginalFirstPage","Job.TotalPages"
"1","1","4186"
"2","5","4186"
"4","13","4186"

1.3.9 Database property names

RICOH ProcessDirector messages might refer to properties by their database names instead of the field names that appear in property notebooks. Most of the database property names are similar to the names in the property notebooks, but they are written in a different format.

When you install RICOH ProcessDirector features, you add additional database properties. Lists of these database property names are found in the Information Center for RICOH ProcessDirector.

1.3.9.1 Database property names for jobs

Some messages about jobs refer to job properties by their database names, which begin with Job. You can use the database property names for job properties in symbol formulas that you specify for RICOH ProcessDirector external programs. You can also specify symbol formulas for job properties in RICOH ProcessDirector control files.

Some of the values that you see in lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the job has been submitted.
  • No means that you cannot change the value.

In the Job ticket column:

  • Yes means that the property can be set from one or more values in the job ticket that is used to submit the job.
  • No means that the property cannot be set from values in the job ticket.

Job properties
Database name Notebook tab: field name Brief description Internal values Editable Job ticket
Job.Add.BlankPage Add blank page Adds a blank page at the end of each PDF file with an odd number of pages when combining PDF files contained in a ZIP file.
  • No
  • Yes
Yes No
Job.Collate Print: Collation Specifies the type of collation that the printer uses when printing multiple copies of the job.
  • Not set
  • Off
  • Collate
Yes No
Job.Binding Binding Set the binding settings for the job you are printing.
  • None
  • Perfect
  • Ring
  • Ring and punch
Yes Yes
Job.Cjfx.FailOnMissingXpath XML: Stop when no matching elements Specifies whether a step based on the CreateJobsFromXML step template puts a job in the error state when no elements match the XPath expression.
  • No
  • Yes
Yes No
Job.Cjfx.FileToSplit XML: XML input file Specifies the name of the XML file that a step based on the CreateJobsFromXML step template uses as input to create jobs.   Yes No
Job.Cjfx.TypeOfJob XML: Create as child job Specifies whether a step based on the CreateJobsFromXML step template creates child jobs or independent jobs from the original job.
  • No
  • Yes
Yes No
Job.Cjfx.Workflow XML: Workflow for new jobs Specifies the workflow that a step based on the CreateJobsFromXML step template submits new XML jobs to.   Yes No
Job.Cjfx.Xpath XML: XPath expression to create jobs Specifies an XPath expression that identifies an element. Each time a step based on the CreateJobsFromXML step template finds a matching element in the XML input file, it creates an XML file and submits it as a job.   Yes No
Job.CompressAllFiles Job Defaults tab of RetainCompletedJobs step template property notebook: Compress all files Specifies whether to compress all spool and checkpoint files for the job when the job is retained.   Yes No
Job.CompressFilePatterns Job Defaults tab of CompressFiles step template property notebook: Compress file patterns Specifies the job files that the step compresses.   Yes No
Job.Copies General and Status: Job copies requested Contains the number of job copies that have been requested.   Yes Yes
Job.CopiesStacked Status: Job copies stacked Contains the current number of job copies that have completed printing and that have reached the output stacker of the printer device.   No No
Job.CreateJobFromFiles.JobType Create Job: Workflow Specifies the workflow to use for the child job.   Yes No
Job.CreateJobFromFiles.JobName Create Job: Job name Specifies the name of the child job.   Yes No
Job.CreateJobFromFiles.DestUsage Create Job: Group ID Specifies the role of the destination file.   Yes No
Job.CreateJobFromFiles.DestType Create Job: Group size Specifies the destination file type.   Yes No
Job.CreateJobFromFiles.Source1 Create Job: First source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source2 Create Job: Second source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source3 Create Job: Third source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source4 Create Job: Fourth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source5 Create Job: Fifth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source6 Create Job: Sixth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source7 Create Job: Seventh source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CreateJobFromFiles.Source8 Create Job: Eighth source file Specifies the full path and name of the input file used to create the job.   Yes No
Job.CurrentPrinter Status: Assigned printer Contains the name of the printer that RICOH ProcessDirector has assigned to print this job.   No No
Job.CustomerName Scheduling: Customer name Identifies the customer who is associated with this job.   Yes Yes
Job.Description General: Job description Contains text that describes the job.   Yes Yes
Job.DownloadFile URL for download file Specifies the URL of the file to download.   Yes No
Job.DownloadFileToCreate Path to downloaded file Specifies the file name and location where RICOH ProcessDirector saves the file.   Yes No
Job.Duplex General: Duplex Indicates whether duplexed printing is active for the job and, if so, the type of duplexed printing.
  • No
  • Tumble
  • Yes
Yes Yes
Job.EJB.SMTPserver SMTP server type Specifies whether you want this step to use the system default email server or an alternate email server.
  • System
  • Alternate
Yes No
Job.EmailAddressBCC Blind copy address One or more email addresses to send a blind copy of the email to.   Yes No
Job.EmailAddressCC Copy address One or more email addresses to send a copy of the email to.   Yes No
Job.EmailAddressTo Recipient address One or more email addresses to send the job to.   Yes No
Job.EmailMessage Message Specifies text to include in the body of the email.   Yes No
Job.Email.PageRange Page range to send Shows a numeric string that describes which pages in the print file are extracted, made into a separate file, and attached to the email.   Yes No
Job.Email.RangeData Stream Page range data stream Specifies the data stream of the print file used to create the file with the page range indicated in the Page range to send property.
  • Use current
  • AFP
  • PDF
Yes No
Job.Email.Secure Connection Secure connection Specifies whether the connection with the mail server should use SSL or TLS security.
  • None
  • SSL
  • TLS
Yes No
Job.EmailSendFrom Sender address The email address used in the From: field of the email.   Yes No
Job.EmailSubject Subject line Specifies the text to include in the subject line of the email.   Yes No
Job.External.CodePage External: External program code page Specifies the code page to use to write the contents of the files that are sent to the external command for processing, such as the control file template. This code page is also used to read messages that the external command writes to stderr and stdout, as well as other files that the external command might create.
  • UTF-8
  • ISO8859_1
  • ISO8859_15
  • EUC_JPEUC_JP
Yes No
Job.External.Command External: External command Specifies a command string that a step can execute during processing.   Yes No
Job.External.ControlFileTemplate External: External control file template Specifies the path and name of the control file template that the external command uses.   Yes No
Job.External.Language External: External program language Specifies what language the external command should use when it returns messages to RICOH ProcessDirector.
  • de_DE
  • en_US
  • es_ES
  • fr_FR
  • it_IT
  • ja_JP
Yes No
Job.External.ValidRCs External: Valid return codes Lists return code values that the external command can issue, that indicate that the command ran successfully. You can specify multiple return code values by separating the values with commas. For example, 0,4.   Yes No
Job.FileToEmail Attachments Specifies the full paths to one or more files that should be attached to the email and sent to the recipients.   Yes No
Job.FoldOptions Fold Options Specifies how to fold the job or large sheets in the job, whether to fold all the sheets together (overlap or collate), and whether the front side of the sheet ends up on the outside, rather than the inside, of the fold.
  • None
  • Z fold
  • Z fold for large paper
  • Double parallel fold
  • Gate fold
  • Letter fold in
  • Letter fold out
  • Saddle
  • Saddle down
Yes Yes
Job.HeaderConfig Header page configuration file Specifies the path to and the name of the configuration file that RICOH ProcessDirector uses to create the content and format of the header page placed before each file that is contained in the ZIP file. Authorized users can specify one of the configuration files for header pages that RICOH ProcessDirector provides, or specify a customized configuration file.   Yes No
Job.HotFolder.ApplicationLogFile Hot Folder: Application log file The directory where the external program stores its log files. You can specify this property.   Yes No
Job.HotFolder.FileToSend Hot Folder: File to send Names the file that RICOH ProcessDirector puts in the sending folder to submit to the external program. You can edit this property.   Yes No
Job.HotFolder.FileVerificationCount Hot Folder: File verification count The number of times that RICOH ProcessDirector polls the retrieval folder and finds that the size of the retrieved file has not changed before deciding that the retrieved file is complete.   Yes No
Job.HotFolder.PollInterval Hot Folder: Poll interval The time between 2 consecutive polls of the retrieval folder. The unit of time for the value can be seconds, minutes, or hours.   Yes No
Job.HotFolder.RetrievalFolder Hot Folder: Retrieval folder Names the output hot folder for the external program. RICOH ProcessDirector looks in the retrieval folder for the retrieved file using the retrieval pattern. You can edit this property.   Yes No
Job.HotFolder.RetrievalPattern Hot Folder: Retrieval pattern The pattern-matching string that RICOH ProcessDirector uses to identify a returned job in the retrieval folder.   Yes No
Job.HotFolder.RetrievedFile Hot Folder: Retrieved file The name to use to rename the retrieved file.   Yes No
Job.HotFolder.SendingFolder Hot Folder: Sending folder Names the hot folder where RICOH ProcessDirector puts the job file to send to the external program.   Yes No
Job.HotFolder.TimeOutInterval Hot Folder: Timeout interval The time in minutes before a job goes into an error state when the retrieved file is not found or not complete.   Yes No
Job.ID Displays in the properties notebook title. Contains a unique number that identifies the job on the system.   No No
Job.Info.Attr1 Information: Custom 1 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr2 Information: Custom 2 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr3 Information: Custom 3 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr4 Information: Custom 4 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr5 Information: Custom 5 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr6 Information: Custom 6 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr7 Information: Custom 7 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr8 Information: Custom 8 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr9 Information: Custom 9 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.Info.Attr10 Information: Custom 10 Contains information about the job that is not included in other properties because it is specific to your company or your processes.   Yes No
Job.InputDatastream General: Input data stream Specifies the format of data that the input file for this job contains.
  • afp
  • gif
  • jdf
  • jpeg
  • json
  • lcds
  • linedata
  • metacode
  • pcl
  • pdf
  • ps
  • text
  • tiff
  • unknown
  • xml
No Yes
Job.InputFile General: Input file name Contains the name of the original input file from which RICOH ProcessDirector created the job.   No Yes
Job.InputFile.Size General: Input file size (bytes) Specifies the size, in bytes, of the original input file that RICOH ProcessDirector used to create the job.   No No
Job.Instance General: Parent server Contains the name of the RICOH ProcessDirector server that owns the submit step for the input file.   No No
Job.JDF.JobID General: JDF job ID Shows the value of the job ID in the JDF job ticket received by RICOH ProcessDirector with the job.   No Yes
Job.JDF.JobPartID General: JDF part ID Shows the value of the part ID for the job in the JDF job ticket received by RICOH ProcessDirector with the job.   No Yes
Job.JobSize Status: Job size (sheets) Contains a calculated value that RICOH ProcessDirector uses when it schedules jobs to printers. It also uses the value of this property when a workflow uses the VerifyPrintedSheetCount step to validate the actual number of sheets that print for a job.   No No
Job.JobType General: Workflow Contains the name of the workflow that defines the processing phases and steps for the job.   No No
Job.JobType.History Status: Workflow history Contains a list of workflows that define processing phases and steps that the job has passed through and where you can restart the job.   No No
Job.Locations Scheduling: Requested location Specifies the location where the job should print.   Yes No
Job.Media Scheduling: Media (ready | supported | all) Specifies the media to use for the job.   Yes Yes
Job.MediaRequired Media required Shows the names of the media objects specified for the entire job or page exception. You cannot change the value of this property.   No Yes
Job.Name General: Job name Contains the name of the job.   Yes Yes
Job.OutputBin Scheduling: Output bin (requested | available | all) Specifies the output bin to use for the job.   Yes Yes
Job.OutputFormat Scheduling: Output format Used to specify whether the first page or the last page of a job prints first. The value can also indicate whether the job needs to be transformed to a different data stream before it is printed.
  • AtoZforAFP
  • AtoZforPDF
  • ZtoAforAFP
  • ZtoAforPDF
  • Transform
No No
Job.PageLength Transform: Transform page length (unit) Specifies the length in inches or millimeters of the image that the Transform program generates.   Yes No
Job.PageRange Print: Pages to print again Specifies which pages in the current job are printed again.   No No
Job.PageWidth Transform: Transform page width (unit) Specifies the width in inches or millimeters of the image that the Transform program generates.   Yes No
Job.PagesStacked Status: Pages stacked Contains the number of logical pages that have printed and that have reached the output stacker of the printer device.   No No
Job.PDF.ActionList Enhance PDF: Action list Specifies one or more actions that a step based on the EnhancePDF step template uses to manipulate or evaluate a PDF file.   Yes No
Job.PDFCheckResult Enhance PDF: PDF results check Shows whether the content of a PDF file meets PDF specifications. To check the content, you add a step based on the EnhancePDF step template to your workflow. In the step, specify the CheckPDF action with the -RPDproperty set to Job.PDFCheckResult.   No No
Job.PDF.FinisherOrderConfiguration PDF: Finisher order For 2-up printing, specifies whether to place the content on the left page first and then the right, or on the right page first and then the left.
  • LeftToRight
  • RightToLeft
Yes No
Job.PDF.NUpConfiguration PDF: N-Up Specifies how many pages print side by side on the same sheet.
  • 1
  • 2
Yes No
Job.PDF.Orientation PDF orientation Specifies the orientation to be used to print the job.
  • Not set (default)
  • Portrait
  • Landscape
No No
Job.PDF.PageRotationFromOriginal PDF: Additional page rotation Specifies whether to change the print orientation of the pages in the job beyond any rotation added by the Leading edge into finisher property.
  • 0
  • 90
  • 180
  • 270
Yes No
Job.PDF.RollConfiguration PDF: Leading edge into finisher Specifies which edge of the print job enters the finisher first.
  • JobEndEdgeIntoFinisher
  • JobStartEdgeIntoFinisher
Yes No
Job.Phase Status: Current phase Contains the name of the RICOH ProcessDirector phase that is currently processing the job.
  • Complete
  • Prepare
  • Print
  • Receive
No No
Job.PhaseProgress Status: Progress within the current phase Contains the progress status for the job within the phase that the Job phase property identifies.
  • Error
  • Manual
  • Staging
  • Working
No No
Job.Preview.AcceptedBy Preview Print: Accepted by Shows the user ID of the user who accepted the preview print.   No No
Job.Preview.AutoAccept Preview Print: Accept preview print automatically Specifies whether RICOH ProcessDirector accepts the preview print automatically and moves the job to the next step in the workflow.
  • No
  • Yes
Yes No
Job.Preview.PageRange Preview Print: Page range for preview print Shows a numeric string that describes which pages in the job are printed as samples in the PreviewPrint step.   Yes No
Job.Preview.Requested Printer Preview Print: Requested printer for preview print Specifies the name of the printer that the PreviewPrint step sends the preview print job to.   Yes No
Job.Print.AssignPrintTime Status: Assigned to printer Specifies the date and time when the printer received the job. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.Print.CumulativePagesStacked Status: Cumulative pages stacked Contains the total number of logical pages that have printed and reached the output stacker of the printer, including any reprinted pages.   No No
Job.Print.CumulativeSheetsStacked Status: Cumulative sheets stacked Contains the total number of physical sheets that have printed and reached the output stacker of the printer throughout the life of the job on the RICOH ProcessDirector system.   No No
Job.Print.EndPrintTime Status: Time printing completed Shows the date and time when the printer finished printing the job successfully. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.Print.HeaderConfig Banner Pages: Header page configuration file Specifies the path to and the name of the configuration file that RICOH ProcessDirector uses to create the content and format of the header page for the job.   Yes No
Job.Print.HeaderCopies Banner Pages: Header copies Contains the number of copies of the job header page that RICOH ProcessDirector should print before it begins to print the job itself.   Yes No
Job.Print.SpoolID General: Spool ID Identifies the spool ID that RICOH ProcessDirector generates for the job before it sends the job to its printer driver component.   No No
Job.Print.TrailerConfig Banner Pages: Trailer page configuration file Specifies the path to and the name of the configuration file that RICOH ProcessDirector uses to create the content and format of the trailer page for the job.   Yes No
Job.Print.TrailerCopies Banner Pages: Trailer copies Contains the number of copies of the job trailer page that RICOH ProcessDirector should print after the job prints.   Yes No
Job.Priority Scheduling: Job priority Contains the printing priority of the job.   Yes Yes
Job.ProcessGroupId General: Process group ID Specifies the number of the processing group, if any, to which the job belongs.   No No
Job.ProcessGroupOrder General: Process group order Identifies the position of the job, if any, in a group of jobs.   No No
Job.Punch Scheduling: Punch Specifies the number and position of holes to punch in the output.
  • 2_at_bottom
  • 2_at_left
  • 2_at_right
  • 2_at_top
  • 3_at_bottom
  • 3_at_left
  • 3_at_right
  • 3_at_top
  • 4_at_bottom
  • 4_at_left
  • 4_at_right
  • 4_at_top
  • Multiple_at_bottom
  • Multiple_at_left
  • Multiple_at_left
  • Multiple_at_top
Yes Yes
Job.ReprintCount Status: Reprint count Shows how many times a job has been reprocessed for printing.   No No
Job.RequestedPrinter Scheduling: Requested printer Contains the name of the printer that was requested for the job.   Yes Yes
Job.Resolution Transform: Transform resolution (dpi) For the standard transform features, specifies the resolution of the full page of image output that the data transform program generates. Specify a value that is appropriate for the model of the printer that prints the job.   Yes No
Job.RestartSteps Displays as the Phase and step list on the Process job again page Shows the phases and associated steps that authorized users can select to start processing the job again.   No No
Job.RetainDuration General: Retention period (unit) Controls the amount of time in minutes, hours, or days that RICOH ProcessDirector retains a job after it reaches the RetainCompletedJobs step in the Complete phase.   Yes Yes
Job.RetainStartTime General: Retention start time Contains the time at which the retention period for a job in the Complete phase began. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.SavedSearches Saved Filters Lets you select from the filters you previously saved to the Job table.   No No
Job.SetJobOverrides Job values file Specifies the full path and file name of a configuration file that is used to set property values.   Yes No
Job.SetJobOverrides Job values file Specifies the full path and file name of a configuration file that is used to set property values.   Yes No
Job.SheetsStacked Status: Sheets stacked Shows the number of physical sheets that have printed and that have reached the output stacker of the printer device.   No No
Job.SnapshotJobFile.FileToBeCopied File type to be copied Specifies the usagetype and datatype of the file this step should find in the spool directory and copy for later use.   Yes No
Job.SnapshotJobFile.NewFileDescriptor Snapshot file descriptor The text that the step inserts in the file name between the job ID and the datatype when it saves the snapshot of the job file.   Yes No
Job.SourceInputDeviceName General: Source input device Shows the name of the input device for the job on the system where the job originated.   No No
Job.SpoolFileStem General: Root file path Specifies the directory location for all files associated with this job.   No No
Job.Staple Scheduling: Staple Specifies the number and position of staples to use in the output.
  • 2_at_bottom
  • 2_at_center
  • 2_at_left
  • 2_at_right
  • 2_at_top
  • Bottom_left
  • Bottom_right
  • Top_left
  • Top_left_diagonal
  • Top_left_horizontal
  • Top_left_vertical
  • Top_right
  • Top_right_diagonal
  • Top_right_horizontal
  • Top_right_vertical
Yes Yes
Job.StapleRequired Stapling required Shows whether this job or any of its page exceptions must be stapled. You cannot change the value of this property.   No Yes
Job.State Status: Current job state Contains the current processing state of the job.
  • Assigned
  • Complete
  • Creating
  • Error
  • ManualWaiting
  • ManualWorking
  • Printing
  • Processing
  • Queued
  • Release
  • Retained
  • Spooling
  • Stopped
  • Unassigned
  • Waiting
No No
Job.Step Status: Current step Contains the name of the step that is processing the job.   No No
Job.StopAtPhase Status: Stop when entering phase Specifies whether RICOH ProcessDirector stops a job when it enters the first step of a specific phase.
  • Complete
  • Prepare
  • Print
  • Receive
Yes No
Job.SubmitTime Scheduling: Time submitted Contains the date and time when the input device submitted the input file and created the corresponding RICOH ProcessDirector job. Dates and times are stored as Universal Time Code (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No No
Job.TestJob General: Test job Specifies whether the job is a test job or a production job.
  • No
  • Yes
Yes No
Job.TotalPages Status: Total pages Contains the total number of logical pages in the job.   No No
Job.TotalSheets Status: Total sheets Contains the total number of physical sheets in the job.   No No
Job.TrailerConfig Trailer page configuration file Specifies the path and name of the configuration file that RICOH ProcessDirector uses to create the content and format of the trailer page placed after each file that is contained in the ZIP file. Authorized users can specify one of the configuration files for trailer pages that RICOH ProcessDirector provides or they can specify a customized configuration file.   Yes No
Job.UseProxy Use proxy server Specifies whether the DownloadFile step uses a proxy server to resolve the URL of the file to be downloaded.
  • No
  • Yes
Yes No
Job.Validate.FileTo Check File Structure: File to check Specifies the full path and name of the JSON or XML file that a step based on the CheckFileStructure step validates by checking the file syntax.   Yes No
Job.Validate.FileType Check File Structure: File format Specifies the format of the file that a step based on the CheckFileStructure step template validates.
  • XML
  • JSON
Yes No
Job.Wait.Amount Wait: Wait for Specifies the amount of time the job waits before moving to the next step.   Yes No
Job.Wait.TimeOfDay Wait: Wait until Specifies the specific time when the job moves to the next step.   Yes No
Job.Wait.TimeZone Wait: Time zone Specifies the time zone to use with the Wait until property.   Yes No
Job.Wait.WaitUntil Wait: Wait step ends Shows the date and time when the waiting period ends and the job moves to the next step.   Yes No
Job.Wait.WhenToMove Wait: Complete step after When values are set for both the Wait until and the Wait for properties, this property specifies whether the Wait step completes when the earlier or later of the two times is reached.
  • First occurs
  • Last occurs
Yes No
Job.WaitReason Status: Reason for wait status Identifies the condition that is preventing RICOH ProcessDirector from further processing of the job.
  • DeviceUnavailable
  • NoMatchingDevice
  • ServerUnavailable
  • StepTemplateDisabled
No No
Job.XML.JSONInputFile XML: JSON input file Specifies the JSON file to be converted into XML format.   Yes No
Job.XML.XMLOutputFile XML: XML output file Specifies the location and name of the XML file created by the step.   Yes No
Job.ZipFIle.FilesToZip ZIP Files: Files to ZIP Specifies a comma-separated list of files that a step based on the ZIPFiles step template copies to create a ZIP file.   Yes No
Job.ZipFIle.ZipToSave ZIP Files: Output file Specifies the full path and name of the output file created by a step based on the ZIPFiles step template.   Yes No
Job.ZipFilesToEmail Email: Attach ZIP file Specifies whether the file or files should be packaged as a ZIP file before they are attached to the email.
  • No
  • Yes
Yes No

1.3.9.2 Database property names for workflows

Messages about jobs might refer to workflow properties by their database names, which begin with JobType.

In the Editable column:

  • Yes means that an authorized user can change the value after the workflow has been created.
  • No means that an authorized user cannot change the value.

Workflow properties
Database name Notebook field name Brief description Editable
Connector.AnyOrAllFieldHelp Apply any or all of the following conditions Specifies whether a job must meet all of the conditions specified by a rule or any one of the conditions. Yes
Connector.ConditionPredicate Summary The Summary field shows your selections in the Conditions area in a database query format. The value changes as you modify conditions. Yes
Connector.JsonRule Conditions Lets you define one or more conditions for a rule. Each condition consists of a job property, a comparison, and a value. Yes
Connector.Order Order of execution When multiple connectors exit a single step, RICOH ProcessDirector must determine which connector the job should follow to the next step. This value indicates which connector RICOH ProcessDirector should evaluate first, second, third, and so on, when it tries to choose which connector the job should use. Yes
Job.CurrentDay Current day Specifies the current day of the week of the server RICOH ProcessDirector is running on when a condition requesting it is evaluated. Yes
Job.CurrentTime Current time Specifies the current time of the server that RICOH ProcessDirector is running on when a condition requesting it is evaluated. Yes
JobType.ChangeId Alternate ID Specifies an alternate ID for the workflow. Yes
JobType.CreatedBy Created by Specifies the ID of the extension that created the workflow. No
JobType.Description Description Contains text that describes the workflow. Yes
JobType.GroupName Group name Specifies the name of the group the workflow belongs to. Yes
JobType.LastModified Last modified The date and time that the workflow was last changed. No
JobType.Location Workflow location Specifies the location associated with a workflow. Yes
JobType.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this workflow. No
JobType.Owner Owner Specifies the owner of the workflow. Yes
JobType.SourceID Source ID Specifies the ID of the workflow. No
StepChain.Color Color Specifies the color of the step chain as it appears in the workflow. Yes
StepChain.Description Step chain description Describes the function of the step chain. Yes
StepChain.ID Step chain name Specifies the name for the step chain. No
StepChain.LastModified Last modified The date and time that the step chain was last changed. No
StepChain.ModifiedBy Modified by user Specifies the name of the user who made the last change to this step chain. No
StepChain.Owner Owner Specifies the owner of the step chain. Yes
StepChain.Usage Step chain usage Specifies what the group of steps in the step chain are used for. Yes

1.3.9.3 Database property names for printers

Messages about printers might refer to properties by their database names. Not all properties are applicable to all types of printers.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the printer has been created.
  • No means that an authorized user cannot change the value.

Printer properties
Database name Notebook tab: field name Brief description Internal values Editable
CustomPDFPrinter.ImportPrinter General: Custom PDF Printer Server Select the printer server where you want to define a Custom PDF printer device.   No
CustomPDFPrinter.PrinterType General: Custom printer type Specifies the type of printer to define as a Custom PDF printer object.   Yes
JdfDirectPrinter.VPName General: Virtual printer name Specifies the name of the virtual printer as defined on the Ricoh TotalFlow printer object.   Yes
JdfOutputPrinter.PrinterType General: Type of printer Specifies the printer type. The list of all printers that can be connected as Ricoh PDF printers. Yes
JdfOutputPrinter.BannerPage.Tray Banner Pages: Banner page input tray Specifies the printer’s input tray that holds the paper for header and trailer pages.   Yes
JdfOutputPrinter.JobStatusPolling General: Job status polling interval Defines how frequently the Ricoh PDF or Custom PDF printer requests updates about the status of a job.   Yes
JdfOutputPrinter.MergeBanner Banner Pages: Merge banner pages into PDF print file Specifies whether or not header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
JdfOutputPrinter.Port General: Printer port Specifies the communications port for the printer.   Yes
JdfOutputPrinter.URL General: Printer URL Specifies the host name or TCP/IP address that is used to communicate with the printer.   Yes
PassThroughPrinter.CodePage General: Code page Specifies the code page that the printer uses to interpret the printer command.   Yes
PassThroughPrinter.Command General: Printer command The command that is used to submit jobs to the printer.   Yes
PassThroughPrinter. ControlFileTemplate General: Control file template Specifies the full path name of the control file template that maps job properties to printer command parameters.   Yes
PassThroughPrinter.MergeBanner Banner Pages: Merge banner pages into PDF print file Specifies whether or not header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
PassThroughPrinter.ValidRCs General: Valid return codes Contains a list of return code values that the printer command can issue to indicate that the job printed successfully.   Yes
Printer.CommunityName SNMP: Community name Specifies the name of the Simple Network Management Protocol (SNMP) community to which the printer belongs.   Yes
Printer.CurrentJobID Status: Current job number Specifies the job number of the job that is currently assigned to the printer.   No
Printer.CurrentJobName Status: Current job name Specifies the name of the job that is currently assigned to the printer.   No
Printer.CurrentJobPagesStacked Status: Current job pages printed Shows the number of pages that have been printed for the job that is currently assigned to the printer.   No
Printer.CurrentJobProgress Status: % Printed Shows the current page that is printing for the job that is currently assigned to the printer, as a percentage of the total pages in the job.   No
Printer.CurrentJobTotalPages Status: Total pages in current job Shows the total number of pages in the job that is currently assigned to the printer.   No
Printer.CurrentStatus Status: Last status message If the printer status is Disconnected or Needs attention, contains the most recent error or warning message received about the printer. Otherwise, contains the most recent informational message received about the printer.   No
Printer.CustomerName Scheduling: Customer name Specifies the customer name that is assigned to the printer.   Yes
Printer.Description General: Printer description Contains text that describes the printer object.   Yes
Printer.Enabled Status: Enabled status Specifies whether RICOH ProcessDirector can schedule jobs to the printer.   No
Printer.EnhancePDFFilter General: Action list Specifies one or more actions that can be applied to a PDF file and JDF file before it is sent to the Ricoh PDF or Ricoh TotalFlow printer.   Yes
Printer.FirstSegmentSize General: PDF first segment size Specifies the size, in pages, of the first PDF job segment that is sent to the printer.   No
Printer.FoldCapable Scheduling: Folding capable Specifies whether the printer can fold pages in different ways depending on the job assigned.   Yes
Printer.HeaderExit Banner Pages: Enable header pages Controls whether the printer prints a header page at the beginning of each job.
  • No
  • Yes
Yes
Printer.ID Displayed in the properties notebook title: Printer name Contains the name of the printer.   No
Printer.Instance General: Printer server Specifies the name of the RICOH ProcessDirector server that sends jobs to this printer.   Yes
Printer.JobSize Scheduling: Job size supported Specifies the size of the jobs in sheets that RICOH ProcessDirector can schedule to the printer.   Yes
Printer.Language General: Printer language Indicates what language the printer driver component uses when it returns messages to RICOH ProcessDirector.   Yes
Printer.LastModified General: Last modified The date and time that the printer was last changed.   No
Printer.Locations Scheduling: Printer location Specifies the location of the printer.   Yes
Printer.MaxConcurrentJobs General: Maximum concurrent jobs Specifies the maximum number of jobs that the printer driver component of RICOH ProcessDirector can control at the same time.   Yes
Printer.Media Scheduling: Media supported Specifies the media that the printer supports.   Yes
Printer.MediaCatalog Media: Media to use Specifies whether the media information sent to the printer for a job is system media or printer media.
  • Printer
  • System
Yes
Printer.Model General: Printer paper type Contains the type of the printer; for example, continuous-form or cut sheet.   Yes
Printer.Model.Specific General: Printer model Contains the model number of the printer.   Yes
Printer.ModifiedBy General: Modified by user Specifies the user name of the user who made the last change to this printer.   No
Printer.OutputBin Scheduling: Output bins available Lists the output bins that can be installed on the printer.   Yes
Printer.OutputFormat Scheduling: Output format Specifies whether the printer is set up to print the first page or the last page of a job first, usually based on finishing or other post-processing requirements. The value can also indicate that the job must be transformed to a different datastream before it can be printed.
  • AtoZforAFP
  • AtoZforPDF
  • ZtoAforAFP
  • ZtoAforPDF
  • Transform
Yes
Printer.PerfectBindingCapable Scheduling: Perfect binding capable Specifies whether the printer can glue a cover onto the binding edge of paper.   Yes
Printer.PunchCapable Scheduling: Punch capable Specifies whether a finisher attached to the printer can punch holes in the output.   Yes
Printer.Retry Connection: Printer connection retry count Specifies how many times RICOH ProcessDirector tries to connect to the printer if an earlier attempt failed.   Yes
Printer.RetryInterval Connection: Retry interval Specifies how often RICOH ProcessDirector tries to connect to the printer if an earlier attempt failed.   Yes
Printer.RingBindingCapable Scheduling: Ring binding capable Specifies whether the printer can insert rings along the binding edge of paper.   Yes
Printer.S2VBarcode AFP: Send blank pages after job Specifies the number of blank pages to send to the printer after the last job that is queued to the printer prints.   Yes
Printer.SegmentSize General: PDF segment size Specifies the size, in pages, of PDF job segments that are sent to the printer.   Yes
Printer.SerialNumber Status: Serial number Contains the serial number of the printer.   No
Printer.SNMPStatus Status: SNMP status Indicates whether SNMP is connected, disconnected, or disabled.   No
Printer.StapleCapable Scheduling: Staple capable Specifies whether a finisher attached to the printer can staple the output.   Yes
Printer.Status Status: Printer status Contains the current status of the printer.   No
Printer.TCPIP.Address General: Printer TCP/IP address or host name Specifies either the network TCP/IP address or the fully qualified host name of the printer hardware.   Yes
Printer.TrailerExit Banner Pages: Enable trailer pages Specifies whether the printer prints a trailer page at the end of each job.
  • No
  • Yes
Yes
Printer.UseSNMP SNMP: Use SNMP Specifies whether RICOH ProcessDirector uses SNMP to monitor the printer.   Yes
Printer.UseSnmpUpdateMedia SNMP: Get tray information from printer Specifies whether RICOH ProcessDirector uses the Simple Network Management Protocol (SNMP) to update media.
  • No
  • Yes
Yes
Printer.Version Status: Version Contains the printer version returned by SNMP.   No

1.3.9.4 Database property names for media

Messages about media might refer to properties by their database names, which begin with Media.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the media has been created.
  • No means that an authorized user cannot change the value.

In the Job ticket column:

  • Yes means that the property is compared to one or more values in the job ticket that is used to submit the job in order to set the Media property for the job.
  • No means that the property is not compared to values in the job ticket.

Media properties
Database name Field name Brief description Internal values Editable Job ticket
Media.Description Media description Contains user-defined text that describes the media.   Yes No
Media.ID Displayed in the properties notebook title: Media name Contains the name of the media.   No Yes
Media.LastModified Last modified The date and time that the media was last changed.   No No
Media.MappedMedia Mapped system media Specifies the system media that you want to map to this printer media.   Yes Yes
Media.MappedMedia.PrinterFilter Printer Specifies what printers to display media mappings for in the table.
  • All
Yes Yes
Media.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this media.   No No
Media.Printer Printer Specifies the name of the printer that this printer media is associated with.   No Yes
Media.ProductId Product ID Specifies the product ID of the media. This property is used only with jobs sent to Ricoh PDF printers with a Data stream to send value of JDF/PDF.   Yes Yes
Media.SendName Send media name in job ticket Specifies whether the media name is sent to the Ricoh PDF printer in the JDF job ticket.   Yes No
MediaSize.Height Media height Specifies the height of the media.   Yes Yes
MediaSize.Units Media units Specifies the unit of measure for the media height and width.
  • Inches
  • Millimeters
  • Points
Yes No
Note: Media dimensions in the job ticket are always in points.
MediaSize.Width Media width Specifies the width of the media.   Yes Yes
MediaType.Color Media color Specifies the color of the media.
  • Blue
  • Buff
  • Goldenrod
  • Gray
  • Green
  • Ivory
  • None
  • Orange
  • Pink
  • Purple
  • Red
  • User
  • White
  • Yellow
Yes Yes
MediaType.Details Media details Specifies the general category to which the media belongs; for example, letterhead or transparency.
  • Bond
  • Cardstock
  • Envelope
  • Labels
  • Letterhead
  • Paper
  • Special
  • Tabstock
  • Translucent
  • Transparent
Yes Yes
MediaType.Preprinted Media is preprinted Specifies whether the media is preprinted.
  • No
  • Yes
Yes Yes
MediaType.Punched Media is prepunched Specifies whether the media is prepunched.
  • No
  • Yes
Yes Yes
MediaType.Recycled Media is recycled Specifies whether the media is recycled.
  • No
  • Yes
Yes Yes
MediaType.Weight Media (gsm) Specifies the weight of the media in grams per square meter (gsm).   Yes Yes

1.3.9.5 Database property names for input devices

Messages about input devices might refer to properties by their database names. Some properties are specific to Hot folder input devices; their database property names begin with HotFolder. Others are specific to Download input devices; their database property names begin with zOSDownload. Properties whose names begin with InputDevice apply to all types of input devices.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the input device has been created.
  • No means that an authorized user cannot change the value.

Input device properties
Database name Notebook tab: field name Brief description Internal values Editable
HotFolder.CodePage General: Device code page The code page that the input device uses to read the contents of any files that accompany the print files, such as trigger files and list files.
  • euc_jp
  • iso8859_1
  • iso8859_15
  • utf8
Yes
HotFolder.SetPattern Batching: Matching pattern for sets Specifies the file name pattern that an input device uses when it creates sets. This pattern is a regular expression that indicates the portion of the input file names that must match within a set. The input files that make up a set are determined by the values for the Data patterns, JDF patterns, Overrides patterns, and File Patterns properties.   Yes
InputDevice.BatchingMethod Batching: Batching method Specifies how the input device groups multiple input files or sets of files and submits them as a single job or parent and child jobs. You can change this value for Hot folder input devices, but not for Download input devices or for LPD input devices.
  • AutoBatch
  • JDF
  • ListFile
  • MVSOutGrp
  • None
  • PatternBased
  • NumberOfFiles
  • NumberOfPages
  • NumberOfSets
  • PagesInSets
  • SetsByTime
  • Time
Yes (HotFolder) No (Download, LPD)
InputDevice.Child.InitJobTypeStep General: Child workflow initialization step Specifies the name of the step that the input device uses to initialize the workflow for single jobs or child jobs, convert an optional overrides file submitted with a job to a text file in property name=value format for setting job properties, or both.   Yes
InputDevice.Child.JobType General: Child workflow Specifies the name of the workflow that the input device assigns to jobs that contain only a single file or jobs that are children of a parent job.   Yes
InputDevice.Child. JobType ParsingRules Advanced: Child workflow parsing rules Contains the path and file name of a control file.   Yes
InputDevice.Child. JobTypeFilename Pattern Advanced: Child workflow pattern Contains a pattern-matching string that indicates what part of the file name should be used for the workflow for single and child jobs.   Yes
InputDevice. ConvertOverrides Advanced: Convert overrides Specifies whether a control file is required to convert the overrides file submitted with a job to a job properties file in RICOH ProcessDirectorproperty name=value format.
  • No
  • Yes
Yes (HotFolder) No (Download, LPD)
InputDevice.CreateZip Batching: Create .zip file Specifies whether the input device submits data files as individual jobs or collects them in a .zip file and submits them as a single job.
  • No
  • Yes
Yes
InputDevice.Description General: Input device description Contains text that describes the input device.   Yes
InputDevice.Enabled Status: Enabled status Specifies whether this input device can submit input files that it receives to create the corresponding RICOH ProcessDirector jobs.
  • No
  • Yes
No
InputDevice.FileCompletion Advanced: Completion method Specifies how the input device determines that file transmission is complete for an input file.
  • CheckOpen
  • CheckSize
  • None
  • Trigger
Yes (HotFolder) No (Download, LPD)
InputDevice.FileDataPatterns Batching: Data patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify the input files that the input device should accept for processing as single jobs.   Yes (HotFolder) No (Download, LPD)
InputDevice.FileJDFPatterns Batching: JDF patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify Job Definition Format (JDF) job tickets.   Yes (HotFolder) No (Download, LPD)
InputDevice.FileListPatterns Batching: List patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify list files.   Yes (HotFolder) No (Download, LPD)
InputDevice.FileOtherPatterns Batching: Overrides patterns Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify files that it must process with a list file and the input files that the list file specifies, or with another single input file.   Yes (HotFolder) No (Download, LPD)
InputDevice. FileTrigger Patterns Advanced: Trigger patterns Contains one or more user-defined pattern-matching strings that RICOH ProcessDirector uses to identify trigger files.   Yes (HotFolder) No (Download, LPD)
InputDevice.FolderLocation General: Folder location Contains the name of the directory that the input device monitors for incoming jobs.   Yes
InputDevice.Frequency Batching: Batching interval Indicates the time interval used to submit a batch of input files.   Yes
InputDevice.ID Displayed in the property notebook title Contains the name of the input device.   No
InputDevice.InitJobTypeStep General: Workflow initialization step Specifies the name of the step that the input device uses to initialize the parent workflow for the input files that the input device receives, convert an optional overrides file submitted with a job to a text file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both.   Yes
InputDevice.Instance General: Parent server Specifies the name of the RICOH ProcessDirector server that receives and records messages for this input device.   Yes
InputDevice.JobType General: Workflow Specifies the name of the workflow that the input device assigns to the job.   Yes
InputDevice. JobTypeFilename Pattern Advanced: Parent workflow pattern Contains a pattern-matching string that indicates what part of the file name should be used for the workflow for the parent job.   Yes
InputDevice. JobTypeParsing Rules Advanced: Parent workflow parsing rules Contains a path and file name of a control file.   Yes
InputDevice.LastModified General: Last modified The date and time that the input device was last changed.   No
InputDevice.Locations General: Input device location Contains the location associated with the input device.   Yes
InputDevice.MaxErrors General: Maximum errors Contains the number of communication errors that can occur for the input device before RICOH ProcessDirector disables the input device.   Yes
InputDevice.ModifiedBy General: Modified by user Specifies the user name of the user who made the last change to this input device.   No
InputDevice.NumberOfFiles Batching: Number of files to batch Specifies the number of files that are combined in a single submission when you choose the Number batching method in the General tab.   Yes
InputDevice.NumberOfPages Batching: Number of pages to batch Specifies the maximum number of PDF pages that should be combined in a single submission when you choose the Pages batching method in the General tab.   Yes
InputDevice.PageThreshold Batching: Exceed pages to batch Specifies whether the Hot folder should include the file that exceeds the value for the Number of pages to batch property when it submits a collection of PDF files.   Yes
InputDevice.PollInterval General: Polling interval (unit) Specifies the time interval at which RICOH ProcessDirector checks for files in the directory that the Folder location property of the Hot folder input device specified.   Yes
InputDevice.ScheduleDaily Batching: Frequency (days) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleHourly Batching: Frequency (hours) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleMinute Batching: Frequency (minutes) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleMonthly Batching: Frequency (months) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.ScheduleWeekly Batching: Frequency (weeks) Specifies how often the input device submits a batch of input files.   Yes
InputDevice.StagingLocation General: Staging location Contains the name of the directory into which the input device moves the input file before submitting it as a job.   Yes
InputDevice.StartDate Batching: Batching start date Specifies the date when the Time batching method takes effect for the input device.   Yes
InputDevice.StartDateAndTime Batching: Batching start date and time Specifies the date and time when the Time or Sets by time batching method takes effect for the input device.   Yes
InputDevice.Status Status: Connection status Lists the current status of the input device: connected, disconnected, or unable to connect.
  • Connected
  • Disconnected
  • UnableToConnect
No
InputDevice.SubmitStep General: Submit step Contains the name of the submit step to which the input device sends the input file for job processing.   Yes
InputDevice.WaitingFileCount Status: Input files waiting Contains the number of input files that the input device has received but has not yet submitted to create the corresponding RICOH ProcessDirector jobs.   No
InputFilePattern.FilePattern Batching: File Pattern Specifies one or more file pattern-matching strings.   Yes
InputFilePattern.Required Batching: File pattern required Specifies whether a file that matches the input file pattern must exist in the Hot folder before submitting the job.
  • No
  • Yes
Yes
InputFilePattern.Sequence Batching: File pattern sequence Specifies the priority of the file pattern. Patterns are checked in this order.   Yes
InputFilePattern.SpoolFileType Batching: Spool file type Specifies the content or the data stream type of the file.   Yes
InputFilePattern.SpoolFileUsage Batching: Spool file usage Specifies the purpose or role of the file within the job.   Yes
LPD.Codepage General: Device code page Specifies the code page that the LPD input device uses to read the contents of any files that accompany the print files, such as control files and list files.
  • euc_jp
  • iso8859_1
  • iso8859_15
  • utf8
Yes

1.3.9.6 Database property names for input files

Messages about input files might refer to properties by their database names, which begin with InputFile.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the input file has been created.
  • No means that an authorized user cannot change the value.

Input file properties
Database name Column heading: Input files table Brief description Internal values Editable
InputFile.JobType Workflow Contains the name of the workflow that the input device assigns to the input file when it submits the file for job processing.   No
InputFile.Location Input file Specifies the path to and the name of the input file.   No
InputFile.Status Status Contains the current status of the input file.
  • Error
  • Processing
  • Queued
  • Waiting
No
InputFile.SubmitGroup Group Identifies a member of a set of input files that were submitted as a group through a list file.   No
InputFile.SubmitType Submit type Contains the submission type for the input file.
  • AIWList
  • Data
  • List
  • Other
  • Trigger
 
InputFile.Timestamp Rec'd Contains the date and time when the input file arrived at the input device. Dates and times are stored as Coordinated Universal Time (UTC) values in this timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff
  • yyyy is the 4-digit year.
  • mm is the 2-digit numerical abbreviation for the month.
  • dd is the 2-digit day.
  • hh is the 2-digit hour.
  • mm is the 2-digit minute.
  • ss is the 2-digit second.
  • fffffffff is the fraction of a second to 9 decimal places and is optional.
No

1.3.9.7 Database property names for notification objects

Messages might refer to Notification properties.

In the Editable column:

  • Yes means that an authorized user can change the value.
  • No means that an authorized user cannot change the value.

Workflow properties
Database name Notebook field name Brief description Editable
User.EmailAddress Email address Specifies the email address for the user. Yes
Notification.AnyAllCustom Apply any or all of the following conditions Specifies how the conditions for a notification object are combined. Yes
Notification.BCC Blind copy address One or more email addresses to send a blind copy of the notification email to. This value is used in the BCC: field of the email. Yes
Notification.CC Copy address One or more email addresses to send a copy of the notification email to. This value is used in the CC: field of the email. Yes
Notification.Condition Conditions Lets you define one or more conditions for a notification object. Conditions limit the notifications that are sent for the specified event. Each condition consists of an object property, a comparison, and a value. Yes
Notification.Condition.NotifyWhen Notify when Specifies how the conditions for a notification object are combined. Yes
Notification.Description Notification description The description might indicate when a notification is sent. For example, the description might say: "Email second shift operators if any printer is disabled after midnight." Yes
Notification.EmailMessage Message Specifies the message to include in the body of the notification email. Messages can consist of plain text, HTML, and embedded images. Yes
Notification.EmailSubject Subject line Specifies the text to include in the subject line of the notification email. Yes
Notification.Enabled.Description Enabled status Specifies whether this notification object can send a notification. No
Notification.Event Event Lets you define one or more properties to monitor for a notification object. Each event consists of an object property, an action, and optionally a value. The type of object whose properties are shown is set in the Event type property on the General tab of the Notification property notebook. Yes
Notification.EventType Event type Specifies the type of object to be monitored for notification. You can only use one type of Event type for each notification object. Yes
Notification.ID Notification name Specifies the name of the notification object. No
Notification.JsonCondition Conditions Lets you define one or more conditions for a notification object. Conditions limit the notifications that are generated for the specified event. No
Notification.SecureConnection Secure connection Specifies whether the connection with the mail server should use SSL or TLS security for sending notification emails. The SMTP server must support SSL or TLS connections for this property to function. Yes
Notification.SendLog Attach log Specifies whether the input device, job or printer log is attached to the notification email when a certain input device, job or printer event occurs, providing more information to the email recipients. Yes
Notification.Threshold Notification limit Lets you specify how many notifications can be sent within a period of time. For example, if you specify 10 messages within 2 hours, a timer starts after the first notification is sent. If nine more notifications are sent in the next 30 minutes, no more notifications are sent until the timer reaches the 2 hour limit. Yes
Notification.To Recipient address One or more email addresses to send the notification to. This value is used in the To: field of the email. Yes
Notification.Type Notification method Specifies how notifications are delivered. Yes
WorkflowSystem.EmailFrom Sender email address The email address used in the From: field for all notification emails. Yes

1.3.9.8 Database property names for servers

Messages about servers might refer to properties by their database names, which begin with Instance.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the server has been created.
  • No means that an authorized user cannot change the value.

Server properties
Database name Notebook field name Brief description Internal values Editable
Instance.Description Server description Contains user-defined text that describes the RICOH ProcessDirector server.   Yes
Instance.Enabled Enabled status Specifies whether the server can do tasks.
  • No
  • Yes
No
Instance.ID Displayed in the properties notebook title: Server name Contains the name of the server.   No
Instance.IPAddress Server IP address or host name Specifies either the network IP address or the fully qualified host name of the computer that the server is running on.   Yes
Instance.InGeneralServerPool In general server pool Specifies whether the server is a general-usage server or a restricted-usage server.
  • No
  • Yes
Yes
Instance.LastModified Last modified The date and time that the server was last changed.   No
Instance.MaxHighUsageSteps Maximum resource-intensive step count Controls how many resource-intensive steps the server lets run concurrently.   Yes
Instance.MaxLowUsageSteps Maximum step count for other steps Controls how many non-resource-intensive steps the server lets run concurrently.   Yes
Instance.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this server.   No
Instance.Status Connection status Shows the current status of the server.
  • Connected
  • Disconnected
No

1.3.9.9 Database property names for step templates

Messages about step templates might refer to properties by their database names, which begin with StepTemplate.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the step template has been created.
  • No means that an authorized user cannot change the value.

Step template properties
Database name Notebook tab: field name Brief description Internal values Editable
Step.Color Step color Specifies the color of the step as it appears in the workflow builder.
  • Red
  • Orange
  • Gray
  • Blue
  • Purple
  • Not set
Yes
Step.Description Step description Describes the purpose of the step. For example, it might describe how the step processes a job.   Yes
Step.DisplayName General: Step name The name given to a step when it is added to a workflow.   Yes
Step.ID General: Step identifier Specifies the internal name for this step. This value is derived from the name of the step.   No
Step.Template.CreatedBy General: Template created by Specifies the name of the feature or extension that created the step template.   No
StepTemplate.Color Step color Specifies the color of the step as it appears in the workflow builder.
  • Red
  • Orange
  • Gray
  • Blue
  • Purple
  • Not set
Yes
StepTemplate.Description General: Template description Contains text that describes the function of the step template.   Yes
StepTemplate.Enabled General: Enabled status Specifies whether the step template is enabled.
  • No
  • Yes
No
StepTemplate.HighResourceUsage Tuning Properties page: Concurrent step limit Specifies where the limits are set for the number of steps created from the step template that can run at the same time.
  • Use limits set here
  • Use limits set on server
Use limits set here
StepTemplate.ID Displayed in the properties notebook title: Step template name Contains the name of the step template.   No
StepTemplate.LastModified Last modified The date and time that the step was last changed.   No
StepTemplate.MaximumActiveCount Tuning Properties page: Limit the number of concurrent steps active in the system to radio button Specifies how many occurrences of the step template, and any steps that are created from it, can run concurrently on a specific type of RICOH ProcessDirector object.   Yes
StepTemplate.MaximumActiveUnit Tuning Properties page: for each drop-down list Specifies the type of RICOH ProcessDirector object to which the value of the Maximum active count property for the step template applies.
  • PerInputDevice
  • PerPrinter
  • PerServer
  • PerSystem
Yes
StepTemplate.ModifiedBy Modified by user Specifies the user name of the user who made the last change to this step.   No
StepTemplate.ModuleType General: Module type Identifies the type of function the step template provides.
  • Cleanup
  • InitJobType
  • Java
  • Manual
  • Print
  • Submit
  • SubmitChild
No
StepTemplate.Servers Tuning Properties page: Run only on the selected server or servers radio button Lists all the restricted-usage servers and general-usage servers on which any steps that are created from the step template can run.   Yes
StepTemplate.SourceID General: Step template source ID Specifies the name of the step template that was used to create this step template.   No
StepTemplate.UseGeneralServerPool Tuning Properties page: Servers to use Specifies which computers can run the steps created by the step template.
  • Run on specific servers
  • Run on servers in general server pool
Run on servers in general server pool

1.3.9.10 Database property names for system properties

Messages about the RICOH ProcessDirector system might refer to properties by their database names, which begin with WorkflowSystem.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value.
  • No means that you cannot change the value.

System properties
Database name Field name Brief description Internal values Editable
WorkflowSystem.AdLdap.TestUserName LDAP test user name Specifies the LDAP user name used to test the LDAP settings.   Yes
WorkflowSystem.AltSMTPAddress Alternate SMTP server Specifies either the network IP address or the fully-qualified host name of the SMTP server that RICOH ProcessDirector uses to send emails when the SMTP server type property on a job step is set to Alternate.   Yes
WorkflowSystem.AltSMTPPassword Alternate SMTP password Specifies the password that the primary server uses to log in to the alternate SMTP Server.   Yes
WorkflowSystem.AltSMTPPort Alternate SMTP port Specifies TCP/IP port that the alternate SMTP server uses.   Yes
WorkflowSystem.AltSMTPSSLPort Alternate SMTP SSL port If the alternate SMTP server uses SSL security, specifies the TCP/IP port that the SSL connection uses.   Yes
WorkflowSystem.AltSMTPTLSPort Alternate SMTP TLS port If the alternate mail server uses TLS security, specifies the TCP/IP port that the TLS connection uses.   Yes
WorkflowSystem.AltSMTPUserName Alternate SMTP user name Specifies the user name that the RICOH ProcessDirector server uses to log in to the alternate SMTP Server.   Yes
WorkflowSystem.CaptureFileName Capture file Specifies the name of the capture file that is created when you capture system data.   Yes
WorkflowSystem.CaptureLevel Data to capture Shows the amount of information that is included in the capture file.   Yes
WorkflowSystem.CaptureServer Servers to capture data from Shows the server or servers that information is collected from when the capture file is created.   Yes
WorkflowSystem.Child.MaxJobID Largest child job number Specifies the largest job number that RICOH ProcessDirector can assign to a child job.   Yes
WorkflowSystem.Child.MinJobID Smallest child job number Specifies the smallest job number that RICOH ProcessDirector can assign to a child job.   Yes
WorkflowSystem.CopyTracesToTemp Back up files before capture Shows whether trace files are copied to a temporary directory before they are added to the capture file.   Yes
WorkflowSystem.CredentialExpiration Login inactivity timer (minutes) Specifies the number of minutes before an inactive user is automatically logged out.   Yes
WorkflowSystem.Email.SSLPort Email SSL port If the mail server uses SSL security, the TCP/IP port that the SSL connection uses.   Yes
WorkflowSystem.Email.TLSPort Email TLS Port If the mail server uses TLS security, the TCP/IP port that the TLS connection uses.   Yes
WorkflowSystem.FileSystemMapping File system mapping file Specifies the name of a file that maps file paths to mount points on the RICOH ProcessDirector server.   Yes
WorkflowSystem.GUILoggingLevel Web server logging level When the Custom option is selected for the Trace level property, shows the trace level that is active for the system.   Yes
WorkflowSystem.JobDisplayTag Job identifier to use Specifies whether the Printers portlet, printer console, and PSF Job completion log show the job name or the job number.
  • Job.ID
  • Job.Name
Yes
WorkflowSystem.LastCaptureFilename File name for last capture Specifies the name of the last capture file created when system data was most recently captured.   No
WorkflowSystem.LastCaptureTimestamp Last capture completed The date and time that the capture was most recently completed. RICOH ProcessDirector updates the value whenever the capture completes.   No
WorkflowSystem.LPDHostnames Hosts allowed to submit LPD jobs Specifies the host names or IP addresses of systems that can submit jobs to RICOH ProcessDirector using the LPD protocol.   Yes
WorkflowSystem.MaxJobID Largest job number Specifies the largest job number that RICOH ProcessDirector can assign to a job.   Yes
WorkflowSystem.MediaTolerance.RecyclingPercentage Recycled content tolerance Specifies the acceptable variation in recycled content for a media object.   Yes
WorkflowSystem.MediaTolerance.Size Size tolerance Specifies the acceptable variation in size for a media object.   Yes
WorkflowSystem.MediaTolerance.Weight Weight tolerance Specifies the acceptable variation in weight for a media object.    
WorkflowSystem.PrinterProgress Print progress bar Specifies whether the print progress bar is displayed in the Printers portlet.
  • No
  • Yes
Yes
WorkflowSystem.MaxPasswordAge Maximum password age before expiration Specifies the number of days passwords can be used until they expire.   Yes
WorkflowSystem.MinJobID Smallest job number Specifies the smallest job number that RICOH ProcessDirector can assign to a job.   Yes
WorkflowSystem.Primary.MaxLowUsageSteps Maximum step count for other steps Controls how many non-resource-intensive steps the primary RICOH ProcessDirector server lets run concurrently.   Yes
WorkflowSystem.Primary.MaxHighUsageSteps Maximum resource-intensive step count Controls how many resource-intensive steps the primary RICOH ProcessDirector server lets run concurrently.   Yes
WorkflowSystem.ProxyPassword Proxy server 1 password Specifies the password that the primary server uses to log in to proxy server 1.   Yes
WorkflowSystem.ProxyPassword2 Proxy server 2 password Specifies the password that the primary server uses to log in to proxy server 2.   Yes
WorkflowSystem.ProxyPort Proxy server 1 port Specifies TCP/IP port that RICOH ProcessDirector uses to communicate with proxy server 1.   Yes
WorkflowSystem.ProxyPort2 Proxy server 2 port Specifies TCP/IP port that RICOH ProcessDirector uses to communicate with proxy server 2.   Yes
WorkflowSystem.ProxyServer Proxy server 1 Specifies either the network IP address or the fully qualified host name of the proxy server 1. RICOH ProcessDirector uses a proxy server to connect to external web sites.   Yes
WorkflowSystem.ProxyServer2 Proxy server 2 Specifies either the network IP address or the fully qualified host name of the proxy server 2. RICOH ProcessDirector uses a proxy server to connect to external web sites.   Yes
WorkflowSystem.ProxyUser Proxy server 1 user Specifies the user name that RICOH ProcessDirector uses when proxy server 1 connects to an external web site.   Yes
WorkflowSystem.ProxyUser2 Proxy server 2 user Specifies the user name that RICOH ProcessDirector uses when proxy server 2 connects to an external web site.   Yes
WorkflowSystem.RememberPrinterStatus Remember enabled status of printers Specifies whether RICOH ProcessDirector restores the state of enabled printers after a system shutdown.
  • No
  • Yes
Yes
WorkflowSystem.RetainPollInterval Retention polling interval (minutes) Controls how often RICOH ProcessDirector polls jobs that are retained on the system to determine if any further action is necessary.   Yes
WorkflowSystem.SMTPPassword SMTP password Specifies the password that RICOH ProcessDirector uses to login to the SMTP Server.   Yes
WorkflowSystem.SMTPPort SMTP port Specifies the TCP/IP port that the SMTP server uses.   Yes
WorkflowSystem.SMTPServer SMTP server Specifies either the network IP address or the fully-qualified host name of the SMTP server that RICOH ProcessDirector uses to send email.   Yes
WorkflowSystem.SMTPUsername SMTP user name Specifies the user name that RICOH ProcessDirector uses to connect to the SMTP Server.   Yes
WorkflowSystem.SystemIdentifier System identifier Specifies an alternate name for the system to show in the user interface.   Yes
WorkflowSystem.TraceCustomTraceLevel Custom trace level When the Custom option is selected for the Trace level property, shows the trace level that is active for the system.   Yes
WorkflowSystem.TraceFileCount Maximum number of trace files Shows the maximum number of trace files that can be created on the system.   Yes
WorkflowSystem.TraceFileSize Maximum trace file size Shows the upper size limit in kilobytes (KB) for trace files that the system creates.   Yes
WorkflowSystem.TraceLevel Trace level Shows the level of tracing that is active on the system.   Yes

1.3.9.11 Database property names for users

Messages about users and their passwords might refer to properties by their database names, which begin with User.

In the Editable column:

  • Yes means that a user can change the value after the user is created.
  • No means that a user cannot change the value.

User properties
Database name Field name Brief description Editable
User.Description User description Contains text that describes the user name. Yes
User.Groups Group membership Contains the name of the group or groups that the user belongs to. Yes
User.ID Displayed in the page title Contains the user name for an authorized user of RICOH ProcessDirector. No
User.LastModified Last Modified The date and time that the user was last changed. RICOH ProcessDirector updates the value whenever the user changes. No
User.Login.Status Logged in Specifies whether a user is logged in to RICOH ProcessDirector. No
User.LocationFilterPreference Locations to show Shows which locations are currently used to filter the user interface. Only objects from locations selected in this list are displayed. Yes
User.LocationSettings Allowed locations Several objects such as jobs, printers, and input devices have a Location property. The Allowed locations property lets you specify which locations a user can access. The setting affects which objects the user can see in the user interface. The user can select which location to use to filter the user interface using the Locations to show property. Yes
User.ModifiedBy Modified by user Specifies the user who made the last change to this input device. RICOH ProcessDirector maintains the value of this property, and updates the value whenever the input device changes. No
User.Password User password Accepts the password for the user. Yes
User.PasswordConfirm Confirm new user password Specifies the password for the new user. Must match the New user password value. Yes
User.PasswordLastChanged Password last changed Specifies the date and time when the password was last changed. No
User.PasswrodNew New user password Specifies the password for the new user. Yes
User.StartPage Start page Specifies which page RICOH ProcessDirector displays after you log in. When a new user is created, this control is not available until a Group membership value is selected. Yes

1.3.9.12 Database property names for groups

Messages about security groups might refer to properties by their database names, which begin with Group.

In the Editable column:

  • Yes means that a user can change the value after the group is created.
  • No means that a user cannot change the value.

Group properties
Database name Field name Brief description Editable
Group.Actions Allowed actions Lists the actions that users in this group are authorized to do. Yes
Group.Attributes Allowed attributes Lists the object properties that users in this group are authorized to edit. Yes
Group.Description Group description Contains text that describes the group. Yes
Group.ID Displayed in the page title Contains the name of the group. No
Group.SourceID Group source ID Contains the name of the group that this group was copied from. No

1.3.9.13 Database property names for locations

Messages about locations might refer to properties by their database names, which begin with Location.

In the Editable column:

  • Yes means that an authorized user can change the value after the location has been created.
  • No means that an authorized user cannot change the value.

Location properties
Database name Field name Brief description Editable
Location.Description Location description Describes the location. For example, the description might include the city name or the building name and floor where printers are located. Yes
Location.ID Location name Specifies the name of the location. No
Location.LastModified Last modified The date and time that the location was last changed. No
Location.Modified Modified by user Specifies the user name of the user who made the last change to this location. No

1.3.9.14 Database property names for security

Messages about security might refer to properties by their database names, most of which begin with WorkflowSystem. The database property names for security include the database property names for Lightweight Directory Access Protocol (LDAP).

In the Editable column:

  • Yes means that an authorized user can change the value after the initial security setup.
  • No means that an authorized user cannot change the value.

Security properties
Database name Notebook tab: Field name Brief description Internal values Editable
User.AccountStatus Security Users: Account status Shows the current status of the user account.
  • Active
  • Locked-Inactive
  • Locked-Password Failure
Yes
WorkflowSystem.AdLdap.EmailAddress Security Settings LDAP: Email attribute Specifies the LDAP attribute that RICOH ProcessDirector gets user email addresses from.   Yes
WorkflowSystem.AdLdap.GroupMap Security Settings LDAP: Product to LDAP group mapping Specifies the mapping of RICOH ProcessDirector groups to LDAP groups.   Yes
WorkflowSystem.AdLdap.GroupSearchBase Security Settings LDAP: Group search base Specifies the branch of the LDAP external directory tree that RICOH ProcessDirector searches to identify the organizational unit (OU) that contains LDAP groups.   Yes
WorkflowSystem.AdLdap.GroupSearchFilter Security Settings LDAP: Group search filter Specifies the filter that RICOH ProcessDirector uses to determine if a group with the specified name exists within the LDAP group search base.   Yes
WorkflowSystem.AdLdap.GroupSearchMember Security Settings LDAP: Group search member Specifies the LDAP attribute RICOH ProcessDirector uses to get the distinguished names of LDAP group members.   Yes
WorkflowSystem.AdLdap.ManagerDN Security Settings LDAP: Manager distinguished name Specifies the full distinguished name (DN) of the user that binds to the LDAP server for user searches.   Yes
WorkflowSystem.AdLdap.ManagerPassword Security Settings LDAP: Manager distinguished name password Specifies the password for the user listed in the Manager distinguished name property.   Yes
WorkflowSystem.AdLdap.rootDN Security Settings LDAP: Root distinguished name Specifies the distinguished name (DN) that is not limited by administrative limit restrictions or access control restrictions for the database.   Yes
WorkflowSystem.AdLdap.Server Security Settings LDAP: LDAP server Specifies either the network IP address or the fully-qualified host name of one or more LDAP servers and the ports that the system uses for authentication.   Yes
WorkflowSystem.AdLdap.SyncLdapGrp Security Settings LDAP: Synchronize with LDAP groups Specifies if RICOH ProcessDirector updates the product security groups for a user, based on the values for the Product to LDAP group mapping property, each time the user logs in.
  • Yes
  • No
Yes
WorkflowSystem.AdLdap.UserSearchBase Security Settings LDAP: User search base Tells the server which part of the external directory tree to search, relative to the base distinguished name (DN) in the LDAP URL.   Yes
WorkflowSystem.AdLdap.UserSearchFilter Security Settings LDAP: User search filter Specifies the filter that RICOH ProcessDirector uses to determine if a distinguished name (DN) of the user exists in LDAP.   Yes
WorkflowSystem.AdLdap.YesNo Security Settings LDAP: Authenticate with LDAP Specifies whether users can log in to RICOH ProcessDirector with a user ID that is defined in the existing Lightweight Directory Access Protocol (LDAP) server.
  • Yes
  • No
Yes
WorkflowSystem.ComplexRules Security Settings General: Enforce password complexity rules Specifies whether all users must use complex passwords.
  • Yes
  • No
Yes
WorkflowSystem.InactiveLength Security Settings General: Account inactivity period Specifies the number of days that RICOH ProcessDirector lets a user account be inactive before that user is locked out of the system.   Yes
WorkflowSystem.LockOutLength Security Settings General: Lockout duration Specifies the amount of time that RICOH ProcessDirector locks a user out of the system after the user exceeds the Account login threshold. The unit of time for the value can be minutes, hours, or days. Use the toggle control to the right of the property name to select the unit of time for the value.   Yes
WorkflowSystem.MaxLoginAttempts Security Settings General: Account lockout threshold Specifies the number of unsuccessful login or password change attempts that are allowed before the user is locked out.   Yes
WorkflowSystem.MinPasswordLength Security Settings General: Minimum password length Specifies the minimum number of characters required for a password.   Yes
WorkflowSystem.PasswordReuseCount Security Settings General: Password reuse count Specifies how many times a user must enter a unique password before they can reuse an old password.   Yes

1.3.10 Job properties that can be set from the job ticket

When you submit a job with a job ticket, RICOH ProcessDirector sets some job properties from values in the job ticket.

Job properties are mapped to attributes in the job ticket. In most cases, RICOH ProcessDirector sets the job property to a value that corresponds to the value of the attribute in the Job ticket attribute column. (The values are not always identical.) The Notes column explains variations in this process.

When a job ticket refers to more than one print file, RICOH ProcessDirector creates a child job for each file. In the Per job or per ticket column:

  • Job means that the property is mapped to an attribute in the job ticket that applies to individual print files, so it can have a different value for each child job.
  • Ticket means that the property is mapped to an attribute that applies to the entire job ticket, so it must have the same value for all jobs created for the job ticket.
  • Job or ticket means that the property is mapped to both types of attribute, so it can have the same value or different values depending on the attributes in the job ticket.

Job properties that can be set from the job ticket
Database name Notebook tab: field name Brief description Per job or per ticket JDF attribute name Notes
Job.Binding Binding Set the binding settings for the job you are printing. Job or ticket job-binding  
Job.Copies General and Status: Job copies requested Contains the number of job copies that have been requested. Job or ticket job-copies  
Job.CustomerName Scheduling: Customer name Identifies the customer who is associated with this job. Job or ticket job-contact-info  
Job.Description General: Job description Contains text that describes the job. Job or ticket jt-comment  
Job.Duplex General: Duplex Indicates whether duplexed printing is active for the job and, if so, the type of duplexed printing. Job or ticket job-sides  
Job.FoldOptions Fold Options Specifies how to fold the job or large sheets in the job, whether to fold all the sheets together (overlap or collate), and whether the front side of the sheet ends up on the outside rather than the inside of the fold. Job or ticket job-folding  
Job.Info.Department Information: Department information Contains a department description for the job. Job or ticket job-contact-info  
Job.InputDatastream General: Input data stream Specifies the format of data that the input file for this job contains. Job document-format  
Job.Line- 2AFP. CC_TYPE AFP: Carriage control type Indicates the type of carriage controls that are present in the job. Ticket job-carriage-control-characters This property is only available if the AFP Support Feature is installed.
Job.Line-2AFP. FORMDEF AFP and Print: Form definition Identifies the form definition to use with the job. Ticket job-form-definition This property is only available if the AFP Support Feature is installed.
Job.Line-2AFP. PAGEDEF AFP: Page definition Identifies the AFP page definition to use with the job. Ticket job-page-definition This property is only available if the AFP Support Feature is installed.
Job.Line-2AFP.TRC AFP: Table reference characters Indicates whether table reference characters are present in the job. Ticket job-table-reference-characters This property is only available if the AFP Support Feature is installed.
Job.Media Scheduling: Media (ready | supported | all) Specifies the media to use for the job. Job or ticket The job media database name maps to several job-media and document-media attributes in JDF. RICOH ProcessDirector uses the media detection setting to determine how this value is set.

If a job ticket specifies both page-level and job-level media values, multiple values are set for this property. However, if you update the value of the Media property, it cannot be written back to the job ticket, because you cannot indicate the page range that the media should be used for. The media values in the job ticket remain unchanged.

Job.Name General: Job name Contains the name of the job. Job or ticket job-name  
Job.OutputBin Scheduling: Output bin (requested | available | all) Specifies the output bin to use for the job. Job or ticket document-output-bin-name, job-output-bin-name  
Job.Print.JogCopies Print: Jog output copies Controls whether the printer jogs the output copies for the job. Ticket job-jog-offset  
Job.Print.Xoffset Print: X offset (unit) Identifies the offset, in inches or millimeters, in the x or horizontal direction of the logical page origin from the media origin. Job or ticket image-shift-front-x This value applies to both the front and back of the page.

This property is only available if the AFP Support Feature is installed.

Job.Print.Yoffset Print: Y offset (unit) Identifies the offset, in inches or millimeters, in the y or vertical direction of the logical page origin from the media origin. Job or ticket image-shift-front-y This value applies to both the front and back of the page.

This property is only available if the AFP Support Feature is installed.

Job.Priority Scheduling: Job priority Contains the printing priority of the job. Job or ticket job-priority  
Job.Punch Scheduling: Punch Specifies the number and position of holes to punch in the output. Job or ticket document-hole-making, job-hole-making  
Job.RequestedPrinter Scheduling: Requested printer Contains the name of the printer that was requested for the job. Job or ticket job-logical-destination-name  
Job.RetainDuration General: Retention period (unit) Controls the amount of time in minutes, hours, or days that RICOH ProcessDirector retains a job after it reaches the RetainCompletedJobs step. Job or ticket job-retain  
Job.Staple Scheduling: Staple Specifies the number and position of staples to use in the output. Job or ticket job-stitching, document-stitching  

1.4 Installing Document Processing Features

1.4.1 Introduction

1.4.1.1 Important

To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use or non-use of this product and operation manuals provided with it.

Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the software. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.

In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.

1.4.1.2 Cautions regarding this guide

  • Some illustrations or explanations in this guide could differ from your product due to improvement or change in the product.
  • The contents of this document are subject to change without notice.
  • No part of this document may be duplicated, replicated, reproduced in any form, modified, or quoted without prior consent of the supplier.
  • Throughout this publication, references to directory paths indicate the default paths only. If you install RICOH ProcessDirector or RICOH ProcessDirector Plug-in for Adobe Acrobat in a different location, including a different drive, you must adjust the paths accordingly.

    For example, if you install RICOH ProcessDirector Plug-in for Adobe Acrobat on the D: drive of a computer running a Windows operating system, replace C: with D: in the directory paths.

1.4.1.3 Publications for this product

The following publications are available for RICOH ProcessDirector document processing features.
Instruction manuals

These instruction manuals are included:

  • RICOH ProcessDirector: Integrating with Other Applications

    This guide provides technical information about the ways that you can configure RICOH ProcessDirector to exchange data with other applications.

  • RICOH ProcessDirector for Linux or Windows: Planning and Installing

    This guide explains planning and installation procedures for RICOH ProcessDirector on your operating system. The publications CD includes the version of this manual for your operating system: Linux or Windows.

  • RICOH ProcessDirector: Installing Document Processing Features (this publication)

    This guide explains how to install RICOH ProcessDirector features that control and track both jobs and the individual documents in jobs.

  • RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat

    This guide explains how to use RICOH ProcessDirector Plug-in for Adobe Acrobat. You can use the Adobe Acrobat plug-in to define text, barcodes, images, and other enhancements in a PDF file. After you save your enhancements in a control file, RICOH ProcessDirector workflows can use the control file to make similar enhancements to PDF files.

  • Font Summary

    This guide explains font concepts and the different types of fonts in the InfoPrint Font Collection. The Font Summary is available only in English.

  • White Paper–Using the Enhance AFP Function

    This guide explains how to configure and use Enhance AFP control files. The guide is available only in English.

  • The RICOH ProcessDirector readme file (readme.html)

    This file tells you how to access the other publications. The readme file is available only in English.

  • The RICOH ProcessDirector release notes

    These release notes provide information about the RICOH ProcessDirector release, including new functions and updates; known limitations, problems, and workarounds; and code change requests. The release notes are available only in English.

You can download English publications in PDF format from the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/

RICOH ProcessDirector Information Center

The RICOH ProcessDirector Information Center contains topics that help administrators, supervisors, and operators learn about and use RICOH ProcessDirector document features. The Information Center is available from the RICOH ProcessDirector user interface and provides quick navigation and search features.

RICOH ProcessDirector Help

Field help is available on many screens for RICOH ProcessDirector document processing features to provide information for specific tasks and settings.

1.4.1.4 How to read the documentation

1.4.1.4.1 Before installing a document processing feature

This manual contains instructions and cautions for correct installation of document processing features. Before installing a document processing feature, read this manual thoroughly and completely. Keep this manual handy for future reference.

1.4.1.4.2 How to use the manuals

Use the instruction manuals according to your needs.
To learn how to install a document processing feature:
See RICOH ProcessDirector: Installing Document Processing Features.
To learn how to use the functions and operations of a document processing feature:
See the RICOH ProcessDirector Information Center.
To learn how to use the functions and operations of RICOH ProcessDirector Plug-in for Adobe Acrobat:
See RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat. This information is also available in the Acrobat plug-in help system and the RICOH ProcessDirector Information Center.
Displaying the publications

RICOH ProcessDirector: Installing Document Processing Features and other publications are available on the RICOH ProcessDirector publications CD, so you can access them before you install the application.

    Note:
  • A PDF viewer, such as Adobe Acrobat Reader, is required to view the publications.

To access the RICOH ProcessDirector publications CD on Windows:

  1. Insert the CD in the CD drive.

    If the Windows system is configured to autorun CDs, Windows Explorer opens automatically to show the contents of the CD.

  2. If Windows Explorer does not start automatically, open it and display the contents of the CD drive.
  3. Open the readme.txt file for information about the contents of the CD, including instructions for launching the RICOH ProcessDirector Information Center from the CD.

Some of these publications are also available from RICOH ProcessDirector user interface.

    Note:
  • You must log in to the RICOH ProcessDirector user interface to view the publications.

On the top menu bar of the RICOH ProcessDirector user interface, click the Information button and select one of the following publications to download:

  • RICOH ProcessDirector: Integrating with Other Applications
  • RICOH ProcessDirector: Installing Document Processing Features
  • RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat
  • RICOH ProcessDirector: Release Notes

Displaying the RICOH ProcessDirector Information Center

The RICOH ProcessDirector Information Center is available from the RICOH ProcessDirector user interface.

  • To display the Information Center:
    • On the top menu bar of the RICOH ProcessDirector user interface, click the Information button and select Help.
    • If you are not logged in to RICOH ProcessDirector, enter this URL in the address bar of your browser:
      • http://hostname:15080/pdhelp/index.jsp

      In the URL, hostname is the host name or IP address of the computer where RICOH ProcessDirector is installed.

In addition, you can bookmark the location of the Information Center in your browser and open it at any time outside of RICOH ProcessDirector.

Information about use the functions and operations of features are available only when the features are installed in the system.

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

1.4.1.7 Abbreviations

AFP
Advanced Function Presentation
CSV
Comma-Separated Values
HTTP
Hyper Text Transfer Protocol
IP
Internet Protocol
PDF
Portable Document Format

1.4.1.8 Trademarks

RICOH ProcessDirector is a trademark of Ricoh Company, Ltd. in the United States, other countries, or both.

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

IBM and AIX are either registered trademarks or trademarks of International Business Machines Corporation in the United States and/or other countries.

Microsoft, Windows, Windows Server, and Internet Explorer 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.

UNIX is a registered trademark of The Open Group.

Thales Group code: The license management portion of this Licensee Application is based on one or more of the following copyrights:

Sentinel RMS
Copyright 1989-2022 Thales Group 
All rights reserved.

Sentinel Caffe (TM)
Copyright 2008-2022 Thales Group 
All rights reserved.

Sentinel EMS
Copyright 2008-2022 Thales Group 
All rights reserved.

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

  • The product names of Windows 7 are as follows:
    • Microsoft Windows 7 Professional
    • Microsoft Windows 7 Ultimate
    • Microsoft Windows 7 Enterprise
  • The product names of Windows 10 are as follows:
    • Microsoft Windows 10 Pro
    • Microsoft Windows 10 Enterprise
  • The product name of Windows 11 is:
    • Microsoft Windows 11 Pro
  • The product names of Windows Server 2016 are as follows:
    • Microsoft Windows Server 2016 Standard
  • Windows Server 2019:
    • Microsoft Windows Server 2019 Standard
  • The product name of Windows Server 2022 is:
    • Microsoft Windows Server 2022 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.4.2 Overview

Document processing features expand the concept of controlling and tracking print jobs to controlling and tracking individual documents in a print job. Additional installation tasks are required to install these features.

Two features add basic functions and objects for processing documents. Installing one of these features is a prerequisite for installing the other document processing features:

  • PDF Document Support adds functions and objects for processing documents in PDF jobs. This no-charge feature is provided with the base product but is not installed by default.

  • AFP Support adds functions and objects for processing documents in AFP jobs.

The other document processing features add functions and objects for specialized needs such as archiving document information in a repository or inserting documents into envelopes. Before installing these features, you install PDF Document Support, AFP Support, or both. If you install PDF Document Support, the other document processing features work with PDF files. If you install AFP Support, they work with AFP files. If you install both, they work with both types of files. Examples of these document processing features are:

  • Archive
  • Automated Verification
  • Electronic Presentment

  • Inserter
  • Postal Enablement
  • Preference Management

Installing a document processing feature involves:

  • Planning for the installation
  • Installing the feature
  • Defining custom document properties
  • Updating custom document properties

Installing the PDF Document Support feature also involves:

  • Installing RICOH ProcessDirector Plug-in for Adobe Acrobat for PDF document processing
  • Loading RICOH ProcessDirector document properties
  • Loading RICOH ProcessDirector media objects for PDF document processing

Important: Examples, lists of step templates, and lists of properties sometimes refer to objects in specific document processing features. If you do not have these features installed, the objects do not exist on your system.

1.4.2.1 Documents

A document is the smallest unit that can be tracked by a workflow. For example, a document can be a set of pages that make up one bill, one statement, or one mailpiece.

A print file can contain thousands of documents. If the print file is in AFP format, each document is bounded by the Begin Page Group and End Page Group AFP structured fields.

1.4.2.2 Document properties file

The document properties file (DPF) can contain properties of documents in a job. The file is stored in the spool directory for the job.

The document properties file is created automatically by the step templates IdentifyPDFDocuments, IdentifyDocuments, ReadDocumentsFromDatabase, CreateJobsFromDocuments, and CreateAFPJobsFromDocuments. The file is structured like a table; the first line identifies the properties that are in the file, and each additional line contains the property values for each document. RICOH ProcessDirector uses the information in the document properties file to keep track of the documents associated with each job.

1.4.2.3 Document database

The document database is an internally managed database that stores and manages the properties of individual documents in the system. You do not do actions directly on the document database, but on the documents that it contains.

During the configuration process, you work with your Ricoh support representative to decide whether to define document properties as database properties or as limited properties.

1.4.3 Planning for installation

When you install RICOH ProcessDirector document processing features, you install the RICOH ProcessDirector components on the primary server. If you install the PDF Document Support feature, you also install RICOH ProcessDirector Plug-in for Adobe Acrobat onto a computer with a Windows operating system and Adobe Acrobat Professional.

1.4.3.1 Planning to install document processing features

All document processing features include RICOH ProcessDirector components that you install on an existing RICOH ProcessDirector server. Before installing a feature, make sure your system meets the following requirements.

1.4.3.1.1 Software requirements

Make sure that your system has the required software before installing any document processing features. In addition to the required software described in this section, we recommend that you use an XML editor to edit the required XML configuration files. The installer does a schema-based validation of XML files but does not validate all syntax.

1.4.3.1.2 Gathering your document requirements

Determine what document properties are relevant for the workflows that you want to create.
Think about what properties you might want to use to sort or group documents in a job.

To gather your document requirements:

  1. Ask yourself questions like these:
    • What document properties will you use to distinguish your documents? (What makes one document different from another?)
    • What document properties do you need to identify to make use of data defined in the document properties in your PDF file?
    • What document properties do you need to identify to make use of data defined in the index tags (also called Tagged Logical Elements (TLEs)) in your Advanced Function Presentation (AFP) file?
    • What properties do you want to use as criteria for tracking documents? For example, you could define a property called account number so that you can track documents according to account number.
    • If you have a feature that includes the InsertJobs step template, what information do you want to include in inserter barcodes or in inserter control files? For example, to include the document's ZIP code in the inserter control file, you could define a document property called ZIP code.
    • If you have a feature used for postal processing, what information does your postal software require about each document?
    • If you have a feature that is used to add barcodes, what document properties do you need to include in the barcode data?
    • If you have the Archive feature, what document properties do you want to use to retrieve documents from the repository where they are stored?
    • If you have the Preference Management feature, what document properties do you need to define to handle preference information in RICOH ProcessDirector?
  2. From your answers, decide what properties to define. Some properties that you might want to define are:
    • Account number
    • Address line
    • Postal keyline
    • Data that you want to put into a barcode that is unique for each document
    • ZIP code
    • Dispatch type, such as express or regular mail
    • Encloser type, such as flat or fold

1.4.3.1.3 Performance and capacity considerations with document processing features

Keep these performance and system capacity considerations in mind as you configure and use document processing features, such as Archive, Postal Enablement, Inserter support, and the Advanced Document Pool extended feature.

1.4.3.1.3.1 Document properties and document management

Use these document management tips to help you optimize system performance.

Carefully assess your document management needs before you define document properties. Not only must you control the number of properties, but also consider their size. A 1024-character property uses more storage space than a 32-character property.

Limited document properties do not need database table space; however, they occupy space for each document in each document properties file that contains the property.

Using database document properties lets you display document information in the user interface and lets you process documents globally (without knowing which job contains each document), but putting document information in the database has a performance cost. Document properties in the database use space in the database tables. Updates to properties increase logging activity and create possible database contention. The database caches information in memory. With fewer and smaller-sized properties, the database can cache more records in memory and provide better system performance.

Several steps and actions process documents in the database. The database system locks database rows during processing. As more document processing occurs, the impact on system resources increases. You can tune your step templates to limit the number of concurrent steps that process documents in the database.

These steps and actions cause updates to the database:

  • WriteDocumentsToDatabase adds entries for each document to the database and assigns each such entry a document identifier.
  • ReadDocumentsFromDatabase retrieves document information from the database and stores it in a document properties file. No updates are done on the database.
  • CompleteDocuments changes the state of all documents in the job to Complete.
  • CreateJobsFromDocuments and CreateAFPJobsFromDocuments create a new association between documents and the child jobs that are created.
  • RemoveJobs notifies RICOH ProcessDirector when jobs are deleted. When RICOH ProcessDirector deletes a job that has documents in the database, it deletes the documents from the database.
  • UpdateDocumentsInDatabase updates the document properties in the database using the values from the document properties file.
  • The Process Again action requires approval from document processing features. Document processing features do not let RICOH ProcessDirector process an original job again if the documents for that job are also associated with other jobs.
  • Opening the Document properties notebook from the Documents portlet retrieves document property values from the database. Only properties that are stored in the database appear in the property notebook.

This list shows steps and actions in order according to how many database resources they use. The most resource-intensive items are at the top.

  1. RemoveJobs
  2. CompleteDocuments
  3. WriteDocumentsToDatabase
  4. CreateJobsFromDocuments or CreateAFPJobsFromDocuments
  5. Displaying the Documents table in the user interface
  6. ReadDocumentsFromDatabase
  7. Process Again
  8. Opening the Documents property notebook from the Documents table

1.4.3.1.3.2 Memory usage

Keep these memory usage considerations in mind as you configure and use document processing features.
    Note:
  • Your installation might not include all of the step templates discussed in this section.

Some steps might need a lot of memory to process a job.

For example, steps based on the CreateJobsFromDocuments, CreateAFPJobsFromDocuments, BuildPDFFromDocuments, BuildAFPFromDocuments, IdentifyPDFDocuments, and IdentifyDocuments step templates read information into memory to do their processing. The system keeps a record for each document in memory.

Steps based on the GroupDocuments, SortDocuments, and SplitDocuments step templates also read information into memory to do their processing. The system keeps a record for each document in memory. The amount of memory needed by GroupDocuments and SortDocuments varies depending on which properties you use for grouping and sorting. When more data exists for those properties, the system uses more memory.

    Note:
  • If you process jobs using any of these step templates, increase the amount of memory that the Java Virtual Machine (JVM) can use for RICOH ProcessDirector steps to at least 8 GB of memory:
    • BuildAFPFromDocuments
    • BuildPDFFromDocuments
    • BuildPDFFromZip
    • CreateAFPJobsFromDocuments
    • CreateJobsFromDocuments
    • GroupDocuments
    • IdentifyDocuments
    • IdentifyPDFDocuments
    • SortDocuments
    • SplitDocuments
    • ReadDocumentsFromDatabase
    • RemoveDocumentsFromDatabase
    • UpdateDocumentsInDatabase
    • WriteDocumentsToDatabase

    See Defining the JVM memory pool allocation for additional information.

By default, steps are tuned to run on the primary computer, which uses up to 2000 MB of memory when it runs. The primary computer uses the memory for system management, user interface and Web service requests, printer management, input device management, and running steps. Jobs with many documents that sort or group using many properties can use a significant amount of memory.

You can optimize step tuning to minimize memory usage:

  1. Define one or more RICOH ProcessDirector secondary servers on the primary server. The secondary servers should not be in the general server pool. The servers should allow only one step to run at a time.
  2. Change the tuning of these step templates to run only on the secondary servers:
    • BuildAFPFromDocuments
    • BuildPDFFromDocuments
    • CreateAFPJobsFromDocuments
    • CreateJobsFromDocuments
    • GroupDocuments
    • IdentifyDocuments
    • IdentifyPDFDocuments
    • SortDocuments
    • SplitDocuments

1.4.3.1.3.3 Setting the maximum number of open files (optional)

This section is not applicable to Windows. The system setting for the maximum number of open files prevents an uncontrolled process from taking over your system, but you might need a higher limit than the default if you are processing jobs with many files. Changing the open file limit lets your document processing feature use more system resources. This task is optional, but if File Not Found errors frequently appear in the job log during job processing, you should do this task.

To set the open file limit:

  1. Log in to your system as the root user, or use sudo or the su command to become the root user.
  2. On Linux: Open the file /etc/security/limits.conf.
  3. Find the line in the file that sets the open file limit. For example, on a Linux system it might look like this: aiw1 - nofile 4096.
    If the line does not exist, add it in the next step.
  4. Edit the line, or add a new line if needed, to set a higher limit for the RICOH ProcessDirector system user (aiw1 is the default).

    This example sets the limit to 15,000 on Linux: aiw1 - nofile 15000

    Check with your system administrator to determine a reasonable upper limit for the number of open files.

  5. Log out as root and log in to make the change take effect.

1.4.3.1.3.4 Defining the JVM memory pool allocation

Depending on the size of your production files, processing a workflow can involve several memory-intensive operations. If you do not allocate enough memory to these processes in RICOH ProcessDirector, you might encounter processing errors or slow processing.
You can configure the Java Virtual Machine memory pool allocation by editing the /aiw/aiw1/config/jvmsettings.cfg (UNIX-based operating systems) or C:\aiw\aiw1\config\jvmsettings.cfg (Windows) file. If you change the settings in this configuration file, you need to reset the system using the stopaiw and startaiw commands for the change to take effect.

The primary setting defines the maximum amount of memory allocated to a Java Virtual Machine process. You can change that setting to match your memory usage needs. The default is 2 GB, and you want to allocate at least 6 GB. In the jvmsettings.cfg file you change:

primary=-Xmx2048m

to

primary=-Xmx6144m
    Note:
  • You change the RICOH ProcessDirector Plug-in for Adobe Acrobat JVM memory allocation by clicking Ricoh Preferences from the Adobe Acrobat menu bar.

1.4.3.2 Hardware and software requirements for RICOH ProcessDirector Plug-in for Adobe Acrobat

This section describes the hardware and software requirements for the computer that you install RICOH ProcessDirector Plug-in for Adobe Acrobat on. The plug-in is included with the PDF Document Support feature.
Hardware requirements

The system hardware requirements for the computer that RICOH ProcessDirector Plug-in for Adobe Acrobat is installed on are:

  • Monitor resolution of 1024 by 768 pixels or higher
  • A minimum of 2 GB RAM

Depending on the number of documents you process, additional free hard-drive space and memory might be required.

Operating system and software requirements

RICOH ProcessDirector Plug-in for Adobe Acrobat requires one of these operating systems:

  • Windows 10
  • Windows 11 Pro
  • Windows Server 2016
  • Windows Server 2019
  • Windows Server 2022

RICOH ProcessDirector Plug-in for Adobe Acrobat requires this software:

  • Java Runtime Environment (JRE) 1.8 (Java Version 8)
    • You must install the JRE, not the Java Development Kit (JDK).
    • We strongly recommend using the 64-bit version of the JRE you choose.
    • RICOH ProcessDirector Plug-in for Adobe Acrobat supports both the Oracle Java and OpenJDK (Hotspot) JREs at Version 8.
      Note: Neither RICOH ProcessDirector nor the Plug-in install Java on your system. You must install a supported Java version for the Plug-in to use.

      If you install the OpenJDK JRE (Hotspot), you must choose the option to install with a custom setup, not the default setup. In the list of features to install, find JavaSoft (Oracle) registry keys and select the option to install that feature on the local hard drive.

  • Adobe Acrobat Pro 2020 or Pro DC
      Note:
    • Acrobat cannot be installed in a directory path that contains non-English Unicode characters.

1.4.3.3 Migrating from Adobe Acrobat Professional version X or XI to version DC

If you have installed RICOH ProcessDirector Plug-in for Adobe Acrobat on Adobe Acrobat X or XI Professional, follow this process to install RICOH ProcessDirector Plug-in for Adobe Acrobat on Adobe Acrobat DC Professional.
To migrate to Adobe Acrobat DC Professional:
  1. Uninstall RICOH ProcessDirector Plug-in for Adobe Acrobat from Adobe Acrobat X or XI Professional.
  2. Install RICOH ProcessDirector Plug-in for Adobe Acrobat on Adobe Acrobat DC Professional.
    Your plug-in settings for Adobe Acrobat Professional version X or XI are retained on version DC.

1.4.4 Installing features

To install document processing features, you install RICOH ProcessDirector components, including workflows and step templates. If you have the PDF Document Support feature, you also install RICOH ProcessDirector Plug-in for Adobe Acrobat.

1.4.4.1 Installing the feature on the RICOH ProcessDirector primary computer

You install the document processing feature on a server on which you have already installed the RICOH ProcessDirector base product.

1.4.4.1.1 Installing document processing features using Feature Manager

Follow these steps to install document processing features using the RICOH ProcessDirector Feature Manager.
    Note:
  • Features are installed in trial mode. After the features are installed in trial mode, you can download and install license keys for them using the instructions in the RICOH ProcessDirector: Planning and Installing guide.
  • To see whether a feature is running in trial mode, choose Administration Licenses and look at the License State column. To see how many days remain for the feature in trial mode, select View log in the RICOH ProcessDirector System Summary portlet to open the system log.

To install one or more document processing features:

  1. If you use RICOH ProcessDirector for Linux and have one or more secondary servers defined and started, stop all of the secondary servers.
  2. Log in to RICOH ProcessDirector as a user authorized to use Feature Manager.
  3. Click the Administration tab.
  4. In the left pane, choose Utilities Features.
    If you see an error message, you must start Feature Manager manually:
    1. Log in to the primary computer. On Linux, log in as the RICOH ProcessDirector system user (aiw1 is the default). On Windows, log in as an administrator.
    2. On Linux, open a command prompt and type: startaiw -f
    3. On Windows, click the Windows Start button, type services to search for the Services App, and click the Services App. Then, right-click the Feature Manager Service and select Restart.
    4. Reload the Feature Manager web page.
  5. If the feature that you want to install is not listed, you must import it. See Adding or upgrading a feature using Import Package in the RICOH ProcessDirector Information Center for details about importing the feature package.
  6. If the feature that you want to install is in the list, select the check box next to it.
  7. In the Available versions column for each feature, select the version of the feature you want to install.
  8. Click Install.
  9. Review the information in the confirmation window, then click OK to continue.
    The features are installed, then RICOH ProcessDirector is restarted to finish the install process.
  10. Click DISMISS to close the Feature Manager browser tab.
  11. To complete the process, clear your browser cache.
    Information that is stored in the browser cache can cause errors when you try to use the newer level. Clearing the cache prevents those errors.
  12. Log in again.
  13. Restart any secondary servers that you stopped in step 1.
The feature or features are installed and RICOH ProcessDirector is restarted to finish the install process.
    Note:
  • If you see error messages during the installation process, you can review the logs located in /path/extensions/doc1 (Linux) or \path\extensions\doc1 (Windows). For example, on Linux, the path is /opt/infoprint/ippd. On Windows, the path is C:\Program Files\Ricoh\ProcessDirector.

1.4.4.1.2 Defining custom document properties

You use custom document properties to extract data from each document in a job. First you define the custom document properties in RICOH ProcessDirector, and then you map data in the documents to the document properties. As a job goes through the workflow, the IdentifyPDFDocuments step (PDF files) or IdentifyDocuments step (AFP files) extracts the data.

Identify data that you want to extract from documents. If RICOH ProcessDirector supplies an appropriate document property, use it instead of defining a custom document property.

For example, you want to extract account number, customer name, email address, and statement date from each document in a job. RICOH ProcessDirector supplies a document property, Email address, for extracting email addresses. You define custom document properties for account number, customer name, and statement date.

    Note:
  • If you use custom document properties, starting with Version 3.11.2, you can create them on the Administration tab, using Objects Custom Properties.

    You can choose the database name and the label that displays in property notebooks and column headings. You can also choose what kind of data to store in the property, and the default access that the different user groups have for the property, without adding them to the docCustomDefinitions.xml file.

    For more information, see the topics Custom job and document properties and Creating and activating custom properties.

  • If you already have custom document properties defined in a docCustomDefinitions.xml file, you can continue to use them. Do not re-create them from the Administration tab. Only use that tab to create new job or document properties.
  • If you want to use the new function made available in RICOH ProcessDirector in Version 3.11.2 to create a custom property:
To define custom document properties:
  1. Choose the type of custom document property:
    • Database property
    • Limited property

    For more information about the docCustomDefinitions.xml file, see docCustomDefinitions.xml file.

  2. Choose a database (internal) name for the custom document property.

    For example, define a custom document property with the database name Doc.Custom.AccountNumber.

      Note:
    • We recommend that the database names of your custom document properties start with Doc.Custom. If you do not use this naming convention, verify that none of your custom document properties have the same database name as a document property supplied with RICOH ProcessDirector.

    • Do not use a number immediately after the period (.) in the database name. For example, the database name Doc.3rdLineAddress is not valid.
    • Do not delete custom document properties after you add them to the docCustomDefinitions.xml file.

    • Do not change the name (database name), dataType, or dbType of a custom document property. The system lets you change caption (user interface name), shortCaption, description, and access.

  3. Choose a user interface name (caption) for the custom document property.

    For example, define a custom document property with the user interface name Account number.

      Note:
    • We recommend that you do not define a custom document property with the same user interface name as a document property supplied by RICOH ProcessDirector.
  4. Choose a datatype (dataType) for the custom document property.

    Examples include String, Integer, IntegerNonNeg, and Timestamp.

  5. For database properties:
    1. Choose a database type (dbType).

      For the String datatype, database types are char, varchar, and long varchar.

      For the Integer datatype, database types are smallint, bigint, and integer.

      For the Timestamp datatype, the database type is Timestamp.

    2. Choose the level of access that users have to the custom document property:

      • attrWriteAdmin

        Members of the Administrator security group have write access. Members of the Monitor, Operator, and Supervisor security groups have read access.

      • attrWriteAdminSuper

        Supervisors and Administrators have write access. Monitors and Operators have read access.

      • attrWriteAdminSuperOper

        Operators, Supervisors, and Administrators have write access. Monitors have read access.

      If you do not specify an access level, Administrators have write access. Monitors, Operators, and Supervisors have read access.

        Note:
      • If you created your own security groups, they receive the same access to custom document properties as the RICOH ProcessDirector security groups that you copied to create your groups.

    3. Choose a short caption.

      The short caption is displayed in table column headings.

      For example, define a custom document property with the short caption Acct Nmbr.

    4. Choose a description.

      The user interface displays the description as help for the custom document property.

      For example, define a custom document property with the description Customer account number.

  6. Edit the document properties configuration file:
    • The first time that you define custom document properties, make a copy of the supplied sample file. Go to this directory:
      • /aiw/aiw1/samples/config on Linux

      • C:\aiw\aiw1\samples\config on Windows

    • When you define more document properties, make a copy of the active file. Go to this directory:
      • /aiw/aiw1/config on Linux

      • C:\aiw\aiw1\config on Windows

  7. Copy the docCustomDefinitions.xml file to a working directory, and edit the file.

    Keep a backup copy of the edited file for recovery purposes.

    For example, these lines add two database document properties with the database names Doc.Custom.AccountNumber and Doc.Custom.StatementDate to the file:

    <docProperty name="Doc.Custom.AccountNumber"
       datatype="String"
       dbType="varchar (32)"
       access="attrWriteAdmin"
       shortCaption="Acount number"
       caption="Account number"
       description="Customer account number"/>
    
    <docProperty name="Doc.Custom.StatementDate"
       datatype="Timestamp"
       dbType="Timestamp"
       access="attrWriteAdmin"
       shortCaption="Statement date"
       caption="Statement date"
       description="The date the statement was created"/>
      Note:
    • The name line defines the database name. The caption line defines the user interface name.

    These lines add two limited document properties with the internal names Doc.Custom.SSNumber and Doc.Custom.CheckAmt to the file:

    <limitedProperties>
    
       <docProperty name="Doc.Custom.SSNumber"
          datatype="String"
          caption="Social Security number"/>
    
       <docProperty name="Doc.Custom.CheckAmt"
          datatype="String"
          caption="Check total"/>
    
    </limitedProperties>
  8. Use an XML editor to validate your syntax.
  9. Copy the edited file to:
    • /aiw/aiw1/config/docCustomDefinitions.xml (Linux)
    • C:\aiw\aiw1\config\docCustomDefinitions.xml (Windows)
  10. To have any new document properties display correctly on the user interface, edit the docCustomDefinitions.properties file for one or more languages. If you do not define labels for the new properties in this file, you will only see database names for the properties on the user interface. See Naming custom document properties in more than one language for the steps to edit the file.
  11. Make the custom document properties that you have defined available to RICOH ProcessDirector:
    1. Run the docCustom utility.
      The first time that you run the docCustom utility, it creates the Custom Document Properties feature and adds it to Feature Manager. When you run the utility again, it adds an updated Custom Document Properties feature to Feature Manager.
    2. Use Feature Manager to install or update the Custom Document Properties feature.
  12. Load the RICOH ProcessDirector updated custom document properties to the tool you use to configure document properties:
    • If you have the PDF Document Support feature, load RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.

      For more information, see the related topic in the information center.

    • If you have the AFP Support feature, use one of these methods to start RICOH Visual Workbench:
      • Start RICOH Visual Workbench from the RICOH ProcessDirector server.

      • Replace the RICOH Visual Workbench application on your desktop:

        • Delete the VisualWorkbench.zip file and all of the unzipped files.

        • Download the VisualWorkbench.zip file from the RICOH ProcessDirector user interface.

        • Unzip the file, and start the new RICOH Visual Workbench desktop application.

      The document properties are loaded automatically.

1.4.4.1.3 Naming custom document properties in more than one language

To define user interface names and descriptive information for your custom document properties in more than one language, you edit a language-specific version of the docCustomDefinitions.properties file for each language. After you update your custom document properties, RICOH ProcessDirector displays the user interface names and descriptive information for the custom document properties in each language.

In a single-language environment, the preferred method of defining user interface text for custom document properties is to use the caption and description attributes of the docProperty element in the docCustomDefinitions.xml file. If you are using a single language and all custom document property descriptive text is defined in docCustomDefinitions.xml, do not edit the docCustomDefinitions.properties file.

For more information about the format of the docCustomDefinitions.properties file, see docCustomDefinitions.properties file.

To name custom document properties in more than one language:

  1. Make a working copy of the docCustomDefinitions.properties file for each language:
    • The first time that you name custom document properties in more than one language, make one copy of the sample docCustomDefinitions.properties file for each language except your default language. Navigate to this directory:

      • /aiw/aiw1/samples/config on Linux

      • C:\aiw\aiw1\samples\config on Windows

      Copy the docCustomDefinitions.properties file to a working directory.

      Name each file docCustomDefinitions_language.properties. For example:

      • docCustomDefinitions_de.properties (German)

      • docCustomDefinitions_en.properties (English)

      • docCustomDefinitions_es.properties (Spanish)

      • docCustomDefinitions_fr.properties (French)

      • docCustomDefinitions_it.properties (Italian)

      • docCustomDefinitions_ja.properties (Japanese)

      • docCustomDefinitions_pt.properties (Brazilian Portuguese)

        Important:
      • Do not create a docCustomDefinitions_language.properties file for your default language.

      • Make sure each file is owned by the RICOH ProcessDirector system user and group (aiw1 and aiwgrp1 are the defaults).

    • When you name additional document properties in more than one language, navigate to this directory:

      • /aiw/aiw1/config on Linux

      • C:\aiw\aiw1\config on Windows

      Copy each docCustomDefinitions_language.properties file to a working directory.

  2. Edit each file to add your new custom document properties.

    The entry for each custom document property has three lines:

    • Short caption

    • User interface name

    • Description

    These lines add two custom document properties with the database names Doc.Custom.AccountNumber and Doc.Custom.StatementDate to the docCustomDefinitions_es.properties file:

    Doc.Custom.AccountNumber.Short=Número de cuentaDoc.Custom.AccountNumber=Número de cuentaDoc.Custom.AccountNumber.Description=Número de cuenta del clienteDoc.Custom.StatementDate.Short=Fecha de extractoDoc.Custom.StatementDate=Fecha de extractoDoc.Custom.StatementDate.Description=Fecha en que se creó el extracto

    Keep a backup copy of each edited file for recovery purposes.

  3. If you did not create the file in Latin-1 or Unicode format, run the native2ascii utility to convert the file to Unicode Latin-1 format.

    • On Linux, the native2ascii utility is at /opt/infoprint/ippd/jre/bin.

    • On Windows, the native2ascii.exe utility is at C:\Program Files\Ricoh\ProcessDirector\jre\bin.

    For detailed information, see Considerations for a system with more than one language.

  4. Make sure that each docCustomDefinitions_language.properties file uses the ISO-8859-1 character encoding format (codepage).
    If your files use a different format, such as Shift JIS or UTF-8, convert them to ISO-8859-1 format before placing them in the configuration directory.
  5. Copy each edited file to the configuration directory:
    • /aiw/aiw1/config on Linux
    • C:\aiw\aiw1\config on Windows
      Important:
    • Do not delete the docCustomDefinitions.properties file. The system requires a file with that name in the configuration directory.
  6. Make the custom document properties that you have named in multiple languages available to RICOH ProcessDirector:
    1. Run the docCustom utility.
      The first time that you run the docCustom utility, it creates the Custom Document Properties feature and adds it to Feature Manager. When you run the utility again, it adds an updated Custom Document Properties feature to Feature Manager.
    2. Use Feature Manager to install or update the Custom Document Properties feature.
  7. Load the RICOH ProcessDirector updated custom document properties to the tool you use to configure document properties:
    • If you have the PDF Document Support feature, load RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.

      For more information, see the related topic in the information center.

    • If you have the AFP Support feature, use one of these methods to start RICOH Visual Workbench:
      • Start RICOH Visual Workbench from the RICOH ProcessDirector server.

      • Replace the RICOH Visual Workbench application on your desktop:

        • Delete the VisualWorkbench.zip file and all of the unzipped files.

        • Download the VisualWorkbench.zip file from the RICOH ProcessDirector user interface.

        • Unzip the file, and start the new RICOH Visual Workbench desktop application.

      The document properties are loaded automatically.

1.4.4.1.3.1 Considerations for a system with more than one language

If you are using a language other than English on your system, or if you want to let users see user interface text for custom document properties in more than one language, you might need to do these tasks.
Identifying the code page in docCustomDefinitions.xml

At the top of the docCustomDefinitions.xml file, make sure you correctly identify the code page so that the file can be processed correctly when you update configuration files. Here are some examples of valid code page declarations:

  • <?xml version="1.0" encoding="UTF-8"?> (specified in the sample file)
  • <?xml version="1.0" encoding="iso-8859-1"?> (Latin-1)
  • <?xml version="1.0" encoding="shift_jis"?> (Japanese)

Making sure the document properties names files are in ISO-8859-1 format

The docCustomDefinitions.properties file and docCustomDefinitions_language.properties files must contain only Latin-1 or Unicode-encoded (\udddd notation) characters. If you created your docCustomDefinitions.properties and docCustomDefinitions_language.properties files in a different format (such as Shift JIS or UTF-8), you must convert each file to ISO-8859-1 before placing it in the /aiw/aiw1/config (UNIX-based operating systems) or C:\aiw\aiw1\config (Windows) directory. Although you can convert the files using whatever method you choose, this section describes one possible method: using the native2ascii utility.

The native2ascii utility converts text to Unicode Latin-1. It is shipped with RICOH ProcessDirector.

  • On Linux, the native2ascii utility is at /opt/infoprint/ippd/jre/bin.
  • On Windows, the native2ascii.exe utility is at C:\Program Files\Ricoh\ProcessDirector\jre\bin.

The utility is also provided with the Java Development Kit, which you can download from this site:

http://www.oracle.com/technetwork/java/javase/downloads

Instructions for using the utility (for Java 6) are here:

http://download.oracle.com/javase/6/docs/technotes/tools/#intl

For example, to convert a UTF-8 file named docCustomDefinitions-UTF8.properties, you can use this command:

native2ascii -encoding UTF-8 docCustomDefinitions-UTF8.properties > docCustomDefinitions.properties

1.4.4.1.4 Updating custom document properties

Whenever you define new custom document properties or name custom document properties in more than one language, you update custom document properties to make your changes available to RICOH ProcessDirector.
    Note:
  • Only use this procedure for custom document properties defined in the docCustomDefinitions.xml file. If you created custom properties using the Administration tab, this procedure is not required.
Before doing this task, verify that the syntax in the docCustomDefinitions.xml file is correct.
To update custom document properties:
  1. Log in to the primary server as the RICOH ProcessDirector system user.
    • For Linux, aiw1 is the default.
    • For Windows, log in to the Administrator account.
  2. Open a command line.
  3. Change directories.
    • For Linux, use cd /aiw/aiw1/bin.
    • For Windows, use cd C:\aiw\aiw1\bin.
  4. Enter this command to run the utility:
    docCustom
    The Custom Document Properties feature EPK file is created and available in the Feature Manager.
  5. Close the command line.
  6. Log in to RICOH ProcessDirector.
  7. Click the Administration tab.
  8. In the left pane, click Utilities Features.
  9. Select the check box for the Custom Document Properties feature.
  10. In the Available versions column for each feature, select the version of the feature you want to install.
  11. Click Install.
  12. Review the information in the confirmation window, then click OK to continue.
    The features are installed, then RICOH ProcessDirector is restarted to finish the install process.
  13. Click DISMISS to close the Feature Manager browser tab.
  14. Check that your new document properties are defined on the system:
    1. Log in to RICOH ProcessDirector.
    2. In the Documents portlet on the Main page, click By property.
    3. Click the Edit () button.
    4. Scroll through the Property list to see if it includes your new properties.

If you have the PDF Document Support feature installed and you change document property names in RICOH ProcessDirector, load a new document properties list into RICOH ProcessDirector Plug-in for Adobe Acrobat. See Loading RICOH ProcessDirector document properties for more information.

If you have the AFP Support feature installed and you change document property names in RICOH ProcessDirector, access RICOH Visual Workbench from the RICOH ProcessDirector user interface. New document properties are loaded to RICOH Visual Workbench when it opens on your workstation.

1.4.4.2 Installing RICOH ProcessDirector Plug-in for Adobe Acrobat

This section describes how to install and uninstall RICOH ProcessDirector Plug-in for Adobe Acrobat. The plug-in is included with the PDF Document Support feature.

Make sure the system on which you install RICOH ProcessDirector Plug-in for Adobe Acrobat meets the hardware and software requirements. See Planning for installation for more information. If you have a previous version of RICOH ProcessDirector Plug-in for Adobe Acrobat on the system, uninstall it.

1.4.4.2.1 Running the installation program

Follow these steps to install RICOH ProcessDirector Plug-in for Adobe Acrobat using the plug-in installer file that is copied to the primary computer during installation of the PDF Document Support feature.

The installer file that comes with the PDF Document Support feature is placed here:

  • On Windows: C:\aiw\aiw1\share\Ricoh-ProcessDirector-Plug-in-for-AdobeAcrobat-Setup.exe
  • On Linux: /aiw/aiw1/share/Ricoh-ProcessDirector-Plug-in-for-AdobeAcrobat-Setup.exe

To run the installation program:

  1. Download the installer file from the primary computer to the Windows computer that has Adobe Acrobat installed on it using the RICOH ProcessDirector user interface.
    1. On the client Windows computer, log in as an administrator.
    1. Log in to RICOH ProcessDirector as a member of the Administrator group.
    2. Click the Administration tab.
    3. In the left pane, choose Utilities Plug-in for Adobe Acrobat.
    4. Click RICOH ProcessDirector Plug-in for Adobe Acrobat.
      The browser's default file download process is used to transfer the file. You might have to choose where to store the file.
    5. Log out of RICOH ProcessDirector.
  2. Close all open applications that could be using Adobe Acrobat, Distiller, or Reader. Many Web browsers use Adobe Acrobat Reader, so make sure to close all Web browsers.
  3. Find the directory where you downloaded the installer file and double-click the file.
    The installer starts.
  4. Optional: For setup information including hardware and software requirements, click Setup Guide.
    Adobe Acrobat must be closed during the installation process. Print these instructions if you want to view them during installation.
  5. Follow the prompts to complete the installation.
  6. Depending on your current configuration, the installer might ask to update some Microsoft libraries.
  7. Verify the installation by opening a PDF file using Adobe Acrobat.
    • In the traditional view of Adobe Acrobat, check the menu bar. You should see the Ricoh menu.
    • In the new Adobe Acrobat experience (introduced in May 2023), select Menu Plug-ins. You should see a sub menu for Ricoh.
  8. If you cannot see the Ricoh menu or sub-menu, check the default values for these Adobe settings:
    1. Open the Preferences dialog:
      • In the traditional view, click Edit Preferences.
      • In the new Adobe Acrobat experience, select Menu Preferences.
    2. Select the General category.
    3. In the Application Startup section, make sure that Use only certified plug-ins is not selected.
    4. Select the Security (Enhanced) category.
    5. In the Sandbox Protections section, you might see an option called Enable Protected mode at startup. Make sure this option is not selected.

Before you start using the plug-in to enhance PDF files, open Adobe Acrobat and review the help for the RICOH ProcessDirector Plug-in for Adobe Acrobat. To open the help:

  • In the traditional view, click Ricoh Help
  • In the new Adobe Acrobat experience, select Menu Plug-ins Ricoh Help.

Review the topics about preferences, loading document properties, and adding the Plug-in icon to the Acrobat quick launch bar. These topics describe how to tailor the Plug-in to your environment.

1.4.4.2.2 Loading RICOH ProcessDirector document properties

To use RICOH ProcessDirector Plug-in for Adobe Acrobat to define text in a PDF file as a RICOH ProcessDirector document property, you must import the list of RICOH ProcessDirector document properties.
You must do this task:
  • After you install RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • After changes are made to property definition files, you have run the docCustom utility, and you have installed or upgraded the Custom Document Properties feature.
  1. Close Adobe Acrobat Professional.
  2. Retrieve the definitions.zip file from this directory on the RICOH ProcessDirector server that processes your PDF files:
    • Unix-based systems, /aiw/aiw1/share
    • Windows, C:\aiw\aiw1\share
    This file is generated when you install one of the document processing features and is updated when you run the docCustom utility and install or upgrade the Custom Document Properties feature.
    The definitions.zip file is downloaded when you download the plug-in installer from the Administration tab. After you make any changes to your custom document properties, you must manually download the definitions.zip file.
  3. On the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat, place the definitions.zip file in the <user_home_directory\AppData>\Roaming\InfoPrint\InfoPrintPlugin\ directory.

    For <user_home_directory\AppData>, substitute the name of the home directory application data directory for the current user.

      Note:
    • You can view the application data directory location for the current user by typing %appdata% in the Windows Run command line and clicking OK.

  4. Restart Adobe Acrobat Professional and click Ricoh Select to activate RICOH ProcessDirector Plug-in for Adobe Acrobat. The list of RICOH ProcessDirector document properties in the definitions.zip file is automatically imported into the areas of the plug-in that use document properties.
The definitions.zip file contains document properties and limited document properties. Limited document properties are not saved to a database, but they are stored in the document properties file that contains the property. For more information about both types of properties, see the topics related to document properties in the information center, for example see the topic on editing the sample document properties template.

1.4.4.2.3 Loading media objects

After installing RICOH ProcessDirector Plug-in for Adobe Acrobat, load RICOH ProcessDirector media objects. After you load them, you can use them to define media and finishing options for specific pages in a PDF file.

Whenever you change RICOH ProcessDirector media objects, do this task to load them into RICOH ProcessDirector Plug-in for Adobe Acrobat.

To load media objects:

  1. Close Adobe Acrobat Professional.
  2. On the RICOH ProcessDirector primary server, go to this directory:

    • /aiw/aiw1/share on Linux
    • C:\aiw\aiw1\share on Windows

  3. Copy the media.zip file to the <user_home_directory\AppData>\Roaming\InfoPrint\InfoPrintPlugin\ directory on the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat.

    For <user_home_directory\AppData>, substitute the name of the home directory application data directory for the current user.

      Note:
    • You can view the application data directory location for the current user by typing %appdata% in the Windows Run command line and clicking OK.
    • If the directory includes both a media.zip file and a media.xml file, RICOH ProcessDirector Plug-in for Adobe Acrobat uses the media.zip file to load the media objects.
    • The media files are not downloaded when you download the plug-in installer from the Administration tab.

  4. Restart Adobe Acrobat Professional and click Ricoh Select.

The media objects now are available in RICOH ProcessDirector Plug-in for Adobe Acrobat for defining media and finishing options.

If your RICOH ProcessDirector system includes the Preprinted Forms Replacement feature, the electronic forms defined for media objects also are available.

1.4.4.2.4 Uninstalling RICOH ProcessDirector Plug-in for Adobe Acrobat

If you need to uninstall RICOH ProcessDirector Plug-in for Adobe Acrobat, use your system's method to remove programs.
To uninstall RICOH ProcessDirector Plug-in for Adobe Acrobat:
  1. Close all instances of Adobe Acrobat.
  2. Log in to Windows as an administrator.
  3. Locate RICOH ProcessDirector Plug-in for Adobe Acrobat in your installed program list.
  4. Select it and remove it.

1.4.5 Reference

This section includes format information and examples of configuration files.

1.4.5.1 Installation and configuration checklist

This checklist can help you plan your installation and configuration process.
  Task Notes
  Decide which document properties you want to use for all the applications that you process.
 
 
 
  Define custom document properties in the document properties configuration file (docCustomDefinitions.xml).
 
 
 
  Optional: To name custom document properties in more than one language, edit the associated docCustomDefinitions.properties file.
 
 
 
  Optional: Edit the sample document properties template file.
 
 
 
  Run the docCustom utility and install or update the Custom Document Properties feature.
 
 
 
  If you have the PDF Document Support feature, load RICOH ProcessDirector document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
 
 
 
  If you have the PDF Document Support feature, use RICOH ProcessDirector Plug-in for Adobe Acrobat to define the document properties and map them to document data.

If you have the AFP Support feature, use the AFP Indexer mode of RICOH Visual Workbench to create index tags in AFP files. Use the Document Property Designer mode to link custom document properties to the index tags.

 
 
 
  Create or edit step templates and workflows as needed.
 
 
 
  Optional: If you have the AFP Support feature, create the Enhance AFP control file.
 
 
 

1.4.5.2 docCustomDefinitions.xml file

The document properties configuration file (docCustomDefinitions.xml) defines properties that are used to manage documents. The installation process places a sample file in /aiw/aiw1/samples/config on UNIX-based operating systems, and in C:\aiw\aiw1\samples\config on Windows.

    Note:
  • If you change the docCustomDefinitions.xml file after installing Advanced Document Pool, AFP Support, or PDF Document Support:
    • Run the docCustom utility and install or upgrade the Custom Document Properties feature.
    • For the PDF Document Support feature, load the document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat.
    • For the AFP Support feature, access RICOH Visual Workbench from the RICOH ProcessDirector user interface. New document properties are loaded to RICOH Visual Workbench when it opens on your workstation.

Database properties and limited properties

You can define two types of document properties:

  • Database properties
  • Limited properties

You can store and manipulate both types of properties in a document properties file, but only database properties are stored in the database.

You can work with both types of properties in these ways:

  • You can use them with steps in a workflow to group or sort documents (for example, with the SortDocuments step template).
  • You can link them to AFP index tags using the RICOH Visual Workbench Document Property Designer.
  • You can map document data in PDF jobs to them using RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • If you have the Archive feature, you can store them in a repository. After you store them, you can use them to search the repository and retrieve jobs, documents, and history information. The values of the properties appear on the Properties tab when you click Show details on the Results table.
  • If you have the Preference Management feature, you can use an external preferences file to set the values of the properties.

You can work with database properties, but not limited properties, in these ways:

  • You can use them to search for documents on the Documents portlet on the Main page of the user interface.
  • When you select a document on the Documents portlet, the values of database properties are displayed.
  • You can use them to search for documents to display in the viewer.
  • You can determine their values in one job, update their values in another job, and use the updated values in the original job.
  • If you have the Automated Verification or Inserter feature, you can use database properties to search for documents to reconcile or reprint.
  • If you have the Advanced Document Pool extended feature, you can use selectors to manipulate documents based on their property values.

Limited properties offer these advantages:

  • You can use them to avoid displaying sensitive property values in the user interface, such as Social Security numbers or check amounts.
  • They maximize system performance. Database property manipulation can degrade performance if you process a significant number of documents.

Work with your support representative to determine your needs for database and limited document properties.

Sections in sample file

The sample docCustomDefinitions.xml file contains several sections. This table summarizes them.

Sections in the docCustomDefinitions.xml file
Section Purpose
Schema The schema section identifies the schema and the unique character string for the custom document properties. Only the support representative should edit this section.
Database properties This section defines database document properties.
Limited properties This section defines limited document properties.
User authorization properties This section is optional. User authorization properties specify custom authority groups for access to database properties.

Schema section

The Schema section contains one docCustomDefinitions element and one schema element. Only support representatives should edit the schema section.

Database properties section

The Database properties section contains the docProperty element.

    Note:
  • Do not define a property as both a database property and a limited property. Unexpected behavior might occur.
  • Do not define a document property with the same name as a property that RICOH ProcessDirector defines automatically. For a list, see Automatically defined document properties.
<docProperty>
Defines document properties that are in the database.
Attributes for the docProperty element
docProperty attribute Required? Notes
name Yes The database name (internal name) for the property. Programs that read or write properties use this name. We recommend that you use a consistent naming convention for your custom property names, so they are unique across the entire system. For example, the sample docCustomDefinitions.xml file uses the prefix Doc.Custom to make its properties unique from those of the base product.

Do not use any special characters (such as @, #, $, %, or - (dash)) or spaces in the property name. You can use periods and underscores.

Do not use a number immediately after the period (.) in the property database name. For example, the property Doc.3rdLineAddress is not valid.

access No The user access level for the property. You can use an access level that is already defined in the product, or you can create a custom access level if an existing one does not meet your needs. See the Access section for more information.
datatype Yes The data type to use for the property. See the next table.
dbType No A database parameter that specifies the type of data.
    Note:
  • The dbType property has been deprecated and is no longer used. Use the datatype property instead.
caption Yes The user interface name (default caption) for the property. If you are setting up captions in only one language, define them in this file. If you are setting up user interface names in more than one language, create additional document properties names files (docCustomDefinitions_language.properties) for the other languages. For more information, see docCustomDefinitions.properties file.
shortCaption Yes The default short caption displayed for this property where required, such as in table column headings. If you are setting up short captions in only one language, define them in this file. If you are setting up short captions in more than one language, create additional document properties names files (docCustomDefinitions_language.properties) for the other languages. For more information, see docCustomDefinitions.properties file.
description Yes The default description of the document property, which displays in the user interface as help text. If you are setting up descriptions in only one language, define them in this file. If you are setting up descriptions in more than one language, create additional document properties names files (docCustomDefinitions_language.properties) for the other languages. For more information, see docCustomDefinitions.properties file.

You can use these data types and database types in database property definitions. Keep in mind that the database definition might further restrict the values that can be stored, in addition to the validation rules shown in this table. For example, a SMALLINT can store integers from 0 to 32,767. Database type values are not case-sensitive.

Data types and database types for docProperty definitions
Data type Database type (used in SQL) Validation for data type
String VARCHAR(128) VARCHAR: variable length, 1–128 characters
IntegerNonNeg SMALLINTBIGINTINTEGER SMALLINT: 2 bytesBIGINT: 4 bytesINTEGER: 8 bytesMinimum=0
Timestamp TIMESTAMP TIMESTAMP: Must contain values for day (D), month (M), and year (Y).Those components can appear in one of these formats:MM DD YYYYDD MM YYYYYYYY MM DDDay and month must be represented by a two-digit number.You can add a time of day in this format:hh:mm:ss
XdkString10 VARCHAR(10) VARCHAR: variable length, 1–10 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString20 VARCHAR(20) VARCHAR: variable length, 1–20 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString30 VARCHAR(30) VARCHAR: variable length, 1–30 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString40 VARCHAR(40) VARCHAR: variable length, 1–40 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString50 VARCHAR(50) VARCHAR: variable length, 1–50 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

XdkString128 VARCHAR(128) VARCHAR: variable length, 1–128 characters

    Note:
  • These values are variations of the String data type that can be used instead of String to reduce the amount of space reserved in the database for property values.

Limited properties section

The Limited properties section contains one or more docProperty elements.

    Note:
  • Do not define a property as both a database property and a limited property. Unexpected behavior might occur.
  • Do not define a document property with the same name as a property that RICOH ProcessDirector defines automatically. For a list, see Automatically defined document properties.
<docProperty>
Defines document properties that are manipulated only in the document properties file and not in the database.
Attributes for the docProperty element
docProperty attribute Required? Notes
name Yes We recommend that you use a consistent naming convention for your custom property names, so that they are unique across the entire system. For example, the sample docCustomDefinitions.xml file uses the prefix Doc.Custom to make its properties unique from the base product.

Do not use any special characters (such as @, #, $, %, or - (dash)) or spaces in the property name. You can use periods and underscores.

Do not use a number immediately after the period (.) in the property database name. For example, the property Doc.3rdLineAddress is not valid.

datatype No See the next table.
caption No The caption displayed in lists in the user interface for this property. If you are setting up captions in only one language, define them in this file. If you are setting up captions in more than one language, create a document properties names file (docCustomDefinitions_language.properties) for the other languages. See the related information center topic for details.

You can use these data types in docProperty definitions:

Data types for the docProperty element
Data type Validation for data type
String
None
IntegerNonNeg
Integer between 0 and 2147483647
Timestamp TIMESTAMP: Must contain values for day (D), month (M), and year (Y).Those components can appear in one of these formats:MM DD YYYYDD MM YYYYYYYY MM DDDay and month must be represented by a two-digit number.You can add a time of day in this format:hh:mm:ss

User authorization properties section

The User authorization properties section is optional. User authorization properties specify custom authority groups for access to database properties. This section contains one or more access elements.

<access>
Used to define the ability to read or edit custom properties. You use these access levels in the docProperty element. You can use one of the default security groups that RICOH ProcessDirector provides, or define your own. These are the attributes:
Attributes for the access element
access attribute Notes
name Name of the access level.
groupAttributeAccess Ability of the user group to read or edit the attribute.
These are the default access levels and authorizations that RICOH ProcessDirector provides:
Default access levels and authorizations
Access name Group name Access level
generic AnyAuthenticated Attribute access: read
Operator Attribute access: read
Supervisor Attribute access: read
Administrator Attribute access: write
attrWriteAdmin Operator Attribute access: read
Supervisor Attribute access: read
Administrator Attribute access: write
Everyone Attribute access: read
Monitor Attribute access: read
attrWriteAdminSuper Operator Attribute access: read
Supervisor Attribute access: write
Administrator Attribute access: write
Everyone Attribute access: read
Monitor Attribute access: read
attrWriteAdminSuperOper Operator Attribute access: write
Supervisor Attribute access: write
Administrator Attribute access: write
Everyone Attribute access: read
Monitor Attribute access: read
actionAdmin Operator Action access: false
Supervisor Action access: false
Administrator Action access: true
Everyone Action access: false
Monitor Action access: false
actionAdminSuper Operator Action access: false
Supervisor Action access: true
Administrator Action access: true
Everyone Action access: false
Monitor Action access: false
actionAdminSuperOper Operator Action access: true
Supervisor Action access: true
Administrator Action access: true
Everyone Action access: false
Monitor Action access: false
Automatically defined document properties

This table lists document properties that RICOH ProcessDirector automatically defines during installation. Do not define these properties in the docCustomDefinitions.xml file.

Automatically defined document properties
Property database name Packaged with... Notes
Doc.Address.1 Postal Enablement Specifies the first line of the address block in the document.
Doc.Address.Company Postal Enablement Specifies the company name in the document.
Doc.Address.PostalCode Postal Enablement Specifies the zip code in the document.
Doc.Address.ZipCode Postal Enablement Specifies the zip code in the document.
Doc.AV.ScanCount Automated Verification Shows the number of times the barcode on a document is scanned.
Doc.ChildJobID All document processing features A grouping identifier for child jobs. Although the value is initially defined in IdentifyDocuments or IdentifyPDFDocuments, it can be updated by any step that changes the document properties file, such as SplitDocuments or CreateJobsFromDocuments.
Doc.CurrentFirstPage All document processing features The page number of the first page of the document in the current print file.
Doc.CurrentJobID All document processing features The associated job number.
Doc.CurrentPages All document processing features The number of pages for the document in the current job.
Doc.CurrentSequence All document processing features The sequence of the document in the current job.
Doc.CurrentSheets All document processing features The number of sheets for the document in the current job.
Doc.Custom.MemberLevel Electronic Presentment The customer’s level of membership at the time the statement was created.
Doc.Custom.PURL Electronic Presentment A personalized URL linking to the location where the customer can retrieve the statement.
Doc.Custom.StatementDate Electronic Presentment The date of when the statement was first issued.
Doc.DataLen All document processing features The length (in bytes) of the document in the print file.
Doc.DataOffset All document processing features The byte offset of the document in the print file of the original job. This value is used by BuildAFPFromDocuments and CreateAFPJobsFromDocuments to locate the AFP to extract from the original job.
Doc.DocSize.PieceThickness Postal Enablement Specifies the thickness of a mail piece when the mail pieces in a job have different thicknesses.
Doc.DocSize.PieceWeight Postal Enablement Specifies the weight of a mail piece when the mail pieces in a job have different weights.
Doc.Email.Sent All document processing features Specifies whether an email with an attached document has been created and delivered to the SMTP server by the EmailDocuments step in a workflow.
Doc.EmailAddress All document processing features The email address associated with the document.
Doc.ID All document processing features A unique identifier for the document.
Doc.Insert.BinTriggers Inserter The inserter bins that should deliver inserts for this document.
Doc.Insert.DivertBin Inserter The number of the inserter output bin to which the document is diverted after insertion.
Doc.Insert.OriginalBarCode Inserter The data in the barcode that controls insertion of the document.
Doc.Insert.RecipientName Inserter The name of the person to whom this document is mailed.
Doc.Insert.ReprintJobId Inserter For an inserter reprint job, the parent job ID that created the job.
Doc.Member.Number Archive Specifies the member number in the document. The RepositorySample supplied workflow uses this property.
Doc.OriginalFirstPage All document processing features The page number of the first page of the document.
Doc.OriginalJobID All document processing features The job ID of the original job.
Doc.OriginalPages All document processing features The number of pages in the document.
Doc.OriginalSequence All document processing features The sequence of the document in the original job. The system gives the first document the sequence value 1, the next document has the sequence value 2, and so on.
Doc.OriginalSheets All document processing features The number of sheets needed to print the document.
Doc.Postal.AddressProcessingRC Postal Enablement A value returned from postal software to indicate if an address change is available for the document.
Doc.Postal.Category Postal Enablement Specifies the pallet break mark for the document.
Doc.Postal.ChangeAddressRC Postal Enablement Specifies the pallet number for the document.
Doc.Postal.ContainerBreakMark Postal Enablement Specifies the container break mark for the document.
Doc.Postal.ContainerNumber Postal Enablement Specifies the container number for the document.
Doc.Postal.HandlingUnitBreakMark Postal Enablement Specifies the package break mark for the document.
Doc.Postal.HandlingUnitNumber Postal Enablement Specifies the package number for the document.
Doc.Postal.PackageBreakMark Postal Enablement Specifies the postage rate for the document.
Doc.Postal.PackageNumber Postal Enablement Specifies the postage rate code for the document.
Doc.Postal.PostageRate Postal Enablement Specifies the presort sequence number for the document.
Doc.Postal.PostageRateCode Postal Enablement A value returned from postal sorting software to indicate the result of its processing.
Doc.Postal.SequenceNumber Postal Enablement The sequence of the document in the child job.
Doc.Postal.SequencingProcessingRC Postal Enablement The state of the document.
Doc.Pref.Member Preference Management Can be used with a property mapping object to identify the documents in a job. The DelimitedSample supplied property mapping object and PreferencesSample supplied workflow use this property.
Doc.Pref.Output Preference Management Can be used with a property mapping object to indicate the output type (such as Email, Print, or Suppress) for a document. The DelimitedSample supplied property mapping object and PreferencesSample supplied workflow use this property.
Doc.Pull All document processing features Can be used with the SetDocPropsFromList step template to indicate that a document should be removed from a job. The PullPDFSample and PullAFPSample supplied workflows use this property.
Doc.PullProp All document processing features Can be used with the SetDocPropsFromList step template to identify which document property determines the documents to be removed from a job. The PullPDFSample and PullAFPSample supplied workflows use this property.
Doc.SequenceInChild All document processing features The sequence of a document in a child job. Although the value is initially defined in IdentifyDocuments, it can be updated by any step that changes the document properties file, such as SortDocuments or CreateJobsFromDocuments.
Doc.SourceFileName All document processing features The name of the input file that contained the document.
Doc.State All document processing features The current state of the document.
Doc.TT.BarcodeStatus1 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus2 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus3 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus4 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.TT.BarcodeStatus5 Automated Verification Shows whether the barcode on a document has been read correctly by the camera or barcode scanner associated with a ReadBarcodeData step.
Doc.Verification.Recipient Automated Verification Specifies information, such as account name, that helps you to identify a document.

1.4.5.3 docCustomDefinitions.properties file

The document properties names file (docCustomDefinitions.properties) defines user interface information for custom document properties. The entries in the docCustomDefinitions.properties file correspond to the docProperty elements in the docCustomDefinitions.xml file.
    Note:
  • If you change the docCustomDefinitions.properties file or any docCustomDefinitions_language.properties files after installing the feature:
    • Run the docCustom utility and install or upgrade the Custom Document Properties feature.
    • For PDF document processing features, load the document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see RICOH ProcessDirector: Installing Document Processing Features.
    • For AFP document processing features, access RICOH Visual Workbench from the RICOH ProcessDirector user interface. New document properties are loaded to RICOH Visual Workbench when it opens on your workstation.

The entries in the docCustomDefinitions.properties file are used in the RICOH ProcessDirector user interface when you select custom document properties from lists, or when you view field help for a custom document property. A sample file is in the /samples directory on the feature CD, and the installation process places a sample file in /aiw/aiw1/samples/config on Linux, and in C:\aiw\aiw1\samples\config on Windows.

Create a separate docCustomDefinitions_language.properties file for each additional language that you want to support, using a language identifier in each file name. For example:

  • docCustomDefinitions_de.properties (German)
  • docCustomDefinitions_en.properties (English)
  • docCustomDefinitions_es.properties (Spanish)
  • docCustomDefinitions_fr.properties (French)
  • docCustomDefinitions_it.properties (Italian)
  • docCustomDefinitions_ja.properties (Japanese)
  • docCustomDefinitions_pt.properties (Brazilian Portuguese)

You create a stanza of caption and description values for every document property.

[property]
The full property name.
[property].Description
A description of the property. Use HTML tags if you want to format the text. This content appears in the field help when the user clicks the ? button.

For example:

Doc.Custom.Zip=ZIP code
Doc.Custom.Zip.Description=The ZIP code of an address

    Note:
  • Do not rename the default docCustomDefinitions.properties file; a file with this name must exist in your configuration directory (/aiw/aiw1/config). Copy the file and name the copy with the appropriate language identifier as needed.
  • The docCustomDefinitions.properties file and any docCustomDefinitions_language.properties files must use the ISO-8859-1 character encoding (code page). If you create your docCustomDefinitions.properties files in a different format (such as Shift JIS or UTF-8), you must convert the file to ISO-8859-1 when placing it in the /aiw/aiw1/config directory.

1.4.5.4 Document properties template file

The document properties template file, if it exists, determines which properties go into the document properties file for each job. The template file lets you control the number of document properties to be used, as well as the order of the columns in the document properties file. If you need to maximize performance on your system by assigning only a subset of document properties, make sure that any properties needed by your workflow steps are listed in the document properties template file.

A sample document properties template file is located on the product CD in the /samples directory. After installation, you can find it in the directory /path/extensions/doc/samples/. For example, on Linux, the path is /opt/infoprint/ippd. On Windows, the path is C:\Program Files\Ricoh\ProcessDirector.

The document properties template file lists the database names of document properties. You can include all entries on a single line with a space or a tab character between each property, or you can place each entry on a separate line. When a step based on the ReadDocumentsFromDatabase step template creates the document properties file, it copies the first line from the template file. Then the step creates a separate line for each document associated with the job. Each document description line lists the property values, separated by a tab or space character, in the same order that they appear in the first line. If a value is Not set, an empty string ('') is placed in the file.

Using a document properties template file is optional, but recommended if you need to maximize performance. If you do not use it, all document properties are included in the generated document properties file.

The document properties template file must include all the properties needed by steps that process the document properties file. In addition, the document properties template file must include certain properties, depending on the step that is using the template file. These properties are required by BuildPDFFromDocuments, CreateAFPJobsFromDocuments, and BuildAFPFromDocuments:

  • Doc.ChildJobID (*)
  • Doc.OriginalJobID (*)
  • Doc.OriginalSequence (*)
  • Doc.SequenceInChild (*)
  • Doc.OriginalSheets
  • Doc.DataOffset (for AFP jobs)
  • Doc.DataLen (for AFP jobs)

Document properties marked with an asterisk (*), as well as the Doc.ID property, are automatically included in the document properties file whether or not they are defined in the template.

1.4.5.5 Document properties file

RICOH ProcessDirector uses information from the document properties file in these processes:

  • Steps that sort, group, and split documents. For example, if you want to use a step to sort documents by ZIP code, a property such as Doc.Custom.ZipCode must be in the document properties file.
  • External programs that process document properties.
  • Steps that process document properties files for use with postal software. The Postal Enablement feature provides these steps: BuildExternalDocPropsFle, MapExternalResultsFileToDocProps, and UpdateDocPropsFromExtResultsFile. For these steps to run successfully, the Doc.ID or Doc.SequenceInChild property must be included in the document properties file.
  • Steps that process document properties files for use with values from external files. All document processing features provide the SetDocPropsFromList and EmailDocuments steps. The Preference Management feature provides the ApplyPreferences step.
  • Steps that process AFP documents, such as steps based on the CreateAFPJobsFromDocuments and BuildAFPFromDocuments step templates. For either the CreateAFPJobsFromDocuments or BuildAFPFromDocuments steps to run successfully, these properties must be included in the document properties file:
    • Doc.OriginalJobID
    • Doc.ChildJobId
    • Doc.SequenceInChild
    • Doc.OriginalSequence
    • Doc.OriginalSheets
    • Doc.DataOffset
    • Doc.DataLen
  • Steps that process PDF documents, such as steps based on the BuildPDFFromDocuments step template. For the BuildPDFFromDocuments steps to run successfully, these properties must be included in the document properties file:
    • Doc.OriginalJobID
    • Doc.ChildJobId
    • Doc.SequenceInChild
    • Doc.OriginalSequence
    • Doc.OriginalSheets

The first line in the document properties file contains the information from the document properties template file. Each additional line contains values for each of the properties from one document.

These steps automatically create the document properties file:

  • A step based on the IdentifyDocuments step template creates the document properties file using the Visual Workbench control file as a guide.
  • A step based on the IdentifyPDFDocuments step template creates the document properties file using the RICOH ProcessDirector Plug-in for Adobe Acrobat control file as a guide.
  • A step based on the ReadDocumentsFromDatabase step template creates the document properties file using a document properties template file as a guide.
  • A step based on the CreateJobsFromDocuments or CreatePDFJobsFromDocuments step template creates the document properties file for child jobs using the document properties file of the parent (current) job as a guide.

These steps can manipulate the document properties file:

  • GroupDocuments
  • SortDocuments
  • SplitDocuments
  • SetDocPropsFromList
  • ApplyPreferences (Preference Management only)
  • UpdateDocPropsFromExtResultsFile (Postal Enablement only)
The document properties file might also be used by an external program or a custom step that you create.

A document properties file always contains the properties Doc.ChildJobId and Doc.SequenceInChild. If a step (such as GroupDocuments) that creates document groups runs, the document properties file will contain more than one value for Doc.ChildJobId.

RICOH ProcessDirector provides methods, including getFileName and getAbsoluteFileName, that let you provide access for external programs to read and write spool files in the spool directory for the job. For more information, see Using RICOH ProcessDirector methods such as getFileName.

The document properties file is stored in the spool directory for the job. When the IdentifyDocuments or IdentifyPDFDocuments step creates the file, the file name is in the format: jobid.original.dpf (for example, 10000009.original.dpf). When the WriteDocumentsToDatabase step runs, it copies the file and adds additional properties, including Doc.ID. The new file is saved with a file name in this format: jobid.document.dpf (for example, 10000009.document.dpf). The values are in UTF-8 format and separated by tabs.

Some information in the document properties file is not stored in the database but is used only during the processing of steps. This information, for example, is in the document properties file but not in the database:

Doc.DataOffset
The offset of the print data for the document in the original job's AFP print file.
Doc.DataLen
The length of the print data for the document in the original job's AFP print file.

1.4.5.6 Property conditions file

Steps based on the SetDocPropsFromConditions step template set document properties or job properties in the current job using a property conditions file. The conditions defined in the file use a comma-separated value (CSV) format. A sample property conditions file is in/aiw/aiw1/samples/doc/DocPropConditions.csv. If you have the Postal Enablement feature, more sample files are in /aiw/aiw1/samples/control_files/postal.
    Important:
  • When you edit the property conditions file, open it in a text editor. Do not edit the file in Microsoft Excel.

You can use the property conditions file to set values for properties with conditions or without conditions. You can also use a separate include file to define properties using a property = value format.

Setting values using conditions

The first line in the property conditions file is a header row that lists the database names of document or job properties, separated by commas. Normally the leftmost part of the header row specifies the properties to test for one or more conditions, although this order is not required.

The header row is followed by one or more condition rows that define the conditions, and the property values to be set when all the conditions in that row are true. You can think of each condition row as representing an if-then statement. All specified conditions in a row are logically ANDed together and must all be true. If any of the conditions in a row are not true, none of the values in that row are set. The values in the condition rows are separated by commas.

This example shows the contents of a property conditions file that sets property values based on conditions:

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE
=USPS,,Yes
=USPS,~XYZ*,No
=NonUSPS,,No
=Exception,,No

The first if-then condition specifies that if a mailpiece category is USPS, RICOH ProcessDirector sets the Doc.Run.PAVE property to Yes. The second row sets the value of Doc.Run.PAVE to No when the job name begins with XYZ.

We recommend that you place all properties that are part of conditions to the left of the properties that are receiving values.

Properties that are part of conditions use condition characters from this set:

Condition characters in the conditions file
Condition characters Condition Example/Notes
=[value] equal to =Fir
<>[value] not equal to <>Fir
<[value] less than <4900000
>[value] greater than >61000
<=[value] less than or equal to <=61207
>=[value] greater than or equal to >=61207
~[value] like ~INSURE*.PDF
!~[value] not like !~*.PDF
"([val1],[val2],...)" in (must start and end with parentheses surrounded by quotation marks) "(PRTA, PRTB)"
"!([val1],[val2],...)" not in (must start and end with parentheses surrounded by quotation marks) "!(PRTA, PRTB)"
(blank) wildcard (*) When a condition is blank, it is considered always true.

    Note:
  • You can use the pound sign (#) to add comments. Only complete lines can be comments; the # character must be in the first position in the line.
  • Spaces can separate keyword characters from condition values.
  • When setting positional properties, you can choose one of these two formats: property-name[process-name][phase-name][step-name] or [phase-name][step-name]. You cannot use positional properties to set other properties.
  • The ? and * characters are wildcard characters used with the like and not like conditions. The question mark matches single characters and the asterisk matches any number of characters.
  • You can use RICOH ProcessDirector symbol notation in the conditions file to set conditions or assign values based on the current value of a particular document or job property. See the topic titled RICOH ProcessDirector symbol notation in the Information Center for a description of symbol notation syntax. You can also use symbol notation with literal string values; see below for more information.
  • If a condition field has an equal sign (=) without a value, the condition is true if the job's property value is null. If a field has an empty value, the property is ignored for that row; it is not part of any condition and its value is not changed. Because of this rule, the step cannot set a job property to null. To set a property to null manually, use the expression ${null}.
  • Each row is evaluated independently.
  • All rows with conditions that match a job's or document's properties are applied. The rows are applied in the order that they occur in the conditions file. Within each row, property values are applied from left to right.
  • Leading and trailing blanks are removed from field values before any comparison or set operation takes place. Blanks within a value (not leading or trailing) are retained.
Using a segment of a property value with symbol notation and the substring specifier

If you want to use only a portion of a property in a condition - such as using only the first 5 characters of a property's value - you can use the substring specifier to indicate the portion of the property that you want to use.

The syntax is:

  • ${property_name;substr;start;length}
where:
  • property_name is the name of the property, such as Job.Name.
  • start is the position in the string that you want to start from.
  • length is the number of characters to use in the condition; if you enter a length that is more than the number of characters in the property, the rest of the property is used.

    Note:
  • The string is zero-base indexed; for example, the first character is in position 0 and the fifth character is in position 4.

This table shows some examples:

Examples of substring values
Property conditions file contains... Property value Result
${Job.Name;substr;0;4} Job.Name = USPS-FullService USPS
${Job.Name;substr;5;8} Job.Name = USPS-OversizeFlat Oversize

Creating concatenated values with symbol notation

In addition to using symbol notation to set conditions or assign values based on the current value of a particular property, you can combine symbols to create a concatenated single value, or use them with literal strings.

This table shows some examples:

Examples of concatenating property values
Property conditions file contains... Actual property values Result
Job.Custom.A,Job.Custom.Z

${Job.Custom.D}${Job.Custom.E},4

Job.Custom.D=5 and Job.Custom.E=9 Job.Custom.A=59

Job.Custom.Z=4

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE

=USPS,${Job.Custom.D} Flat,No

Doc.Custom.MailCategory=USPS and Job.Custom.D=Oversize

Job.Name=Oversize Flat

Doc.Run.PAVE=No

Setting values without defining conditions

The format of the conditions file is the same, with a header row that contains property database names and a second row that lists property values. However, the conditions file contains only two rows. If you include more than one row of property values, only the values specified in the last row are saved.

This example shows the contents of a property conditions file that sets property values without using conditions:

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE
USPS,PostalDiscount,Yes

Setting values with a separate include file

If you have a collection of properties that remain the same for several workflows, you can define those properties in a separate include file that you refer to in the property conditions file.

To refer to a separate include file, put @include in the header row of the property conditions file, and specify the relative or absolute path to the include file in the second row of the property conditions file.

    Important:
  • Use the Linux delimiting character (/) to specify the absolute directory path to the include file on a Windows system. For example, if the include file on a Windows system is at C:\Projects\data.txt, specify /Projects/data.txt.

This example shows the contents of a property conditions file that contains @include and a path to a separate include file:

Doc.Custom.MailCategory,Job.Name,@include
USPS,Priority,../prop-assignments/usps-properties.txt

In this example, the Mail Category property is assigned the value of USPS, the Job Name property is assigned the value Priority, and the relative path to the include file usps-properties.txt is specified.

The include file defines property values using the format Property name = Value. This example shows the format of the include file:

Doc.Insert.RecipientName=George Rogers
Job.CustomerName=CerbCo

The conditions file is processed from left to right and from top to bottom. This table contains examples to show how the property conditions file and the include file can override properties that were previously set. (These examples are for illustration only and are not intended as actual uses of the conditions file.)

Examples of processing order for the conditions file and include file
Property conditions file contains... Include file contains... Result
Job.Name,@include

=,../prop-assignments/usps-properties.txt

Job.Name=FlatFold If the Job Name is not already defined, the include file defines it as FlatFold.
Doc.Custom.Zip, Doc.Custom.Location, Doc.Custom.Location, @include

<50000, EAST, NEW HAMPSHIRE, /Projects/data.txt

Job.CityPopulation = 42400 If Zip is <50000, the conditions file sets Location = EAST, then the conditions file sets Location = NEW HAMPSHIRE, then the include file /Projects/data.txt sets CityPopulation = 42400.

Doc.Custom.Location = NEW HAMPSHIRE

Job.CityPopulation = 42400

Doc.Custom.Zip, Doc.Custom.Location, @include, Doc.Custom.Location

<50000, EAST, /Projects/data.txt, NEW HAMPSHIRE

Doc.Custom.Location = CONCORD

Job.CityPopulation = 42400

If Zip is <50000, the conditions file sets Location = EAST, then the include file /Projects/data.txt sets Location = CONCORD and CityPopulation = 42400, then the conditions file sets Location = NEW HAMPSHIRE.

Doc.Custom.Location = NEW HAMPSHIRE

Job.CityPopulation = 42400

Doc.Custom.Zip, Doc.Custom.Location, @include, @include

<50000, EAST, /Projects/data.txt, /Projects/data2.txt

/Projects/data.txt

Doc.Custom.Location = CONCORD

Job.CityPopulation = 42400

/Projects/data2.txt

Doc.Custom.Location = US ROUTE 202

Job.CityPopulation = 52400

If Zip is <50000, the conditions file sets Location = EAST, then the include file /Projects/data.txt sets Location = CONCORD and Population = 42400, then the include file /Projects/data2.txt sets Location = US ROUTE 202 and CityPopulation = 52400.

Doc.Custom.Location = US ROUTE 202

Job.CityPopulation = 52400

    Note:
  • You can use RICOH ProcessDirector symbol notation as part of the include file name. For example, if you use the include file name ${Job.RequestedPrinter}.equipmentprops.txt, the system can choose the correct set of properties to define for each requested printer (for each value of Job.RequestedPrinter). See the related Reference topic for a description of symbol notation syntax.

1.4.6 Accessibility

Ricoh strives to provide products with usable access for everyone, regardless of age or ability.

For more information about the commitment that we have made to accessibility, refer to the Accessibility page on the Ricoh web site.

Accessibility features

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

The major accessibility features in this product let you:

  • Use screen readers, screen magnifiers, and other assistive technologies.
  • Use a keyboard instead of a mouse.
  • Change attributes such as volume, color, contrast, and font size.
  • Distinguish keys by touch without activating them.
  • Attach alternative input and output devices such as special pointing devices and Braille displays.

In addition, the information center and the publications for the product are in an accessible format.

RICOH ProcessDirector Plug-in for Adobe Acrobat Markup Navigator shortcut keys

When a markup object that you defined has focus in the Markup Navigator, you can use these shortcut keys:

Markup Navigator shortcut keys
Description Key
Opens the Edit dialog Enter
Deletes a markup object Delete
Keyboard navigation

This product uses standard Microsoft Windows navigation keys.

1.5 Using RICOH ProcessDirector Plug-in for Adobe Acrobat

1.5.1 Introduction

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.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.
  • Throughout this publication, references to directory paths indicate the default paths only. If you install RICOH ProcessDirector Plug-in for Adobe Acrobat in a different location, including a different drive, you must adjust the paths accordingly.

    For example, if you install RICOH ProcessDirector Plug-in for Adobe Acrobat on the D: drive of a computer running a Windows operating system, replace C: with D: in the directory paths.

1.5.1.3 Publications for this product

The following publications are available for RICOH ProcessDirector Plug-in for Adobe Acrobat.
Instruction manuals

These instruction manuals are included:

  • RICOH ProcessDirector: Integrating with Other Applications

    This guide provides technical information about the ways that you can configure RICOH ProcessDirector to exchange data with other applications.

  • RICOH ProcessDirector for Linux or Windows: Planning and Installing

    This guide explains planning and installation procedures for RICOH ProcessDirector on your operating system. The publications CD includes the version of this manual for your operating system: Linux or Windows.

  • RICOH ProcessDirector: Installing Document Processing Features

    This guide explains how to install RICOH ProcessDirector features that control and track both jobs and the individual documents in jobs.

  • RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat (this publication)

    This guide explains how to use RICOH ProcessDirector Plug-in for Adobe Acrobat. You can use the Adobe Acrobat plug-in to define text, barcodes, images, and other enhancements in a PDF file. After you save your enhancements in a control file, RICOH ProcessDirector workflows can use the control file to make similar enhancements to PDF files.

  • Font Summary

    This guide explains font concepts and the different types of fonts in the InfoPrint Font Collection. The Font Summary is available only in English.

  • White Paper–Using the Enhance AFP Function

    This guide explains how to configure and use Enhance AFP control files. The guide is available only in English.

  • The RICOH ProcessDirector readme file (readme.html)

    This file tells you how to access the other publications. The readme file is available only in English.

  • The RICOH ProcessDirector release notes

    These release notes provide information about the RICOH ProcessDirector release, including new functions and updates; known limitations, problems, and workarounds; and code change requests. The release notes are available only in English.

You can download English publications in PDF format from the RICOH Software Information Center (https://help.ricohsoftware.com/swinfocenter/).

RICOH ProcessDirector Information Center

The RICOH ProcessDirector Information Center contains topics that help administrators, supervisors, and operators learn about and use RICOH ProcessDirector document features. The Information Center is available from the RICOH ProcessDirector user interface and provides quick navigation and search features.

RICOH ProcessDirector Help

Field help is available on many screens for RICOH ProcessDirector document processing features to provide information for specific tasks and settings.

1.5.1.4 How to read the documentation

1.5.1.4.1 Before using RICOH ProcessDirector Plug-in for Adobe Acrobat

This manual contains instructions and cautions for correct use of RICOH ProcessDirector Plug-in for Adobe Acrobat. Before using RICOH ProcessDirector Plug-in for Adobe Acrobat, read this manual thoroughly and completely. Keep this manual handy for future reference.

1.5.1.4.2 How to use the manuals

Use the instruction manuals according to your needs.
To learn how to install RICOH ProcessDirector Plug-in for Adobe Acrobat:
See RICOH ProcessDirector: Installing Document Processing Features.
To learn how to use the functions and operations of RICOH ProcessDirector Plug-in for Adobe Acrobat:
See RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat. This information is also available in the plug-in help system and the RICOH ProcessDirector Information Center.
Displaying the publications
RICOH ProcessDirector: Installing Document Processing Features is available when you run the installation program, so you can access the publication while you install the application.

RICOH ProcessDirector: Installing Document Processing Features and RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat are also available from the RICOH ProcessDirector user interface.

On the top menu bar of the RICOH ProcessDirector user interface, click the Information button and select one of the publications to download.

    Note:
  • A PDF viewer, such as Adobe Acrobat Reader, is required to view the publications.
  • You must log in RICOH ProcessDirector user interface to view the publications.
Displaying the help system

The RICOH ProcessDirector Plug-in for Adobe Acrobat help system is available from the application. Click Help on a dialog.

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

1.5.1.7 Abbreviations

Abbreviations used in this publication.
HTTP
Hyper Text Transfer Protocol
IP
Internet Protocol
OMR
Optical Mark Recognition
PDF
Portable Document Format

1.5.1.8 Trademarks

RICOH ProcessDirector is a trademark of Ricoh Company, Ltd. in the United States, other countries, or both.

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

Microsoft, Windows, Windows Server, and Internet Explorer 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.

UNIX is a registered trademark of The Open Group.

Thales Group code: The license management portion of this Licensee Application is based on one or more of the following copyrights:

Sentinel RMS
Copyright 1989-2022 Thales Group 
All rights reserved.

Sentinel Caffe (TM)
Copyright 2008-2022 Thales Group 
All rights reserved.

Sentinel EMS
Copyright 2008-2022 Thales Group 
All rights reserved.

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

  • The product names of Windows 7 are as follows:
    • Microsoft Windows 7 Professional
    • Microsoft Windows 7 Ultimate
    • Microsoft Windows 7 Enterprise
  • The product names of Windows 10 are as follows:
    • Microsoft Windows 10 Pro
    • Microsoft Windows 10 Enterprise
  • The product name of Windows 11 is:
    • Microsoft Windows 11 Pro
  • The product names of Windows Server 2016 are as follows:
    • Microsoft Windows Server 2016 Standard
  • The product name of Windows Server 2019 is:
    • Microsoft Windows Server 2019 Standard
  • The product name of Windows Server 2022 is:
    • Microsoft Windows Server 2022 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.5.2 Overview

RICOH ProcessDirector Plug-in for Adobe Acrobat is an Adobe Acrobat Professional plug-in that you use to define and display enhancements in a PDF file that represents the PDF files that are processed by the steps in your workflows.

Enhancements include barcodes, OMR marks, images, hidden areas, and text. The enhancements you define in the PDF file are not saved in the PDF file; instead, they are saved in control files that you make available to a server used by RICOH ProcessDirector. RICOH ProcessDirector uses the control files to apply the same enhancements to production PDF files when it processes them for printing.

To extend markup capabilities, RICOH ProcessDirector Plug-in for Adobe Acrobat provides page groups, document properties, and conditional processing.

1.5.2.1 Page groups

A page group is a set of pages that make up a single document, such as a mailpiece or customer statement, within a PDF file. In RICOH ProcessDirector Plug-in for Adobe Acrobat, a document is a page group. A single PDF file can contain many documents. If an entire PDF file is treated as a single page group, the PDF file represents one document.

You should define a page group before you add markup. After you define a page group, you can apply markup to specific pages in each document. For example, you can add a barcode to the first page of each document, an image to all front-facing pages of each document, or text to the first back-facing page of each document.

You can define a page group in these ways:

  • As the entire PDF file.

  • As a fixed number of pages.

  • Based on text you select that is in the same location on the first page of each page group.

    RICOH ProcessDirector Plug-in for Adobe Acrobat uses the repeated text to determine the first page of each page group. For example, you have 100,000 customer statements in one PDF file. Each statement has three or more pages. To define a page group, you select Page 1 of, which is in the same location on the first page of each statement.

    Note: If you are using a sample PDF file to define page groups, make sure that the content and location of the text you select are consistent among the production PDF files.

  • Based on a specific key word or phrase that appears on the first page of a document within a region of text. The surrounding text might change, but the key word or phrase remains the same.

  • Based on text you specify that is on the first page of each page group. When you type the text, you can include wildcard characters. RICOH ProcessDirector Plug-in for Adobe Acrobat interprets the wildcard characters as any character.

  • Based on Java regular expressions that you define to specify text on the first page of each page group.

    For example, you define a Java regular expression so that RICOH ProcessDirector Plug-in for Adobe Acrobat starts a new page group each time it finds the English text Page 1 of or the Spanish text Página 1 de.

  • When text in a selected area changes.

    For example, you draw a box around the account name on a statement in a PDF file. Whenever the text in the box changes, that page becomes the first page of a new page group. The location of the box on every page must encompass only the text to evaluate or white space (no text).

Use the Page Group Navigator to see a list of the pages in each page group. After you verify that the page groups are correct, save your control file, which contains your new page group definition. If you define document properties, save them in the same control file. You then add the name and location of the control file to a RICOH ProcessDirector step based on the IdentifyPDFDocuments step template.

1.5.2.2 Document properties

A document property is data, such as a customer name or postal code, extracted from a specific location on a page within a document. Using document properties, you can add markup based on variable information. For example, you can add a different image to documents sent to different states or provinces.

RICOH ProcessDirector Plug-in for Adobe Acrobat has an advanced address block parsing tool to help you extract city, state or province, postal code, and other document properties from complex, variable line addresses. If you need to reprint documents in a job, you can use RICOH ProcessDirector to search for document property values to find the specific documents you need to reprint.

You can define your own document property or select a RICOH ProcessDirector document property from a drop-down list. You can use RICOH ProcessDirector document properties with functions provided by RICOH ProcessDirector document processing features.

Note: When you use RICOH ProcessDirector Plug-in for Adobe Acrobat to define document properties, you select from a list of your RICOH ProcessDirector document properties. After you install RICOH ProcessDirector Plug-in for Adobe Acrobat or any time that you change RICOH ProcessDirector document properties, you need to load the document properties into RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see RICOH ProcessDirector: Installing Document Processing Features.

Click Ricoh View Document Property Values to verify that document property values are extracted correctly.

If you want to use document property values with an external program, you can save the values to a tab-delimited text file.

1.5.2.3 Conditional processing

When you add markup to a PDF file using RICOH ProcessDirector Plug-in for Adobe Acrobat, you can create conditional processing rules to place the markup on specific pages.You also can use conditional processing rules to apply media and finishing options and to specify the pages from which RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector extract document property values.

Rules can specify conditions based on pages within documents, such as All Front Pages, as well as on job properties, document properties, statistics, and conditional triggers (text that determines whether a condition is met).

For example, you want the word Invoice at the top of the first page of a statement to trigger the placement of a barcode. First, you select the word Invoice and define it as a conditional trigger. Then you define a rule that specifies the conditional trigger. When you add a barcode to a PDF file, you specify this rule to control placement of the barcode. The barcode only prints on the pages where the word Invoice appears in the location specified by the conditional trigger.

Your RICOH ProcessDirector workflows can contain steps that set job property values during RICOH ProcessDirector processing. If you use RICOH ProcessDirector Plug-in for Adobe Acrobat to define a rule with a job property, you can dynamically create and alter how the rule is applied by setting the job property value in RICOH ProcessDirector. For example, you could use the Job.CustomerName job property to print a barcode only when the value of that property is BANK. RICOH ProcessDirector also keeps track of job processing statistics, such as the current page in a document. If you want to apply a barcode to page three in every document in a PDF job, you can make Stat.CurrentPageInDocument = 3 a condition for the application of a rule.

1.5.2.4 Markup

RICOH ProcessDirector Plug-in for Adobe Acrobat supports five types of markup: barcodes, OMR marks, images, text, and hidden areas.

For each type of markup, you assign a name that identifies the markup contents. Then you assign values for location, placement, and other properties. You can define document properties and conditional processing for markup using data that varies by document within the PDF file.

When RICOH ProcessDirector Plug-in for Adobe Acrobat displays a PDF file, your markup appears as a set of boxes with names. The PDF file is not altered. The Markup Navigator lets you locate and edit markup that is hidden under other markup.

To view and verify the content and placement of your markup on specific pages, you preview the PDF file. See Previewing markup for more information.

1.5.2.5 Control files

A control file saves your page group definition, document properties, conditional triggers, and markup independently of a PDF source file. Control files are templates that RICOH ProcessDirector uses to apply the same markup rules to the PDF files it processes.
    Note:
  • Saving your PDF source file by clicking File Save or File Save As does not save your RICOH ProcessDirector Plug-in for Adobe Acrobat page groups, document properties, or markup.

To use the RICOH ProcessDirector IdentifyPDFDocuments step in a PDF workflow, you must add the RICOH ProcessDirector Plug-in for Adobe Acrobat control file that defines page groups or document properties for that step. Any markup definition must be saved to one or more control files that are used by the RICOH ProcessDirector BuildPDFFromDocuments step.

You do not need to create separate control files for the page group, document properties, and markup definitions: all definitions can be saved in one control file if that control file is added to both the IdentifyPDFDocuments and the BuildPDFFromDocuments steps. However, you might choose to create multiple control files if you can apply one or more control files to different PDF workflows. For example each workflow might require its own document properties, but some workflows might require the same area to be hidden to cover OMR marks. For each workflow you would save a separate control file that defines document properties, but save only one control file to hide OMR marks. In each workflow, you would specify the workflow-specific control file that defines document properties. But in the step in each workflow that is based on the BuildPDFFromDocuments step template, you would specify the same control file that contains the hidden-area definition.

    Note:
  • The IdentifyPDFDocuments step uses one control file to create page groups and extract document properties. The BuildPDFFromDocuments step optionally uses one or more control files to apply markup and restructure a PDF file. ( BuildPDFFromDocuments does not require a control file.) In order to preview markup, you must define a page group and the document property definitions whose values you use in markup content. If you save a page group or property definition to a control file that you add to the BuildPDFFromDocuments step, RICOH ProcessDirector ignores those definitions. The BuildPDFFromDocuments step receives page grouping and document properties definitions from a workflow that includes the IdentifyPDFDocuments step.

See Working with control files and Previewing markup for tips on using multiple control files and best practices for verifying where markup prints.

1.5.2.6 Sample PDF files

If your production PDF files are large (for example, over 1000 pages in length), you should mark up a smaller sample PDF file that represents the PDF files you process in RICOH ProcessDirector.

You only need to mark up one sample PDF file, save all your changes to control files, and then use RICOH ProcessDirector to apply those changes to all of your production PDF files that match the sample PDF file. If you use RICOH ProcessDirector to process several PDF files that have different formats or different document properties, you need to mark up a sample PDF file for each type of file that you print using RICOH ProcessDirector. When working with RICOH ProcessDirector Plug-in for Adobe Acrobat, the goal is to mark up a PDF file that represents your production PDF files but that is smaller than your production files. If you mark up a PDF file in RICOH ProcessDirector Plug-in for Adobe Acrobat that is under 1,000 pages, you can work more quickly when adding markup and when using preview and viewing extracted document properties.

Both your sample PDF file and PDF files processed by RICOH ProcessDirector must contain all fonts and images in the PDF file itself. If you have PDF files with varying page sizes, markup may not appear as you expect. The placement reference for all markup, document properties, and page group definitions is the top left corner of each page.

1.5.3 Using RICOH ProcessDirector Plug-in for Adobe Acrobat

You use this software to enhance a PDF file by adding markup, such as barcodes, and by defining document properties using data in the PDF file.

In the RICOH ProcessDirector IdentifyPDFDocuments and BuildPDFFromDocuments steps, you specify the RICOH ProcessDirector Plug-in for Adobe Acrobat control files that contain the markup and document properties definitions, to apply the same enhancements in PDF files that you process on RICOH ProcessDirector.

1.5.3.1 Adding the plug-in icon to the Acrobat quick launch bar

Before you can mark up a PDF file, you must make the plug-in the active tool in Adobe Acrobat. Clicking the plug-in icon is a convenient alternative to clicking Ricoh Select in the menu bar. You can permanently place the RICOH ProcessDirector Plug-in for Adobe Acrobat icon on the Adobe Acrobat quick launch bar.
Follow these steps:
  1. Open Adobe Acrobat Professional.
  2. Click the Tools menu on the far right.
  3. Click Advanced Editing.
  4. Right-click the RICOH ProcessDirector Plug-in for Adobe Acrobat icon (Plug-in tool icon) and select Add to Quick Tools. The RICOH ProcessDirector Plug-in for Adobe Acrobat icon is permanently placed in the quick launch bar below the Acrobat main menu.
When the plug-in is the active tool, its icon will be highlighted.

1.5.3.2 Preferences

You can set preferences for RICOH ProcessDirector Plug-in for Adobe Acrobat to customize it for the way that you process PDF files.
To change your preferences, click Ricoh Preferences.
Fonts tab
Use the Fonts tab to select the font and size. This font is applied to the name of the markup boxes you draw in a PDF file. You use this option to change the font of the characters in your preferred language.
    Note:
  • Selections for style, effects, color, and type of script are not applied to the name of the markup boxes.
Preview tab

Use the Preview tab to set values for these properties:

Pages to Process
This value determines the maximum number of pages to process when you preview markup, export and view document properties, and use the Page Group Navigator. The more pages you specify, the longer RICOH ProcessDirector Plug-in for Adobe Acrobat takes to preview markup and view document properties.
Production Intent
This value defines how RICOH ProcessDirector Plug-in for Adobe Acrobat interprets PDF files. For example, when the Production Intent is Simplex, Second Front Only page placement puts markup on the second page of each page group. When the Production Intent is Duplex, Second Front Only page placement puts markup on the third page of each page group.
Show electronic forms
This value determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use.

Address tab

Use the Address tab to set a value for the Default address block format property. The default value is displayed when you use the Define Address Block function.

Logging tab
RICOH ProcessDirector Plug-in for Adobe Acrobat provides a log file in text format that you can customize to provide different levels of historical information. Use the Logging tab to define these properties:
Logging Level
The types of messages saved in the log file. Trace saves all six types. Info saves four types: informational, warning, error, and fatal messages. Fatal saves only fatal messages. Off turns off logging.
Log Output Folder
The directory path for the plug-in and Java log files that the system creates. The directory path must exist when the system creates the first log file. If a file does not exist, the system creates it.
Plug-in Log File
The file name for the plug-in log file that the system creates.
Java Log File
The file name for the Java log file that the system creates.
Maximum File Size
The upper size limit for the log. The minimum file size is 1 MB; the maximum file size is 10 GB. When the file reaches the upper limit, the system closes the file, renames it to include a number at the end of the name. The system keeps the file until the value in the Number of Log Files to Retain property is reached. For example, the log file name is Log.txt. Each renamed file is Log.n.txt, where n is a number from 1 to the value in the Number of Log Files to Retain property. The most recent log remains Log.txt.
Number of Log Files to Retain
The number of log files that the system keeps in addition to the current log file. When this limit is reached, the system deletes the oldest log file after it creates a log file. For example, you select 3. The system keeps the current log file plus the three most recent log files.
Advanced tab
Use the Advanced tab to set values for these properties:
Port
The internal port number for communication between RICOH ProcessDirector Plug-in for Adobe Acrobat and its background Java process. Restart Adobe Acrobat for this value to take effect. Edit this field if you have software that uses the default port.
Heap Size (MB)
The number of megabytes for the desired minimum amount of memory in the Java Virtual Machine allocation pool. Restart Adobe Acrobat for this value to take effect. Experiment with this value to tune it to the size and complexity of the PDF files you mark up. When you experience delays while previewing, selecting text, using the Page Group Navigator, or extracting and exporting document properties, you might improve performance by increasing the number of megabytes. If you set the heap size to a value that is greater than the available memory, you might not be able to use RICOH ProcessDirector Plug-in for Adobe Acrobat. In that case, decrease the heap size value, restart Adobe Acrobat, and reactivate the plug-in.
Other JVM Options
In addition to setting the minimum heap size, you can fine-tune other JVM memory settings. Edit this field only on the advice of your support representative.

1.5.3.3 Units of measure

RICOH ProcessDirector Plug-in for Adobe Acrobat uses the units of measure from the Pages & Ruler Units you set in Adobe Acrobat preferences.

To see or change this setting, click Edit Preferences Units & Guides.

Note: You define certain units of measure, such as those for the OMR marks, when you define the markup.

1.5.3.4 User interface

The plug-in user interface consists of the Ricoh menu added to Adobe Acrobat, a right mouse button popup menu, a left mouse button popup menu, and windows that you use to perform RICOH ProcessDirector Plug-in for Adobe Acrobat functions.
Ricoh menu and right mouse button popup menu

The Table Ricoh and right click menu options describes the options you can select from the Ricoh menu that is added to the Adobe Acrobat Pro menu bar and when you right click in a PDF file.

Ricoh and right click menu options
Menu Option Description
Select Makes RICOH ProcessDirector Plug-in for Adobe Acrobat the active Adobe Acrobat tool. After activating the plug-in, you can use the left mouse button to draw a box in an area of the PDF file where you want to select specific text or add markup.
Add Markup Displays the options on the left-mouse button menu.
View Markup Navigator Displays a list of the markup, document property, and page group definitions that have been added to the active PDF file. You can use this view to edit markup and to locate markup that is hidden under other markup. Mark the check box next to a name in the list to display the box for that markup. Remove the check to hide the markup box. If you deselect the check box in front of a markup type, you hide the boxes for all markup of that type.
View Page Group Navigator Views the pages that belong to each page group. Click the + sign to expand the page groups and click the sign to collapse the page groups. You can also use this view to navigate to specific pages in the PDF file. Click one of the pages in a page group to make that the active page in Adobe Acrobat.

If you do not see the page groups you were expecting based on your page group definition, you must edit the definition to obtain the correct page groups. If you do not see the correct page groups in this view, you cannot obtain correct print results in RICOH ProcessDirector.

Preview Verifies that files are going to print as you expect when your markup, media, and finishing are applied to a job. After you have examined the preview rendering of the PDF file, click X in the upper right corner of the PDF file to close the rendered PDF file and to return to your original PDF file.
Preview Preferences Sets or changes preview preferences. You can define: the maximum number of pages to process, the rendering intent, and other settings.
View Document Property Values Views the values of the document properties that are defined in the loaded control file. You can save the values to a tab-delimited text file.
Manage Rules Displays your conditional processing rules. You can define new rules, and you can edit or delete existing rules.
Manage Inserts Inserts pages from other PDF files before each document that matches the placement conditions, after each document that matches the placement conditions, or both. The inserted pages increase the number of pages in each document, and you can apply markup to them.
Media and Finishing Defines media and finishing options for a range of a pages or for the documents within your PDF file.
Load Control File Loads an existing control file. RICOH ProcessDirector Plug-in for Adobe Acrobat saves all page group, document property, and markup definitions into one or more control files. If you load a control file, you load all definitions in that control file. You can only have one control file loaded at a time.
Save Control File Stores any markup, document property, and page group definitions to a control file. The Save Control File window displays the name and location of the control file you are saving. You can enter a new name for the control file, or keep the existing name to overwrite the control file you previously loaded or saved. Whenever you save a control file used by RICOH ProcessDirector, you must copy the control file to the location you define in the control file properties in the RICOH ProcessDirector BuildPDFFromDocuments or IdentifyPDFDocuments step.
Clear Markup Removes all markup, document property, and page group definitions from the active PDF file. You use this option when you want to start over or create a new control file that does not contain any of the markup from the prior control file. If, after using this option, you add markup or other definitions to the PDF file, you use the Save Control File option and save the definitions with a new control file name.
Preferences Sets or changes preferences, such as the default font used for the labels for the markup you add to a PDF file; the maximum number of pages to process; the rendering intent; logging options; and the maximum amount of memory (heap space) to reserve for RICOH ProcessDirector Plug-in for Adobe Acrobat.
Help Opens the publication RICOH ProcessDirector: Using RICOH ProcessDirector Plug-in for Adobe Acrobat.
About Displays the version information for your RICOH ProcessDirector Plug-in for Adobe Acrobat installation.
Left-mouse button menu

The Table RICOH ProcessDirector Plug-in for Adobe Acrobat left mouse menu describes the options you can select from the RICOH ProcessDirector Plug-in for Adobe Acrobat menu that you see when you use the left mouse button to draw a box in the PDF file. To use the left mouse button, you must first make RICOH ProcessDirector Plug-in for Adobe Acrobat the active tool in Adobe Acrobat by either clicking the plug-in icon or by clicking Ricoh Select. You draw a box in a PDF when you want to select text or define an area to place markup. To draw a box, click the left mouse button, and without letting go of the mouse button, drag the cursor down and to the right until you have either selected the text you want or have drawn a box the size that you want. When you release the mouse button, a menu pops up with the following options.

RICOH ProcessDirector Plug-in for Adobe Acrobat left mouse menu
Menu Option Description
Define Page Group Defines a page group to break a PDF file into mailpieces, such as statements or invoices. You must define the page group before you add markup or define document properties.
Define Conditional Trigger Defines a conditional trigger from text in the PDF. You use a conditional trigger in a conditional placement rule that defines the pages on which markup is printed or document properties are extracted. For example, you want to add a QR barcode only on the page where the word Invoice occurs near the top left of either the first or second page of a statement. You first define the word Invoice as a conditional trigger. Then, when you are defining the QR barcode, you select that trigger as a conditional placement rule on the QR barcode so it only prints on the pages where the word Invoice occurs in the location you selected.
Define Document Property Defines existing data in your sample PDF file as a document property so RICOH ProcessDirector can use that data in different steps (such as adding barcodes). After you define document properties, you can later search for them in the RICOH ProcessDirector viewer for reprint and other actions.

You can also define a document property on any text or DataMatrix barcode that you want to extract from the PDF file. In that case, you do not select a standard RICOH ProcessDirector document property; instead, you provide your own name for the property.

Define Multiple Properties Defines document properties from a block or multiline section of text.
Define Address Block Defines document properties for an address block.
Hide Area Creates a cover block to hide content in a PDF file. Hidden content does not print and is not viewable in RICOH ProcessDirector Plug-in for Adobe Acrobat preview or in the PDF viewer in RICOH ProcessDirector. You can hide an area and then place other markup over the hidden area.
Add Barcode Adds and configures a barcode. First you select the area where you want to place the barcode. Then, you select a barcode type and add content. When adding a barcode for downstream processing of mailpieces, you must understand the precise optical marks required by your machinery and have configuration specifications from your supplier.
Add OMR Adds and configures optical markings to help manage downstream processing of mailpieces in the PDF file. When adding an OMR, you must have an understanding of the precise optical marks required by your machinery and have configuration specifications from your supplier.
Add Image Adds an RGB JPEG-formatted image to create new content or to cover existing content.
Add Text Adds text to any location in a PDF file. You designate the area where you want the text to print and select content from a combination of options, including typing text.

1.5.3.5 Working with control files

As you use RICOH ProcessDirector Plug-in for Adobe Acrobat to mark up a PDF file, instead of saving markup in the PDF file itself, you save markup to one or more control files. RICOH ProcessDirector Plug-in for Adobe Acrobat uses a control file to extract data, and RICOH ProcessDirector uses control files in the different stages of preparing a PDF file for printing.

You use the Ricoh menu options Load Control File and Save Control File to manage control files. You can only have one control file loaded at a time. When you finish marking up a PDF file, you save the control file to a directory accessed by RICOH ProcessDirector. You configure RICOH ProcessDirector workflows with one or more step templates that use RICOH ProcessDirector Plug-in for Adobe Acrobat control files.

    Important:
  • Do not manually edit RICOH ProcessDirector Plug-in for Adobe Acrobat control files without advice from a Ricoh support representative.
  • RICOH ProcessDirector Plug-in for Adobe Acrobat Version 3.6 includes an improved PDF processing library. For most PDF files, the new library improves performance, reduces processing time, and uses less memory.

    When you open a control file created in a previous release, RICOH ProcessDirector Plug-in for Adobe Acrobat prompts: Do you want to update your control file to use an improved PDF processing library?

    If you click No, the message appears the next time that you open the control file.

    If you click Yes, RICOH ProcessDirector Plug-in for Adobe Acrobat updates the control file, and the message never appears again.

    When you update a control file, make sure that it produces the same results. Slight differences between libraries could result in slightly different text selection boxes. A smaller box could exclude text that you want to select, and a larger box could include text that you do not want. Using the improved library also could change the position of markup slightly.

    No other changes are required on the RICOH ProcessDirector server to use the improved PDF library.

  • To use a control file built for a PDF 1.7 file with a PDF 2.0 file, you must update the control file to use the new library.

You must save any page group definitions and document properties to a single control file. You can add markup, media, and finishing definitions to that single control file, or you can separate the definitions into different control files. You specify the control file that defines page groups and document properties in a step based on the IdentifyPDFDocuments step template. The control files that define markup, media, and finishing must be specified in a step based on the BuildPDFFromDocuments step. When you decide whether to create one or more control files, take your print environment into account: the complexity of your changes, how you want to differentiate your markup, and what PDF file enhancements change most often.

In a repetitive print environment where your PDF workflow does not change often, you could choose to create only one control file. When you preview a PDF file to verify where markup is going to print and which pages have media and finishing options, you can view all markup, media, and finishing in one view. You move the single control file to a directory accessed by RICOH ProcessDirector. You define the control file name and location in both the IdentifyPDFDocuments and the BuildPDFFromDocuments steps.

You could also use one control file when you want to preview the PDF file to make sure that all markup, media, and finishing are applied correctly. When you preview a file, RICOH ProcessDirector Plug-in for Adobe Acrobat renders markup and applies media and finishing options that are defined in the active PDF file. You cannot use preview to verify markup, media, and finishing definitions in a control file that is not loaded.

You could choose to use more than one control file in an environment that changes frequently or unexpectedly. By using different types of control files, you can mitigate the risk of change or adapt to it quickly. For example:

  • The page group definition is less likely to change than other definitions in your PDF files. You can put the page group and document property definitions in the control file that you add to the IdentifyPDFDocuments step.
  • You have installed the Inserter feature, and you switch between inserters. You do not have to edit your workflow each time you switch. Instead, you save the barcode markup for each inserter in a separate control file with a name that identifies the inserter. In the BuildPDFFromDocuments step, you specify the name and location of one control file, using symbol notation that matches the value of a job property. During print processing, you set the value of that job property to the name of the control file that matches the inserter you want to use for the job.

Symbolic notation also lets you use the same workflow for input files that need different RICOH ProcessDirector Plug-in for Adobe Acrobat control files. For example, you have two input files, File1.pdf and File2.pdf, with corresponding control files, File1.ctl and File2.ctl. You want to use the same workflow for both files. You can use ${Job.InputFile}.ctl as the control file name that you specify in the BuildPDFFromDocuments step. ${Job.InputFile}.ctl causes RICOH ProcessDirector to set the value of the RICOH ProcessDirector Plug-in for Adobe Acrobat control file property to the name of the input file plus the .ctl extension.

1.5.3.6 Previewing markup

After you add markup to a sample PDF file, you can preview markup placement. Previewing lets you verify that PDF files are going to print as expected when RICOH ProcessDirector applies the markup that you saved to a control file. Preview also lets you verify that media and finishing options are going to be applied to the intended pages.

Using preview with more than one control file

If you save more than one control file for markup, media, and finishing definitions, preview renders only the definitions contained in the loaded control file. For example, you save a barcode definition in a control file called barcodes.ctl and an image definition in images.ctl. You can have either barcodes.ctl or images.ctl loaded in RICOH ProcessDirector Plug-in for Adobe Acrobat. If you have barcodes.ctl loaded, you preview the placement and content of the barcode, but you cannot preview the image because you do not have images.ctl loaded.

You can include page group and document property definitions in any control file. If a page group is defined in a control file that is not loaded, you cannot preview markup, media, and finishing with conditional placement rules based on page groups. If document properties are defined in a control file that is not loaded, you cannot select those document properties as content for markup. If you want to preview as much markup as possible while using multiple control files, first save page groups and document properties to a control file, for example, pagegrouping.ctl. When you are ready to define markup, load pagegrouping.ctl, add the markup, and save the result to a new control file (for example, barcodes.ctl). To define more markup and save it to a separate control file, first load pagegrouping.ctl. Add the markup (for example, images), and save the result to a new control file (for example, images.ctl). By starting your markup definitions from a control file that contains page groups and document properties, you can preview markup, media, and finishing that use conditional placement rules and document properties.

If you save all your enhancements in one control file, you can preview all markup, media, and finishing at once.

    Note:
  • You cannot edit, print, or save a preview file.
  • You must define a page group before you can preview markup. For more information, see Defining a page group.
  • The Pages to Process preference specifies the maximum number of pages that Preview processes. The greater the Pages to Process value, the longer RICOH ProcessDirector Plug-in for Adobe Acrobat takes to preview markup added to a PDF file. For more information, see Preferences.
  • The Production Intent preference determines how RICOH ProcessDirector Plug-in for Adobe Acrobat interprets PDF files. For more information, see Preferences.
  • The Show electronic forms preference determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use.
  • When you define markup in a PDF file, you can use the values of job and document properties as content for markup and in conditional placement rules. Preview uses values that are extracted from the PDF file. If you have markup that uses job or document properties that are not defined in the file, RICOH ProcessDirector Plug-in for Adobe Acrobat uses a unique static numeric value for each job or document property. If conditional placement rules use properties that are not defined in the file, usually Preview always applies or never applies markup based on those rules.
  • If your markup uses an image that the plug-in cannot find (for example, an image that is not on your local machine), preview does not render the image. Instead, preview places a message that specifies the name of the missing image in the location specified for the image.
  • You cannot preview markup that is placed using a RICOH ProcessDirector Plug-in for Adobe Acrobat rule that evaluates Stat.CurrentMedia.
To preview markup:
  1. Click Ricoh Preview.

    RICOH ProcessDirector Plug-in for Adobe Acrobat generates and displays a new, temporary PDF file. Your sample PDF file remains open.

    The temporary PDF file opens to the first page regardless of the page you are editing in the sample PDF file.

  2. When a page has media and finishing options, you see an annotation labeled Print Operations in the upper right corner. To see the media name and finishing option, hover the mouse pointer over Print Operations.

    As an alternative, click Comment on the Adobe Acrobat toolbar. In the Comments pane, you see a comment for each page with media and finishing options.

  3. If electronic forms are defined for media used by sample files, you can see how the files look when the data is combined with the forms.

    To see the electronic forms:

    • Make sure that you exported the RICOH ProcessDirectormedia.zip file and loaded it to the correct directory on the system where you installed RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information about loading media objects to the plug-in, see the help system or Ricoh ProcessDirector: Installing Document Processing Features.
    • For pages in your sample PDF file, select media that defines electronic forms. As an alternative, load a control file that you saved after selecting media that defines electronic forms.
    • Make sure that the Show electronic forms preference is set to Yes.

      Although Preview lets you see how files look when the data is combined with the forms, the data and forms remain separate. RICOH ProcessDirector combines the forms with the data in production PDF files when the CombinePDFWithForm step processes the files.

  4. When you have finished previewing the PDF file, you can close this temporary PDF file or leave it open.
    You can update the temporary PDF file by clicking Ricoh Preview.

1.5.3.7 Modifying markup definitions

After you add markup to a PDF file, you might need to delete the markup, move it to a new location, or modify its properties. RICOH ProcessDirector Plug-in for Adobe Acrobat provides several ways to edit and delete markup, document properties, and a page group definition.

The most common methods to edit markup are to double-click the box you drew to display the markup definition window or to click a box and move it to a new location. But you may have layered markup under other markup, such as having several barcodes in the same area because you want to print only one based on RICOH ProcessDirector conditional processing. You could also place a hidden area over an image and place a smaller image over the hidden area. To edit markup layered under other markup, you can use the Markup Navigator to select the markup you need to edit.

Tip: Tip: Keep in mind that changes you make to markup in the active PDF file must be saved to the control file to which you previously saved the markup definition. For example, if you added a barcode to a PDF file and saved that definition to a control file, and you delete the barcode from the active PDF file, you must save that change to the existing control file. After you save markup changes to a control file, you must make the new version of the control file accessible to a RICOH ProcessDirector server for those changes to be applied to your production PDF files.

You can use any of the following methods to edit markup.

Methods to modify markup
Method Description
Double-click a markup box Displays the property definition window for the markup box.
Right-click a markup box Displays a popup menu with options to edit the definition of the markup box or to delete it.
Click and drag to resize or move a box Click any box for markup, document properties, or a page group definition. Resizing handles appear on the corners of the box. Click and drag a corner to change the size of the box.

Click and drag the middle of a box to move it to a new location.

    Note:
  • If the markup is layered underneath other markup, click Ricoh View Markup Navigator to isolate the markup you want to resize. Remove the checkmark from the boxes in front of markup that blocks your access to the markup you want to edit.
  • You can use the horizontal and vertical coordinates, width, and height in the markup definition window to change the location and size of the markup box.
  • If you click, resize, or move either a page group definition or a conditional trigger, make sure it is on the page that contains the data you are looking for. These three actions resample the data for a page group definition or a conditional trigger. If you do one of the actions on the wrong page, RICOH ProcessDirector Plug-in for Adobe Acrobat asks whether it should accept your change. If you click OK, the data changes to an incorrect value.
Left-click in the Markup Navigator To highlight a markup box:
  1. Click Ricoh View Markup Navigator.
  2. Click the markup you want to highlight.
Tip: Tip: You can keep the Markup Navigator window open as you add, modify, and delete markup. The window automatically updates with your changes.
Double-click in the Markup Navigator To edit markup, document properties, or a page group definition:
  1. Click Ricoh View Markup Navigator.
  2. Double click the markup you want to edit.
Hide markup using the Markup Navigator To hide markup, document properties, or a page group definition so you can access other markup:
  1. Click Ricoh View Markup Navigator.
  2. Toggle the check box on and off to show and hide:
    • A box that you drew for markup, document properties, or a page group definition.
    • A group of markup. For example, remove the check from the Image check box to hide all image markup boxes.
Note: When you use the Markup Navigator to hide markup, you are only hiding it from your view of the active PDF file. If you have a control file that contains hidden markup and you save a control file, the hidden markup is saved to the control file, and any definitions in it are processed by RICOH ProcessDirector.

1.5.3.8 Defining a page group

A page group defines the pages ranges for each document in your PDF file. You save one page group definition to the control file that you specify in a RICOH ProcessDirector IdentifyPDFDocuments step. We recommend that you define a page group before you add markup.
Note: You can define more than one control file per PDF file, but only the control file you identify in the Identify PDF control file property of the step based on the IdentifyPDFDocuments step template creates page groups. If you want to use RICOH ProcessDirector Plug-in for Adobe Acrobat preview mode to verify the correct placement of other markup, you might need to define a page group in the control files you use to generate such markup. You can, for example, add a control file that contains page group definitions to a BuildPDFFromDocuments step. However, because a BuildPDFFromDocuments step receives page grouping information from the previous IdentifyPDFDocuments step, a BuildPDFFromDocuments step ignores any page group definitions in its control files. See Previewing markup for more information about best practices.
To define a page group:
  1. Open a PDF file in Adobe Acrobat Professional and click Ricoh Select to make the plug-in the active tool.
  2. To define a text-based page group, draw a box around the target text. Otherwise, draw a box anywhere on the page.
  3. Click Define Page Group.
  4. Either accept or change the default page group name. We recommend that you use the default name, so that anyone working on the PDF file can easily see where the page group boundary is defined. If you do change the name, do not use spaces or special characters (such @, #, $, and %). You can use periods and underscores.
  5. For text-based page groups, you can alter the location and size of the enclosing box by entering values for Horizontal and Vertical coordinates, Width, and Height. The position and size of the box are adjusted after you click OK.
  6. From the Page Groups list, select one of these options:
    • Treat entire PDF as a single page group: Creates a single page group that includes all processed pages.
    • Create fixed-length page groups: Creates page groups of specific lengths based on the value of the Page Group Length property. Page grouping starts on page 1 of the PDF file.

      For example, select 5 to create page groups for pages 1–5, 6–10, 11–15, and 16–18 in an 18–page PDF file.

    • Begin page group when the selected text is found: Creates page groups based on text that you select. Any page with the selected text inside the box you drew becomes the first page of a new page group.

      For example, select Page 1 of to create a new page group each time that RICOH ProcessDirector Plug-in for Adobe Acrobat finds the text Page 1 of inside the box you drew.

      Note: Characters in a PDF file have white space enclosing them. Make sure that the Selected Text field does not include characters — such as white-space characters — that you do not want. If it does, cancel the page group definition and redraw the box around the text.

    • Begin page group when the specified text is found: Creates page groups based on text that you specify. Any page with the specified text inside the box you drew becomes the first page of a new page group. The text does not need to be on the same page as the box you drew.

      From the Match method list, select one of these options:

      • Match text exactly: Matches the exact text that you specify.

      • Match text containing: Matches the text that you specify to a portion of the text in the box you drew. The text that you specify does not need to be in the same location on each page.

        For example, use this option to create a new page group each time that RICOH ProcessDirector Plug-in for Adobe Acrobat finds the text Page 1 of anywhere inside the box you drew. The box can contain other text. Page 1 of 4 and This is Page 1 of 4 found in the box both match the specified text Page 1 of.

      • Match text using wildcards [* or ?]: Matches the text that you specify, which includes wildcard characters, by interpreting the wildcard characters as any characters. The asterisk (*) matches zero or more characters. The question mark (?) matches a single character.

        For example, the first page of each mail piece has an account number that starts with A followed by seven digits. The position of the account number varies on each statement. You draw a box large enough to include the account number on all the statements and type A??????? as the value of the Specify text to match property. RICOH ProcessDirector Plug-in for Adobe Acrobat starts a new page group on each page with an account number like A1265581 or A6428229.

        Note: If you typed A??????* as the value of the Specify text to match property, RICOH ProcessDirector Plug-in for Adobe Acrobat would start a new page group when it finds account numbers with six or more digits.

      • Match text using a Java regular expression: Matches the Java regular expression that you specify.

        For example, each mail piece is in one of two languages: English or Spanish. You type (Page 1 of).*|(Página 1 de).* as the value of the Specify text to match property. RICOH ProcessDirector Plug-in for Adobe Acrobat starts a new page group when the text found is Page 1 of followed by any number of characters or Página 1 de followed by any number of characters. Examples: Page 1 of, Page 1 of 6, Página 1 de 2, or Página 1 de 10.

        Note: For more information, see the Java documentation for the java.util.regex.Pattern class.

    • Begin page group when text in selected area changes: Creates page groups when text inside the box you drew changes. The page with the changed text becomes the first page of a new page group.

      For example, you draw a box around an account name. RICOH ProcessDirector Plug-in for Adobe Acrobat creates a page group each time a new account name appears in the box you drew.

      Important: When you draw the box for this type of page group, make sure that the location of the box on every page encompasses only the text to evaluate or white space (no text). If other text appears in the box, unwanted page groups are identified. Pages that contain white space, in the location of the box, do not start a new page group.

    • Begin page group when text or drawn objects are detected: Creates page groups when either a graphic object or text is enclosed in the box you drew. If the box you drew does not contain the text or entire graphic, then the page is not the start of a new page group.
      Note: Not all marks are graphics. Some marks are image data.
  7. Click OK.
  8. Click Ricoh View Page Group Navigator and verify that the page groups begin on the correct pages.
    If text-based page groups do not begin on the correct pages, the box you drew might not be the correct size for the text you selected or specified. Inspect the page groups to see if you can find the problem. Then redraw the box, change the text, or both.
  9. Edit the page group definition by double-clicking the box representing the page group, or by clicking Ricoh View Page Group Navigator and then double-clicking the page group name.
  10. When you are ready to save all your enhancements to the PDF file, including the new page group definition, click Ricoh Save Control File.

1.5.3.9 Working with document properties

You can define document properties from data in your PDF file that you want to use for later print processing. When RICOH ProcessDirector processes PDF files with document property definitions, it extracts, or mines, values from each page group in a PDF file. For example, you can create document properties to extract data in each page group in a PDF file and define that data as the content of a barcode that prints on a page in the same page group.

When you define a document property, you specify data in the PDF file. You can apply conditional processing rules to tell RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector where to extract the data from and when to extract it. For example, you want to apply conditional processing rules that extract an account number from the first page of every page group when an account is overdue. First you create a conditional trigger on text that indicates the account is overdue. Then you define a rule with two conditions. One condition specifies that the “overdue” text is present. The other condition specifies the pre-defined rule First Front Only. You choose to apply the new rule when all of its conditions are met. Finally you define the account number as a document property and select the new rule in the Placement Conditions section. RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector extract the account number from the first front page of each page group when the “overdue” text is present.

When you define a document property in RICOH ProcessDirector Plug-in for Adobe Acrobat, you select a RICOH ProcessDirector document property from a list or define your own document property name. If you define your own document property name instead of selecting a RICOH ProcessDirector document property, that document property cannot be integrated into RICOH ProcessDirector functions that save the properties to the database. You cannot use that document property for functions in RICOH ProcessDirector document processing features, or for markup content in barcodes or text. You should choose to create your own document property in RICOH ProcessDirector Plug-in for Adobe Acrobat only if you are going to extract your document properties to a file or if you know the document property will exist in RICOH ProcessDirector when your PDF files are processed. If you need to use a document property with RICOH ProcessDirector, create it in RICOH ProcessDirector and then select the document property from the list in RICOH ProcessDirector Plug-in for Adobe Acrobat.

    Note:
  • You see the database or system names for document properties in the lists in RICOH ProcessDirector Plug-in for Adobe Acrobat and the document properties list in the RICOH ProcessDirector viewer. In those lists you do not see custom or translated document property names.

Viewing document property values

After you define one or more document properties, you click Ricoh View Document Property Values to see the values of the document properties in the active PDF file. You can verify that the conditional processing rules and the text selected for each document property are correct. Use the document property view to verify that none of the document property values are longer than the text selection box you drew. RICOH ProcessDirector Plug-in for Adobe Acrobat truncates any text that extends beyond the text selection box.

    Note:
  • The Document Property window is a useful tool for you to keep open as you define document properties. After you create your first document property and view its values, you can click the Update Table button in the Document Property window at any time to update the table with changes that you made to the document properties.

Saving document property values

If you need to use document property values outside the product, click Save while viewing document property values. RICOH ProcessDirector Plug-in for Adobe Acrobat saves the values to a tab-delimited text file.

Using document properties in RICOH ProcessDirector

You define how document properties are used in different RICOH ProcessDirector print processing steps. For example, you define how RICOH ProcessDirector uses document properties in its barcode creation function. You can also use document property values to search for a specific customer account from a PDF print job if you need to reprint a mailpiece of that one customer.

Creating new document properties in RICOH ProcessDirector

After you install your document processing feature, you define all of the custom document properties you need in the docCustomDefinitions.xml file. When you run the docCustom utility to update configuration files, those properties are added to the database. If you need to create additional custom document properties, you edit the docCustomDefinitions.xml file and rerun the docCustom utility.

    Note:
  • If you use custom document properties, starting with Version 3.11.2, you can create them on the Administration tab, using Objects Custom Properties.

    You can choose the database name and the label that displays in property notebooks and column headings. You can also choose what kind of data to store in the property, and the default access that the different user groups have for the property, without adding them to the docCustomDefinitions.xml file.

  • If you already have custom document properties defined in a docCustomDefinitions.xml file, you can continue to use them. Do not re-create them from the Administration tab. Only use that tab to create new job or document properties.

After you load the new document properties values, they are available to you in the plug-in wherever you define document properties. For more information about editing the docCustomDefinitions.xml file and running the docCustom utility, see RICOH ProcessDirector: Installing Document Processing Features.

    Note:
  • When you define document properties you can define a document property as a limited document property. Limited document properties do not need database table space; however, they occupy space for each document in each document properties file that contains the property.

1.5.3.9.1 Defining a document property

RICOH ProcessDirector features can store document property values in the RICOH ProcessDirector database. The features rely upon document properties for later downstream processing of PDF files in RICOH ProcessDirector.
    Note:
  • Read the document property overview section to ensure you understand how document properties are used in RICOH ProcessDirector so you can take full advantage of your RICOH ProcessDirector feature.
To define a document property:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Left-click just above the top left corner of the data that you want to capture. Drag the mouse to draw a box around the data.
    You can later view the extracted values to verify your selection.
      Note:
    • The data to capture can be text or DataMatrix barcodes encoded as images.
    • Make the box big enough to capture the longest occurrence of the data in your PDF files. Some characters in a PDF file have a larger white space buffer than other characters. For example, the left edge of a large capital letter might have up to a tenth of an inch of white space buffer that you might need to select in order to capture that letter.
  3. Select Define Document Property from the popup menu.
  4. Select a RICOH ProcessDirector document property from the list or type a document property name into the field. Do not use any special characters (such as @, #, $, %, or - (dash)) or spaces. The RICOH ProcessDirector IdentifyPDFDocuments step might fail. You can use periods and underscores.
      Note:
    • When you define document properties, you can define a document property more than once. For example, text in your PDF file might be variable, and you might need to mine the zip code from two different locations. You can define your zip code document property twice - as long as you define different conditional placement rules that specify the pages from which the property is extracted. If you define the same document property in two different ways in the document, and each of their conditions are met, then only the value extracted last is used.
  5. Define which type of data to extract values from.
    • If you selected an area that only contains text, select Text under Select from.
    • If you selected an area that only contains barcodes, select Barcode image under Select from.
    • If you selected an area that contains both text and barcodes, select both Text and Barcode image.

      The text data is placed before the barcode data in the extracted string without an indicator of where the text data ends and the barcode data begins.

        Note:
      • We recommend using black barcodes. Using colored barcodes might have unpredictable results.

  6. Specify the page in each document from which document property data will be extracted. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is First Front Only. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
        Important:
      • The Last Back, Last Front, and Last Page rules do not work with the extraction of document property data.
    • Select Specific pages and type the page in each document that you want.

      If you specify multiple pages, RICOH ProcessDirector Plug-in for Adobe Acrobat extracts the document property data from the last specified page in each document. Examples:

      • You specify pages 2–4. If a document has four or more pages, the document property data is extracted from page 4. If a document has three pages, the document property data is extracted from page 3. If a document has two pages, the document property data is extracted from page 2.
      • You specify pages 2,4. If a document has four or more pages, the document property data is extracted from page 4. If a document has 2–3 pages, the document property data is extracted from page 2.
      • You specify pages 2–n. Because n represents the last page, the document property data is extracted from the last page if the document has two or more pages.
          Important:
        • If you specify only page n, RICOH ProcessDirector Plug-in for Adobe Acrobat does not extract the document property data from any page in a document.

  7. Optional: Select the edit icon (Edit line icon) to display a Modify Text window where you define one or more modifier extraction rules to extract the exact document property you need.
    1. Choose one of the following modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

      When you use a modifier to define a text extraction rule, the Text to Modify field at the top of the Modify Text window contains the selected line plus any edits you make to the line. The Modified Value field to the right of a modifier displays the text that results when that modifier is applied to the text it received from either the modifier above it or the Text to Modify field (if you are defining the first modifier).

    2. Continue to apply modifiers until you extract the value you want from the selected line. Click the Add icon icon to add a new modifier. The Final Text field below the list of modifiers displays the final modified value, after all modifier extraction rules are applied.
      For the selected modifier, the Modifier Initial Text field at the bottom of the window displays the value before the modifier is applied. The Modified Text field displays the value after the modifier is applied.
    3. Use the modifier management icons near the top of the window to delete and reorder the modifier extraction rules. Use the Trash can icon icon to delete the selected modifier extraction rules. Use the up and down arrow icons to reorder the rules. The rules are applied to the line in order from top to bottom.
    4. Click the OK button to save the line extraction rule.
  8. Click OK to create the document property.
  9. Click Ricoh View Document Property Values and scroll through several documents in your PDF file to verify that RICOH ProcessDirector Plug-in for Adobe Acrobat is extracting the correct document property values for each document.
  10. When you are ready to save all your enhancements to the PDF file, including the new document property definition, click Ricoh Save Control File.
  11. In the RICOH ProcessDirector IdentifyPDFDocuments step, specify the name and location of the control file that contains the document property definition.

1.5.3.9.2 Defining multiple document properties

You can define multiple document properties in a block of data in a PDF file. A block of data can be text, DataMatrix barcodes encoded as images, or both.
    Note:
  • Read the document property overview section to ensure you understand how document properties are used in RICOH ProcessDirector so you can take full advantage of your RICOH ProcessDirector feature.
To define multiple document properties:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Left-click just above the top left corner of the block of data that you want to capture. Drag the mouse to draw a box around the block of data. You can later view the extracted values to verify your selection.
      Note:
    • Make the box you draw big enough to capture the longest occurrence with the most lines of data in your PDF files. Some characters in a PDF file have a larger white space buffer than other characters. For example, the left edge of a large capital letter might have up to a tenth of an inch of white space buffer that you might need to select in order to capture that letter or line.
  3. Select Define Multiple Properties from the popup menu.
  4. Type a Name for the block of multiple document properties. Do not use spaces or special characters (such as @, #, $, %, or - (dash)) in the name. You can use periods and underscores.
  5. Define which type of data to extract values from.
    • If you selected an area that only contains text, select Text under Select from.
    • If you selected an area that only contains barcodes, select Barcode image under Select from.
    • If you selected an area that contains both text and barcodes, select both Text and Barcode image.

      The text data is placed before the barcode data in the extracted string without an indicator of where the text data ends and the barcode data begins.

  6. Specify the page in each document from which document property data will be extracted. Do either of these steps:
    • Select Pages based on a rule, and then select a rule from the list. The default rule is First Front Only. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
        Important:
      • The Last Back, Last Front, and Last Page rules do not work with the extraction of document property data.
    • Select Specific pages and type the page in each document that you want.

      If you specify multiple pages, RICOH ProcessDirector Plug-in for Adobe Acrobat extracts the document property data from the last specified page in each document. Examples:

      • You specify pages 2–4. If a document has four or more pages, the document property data is extracted from page 4. If a document has three pages, the document property data is extracted from page 3. If a document has two pages, the document property data is extracted from page 2.
      • You specify pages 2,4. If a document has four or more pages, the document property data is extracted from page 4. If a document has 2–3 pages, the document property data is extracted from page 2.
      • You specify pages 2–n. Because n represents the last page, the document property data is extracted from the last page if the document has two or more pages.
          Important:
        • If you specify only page n, RICOH ProcessDirector Plug-in for Adobe Acrobat does not extract the document property data from any page in a document.

  7. Use the Document Properties section of the definition window to select a document property and define the property extraction rule. This section contains the full text of the first line of the text data you selected. If you choose to edit an existing text block, this section contains all of the document properties you have defined for the text block. Follow these steps to define a new document property and the modifier extraction rule for it.
    1. Click the add icon (Add document property icon) to add a new document property definition row.
    2. Select a RICOH ProcessDirector document property from the Property list. You can define your own document property by typing in a document property name; however, you cannot use that document property in RICOH ProcessDirector. You should only define your own document properties when you are only using RICOH ProcessDirector Plug-in for Adobe Acrobat to export document property values to a text file.
    3. Select the Line of the text block from which you want to extract the selected document property. You can select the line using a top-down or a bottom-up reference. To select a line using a top-down reference, select 1 through n (where n is a positive whole number). To select a bottom-up reference, select Last or select Last - x (where x is the number of rows up from the last row). Instead of selecting the row value from the list, you can enter the row number directly into the Line field.
    4. Select the edit icon (Edit line icon) to display a Modify Text window where you define one or more modifier extraction rules to extract the exact document property you need.
    5. Choose one of the following modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

      When you use a modifier to define a text extraction rule, the Text to Modify field at the top of the Modify Text window contains the selected line plus any edits you make to the line. The Modified Value field to the right of a modifier displays the text that results when that modifier is applied to the text it received from either the modifier above it or the Text to Modify field (if you are defining the first modifier).

    6. Continue to apply modifiers until you extract the value you want from the selected line. Click the Add icon icon to add a new modifier. The Final Text field below the list of modifiers displays the final modified value, after all modifier extraction rules are applied.
      For the selected modifier, the Modifier Initial Text field at the bottom of the window displays the value before the modifier is applied. The Modified Text field displays the value after the modifier is applied.
    7. Use the modifier management icons near the top of the window to delete and reorder the modifier extraction rules. Use the Trash can icon icon to delete the selected modifier extraction rules. Use the up and down arrow icons to reorder the rules. The rules are applied to the line in order from top to bottom.
    8. Click the OK button to save the line extraction rule.
  8. Continue to define the other document properties you need to extract from a line in the block. You can select the same line that you used in another document property. If you need to delete a document property or want to rearrange their order, place a check mark in the box in front of a document property, and use the Trash can icon icon and the up down arrow icons.
  9. When you have finished defining document properties, click OK.
  10. Click Ricoh View Document Property Values to verify that the properties have the content you want.
  11. Optional: You can edit the text block definition by double-clicking its box or by right-clicking the box and selecting Edit.
  12. When you are ready to save all your enhancements to the PDF file, including the new document properties definition, click Ricoh Save Control File.
  13. Move the control file to a directory location used by a RICOH ProcessDirector server and include its name and location in a RICOH ProcessDirector IdentifyPDFDocuments step. This control file must also contain the page group definition that defines the documents in the PDF files processed by that step.

1.5.3.9.3 Defining an address block

You can define document properties in an address block in each document in a PDF file. After you define the document properties, you can extract and view them or save them in a text file.

Note: Use the Define Multiple Properties function to define document properties for addresses if:
  • The address components are not in block form.

  • You want to give the document properties your own names.

  • The Define Address Block function assigns one or more components of the address text to the wrong document property.

To define an address block:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
    Tip: Tip: Before you select an address block, scan your sample PDF file for the most complicated and longest example of addresses in the PDF files that you are going to process. For example, if the first document in your PDF file contains an address of only three rows, and page 80 contains a five-row address, draw the box around the five-row address so you can work with the most complicated address. When you view document property values, you can verify that each document property in shorter address blocks has the proper value.
  2. Left-click just above the top left corner of an address area and drag the mouse to capture all rows of the address.
  3. Select Define Address Block from the popup menu.
  4. Examine the Selected Address section of the Define Address Block window. If you have not captured all the lines in the address block, click Cancel and draw the box around the address again. Repeat this step until the address you want is displayed in the rows of the Selected Address table.
  5. Type a Name for the address block.
  6. Use the Extraction Conditions section to specify the page in each document from which address block data will be extracted. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is First Front Only. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
      Important: The Last Back, Last Front, and Last Page rules do not work with address block extraction.
    • Select Specific pages and type the page in each document that you want.

      If you specify multiple pages, RICOH ProcessDirector Plug-in for Adobe Acrobat extracts the address block from the last specified page in each document. Examples:

      • You specify pages 2–4. If a document has four or more pages, the address block is extracted from page 4. If a document has three pages, the address block is extracted from page 3. If a document has two pages, the address block is extracted from page 2.
      • You specify pages 2,4. If a document has four or more pages, the address block is extracted from page 4. If a document has 2–3 pages, the address block is extracted from page 2.
      • You specify pages 2–n. Because n represents the last page, the address block is extracted from the last page if the document has two or more pages.
        Important: If you specify only page n, RICOH ProcessDirector Plug-in for Adobe Acrobat does not extract the address block from any page in a document.

  7. Select an address type:
    • Address lines 1–7

      This option defines seven document properties (Doc.Address.1 through Doc.Address.7) based on the first seven lines in the address block. Subsequent lines are ignored.

    • U.S. addresses

      This option defines eight document properties:

      • Doc.Address.FullName

      • Doc.Address.Primary

      • Doc.Address.Secondary

      • Doc.Address.Other

      • Doc.Address.City

      • Doc.Address.State

      • Doc.Address.ZipCode

      • Doc.Address.CityStateZip

    Each component of address text in the Selected Address becomes a value for a document property in the Address Document Properties area.
  8. Check to make sure that each document property has the proper value.
  9. Click OK to create the document properties for the address block.
  10. Click Ricoh View Document Property Values to verify the properties have the content you want.
  11. Optional: You can edit the address block definition by double-clicking its box or by right-clicking the box and selecting Edit.
  12. When you are ready to save all your enhancements to the PDF file, including the new document properties for the address block, click Ricoh Save Control File.
  13. Make the control file accessible by your RICOH ProcessDirector server and include its name and location in an IdentifyPDFDocuments step. This control file must also contain the page group definition that defines the documents in the PDF files processed by that step.

1.5.3.9.4 Viewing document property values

After you create a document property in a sample PDF file, you can view the data values for that property. You view document property values to verify that you have selected the right location for the property and defined the correct conditional extraction rules. You can click a document property value to go to the first page of the page group that contains the value.
Follow these steps to view a table of extracted document property values.
  1. Open a PDF file in Adobe Acrobat Professional and load the control file that has the document properties you want to view.
  2. Click Ricoh View Document Property Values.
    In the Document Property View window, you see document property values for the number of pages that you defined in the Pages to Process preferences setting.
  3. To view fewer or more document property values, change the Number of pages to process and click Update table.
    The more pages you specify, the longer RICOH ProcessDirector Plug-in for Adobe Acrobat takes to view document property values.
  4. Optional: Click any row in the document property table to go to the first page in the page group that contains the document property value.
    Tip: Tip: Keep this window open as you define document properties, so you can update the values in the table to verify you have correctly selected the property.

1.5.3.9.5 Saving document property values

After you create document properties in a sample PDF file, you can save the data values for those properties. For example, you can save the account numbers in a PDF file that you plan on printing for an audit or printed in the past for an audit.
To save document property values:
  1. While viewing document property values, click Save.
  2. Select a location for the file and type a name, or use the name and location of the PDF file with a .txt extension.
  3. Click Save.
    RICOH ProcessDirector Plug-in for Adobe Acrobat generates a tab-delimited text file containing the values.

1.5.3.10 Working with rules

A rule is a set of one or more conditions. You can apply the conditions specified by a rule to place markup, extract data, or specify media and finishing options. You can also include a rule as a condition within another rule.

For example, you can use a rule to:

  • Place a barcode on the first page of each document in your PDF file
  • Extract a customer’s name when the city in the mailing address is New York
  • Specify gold media for the first page of each document for a Gold Club member

Each condition in a rule compares two values. The first value can be a Predefined Rule (a rule defined by RICOH ProcessDirector Plug-in for Adobe Acrobat that specifies pages within documents), a Custom Rule (a rule that you have defined), a conditional trigger, a job property, a document property, or a statistic. The choices for the second value depend on the first value.

When you create a rule with multiple conditions, you can specify whether the rule requires all conditions to be met or any condition to be met.

Rules can evaluate static and dynamic values. For example, a rule can evaluate whether the total number of documents in a job is greater than 10. A rule can also evaluate whether the value of the Doc.Begin.Balance document property is equal to the value of the Doc.End.Balance document property.

The Figure below shows a rule with five different types of conditions.

Rule with multiple conditions
Rule Builder dialog showing a rule with multiple conditions

1.5.3.10.1 Pre-defined rules

RICOH ProcessDirector Plug-in for Adobe Acrobat has 11 pre-defined rules that apply markup to, set media and finishing options for, or extract data from specific pages within each document in a PDF file. For example, you can use a pre-defined rule to place an image on all front pages in each document.

The table below describes each pre-defined rule.

Pre-defined rules
Rule Definition
All Front Pages All front-facing pages in each page group. If the rule is used to define a document property, the value extracted is from the last front page in a page group.
All Back Pages All back-facing pages in each page group. This rule does not apply to a simplex job. If the rule is used to define a document property in a duplex job, the value extracted is from the last back page in a page group.
All Pages Markup prints on all pages in each page group. Document properties values are extracted from the last page (either front or back) in a page group. If a rule does not have a condition with a pre-defined rule, RICOH ProcessDirector Plug-in for Adobe Acrobat applies the rule to All Pages.
First Front Only First page in each page group.
First Back Only First back page in each page group. This rule does not apply to simplex jobs.
Second Front Only Second front-facing page in each page group.
Second Back Only Second back-facing page in each page group. This rule does not apply to simplex jobs or to jobs that do not have a second back page.
Last Front Only Last front-facing page in each page group.
Last Back Only Last back of each page group. This rule does not apply to simplex jobs.
Last Page Only Last page of each page group (front or back is not a factor).
No Pages No pages. To keep a rule from being applied, you can add a condition with No Pages = True.

1.5.3.10.2 Conditional triggers

A conditional trigger is text that determines whether a condition is met.

If you want to place a barcode on a page whenever the word Invoice appears at the top of the page, you can define a conditional trigger for the word Invoice, define a rule with the trigger as a condition, and use the rule to apply the barcode.

If you want to use special media when the word Overdue appears at the bottom of the page, you can define a conditional trigger for the word Overdue, define a rule with the trigger as a condition, and use the rule to set the media.

If you want to extract the value of a document property whenever the words Account Summary appear on the right side of the page, you can define a conditional trigger for the words Account Summary, define a rule with the trigger as a condition, and use the rule when you define the document property.

Tip: Tip: If you know that the word you want to define as a conditional trigger occurs on a specific page in every page group, you can use the Stat.CurrentPageInDocument statistic instead of a conditional trigger.

1.5.3.10.3 Using job properties or document properties in rules

You can compare a job property or document property to a static value, such as a number or word, or to a dynamic value, such as job property, document property or statistic.

For example, you have two inserters, and you want to choose the inserter for different jobs. You can use the SetDocPropsFromConditions step in your workflow to set a value of a specific job property such as Doc.Insert.InserterID. In RICOH ProcessDirector Plug-in for Adobe Acrobat, you can use the Doc.Insert.InserterID job property in a rule. RICOH ProcessDirector can apply a specific barcode or image based on the control file (which contains the rules you defined in RICOH ProcessDirector Plug-in for Adobe Acrobat) that you add to a BuildPDFFromDocuments step.

Note: When using a document or job property value in a rule, define your value so it matches the value of the property when RICOH ProcessDirector processes the page groups in the PDF file. For example, the values of the Doc.Insert.InserterID job property in RICOH ProcessDirector are 01 and 02. Use those values when you define a rule with the Doc.Insert.InserterID job property as a condition. Do not use One and Two.

1.5.3.10.4 Using statistics in rules

You can compare a statistic to a static value, such as a number or word, or to a dynamic value, such as a job property, document property, or statistic.

For example, you want to create a barcode on the third page of every document. You select the Stat.CurrentPageInDocument statistic, select = as the mathematical symbol, and type 3 in the Text field. The fifth condition in the Figure Rule with multiple conditions specifies a statistic.

The table below describes the available statistics.

Statistics options for rules
Keyword Level Definition
Stat.TotalDocumentsInJob Print job The total number of documents in the current print job.
Stat.TotalSheetsInJob Print job The total number of sheets in the current print job.
Stat.TotalPagesInDocument Document The total count of pages in the current document.
Stat.TotalSheetsInDocument Document The total count of sheets in the current document.
Stat.CurrentDocumentInJob Document The number of the current document in its print job, starting at 1. For example, the value of Stat.CurrentDocumentInJob for the third document is 3.
Stat.CurrentPageInDocument Page The number of the current page in its document, starting at 1. For example, the value of Stat.CurrentPageInDocument for the second page in a document is 2.
Stat.CurrentSheetInDocument Page The number of the current sheet in its document, starting at 1.
Stat.CurrentPageInJob Page The number of the current page in its print file, starting at 1 and always from the Start page of the job. For example, the value of Stat.CurrentPageInJob for the tenth page in the print file is 10.
Stat.CurrentSheetInJob Page The number of the current sheet in its print file, starting at 1 and always from the Start page of the job.
Stat.CurrentMedia Page The media specified for the current page in a print job when the IdentifyPDFDocuments step was run. If no media is specified for the page, Stat.CurrentMedia provides the media specified for the job. If no media is specified for the page or the job, Stat.CurrentMedia does not provide a value. For example, the value of Stat.CurrentMedia for the first page of a document is Letterhead.
    Note:
  • Stat_CurrentMedia does not provide media specified using RICOH ProcessDirector Plug-in for Adobe Acrobat.
  • You cannot preview markup that is placed using a RICOH ProcessDirector Plug-in for Adobe Acrobat rule that evaluates Stat.CurrentMedia.
Note: Although some statistics describe job-level values, RICOH ProcessDirector evaluates each page in a document when determining whether or not to apply markup or extract the value of a document property.

1.5.3.10.5 Defining a rule

You can define rules that specify conditions for markup. You can also define rules to set media and finishing options, or to extract data.
Before you define a rule, make sure you have defined each custom rule, document property, and conditional trigger that you want to use as conditions in the rule.
To define a rule:
  1. Click Ricoh Manage Rules.
  2. Click the Add content icon icon.
    Rules are shown alphabetically by name.
    Tip: Tip: In a markup dialog, you can define a rule by clicking the Add content icon icon and edit a rule by clicking the Rules Manager icon icon.
  3. Type a Name for the rule. You can use alphanumeric characters, periods, underscores, spaces, and special characters (such as @, #, $, or %).
  4. Optional: Type a Description.
  5. Specify whether RICOH ProcessDirector Plug-in for Adobe Acrobat should apply the rule when any or all of its conditions are met.
  6. Specify the first condition.
    1. Click the down arrow for the Not set drop-down list.
    2. Click the + icon next to Predefined Rule, Custom Rule, Trigger, Job Property, Document Property, or Statistic and select the item you want for the first part of the condition.

      If a choice (such as custom rules, conditional triggers, or document properties) does not have any items, the choice is grayed out.

      Note: To display all items with a word in their names, type the word and press the down arrow key on your keyboard. You can also type the word and click the down arrow for the drop-down list.
    3. Select a mathematical symbol, such as = (equals) or (does not equal), to compare the two parts of the condition.
    4. Specify the second part of the condition:
      • For a rule, select True or False.
      • For a conditional trigger, verify that the condition has the value you want. If not, select a new conditional trigger.
      • For a job property, document property, or statistic, type a value. You can also select any job property, document property, or statistic.
  7. For a rule with multiple conditions, click the Add content icon icon and specify the next condition.
    Repeat this step until you have defined all the conditions in the rule.
  8. Click OK to create the rule and add it to the Rules Manager.
Examples
Rule with one condition: a pre-defined rule
To place markup on the first front page of each document, define a rule with a pre-defined rule as its only condition: First Front Only = True
Three rules that each have one condition: a document property
A job contains sales statements for members at three different levels based on sales performance: Bronze, Silver, and Gold. You want to identify each membership level.
  • In RICOH ProcessDirector, define a document property: doc.member.level.
  • In RICOH ProcessDirector Plug-in for Adobe Acrobat, define three rules:
    • Gold Level

      doc.member.level = GOLD

    • Silver Level

      doc.member.level = SILVER

    • Bronze Level

      doc.member.level = BRONZE

Rule with multiple conditions
A job contains sales statements for members at three different levels based on sales performance: Bronze, Silver, and Gold. You want to print a reward coupon on the first page of each statement for Gold and Silver members. This example uses three rules defined in the previous examples:
  • First Front Only
  • Gold Level
  • Silver Level

First, define a Top Sales rule with two conditions, which you apply when any condition is met:

  • Gold Level = True
  • Silver Level = True

Next, define a Top Sales — First Front rule with two conditions, which you apply when all conditions are met.

  • First Front Only = True
  • Top Sales = True

Finally, select the Add Image option. Apply settings by clicking Pages/documents based on conditions and selecting the Top Sales — First Front rule. Specify the path to the image.

Rule with one condition: a job property
To print VOID: DO NOT MAIL on each page of a test job:
  • Define a Test Job rule with a job property as its only condition: Job.TestJob = Yes
  • Select the Add Text option. Apply settings by clicking Pages/documents based on conditions and selecting the Test Job rule. Select Text as the Content Type and type VOID: DO NOT MAIL for the value.
Rule with a condition that uses dynamic data
When a statement has different addresses for billing and shipping, you want to print Order sent to shipping address on the statement:
  • Define two document properties: doc.shipping.address and doc.billing.address.
  • Define a Sent to Shipping Address rule with this condition: doc.shipping.address ≠ doc.billing.address
  • Select the Add Text option. Apply settings by clicking Pages/documents based on conditions and selecting the Sent to Shipping Address rule. Select Text as the Content Type and type Order shipped to shipping address for the value.

1.5.3.10.6 Defining a conditional trigger

You can define text in a PDF file as a trigger to control whether markup is applied to a page when RICOH ProcessDirector processes a PDF file. The text can also control whether media and finishing options are applied to a page and whether document properties are extracted from a page.
Note: If you are experimenting to determine which text to use as a conditional trigger, you do not have to save the conditional trigger in a control file before you use preview mode. For preview mode, RICOH ProcessDirector Plug-in for Adobe Acrobat generates a temporary control file.
To define a conditional trigger:
  1. Open a PDF file in Adobe Acrobat Professional and load a control file that contains the page group definition.
  2. Left-click slightly above and to the left of the text that you want to use as a conditional trigger. Drag the mouse to draw a box around the text.
      Note:
    • If you draw a box around an area with no text, the conditional trigger determines that its condition is met whenever the area has no text. The condition is also met when the area has an image or other markup but no text.
  3. Select Define Conditional Trigger.
  4. Verify that the Trigger box has the text that you selected. If not, click Cancel and select the text again.
  5. Type a Name for the trigger. Do not use spaces or special characters (such as @, #, $, or %) in the name. You can use periods and underscores.
  6. Click OK to create the trigger.
    The conditional trigger is now available on the drop-down list for specifying conditions when defining rules.
Example

You want to extract a customer account number for every page group. Each invoice in your PDF file contains the word Account near the upper left of the first or second page of every document. Each customer account number is printed to the right of that word. The longer invoices also have the customer account number on the third page.You draw a box around the first occurrence of the word Account in the PDF file you are enhancing, and you name the trigger acct_trg.

Next, you create a rule with a condition that specifies the trigger: acct_trg = Account.

Finally, you define a document property that applies the rule.

1.5.3.10.7 Managing rules

The Rules Manager dialog shows information about your rules. You can define new rules, and edit or delete existing rules.

For each rule, the dialog shows the rule name and description. Rules appear on the list in alphabetical order by name.

To define a new rule, click the Add icon icon.

To work with a rule, select it. Click the Edit icon icon to modify the rule or the Trash can icon icon to delete it.

1.5.3.11 Adding markup to a PDF file

You use RICOH ProcessDirector Plug-in for Adobe Acrobat to add markup to a PDF file that represents your production PDF files. You mark up a PDF file by drawing a box around existing content or by drawing a box to add new markup. You can preview the PDF file as you add markup to verify its content and placement on specific pages. When you are done enhancing the sample PDF file, you save your changes to one or more control files and make them accessible by a RICOH ProcessDirector server so it can apply the control files to production PDF files.

Before you add markup to a PDF file, you must define the page grouping for the documents in the PDF file. See Defining a page group for more information. When previewing the page placement of markup, you may not be able to view the placement or content that RICOH ProcessDirector applies to markup when processing your RICOH ProcessDirector workflows. RICOH ProcessDirector Plug-in for Adobe Acrobat may not have access to all of the properties that you use to define both page placement rules and markup content (such as in text and barcodes). See Previewing markup for more information.

When RICOH ProcessDirector applies markup defined in the control files that you specified in a BuildPDFFromDocuments step, RICOH ProcessDirector applies the markup in this order:

  • Hidden areas
  • Images
  • Text
  • OMR marks
  • Barcodes

1.5.3.11.1 Adding a barcode to a PDF file

To add a barcode to a PDF file, select the area where you want to place the barcode, specify a barcode type, and add content. You can limit the placement of a barcode to specific pages in each page group by specifying a rule or typing page numbers.

RICOH ProcessDirector Plug-in for Adobe Acrobat supports the following barcode types:

  • 2of5 (Interleaved 2 of 5)
  • Code128
  • Code39
  • Datamatrix
  • IMB (Intelligent Mail Barcode)
  • QR code (Quick Response Code)
  • RM4SCC (Royal Mail 4-State Customer Code)
  • RMM (Royal Mail Mailmark)
    Note:
  • If you are creating child jobs, make sure that the barcode type supports periods. Child jobs have a period in the job number (for example, 10000001.1). Automated Verification workflows create child jobs for open-loop reprints. The Postal Enablement GroupDocsForPostalProcess workflow creates a child job when the documents in the job qualify for more postal processing.

You can create a barcode from content within the PDF file. For example, if your processing extracts the customer account number for every mailpiece you print, you can create a barcode from the account number. You first create a document property for the account number. You can then select that document property when defining the barcode content.

If you want to use text in the PDF file to trigger placement of a barcode on a specific page in a page group, you first create a conditional trigger on that text and define a rule with the trigger as a condition. You can then select that rule when defining the barcode.

To add a barcode:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Use the left mouse button to draw a box where you want the barcode to print. You do not need to draw the box to the exact size of the barcode.
    The barcode is not resized to fit within the box. If you draw a box to the approximate size of the barcode, you can see its position relative to all the markup you add to the PDF file.
  3. Click Add Barcode.
  4. Type a Name for the barcode. Do not use spaces or special characters (such as @, #, $, or %) in the name. You can use periods and underscores.
  5. Optional: Use the Location section of the definition window to change the placement of the barcode by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the barcode, before any rotation. If your manufacturing equipment has a specification for the location of the barcode, use these coordinates to set a precise location.
      Note:
    • Width and Height change the size of the markup box but do not affect the location or size of the barcode.
  6. Select the clockwise Rotation (degrees). The reference point for rotating a barcode is its top left corner.
  7. Use the Placement Conditions section to specify the pages to place the barcode on. Do either of these steps:
    • Select Pages based on a rule, and then select a rule from the list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  8. Use the Barcode Configuration section to define the mechanical attributes and type of the barcode.
    1. Use the Barcode Type list to select one of the following barcodes: 2of5, Code128, Code39, Datamatrix, IMB, QR code, RM4SCC, or RMM.
    2. Click the Settings button to set the mechanical attributes of the barcode.
      The Table Barcode mechanical attributes describes the settings for each barcode type.
      Barcode mechanical attributes
      Barcode type Attribute and description
      2of5 and Code39 The unit of measure for the numeric attributes for these barcode types is millimeters.
      barHeight This attribute determines the vertical height of each bar.
      checksumMode This attribute determines the behavior of checksums.
      • To add the checksum to the message, enter: add
      • To check the checksum when rendering the barcode, enter: check
      • To disable checksum processing, enter: ignore
      • To enable the default barcode behavior, enter: auto
      moduleWidth This attribute is the width of the narrow element.
      widthFactor This attribute is the multiplier for the wide element or how many times wider it is than the narrow element.
      Code128 The unit of measure for the numeric attributes for this barcode type is millimeters.
      barHeight This attribute determines the vertical height of each bar.
      checksumMode This attribute determines the behavior of checksums.
      • To add the checksum to the message, enter: add
      • To check the checksum when rendering the barcode, enter: check
      • To disable checksum processing, enter: ignore
      • To enable the default barcode behavior, enter: auto
      moduleWidth This attribute is the width of the narrow element.
      Datamatrix The unit of measure for the numeric attributes of this barcode type is millimeters.
      maxSize This attribute determines the maximum number of modules in both X and Y directions.
      minSize This attribute determines the minimum number of modules in both X and Y directions.
      moduleWidth This attribute determines the size of each pixel element.
      shape The FORCE_SQUARE value forces the use of square symbols. No other values are supported.
      IMB and RM4SCC The unit of measure for the numeric attributes for these barcode types is millimeters.
      ascenderHeight This attribute defines the height of both the ascender and descender sections of long bars.
      intercharGapWidth This attribute defines the width of each gap. The value you enter must be from 0.38 through 0.63 and must be the same as the moduleWidth value.
      moduleWidth This attribute defines the width of each bar and must be from 0.38 through 0.63.
      trackHeight This attribute defines the height each short track or center bar and must be a value from 1.02 through 1.52.
      QR code The unit of measure for the numeric attribute of this barcode type (moduleWidth) is inches.
      encoding This attribute defines the encoding type of the QR barcode.
      • To specify UTF-8 encoding, enter: Auto
      • To specify that the Unicode data is output in that format, enter: Shift_JIS or another supported type of Shift JIS code points, such as sjis or x-sjis.
        Note:
      • The input data for the barcode must always be Unicode character points. Do not use Shift_JIS or any other non-Unicode input data.
      errorcorrection This attribute defines the capability to restore the data in a damaged QR barcode.
      • To specify that 7% of the code can be restored, enter: L
      • To specify that 15% of the code can be restored, enter: M
      • To specify that 25% of the code can be restored, enter: Q
      • To specify that 30% of the code can be restored, enter: H
      moduleWidth This attribute determines the size of each pixel element.
      version Do not change this attribute; it is reserved for future use.
      RMM shape This attribute determines the type of barcode.
      • To specify a 2D Type 9 barcode, enter: square
      • To specify a 2D Type 29 barcode, enter: rectangle

      The values for the attribute are not case-sensitive.

  9. Select one of the following from the Content Type list.
      Note:
    • Because RICOH ProcessDirector generates barcode content as it prepares a PDF file for printing, RICOH ProcessDirector Plug-in for Adobe Acrobat cannot always determine valid content for a barcode. For example, some barcodes cannot accept text or line breaks. If you include invalid barcode content, the PDF file job might fail in the RICOH ProcessDirector BuildPDFFromDocuments step.
    Job Property Select a job property whose value you want to include in the barcode.
    Document Property Select a document property whose value you want to include in the barcode.
    Statistic Select a statistic whose value you want to include in the barcode.
    Text Enter text that you want to include in the barcode.
    Line Break Select this content type when you want to force a line break. The break occurs after the last character of the prior barcode content.
    Script Only select this option on the advice of your software support representative.
    1. If you selected a document property, job property, or statistic Content Type, you can apply text modifier rules to the value of the property or statistic. Click the Edit icon icon to display a Modify Text window for defining one or more modifier extraction rules to extract the exact value you need.
    2. Enter text into the Text to Modify field. RICOH ProcessDirector generates or extracts statistics and properties as it processes each page group in production PDF files. Because these values are not available to RICOH ProcessDirector Plug-in for Adobe Acrobat, you must enter a text value that represents the values that RICOH ProcessDirector processes. The modifier rule is a template that is applied to all values of the content type that you selected. For example, you want to print only the last eight digits of customer account number, and you have stored the entire number into a document property. You select Document Property as the Content Type, and select the account document property as the Content Value. You define two Remove Character text modifier rules to strip dashes and spaces from the number to make them all uniform. Then you define a Substring by Position rule to retain only the last eight digits. You do not need to know any single value of a document property to create modifier rules. You need to know only the possible formats that could occur in your PDF files.
    3. Choose one of these modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

  10. To add a new content definition row, click the Add content icon icon. After you have added all content types and modifier rules to the barcode, you can place a check mark in the box next to a content type and use the up and down arrows to reorder the content. Use the Trash can icon icon to delete selected content.
  11. If you defined multiple lines of text and you want RICOH ProcessDirector Plug-in for Adobe Acrobat to remove lines that only contain white space, click the Remove blank lines check box to select it.
  12. To create your barcode configuration, click OK.
  13. To verify that the barcode has the content and page placement you intended, click Ricoh Preview.
  14. Optional: You can edit the barcode definition by double-clicking the barcode box or by right-clicking the box and clicking Edit.
  15. When you are ready to save all your enhancements to the PDF file, including the new barcode definition, click Ricoh Save Control File.
  16. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the barcode definition.

1.5.3.11.2 Adding OMR marks to a PDF file

You can add a variety of OMR marks of different height, width, and pitch to a PDF file. You can limit the placement of OMR marks to specific pages in each page group by specifying a rule or typing page numbers.
    Note:
  • If your brand of inserters or other machinery requires specific OMR marks, you must use the specifications from your supplier.
To add OMR marks:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group definition or define a page group.
  2. Use the left mouse button to draw a box where you want the OMR marks to print. You do not need to draw the box to the exact size of the OMR marks.
    The OMR marks are not resized to fit within the box. If you draw a box to the approximate size of the OMR marks, you can see their position relative to all the markup you add to the PDF file.
  3. Select Add OMR.
  4. Type a Name for the OMR marks. Do not use spaces or special characters (such as @, #, $, or %). You can use periods and underscores.
  5. Optional: Use the Location section of the definition window to change the placement of the OMR marks by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the OMR marks. If your manufacturing equipment has a specification for the location of the OMR marks, use these coordinates to set a precise location.
    Note: Width and Height change the size of the markup box but do not affect the location or size of the OMR mark.
  6. Use the Placement Conditions section to specify the pages to place the OMR marks on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  7. Use the Physical Configuration section to define the OMR content and form. If the OMR Content drop-down list has the name of the configuration you need, select it from the list. OMR configuration files have a .omr extension and are saved by default in the RICOH ProcessDirector Plug-in for Adobe Acrobat application data directory. If you need a different configuration than the one that is selected, click the Manage Content button.
    Tip:
    • You can view the application data directory location for the current user by typing %appdata% in Windows Run command line and clicking OK.
    1. If you do not want to modify the selected OMR configuration file, click New or Copy.
    2. Use the Add and Remove buttons to manage the OMR content in the Chosen Marks box. Use the Move Up, Move Down, and Reverse buttons to specify the order in which the marks are printed.
      The Table Available OMR marks describes the marks you can add to your OMR definition.
      Available OMR marks
      OMR mark name Description
      Blank Leaves a space equal to the OMR pitch value plus the OMR height value.
      Collate Indicates that the current group of pages need to be enveloped. This mark normally appears only on the first or last sheet of a page group.
      Feeder Defines the location for a feeder station mark. There can be multiple occurrences of this mark.
      Gate Sometimes used to mark the start of an OMR set. If requested, this mark is always present.
      Parity Used to bring the total number of bars up to the required parity, either even or odd.
      Safety Sometimes used to mark the end of an OMR set. If requested, this mark is always present.
      Sequence Displays a sequence using from one to three bars or from one to four bars.
      Void Leaves a space equal to the OMR Pitch value.
    3. In the OMR Configuration section of the Add OMR window, first select your Units of measure. Enter numeric values into the Height and Length fields to define the height and width of each OMR mark. Enter a numeric value into the Pitch field to define the distance between each OMR mark.
    4. In the Parity section, select whether your inserter uses Odd or Even parity checking.
    5. Select First Page or Last Page collation.
    6. If you select a sequence bar type, use the Sequence Range section to specify 1 through 7 for three bars or 1 through 15 for four bars.
    7. If you select a sequence bar type, use the Sequence section to define the bit order of the sequence bars. Select Up to print the bars in a 1, 2, 4 order (three bars) or in 1, 2, 4, 8 order (four bars). Select Down to print the bars in 4, 2, 1 order or in 8, 4, 2, 1 order.
      If the sequence is Up, a bar in the first position represents 1, a bar in the second position represents 2, bars in the first and second positions represent three, a bar in the fourth position represents 4, bars in the first and fourth positions represent 5, and so on.
    8. After you have defined the OMR content and structure definition click Save and then click Cancel to return to the main OMR configuration window.
  8. Use the Inserts field to select a fixed set of inserts for an entire job. You enter either a 0 or a 1 to tell the inserter which inserts to pull for every document in a job. For example, on a six station inserter with stations numbered from one to six, if you want to add the inserts from stations two and four, you enter the value 010100 into the Inserts field.
  9. Click Ricoh Preview to verify the OMR has the structure and page placement you intended.
  10. Optional: You can edit the OMR definition by double clicking the OMR box or by right-clicking the box and selecting Edit.
  11. When you are ready to save all your enhancements to the PDF file, including the new OMR marks definition, click Ricoh Save Control File.
    Tip:
    • When you save an OMR configuration, the OMR definition is saved to an OMR configuration file in the InfoPrint directory in your application data directory. When you mark up a PDF file, add OMR marks, and save a control file, the OMR configuration is also saved into the control file. You specify that control file in a BuildPDFFromDocuments step. You do not need to move the OMR configuration file to a directory accessible by RICOH ProcessDirector, but you can move the OMR configuration file to another computer used by RICOH ProcessDirector Plug-in for Adobe Acrobat if you want to share the configuration with someone else.
  12. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the OMR marks definition.

1.5.3.11.3 Adding an image to a PDF file

You can add JPEG images, such as a logo or an advertisement, to the PDF file. You can limit the placement of an image to specific pages in each page group by specifying a rule or typing page numbers. RICOH ProcessDirector Plug-in for Adobe Acrobat can process only JPEG files that are in RGB format; the CMYK format is not supported.

To add an image:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group or define a page group.
  2. Use the left mouse button to draw a box where you want the image to print. You can also place an image over a hidden area markup box.
    Note: The image is not resized to match the size of the box. If you draw a box to the approximate size of the image, you can see its position relative to all the markup you add to the PDF file.
  3. Click Add Image.
  4. Use the Location section of the definition window to change the placement of the image by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the image.
    Note: Width and Height change the size of the markup box but do not affect the location or size of the image.
  5. Type a Name for the image. Do not use spaces or special characters (such as @, #, $, or %). You can use periods and underscores.
  6. Use the Placement Conditions section to specify the pages to place the image on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  7. If the image you are defining exists in a file path that you can access, select Browse, click the JPEG image file you want to add to the PDF file, and click Open. When you save this image definition to a control file, the image file is embedded in the control file. You do not need to copy the image to a directory accessible to a RICOH ProcessDirector server.

    Instead of embedding the image file in a control file, you can enter an image file name and location that RICOH ProcessDirector can access when a BuildPDFFromDocuments step processes PDF files. If you specify an image file name and location that RICOH ProcessDirector Plug-in for Adobe Acrobat cannot find, a message informs you that the image was not found. If you want to use the image file name and path for the RICOH ProcessDirector server, select Yes. Otherwise, select No.

    To specify a directory location accessible to RICOH ProcessDirector, type the full directory path and file name (for example, /aiw/aiw1/images/myimage.jpg). If RICOH ProcessDirector cannot find the image file when it processes a PDF file, the job fails in the BuildPDFFromDocuments step.

  8. Click OK to create the image configuration.
  9. Optional: Click Ricoh Preview to verify that the image has the page placement you intended.
  10. Optional: You can edit the image definition by double-clicking the image box or by right-clicking the box and selecting Edit.
  11. When you are ready to save all your enhancements to the PDF file, including the new image definition, click Ricoh Save Control File.
  12. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the image definition.

1.5.3.11.4 Hiding an area in a PDF file

You can hide an area of a PDF file by defining a cover block to keep an area on a page from being shown or printed when you process a production PDF file in RICOH ProcessDirector. You can limit the placement of a hidden area to specific pages in each page group by specifying a rule or typing page numbers.
Typically you hide areas of a PDF file that contain images, text, barcodes, or other types of optical marks that are no longer needed. For example, if you want to replace an existing optical mark with a smaller Datamatrix barcode, you draw a box over the area that contains the old marks to hide them. You then place a new Datamatrix barcode on top of the hidden area. When RICOH ProcessDirector processes a PDF file with a hidden area, it blocks that area from having any ink applied, so the hidden area is the same color as the print media. When RICOH ProcessDirector applies markup to a PDF file, the BuildPDFFromDocuments step applies all hidden areas before applying other markup.

To hide an area:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group or define a page group.
  2. Use the left mouse button to draw a box around the area of the PDF file that you want to hide.
  3. Click Hide Area.
  4. Optional: Use the Location section of the definition window to change the placement and size of the hidden area. The Horizontal and Vertical coordinates specify the distance between the top left corner of the page and the top left corner of the hidden area. The Width and Height specify the size of the hidden area.
  5. Type a Name for the hidden area. Do not use spaces or special characters (such as @, #, $, or %). You can use periods and underscores.
  6. Use the Placement Conditions section to specify the pages to place the hidden area on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

        .
  7. Click OK to create the hidden area definition.
  8. Click Ricoh Preview to verify the hidden area has the page placement you intended.
  9. Optional: You can edit the hidden area definition by double-clicking the hidden area box or by right-clicking the box and selecting Edit.
  10. When you are ready to save all your enhancements to the PDF file, including the new hidden area definition, click Ricoh Save Control File.
  11. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the hidden area definition.

1.5.3.11.5 Adding text to a PDF file

You can add fixed text or variable text to a PDF file. You also can combine fixed and variable text in one text box. Fixed text is text that you type. Variable text is data from document properties, job properties, or statistics.
To add text:
  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains a page group or define a page group.
  2. Use the left mouse button to draw a box in the area where you want to add text.
    RICOH ProcessDirector Plug-in for Adobe Acrobat uses the upper left corner of the text box to position the text. All the text you specify is printed at the size you specify, even if the text does not fit inside the box.
  3. Click Add Text.
  4. Optional: Use the Location section of the definition window to change the placement of the text by entering new Horizontal and Vertical coordinates. These coordinates specify the distance between the top left corner of the page and the top left corner of the text box.
    Note: Width and Height change the size of the markup box but do not affect the location or size of the text.
  5. Type a Name for the text box. Do not use spaces or special characters (such as @, #, $, or %) in the name. You can use periods and underscores.
  6. Select a value from the Align with enclosed text drop-down list:
    • If you want to align the text that you are adding with the first occurrence of existing text enclosed by the box you drew, select First occurrence. RICOH ProcessDirector Plug-in for Adobe Acrobat maintains that position each time that it adds the text.
    • If you want to align the text that you are adding with each occurrence of existing text enclosed by the box you drew, select Each occurrence.
    • If you do not want the text aligned, use the default value Disabled.
    Aligning new text with enclosed text is the most precise way to replace existing text.
      Note:
    • The Align with enclosed text function works best when the new text and the existing text are in the same font. If the fonts are different, RICOH ProcessDirector Plug-in for Adobe Acrobat aligns the baselines of the fonts.

    • RICOH ProcessDirector Plug-in for Adobe Acrobat always aligns the first line of the new text with the first line of the existing text.

    • If the enclosed text is not left-justified, RICOH ProcessDirector Plug-in for Adobe Acrobat aligns the new text with the left-most line of the existing text.

  7. Select the clockwise Rotation (degrees). The reference point for rotating a text box is its top left corner.
  8. Use the Placement Conditions section to specify the pages to place the text on. Do either of these:
    • Select Pages based on a rule, and then select a rule from the drop-down list. The default rule is All Pages. You can also:
      • Click the Add content icon icon to define a new rule. See Defining a rule for more information.
      • Click the Rules Manager icon icon to go to the Rules Manager.
    • Select Specify pages and type the pages in each page group that you want. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page.

        Example: a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

  9. Use the Font section to select the font, size, and color.
    The font drop-down list includes all fonts available to Adobe Acrobat except for fonts that do not permit embedding in a PDF file.
      Note:
    • To make a font available to RICOH ProcessDirector Plug-in for Adobe Acrobat, install it in the Windows Fonts folder.
    • RICOH ProcessDirector Plug-in for Adobe Acrobat does not support alternate letter forms, including ligatures, swashes, and letter forms that vary according to where they appear in a word. Right-to-left languages, such as Hebrew and Arabic, are rendered incorrectly. However, the font drop-down list shows all fonts installed in the Windows Fonts folder, including fonts for right-to-left languages and fonts with unsupported alternate letter forms.
    • When a font is added to a control file, it is the user’s responsibility to make sure that the font is licensed on all machines that use the control file to process a PDF document.
  10. Define the content of the text you are adding:
    1. Select the first Content Type from the drop-down list. You can select as many of the following types as you need to define the text content:
      Text markup content types
      Content Type Description
      Text Type text that you want to print.
      Document Property Select a document property whose value you want to print.
      Job Property Select a job property whose value you want to print.
      Line Break Select this content type to force a line break. The break occurs after the last character of any prior text content.
      Statistic Select a statistic whose value you want to print.
      Script Only select this option on the advice of your software support representative.
    2. Select the Content Value. The drop-down list has the available values for the selected Content Type.
    3. Optional: You can apply text modifier rules to the value of a document property, job property, or job statistic Content Type. Click the Edit icon icon to define one or more text modifier rules to extract the exact value you need.
    4. Type text in the Text to Modify field. RICOH ProcessDirector generates or extracts statistics and properties as it processes each page group in the production PDF files. Because these values are not available to RICOH ProcessDirector Plug-in for Adobe Acrobat, you must enter a text value that is representative of the values that RICOH ProcessDirector processes. The modifier rule is a template that is applied to all values of the content type that you selected. For example, you might need to print only the last four digits of a credit card number, and you have stored the entire number in a document property. You select Document Property as the Content Type, and select the credit card document property as the Content Value. You define two Remove Character text modifier rules to strip dashes and spaces from the number to make them all uniform, and then you define a Substring by Position rule to retain only the last four digits. You do not need to know any single value of a document property to create modifier rules, you need to know only the possible formats that could occur in your PDF files.
    5. Choose one of the following modifiers:

      Content modifiers
      Modifier Action
      Remove Character Type one character or a blank character (use the space bar to type a blank character) that you want to remove from the value. The character is case-sensitive. Then select one of these buttons:
      • Remove all instances of the character

        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 remove all - characters from the value, producing 324144325511.

      • Remove leading characters

        The specified character is removed from the beginning of the value. For example, if you type a blank character, all blank characters are removed from the beginning of the value.

      • Remove trailing characters

        The specified character is removed from the end of the value. For example, if you type a blank character, all blank characters are removed from the end of the value.

      • Remove 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 blank characters are removed from the beginning and end of the value.

      Substring by Position Select Beginning of Line or End of Line from the Starting From list. Select a number for First Position to indicate the location of the first character in the text value. Select a number for Number to Retain to indicate how many characters are retained.
      Substring by Delimiter Type a character or a blank character in the Delimiter field to indicate where the text value is split into separate string segments. The character and the text string are case-sensitive.

      Select Beginning of Line or End of Line from the Starting From drop-down menu.

      Select a number for First Position to define the position of the delimiter in the text string.

      Select a number for Number to Retain to define the number of text string segments to retain.

      These examples show how to select text string segments by specifying a delimiter:

      • For the account number 324-1443255-11, you can use - as the delimiter to split the value into these three text strings: 324, 1443255, and 11. Select Beginning of Line. To select the second and third text strings (1443255 and 11), select 2 for both First Position and Number to Retain.

      • For the mailing address Eldorado Springs CO 80025, you can use a blank character as the delimiter to split the value into these four text strings: Eldorado, Springs, CO, and 80025. Select End of Line.

        • To select the zip code, select 1 for both First Position and Number to Retain.

        • To select the state, select 2 for First Position and 1 for Number to Retain.

        • To select the city, select 3 for First Position and 10 for Number to Retain. By specifying 10 for Number to Retain, you can select city names with up to ten words.

      Pad with Character Select Beginning of Line or End of Line from the Padding Location list. Enter a character or a blank character as the padding character into the Character to Pad with field.

      Enter a number in the Minimum Padded Text Length field to define the minimum length of the text string. If the number of characters in the text string is less than this minimum length, padding characters are added until the text string equals the minimum length.

  11. Click Add document property icon to add a new content definition row. After you have added all content types and modifier rules to the text you are adding to the PDF file, you can place a check mark in the box next to a content type and use the up and down icons to reorder the content. Use the Trash can icon icon to delete selected content.
  12. If you defined multiple lines of text and you want RICOH ProcessDirector Plug-in for Adobe Acrobat to remove lines that only contain white space, click the Remove blank lines check box to select it.
  13. Click OK to create the text configuration.
  14. Click Ricoh Preview to verify the text has the content and page placement you intended.
  15. Optional: You can edit the text definition by double-clicking its box or by right-clicking the box and clicking Edit.
  16. When you are ready to save all your enhancements to the PDF file, including the new text definition, click Ricoh Save Control File.
  17. Move the control file to a directory location that RICOH ProcessDirector can access.
  18. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the text definition.

1.5.3.12 Working with page inserts

The Inserts Manager dialog shows information about page inserts from other PDF files. You can add, edit, and delete page inserts. You also can set the order in which RICOH ProcessDirector adds the inserts to the documents in a job when the BuildPDFFromDocuments step runs.

The Inserts Manager dialog provides this information for each page insert:

  • The PDF file column shows the directory path to the PDF file on the RICOH ProcessDirector primary server.

  • The Insert location column shows whether the pages are inserted before or after the pages in the documents.

  • The Pages column shows which pages in each PDF file are inserted.

  • The Rule column shows the name of the rule that RICOH ProcessDirector uses to determine which documents in a job receive the inserts when the BuildPDFFromDocuments step runs.

  • The Sides column shows whether the insert is one-sided, two-sided, tumbled, or that the setting is inherited from the job.

To add a page insert, click the Add icon icon.

To work with a page insert, select it. Click the Edit icon icon to modify the page insert or the Trash can icon icon to delete it.

RICOH ProcessDirector adds the inserts to the documents in a job in the order that they appear on the Inserts Manager list, from top to bottom.

To revise the order in which inserts are added to the documents, select an insert. Click the Up arrow icon icon or the Down arrow icon icon to move the insert up or down the list.

1.5.3.12.1 Inserting pages from other PDF files

In a PDF file, you can insert pages from other PDF files before each document that matches the placement conditions, after each document that matches the placement conditions, or both. The inserted pages increase the number of pages in each document, and you can apply markup to them.

To insert pages from other PDF files:

  1. Open a PDF file in Adobe Acrobat Professional and either load a control file that contains page groups or define page groups.
  2. Click Ricoh Manage Inserts.
  3. Click the Add content icon icon.
  4. Specify the first PDF file with pages that you want to insert:
    • If you can access the file, click Browse in the File to Insert section. Navigate to the file. Select it, and click Open.
    • If you cannot access the file, type the full directory path to the file on the RICOH ProcessDirector primary server.

      For example, type /aiw/aiw1/insertpages/insert1.pdf on a Unix-based system or C:\aiw\aiw1\insertpages\insert1.pdf on Windows.

      Make sure that RICOH ProcessDirector can access the file when the BuildPDFFromDocuments step runs.

  5. To insert all pages in the file, click the All pages radio button.

    To specify the pages for insertion, click the Specific pages radio button, and type the page selection.

    • Use a hyphen to separate the first and last pages in a page range.
    • Use a comma to separate page selections.
    • Type n to specify the last page.

      For example, type 8-n,5,2 to insert the pages from 8 to the end of the insert file, followed by pages 5 and 2.

  6. In the Insert Location section, choose whether to insert the pages before or after the pages in the documents that match the specified placement conditions.
  7. In the Placement Conditions section, specify the documents that receive inserted pages:
    • To insert pages before or after each document in the open PDF file, click the All documents radio button.
    • To insert pages before or after some documents but not others, click the Documents based on a rule radio button.

      From the list, choose the rule that defines the placement conditions.

      You also can do these actions:

      • To define a new rule, click the Add content icon icon. See Defining a rule for more information.

      • To go to the Rules Manager, click the Rules Manager icon icon.

      Important:

      • Custom rules for page inserts can include conditions based on the values of job properties, document properties, and document statistics (such as Stat.TotalPagesInDocument and Stat.TotalSheetsInDocument).

      • Conditions based on the values of conditional triggers or page statistics (such as Stat.CurrentPageInJob and Stat.CurrentSheetInJob) do not work with custom rules for page inserts. RICOH ProcessDirector evaluates whether a rule for page insertions applies to a document before evaluating the information on the individual pages in a document.

      • Pre-defined rules, such as All Front Pages or Last Back Only, add page inserts to all documents or no documents. Because those rules do not restrict page inserts to specific documents, do not use them for page inserts.

  8. In the Sides section, specify whether you want to print the insert one-sided or two-sided.
    Simplex
    The insert prints on a single side of the paper.
    Duplex
    The insert prints on both sides of the paper, with the long side of the paper as the bound edge.
    Tumble
    The insert prints on both sides of the paper, with the short edge of the paper as the bound edge. The bottom of the front side of the sheet is the top of the back side of the sheet.
    From print job
    The insert prints on the sides specified in the print job.
  9. Click OK.
  10. To select another PDF file and specify how to insert pages, click the Add content icon icon. Repeat the steps for the first PDF file.

    RICOH ProcessDirector inserts the pages from the PDF files in the order that the files appear on the Inserts Manager list, from top to bottom.

    For example, an Inserts Manager list has 4 rows. The PDF files provide the following inserts:

    • Page 1 in the first PDF file is inserted before each document in the open PDF file.

    • Pages 4–6 in the second PDF file are inserted before each document.

    • Pages 2–4 in the third PDF file are inserted after each document.

    • Page 3 in the fourth PDF file is inserted after each document.

    The first document in the open PDF file has 6 pages. After RICOH ProcessDirector adds the inserts, the first document has 14 pages, in this order:
    • Page 1 from the first PDF file

    • Pages 4–6 from the second PDF file

    • Pages 1–6 from the original document

    • Pages 2–4 from the third PDF file

    • Page 3 from the fourth PDF file

  11. To change the order that RICOH ProcessDirector uses to insert pages into documents, select a row on the Inserts Manager list. To move the row up or down the list, click the Up arrow icon icon or the Down arrow icon icon.
  12. When you finish adding PDF files to the list, click OK.
  13. Optional: To verify that the pages have been inserted as you intended, click Ricoh Preview.

    When you preview a PDF file with inserts, RICOH ProcessDirector Plug-in for Adobe Acrobat checks whether the PDF files are at the directory paths you specified on the Inserts Manager list.

    • If they are, the pages are inserted from the PDF files at those directory paths.

    • If they are not, the pages are inserted from the PDF files that are embedded in the control file.

    If RICOH ProcessDirector Plug-in for Adobe Acrobat cannot find an embedded PDF file, the preview function displays a warning message and continues without inserting the pages.

  14. When you are ready to save all your enhancements to the open PDF file, including the new inserts, click Ricoh Save Control File.

    In the control file, RICOH ProcessDirector Plug-in for Adobe Acrobat embeds the PDF files that it can access.

    If the PDF files are embedded, you need not copy them to a directory accessible to a RICOH ProcessDirector server.

    Whenever you save the control file, RICOH ProcessDirector Plug-in for Adobe Acrobat tries to replace each embedded PDF file with the file at the directory path shown on the Inserts Manager list.

  15. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the pages to insert.

    When a job with inserts from other PDF files enters the BuildPDFFromDocuments step, RICOH ProcessDirector checks whether the PDF files are at the specified directory paths.

    • If they are, the pages are inserted from the PDF files at those directory paths.

    • If they are not, the pages are inserted from the PDF files that are embedded in the control file.

    If RICOH ProcessDirector cannot find an embedded PDF file, the job moves to error state. The job cannot complete the BuildPDFFromDocuments step until RICOH ProcessDirector can access all the PDF files that provide inserts or until you remove the page insertion instructions from the control file.

Example

Each document in a PDF file has from 1 to 3 pages. You want to insert page A at the end of documents with 2 pages. You want to insert page A and page B at the end of documents with 1 page.

  1. Define a rule named TotalPagesLessThan3 with 1 condition:

    Stat.TotalPagesInDocument < 3

  2. Define a page insert for page A and another page insert for page B.

  3. For each page insert:

    • Click the After documents radio button.

    • Click the Documents based on a rule radio button and select TotalPagesLessThan3.

  4. Make sure that the insert for page A is above the insert for page B on the Inserts Manager list.

If a document has 1 or 2 pages, RICOH ProcessDirector adds page A. If the document now has 2 pages, RICOH ProcessDirector adds page B after page A.

1.5.3.13 Media and finishing

You can specify media and finishing options for your sample PDF file and apply them as page exceptions to the job-level media and finishing options specified for RICOH ProcessDirector jobs.

You can apply media and finishing options to a range of pages or to the documents (page groups) within a PDF file. When applying media and finishing options to documents, you can use pre-defined rules or custom rules. For example, you can use a pre-defined rule to print the first page of each document on blue paper. You can define a custom rule so that each page with the words Premier Member in the upper right corner prints on gold paper.

Media and finishing options that you specify with RICOH ProcessDirector Plug-in for Adobe Acrobat override the options that RICOH ProcessDirector specifies for jobs.

    Note:
  • RICOH ProcessDirector Plug-in for Adobe Acrobat supports RICOH ProcessDirector media with electronic forms. The Show electronic forms preference determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use.

You can preview the PDF file as you add media and finishing options to verify that they have been applied to the intended pages.

Your media and finishing definitions are saved in the RICOH ProcessDirector Plug-in for Adobe Acrobat control file. RICOH ProcessDirector uses the control file to apply the definitions to print jobs automatically.

1.5.3.13.1 Managing media and finishing options

The Media and Finishing dialog shows information about your media and finishing options for a PDF file. You can edit and delete options, select new media and finishing options, and set the order in which RICOH ProcessDirector applies the options to a PDF file.

For each page-level media or finishing option, the Range column shows the page selection or the name of the rule that RICOH ProcessDirector Plug-in for Adobe Acrobat uses to apply the option to documents in the PDF file. The Paper substitution column shows media options, and the Subset finishing column shows finishing options.

To specify a new page-level media or finishing option, click the Add icon icon.

To work with a page-level media or finishing option, select it. Click the Edit icon icon to modify the option or the Trash can icon icon to delete it.

To revise the order in which page-level media and finishing options are applied to the PDF file, select an option. Then click the up or down arrow to move it.

RICOH ProcessDirector Plug-in for Adobe Acrobat applies the page-level options to the PDF file in the order that they appear on the list, from top to bottom. If two page-level options specify conflicting selections for the same page (for example, two different types of media), RICOH ProcessDirector Plug-in for Adobe Acrobat applies the option that is lower on the list.

For example, the first option specifies Letter Blue media for the first page of each document in the PDF file. The second option specifies Letter Gold media for the first page of each document for a Gold Club member. When the PDF file is printed, the first page of every document for a Gold Club member prints on Letter Gold media. The first page of every other document prints on Letter Blue media. If the option for Letter Blue media is below the option for Letter Gold media, the first page of every document prints on Letter Blue media. No first pages print on Letter Gold media.

Note: The order of media options does not affect how RICOH ProcessDirector Plug-in for Adobe Acrobat applies finishing options, and vice versa.

1.5.3.13.2 Selecting media and finishing options

You can select media and finishing options for specific pages in each page group by specifying a rule or typing page numbers. For example, you can specify that pages 1–4 of each page group are stapled. You can also specify that the first page of each page group prints on gold paper.
To select media and finishing options:
  1. Click Ricoh Media and Finishing and then click the Add icon icon.
  2. Select a media option on the Paper substitution list or a stapling option on the Subset finishing list.
      Note:
    • The media options are the names of RICOH ProcessDirector media objects specified in the media.zip file (or the media.xml file from an older version of RICOH ProcessDirector). For more information, see the topic about loading media objects in the help system or RICOH ProcessDirector: Installing Document Processing Features.
  3. Use the Placement Conditions section to specify the pages for the media or finishing option. Do either of these steps:
    • Select Pages based on a rule, and then select a rule from the list. The default rule is All Pages. You can also:
      • Define a new rule by clicking the Add content icon icon. See Defining a rule for more information.
      • Go to the Rules Manager by clicking the Rules Manager icon icon.
    • Select Specify pages and type the pages that you want. Media and finishing options are applied to these pages in each page group. You can:
      • Use a hyphen to separate the first and last pages in a page range.
      • Use a comma to separate page selections.
      • Type n to specify the last page in each page group.

        For example, a PDF file has two page groups. The first has four pages, and the second has seven pages. Specifying pages 3–n places markup on pages 3–4 in the first page group, and pages 3–7 in the second.

  4. Click OK.
    The option that you specified appears on the media and finishing list.
  5. If you have multiple options for paper substitution or subset finishing, select the new option. Use the up and down arrows to move it into the proper position in the ordered list of options.

    RICOH ProcessDirector Plug-in for Adobe Acrobat applies the page-level options to the PDF file in the order that they appear on the list, from top to bottom. If two page-level options specify conflicting selections for the same page (for example, two different types of media), RICOH ProcessDirector Plug-in for Adobe Acrobat applies the option that is lower on the list.

  6. To verify that RICOH ProcessDirector Plug-in for Adobe Acrobat has applied media and finishing options to the intended pages:
    1. Click Ricoh Preview.
      If a page has media and finishing options, you see an annotation labeled Print Operations in the upper right corner.
    2. To see the media name and finishing option, hover the mouse pointer over Print Operations.

      For example:

      Media = Blue LetterStapling = Top left (#1)

      (#1) indicates the sequence of the page in the finishing option. If you specify stapling for pages 5–8, page 5 is #1 and page 8 is #4.

      As an alternative, click Comment on the Adobe Acrobat toolbar. In the Comments pane, you see a comment for each page with media and finishing options.
        Note:
      • The Show electronic forms preference determines whether Preview shows how sample files look when the data is combined with electronic forms defined for the media that the files use. Set the preference to Yes to see the data combined with the forms.
  7. When you are ready to save all your enhancements to the PDF file, including the new media and finishing options, click Ricoh Save Control File.
  8. In the RICOH ProcessDirector BuildPDFFromDocuments step, specify the name and location of the control file that contains the media and finishing definitions.

1.5.4 Troubleshooting

If you encounter problems while you are working with RICOH ProcessDirector Plug-in for Adobe Acrobat, you might be able to use these topics to help solve them.

1.5.4.1 Determining the plug-in version

About information includes the version number of RICOH ProcessDirector Plug-in for Adobe Acrobat that you currently have installed.
To determine the version:
  1. Open Adobe Acrobat Professional and click Ricoh About.
  2. After viewing the information, click Close.

1.5.4.2 Page groups do not display correctly

When page groups based on repeated text do not display as you expected in the Page Group Navigator, you have not correctly selected or specified the text for the page group.

You might need to adjust the width of the box that you drew or change the text that you specified.

If you selected the Begin page group when the selected text is found option, some characters in the PDF file might include white space that you need to enclose in the box you drew.

1.5.4.3 You do not see markup on the correct pages in Preview

Preview shows markup based on the Production Intent property value in Preview Preferences.
For example, when the Production Intent property value is Simplex and the page placement is Second Front Only, Preview shows markup on the second page of each page group. When the Production Intent property value is Duplex and the page placement is Second Front Only, Preview shows markup on the third page of each page group.
If you do not see markup on the correct pages in Preview:
  1. Click Ricoh Preview Preferences.
  2. Check the setting of the Production Intent property value.

1.5.4.4 Text selections show small boxes instead of text

If you select text in a PDF file (for example, if you select text for a page group or document property) and the text you selected is represented by small boxes, your PDF file might be malformed. You cannot enhance a malformed PDF file using RICOH ProcessDirector Plug-in for Adobe Acrobat.

Two ways to determine if your PDF file is malformed are:

  • Use the Acrobat search tool to locate text that you see in the PDF file. For example, you see the words "Account Number" on the first page of the PDF file. Type those words into the Acrobat search tool and run the search. If Acrobat cannot locate the words, the PDF file could be malformed.
  • Copy text from the PDF file and paste the text into the Acrobat search field. If the text you pasted in the search field is different than the text you copied, your PDF file could be malformed.

1.5.4.5 Fonts, images, or other resources are missing

Your PDF files, for both RICOH ProcessDirector Plug-in for Adobe Acrobat and RICOH ProcessDirector, must embed all their resources, including fonts and images.

1.5.4.6 Fields in the RICOH ProcessDirector Plug-in for Adobe Acrobat cut off values

Monitors with a very high resolution and certain display settings can cause problems in the way information is displayed.
To change the way entry fields are displayed in the RICOH ProcessDirector Plug-in for Adobe Acrobat:
  1. Right-click the Desktop and select Display settings.
  2. Under Scale and layout, change the Change the size of text, apps, and other items value to 100%.
  3. Restart the computer for the change to take effect.
      Note:
    • If this change makes the fields too small to use, try changing the Resolution value.

1.5.4.7 Document properties are missing

If you do not see the Document Property option in the Go to list in the RICOH ProcessDirector viewer, check to ensure you have a step based on the IdentifyPDFDocuments step template in your workflow. That step extracts document properties from a PDF file using the control file you generated from RICOH ProcessDirector Plug-in for Adobe Acrobat.

If you do not see a specific document property, use RICOH ProcessDirector Plug-in for Adobe Acrobat, load the control file you specified in the IdentifyPDFDocuments step, and verify that you defined the specific document property. You also might not have the current RICOH ProcessDirector document properties loaded.

If you do not see any document properties in the drop-down document property lists in RICOH ProcessDirector Plug-in for Adobe Acrobat, you need to load them. Follow the steps in the help topic on loading the RICOH ProcessDirector document property list.

For more information, see RICOH ProcessDirector: Installing Document Processing Features.

1.5.4.8 Media options are missing

If you do not see RICOH ProcessDirector media objects on the Paper substitution list when you are defining media options, RICOH ProcessDirector Plug-in for Adobe Acrobat does not have a current list of RICOH ProcessDirector media objects.

RICOH ProcessDirector Plug-in for Adobe Acrobat gets media objects from a media.zip file (or a media.xml file generated by an older version of RICOH ProcessDirector). When you install RICOH ProcessDirector Plug-in for Adobe Acrobat and whenever you update media objects in RICOH ProcessDirector, load media objects to RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see RICOH ProcessDirector: Installing Document Processing Features.

1.5.4.9 A font is not on the list when you add text to a PDF file

When you add text to a PDF file, the font list should include all fonts available to Adobe Acrobat except for fonts that do not permit embedding in PDF files.
If the font list does not include a font that should be available:
  1. Make sure that the font is installed in the Windows Fonts folder or the Resource\Font folder of your Adobe installation.
  2. If the font is installed, set the logging level to warning messages:
    1. Click Ricoh Preferences.
    2. On the Logging tab, click Warn in the Logging Level section.
    If certain installed fonts are not included in the fonts list when you add text to a PDF file, RICOH ProcessDirector Plug-in for Adobe Acrobat issues a warning message with the reason. The message is saved to the log file.

1.5.4.10 Fonts with alternate letter forms do not display correctly

This version of RICOH ProcessDirector Plug-in for Adobe Acrobat does not support alternate letter forms, including ligatures, swashes, and letter forms that vary according to where they appear in a word. Right-to-left languages, such as Hebrew and Arabic, are rendered incorrectly.

When you add text to a PDF file, the drop-down list of fonts shows all fonts in the Windows Fonts folder. The list might include fonts for right-to-left languages and fonts with unsupported alternate letter forms.

1.5.4.11 QR barcode does not print Japanese data

If the data within the QR barcode should be encoded in Shift JIS (SJIS):
  1. Double-click the box you drew that defines the QR barcode.
  2. Click Settings and enter Shift_JIS in the encoding field.
    The input data is always Unicode; however, this setting translates the Unicode characters into the Shift JIS encoding for the content of the QR barcode.
Setting the encoding field to Shift_JIS or SJIS produces UTF-8 that is encoded in Shift JIS. This encoding is not interpreted correctly on DoCoMo Imode phones (common in Japan). DoCoMo Imode phones are compatible with encoding settings of: sjis, x-sjis, windows-31J, MS_Kanji, csShiftJIS, csWindows31J, windows-932, cp943c, ibm-943. These encodings might produce different QR barcodes because they have conflicting code points.

1.5.4.12 Error message tells you to check memory settings

If you are working with a large PDF source file and an error message tells you to check memory settings, you might need to increase the RICOH ProcessDirector Plug-in for Adobe Acrobat memory allocation.
To increase the memory allocation:
  1. Click Ricoh Preferences Advanced.
  2. Increase the Heap Size (MB).
  3. Restart Adobe Acrobat.

1.5.5 Accessibility

Ricoh strives to provide products with usable access for everyone, regardless of age or ability.

For more information about the commitment that we have made to accessibility, refer to the Accessibility page on the Ricoh web site.

Accessibility features

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

The major accessibility features in this product let you:

  • Use screen readers, screen magnifiers, and other assistive technologies.
  • Use a keyboard instead of a mouse.
  • Change attributes such as volume, color, contrast, and font size.
  • Distinguish keys by touch without activating them.
  • Attach alternative input and output devices such as special pointing devices and Braille displays.

In addition, the information center and the publications for the product are in an accessible format.

RICOH ProcessDirector Plug-in for Adobe Acrobat Markup Navigator shortcut keys

When a markup object that you defined has focus in the Markup Navigator, you can use these shortcut keys:

Markup Navigator shortcut keys
Description Key
Opens the Edit dialog Enter
Deletes a markup object Delete
Keyboard navigation

This product uses standard Microsoft Windows navigation keys.