Database property names for input devices
Messages about input devices might refer to properties by their database names. Some
properties are specific to Hot folder input devices; their database property names
begin with HotFolder. Others are specific to Download input devices; their database property names begin
with zOSDownload. Properties whose names begin with InputDevice apply to all types of input devices.
Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.
In the Editable column:
- Yes means that an authorized user can change the value after the input device has been created.
- No means that an authorized user cannot change the value.
Input device properties
| Database name | Notebook tab: field name | Brief description | Internal values | Editable |
|---|---|---|---|---|
| HotFolder.CodePage | General: Device code page | The code page that the input device uses to read the contents of any files that accompany the print files, such as trigger files and list files. |
|
Yes |
| HotFolder.SetPattern | Batching: Matching pattern for sets | Specifies the file name pattern that an input device uses when it creates sets. This pattern is a regular expression that indicates the portion of the input file names that must match within a set. The input files that make up a set are determined by the values for the Data patterns, JDF patterns, Overrides patterns, and File Patterns properties. | Yes | |
| InputDevice.BatchingMethod | Batching: Batching method | Specifies how the input device groups multiple input files or sets of files and submits them as a single job or parent and child jobs. You can change this value for Hot folder input devices, but not for Download input devices or for LPD input devices. |
|
Yes (HotFolder) No (Download, LPD) |
| InputDevice.Child.InitJobTypeStep | General: Child workflow initialization step | Specifies the name of the step that the input device uses to initialize the workflow for single jobs or child jobs, convert an optional overrides file submitted with a job to a text file in property name=value format for setting job properties, or both. | Yes | |
| InputDevice.Child.JobType | General: Child workflow | Specifies the name of the workflow that the input device assigns to jobs that contain only a single file or jobs that are children of a parent job. | Yes | |
| InputDevice.Child. JobType ParsingRules | Advanced: Child workflow parsing rules | Contains the path and file name of a control file. | Yes | |
| InputDevice.Child. JobTypeFilename Pattern | Advanced: Child workflow pattern | Contains a pattern-matching string that indicates what part of the file name should be used for the workflow for single and child jobs. | Yes | |
| InputDevice. ConvertOverrides | Advanced: Convert overrides | Specifies whether a control file is required to convert the overrides file submitted with a job to a job properties file in RICOH ProcessDirectorproperty name=value format. |
|
Yes (HotFolder) No (Download, LPD) |
| InputDevice.CreateZip | Batching: Create .zip file | Specifies whether the input device submits data files as individual jobs or collects them in a .zip file and submits them as a single job. |
|
Yes |
| InputDevice.Description | General: Input device description | Contains text that describes the input device. | Yes | |
| InputDevice.Enabled | Status: Enabled status | Specifies whether this input device can submit input files that it receives to create the corresponding RICOH ProcessDirector jobs. |
|
No |
| InputDevice.FileCompletion | Advanced: Completion method | Specifies how the input device determines that file transmission is complete for an input file. |
|
Yes (HotFolder) No (Download, LPD) |
| InputDevice.FileDataPatterns | Batching: Data patterns | Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify the input files that the input device should accept for processing as single jobs. | Yes (HotFolder) No (Download, LPD) | |
| InputDevice.FileJDFPatterns | Batching: JDF patterns | Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify Job Definition Format (JDF) job tickets. | Yes (HotFolder) No (Download, LPD) | |
| InputDevice.FileListPatterns | Batching: List patterns | Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify list files. | Yes (HotFolder) No (Download, LPD) | |
| InputDevice.FileOtherPatterns | Batching: Overrides patterns | Contains one or more pattern-matching strings that RICOH ProcessDirector uses to identify files that it must process with a list file and the input files that the list file specifies, or with another single input file. | Yes (HotFolder) No (Download, LPD) | |
| InputDevice. FileTrigger Patterns | Advanced: Trigger patterns | Contains one or more user-defined pattern-matching strings that RICOH ProcessDirector uses to identify trigger files. | Yes (HotFolder) No (Download, LPD) | |
| InputDevice.FolderLocation | General: Folder location | Contains the name of the directory that the input device monitors for incoming jobs. | Yes | |
| InputDevice.Frequency | Batching: Batching interval | Indicates the time interval used to submit a batch of input files. | Yes | |
| InputDevice.ID | Displayed in the property notebook title | Contains the name of the input device. | No | |
| InputDevice.InitJobTypeStep | General: Workflow initialization step | Specifies the name of the step that the input device uses to initialize the parent workflow for the input files that the input device receives, convert an optional overrides file submitted with a job to a text file in RICOH ProcessDirectorproperty name=value format for setting job properties, or both. | Yes | |
| InputDevice.Instance | General: Parent server | Specifies the name of the RICOH ProcessDirector server that receives and records messages for this input device. | Yes | |
| InputDevice.JobType | General: Workflow | Specifies the name of the workflow that the input device assigns to the job. | Yes | |
| InputDevice. JobTypeFilename Pattern | Advanced: Parent workflow pattern | Contains a pattern-matching string that indicates what part of the file name should be used for the workflow for the parent job. | Yes | |
| InputDevice. JobTypeParsing Rules | Advanced: Parent workflow parsing rules | Contains a path and file name of a control file. | Yes | |
| InputDevice.LastModified | General: Last modified | The date and time that the input device was last changed. | No | |
| InputDevice.Locations | General: Input device location | Contains the location associated with the input device. | Yes | |
| InputDevice.MaxErrors | General: Maximum errors | Contains the number of communication errors that can occur for the input device before RICOH ProcessDirector disables the input device. | Yes | |
| InputDevice.ModifiedBy | General: Modified by user | Specifies the user name of the user who made the last change to this input device. | No | |
| InputDevice.NumberOfFiles | Batching: Number of files to batch | Specifies the number of files that are combined in a single submission when you choose the Number batching method in the General tab. | Yes | |
| InputDevice.NumberOfPages | Batching: Number of pages to batch | Specifies the maximum number of PDF pages that should be combined in a single submission when you choose the Pages batching method in the General tab. | Yes | |
| InputDevice.PageThreshold | Batching: Exceed pages to batch | Specifies whether the Hot folder should include the file that exceeds the value for the Number of pages to batch property when it submits a collection of PDF files. | Yes | |
| InputDevice.PollInterval | General: Polling interval (unit) | Specifies the time interval at which RICOH ProcessDirector checks for files in the directory that the Folder location property of the Hot folder input device specified. | Yes | |
| InputDevice.ScheduleDaily | Batching: Frequency (days) | Specifies how often the input device submits a batch of input files. | Yes | |
| InputDevice.ScheduleHourly | Batching: Frequency (hours) | Specifies how often the input device submits a batch of input files. | Yes | |
| InputDevice.ScheduleMinute | Batching: Frequency (minutes) | Specifies how often the input device submits a batch of input files. | Yes | |
| InputDevice.ScheduleMonthly | Batching: Frequency (months) | Specifies how often the input device submits a batch of input files. | Yes | |
| InputDevice.ScheduleWeekly | Batching: Frequency (weeks) | Specifies how often the input device submits a batch of input files. | Yes | |
| InputDevice.StagingLocation | General: Staging location | Contains the name of the directory into which the input device moves the input file before submitting it as a job. | Yes | |
| InputDevice.StartDate | Batching: Batching start date | Specifies the date when the Time batching method takes effect for the input device. | Yes | |
| InputDevice.StartDateAndTime | Batching: Batching start date and time | Specifies the date and time when the Time or Sets by time batching method takes effect for the input device. | Yes | |
| InputDevice.Status | Status: Connection status | Lists the current status of the input device: connected, disconnected, or unable to connect. |
|
No |
| InputDevice.SubmitStep | General: Submit step | Contains the name of the submit step to which the input device sends the input file for job processing. | Yes | |
| InputDevice.WaitingFileCount | Status: Input files waiting | Contains the number of input files that the input device has received but has not yet submitted to create the corresponding RICOH ProcessDirector jobs. | No | |
| InputFilePattern.FilePattern | Batching: File Pattern | Specifies one or more file pattern-matching strings. | Yes | |
| InputFilePattern.Required | Batching: File pattern required | Specifies whether a file that matches the input file pattern must exist in the Hot folder before submitting the job. |
|
Yes |
| InputFilePattern.Sequence | Batching: File pattern sequence | Specifies the priority of the file pattern. Patterns are checked in this order. | Yes | |
| InputFilePattern.SpoolFileType | Batching: Spool file type | Specifies the content or the data stream type of the file. | Yes | |
| InputFilePattern.SpoolFileUsage | Batching: Spool file usage | Specifies the purpose or role of the file within the job. | Yes | |
| LPD.Codepage | General: Device code page | Specifies the code page that the LPD input device uses to read the contents of any files that accompany the print files, such as control files and list files. |
|
Yes |