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 (AIX and Linux)
  • C:\aiw\aiw1\samples\control_files\inserter (Windows)

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
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 (AIX and 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 AIX and 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
 
Copyright © 2006, 2015