Preferences file

Specifies the full path or symbolic name of the preferences file that the ApplyPreferences step uses to add or change property values in the document properties file (DPF) for each document in the job. The step uses a property mapping object to interpret the contents of the preferences file. You can also select a step resource object as the value for the property instead of providing a path and filename. Using a step resource lets you change the specific file without editing all of the workflows that contain the step that uses the file.

Format:

Length
Up to 255 characters (bytes)
Restrictions
Case-sensitive

Database name
Job.Pref.ExternalFile

Usage notes:

  • If you submit the preferences file with the job using the List batching method, the UsageKeyword and DatatypeKeyword in the symbolic name must match the name and extension of the preferences file. For example, the preferences file is pref.csv, and you use the getFileName method. The symbolic name of the preferences file must be ${getFileName(pref,csv,read)}.

  • If you submit the preferences file with the job using the Pattern batching method, the UsageKeyword and DatatypeKeyword in the symbolic name must match the values of the Spool file usage and Spool file type properties for the preferences file on the Batching tab. For example, the value of the Spool file usage property is pref, the value of the Spool file type property is csv, and you use the getFileName method. The symbolic name of the preferences file must be ${getFileName(pref,csv,read)}.

Parent topic: Field help