Creating rules for inserter control files
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 |
- Log in to the primary computer as the RICOH ProcessDirector system user (aiw1 is the default).
- Navigate to the
inserter
directory:/aiw/aiw1/samples/control_files/inserter
(Linux)C:\aiw\aiw1\samples\control_files\inserter
(Windows)
- 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
-
-
- 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.
- Save the files. You can keep the same file names or change them. The file name extension
must be
.dsc
.
- Rules file
- Header rules file