Header rules files for inserter control files

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)

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.

Format

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

JobID,character,8,[expr=Job.Inserter.JobID]RunID,character,15,[expr="           TEST"]

10000034           TEST