Maximizing the performance of document properties files

To maximize the performance of document properties files, you edit the document properties template file. The template file determines which properties go into the document properties file for a job. The template file lets you control the number of document properties to be used, as well as the order of the columns in the document properties file. If you need to maximize performance on your system by assigning only a subset of document properties, make sure that any properties needed by your workflow steps are listed in the document properties template file.
The document properties template file contains the database names of document properties. Steps based on the ReadDocumentsFromDatabase step template use the content of the document properties template file to create the document properties file.

Using a document properties template file is optional, but recommended if you need to maximize performance. If you do not use it, all document properties are included in the generated document properties file.

The document properties template file must include all the properties needed by steps that process the document properties file. In addition, the document properties template file must include certain properties, depending on the step that is using the template file. These properties are required by CreateAFPJobsFromDocuments, BuildAFPFromDocuments, and BuildPDFFromDocuments:

  • Doc.ChildJobID (*)
  • Doc.OriginalJobID (*)
  • Doc.OriginalSequence (*)
  • Doc.SequenceInChild (*)
  • Doc.OriginalSheets
  • Doc.DataOffset (for AFP jobs only)
  • Doc.DataLen (for AFP jobs only)

You do not need to define the Doc.ID property or the properties marked with an asterisk (*) in the document property template; the system automatically includes them in the document properties file. Steps based on the WriteDocumentsToDatabase step template define Doc.ID; IdentifyDocuments and IdentifyPDFDocuments define the others.

If you have the Inserter feature and you edit the sample document properties template file, include these Inserter document properties in the template if they are relevant to your workflow:

  • Doc.Insert.BinTriggers
  • Doc.Insert.DivertBin
  • Doc.Insert.RecipientName
  • Doc.Insert.OriginalBarCode

You can use more than one document properties template file in one RICOH ProcessDirector system.

To edit a document properties template file:

  1. The sample document properties template file named docPropTemplate.txt is in the /path/extensions/doc/samples directory. For example, on Linux, the path is /opt/infoprint/ippd. On Windows, the path is C:\Program Files\Ricoh\ProcessDirector. Copy the sample file to the location where you want to store it. You specify the path to this file in the ReadDocumentsFromDatabase step.
  2. Edit the file to contain the properties that you want to use for step processing by a specific workflow.
    Keep these tips in mind:
    • Add the custom document properties that are important for the job. For example, if the workflow will sort the documents in postal code order, make sure the Postal Code document property is included in the template file.
    • Include only the necessary properties. Limiting the number of properties improves performance and reduces the amount of storage space needed to store the document property data.
    • You can include all entries on a single line with a space or a tab character between each property, or you can place each entry on a separate line.
    • You can include job properties in the document properties template file.
  3. Optional: Create additional document properties template files.
    For example, if you copy the PrintDocuments workflow multiple times and want to manipulate a different set of document properties for each of the new workflows, create a document properties template file for each new workflow.

Related information:

Document properties file
Document properties template file
Parent topic: Configuring document processing features