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

Related information:

Inserter results files
Parsing rules files for inserter results files
Document-properties rules files for inserter results files
Job-properties rules files for inserter results files
Parent topic: Configuring the system to use inserters