docCustomDefinitions.properties file

The document properties names file (docCustomDefinitions.properties) defines user interface information for custom document properties. The entries in the docCustomDefinitions.properties file correspond to the docProperty elements in the docCustomDefinitions.xml file.
    Note:
  • If you change the docCustomDefinitions.properties file or any docCustomDefinitions_language.properties files after installing the feature:
    • Run the docCustom utility and install or upgrade the Custom Document Properties feature.
    • For PDF document processing features, load the document properties to RICOH ProcessDirector Plug-in for Adobe Acrobat. For more information, see RICOH ProcessDirector: Installing Document Processing Features.
    • For AFP document processing features, access RICOH Visual Workbench from the RICOH ProcessDirector user interface. New document properties are loaded to RICOH Visual Workbench when it opens on your workstation.

The entries in the docCustomDefinitions.properties file are used in the RICOH ProcessDirector user interface when you select custom document properties from lists, or when you view field help for a custom document property. A sample file is in the /samples directory on the feature CD, and the installation process places a sample file in /aiw/aiw1/samples/config on Linux, and in C:\aiw\aiw1\samples\config on Windows.

Create a separate docCustomDefinitions_language.properties file for each additional language that you want to support, using a language identifier in each file name. For example:

  • docCustomDefinitions_de.properties (German)
  • docCustomDefinitions_en.properties (English)
  • docCustomDefinitions_es.properties (Spanish)
  • docCustomDefinitions_fr.properties (French)
  • docCustomDefinitions_it.properties (Italian)
  • docCustomDefinitions_ja.properties (Japanese)
  • docCustomDefinitions_pt.properties (Brazilian Portuguese)

You create a stanza of caption and description values for every document property.

[property]
The full property name.
[property].Description
A description of the property. Use HTML tags if you want to format the text. This content appears in the field help when the user clicks the ? button.

For example: 

Doc.Custom.Zip=ZIP code
Doc.Custom.Zip.Description=The ZIP code of an address

    Note:
  • Do not rename the default docCustomDefinitions.properties file; a file with this name must exist in your configuration directory (/aiw/aiw1/config). Copy the file and name the copy with the appropriate language identifier as needed.
  • The docCustomDefinitions.properties file and any docCustomDefinitions_language.properties files must use the ISO-8859-1 character encoding (code page). If you create your docCustomDefinitions.properties files in a different format (such as Shift JIS or UTF-8), you must convert the file to ISO-8859-1 when placing it in the /aiw/aiw1/config directory.

Related information:

Updating custom document properties
Naming custom document properties in more than one language
Parent topic: Control files for document processing features