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. This format is the DB2 DEL output format.

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 for several inserter manufacturers that you can modify for your installation. When you create an inserter controller object, you specify which rules files to use.

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

 
Copyright © 2006, 2018