Document-properties rules files for inserter results files
The document-properties rules file specifies how to map values in the inserter results file to RICOH ProcessDirector document-property values.
Purpose
RICOH ProcessDirector uses the document-properties rules file to set values of RICOH ProcessDirector document properties. It uses the document-properties rules file together with the parsing rules file that defines each field in the results file.
RICOH ProcessDirector provides sample document-properties rules files in theinserter directory:
-
/aiw/aiw1/samples/control_files/inserteron Linux -
C:\aiw\aiw1\samples\control_files\inserteron Windows
| Inserter manufacturer | Document-properties rules |
|---|---|
| Bowe | BOWE.icf_results.process.doc.dsc |
| Bowe Bell & Howell | BBH.icf_results.process.doc.dsc |
| Bowe Bell & Howell with JetVision camera systems | JET.icf_results.process.doc.dsc |
| Gunther | GUN.icf_results.process.doc.dsc |
| Inserters with Ironsides camera systems | IRON.icf_results.process.doc.dsc |
| Kern | KERN.icf_results.process.doc.dsc |
| Pitney Bowes | PB.icf_results.process.doc.dsc |
| Quadient | quadient.jrf_results.outputfile.dsc |
RICOH ProcessDirector document properties set in rules files lists some of the document properties that you might want to set in the document-properties rules file. The rules files must set the value of document properties that are marked Required.
RICOH ProcessDirector document properties set in rules files
| Property (field name) | Property (database name) | Required | Description | Type | Length (characters) |
|---|---|---|---|---|---|
| Insert sequence | Doc.Insert.Sequence | One of these is required for job-specific results files:
|
The numeric position of the document in the job. The value must match the value that RICOH ProcessDirector assigned to the document. | integer | 8 |
| Document number | Doc.ID | Required if the inserter results files is not job-specific (such as Gunther results files) | The document number. The value must match the value that RICOH ProcessDirector assigned to the document. | bigint | 16 |
| Status | Doc.Insert.Status | Yes | The insert status of the document. Allowed values:
Note: If the rules file does not set a value for this property, RICOH ProcessDirector sets it to the value of the Default insert status property of the inserter controller.
|
character | 16 |
| Action | Doc.Insert.Disposition | Required if the inserter results files is not job-specific (such as Gunther results files) | The action that RICOH ProcessDirector takes during automatic reconciliation and the default action for manual reconciliation.
Allowed values:
Note: If the inserter results file is job-specific, do not set this property because RICOH ProcessDirector sets it.
|
character | 16 |
| Status code | Doc.Inserter.StatusCode | No | The status code for the document. | character | 16 |
| Extended status code | Doc.Inserter.StatusCodeExtended | No | The extended status code for the document. | character | 128 |
| Insert date and time | Doc.Insert.TimeStamp | No | The date and time that the inserter processed the document. | character | 15 |
| Inserter name | Doc.Insert.InserterID | No | The name of the inserter that processed the document. | character | 64 |
| Bin results | Doc.Insert.BinResults | No | The inserter bins that delivered inserts for this document. Y or 1 in a bin position can mean that the bin delivered an insert. N or 0 can mean that the bin did not deliver an insert. | character | 64 |
| Operator name | Doc.Insert.OperatorID | No | The name or user ID of the operator who was logged in to the inserter when this document was processed. | character | 64 |
Format
Comment lines start with a pound sign (#).
The first non-comment line is optional. It identifies which records in the results file contain information. The first line has this format:
[expr=content_language_expression]
For example, if the first line of the results file is a header and you want to ignore it, use this expression:
[expr=recnum>1]
If all records in the results files contain information, omit this line.
Each subsequent line in the rules file sets a document property. Each line has this format:
property_name,property_type,property_length,[expr=content_language_expression]
- property_name
- Specifies the database name of the RICOH ProcessDirector document property.
- property_type
- Specifies the type of data in the property value. Allowed values: character, varchar, integer, bigint.
- property_length
- Specifies the number of characters that the property allows in the value.
- [expr=content_language_expression]
- Specifies an expression in the RICOH ProcessDirector Content Expression Language (CEL). The expression is evaluated and the result becomes the value of the document property. In the expression, you can specify a fixed value, or you can specify the value of a field in the results file. The parsing rules file defines the fields in the results file. You can also use CEL functions. For information about the CEL language and functions, see the related Reference topic.
Examples
This example specifies that the records in the results file that contain document information have RecordType=5 and SubRecordType=0. The RecordType and SubRecordType fields must be defined in the parsing rules file.[expr=and(RecordType=="5",SubRecordType=="0")]This example sets the Doc.Insert.Sequence property value equal to the value of the
PieceID field in the results file. The parsing rules file must define the PieceID field.
Doc.Insert.Sequence,integer,8,[expr=PieceID]This example sets the value of the Doc.Insert.Status property based on the value of
the Disposition field in the inserter results file. The parsing rules file must define the Disposition field.
- If Disposition is 0, 1, or 6, Doc.Insert.Status is null.
- If Disposition is 2, 3, 4, or 7, Doc.InsertStatus is Damaged.
- If Disposistion is 5 or 8, Doc.Insert.Status is OK.
- If Disposition is 9, Doc.InsertStatus is Pulled.
- If the Disposition is another value, Doc.Insert.Status is Damaged.
Doc.Insert.Status,character,16,[expr=if(or(Disposition==0,Disposition==1,Disposition==6),"",if(or(Disposition==2,Disposition==3,Disposition==4,Disposition==7),"Damaged",if(or(Disposition==5,Disposition==8),"OK",if(Disposition==9,"Pulled","Damaged"))))]