Field help
The field help displays when you click the ? button next to a field in the user interface.
In this section:
- Apply any or all of the following conditionsSpecifies whether a job must meet all of the conditions specified by a rule or any one of the conditions.
- SummaryThe Summary field shows your selections in the Conditions area in a database query format. The value changes as you modify conditions.
- ConditionsLets you define one or more conditions for a rule. Each condition consists of a job property, a comparison, and a value.
- Order of executionWhen multiple connectors exit a single step, RICOH ProcessDirector must determine which connector the job should follow to the next step. This value indicates which connector RICOH ProcessDirector should evaluate first, second, third, and so on, when it tries to choose which connector the job should use.
- Rule nameSpecifies the name of the rule that is assigned to the connector. You can define a new rule for the connector by typing a name.
- Group actionsThe actions that members of the user group can do.
- Action permissionsLists the available object types and the actions for each object type and lets you change the access level for each action for this group.
- Group propertiesThe properties that members of the user group can view or edit.
- Properties permissionsLists the available object types and properties of each object type and lets you change the access level for each property for this group.
- Group created bySpecifies the ID of the RICOH ProcessDirector feature that created the group. This property has no value if a user created the group, and the group did not result from the action of a feature.
- Group descriptionDescribes the user group. For example, the description might include the level of security authority for the group.
- Group nameSpecifies the name of the user group.
- Last modifiedThe date and time that the group changed. RICOH ProcessDirector updates the value whenever the user group changes. You cannot change the value of this property.
- Modified by userSpecifies the user name of the user who made the last change to this user group. RICOH ProcessDirector maintains the value of this property, and updates the value whenever the user group occur changes. You cannot change the value of this property.
- Group source IDSpecifies the group supplied by RICOH ProcessDirector that was used as a base for this group. This group might have been copied either directly from the source group or from another copy of the source group. You cannot change the value of this property.
- Device code pageSpecifies the code page that the Hot folder input device uses to read the contents of any files that accompany the print files, such as trigger files and list files. The input device converts those accompanying files into UTF-8 format; it does not convert print files to UTF-8. The Device code page value should match the code page that was used to create the accompanying files.
- Matching pattern for setsSpecifies 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.
- Batching methodSpecifies 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 or SFTP input devices, but not for Download input devices, LPD input devices, or REST or SOAP web services input devices. Download input devices use the JCL batching method and LPD input devices use the List batching method.
- Child workflow initialization stepSpecifies 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.
- Child workflowSpecifies 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. The primary purpose of the child workflow is to define the phases and steps that RICOH ProcessDirector uses to process the child job.
- Child workflow patternSpecifies a pattern-matching string that consists of a regular expression and can include (JOB_TYPE) to specify what part of the file name should be used for the workflow for a single job or a child job. A pattern-matching string is used only if the Child workflow initialization step property is set to SetJobTypeFromFileName.
- Child workflow parsing rulesSpecifies the path and file name of a control file that parses parameters accompanying an input file. For example, RICOH ProcessDirector can use a control file to parse JCL parameters and values to assign the workflow to a single job or a child job. A control file is used only if the Child workflow initialization step property is set to SetJobTypeFromRules or SetJobTypeFromFileName.
- Auto ConnectSpecifies whether the computer connects the input device when its server is connected.
- Convert overridesSpecifies whether the SetJobTypeFromRules or SetJobTypeFromFileName step converts an optional overrides file submitted with a job to a text file in RICOH ProcessDirector property name=value format that can be used to set job properties.
- Create .zip fileSpecifies whether the input device submits data files as individual jobs or collects them in a .zip file and submits them as a single job.
- Input device descriptionDescribes the input device. For example, it might describe the type of jobs that are sent to the device.
- Enabled statusSpecifies whether this input device can submit input files that it receives to create the corresponding RICOH ProcessDirector jobs.
- Completion methodSpecifies how the input device determines that file transmission is complete for an input file. You can change this value for Hot folder input devices, but not for Download input devices or for LPD input devices.
- Data patternsSpecifies one or more pattern-matching strings. RICOH ProcessDirector uses these strings to identify the input files that this input device should accept for processing as single jobs. The value uses regular expression syntax and characters in the value are case-sensitive. For example, .*PRD$,.*PDF$ represent patterns that are different from .*prd$,.*pdf$. Separate multiple patterns by commas; do not type a space between them.
- JDF patternsSpecifies one or more pattern-matching strings that RICOH ProcessDirector uses to identify Job Definition Format (JDF) job tickets. RICOH ProcessDirector processes the JDF print files as a group. The value uses regular expression syntax and characters in the value are case-sensitive. For example, .*\.JDF$ represents patterns that are different from .*\.jdf$. Separate multiple patterns by commas; do not type a space between them.
- List patternsSpecifies one or more pattern-matching strings that RICOH ProcessDirector uses to identify list files. List files contain the names of input files that RICOH ProcessDirector processes as a group. The value uses regular expression syntax and characters in the value are case-sensitive. For example, .*LST$,.*LIST$ represent patterns that are different from .*lst$,.*list$. Separate multiple patterns by commas; do not type a space between them.
- Overrides patternsSpecifies one or more pattern-matching strings. RICOH ProcessDirector uses the strings to identify files that it must process in conjunction with a list file and the input files that the list file specifies or with another single input file.
- Trigger patternsSpecifies one or more pattern-matching strings that RICOH ProcessDirector uses to identify trigger files. A trigger file indicates that the associated input file has been completely transmitted. The trigger file and the input file have the same name, but they have different extensions. For example, using the default trigger pattern matching string for input devices, an input file named
STMT406.pdf
would have an associated trigger file namedSTMT406.trg
. The value uses regular expression syntax and characters in the value are case-sensitive. Separate multiple patterns by commas; do not type a space between them. - Folder locationSpecifies the name of the directory that this input device monitors for incoming jobs. Authorized users can select any directory on the computer that is not in use as a folder location or staging location by another RICOH ProcessDirector input device. You can also specify a new directory.
- Batching intervalSpecifies the time interval used to submit a batch of input files.
- Input device nameSpecifies the name of the input device.
- Workflow initialization stepSpecifies 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 ProcessDirector property name=value format for setting job properties, or both.
- Parent serverSpecifies the name of the RICOH ProcessDirector server that receives and records messages for this input device. The default value for the parent is System, which is the name of the primary server that the RICOH ProcessDirector installation program creates. In addition to the primary server, the list contains Linux or AIX secondary servers that have connected to the primary server. You cannot create input devices on Windows application servers.
- WorkflowSpecifies the name of the workflow that the input device assigns to the job. The primary purpose of the workflow is to define the phases and steps that RICOH ProcessDirector uses to process the parent job.
- Parent workflow patternSpecifies a pattern-matching string that consists of a regular expression and can include (JOB_TYPE) to indicate what part of the file name should be used for the workflow for the parent job. A pattern-matching string is used only if the Workflow initialization step property is set to SetJobTypeFromFileName.
- Parent workflow parsing rulesSpecifies the path and file name of a control file that parses parameters accompanying an input file. For example, RICOH ProcessDirector can use a control file to parse JCL parameters and values to assign the workflow to a parent job. A control file is used only if the Workflow initialization step property is set to SetJobTypeFromRules or SetJobTypeFromFileName.
- Last modifiedThe date and time that the input device was last changed. RICOH ProcessDirector updates the value whenever the input device changes. You cannot change the value of this property.
- Input device locationSpecifies the location associated with the input device.
- Maximum errorsSpecifies the number of communication errors that can occur for the input device before RICOH ProcessDirector disconnects the input device. Disconnecting the input device prevents it from acknowledging and processing any new input files.
- Modified by userSpecifies the user name of the user who made the last change to this input device. RICOH ProcessDirector maintains the value of this property, and updates the value whenever the input device changes. You cannot change the value of this property.
- Number of files to batchSpecifies the number of files that should be combined in a single submission using the Number or Number of sets batching method.
- Number of pages to batchSpecifies the maximum number of PDF pages that should be combined in a single submission using the Pages or Pages in sets batching method. The hot folder maintains a count of how many PDF pages have arrived since the last batch was submitted. When the number meets or exceeds this value, a batch is submitted and the page count is reset.
- Exceed pages to batchSpecifies whether the hot folder should submit a collection of PDF files whose total pages exceed the value set for the Number of pages to batch property.
- Polling intervalFor hot folder input devices, specifies the time interval at which RICOH ProcessDirector checks for files in the directory that the Folder location property specified.
- Workflow to useSpecifies what workflow to resubmit one or more input files to.
- Frequency (days)Specifies how often the input device submits a batch of input files. The schedule repeats until you update the properties of the input device.
- Frequency (hours)Specifies how often the input device submits a batch of input files. The schedule repeats until you update the properties of the input device.
- Frequency (minutes)Specifies how often the input device submits a batch of input files. The schedule repeats until you update the properties of the input device.
- Frequency (months)Specifies how often the input device submits a batch of input files. The schedule repeats until you update the properties of the input device.
- Frequency (weeks)Specifies how often the input device submits a batch of input files. The schedule repeats until you update the properties of the input device.
- Input device source IDSpecifies the ID of the source input device.
- Staging locationSpecifies the name of the directory where the input device moves the input file before submitting it as a job. Authorized users can specify any directory on the computer that is not in use as a folder location or staging location by another RICOH ProcessDirector input device. You can also specify a new directory.
- Batching start dateSpecifies the date when the Time or Sets by time batching method takes effect for the input device. Use this property with the Batching start time property to delay batching.
- Batching start date and timeSpecifies the date and time when the Time or Sets by time batching method takes effect for the input device.
- Connection statusSpecifies the current status of the input device.
- Submit stepSpecifies the name of the submit step to which the input device sends the input file for job processing. The submit step creates the actual RICOH ProcessDirector job from the input file.
- SystemShows the name of the system where the input device is defined.
- Input files waitingSpecifies the number of input files that the input device has received, and that it has processed and placed in the directory that the Staging location property specifies. The number does not include input files in the Processing state or any List files that RICOH ProcessDirector creates.
- Input deviceSpecifies the name of the input device that received the input file. The input device then creates the corresponding RICOH ProcessDirector job from the input file.
- Assigned job numberSpecifies the job identification number that RICOH ProcessDirector assigns when the input device submits the input file for job processing. After submission, RICOH ProcessDirector creates a corresponding job, and the Job number property for the job contains the same value as this input file property.
- WorkflowSpecifies the name of the workflow that the input device assigns to the input file when it submits the file for job processing. The property might not have a value depending on whether the input device has an assigned workflow. You can use methods other than assigning a workflow to an input device to assign job properties to a job. Use either the Resubmit action or the Process Again action to change the workflow for the input file.
- Input fileSpecifies the path to and the name of the input file. RICOH ProcessDirector appends the date the input file was received and a unique number after the input file name.
- Input file statusSpecifies the current status of the input file.
- Submit groupSpecifies a numeric ID that identifies a member of a set of input files that were submitted as a group through a list file. The list file might have been created by a user or RICOH ProcessDirector might have created the list file. Each file in the group has the same value for its Submit group property.
- Time receivedSpecifies the date and time at which the input file arrived at the input device.
- File patternSpecifies one or more file pattern-matching strings. RICOH ProcessDirector uses these strings to identify the input files that this Hot folder should accept for processing as single jobs. The value uses regular expression syntax and characters in the value are case-sensitive. For example, .*PRD$,.*PDF$ represent patterns that are different from .*prd$,.*pdf$ . Separate multiple patterns by commas; do not type a space between them.
- File pattern requiredSpecifies whether a file that matches the input file pattern must exist in the Hot folder before submitting the job.
- File pattern sequenceSpecifies the priority of the file pattern. Patterns are checked in this order.
- Spool file typeSpecifies the content or the data stream type of the file.
- Spool file usageSpecifies the purpose or role of the file within the job.
- BinSpecifies the bin number of the input tray.
- Input tray enabled statusSpecifies whether the input tray is available.
- Input tray nameSpecifies the name of the input tray.
- LevelSpecifies the level of the input tray.
- MediaMedia loaded in the input tray.
- Server descriptionDescribes the RICOH ProcessDirector server. For example, the description might indicate the function of the server.
- Enabled statusSpecifies whether a server is available.
- Server nameSpecifies the name of the server.
- In general server poolSpecifies whether a secondary server is a general-usage server or a restricted-usage server.
- Computer IP address or host nameSpecifies either the network IP address or the fully qualified host name of the computer. For application or secondary servers, this is the IP address or host name of the computer they are installed on.
- Server name for local computerSpecifies the name the remote system uses to identify the primary server on this system (local system).
- Last modifiedThe date and time that the server was last changed. RICOH ProcessDirector updates the value whenever the server changes. You cannot change the value of this property.
- Maximum resource-intensive step countSpecifies how many resource-intensive steps the application or secondary server allows to run concurrently.
- Maximum step count for other stepsSpecifies how many non-resource-intensive steps the application or secondary server allows to run concurrently.
- Modified by userSpecifies the user name of the user who made the last change to this server. RICOH ProcessDirector maintains the value of this property, and updates the value whenever the server changes. You cannot change the value of this property.
- Operating systemShows the type of operating system installed on the computer.
- Connection statusShows the status of the server.
- SystemShows the name of the system where the server is located. When you add a server, you can specify any value. RICOH ProcessDirector updates this property with the system name that the remote system reports the first time that RICOH ProcessDirector connects to this system.
- Server typeSpecifies the type of the RICOH ProcessDirector server.
- Add blank pageSpecifies whether the step should add a blank page to the end of any PDF file within the zip file that has an odd number of pages when it builds the larger PDF file.
- Values to setIdentifies the properties and values that the step sets.
- BindingSet the binding settings for the job you are printing.
- CollateSpecifies the type of collation that the printer uses when printing multiple copies of the job.
- Compress file patternsSpecifies one or more pattern-matching strings. RICOH ProcessDirector uses these strings to identify the files in the job spool directory that the CompressFiles step compresses.
- Compress all filesSpecifies whether all spool and checkpoint files should be compressed when the job reaches the Retained state.
- Job copies requestedSpecifies the number of job copies that RICOH ProcessDirector prints.
- CopiesSpecifies whether to update the number of copies for each or all selected jobs.
- Job copies stackedIf the job is printing on an AFP or Ricoh PDF printer, this property specifies the current number of job copies that have completed printing, and that have reached the output stacker. Whenever the printer reports that another copy in a multi-copy job has printed and stacked, the value is updated.
- Current daySpecifies the current day of the week of the server RICOH ProcessDirector is running on when a condition requesting it is evaluated.
- Assigned printerShows the name of the printer that RICOH ProcessDirector has assigned to print this job. You cannot change the value of this property. To schedule a job to a specific printer, set the Requested printer property on either the Schedule Job page or in the Job properties notebook.
- Current timeSpecifies the current time of the server that RICOH ProcessDirector is running on when a condition requesting it is evaluated.
- Customer nameSpecifies the customer who is associated with this job. RICOH ProcessDirector uses the customer-name value to schedule the job to a printer that has the same customer-name value assigned to its Customer name property.
- Job descriptionDescribes the job. For example, it might describe any special handling requirements for the job.
- DuplexFor jobs sent to some types of printers, specifies whether duplexed printing is active for the job and, if so, the type of duplexed printing. Duplexed jobs print on both sides of the paper.
- External program code pageSpecifies the code page to use to write the contents of the files that are sent to the external command for processing, such as the control file template. This code page is also used to read messages that the external command writes to stderr and stdout, as well as other files that the external command might create.
- External commandSpecifies a command string that a step can execute during processing.
- External control file templateSpecifies the path and name of the control file template that the external command uses.
- External program languageSpecifies what language the external command should use when it returns messages to RICOH ProcessDirector.
- Valid return codesLists return code values that the external command can issue, that indicate that the command ran successfully. You can specify multiple return code values by separating the values with commas. For example 0,4.
- Job arrival timeSpecifies the actual date and time when the last input file for the job arrived in the system.
- Fold optionsSpecifies how to fold the job or large sheets in the job, whether to fold all the sheets together (overlap or collate), and whether the front side of the sheet ends up on the outside rather than the inside of the fold.
- Job hold pendingSpecifies whether RICOH ProcessDirector holds the job after it completes the processing that the current step does. The Job step property identifies the current step. Operators can specify this value.
- Application log fileThe directory where the external program stores its log files.
- Clean up retrieval folderSpecifies whether the RunHotFolderApplication step deletes any file whose file name matches the Retrieval pattern from the retrieval folder before it submits the File to send.
- File to sendNames the file that RICOH ProcessDirector puts in the sending folder to submit to the external program. 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.
- File size verification countThe number of times that RICOH ProcessDirector polls the retrieval folder and finds that the size of the retrieved file has not changed before deciding that the retrieved file is complete.
- Poll intervalThe time between two consecutive polls of the retrieval folder. The unit of time for the value can be seconds, minutes, or hours.
- Retrieval folderNames the output hot folder for the external program. RICOH ProcessDirector looks in the retrieval folder for the retrieved file using the retrieval pattern.
- Retrieval patternThe pattern-matching string that RICOH ProcessDirector uses to identify a returned job in the retrieval folder. The value uses regular expression syntax and characters in the value are case-sensitive. For example, .*CMD$,.*XLS$ represent patterns that are different from .*cmd$,.*xls$. Separate multiple patterns by commas; do not type a space between them.
- Retrieved fileThe name to use to rename the retrieved file.
- Sending folderNames the hot folder where RICOH ProcessDirector puts the job file to send to the external program.
- Timeout intervalThe time in minutes before a job goes into an error state if the retrieved file is not found or not complete.
- Job numberShows a unique number that identifies the job on the system. The format of the number depends on whether the job is a parent job or a job that has no child jobs, or if the job is a child job. For example, a child job contains a decimal point such as 1000023.100. RICOH ProcessDirector assigns the value of this property when the input device submits the input file for job processing. You cannot change the value.
- Prevent media substitutionIndicates that media should not be substituted for the job. Use this option to override the defined media substitution rules for jobs that must be printed on specific paper.
- Input data streamSpecifies the format of data that the input file for this job contains. RICOH ProcessDirector can try to set the value of this property automatically if the workflow for the job includes the DetectInputDataStream step. The detection process includes analyzing the beginning content of the input file. You can update this value using the Process again action.
- Input file nameShows the name of the original input file from which RICOH ProcessDirector created the job. The format of the input-file name for the job depends on the job-submission method and other factors, such as whether the input file is a member of a group of files. You cannot change the name after the input device receives the input file.
- Input file size (bytes)Shows the size of the original input file that RICOH ProcessDirector used to create the job. You cannot change the value of this property.
- Parent serverShows the name of the RICOH ProcessDirector server that owns the submit step for the input file. The submit step creates the RICOH ProcessDirector job from the input file; see the Submit step property for the input device that submitted the job. You cannot change the value of this property.
- Job size (sheets)Shows a calculated value that RICOH ProcessDirector uses when it schedules jobs to printers. RICOH ProcessDirector calculates the value of this property by multiplying the value of the Job copies requested job property by the value of the Current total sheets job property. RICOH ProcessDirector can schedule the job to a printer whose Printer job size (sheets) supported printer property specifies a value that is appropriate for the calculated size of the job.
- WorkflowShows the name of the workflow that defines the processing phases and steps for the job. Authorized users define workflows through the RICOH ProcessDirector administration interface. Then, they can use a variety of methods, such as assigning the workflow to an input device, to assign a workflow to a job. You cannot change the workflow value for the job directly. Use the Process Again action if there is a need to change the workflow for a job that is already on the RICOH ProcessDirector system.
- Workflow historyShows a list of workflows that have been used to process the job and that define processing phases and steps where you can restart the job with the Process Again action. You cannot edit this value.
- Requested locationSpecifies the name of the requested job location. RICOH ProcessDirector uses this value to schedule the job to a printer that has the same value for its Printer location property. Requested location can be set by a workflow, or it can be set in the property notebook for the job.
- MediaSpecifies the primary media for the job. The value can come from the job, job ticket, or workflow.
- Media requiredShows the names of the media objects specified for the entire job, including any page exceptions.
- Media substitutedShows whether media was substituted for the job based on the substitution rules specified on the Media settings page. You cannot change the value of this property.
- Job nameSpecifies the name of the job. The user who submitted the job might have specified the name, or the host system that submitted the job might have assigned the name. RICOH ProcessDirector does not require the job name to be unique on the system; the Job number property contains the unique system identifier, or spool ID, that RICOH ProcessDirector uses to identify the job. RICOH ProcessDirector initially supplies the value of this property when it creates the job from the input file.
- Output binSpecifies the output bin for the job. RICOH ProcessDirector uses this value to schedule the job to a printer that supports the selected output bin.
- Transform page lengthSpecifies the length of the image that the data transform program generates. The unit of measure for the value can be either inches or millimeters. Authorized users can specify a value from 1 through 999.99. Use the toggle control to the right of the property name to select the unit of measure for the property value. RICOH ProcessDirector initially sets the unit of measure by using the locale setting of the browser.
- Pages to print againSpecifies which pages in the current job are printed again.
- Pages stackedShows the number of logical pages that have printed, and that have reached the output stacker of the AFP or Ricoh PDF printer device. The AFP or Ricoh PDF printer reports this information to RICOH ProcessDirector. Passthrough printers set this property equal to the Total pages property if a valid return code is reported from the printer command. PCLOut printers set this property equal to the number of pages converted to PCL. Otherwise, no value is set for this property. You cannot change the value of this property.
- Transform page widthShows the width of the image that the data transform program generates. The unit of measure for the value be either inches or millimeters. Authorized users can specify a value from 1 through 999.99. Use the toggle control to the right of the property name to select the unit of measure for the property value. RICOH ProcessDirector initially sets the unit of measure by using the locale setting of the browser.
- Current phaseShows the name of the workflow phase that is currently processing the job.
- Progress within the current phaseShows the progress status for the job within the phase that the Current phase property identifies. RICOH ProcessDirector updates the value of this property whenever the job progress within the phase changes. You cannot change the value of this property.
- Accepted byShows the user ID of the user who accepted the preview print.
- Accept preview print automaticallySpecifies whether RICOH ProcessDirector accepts the preview print automatically and moves the job to the next step in the workflow.
- Page range for preview printShows a numeric string that describes which pages in the job are printed as samples in the PreviewPrint step.
- Requested printer for preview printSpecifies the name of the printer that this step sends the preview print job to. The preview print job is always sent to this printer.
- Previous printerShows the printer that was previously assigned to the job by RICOH ProcessDirector or that previously printed the job. RICOH ProcessDirector maintains the value of this property. You cannot change the value of this property.
- Assigned to printerShows the date and time when the printer received the job. If you print the job again, or process the job again, RICOH ProcessDirector updates the printer-assignment time. You cannot change the value of this property.
- Cumulative pages stackedShows the total number of logical pages that have printed and reached the output stacker of AFP and Ricoh PDF printers. The value includes the page count from the first time that the job printed, as well as page counts from any partial or full reprints of the job.
- Cumulative sheets stackedShows the total number of physical job sheets that have printed and reached the output stacker of the AFP or Ricoh PDF printer. The value i