RICOH ProcessDirector Field Help

Values:

All (default)

A job is sent through the connector if it meets all of the conditions. The conditions have an AND relationship.

Any

A job is sent through the connector if it meets any condition. The conditions have an OR relationship.

Custom

A job is sent through the connector if a compound condition is met. If you define three or more conditions, you can use AND and OR to build a compound condition.

Database name

Connector.AnyOrAllFieldHelp

Usage notes:

• This property supports both simple and compound conditions.
• The Summary field shows the result of your selection in a database query format.
• If you select Custom, an entry field appears. Use the numbers to the left of each condition to build the rules for combining conditions in this field. Enter parentheses to group the conditions logically. For example, when three conditions are specified, enter ( 1 OR 2 ) AND 3 if condition 3 must be included with either 1 or 2, compared to 1 OR ( 2 AND 3 ) where either condition 1 or both conditions 2 and 3 must be included.

Property

Specifies which job property you want to use for the condition.

Values:

The list of all job properties (by field name) in the system.

Comparison

Specifies how RICOH ProcessDirector compares the property value for a job to the contents of the Value field to decide whether a job meets the condition. Select one of these:

Values:

= (equal to ) (default)

A job meets the condition if its property value exactly matches the text in the Value field. The comparison is case-sensitive.

!= (not equal to)

A job meets the condition if it has a property value and it is not the value in the Value field. The comparison is case-sensitive.

> (greater than)

A job meets the condition if its property value is greater than the number in the Value field.

< (less than)

A job meets the condition if its property value is less than the number in the Value field or if the property has no value.

>= (greater than or equal to)

A job meets the condition if its property value is the same as or greater than the number in the Value field.

<= (less than or equal to)

A job meets the condition if its property value is the same as or less than the number in the Value field or if the property has no value.

Like

A job meets the condition if its property value matches the value in the Value field when that value includes wildcard characters. For example, the value in the Value field for the Job name property is CUST1*. All jobs from one customer have the prefix CUST1 added to the job name. A job meets the condition when its job name begins with the text CUST1. The comparison is case-sensitive.

Unlike

A job meets the condition if its property value does not match the value in the Value field when that value includes wildcard characters. For example, the value in the Value field for the Job name property is *.pdf. A job meets the condition when the extension for the job name is not .pdf. The comparison is case-sensitive.

Not set

A job meets the condition if its property has no value set or if the value is Not set.

Set

A job meets the condition if its property has a value set.

Value

Specifies the value that RICOH ProcessDirector uses to decide whether a job meets the condition.

Values:

Depending on the property, you can either choose from a list or enter an alphanumeric value.

If a property takes a unit, you cannot select it. You must specify measurement values in inches. You must specify time values in the smallest unit that the property supports. For example, values for Retention period are in minutes.

Database name

Connector.Display

Usage notes:

• When you use the like or unlike comparison, you can use wildcard characters in the Value field. Use * or % to represent zero or more characters; use _ or ? to represent exactly one character. If you use a like comparison and type only a wildcard character in the Value field, all the jobs in which that property value is set meet the condition, but not the jobs in which that value is Not set.
• To define an additional condition, click + to the right of any condition. To delete a condition, click - to the right of the condition you want to delete.
• If the Value is a date or timestamp, you must only use the less than or greater than comparison.
• You cannot use a RICOH ProcessDirector symbol in the Value field.

Values:

Integers corresponding to the total number of connectors that exit the current step.

Database name

Connector.Order

Usage notes:

• The default Order of execution is the order that the connectors were created in.
• If a step has more than one connector leaving it, the Order of execution value is added to the label on the connector before the value of the Rule name.
• If you change the Order of execution value of a connector to 1, that connector becomes the first connector evaluated. The Order of execution values for the other connectors are updated accordingly.

  For example, you have four connectors, and change the Order of execution value for one of them from 3 to 1. As a result, the connector that previously had its Order of execution value set to 1 is changed to 2. The connector that had its Order of execution value set to 2 adjusts the value to 3 and the value of the fourth connector remains unchanged.

• If you change the Order of execution value of a connector from 5 to 2, that connector becomes the second connector evaluated. The Order of execution values for the other connectors are updated accordingly.

  For example, you have six connectors, and change the Order of execution value for one of them from 5 to 2. As a result, the connector that previously had its Order of execution value set to 2 is changed to 3. The connector that had its Order of execution value set to 3 adjusts the value to 4. The connector that had its Order of execution value set to 4 adjusts the value to 5 and the value of the first and sixth connectors remain unchanged.

Format:

Length

1-128 characters (bytes)

Restrictions

Case-sensitive

Database name

Connector.RuleLabel

Usage notes:

• If you define a condition for a connector, you must provide a rule name.
• You can have multiple rules with the same name. Rules with the same name can have different conditions.

Format:

Length

Up to 128 characters (bytes)

Database name

Group.Actions

When an object type is selected, the available actions for that object type are listed. You can enable or disable any of the actions listed in the table by toggling the Allow checkbox next to the action.

The object types listed include all the objects that are available on the system.

Database name

Group.ActionPermissions

Format:

Length

Up to 128 characters (bytes)

Database name

Group.Attributes

When an object type is selected, the properties for that object type are listed. You can enable or disable the View or Edit action for each property. The View action lets a group view the value of the property without the ability to change it. The Edit action lets a group change the value of the property.

The object types listed include all the objects that are available on the system.

Database name

Group.AttributesPermissions

Format:

Length

Up to 255 characters (bytes)

Database name

Group.CreatedBy

Format:

Length

Up to 1024 characters (bytes)

Database name

Group.Description

Format:

Length

Up to 32 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

Group.ID

Usage note: You cannot change the name of the group after you create it. If you need to rename the location, create a copy of the group and specify the new name. Then, delete the original group.

Database name

Group.LastModified

Database name

Group.ModifiedBy

Format:

Length

Up to 255 characters (bytes)

Database name

Group.SourceID

Values:

UTF8 (default)

Eight-bit UCS Transformation Format.

ISO8859_1

Latin Alphabet Number 1.

ISO8859_15

Latin Alphabet Number 9.

EUC_JP

JISX 0201, 0208, and 0212, EUC encoding Japanese.

Database name

HotFolder.CodePage

Format:

Length

Up to 255 characters (bytes)

Default

(.+?)\.[^.]*$|$

Database name

HotFolder.SetPattern

Usage notes:

• The default value finds files whose names are identical except for their extensions and adds them to the same set. For example, the files Jones.csv and Jones.pdf match except for the extension and can be added to a set. Similarly, Jones.part1.csv and Jones.part1.pdf can be added to a different set.
• The default value assumes that the filetype extension (the text after the last period in the file name) is used to identify each type of file in the set. For example, the Data patterns property is set to a value that uses the .pdf extension to identify the print file and the JDF patterns property is set to a value that uses the .jdf extension to identify the JDF job ticket.
• This property is only used when the Batching method is set to Number of sets, Pages in sets, or Sets by time.

A set is a group of files that must be processed together, such as a data file, a job ticket, and an overrides file. To create sets, you specify values for the pattern matching properties as needed. Pattern matching properties include: Data patterns, JDF patterns, Overrides patterns, and File Patterns. Only the Number of sets, Pages in sets, and Sets by time batching methods can process sets of files.

Values:

None

The input device does not group input files together. For hot folder or SFTP input devices, the default is None.

Batch

The input device groups input files when a user selects two or more files and clicks Make batch from the input files page for the input device. The input device does not automatically submit any input files for processing when this batching method is in effect.

JCL

The input device automatically groups certain sets of input files using the values of their z/OS OUTGRP JCL parameters. The input device groups input files with OUTGRP values of FIRST, NEXT, and LAST. It does not group input files with OUTGRP values of ONLY or input files that do not use OUTGRP parameters.

JCL is valid only for Download input devices. Download input devices are only available if you install the AFP Support feature.

JDF

The input device automatically groups all input files that are specified as Job Definition Format (JDF) type. The input device reads the job ticket input files and locates PDF file names in the input files table or a local directory. The JDF patterns property controls how the input device identifies JDF files.

You must specify values for both the Workflow property and the Child workflow property. The input device treats the data files that the JDF file specifies as child input files. Set the Workflow property for the input device to ParentNoPrint and the Child workflow property to a workflow that is appropriate for the types of files that the JDF file specifies. If more than one file is referenced in the JDF job ticket, the files are assigned child job IDs in the order they appear in the JDF file.

List

The input device automatically groups all input files that are specified in a separate list file. The List patterns property controls how list files are identified.

The list file contains input file names without any path information, and each input-file entry must be on a separate line. To submit a batch of files, copy the list file and all of the input files it identifies to the directory that the Folder location property for the input device specifies.

If only one data file is provided, one job is created. The job contains the list file, aiwlist file, data file, and any other (non-data) files. The job is treated as a child job, even though the job ID is not assigned a child job ID (it displays as, for example, 1000001 rather than 1000001.1).

If more than one file is provided and the Create .zip file property is set to No, a parent job is created for the list and aiwlist files, and a child job is created for each data file (and its associated other files). For example, parent job 1000002 contains the list and aiwlist files, and child jobs 1000002.1 and 1000002.2 contain a data file (and their associated non-data files). The files are assigned child job IDs in the order they appear in the list file.

List is the only valid value for LPD input devices; it can also be used for hot folder or SFTP input devices.

Pattern

The hot folder or SFTP input device compares file information for all input files received by the input device, using the Data patterns and the File patterns properties. Files that match the specified patterns are used to create a single job using the data file. Only one matching file can contain print data.

If you use the Pattern batching method, you can define more precise matching criteria by using both the Data patterns field and the File pattern field. For example, if you use the Data patterns value (.*).data$, any file name ending with .data matches. If you use the File pattern value \1.oth$, then Job1.data and Job1.oth are considered a match and are included in the job, but Job2.oth does not match. For more information about pattern-matching syntax, see the information center.

Number

The hot folder or SFTP input device waits until the number of files in the input device matches the value of the Number of files to batch property. When the values match, the input device submits a group of files.

Number of sets

The hot folder or SFTP input device waits until the number of sets of files in the input device matches the value of the Number of files to batch property. When the values match, the input device submits the sets.

Pages

The hot folder or SFTP input device waits until the total number of pages in the PDF files that are received by the input device matches or exceeds the value of the Number of pages to batch property, then submits a group of files.

The Pages batching method can be used only for PDF files.

Pages in sets

The hot folder or SFTP input device waits until the total number of PDF pages in complete sets that are received by the input device matches or exceeds the value of the Number of pages to batch property, then submits the sets as a group.

The Pages in sets batching method can be used only for PDF files.

Sets by time

The hot folder or SFTP input device submits one or more complete sets of input files at a specific time or time interval determined by the values set for the Batching interval and Batching date or Frequency properties. The hot folder or SFTP input device submits the sets as a group with one set in each child job.

Time

The hot folder or SFTP input device submits a group of all the files that match the value set for the Data patterns property and that are received during a time period determined by the values set for the Batching start date, Batching start time, Batching interval, and Batching date or Frequency properties in the Batching tab.

Database name

InputDevice.BatchingMethod

Usage notes:

• If you choose Number of sets, Pages in sets, or Sets by time, the Create .zip file property is not available. When a set of files is submitted, they always form a single job.
• If the Create .zip file property is available and set to Yes, a single job containing all of the files is submitted in ZIP file format. Set the Workflow property for the input device to a workflow that is appropriate for the data files.
• If you use the Batch, JDF, or Pattern batching method, or if the Create .zip file property is set to No, each data file in a batch is submitted as a child job. As a result, you must set the Workflow property for the input device to ParentNoPrint and the Child workflow property to a workflow that is appropriate for the data files.
• Child jobs are not kept together through processing unless the WaitForGroup step is included in the workflow.
• If you select Trigger for the Completion method property, the Batching method value is not used.

Values:

Not set (default)

The input device has no name assigned for the step. Use this setting if you assign the workflow by setting the Child workflow property for the input device. For LPD input devices, you must enter a value other than Not set for the Child workflow initialization step property.

SetJobTypeFromRules

This step sets the workflow value by using a RICOH ProcessDirector control file. You can edit the control file so that RICOH ProcessDirector determines the workflow from a value of a parameter that accompanies the job. For example, RICOH ProcessDirector could use the FORMS JCL parameter to set the workflow. The Child workflow parsing rules property for the input device specifies the control file that RICOH ProcessDirector uses if this value is set. This step can also use the control file to convert an optional overrides file to a text file in RICOH ProcessDirectorproperty name=value format for setting job properties.

SetJobTypeFromFileName

This step sets the workflow value by parsing the name of the input file. You can specify a pattern-matching string that RICOH ProcessDirector uses to determine the part of the name to use. For example, RICOH ProcessDirector could use the file extension of the input file to set the workflow. The Child workflow pattern property for the input device specifies the pattern-matching string that RICOH ProcessDirector uses if this value is set. This step can also use the control file specified by the Child workflow parsing rules property for the input device to convert an optional overrides file to a text file in RICOH ProcessDirectorproperty name=value format for setting job properties.

Database name

InputDevice.Child.InitJobTypeStep

Usage notes:

• For input device types other than LPD, you can use the Child workflow property in place of or with the Child workflow initialization step property. At least one of the properties must have a value. If the Child workflow initialization step cannot assign a workflow to the job, RICOH ProcessDirector uses the workflow that the Child workflow property for the input device specifies. For LPD input devices, you must enter a value for the Child workflow initialization step property; you cannot use Child workflow instead.
• The Workflow initialization step property for the input device specifies the step that initializes the workflow for parent jobs.

The list includes all the workflows that are available on the system.

Database name

InputDevice.Child.JobType

Usage notes:

• You can use the Child workflow initialization step property in place of or at the same time as the Child workflow property. At least one of these properties must have a value. If the Child workflow initialization property is Not set, the workflow specified in the Child workflow property is used.
• Input devices can receive individual files or groups of files that are processed together. Individual files are always processed as separate jobs. When groups of files are processed together, one file is the parent job and the other jobs are children of the parent. The parent job does not usually contain print data but is kept in the system to manage processing of its child jobs. The Workflow property specifies the workflow for parent jobs. The Child workflow property for the input device specifies the workflow for single jobs and child jobs.
• Do not use the ErrorMessage and ParentNoPrint workflows as the value for the Child workflow property.

Format:

Length

Up to 255 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

InputDevice.Child.JobTypeFilenamePattern

Usage notes:

• RICOH ProcessDirector tries to match the pattern-matching string to a workflow twice, first with a dollar sign, $, appended to the pattern-matching string and then without one. Therefore, it finds a match at the end of the file name before a match at the beginning.
• This is an example of a pattern-matching string that uses the file extension to determine the workflow:

  *.(JOB_TYPE)

  The asterisk, *, represents zero or more characters. The period . is a literal period. The (JOB_TYPE) token signifies that RICOH ProcessDirector should use the characters that follow the literal period as the workflow. Therefore, submitting an input file with the name myfile.pdf results in the input device assigning pdf as the workflow. Users can use a period, an asterisk, and (JOB_TYPE) to select any portion of the job name to use as the workflow name. For example, the pattern (JOB_TYPE).* would cause RICOH ProcessDirector to use the file name to set the workflow.

• This is an example of a regular expression that uses the first 4 alphanumeric characters of the file name:

  [A-Za-z0-9]{4}

  There is no (JOB_TYPE) token in this string because the entire pattern is the workflow. Therefore, submitting an input file with the name pdf3file.pdf results in the input device assigning pdf3 as the workflow.

Format:

Length

Up to 255 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

InputDevice.Child.JobTypeParsingRules

Usage notes:

• RICOH ProcessDirector provides the receive_jcl_jobtype.cfg sample control file that you can modify and use.
• In Linux receive_jcl_jobtype.cfg can be found in the /aiw/aiw1/control_files/rules directory.
• In Windows receive_jcl_jobtype.cfg can be found in the c:\aiw\aiw1\control_files\rules directory.
• As shipped with RICOH ProcessDirector, all workflow assignment statements in the file are inactive. For example: #DEFINE $\{Job.JobType} AS "TEST" WHEN ($\{ORIGHOST} != "myWindowshostname") Users can activate an entry by removing the # comment character, or they can create their own criteria for assigning the workflow.
• See the Reference information section of the information center for more information about control file syntax.

Values:

Yes

Connect the input device when its server connects.

No

Do not connect the input device when its server connects.

To change the value of this property, use the Disconnect and Connect actions of the RICOH ProcessDirector interface.

Database name

InputDevice.Connect

Values:

Yes

A control file converts the overrides file submitted with a job to a text file in RICOH ProcessDirectorproperty name=value format. This value is the default for Download and LPD input devices.

No

The overrides file submitted with a job is not converted to a text file in RICOH ProcessDirectorproperty name=value format. This value is the default for input devices that are not Download or LPD input devices.

Database name

InputDevice.ConvertOverrides

Usage notes:

• The SetJobTypeFromRules or SetJobTypeFromFileName value in the Child workflow initialization step property is required if the value is Yes.
• Only set the value to Yes when the overrides file submitted with a job is not in a RICOH ProcessDirectorproperty name=value format.

Values:

Yes

The files are packaged as a .zip file and submitted as one job.

No (default)

The files are submitted as individual jobs.

Database name

InputDevice.CreateZip

Usage notes:

• You can set this property to Yes for the List, Number, Pages, and Time batching methods. Jobs submitted this way do not use the parent/child job structure.
• If the batching method is Batch, JDF, Pattern, Number of sets, Pages in sets, or Sets by time, this property is not available.

Format:

Length

Up to 1024 characters (bytes)

Database name

InputDevice.Description

Values:

Yes

The input device can submit and create new jobs, and send information.

No (default)

The input device cannot create new jobs.

Authorized users can use the Disable and Enable actions of the RICOH ProcessDirector interface to change the value of this property.

Database name

InputDevice.Enabled

Usage note: A disabled input device can still receive input files from external sources if the connection for the input device is active. The Connection status property describes whether the input device is connected.

Values:

None

The input device uses no defined method to determine file completion. Transmission is complete as soon as the input device detects the input file. For Download input devices, None is the only valid value.

Size

The input device polls the size of the input file, and determines that transmission is complete when no more file-size changes occur between two polls. The Polling interval (unit) property controls the amount of time between polls. For Hot folder input devices, Size is the default value.

File open

The input device determines that transmission is complete when it can open the input file for a write operation.

Trigger

The input device determines that transmission is complete when it receives the trigger file for the input file. The Trigger patterns property controls how the input device recognizes a trigger file. A trigger file must have the same name as the input file, with a different extension. For LPD input devices, Trigger is the only valid value.

If you select Trigger, the value of the Batching method property is not used.

Database name

InputDevice.FileCompletion

Usage note: An overrides file can also be used as a trigger file by specifying the same pattern value for both the Trigger patterns and Overrides patterns properties. In this case, the file is first used as a trigger to indicate that the job has been received and then as an overrides file to update property values.

The default data pattern-matching string for the Hot folder input devices that RICOH ProcessDirector provides is .*$, which means that those input devices accept any file as an input file that contains job data.

The default data pattern-matching string for the RICOH ProcessDirector Download input devices is .*PRD$. This default string cannot be changed. In this string:

• Period (.) matches a single occurrence of any character.
• Asterisk (*) matches zero or more occurrences of the preceding expression.
• PRD are the actual characters that must match.
• Dollar sign ($) signifies that a match of PRD signifies the END of the expression.

The default data pattern-matching string for LPD input devices is .*\.prt$. This default string cannot be changed. In this string:

• Period (.) matches a single occurrence of any character.
• Asterisk (*) matches zero or more occurrences of the preceding expression.
• Backslash (\) indicates that the following period is a literal period, not a placeholder.
• .prt are the actual characters that must match.
• Dollar sign ($) signifies that a match of .prt signifies the END of the expression.

Database name

InputDevice.FileDataPatterns

Usage notes:

• Input files that RICOH ProcessDirector identifies as data files have a submit type of Data when they display in the input files table for the input device.
• If the Completion method property for the input device is Trigger, RICOH ProcessDirector checks for trigger files first. It then checks for other pattern types in this order: overrides patterns, list patterns, data patterns.

The suggested value for Hot folder input devices is .*\.jdf$, where:

• Period (.) matches a single occurrence of any character.
• Asterisk (*) matches zero or more occurrences of the preceding character, up to the maximum file name length.
• Backslash (\) is the escape character that means the next characters are interpreted literally.
• .jdf are the actual characters that must match.
• Dollar sign ($) means that a match of jdf signifies the END of the expression.

Database name

InputDevice.FileJDFPatterns

Usage notes:

• Set the Workflow property for the input device to ParentNoPrint. Set the Child workflow property to a workflow that is appropriate for the types of files that the JDF file specifies.
• Set the Batching method property for the input device to JDF or Pattern.
• If the Completion method property for the input device is Trigger, RICOH ProcessDirector checks for trigger files first. It then checks for other pattern types in this order: JDF patterns, overrides patterns, list patterns, data patterns.

The default for Hot folder input devices is .*\.lst$, where:

• Period (.) matches a single occurrence of any character.
• Asterisk (*) matches zero or more occurrences of the preceding character, up to the maximum file name length.
• Backslash (\) indicates that the following period is a literal period, not a placeholder.
• .lst are the actual characters that must match.
• Dollar sign ($) means that a match of .lst signifies the END of the expression.

The default for Download input devices is .*\.JOB$. This default string cannot be changed. In this string:

• Period (.) matches a single occurrence of any character (letter or number).
• Asterisk (*) matches zero or more occurrences of the preceding character.
• Backslash (\) is the escape character that means the next character is interpreted literally.
• .JOB are the actual characters that must match.
• Dollar sign ($) means that a match of .JOB signifies the END of the expression.

The default for LPD input devices is .*list\lst$. This default string cannot be changed. In this string:

• Period (.) matches a single occurrence of any character.
• Asterisk (*) matches zero or more occurrences of the preceding expression.
• list are actual characters that must match.
• Backslash (\) indicates that the following period is a literal period, not a placeholder.
• .lst are actual characters that must match.
• Dollar sign ($) signifies that a match of list.lst signifies the END of the expression.

Database name

InputDevice.FileListPatterns

Usage notes:

• Set the Workflow property for the input device to ParentNoPrint. Set the Child workflow property to a workflow that is appropriate for the types of input files that the list file specifies.
• Set the Batching method property for the input device to List. Do not submit input files that are not specified by a list file to the input device. Any files that are not identified by a list file wait indefinitely on the input device.
• List files are useful when an input device routinely receives many files that belong to different groups of files. Each list file contains a separate line for each input file that belongs to its group. The input device waits until all input files for the group arrive before it submits the group of files.
• Copy the list file and all of the input files that it specifies to the directory that the Folder location property for the input device specifies. You can copy the input files and the list file in any order. The files are assigned child job IDs in the order they appear in the list file. Child jobs are not kept together through processing unless the WaitForGroup step is included in the workflow.
• Use the Show files action for the input device if you need to determine whether all of the input files have arrived. The list file has a submit type of List file, and a status of Waiting as it waits for all input files to arrive.
• If the Completion method property for the input device is Trigger, RICOH ProcessDirector checks for trigger files first. It then checks for other pattern types in this order: overrides patterns, list patterns, data patterns.

The overrides file and the input file can have the same name, but they must have different extensions. RICOH ProcessDirector does not process files that it identifies with this pattern by themselves. 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.

The default pattern-matching string for Download input devices is .*JCL$. This default string cannot be changed. In this string:

• Period ( . ) matches a single occurrence of any character.
• Asterisk ( * ) matches zero or more occurrences of the preceding expression.
• JCL are the actual three characters that must match.
• Dollar sign ($) signifies that a match of JCL signifies the END of the expression.

The default for LPD input devices is .*other\.oth$. This default string cannot be changed. In this string:

• Period ( . ) matches a single occurrence of any character.
• Asterisk ( * ) matches zero or more occurrences of the preceding expression.
• other are actual characters that must match.
• Backslash (\) indicates that the following period is a literal period, not a placeholder.
• .oth are actual characters that must match.
• Dollar sign ($) signifies that a match of other.oth signifies the END of the expression.

Database name

InputDevice.FileOtherPatterns

Usage notes:

• To process the overrides file in conjunction with a single input file, you cannot use the default value for this property. Update the Data patterns property to a pattern that specifically identifies the input file. For example, if the input file is a PDF, use this pattern: .*pdf$
• If the batching method is List, make sure that the List patterns property for the input device includes the pattern that identifies the list file.
• If the Completion method property for the input device is Trigger, RICOH ProcessDirector checks for trigger files first. It then checks for other pattern types in this order: overrides patterns, list patterns, data patterns.
• An overrides file can also be used as a trigger file by specifying the same pattern value for both the Trigger patterns and Overrides patterns properties. In this case, the file is first used as a trigger to indicate that the job has been received and then as an overrides file to update property values.

The default trigger pattern-matching string for Hot folder input devices and Download input devices is .*\.trg$. This default can be changed for Hot folder input devices, but not for Download input devices. In this string:

• Period (.) matches a single occurrence of any character (letter or number).
• Asterisk (*) matches zero or more of the preceding characters, up to the maximum file name length.
• Backslash (\) is the escape character that means the next character is interpreted literally.
• .trg are the actual characters that must match.
• Dollar sign ($) means that a match of .trg signifies the END of the expression.

The default for LPD input devices is .*\trg$. This default string cannot be changed. In this string:

• Period ( . ) matches a single occurrence of any character.
• Asterisk ( * ) matches zero or more occurrences of the preceding expression.
• Backslash (\) indicates that the following period is a literal period, not a placeholder.
• .trg are actual characters that must match.
• Dollar sign ($) signifies that a match of .trg signifies the END of the expression.

Database name

InputDevice.FileTriggerPatterns

Usage notes:

• To use trigger files, set the Completion method property for the input device to Trigger.
• If the Completion method property for the input device is Trigger, RICOH ProcessDirector checks for trigger files first. It ignores trigger patterns for any of the other completion methods. It then checks for other pattern types in this order: overrides patterns, list patterns, data patterns.
• The input file must have an extension. If it does not, it is not matched to a trigger file, even if one exists.
• The trigger file does not need to have any content. For example, to create a trigger file that indicates that transmission of the input file is complete, access the Linux command line from outside of the RICOH ProcessDirector interface. Then, change to the directory that contains the input file and issue this command: touch filename.trg
• An overrides file can also be used as a trigger file by specifying the same pattern value for both the Trigger patterns and Overrides patterns properties. In this case, the file is first used as a trigger to indicate that the job has been received and then as an overrides file to update property values.

Format:

Length

Up to 255 characters (bytes)

Restrictions

Case-sensitive

You must specify the folder location when you create the input device.

When you add an input device, the default value is:

• For hot folders:

  Linux: /aiw/aiw1/System/hf

  Windows: C:\aiw\aiw1\System\hf

• For Download input devices:

  Linux: /aiw/aiw1/System/dl

  Windows: C:\aiw\aiw1\System\dl

• For LPD input devices:

  Linux: /aiw/aiw1/System/lpd

  Windows: C:\aiw\aiw1\System\lpd

Database name

InputDevice.FolderLocation

Usage note: Input files submitted to the folder location must have permissions that allow RICOH ProcessDirector to read and modify the input files. During installation, RICOH ProcessDirector creates a system user ( aiw1 is the default) with authority to the RICOH ProcessDirector group ( aiwgrp1 is the default). To submit files to the folder location, users must be logged in with a user ID that is a member of the RICOH ProcessDirector group. If they use any other user ID, RICOH ProcessDirector does not have the correct access permissions set on the input file and cannot process the job. The job stays in Error state until it is deleted and resubmitted correctly.

Values:

• Minute
• Hour
• Day
• Week
• Month

Database name

InputDevice.Frequency

Usage notes:

• Use this property with the Batching date or appropriate Frequency property to determine when or how often to submit a batch of input files.
• The value of the Batching interval property is only used with the Time or Sets by time batching method.

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Database name

InputDevice.ID

Usage notes:

• For LPD input devices, it is best to limit the input device name to 8 characters. Depending on the print command that you use, you might have to create a print queue on the sending system with the same name as the input device. Some systems truncate print queue names to 8 characters.
• After RICOH ProcessDirector creates the input device, you cannot change the name of the device. If you need to rename the device, create a copy of the input device and specify the new name. Then, delete the original input device.

Values:

Not set

The input device has no assigned workflow initialization step. Use this setting if you assign the workflow by setting the Workflow property for the input device.

SetJobTypeFromRules

This step sets the parent workflow value by using a RICOH ProcessDirector control file. You can edit the control file so that RICOH ProcessDirector determines the workflow from a value of a parameter that accompanies the job. For example, RICOH ProcessDirector could use the FORMS JCL parameter to set the workflow. The Parent workflow parsing rules property for the input device specifies the control file that RICOH ProcessDirector uses. This step can also use the control file to convert an optional overrides file to a text file in RICOH ProcessDirectorproperty name=value format for setting job properties.

SetJobTypeFromFileName

This step sets the workflow value by parsing the name of the input file. You can specify a pattern-matching string that RICOH ProcessDirector uses to determine the part of the name to use. For example, RICOH ProcessDirector could use the file extension of the input file to set the workflow. The Parent workflow pattern property for the input device specifies the pattern-matching string that RICOH ProcessDirector uses. This step can also use the control file specified by the Parent workflow parsing rules property for the input device to convert an optional overrides file to a text file in RICOH ProcessDirectorproperty name=value format for setting job properties.

Database name

InputDevice.InitJobTypeStep

Usage notes:

• You can use the Workflow property in place of or in conjunction with the Workflow initialization step property. At least one of the properties must have a value. If the workflow initialization step cannot assign a parent workflow to the job or if the property does not have a value, RICOH ProcessDirector uses the workflow that the Workflow property for the input device specifies.
• The Child workflow initialization step property for the input device specifies the step that initializes the workflow for single and child jobs.

Database name

InputDevice.Instance

The list includes all the workflows that are available on the system.

Database name

InputDevice.JobType

Usage notes:

• You can use the Workflow initialization step property in place of or in conjunction with the Workflow property. At least one of these properties must have a value. If the Workflow initialization property is Not set, the workflow named in the Workflow property is used.
• Input devices can receive individual files or groups of files that are processed together. Individual files are always processed as separate jobs. When groups of files are processed together, one file is the parent job and the other jobs are children of the parent. The parent job does not usually contain print data but is kept in the system to manage processing of its child jobs. The Workflow property specifies the workflow for parent jobs. The Child workflow property for the input device specifies the workflow for single jobs and child jobs.

Format:

Length

Up to 255 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

InputDevice.JobTypeFilenamePattern

Usage notes:

• RICOH ProcessDirector tries to match the pattern-matching string to a workflow twice, first with a dollar sign, $, appended to the pattern-matching string and then without one. Therefore, it finds a match at the end of the file name before a match at the beginning.
• This is an example of a pattern-matching string that uses the file extension to determine the workflow:

  *.(JOB_TYPE)

  The asterisk, *, represents zero or more characters. The period . is a literal period. The (JOB_TYPE) token signifies that RICOH ProcessDirector should use the characters that follow the literal period as the workflow. Therefore, submitting an input file with the name myfile.pdf results in the input device assigning pdf as the workflow. Users can use a period, an asterisk, and (JOB_TYPE) to select any portion of the job name to use as the workflow name. For example, the pattern (JOB_TYPE).* causes RICOH ProcessDirector to use the file name to set the workflow.

• This is an example of a regular expression that uses the first 4 alphanumeric characters of the file name:

  [A-Za-z0-9]{4}

  There is no (JOB_TYPE) token in this string because the entire pattern is the workflow. Therefore, submitting an input file with the name pdf3file.pdf results in the input device assigning pdf3 as the workflow.

Format:

Length

Up to 255 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

InputDevice.JobTypeParsingRules

Usage note:

RICOH ProcessDirector provides the receive_jcl_jobtype.cfg sample control file that you can modify and use.

On Linux, receive_jcl_jobtype.cfg can be found in the /aiw/aiw1/control_files/rules directory.

On Windows, receive_jcl_jobtype.cfg can be found in the c:\aiw\aiw1\control_files\rules directory.

As shipped with RICOH ProcessDirector, all workflow assignment statements in the file are inactive. For example: #DEFINE $\{Job.JobType} AS "TEST" WHEN ($\{ORIGHOST} != "myWindowshostname") Authorized users can activate an entry by removing the # comment character or they can create their own criteria for assigning the workflow.

See the Reference information section of the RICOH ProcessDirector information center for more information about control file syntax.

Database name

InputDevice.LastModified

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

InputDevice.Locations

Format:

Data type

Integer from 1-999

Default

10 for Download input devices and LPD input devices or 5 for Hot folder input devices.

Database name

InputDevice.MaxErrors

Database name

InputDevice.ModifiedBy

Format:

Data type

Integer value of 1 or greater

Database name

InputDevice.NumberOfFiles

Usage note: The value of the Number of files to batch property is only used with the Number or Number of sets batching method.

If the Exceed pages to batch property is set to Yes, the batch includes the PDF file that makes the page count exceed this value. If that property is set to No, the batch is submitted without that PDF file.

Format:

Data type

Integer value of 1 or greater

Database name

InputDevice.NumberOfPages

Usage note: The value of the Number of pages to batch property is only used with the Pages or Pages in sets batching method.

Values:

Yes

When a PDF file contains enough pages to make the total number of pages in the hot folder exceed the value set for the Number of pages to batch property, submit that file with the rest of the files as a group.

No (default)

When a PDF file contains enough pages to make the total number of pages in the hot folder exceed the value set for the Number of pages to batch property, submit only the PDF files that are already in the hot folder. The PDF file remains in the hot folder as the first set of pages for the next batch.

Database name

InputDevice.PageThreshold

Usage notes:

• The value of the Exceed pages to batch property is only used with the Pages or Pages in sets batching method.
• If a single file contains more pages than the value set for the Number of pages to batch property and the Exceed pages to batch property is set to Yes, the file is submitted for printing, either as a batch with the rest of the PDF files that are waiting to print or as a batch that contains only one file. However, if the Exceed pages to batch property is set to No, the file cannot be submitted. Processing for the hot folder stops until that input file is deleted, the value of the Number of pages to batch property is increased to at least the number of pages in the file, or the value of the Exceed pages to batch property is changed to Yes so the file can be submitted.

For REST and SOAP web service input devices, specifies the time interval at which RICOH ProcessDirector checks for files at the Request URL. These input devices require the Web Services Enablement feature.

The unit of time for the value can be milliseconds, seconds, minutes, hours, or days. You can specify a value from 0 milliseconds through 24 hours.

Default

30 seconds

Database name

InputDevice.PollInterval

Usage note: When the Completion method property for a hot folder input device is set to Size, the input device checks the file size. The input device then waits for the length of the polling interval and checks the size of the file again. When the file size stays the same from one check to the next, the input device submits a job. With the default Polling interval of 30 seconds, a job that has been fully received waits from 31 to 60 seconds in the input device before it is submitted.

Values:

Current workflow (default)

The input files that share the same submit group as the selected input file are all submitted to the workflow that was previously assigned.

If you select input files that are members of different submit groups, each submit group of files is submitted as a separate job with its assigned workflow.

Different workflow

The input files that share the same submit group as the selected input file are all submitted to the workflow that you select from the list.

If you select input files that are members of different submit groups, each submit group of files is submitted as a separate job to the workflow that you select from the list.

If the workflow that you are looking for is not in the list, check to see if the workflow is disabled. Either select a different workflow or enable the workflow and try again.

Values:

First day of every month

Choose this option to submit a batch of input files on the first day of the month.

Last day of every month

Choose this option to submit a batch of input files on the last day of the month.

Every day

Choose this option to submit a batch of input files every day.

Every x days

Choose one of these options to submit a batch of input files on a repeating basis.

Database name

InputDevice.ScheduleDaily

Usage notes:

• Use this property with the Batching interval property to determine how often to submit a batch of input files.
• The value of the Frequency property is only used with the Time or Sets by time batching method.

Values:

Every hour

Choose this option to submit a batch of input files every hour.

Every x hours

Choose one of these options to submit a batch of input files on a repeating basis.

Database name

InputDevice.ScheduleHourly

Usage notes:

• Use this property with the Batching interval property to determine how often to submit a batch of input files.
• The value of the Frequency property is only used with the Time or Sets by time batching method.

Values:

Every minute

Choose this option to submit a batch of input files every minute.

Every x minutes

Choose one of these options to submit a batch of input files on a repeating basis.

Database name

InputDevice.ScheduleMinute

Usage notes:

• Use this property with the Batching interval property to determine how often to submit a batch of input files.
• The value of the Frequency property is only used with the Time or Sets by time batching method.

Values:

Every month

Choose this option to submit a batch of input files every month.

Every x months

Choose one of these options to submit a batch of input files on a repeating basis.

Database name

InputDevice.ScheduleMonthly

Usage notes:

• Use this property with the Batching interval property to determine how often to submit a batch of input files.
• The value of the Frequency property is only used with the Time or Sets by time batching method.

Values:

Every week

Choose this option to submit a batch of input files every week.

Every x weeks

Choose one of these options to submit a batch of input files on a repeating basis.

Database name

InputDevice.ScheduleWeekly

Usage notes:

• Use this property with the Batching interval property to determine how often to submit a batch of input files.
• The value of the Frequency property is only used with the Time or Sets by time batching method.

Format:

Length

Up to 255 characters (bytes)

Database name

InputDevice.SourceID

Format:

Length

Up to 255 characters (bytes)

Restrictions

Case-sensitive

You must specify the staging location when you create the input device. Consider creating a subdirectory of the directory that the Folder location property for the input device specifies.

When you add an input device, the default value is:

• For hot folders:

  Linux: /aiw/aiw1/System/hf

  Windows: c:\aiw\aiw1\System\hf

• For Download input devices:

  Linux: /aiw/aiw1/System/dl

  Windows: c:\aiw\aiw1\System\dl

• For LPD input devices:

  Linux: /aiw/aiw1/System/lpd

  Windows: c:\aiw\aiw1\System\lpd

Database name

InputDevice.StagingLocation

Database name

InputDevice.StartDate

Usage note: The value of the Batching start date property is only used with the Time or Sets by time batching method.

Select a date from the calendar or enter a date in the field.

Select a time from the list or enter a time in the field.

Database name

InputDevice.StartDateAndTime

Values:

Connected

The input device can receive data from an outside source, such as a hot folder or a system that uses the LPD protocol to transmit files.

Disconnected

The input device cannot receive data from outside sources. The cause of the disconnected status might not indicate a problem with the input device. For Hot folder input devices, you can still place input files in the directory that the Folder location property specifies. Note, however, that RICOH ProcessDirector ignores the files until the input device is connected. Also, if you send input files with the same name while the input device is disconnected, each new occurrence of the input file overwrites any existing file with the same name. Disconnected is the default status for a newly created input device.

Unable to connect

The server for the input device did not respond when a connection attempt was made; or the port is already in use by another input device. For an LPD input device, the appropriate LPD daemon is not started. RICOH ProcessDirector connects the input device when its server, port, or LPD daemon is available.

To change the value of this property, use the Disconnect and Connect actions of the RICOH ProcessDirector interface.

Database name

InputDevice.Status

Value:

SubmitInputFiles

A step that is based on this step template submits either single input files or groups of input files. For single input files, it creates a single job that uses the child workflow. For groups of input files, it creates one parent job for the group and a child job for each input file, and maintains a relationship between the resulting jobs.

You must set either the Child workflow property or the Child workflow initialization step property to assign a workflow to the jobs.

Database name

InputDevice.SubmitStep

Usage note: If a Job Definition Format (JDF) job ticket contains references to more than one file, the step rewrites the job ticket to reference only the file for each child job.

Database name

InputDevice.SystemName

Database name

InputDevice.WaitingFileCount

Database name

InputFile.InputDevice

Usage note:RICOH ProcessDirector does not provide a property notebook for input files. Instead, input file properties display as table columns when you select the Show files action for an input device.

Database name

InputFile.JobIDAssigned

Database name

InputFile.Location

Usage note: If you need to determine the corresponding job number for an input file, view the log for the input device that received the input file. The input device writes a message after it submits an input file that identifies the resulting job number.

The status values are:

Queued

The input device has fully received the input file, and the input file is waiting for the input device to submit it and create the corresponding RICOH ProcessDirector job.

Processing

The Submit step is in the process of converting the input file into a RICOH ProcessDirector job.

Waiting

The input device has fully received the input file, but the input file is not ready for the input device to submit it. For example, the input device might be waiting for other files that are associated with the input file to arrive.

Error

The input device has fully received the input file, but an error condition that requires operator intervention has occurred.

Disabled

The input device has fully received the input file, but the input device is now disabled and cannot submit the input file.

RICOH ProcessDirector updates the value whenever the status of the file changes.

Database name

InputFile.Status

Database name

InputFile.SubmitGroup

Database name

InputFile.Timestamp

If you enter more than one value, they are logically ORed together; if a file matches any specified file type, it is considered a matching pattern. For example, if the File pattern field contains .*oth$,.*ejt$ with a usage of Print and a type of .txt , the system uses a file with either an .oth file type or an .ejt file type to create the print file named <job_number>.Print.txt.

For the string .*oth$ :

• Period ( . ) matches a single occurrence of any character.
• Asterisk ( * ) matches zero or more occurrences of the preceding expression.
• oth are the actual characters that must match.
• Dollar sign ( $ ) signifies that a match of oth signifies the END of the expression.

Database name

InputFilePattern.FilePattern

If this value is set to Yes, RICOH ProcessDirector does not submit the job until a matching file arrives in the Hot folder.

If you want the system to wait for several files with different file types but the same file usage, add a row in the file patterns table for each file type, making each pattern required.

Database name

InputFilePattern.Required

If you specify two file patterns, and the Spool file type and Spool file usage are the same for both file patterns, the Sequence value determines which pattern is used.

Database name

InputFilePattern.Sequence

You can enter a file type that RICOH ProcessDirector provides (for example, afp, gif, jdf, linedata, pcl, pdf, text), or define your own.

Keep in mind that a file type you define should not be a variation of the RICOH ProcessDirector keywords if RICOH ProcessDirector will further process a file that an external program writes to the spool directory. For example, do not use a file type of PDF or Pdf; RICOH ProcessDirector only recognizes pdf.

If you specify a file type that is not already defined in RICOH ProcessDirector, you must use an external program to handle processing for that file type; for example, you can include a step based on RunExternalProgram or RunHotFolderApplication in your workflow.

Database name

InputFilePattern.SpoolFileType

You can enter a usage that RICOH ProcessDirector provides (for example, aiwlist, control, overrides, print), or define your own.

Keep in mind that a usage you define should not be a variation of the RICOH ProcessDirector keywords if RICOH ProcessDirector will further process a file that an external program writes to the spool directory. For example, do not use a file usage of PRINT or Print; RICOH ProcessDirector only recognizes print.

If you specify a usage that is not already defined in RICOH ProcessDirector, you must use an external program to handle processing for that file usage; for example, you can include a step based on RunExternalProgram or RunHotFolderApplication in your workflow.

Database name

InputFilePattern.SpoolFileUsage

Database name

InputTray.Bin

Values:

Yes

The input tray is enabled.

No

The input tray is not enabled.

Database name

InputTray.Enabled

Format:

Length

1-32 characters (bytes)

Database name

InputTray.Id

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Database name

InputTray.Level

Values:

The list of Media objects that have been created in the system.

Database name

InputTray.Media

Format:

Length

Up to 1024 characters (bytes)

Database name

Instance.Description

Values:

Yes

The server is available.

No

An application/secondary server is not available.

Database name

Instance.Enabled

Usage note: You can use the Administration page to enable or disable servers.

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

Instance.ID

Usage note: After RICOH ProcessDirector creates the server, you cannot change the server name. If you need to rename the server, create a copy of the server and specify a new name. Then, delete the original server.

Values:

Yes

The secondary server is a general-usage server. General-usage servers can run any step whose parent step template specifies that it can run on any server in the general pool.

No

The secondary server is not a general-usage server. It can only run a step when the tuning properties for its parent step template list this server.

Database name

Instance.InGeneralServerPool

Usage note: For application servers that run on Windows, make sure that the value of this property is No. Otherwise, errors occur if RICOH ProcessDirector tries to run any of the steps that can run in the general server pool on the Windows server.

For a local secondary server on the primary computer, enter: localhost

Format:

Length

Up to 255 characters (bytes)

Restrictions

RICOH ProcessDirector supports both IPv4 and IPv6 protocols. If you use IPv4, IP addresses can be expressed using dotted-decimal addresses or the fully qualified host name. If you use IPv6, you must use the fully qualified host name of the server.

Default

Not set

Database name

Instance.IPAddress

Database name

Instance.KnownAs

Usage note: This name must exactly match the Server name property on the remote system.

Database name

Instance.LastModified

Format:

Data type

Integer 0–99; 0 means that the application or secondary server does not allow any resource-intensive steps to run.

Default

1

Database name

Instance.MaxHighUsageSteps

Usage notes:

• The Concurrent step limit step template property controls whether a step template, and any steps that are created from it, are considered resource-intensive in performance.
• To control the number of resource-intensive steps that can run on the primary server of the RICOH ProcessDirector system, set the Maximum resource-intensive step count system property.
• If Maximum resource-intensive step count is set to 0, the value for the Maximum step count for other steps property for this server cannot also be 0.

Format:

Data type

Integer 0–999; 0 means that the application or secondary server does not allow any non-resource-intensive steps to run.

Default

5

Database name

Instance.MaxLowUsageSteps

Usage notes:

• The Concurrent step limit step template property controls whether a step template, and any steps that are created from it, are considered resource-intensive in performance.
• To control the number of non-resource-intensive steps that can run on the primary server of the RICOH ProcessDirector system, set the Maximum step count for other steps system property.
• If Maximum resource-intensive step count is set to 0, the Maximum step count for other steps property value for this server cannot also be 0.

Database name

Instance.ModifiedBy

Values:

Linux

Linux operating system

Windows

Microsoft Windows operating system

Database name

Instance.OperatingSystem

Values:

Connected

The application or secondary server can communicate with the primary server.

Disconnected

Either the application or secondary process is not running or it cannot establish a network connection with the primary server. The server process might be inactive because the server was rebooted, the process itself was shut down, or a system failure occurred. The disconnected server tries to reconnect with the primary server at one-minute intervals.

When the primary server detects that an application or secondary server is disconnected, these actions occur:

• Any printer devices that are associated with the disconnected server are disabled. RICOH ProcessDirector moves to an error state any jobs that are assigned to those printers and that have printed pages. If a job has been assigned to a printer on the secondary server but has not begun printing, RICOH ProcessDirector moves it to the queued state.
• Input devices that are associated with the disconnected server do not process any new input files that they receive.
• RICOH ProcessDirector cancels any steps that are associated with the disconnected server and that are actively processing a job. The job is moved to an error state and a message is written to the job error log.
• RICOH ProcessDirector does not schedule new steps to the server until the server reconnects.

Database name

Instance.Status

Database name

Instance.SystemName

Values:

Application/Secondary

Application and Secondary servers share the database with the primary RICOH ProcessDirector server. You can create secondary servers on the same computer as the RICOH ProcessDirector primary server. If the primary server is on a Linux computer, you can install the Secondary Server feature on other Linux computers. That feature lets you create input devices and printers on those computers, in addition to running processing steps on them. You can install Application servers on Windows computers. Application servers let you access other programs on the Windows computer so you can send print jobs to them as part of your workflows.

Database name

Instance.Type

Values:

Yes (default)

Blank page are added to the files that have an odd number of pages.

No

No blank pages are added to the files.

Database name

Job.Add.BlankPage

Usage notes:

• Use this property when the job is sent to a duplex printer to avoid printing the last page of one PDF file and the first page of another PDF file on the same sheet of paper.

  For example, if each PDF file is a separate customer statement, set this property to Yes so that each statement starts to print on the front side of the sheet.

• Blank pages are only added to PDF files with an odd number of pages.

Database name

Job.AssignedValues

Usage notes:

• You can use both a configuration file and the list of property values to change the values for a job. If a property is included in both the configuration file and in the list, the value in this list is used.
• You can enter symbols such as ${Job.CustomerName} as a value for another property, such as a property you use for accounting.
• If you want to set positional properties, you must use the configuration file to specify them.
• If a property takes a unit, you cannot select it. Measurement values are in inches. Time values are in the smallest unit that the property supports. For example, values for Retention period are in minutes.

Values:

None (default)

No binding options are set; the job uses the printer's default setting.

Perfect

The printer glues a cover onto the binding edge.

Ring

The printer inserts rings along the binding edge.

Ring and punch

The printer punches the job for a ring binder.

Database name

Job.Binding

Values:

Not set (Default)

Use the default setting for the printer.

Off

Print all the copies of each sheet before printing the next sheet. For example, if you print 10 copies of a 3-page job with this setting, the printer outputs 10 copies of page 1, then 10 copies of page 2, then 10 copies of page 3.

Collate

For each print file in the job, print all the pages of the file in the order that they appear before printing the next copy. For example, if you print 50 copies of a 10-page packet, the printer outputs pages 1-10 for the first copy, then pages 1-10 for the second copy, and so on, until 50 copies are printed.

Database name

Job.Collate

Usage note: You can only use this property when you print to a Ricoh PDF printer.

The value uses regular expression syntax:

• Period (.) matches a single occurrence of any character (letter or number).
• Asterisk (*) matches zero or more of the preceding character, up to the maximum file name length.
• Backslash (\) is the escape character that means the next character is interpreted literally.
• Dollar sign ($) means that a match signifies the END of the expression.

Characters in the value are case-sensitive. For example, .*PDF$,.*AFP$ represent patterns that are different from .*pdf$,.*afp$. Separate multiple patterns by commas; do not type a space between them.

For example:

• To compress all PDF files, including files with names like myfile.pdf.old, set the value to .*pdf,.*PDF.
• To compress all PDF files, excluding files with names like myfile.pdf.old, set the value to .*pdf$,.*PDF$.
• To compress all PDF files with ABC in the filename, such as draft_ABC.pdf and ABC1.pdf, set the value to .*ABC.*pdf,.*ABC.*PDF.

Format:

Restrictions

Case-sensitive

Default

None

Database name

Job.Compress.FilePatterns

Values:

Yes

All spool and checkpoints files are compressed.

No (default)

No files are compressed.

Database name

Job.CompressAllFiles

Format:

Data type

Integer value of 1 or greater

Default

1

Database name

Job.Copies

Usage notes:

• RICOH ProcessDirector prints the value of this property in the Copies: field of the header sheet for the job.
• When the job is actively printing on an AFP or Ricoh PDF printer, the Job copies stacked property shows how many of the requested copies have printed and reached the output stacker of the printer device. When the job is actively being processed on a PCLOut printer, the Job copies stacked property shows how many of the requested copies have been converted to PCL. To print multiple copies of a job on a Passthrough printer, add the copies option to the Printer command property for the printer. Not all printers support printing multiple copies using lpr, so the request might not be honored.

Values:

Update Job copies requested

Lets you change the number of copies to print. If you select this option, enter a value in the Job copies requested field below. The number of copies is applied to all selected jobs.

Do not update Job copies requested

The number of requested copies for the selected jobs is not updated.

If the job is printing on a Passthrough printer, this property is set to the value of the Job copies requested property after a valid return code is reported for the printer command. If the job is printing on a PCLOut printer, this value is equal to the number of copies converted to PCL. Otherwise no value is set for this property.

Database name

Job.CopiesStacked

Usage notes:

• RICOH ProcessDirector stops updating the value of this property if it receives a stop request for a job that is printing on an AFP printer that specifies that the rest of the job be discarded. If the job is discarded before the current copy completes, the job-copies-stacked count includes a partial copy.
• The value of this property is reset to 0 when a Process again or a Print again request is made for the job. If the job is sent to an AFP or Ricoh PDF printer, any copies that were printed previously are excluded from this value. If the job is sent to a Passthrough printer, the value is reset to the value in the Job copies requested property, regardless of the number of copies that have printed.

Database name

Job.CurrentDay

Usage notes:

• This property can be used to set a condition in a workflow, so that jobs can follow different paths through the workflow based on the day that they arrive at the connector that specifies the condition.
• When you use the Current day property to set a condition, you can only use the = (equal to) and != (not equal to) values.

Database name

Job.CurrentPrinter

Usage note:RICOH ProcessDirector prints the value of this property in the PrinterName: field of the header sheet for the job.

Database name

Job.CurrentTime

Usage note: This property can be used to set a condition in a workflow, so that jobs can follow different paths through the workflow based on the time that they arrive at the connector that specifies the condition.

Format:

Length

1-255 characters (bytes)

Restrictions

None

Default

Not set

Database name

Job.CustomerName

Usage note:RICOH ProcessDirector prints the value of this property in the Customer: field of the header sheet for the job.

Format:

Length

1-1024 characters (bytes)

Database name

Job.Description

Usage note:RICOH ProcessDirector prints the value of this property in the Job Description: field of the header sheet for the job.

For jobs that are printed on Passthrough printers, the value of the Duplex property is not automatically sent with the job. The command defined to send the job to the Passthrough printer or the duplex setting on your printer determines whether the job prints one-sided or two-sided. However, the value of the Duplex property is used by the CountPages step for PDF jobs when calculating the page and sheet count for the job.

Values:

Not set (default)

No duplex mode is assigned.

No

Duplexed printing is not active. The job prints on a single side of the paper. This is also referred to as simplexed printing.

Yes

Normal duplexed printing is active. The job prints on both sides of the paper, with the long side of the paper as the bound edge. This is the orientation that most books use.

Tumble

Tumble-duplexed printing is active. The job prints on both sides of the paper, with the short edge of the paper as the bound edge. The bottom of the front side of the sheet is the top of the back side of the sheet.

Database name

Job.Duplex

Usage notes:

• For AFP jobs, if the value for the Duplex property differs from the duplex mode that the form definition for the job specifies, the Duplex property value is used. For example, if the form definition specifies tumble-duplexed printing and the Duplex property is No, the No value is used and the job prints on a single side of the paper (simplex). If the Duplex property is Not set, the value in the form definition for the job is used.
• For PDF jobs submitted with a JDF job ticket, if the value of the Duplex property differs from the JDF setting, the JDF setting is used. For example, if the JDF specifies duplexed printing and the Duplex property is No, the JDF value is used and the job prints on both sides of the paper.
• The OptimizeJDF step can change the Duplex property based on number of Sides page exceptions in the JDF. For example, some JDF job tickets have a Sides setting on every page even if only one sheet in the entire job is simplex. When the step processes those JDF files, it makes groups of the series of pages with the same Sides value. Then it counts which Sides setting has the most groups and sets that Sides value at the job level and only inserts page exceptions for the pages that have a different Sides value. JDF job tickets with fewer page exceptions are processed faster by steps in Ricoh ProcessDirector.
• This property is ignored when printing on PCLOut printers.

Values:

Not set (default)

RICOH ProcessDirector programs use the code page that the locale setting in the RICOH ProcessDirector server specifies.

UTF-8

Eight-bit UCS Transformation Format

ISO8859_1

Latin Alphabet No. 1

ISO8859_15

Latin Alphabet No. 9

EUC_JP

JISX 0201, 0208, and 0212, EUC encoding Japanese

Database name

Job.External.CodePage

Usage note: External program code page is a positional job property. For information about using positional job properties, refer to the Information Center.

Format:

Length

1–3072 characters (bytes) Special characters are permitted.

Restrictions

Case-sensitive

The command string must use regular expression syntax.

Database name

Job.External.Command

Usage notes:

• External command is a positional job property. For information about using positional job properties, refer to the Information Center.
• One example of an external command appears in the RunExternalProgram step in the PDF workflow. This value is set for the External command property:
  • cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv
  • cp is the Linux command to copy a file.
  • ${getControlFileName()} is a symbol formula that RICOH ProcessDirector uses to derive the name of the file to copy. This formula specifies the control file in the External control file template property.
  • /aiw/aiw1/samples/${Job.ID}.info.csv is the Linux parameter for the directory path and name of the CSV file produced by the external command. If the Job ID is 10000000, the name of the file is 10000000.info.cfg.

  If the primary server runs on Windows, you must change the default value to use a Windows command and an appropriate directory name. For example:

  • copy ${getControlFileName()} C:\aiwdir\aiw1\samples\${Job.ID}.info.csv

• External command is a positional job property. For information about using positional job properties, refer to the Information Center.

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

1-255 characters (bytes)

Database name

Job.External.ControlFileTemplate

Usage notes:

• Control file template is the RICOH ProcessDirector terminology for any parameter file that an external command requires. If the external command calls an external program, the program might use a different term to refer to its parameter file.
• If the external command does not use a control file template, do not specify a value for this property.
• External control file template is a positional job property. For information about using positional job properties, refer to the Information Center.
• The content and format of the information that the control file contains depends on the external command that uses the control file.
• job_info.cfg is an example of a control file template. The job_info.cfg file is located in this directory:
  • On Linux: /aiw/aiw1/control_files/external_programs
  • On Windows: C:\aiw\aiw1\control_files\external_programs

  The control file has a list of symbols for nine job properties.

  An external command like cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv (on Linux) or copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv (on Windows) uses the control file to produce a CSV file with the values of the nine job properties.

  In the control file, the ${job.ID} and ${job.Name} symbols specify the Job ID and Job name job properties. Job.ID and Job.Name are the RICOH ProcessDirector database names of the job properties. In the CSV file produced when a job runs, Job ID and Job name might be 10000000 and Demo.pdf. You can add and delete symbols in the job_info.cfg file, as required for the installation.

• For the TransformJobIntoAFP step, you can use a control file that specifies either the Adobe PDF Print Engine (APPE) or Configurable PostScript Interpreter (CPSI) conversion program. Both programs convert PDF data to AFP. APPE supports more PDF capabilities and gives better performance for color jobs. To convert PDF data with APPE, change the name of the file in the property value to prepare_transform_APPE.cfg. Leave the directory path the same. To convert PDF data with CPSI, keep the default value for the name of the file: prepare_transform.cfg. Both control files convert PostScript, PCL, and SAP data to AFP.

Values:

Not set

The command uses the language that the locale setting in the RICOH ProcessDirector server specifies.

English (en_US)

French (fr_FR)

German (de_DE)

Italian (it_IT)

Japanese (ja_JP)

Portuguese (pt_BR)

Spanish (es_ES)

Database name

Job.External.Language

Usage note: External program language is a positional job property. For information about using positional job properties, refer to the Information Center.

Format:

Length

Up to 128 characters (bytes)

If the external command returns any value that this property does not specify, RICOH ProcessDirector issues an error message and moves the job to an error state.

Database name

Job.External.ValidRCs

Usage note: Valid return codes is a positional job property. For information about using positional job properties, refer to the Information Center.

Database name

Job.FileReceiptTime

Usage note: If a parent job and child jobs are created, the Job arrival time of all child jobs is set to the Job arrival time of the parent job.

Values:

None (default)

No folding options are set.

Z Fold

Folds the paper twice as a Z-shape.

Z Fold Large Paper

Same as Z-fold, except that it only folds the large sheets in the job.

Double Parallel-Fold

Folds the job in four pieces, containing eight panels.

Gate Fold

The left and right edges fold inside and meet in the middle of the page without overlapping. The middle panel is larger, to accommodate the left and right panels when closed.

Multi Letter Fold-Out

Applies two folds to create three equal panels.

Multi Letter Fold-In

Applies two folds to create three equal panels. The outer parts are folded inward

Saddle

Folds the job once, creating two equal halves.

If the Saddle fold option is selected when a folding unit is not attached to the printer, the output is not folded.

SaddleDown

Booklet folds down, also called booklet fold.

May be used to fold output in half that is not a booklet.

Database name

Job.FoldOptions

Values:

Yes

RICOH ProcessDirector holds the job.

No (default)

The job continues to the next processing step.

Database name

Job.HoldPending

Database name

Job.HotFolder.ApplicationLogFile

Usage notes:

• For the RunImpostripOnJob step, the default name and location of the Ultimate Impostrip® log file on the Ultimate Impostrip® server is Program Files\Ultimate Technographics\ImpostripOnDemand\OnDemandLog.txt.
• Application log file is a positional job property. For information about using positional job properties, refer to the Information Center.

Values:

Not set

When a job enters the step, the step deletes any file whose file name matches the Retrieval pattern from the retrieval folder before it submits the File to send.

Yes (default)

When a job enters the step, the step deletes any file whose file name matches the Retrieval pattern from the retrieval folder before it submits the File to send.

No

When a job enters the step, the step leaves any file whose file name matches the Retrieval pattern in the retrieval folder, then submits the File to send.

Database name

Job.HotFolder.ClearRetrievalFolder

Usage notes:

• When the step processes a job, it leaves all files whose file names do not match the Retrieval pattern in the retrieval folder.

• When you set this property to No, the file that the step retrieves can be in the retrieval folder when a job enters the step. The step retrieves the file, then puts the file specified by the File to send property in the sending folder. The step then sends the job and the retrieved file to the next step in the workflow. The step does not wait for a new file to be placed in the retrieval folder.

Format:

Data type

Symbol formula

Default

${getAbsoluteFileName(print,pdf,read)}

Database name

Job.HotFolder.FileToSend

Usage notes:

• The default value returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, an error occurs.
• File to send is a positional job property. For information about using positional job properties, refer to the Information Center.

Format:

Data type

Integer from 2-9

Default

2

Database name

Job.HotFolder.FileVerificationCount

Usage notes:

• For the RunImpostripOnJob step, the retrieval folder is set to the job's spool directory and cannot be changed.
• File size verification count is a positional job property. For information about using positional job properties, refer to the Information Center.

You can specify a value from 1 second through 1 hour. Use the toggle control to the right of the property name to select the unit of time for the value.

Format:

Data type

Integer

Default

30 seconds

Database name

Job.HotFolder.PollInterval

Usage notes:

• The timeout interval should be greater than the poll interval times the file verification count.
• For the RunImpostripOnJob step, the retrieval folder is set to the job's spool directory and cannot be changed.
• Poll interval is a positional job property. For information about using positional job properties, refer to the Information Center.

Database name

Job.HotFolder.RetrievalFolder

Usage note: Retrieval folder is a positional job property. For information about using positional job properties, refer to the Information Center.

The default retrieval pattern string is ${Job.Id}.*. In this string:

• ${Job.Id} is the symbol notation for the Job number property.

  RICOH ProcessDirector looks up the value of this property for the current job and inserts that value in the string, replacing the symbol notation.

• Period (.) matches a single occurrence of any character.
• Asterisk (*) matches zero or more occurrences of the preceding expression.

Database name

Job.HotFolder.RetrievalPattern

Usage note: Retrieval pattern is a positional job property. For information about using positional job properties, refer to the Information Center.

Format:

Data type

Symbol formula

Default

${getFileName(print,pdf,write)}

Database name

Job.HotFolder.RetrievedFile

Usage note: Retrieved file is a positional job property. For information about using positional job properties, refer to the Information Center.

Database name

Job.HotFolder.SendingFolder

Usage notes:

• For the RunImpostripOnJob step template, leave this field blank. During processing, this value is derived from the values you entered on the Ultimate Impostrip® settings page.
• Sending folder is a positional job property. For information about using positional job properties, refer to the Information Center.

The unit of time for the value can be minutes, hours, or days. You can specify a value from 0 minutes through 7 days. Use the toggle control to the right of the property name to select the unit of time for the value.

Format:

Data type

Integer

Default

• None for the RunHotFolderApplication step
• 2 hours for the RunImpostripOnJob step

Database name

Job.HotFolder.TimeOutInterval

Usage notes:

• The timeout interval should be greater than the poll interval times the file verification count.
• For the RunImpostripOnJob step, the retrieval folder is set to the job's spool directory and cannot be changed.
• Timeout interval is a positional job property. For information about using positional job properties, refer to the Information Center.

Database name

Job.ID

Usage note: You can use the System Settings page of the administration interface to configure the largest and smallest job numbers that RICOH ProcessDirector assigns.

Values:

No (default)

Media substitution rules are honored and different media can be used for the job.

Yes or Not set

Media substitution rules are ignored and different media cannot be used for the job.

Database name

Job.IgnoreShopRules

Usage note: Selecting Yes or Not set restricts this job from using any media substitution rules that are defined for the printer used to print the job. This setting might prevent the job from printing until the requested media is available.

Values:

AFP

The input file is in the Advanced Function Presentation format.

CSV

The input file is in the comma-separated value format.

GIF

The input file is in the Graphic Interchange Format.

JDF

The input file is a job ticket in the Job Definition Format.

JPEG

The input file is in the Joint Photographic Experts Group format.

JSON

The input file is in the JavaScript Object Notation format.

LCDS

The input file contains data in the Xerox line-conditioned data stream.

LineData

The input file contains line data or mixed mode data. RICOH ProcessDirector cannot detect line data or mixed mode data; this value must be explicitly set.

Metacode

The input file contains data in the Xerox metacode format.

PCL

The input file is in the Hewlett-Packard Printer Control Language format.

PDF

The input file is in the Adobe Portable Document Format.

PostScript

The input file is in the Adobe PostScript format.

Text

The input file contains plain text data. RICOH ProcessDirector cannot detect plain text; this value must be explicitly set.

TIFF

The input file is in the Tagged Image File Format.

Unknown

The data type of the input file is not known. Because the DetectInputDataStream step cannot detect between the line data and text input data streams, it sets the value of this property to Unknown for either of these input data streams.

XML

The input file is in Extensible Markup Language format.

Database name

Job.InputDataStream

Usage notes:

• It is a good practice to set the input data stream accurately. Authorized users can accomplish this by including the DetectInputDataStream step in the workflow, or they can explicitly set the Input data stream property in a SetJobPropsFromTextFile step in the workflow.
• If the Input data stream property is specified more than once, RICOH ProcessDirector uses a hierarchy to establish the final value of the property. It establishes the value in this order:
  • When the input device submits the input file and creates the corresponding job, RICOH ProcessDirector sets the initial value to Unknown.
  • If the workflow for the job includes a value for the input data stream, RICOH ProcessDirector updates the value of the property to the value that the workflow specifies.
  • If the AFP Support feature is installed, the input file was submitted through Download for z/OS or AFP Download Plus, and the JCL file that accompanied the input file included a value for the datat keyword, RICOH ProcessDirector updates the property to the value that the keyword specifies.
  • If the workflow includes the DetectInputDataStream step, and the step detects the type of input data stream, RICOH ProcessDirector updates the value to the type that the step detected. This only applies if the Input data stream property has not been modified by the workflow or through the JCL file, and is still Unknown.
  • If an authorized user does a Process again action on the job and selects a new value for the input data stream, RICOH ProcessDirector uses the value that the user specifies. In this case, it ignores any value that the workflow specifies. Also, if reprocessing runs the DetectInputDataStream step again, RICOH ProcessDirector ignores any value that the step determines.
• If you need to change the Input data stream property after RICOH ProcessDirector starts to process the job, use the Process Again action. In this case, start processing the job again from the step that specifies the new value.

Database name

Job.InputFile

Database name

Job.InputFile.Size

Usage note: If the workflow for the job specifies the CountPages step, RICOH ProcessDirector reports the size of the job in pages after that step completes for the job. See the value of the Total pages property.

Database name

Job.Instance

RICOH ProcessDirector also uses the value of this property when a workflow uses the VerifyPrintedSheetCount step to validate the actual number of sheets that print for a job. You cannot change the value of this property.

Database name

Job.JobSize

Database name

Job.JobType

Database name

Job.JobType.History

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

Job.Locations

Usage note:RICOH ProcessDirector prints the value of this property in the Location field of the header sheet for the job.

Default

Not set

In the job property notebook, you can use the toggle control to the right of the property name to change the media objects that are included in the list. The toggle options are:

Ready

The list shows only media that are loaded and ready in the requested printer.

Supported

The list shows media that the requested printer supports. Media that is both supported and ready in the printer appears at the top of the list.

All

The list includes all media objects that are defined. Media that is ready is listed first, followed by supported media, then any remaining media.

On the Workflow page, the toggle button is not available; the list always displays all media.

Database name

Job.Media

Usage notes:

• If you do not specify a value, the printer uses the media that is loaded in the default tray.
• If a value is specified for the Media, Duplex, or Output bin job property for an AFP job, RICOH ProcessDirector ignores that value in the form definition.
• Both the Scheduling and the Page Exception tabs in the Job property notebook include this property; you cannot change its value on the Page Exception tab.
• If the job requires more than one type of media, such as cardstock for covers or colored paper for chapter dividers, use the Page Exception tab to define the other media. If page exceptions are defined, RICOH ProcessDirector uses the list of media in the Media required property to schedule the job to a printer.

Database name

Job.MediaRequired

Usage notes:

• This value is compared to the Media supported property on a printer to determine whether the printer can print the job.
• You cannot change the value of this property.

Values:

Yes

At least one media was substituted. See the job log for details.

No

No media was substituted.

Database name

Job.MediaSubstitution

Usage note: This property is set when the job is assigned to a printer. If you print or process the job again, the value is reset to No if the job was printed on a printer that does not require substitution.

Format:

Length

Up to 128 characters (bytes)

Restrictions

Case-sensitive

Database name

Job.Name

Usage notes:

• When the ${Job.InputFile} symbol is used as the value for this property, RICOH ProcessDirector sets the job name to the name of the input file from which the job was created. However, for any job submitted with a control file that defines the job name (Download and LPD input devices), remove ${Job.InputFile} as the value for this property so it does not override the job name defined in the control file.

  For example, if the workflow specifies ${Job.InputFile} as the value of the Job name property, and a control file, such as receive_lpd_pdf_jobtype.cfg, specifies DEFINE ${Job.Name} AS "${DEPARTMENT}", RICOH ProcessDirector sets the value of the Job name property to the name of the input file for the job, not to the value that the DEPARTMENT job parameter specifies.

• If you use the Process Again action to process the job again, and you specify a different workflow, the job's name might change. The job name is set based on the rules for the new workflow.

You can use the toggle control to the right of the property name to change the bins that are included in the list. The toggle options are:

Requested

Output bins that are available on the requested printer are shown.

Available

Output bins that are available on any printer are shown. Requested output bins are listed first.

All

All output bins defined are shown. Requested output bins are listed first, followed by available output bins, then any remaining output bins.

On the Workflow page, the toggle button is not present; the list always displays all defined output bins.

Default

Not set

Database name

Job.OutputBin

Default

11.0 inches or 279.400 millimeters, depending on the locale setting of the browser. In the Workflow page, inches are used.

Database name

Job.PageLength

The value can include individual pages and page ranges. Separate pages and page ranges with commas. Use a dash to separate the beginning and ending pages in a page range. For example: 1,170,300-350,418.

The letter n can be used to represent the last page in the job. A value of 400-n causes RICOH ProcessDirector to print from page 400 through the last page of the job. A value of just n causes RICOH ProcessDirector to print only the last page of the job.

Format:

Length

Up to 255 characters (bytes)

Default

Not set

Database name

Job.PageRange

Usage notes:

• You cannot edit the Pages to print again property on the Job property notebook. Use the Print again action to specify which pages to print again.
• In the Print Again dialog, you can enter the value in the field or click the Select pages in viewer button and select which pages to print again.
• RICOH ProcessDirector prints the value of this property in the Reprint Range field of the header sheet for the job.

Database name

Job.PagesStacked

Usage notes:

• To see updates to the value of this property, view the Status tab of the property notebook for the job and refresh the page.
• RICOH ProcessDirector stops updating the value of this property if it receives a stop request for the AFP or Ricoh PDF job that specifies that the rest of the job should be discarded.
• RICOH ProcessDirector recalculates the value of this property if a Process again request or a Print again request is made for the job and the job is printed on an AFP or Ricoh PDF printer. For a job assigned to a Passthrough printer, this property gets reset to zero when a Process again or a Print again request occurs and reset to the value in the Total pages property when the job is reassigned to a Passthrough printer.
• The pages-stacked value includes any header pages, separator pages, trailer pages, and message pages that might print for the job.

Default

8.5 inches or 215.900 millimeters, depending on the locale setting of the browser. In the Workflow tab, inches are used.

Database name

Job.PageWidth

Values:

• Receive
• Prepare
• Print
• Complete

RICOH ProcessDirector updates the value whenever the job moves from one phase to another. You cannot change the value of this property.

Database name

Job.Phase

Usage notes:

• If you changed the default phase names, the names you chose are displayed in the list.
• RICOH ProcessDirector also uses these properties to further define the processing point and state of the job:
  • Current job state
  • Current step
  • Progress within the current phase
  • Stop when entering phase
  • Reason for wait status

Values:

Preprocessing

RICOH ProcessDirector is performing one or more pre-processing tasks for the job.

Active

RICOH ProcessDirector is actively processing the job.

Manual

The job requires an action on the part of the operator. The action is not required because of an error condition. For example, an operator might have done a Stop action on the job and a Continue action is needed to resume processing. Another example would be if the workflow for the job includes a manual step and the job is waiting for the operator to start or complete the manual step.

Error

RICOH ProcessDirector has detected an error with the job that requires operator intervention. For example, the printer jammed or another job-processing step encountered an error.

Database name

Job.PhaseProgress

Database name

Job.Preview.AcceptedBy

Usage notes:

• If the Accept preview print automatically property is set to Yes, this value is set to System.
• Accepted by is a positional job property. For information about using positional job properties, refer to the Information Center.

Values:

Yes

Accepts the preview print without waiting for a user to do an action. The print job moves to the next step and continues processing.

No (default)

Waits for a user to accept or reject the preview print.

Database name

Job.Preview.AutoAccept

Usage notes:

• Set this value to Yes if a user does not have to review and accept the preview print at this point in the workflow. For example, if your workflow includes multiple PreviewPrint steps and you want to compare the output from all of them, you can automatically accept all of the print previews except the last one.
• Accept preview print automatically is a positional job property. For information about using positional job properties, refer to the Information Center.

The value can include individual pages and page ranges. Separate pages and page ranges with commas; use a dash to separate the first and last pages in a page range. For example: 1,170,300-350,418.

The letter n can be used to represent the last page in the job. A value of 400-n causes RICOH ProcessDirector to print from page 400 through the last page of the job. A value of just n causes RICOH ProcessDirector to print only the last page of the job.

Format:

Length

Up to 255 characters (bytes)

Default

Not set

Database name

Job.Preview.PageRange

Usage note: If you change this value after the job enters the PreviewPrint step, you must process the job through the PreviewPrint step again.

If the value is Not set, RICOH ProcessDirector does not assign the job to a printer until an authorized user selects a printer from the list. You do not use the Schedule Job action to set this value.

If you see a colored star next to this field, only your favorite printers are listed. Click the colored star to see all the printers in the list.

Database name

Job.Preview.RequestedPrinter

Usage notes:

• If a specific printer is requested, the properties of that printer determine the ready and supported values that you can select for the Media property, and the available and requested values that you can select for the Output bin property.
• If you set the Transform RIP for printer property to Same as requested printer, make sure that the requested printer supports the halftone specified by the Transform halftone property. You can specify any combination of printer and halftone, but if the printer does not support the halftone there are errors in transform processing.

Database name

Job.PreviousPrinter

Database name

Job.Print.AssignPrintTime

Passthrough printers accumulate page counts by assuming the number of pages set in the Total pages property was stacked each time the printer command was run and reported a valid return code. PCLOut printers show how many accumulated pages have been converted to PCL.

Database name

Job.Print.CumulativePagesStacked

Usage note: The cumulative-pages-stacked value includes any header pages, separator pages, trailer pages, and message pages that might print for the job.

Passthrough printers accumulate sheet counts by assuming the number of sheets set in the Total sheets property was stacked each time the printer command was run and reported a valid return code. PCLOut printers show how many accumulated sheets have been converted to PCL.

Database name

Job.Print.CumulativeSheetsStacked

Usage note: For jobs sent to AFP printers, the cumulative-sheets-stacked value includes any header pages, separator pages, trailer pages, and message pages that might print for the job.

Database name

Job.Print.CurrentPag

Database name

Job.Print.CurrentTotalPages

Database name

Job.Print.CurrentTotalSheets

You cannot change the value of this property.

Database name

Job.Print.EndPrintTime

Database name

Job.Print.Formlength

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. RICOH ProcessDirector provides these configuration files in this directory:

• On Linux: /aiw/aiw1/control_files/banner_pages
• On Windows: C:\aiw\aiw1\control_files\banner_pages

Format:

Length

Up to 255 characters (bytes)

Database name

Job.Print.HeaderConfig

Usage notes:

• If the Header copies property for the job has a value of 1 or greater, RICOH ProcessDirector verifies that the Header page configuration file property has a value, and that the configuration file exists. If RICOH ProcessDirector does not find the configuration file, it moves the job to an error state.
• For AFP banner pages, this value must specify the appropriate .cfg file.
• For PDF banner pages, this value must specify the appropriate .jrxml file.
• For AFP banner pages, if the Banner page type printer property has a value, RICOH ProcessDirector looks for a corresponding configuration file. If it finds a corresponding configuration file and the file is different from the configuration file that the job specifies, RICOH ProcessDirector uses the configuration file that the Banner page type printer property specifies. For example, if the Header page configuration file job property has a value of header.cfg, and the printer property has a value of Narrow, RICOH ProcessDirector looks for a configuration file in the directory specified by the job with a name of header.narrow.cfg. If that file exists, RICOH ProcessDirector uses that file instead of the header.cfg file.
• On Linux primary computers: For PDF banner pages that print on Ricoh PDF or Custom PDF printers on application servers, this value must specify the drive letter that the application server uses to connect to the /aiw directory on the primary computer. For example, the application server uses Z: to connect, and the file path to the header page configuration file on the primary computer is /aiw/aiw1/control_files/banner_pages/header.jrxml. This value must specify Z:\aiw1\control_files\banner_pages\header.jrxml.

Format:

Data type

Integer from 0-9999; 0 means that no header page prints for the job.

Default

1

Database name

Job.Print.HeaderCopies

Usage notes:

• If you use PDF banner pages, the printer device must support the PDF data stream.
• To print a PDF header page for a job sent to a Ricoh PDF or Passthrough printer, this value must be set to 1 or greater and the Enable header pages printer property set to Yes.
• If the Download file type property is Job header file, Dataset header file, or Job trailer file, RICOH ProcessDirector sets the Header copies property to 0 for this job and all other jobs in the group.

Values:

Default

Not set

In the job property notebook, you can use the toggle control to the right of the property name to change the media objects included in the list. The toggle options are:

Ready

The list shows only media that the printer reports as ready and loaded.

Supported

The list shows media that the printer supports. Media that is both supported and ready in the printer appears at the top of the list.

All

The list includes all defined media objects. Media that is ready is listed first, followed by supported media, then any remaining media.

Database name

Job.Print.HeaderMedia

Usage notes:

• Use Header and Trailer media values to maximize printing efficiency by precisely matching jobs and printers.
• This property is only available for Ricoh PDF, Kodak, and Xerox printers. Set Header and Trailer media values only for these printers to avoid a No matching device status.
• If you do not specify a value, the printer uses the media loaded in Banner page input tray. If the banner page input tray value is not set, RICOH ProcessDirector creates a default JDF job ticket with no tray information. The printer then picks the default tray.
• If the Printer specifies a tray for the banner pages, and the Job specifies media for the Header or Trailer, then the job is marked with a scheduling conflict and printing does not occur.

Database name

Job.Print.ReprintedUnfinished

Database name

Job.Print.SpoolID

Usage notes:

• The RICOH ProcessDirector printer driver component prints the spool ID on any error pages that it prints for the job.
• RICOH ProcessDirector prints the value of this property in the SpoolID: field of the header sheet for the job.
• This property is not set for jobs sent to Passthrough printers.

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. RICOH ProcessDirector provides these configuration files in this directory:

• On Linux: /aiw/aiw1/control_files/banner_pages
• On Windows: C:\aiw\aiw1\control_files\banner_pages

Format:

Length

Up to 255 characters (bytes)

Database name

Job.Print.TrailerConfig

Usage notes:

• If the Trailer copies property for the job has a value of 1 or greater, RICOH ProcessDirector verifies that the Trailer page configuration file property has a value, and that the configuration file exists. If RICOH ProcessDirector does not find the configuration file, it moves the job to an error state.
• For AFP banner pages, this value must specify the appropriate .cfg file.
• For PDF banner pages, this value must specify the appropriate .jrxml file.
• For AFP banner pages, if the Banner page type printer property has a value, RICOH ProcessDirector looks for a corresponding configuration file. If it finds a corresponding configuration file and the file is different from the configuration file that the job specifies, RICOH ProcessDirector uses the configuration file that the Banner page type printer property specifies. For example, if the Trailer page configuration file job property has a value of trailer.cfg, and the printer property has a value of Narrow, RICOH ProcessDirector looks for a configuration file in the directory specified by the job with a name of trailer.narrow.cfg. If that file exists, RICOH ProcessDirector uses that file instead of the trailer.cfg file.
• On Linux primary computers: For PDF banner pages that print on Ricoh PDF or Custom PDF printers on application servers, this value must specify the drive letter that the application server uses to connect to the /aiw directory on the primary computer. For example, the application server uses Z: to connect, and the file path to the trailer page configuration file on the primary computer is /aiw/aiw1/control_files/banner_pages/trailer.jrxml. This value must specify Z:\aiw1\control_files\banner_pages\trailer.jrxml.

Format:

Data type

Integer from 0-9999; 0 means that no trailer page prints for the job.

Default

1

Database name

Job.Print.TrailerCopies

Usage notes:

• If you use PDF banner pages, the printer device must support the PDF data stream.
• To print a PDF trailer page for a job sent to a Ricoh PDF or Passthrough printer, this value must be set to 1 or greater and the Enable trailer pages printer property set to Yes.
• If the Download file type property is Job header file, Dataset header file, or Job trailer file, RICOH ProcessDirector sets the Trailer copies property to 0 for this job and all other jobs in the group.

Values:

Default

Not set

In the job property notebook, you can use the toggle control to the right of the property name to change the media objects included in the list. The toggle options are:

Ready

The list shows only media that the printer reports as ready and loaded.

Supported

The list shows media that the printer supports. Media that is both supported and ready in the printer appears at the top of the list.

All

The list includes all defined media objects. Media that is ready is listed first, followed by supported media, then any remaining media.

Database name

Job.Print.TrailerMedia

Usage notes:

• Use Header and Trailer media values to maximize printing efficiency by precisely matching jobs and printers.
• This property is only available for Ricoh PDF, Kodak, and Xerox printers. Set Header and Trailer media values only for these printers to avoid a No matching device status.
• If you do not specify a value, the printer uses the media loaded in Banner page input tray. If the banner page input tray value is not set, RICOH ProcessDirector creates a default JDF job ticket with no tray information. The printer then picks the default tray.
• If the Printer specifies a tray for the banner pages, and the Job specifies media for the Header or Trailer, then the job is marked with a scheduling conflict and printing does not occur.

Format:

Data type

Integer from 1-999. 1 specifies the highest priority. 999 specifies the lowest priority.

Default

Not set

Database name

Job.Priority

Usage notes:

• RICOH ProcessDirector treats any job without a value for its Job priority property as the lowest priority. Any other job with a job-priority value, even if the value is 999, processes through each step before a job without a job-priority value.
• RICOH ProcessDirector prints the value of this property in the Priority: field of the header sheet for the job.
• Before setting the job priority, make sure that the printer is disabled at the time the schedule is made. Otherwise, the jobs are not printed in the order specified by the user.
• Jobs that contain a JDF file must use a job priority value between 1 and 100. If you enter a value that exceeds 100, Ricoh ProcessDirector reverts the value to 100.

Database name

Job.ProcessGroupId

Usage notes:

• RICOH ProcessDirector assigns a value to the Process group ID property for all child jobs.
• If you select the Add to Group action for a job that is not in a group, Process group ID is set to the same value as the job number.
• For child jobs, RICOH ProcessDirector uses the job number of the parent job as the value for this property. RICOH ProcessDirector can create child jobs from the input files that a list file specifies for a Hot folder input device. If the AFP Support feature is installed, it can also create child jobs from a multi-dataset job sent through Download for z/OS.
• The Process group order property identifies the position of the job within the group of jobs that have the same Process group ID value.
• Selecting Remove from Group for a job resets the Process group ID to null.

Default

Not set

Database name

Job.ProcessGroupOrder

Usage notes:

• The parent job in a group has a Process group order value of 0.
• RICOH ProcessDirector assigns a value to the Process group order property for all child jobs.
• If you select the Add to Group action for a job that is not in a group, Process group ID is set to the job number of the job and Process group order is set to 0.

Values:

Yes

The job was promoted.

No

The job was not promoted.

Default

Not set

Database name

Job.Promote

Usage notes:

• If you promote more than one job on the system, the job that was promoted last moves ahead of all other jobs. The Promotion time property contains the timestamp of when the job was promoted.
• RICOH ProcessDirector processes jobs on the system that are not members of process groups in this order:
  • Most recently promoted, as determined by the Promotion time property for the job
  • Highest priority, as determined by the Job priority property
  • Most recently submitted, as determined by the Time submitted property
• RICOH ProcessDirector processes jobs that are members of a process group in this order:
  • Most recently promoted
  • Highest priority
  • Job order within the process group, as determined by the Process group order property
• You cannot set the Promoted property in a workflow.

Database name

Job.PromoteTime

Values:

Not set (default)

2 at left

2 at right

2 at top

2 at bottom

3 at left

3 at right

3 at top

3 at bottom

4 at left

4 at right

4 at top

4 at bottom

Multiple at left

Multiple at top

Multiple at right

Multiple at bottom

Database name

Job.Punch

Usage notes:

• The value set for the Punch property is ignored if the job is AFP and contains an inline form definition or medium map.
• If the job is AFP and uses an external form definition which has values set for the Punch or Staple job property, RICOH ProcessDirector uses the property values and ignores the values in the external form definition. If the job uses an external form definition and these values are unspecified, RICOH ProcessDirector uses the values in the external form definition.
• Not all printers support all punch options. For some printers, you can indicate whether a printer can punch, but not what punch patterns it can do.
• On some printers, different options produce the same results; for example, 2 at left and Multiple at left.
• On AFP printers, all punch options produce the same results even when the printer supports multiple options because the job submission program does not distinguish between options.

Values:

Not set

The job has been printed only once.

1

The job has been printed once and then all or part of the job has been processed or printed again.

Database name

Job.ReprintCount

Usage notes:

• Only one version of the job can be printing at a time, the original print job or one reprint. For example, you cannot select two different sets of page ranges and have them print simultaneously on two printers.
• When the Reprint count property contains a value, the size of the job reflected in the Job size (sheets) property is adjusted for the size of the reprint job. Therefore, if you request to reprint only 100 sheets of a 5000-sheet job, the Job size property changes from 5000 to 100 when the Reprint count property is incremented. The Total sheets property remains 5000. When the reprint is successfully completed, the Cumulative sheets stacked property is 5100 plus any banner pages that were printed.

The requested printer can also be one of these values:

Any printer

The job is assigned to the first available printer with matching values for its scheduling properties.

Not set

The job is not assigned to any printer. The value must be changed before RICOH ProcessDirector can assign the job to a printer.

If you see a colored star next to this field or next to the printer name, only your favorite printers are listed. Click the colored star to see all the printers in the list.

The requested printer might not be the actual printer that prints the job. For example, an operator might move the job to a different printer because of a problem with the requested printer. The Assigned printer property identifies the printer that actually prints the job.

Database name

Job.RequestedPrinter

Usage notes:

• If a specific printer is requested, the properties of that printer determine some of the values that you can select for Media and Output bin properties.
• If you install the AFP Support feature and set the Transform RIP for printer property to Same as requested printer, make sure that the requested printer supports the halftone specified by the Transform halftone property. You can specify any combination of printer and halftone, but if the printer does not support the halftone there are errors in transform processing.

For the AFP output of the Advanced Transform feature, specifies the resolution of the raster fonts produced. The resolution of images is set with the IOCA transform resolution property.

Format:

Length

Number from 100-999

For example:

240

The resolution is 240 dots-per-inch. Use this resolution for printers such as the IBM 3900.

300

The resolution is 300 dots-per-inch. Use this resolution for printers such as some models of the InfoPrint 4000. This is the default value for the Advanced Transform feature.

600

The resolution is 600 dots-per-inch. Use this resolution for printers such as the InfoPrint 4100. This is the default value for the RICOH Transform features.

Database name

Job.Resolution

Database name

Job.RestartSteps

You can specify a value from 0 minutes through 99999 hours. Use the toggle control to the right of the property name to select the unit of time for the value. RICOH ProcessDirector also uses the retention-period value to calculate and set the Retention expiration time property for the job. The default value for the retention period is 3 days.

Database name

Job.RetainDuration

Database name

Job.RetainStartTime

The configuration file is a text file that contains property and value pairs for any job properties, including properties that can be used more than once in a workflow and have different values for each use. By defining rules to call the step to assign the values in this file to the job, you can set different values for the same or different job properties to be passed to the next step in the workflow.

Database name

Job.SetJobOverrides

Usage notes:

• You can use both a configuration file and the list of property values in this step to change the values for a job. If a property is included in both the configuration file and in the list, the value in the list is used.
• In the file, use RICOH ProcessDirector database names for the properties. List each property and value on a separate line as database.property.name=value, with no spaces before or after the equal sign (=). For example:

  Job.RequestedPrinter=RicohProVC60000Job.Duplex=Yes

• To set a value for a positional job property, specify the phase and step names in brackets following the property name.

  This example specifies a Linux copy command as the value of the External command job property for the RunExternalProgram step in the Prepare phase of a workflow:

  Job.External.Command[Prepare][RunExternalProgram]=cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv

• Job values file is a positional job property. For information about using positional job properties, refer to the Information Center.

Format:

Length

Up to 200 characters (bytes)

Restrictions

Do not use these characters in the name: \ (backslash) " (double quote) ` (backtick)

Database name

Job.SetupName

Usage note:

• Sometimes presets are also referred to as setups.
• If you request a preset for a job and that preset is available on the printer but requires operator intervention to apply (such as to load a different paper), the job goes into error.
• If you request a preset for a job and that preset is not available on the printer, the job goes into error.
• If you use this property as a scheduling property, you can schedule jobs to a printer that has the same value for its Preset name property.

  However, this property is not updated with the Make job match printer action. To update it, use Edit Scheduling Properties or open the job property notebook and update it directly.

• You can use a RICOH ProcessDirector symbol for the value of this property. For more information about symbol notation and how to use it, refer to the help system.

PCLOut printers set this property equal to the number of sheets converted to PCL. Passthrough printers set this property to equal the Total Sheets property, if a valid return code is reported for the printer command. Otherwise, no value is set for this property. You cannot change the value of this property.

Database name

Job.SheetsStacked

Usage notes:

• RICOH ProcessDirector stops updating the value of this property if it receives a Stop request for the AFP or Ricoh PDF job that specifies that the rest of the job should be discarded.
• RICOH ProcessDirector recalculates the value of this property if a Process again request or a Print again request is made for the job and the job is printed on an AFP or Ricoh PDF printer. For a job assigned to a Passthrough printer, this property is reset to 0 when a Process again or Print again request occurs and reset to the value in the Total Sheets property when the job is reassigned to a Passthrough printer.
• The sheets-stacked value includes the sheets that are used for any header pages, separator pages, trailer pages, and message pages that might print for the job.
• To see updates to the value of this property, view the Status tab of the property notebook for the job and refresh the page.

For example, when RICOH ProcessDirector receives a job file, it renames the file JobID.print.unknown. In that file name, the usagetype is print and the datatype is unknown.

Format:

usagetype.datatype

For example: print.pdf, print.afp, print_range.afp

Default

print.pdf

Database name

Job.SnapshotJobFile.FileToBeCopied

Usage notes:

• The most common usagetype for this property is print.
• Example datatypes for this property are: afp, pdf, and ps.
• For more information about usagetype and datatype values and how they are used in RICOH ProcessDirector methods, see the information center.
• These values are case-sensitive.

If you include a command in a step that occurs later in the workflow and that command requires the snapshot file, use this value as the usagetype in the method that you include in the command.

For example, if this value is set to original , the method ${getAbsoluteFileName(original,afp,read)} resolves to jobID.original.afp .

Format:

Default

original

Database name

Job.SnapshotJobFile.NewFileDescriptor

Usage notes:

• This value is case-sensitive.
• For more information about usage type values and how they are used in RICOH ProcessDirector methods, see the information center.

Database name

Job.SourceInputDeviceName

Usage note: If the job was submitted to a workflow directly and not through an input device, this value is blank.

Database name

Job.SourceInputDeviceType

Database name

Job.SpoolFileStem

Usage note: Reference information about advanced tasks that RICOH ProcessDirector provides might refer to this directory as the spool directory for the job. Examples of advanced tasks are using control files, using symbol formulas, and using method calls.

Values:

Not set (default)

2 at left

2 at right

2 at top

2 at bottom

2 at center

Top left

Top left diagonal

Top left horizontal

Top left vertical

Top right

Top right diagonal

Top right horizontal

Top right vertical

Bottom left

Bottom right

Database name

Job.Staple

Usage notes:

• The value set for the Staple property is ignored if the job is AFP and contains an inline form definition or medium map.
• If the job is AFP and uses an external form definition which has values set for the Punch or Staple job property, RICOH ProcessDirector uses the property values and ignores the values in the external form definition. If the job uses an external form definition and these values are unspecified, RICOH ProcessDirector uses the values in the external form definition.
• Not all printers support all stapling options. For some printers, you can indicate whether a printer can staple, but not what stapling patterns it can do.
• On some printers, different options produce the same results; for example, Top left and Top left diagonal.
• On AFP printers, some different options produce the same results even when the printer supports both options because the job submission program does not distinguish between these options.
• Both the Scheduling and the Page Exception tabs include this property; you cannot change its value on the Page Exception tab.

Database name:

Job.StapleRequired

In the Jobs table, sometimes the Current job state value is replaced by the Reason for wait status value, to provide additional information. You cannot use Reason for wait status values for the Current job state when you create notifications, you must use the underlying Current job state value.

Values:

Assigned

RICOH ProcessDirector has assigned the job to a specific printer. The Assigned printer property for the job contains the name of the printer.

Complete

The step has completed its processing of the job. Depending on where the job is in its workflow, RICOH ProcessDirector can immediately queue the job to another step.

Creating

The job is being created.

Deleting

The job is being deleted.

Duplicates detected

One or more barcodes have been scanned multiple times in a ReadBarcodeData step. The duplicates must be resolved during a Reconcile step later in the workflow.

Error

An error occurred as the step processed the job. Someone must do an action on the job before processing can resume.

Error on printer

An error occurred during printing.

Manual, waiting

The workflow for the job includes a manual step during which someone does an action that is external to RICOH ProcessDirector. For example, there is a point in job processing at which the print quality must be checked. The job is waiting for a person to right-click the job in the jobs table, and select Manual start.

Manual, working

The workflow for the job includes a manual step during which someone does an action that is external to RICOH ProcessDirector. For example, there is a point in job processing at which the print quality must be checked. The job is waiting for a person to right-click the job in the jobs table, and select Manual complete.

No matching connector

The job is waiting in the No matching connector state because the values of its properties do not match the rules set on any of the connectors. Review the conditional workflow to determine the cause of the problem.

Printing

The assigned printer is printing the job.

Processing

A step is actively processing the job.

Queued

The job is waiting to be processed by a step.

Reading barcodes

The job is waiting for one or more barcode readers to finish detecting all the documents in the job. Use the Complete barcode step action to see what percent of the documents have been detected. Depending on how the workflow is configured, you might have to complete the barcode step manually to get to the next step in the workflow.

Released

Someone has released a job that was previously in a stopped state.

Retained

The job is waiting for its retention period to expire, at which time RICOH ProcessDirector deletes the job from the system.

Spooling

RICOH ProcessDirector is sending the job to the assigned printer.

Spooled at printer

RICOH ProcessDirector has sent the job to the assigned Ricoh PDF printer or Ricoh TotalFlow printer where it might be held for later printing.

Status changed on printer

Applies to a Ricoh TotalFlow printer only. A user has moved the job from the Active Jobs state to the Inactive Jobs state on the printer console or deleted the job from the printer. Use the Go to next step action to continue processing the job through the workflow. Use the Print again or Restart step action to send the job to the printer again.

Stopped

RICOH ProcessDirector has stopped the job, which prevents further processing. You must do a Continue action on the job before processing can resume.

Unassigned

The job is waiting for RICOH ProcessDirector to assign it to a printer.

Waiting

The job is waiting for the step to process related jobs or other jobs with the same process group ID.

Waiting for Acceptance

The job is waiting for a user to accept or reject the preview print.

Waiting to reconcile

The job is waiting for a user to do the Reconcile action to review the action to take for the documents in the job.

Database name

Job.State

Values:

Queued

The job is waiting for processing by a specific step to begin.

Processing

A specific step is processing the job.

Complete

The processing for a specific step is complete. RICOH ProcessDirector queues the job to the next step, if one exists.

Error

A specific step reported an error. An authorized user must take corrective action before RICOH ProcessDirector can continue processing.

Manual

An authorized user is performing an action for the job.

Administrators and operators cannot change the value of this property.

Valid values are the names of the steps in the workflow for the job. RICOH ProcessDirector updates the value when the job moves from one step to another. You cannot change the value of this property.

Database name

Job.Step

Values:

Not set (default)

RICOH ProcessDirector does not stop the job at any phase.

Prepare

RICOH ProcessDirector stops the job at the first step of the Prepare phase.

Print

RICOH ProcessDirector stops the job at the first step of the Print phase.

Complete

RICOH ProcessDirector stops the job at the first step of the Complete phase.

Database name

Job.StopAtPhase

Usage notes:

• If you changed the default phase names, the names you chose are displayed in the list.
• RICOH ProcessDirector does not stop jobs in the Receive phase.
• After RICOH ProcessDirector stops the job at the specified phase, you can start the job again by selecting it and then using the Continue action.
• If you need to change the Stop when entering phase property after RICOH ProcessDirector starts to process the job, use the Process Again action.

Database name

Job.SubmitTime

Usage note:RICOH ProcessDirector prints the value of this property in the Submit Time field of the header sheet for the job.

Database name

Job.SystemName

Values:

Not set (default)

The type of the job is not specified.

Yes

The job is a test job.

No

The job is not a test job. It is a production job.

Database name

Job.TestJob

Usage note:RICOH ProcessDirector does no special processing for test jobs or for production jobs, and both can exist on the system at the same time.

Operators can use the Pages stacked property in conjunction with the Total pages property to monitor the printing progress of the job on AFP or Ricoh PDF printers. The AFP support feature is required for AFP printers.

Database name

Job.TotalPages

Usage notes:

• If the AFP Support feature is installed, this value can be set by the EnableRepositioning step. The EnableRepositioning step does not count any header pages, separator pages, trailer pages, message pages, or constant forms that might print for the AFP job. Constant forms print an overlay but no page data on the sheet.
• If a PDF job with a JDF job ticket specifying a mixture of duplex and simplex pages is processed by the CountPages step, the blank sides of the simplex sheets are not counted in the Total pages property. The IdentifyPDFDocuments and BuildPDFFromDocuments steps use the Page exceptions for sides property to determine whether to add blank pages to the PDF or add Sides page exceptions to the JDF for simplex sheets. If Sides page exceptions are used, the blank pages in the output are not included in the Total pages count.
• RICOH ProcessDirector prints the value of this property in the Page Count: field of the header sheet for the job on AFP printers.

Operators can use the Sheets stacked property in conjunction with the Total sheets property to monitor the printing progress of the job on AFP or Ricoh PDF printers. The AFP Support feature is required for AFP printers.

Database name

Job.TotalSheets

Usage notes:

• If the AFP Support feature is installed, this value can be set by the EnableRepositioning step. The EnableRepositioning step does not count the sheets that are used for header pages, separator pages, trailer pages, or message pages that might print for the AFP job. Sheets used for constant forms are counted. Constant forms print an overlay but no page data on the sheet. If the CountPages step is used instead of EnableRepositioning, RICOH ProcessDirector calculates the total number of sheets in the CountPages step using the form definition for the job.
• If you change the initial value of the Duplex property for the job to any value other than Not set, the value of the Total sheets property that RICOH ProcessDirector calculates might not match the total number of job sheets that actually stack at the printer. The Sheets stacked property records the number of sheets that are actually stacked at the printer. For example, if the initial duplex value for the job is No, and it is changed to Tumble or Yes, RICOH ProcessDirector issues a warning message about the mismatch. Use the Process Again action to rerun the CountPages or EnableRepositioning step to correct the number of sheets for the new duplex value.
• RICOH ProcessDirector prints the value of this property in the Sheet Count field of the header sheet for the job on AFP printers.

Values:

Step template disabled

The job is waiting in the queued state because the step template for the step is disabled. Authorized users should review the Current step property for the job. Then, make sure that the step template on which the step is based is enabled.

Server unavailable

The job is waiting in the queued state because all servers that can run the step are disabled or disconnected. Authorized users should review the tuning properties for the step template on which the step is based. Determine the server or servers that can run the step, and then start and enable the appropriate server.

The server-unavailable condition can also occur if the workflow for the job includes a step that requires a server that runs on a specific operating system. If no application or secondary server on that operating system is connected to the primary server, RICOH ProcessDirector does not continue to process the job. Check the tuning properties for the step template on which the step is based. Either make sure that servers of the specified types exist and are connected, or change the operating system types for the step.

No matching device

The job is waiting in the unassigned state because the values of its scheduling properties do not match the corresponding values of any printer device. RICOH ProcessDirector cannot schedule the job. Authorized users can modify the scheduling properties of the job so that they match the scheduling properties of a printer or modify the scheduling properties of a printer to match the job. Select the job, and then use the Schedule action.

No matching media

The job cannot move to the next step because the media name or media properties in the JDF job ticket or overrides file for the job cannot be matched to an existing media object. This value is a Reason for wait status value when a job is in the Error state.

Device unavailable

The job is waiting in the unassigned state because there are no enabled and connected devices that match its scheduling properties. RICOH ProcessDirector cannot schedule the job. Review the printer devices that match the scheduling properties of the job, and enable a matching printer. If the printer is not connected, view the properties for the printer and determine its server. Then, use the startaiw command to start the server.

Output bin unavailable

The job is waiting in the queued state because the output bin requested for the job is either full or not installed on the printer.

Database name

Job.WaitReason

Values:

Current workflow (default)

• If you are processing one or more jobs that have used the same workflows again, the jobs continue processing from the step that you specify. That step can be in the current workflow or in another workflow that already processed the job. You can choose the input data stream and whether RICOH ProcessDirector stops a job when it enters the first step of a specific phase.

  If you are processing the job again to pick up job property values that you changed, select a restart step that processes the changed property values. For example, if you changed a control file used by a step, back up to the step where the control file was specified.

• If you are processing multiple jobs again in different workflows, each job continues processing from the first step in its current workflow.

Different workflow

The jobs continue processing from the first step of the workflow that you select from the list.

If the workflow that you are looking for is not in the list, check to see if the workflow is disabled. Either select a different workflow or enable the workflow and try again.

Usage notes:

• If you are processing one or more jobs that are using the same workflow, you can select a phase and step from any workflow that already processed the job. The list starts with the last step that processed the jobs.
• If you are processing one or more jobs and any of the workflows were edited after the jobs started, the Current workflow option is not available. You must select a workflow from the list.

Format:

Length

Up to 256 characters (bytes)

Restrictions

Case-sensitive

Default

No default value

Database name

JobType.ChangeId

Format:

Length

Up to 255 characters (bytes)

Database name

JobType.CreatedBy

Usage notes:

• If you uninstall a feature that added a workflow, RICOH ProcessDirector uses the Workflow source ID property and the Workflow created by property to manage the workflow. workflows that are not used by jobs in the system or referred to by other objects are deleted. Workflows that are still referred to are identified in a message during the uninstallation process so that you can dispose of them properly.
• The Workflow created by property is not propagated to the new workflow when a workflow that was added by a feature is copied.

Database name

JobType.Description

Values:

Yes

The workflow is ready for use in job processing.

No

The workflow is not ready to use in job processing.

RICOH ProcessDirector updates the value whenever authorized users use the administration interface to enable or disable the workflow.

Database name

JobType.Enabled

Format:

Length

Up to 256 characters (bytes)

Restrictions

Case-sensitive

Default

No default value

Database name

JobType.GroupName

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

JobType.ID

Usage note: After RICOH ProcessDirector creates the workflow, you cannot change the name of the workflow. If you need to rename the workflow, create a copy of the workflow and specify the new name. Then delete the original workflow.

Database name

JobType.LastModified

Values:

The list of locations available in the system.

Default

Not set

Database name

JobType.Location

Usage notes:

• When a user tries to process a job again, only the workflows with a Workflow location value that match a Location value for the user are available. If the Archive feature is installed, the Workflow location is used to present the list of workflows used for resubmitting a job or document retrieved from a repository.
• The Workflow location value does not affect the value that can be set on the Requested location property for jobs processed by the workflow.

Database name

JobType.ModifiedBy

Format:

Length

Up to 256 characters (bytes)

Restrictions

Case-sensitive

Default

No default value

Database name

JobType.Owner

Values:

The list of rules that have been created in this workflow.

Not set

No rule has been assigned to the connector.

Database name

JobType.RulesList

Usage notes:

• To use an existing rule as a template for a new rule, select it. Change the rule’s name, its conditions, or both.
• You can have multiple rules with the same name. Rules with the same name can have different conditions, and rules with different names can have the same conditions. If you assign a rule to multiple connectors and then change the conditions for the rule assigned to one connector, the conditions for the rule assigned to the other connectors do not change.
• When you delete a connector that has a rule, the rule remains on the list until you close the workflow.

This property has no value if an authorized user created the workflow without copying a supplied workflow. If a user copied the workflow from a supplied workflow, the Workflow source ID is the same as the name of the supplied workflow. If a feature installed the workflow, the Workflow source ID is the same as the name of the workflow. You cannot change the value of this property.

Database name

JobType.SourceID

Usage note: If you uninstall a feature that added a workflow, RICOH ProcessDirector uses the Workflow source ID property and the Workflow created by property to manage the workflow. Workflows that are not used by jobs in the system or referred to by other objects are deleted. Workflows that are still referred to are identified in a message during the uninstallation process so that you can dispose of them properly.

Database name

JobType.Steps

Format:

Length

Up to 1024 characters (bytes)

Database name

Location.Description

Format:

Length

Up to 32 characters (bytes)

Restrictions

Case-sensitive

Database name

Location.ID

Usage note: You cannot change the name of the location after you create it. If you need to rename the location, create a copy of the location and specify the new name. Then, delete the original location.

Database name

Location.LastModified

Database name

Location.ModifiedBy

Values:

UTF8 (default)

Eight-bit UCS Transformation Format.

ISO8859_1

Latin Alphabet Number 1.

ISO8859_15

Latin Alphabet Number 9.

EUC_JP

JISX 0201, 0208, and 0212, EUC encoding Japanese.

Database name

LPD.CodePage

Format:

Length

Up to 1024 characters (bytes)

Database name

Media.Description

Database name

Media.GeneralId

Usage notes:

• This property applies only to Ricoh PDF printers.
• If the media ID is not available on the printer, the field is empty.
• The General ID is displayed only if you select the Printer checkbox in the Media to use field when creating a new printer.
• If the Send media name in job ticket value is set to Yes, the General ID value is overwritten by the media name.

Format:

Length

1-128 characters (bytes)

Database name

Media.ID

Values:

A list of all the system media.

Database name

Media.MappedMedia

Usage note: Click the Edit icon to display the full list of system media.

Values:

A list of printers whose Media to use values are set to Printer.

All printers

Show the mappings defined for all printers with the Media to use value set to Printer.

Database name

Media.MappedMedia.PrinterFilter

Values:

A list of all the printers in the system that have the Media to use property set to Printer.

Database name

Media.Printer

Usage note: If you need to change this property for an existing printer media, copy the printer media and select a new printer name. Then delete the original printer media.

Format:

Length

1–128 characters (bytes)

Database name

Media.ProductId

Usage notes:

• When Media Matching is set to Use media product ID or media name, RICOH ProcessDirector tries to match media in the JDF job ticket submitted with the job based on the media product ID. If RICOH ProcessDirector does not find a matching product ID, it tries to match media in the job ticket based on the media name.

  RICOH ProcessDirector first checks whether the JDF job ticket specifies a media product ID. If it does, RICOH ProcessDirector looks for a media object with the same product ID.

  If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the job property for job media or page-exception media.

  If RICOH ProcessDirector does not find a match, it looks for a media object with the media name specified in the JDF job ticket. If RICOH ProcessDirector finds a match, it puts the name of the matching media object in the job property for job media or page-exception media.

• When RICOH ProcessDirector sends a job with a JDF job ticket to a Ricoh PDF printer, RICOH ProcessDirector looks for media product IDs:
  1. First RICOH ProcessDirector looks in the mediamap.cfg file for a product ID to associate with a media name. The mediamap.cfg file maps media names to media product IDs separately for different printers. For example, this entry maps media named A4 Blue to media product ID 39872 only when the job is sent to the printer named RicohPro9110: RicohPro9110,A4 Blue,39872

     If another printer uses a different media product ID for A4 Blue paper, a different entry in the file provides the mapping. For example: RicohPro8120,A4 Blue,239872

     If RICOH ProcessDirector finds an entry, it takes the product ID in the entry and associates it with the media name in the job ticket.

  2. If RICOH ProcessDirector does not find an entry, it looks for a Product ID in the media object associated with the media name. If RICOH ProcessDirector finds a Product ID value, it associates the product ID with the media name in the job ticket.

  If RICOH ProcessDirector does not find a match, it does not send a product ID for that media name in the job ticket.

Format:

Length

Up to 255 characters (bytes)

Database name

Media.SourceID

Format:

Data type

Number from 1 to 9999.99; fractional values allowed.

Database name

MediaSize.Height

Usage note: Either the media height or the media width must be at least 2 millimeters larger or smaller than any other media size.

Values:

Inches

Millimeters

Points

Database name

MediaSize.Units

Usage note: The default value is Inches or Millimeters, depending on the language setting of your browser.

Format:

Data type

Number from 1 to 1024; fractional values allowed.

Database name

MediaSize.Width

Usage note: Either the media width or the media height must be at least 2 millimeters larger or smaller than any other media size.

Database name

MediaType.Color

Usage notes:

• None means that the media has no color; for example, a transparency. This is different from Not set, which means that the color is not specified.
• Select Color for a color name that is not available in the list of values.

Format:

Length

1-255 characters (bytes)

Database name

MediaType.CreatedBy

Format:

Length

1-1024 characters (bytes)

Database name

MediaType.Description

Database name

MediaType.Details

Values:

Not set (default)

Coated

Glossy

High gloss

Matte

None

Polymer

Satin

Semigloss

Silver

Database name

MediaType.FrontCoating

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Database name

MediaType.ID

Values:

Not set (default)

There is no restriction on which side of the media printers can print on. Printers can print on both sides of this media.

Back

Printers can print only on the back side of this media.

Both

Printers can print on both sides of this media.

Front

Printers can print only on the front side of this media.

Neither

Printers cannot print on this media.

Database name

MediaType.ImagableSide

Usage note: Use the Neither option to prevent printing on certain materials, such as preprinted promotional materials that are loaded in a paper bin so they can be included in the output.

Database name

Media.LastModified

Database name

Media.ModifiedBy

Values:

Not set (default)

Opaque

Light does not pass through the media.

Translucent

Only some light passes through the media.

Transparent

Enough light passes through the media that you can clearly see through it.

Database name

MediaType.Opacity

Values:

Yes

The media is preprinted.

No

The media is not preprinted.

Database name

MediaType.Preprinted

Values:

Yes

The media is prepunched.

No

The media is not prepunched.

Database name

MediaType.Prepunched

Values:

Yes

The media is recycled.

No

The media is not recycled.

Database name

MediaType.Recycled

Format:

Data type

Integer from 0 to 100

Database name

MediaType.RecycledPercentage

Values:

Not set (default)

Bond

Cover

Database name

MediaType.Stock

Database name

MediaType.Texture

Format:

Data type

Integer from 1-999

Database name

MediaType.Weight

Format:

Data type

Non-negative integer

Database name

OutputBin.Capacity

Format:

Length

Up to 255 characters (bytes)

Database name

OutputBin.Description

Database name

OutputBin.Enabled

Database name

OutputBin.HasSpaceRemaining

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Database name

OutputBin.Id

Format:

Data type

Non-negative integer

Database name

OutputBin.Level

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Database name

OutputBin.PrinterName

Database name

OutputBin.Unit

Values:

Connected

The connection between the server and the output device is active. The output device can receive data.

Disconnected

The connection between the server and the output device is not active. The output device cannot receive data.

Database name

OutputDevice.Connected

Format:

Length

1-255 characters (bytes)

Restrictions

None

Default

Not set

Database name

OutputDevice.CustomerName

Format:

Length

Up to 1024 characters (bytes)

Database name

OutputDevice.Description

Values:

Yes

RICOH ProcessDirector can schedule jobs to the output device.

No (default)

RICOH ProcessDirector cannot schedule jobs to the output device.

You can use the Disable and Enable actions of the RICOH ProcessDirector interface to change the value of this property.

Database name

OutputDevice.Enabled

Usage note: A disabled output device can still send files if the connection for the output device is active. The Connection status property describes whether the output device is connected.

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Database name

OutputDevice.ID

Usage notes:

• After RICOH ProcessDirector creates the output device, you cannot change the name of the device. If you need to rename the device, create a copy of the output device and specify the new name. Then, delete the original output device.

Database name

OutputDevice.LastModified

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

OutputDevice.Location

Database name

OutputDevice.ModifiedBy

Database name

OutputDevice.Type

Values:

Not set

The code page of the system locale

UTF8

Eight-bit UCS Transformation Format

ISO8859_1

Latin Alphabet Number 1

ISO8859_15

Latin Alphabet Number 9

EUC_JP

JISX 0201, 0208, and 0212, EUC encoding Japanese

Database name

PassThroughPrinter.CodePage

Usage note: This property applies only to Passthrough printers.

On Windows, you can use the ${getCurrentFile(pdf)} symbol to pass the name of the print file in the spool directory for the job:

lpr -S printer_IPaddr -P PASS ${getCurrentFile(pdf)}

On Linux, you can also use the ${Job.Copies} symbol to pass the Job copies requested property on the lpr command line with its -# option:

lpr -P printerName -#${Job.Copies} ${getCurrentFile(pdf)} or lprafp -pprinterName -#${Job.Copies} ${getCurrentFile(pdf)}

Database name

PassThroughPrinter.Command

Usage notes:

• This property applies only to Passthrough printers. If you are sending banner pages to a Passthrough printer, the printer device must support the PDF data stream.
• On Windows, the -P option specifies the name of the print queue.
• On Linux, you must pass all job properties that you want the Passthrough printer to use. You can pass them in the printer command itself (as in these examples), in a script, or in the control file template. Printers support different lpr options, so the printer might not honor all options requested.
• On Linux, different printer commands use different options. For example, the printer option of the Linux lpr command is upper case -Pwith an optional space between the option and the printer name; while the printer option of the lprafp command is lower case -pwithout a space between the option and the printer name.

Format:

Length

Up to 255 characters (bytes)

Database name

PassThroughPrinter.ControlFileTemplate

Usage notes:

• This property applies only to Passthrough printers.
• The content and format of the information that the control file contains depend on the program that uses the control file.
• RICOH ProcessDirector supplies passthru.cfg as a default control file template: On Linux, this file is in the /aiw/aiw1/control_files/passthru directory. On Windows, this file is in the C:\aiw\aiw1\control_files\passthru directory. The sample control file template maps RICOH ProcessDirector job properties to sample print command options. For example, the control file template contains this statement:

  JobCopies = ${Job.Copies}

  This statement sets JobCopies to the value of the Job copies requested property. JobCopies is the RICOH ProcessDirector database name of the job property. You can add and delete statements in the PassThroughPrinter.cfg file as required.

• To use the control file created with this template in the Printer command property, use the getFileName method with this syntax: ${getFileName(passthru.control,text,read)}

  Do not use the getControlFileName method.

• You must pass all job properties that you want the Passthrough printer to use. You can pass them in the control file template or in the printer command.

Values:

Yes

If header or trailer pages are enabled, they are combined with the print file and one file is sent to the printer.

No

If header or trailer pages are enabled, separate files for the banner pages and the print files are sent to the printer.

Default

Yes

Database name

PassThroughPrinter.MergeBanner

Usage note: This property applies only to Passthrough printers. A similar property with the same name (JdfOutputPrinter.MergeBanner) applies to Ricoh PDF printers.

Format:

Length

Up to 128 characters (bytes)

Restrictions

Separate the values with commas. For example 0,4.

Database name

PassThroughPrinter.ValidRCs

Usage notes:

• This property applies only to Passthrough printers.
• When RICOH ProcessDirector receives a successful return code from issuing the printer command for a job, it updates the page and sheet counters to reflect successful stacking of the entire job because no more precise information is available from the printer.

Database name

Printer.EnhancePDFFilter

Usage notes:

• To type an action in the text area, use this syntax:

  Action -param1 value1 -param2 value2

  where Action is the name of an action, -param1 and -param2 are parameters, and value1 and value2 are the values of the parameters. Different actions have different parameters.

  Type each action, its parameters, and the parameter values on a separate line.

  This example has three actions: RemovePages, AddStamps, and RotatePages.

  RemovePages -pages 3-4,9,12-n

  AddStamps -stampsCSV /aiw/aiw1/control_files/actions/stamp1.csv

  RotatePages -rotate 270 -pagetype landscape

  The example specifies a directory path on Linux.

  This example has one action: CheckOrientation.

  CheckOrientation -ControlUnitJDF TotalFlow

  In this example, JDF appropriate for the Ricoh TotalFlow print server is created for the job based on the orientation value determined by the CheckOrientation program.

  For more information about supported actions and their parameters, see the topic about the EnhancePDF step template in the RICOH ProcessDirector Information Center. The actions that can be specified on that step template can also be specified on this printer property.

• The actions are executed in the order that they appear on the list, from top to bottom.
• An action can appear on the list more than once, with different parameter values.

Format:

Length

Up to 255 characters (bytes)

Default

public

Database name

Printer.CommunityName

RICOH ProcessDirector updates this value when the user interface is refreshed. You cannot change this value.

Database name

Printer.CurrentJobID

RICOH ProcessDirector updates this value when the user interface is refreshed. You cannot change this value.

Database name

Printer.CurrentJobName

RICOH ProcessDirector updates this value when the user interface is refreshed. You cannot change this value.

Database name

Printer.CurrentJobPagesStacked

RICOH ProcessDirector updates this value when the user interface is refreshed. You cannot change this value.

Database name

Printer.CurrentJobProgress

RICOH ProcessDirector updates this value when the user interface is refreshed. You cannot change this value.

Database name

Printer.CurrentJobTotalPages

Database name

Printer.CurrentStatus

Default

Not set

Database name

Printer.CustomerName

Usage notes:

• If the customer name printer property has no value, the printer accepts jobs that specify any customer name.
• To see the candidate jobs for a printer, right-click the printer in the printers portlet on the Main page of the RICOH ProcessDirector interface and select Show Candidate Jobs. RICOH ProcessDirector opens a jobs table including only those jobs whose scheduling properties, including the Customer name property, match the scheduling properties of the selected printer.

Database name

Printer.Description

Usage notes:

• You cannot change the value of this property if there is a job assigned to the printer.
• RICOH ProcessDirector automatically shuts down and restarts the printer when you change the printer description.

Values:

Yes (default)

RICOH ProcessDirector can schedule jobs to the printer.

No

RICOH ProcessDirector cannot schedule jobs to the printer.

Database name

Printer.Enabled

Usage notes:

• On Linux, if the parent server for a printer is a secondary server and that server stops or restarts, RICOH ProcessDirector disables the printer.
• Shutting down the RICOH ProcessDirector primary server disables all printers by default. If you want a printer that was enabled before the shutdown to be enabled after the system is restarted, you can change the Remember enabled status of printers property value to Yes on the System Settings page.

Default

250

Database name

Printer.FirstSegmentSize

Usage note:

• When you create a Ricoh PDF printer with Data stream to send set to JDF/PDF and you keep the default values for First PDF segment size and PDF segment size, RICOH ProcessDirector clears the values when you click OK. Jobs are not split into segments.

  If you right-click the Ricoh PDF printer and select Properties, the values for First PDF segment size and PDF segment size are blank. To split jobs into segments, enter values for First PDF segment size and PDF segment size. RICOH ProcessDirector does not clear the values when you click OK.

  When Data stream to send is set to JDF/PDF, we recommend that you do not set values for segment size when you print normal-size jobs.

Values:

Yes

The printer can fold jobs.

No

The printer cannot fold jobs.

Not set (default)

RICOH ProcessDirector assumes that the printer can fold jobs.

Database name

Printer.FoldCapable

Values:

Yes (default)

Header pages print.

No

No header pages print for jobs that are sent to this printer.

Database name

Printer.HeaderExit

Usage notes:

• To print header pages on Passthrough printers, this property must be set to Yes and the printer command must contain the correct options.
• The file that the Header page configuration file job property specifies controls the information that prints on the header page.
• The Header copies job property controls how many copies of the header page print.
• You cannot change the value of this property if there is a job assigned to the printer.
• RICOH ProcessDirector automatically shuts down and restarts the AFP or PCLOut printer when you enable or disable header pages.

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive. Do not start the printer name with a dash (-).

Default

Not set

Database name

Printer.ID

Usage notes:

• After RICOH ProcessDirector creates the printer, you cannot change the printer name. If you need to rename a printer, create a copy of the printer and specify a new name. Then, delete the original printer.

Database name

Printer.InputTray

Usage note: This property is valid only for cut sheet printers.

Default

System; this value is the name of the primary server that the RICOH ProcessDirector installation program creates.

Database name

Printer.Instance

Usage notes:

• You cannot change the value of this property when there is a job assigned to the printer.
• RICOH ProcessDirector automatically shuts down and restarts the printer when you change the server.
• Custom PDF printers and Ricoh PDF printers must be defined on a printer server that uses the Linux or Windows operating system. If the printer is a Ricoh TotalFlow printer, you can use any server as the printer server.
• You are not required to tune the PrintJobs step when you choose a secondary server for this value.

Format:

Content

Greater than symbol (>) or a less than symbol ( <), followed by a number from 0 through 100000000.

Restrictions

Do not include commas in the value.

Default

Not set

Database name

Printer.JobSize

Usage notes:

• RICOH ProcessDirector calculates the size of a job by multiplying the value of its Job copies requested job property by the value of its Current total sheets job property.
• PDF jobs that have been processed by the CountPages step have values set for their Job Size properties. As a result, they can use Printer job size for scheduling jobs to Passthrough or Ricoh PDF printers.
• Jobs in other data streams (such as PostScript or PCL) do not have a value set for the Job Size property, so the Printer job size property is not recommended for scheduling those jobs to Passthrough printers.

Values:

• Not set. The program uses the language that the locale setting in the RICOH ProcessDirector server specifies.
• English (en_US)
• French (fr_FR)
• German (de_DE)
• Italian (it_IT)
• Japanese (ja_JP)
• Portuguese (pt_BR)
• Spanish (es_ES)

Database name

Printer.Language

Usage notes:

• You cannot change the value of this property if there is a job assigned to the printer.
• RICOH ProcessDirector automatically shuts down and restarts the AFP or PCLOut printer when you change the Printer language.

Database name

Printer.LastModified

Format:

Length

1-32 characters (bytes)

Restrictions

Case-sensitive

Default

Not set

Database name

Printer.Locations

Format:

Maximum value

999

Database name

Printer.MaxConcurrentJobs

Usage notes:

• The default value for Passthrough printers is 1.
• The default value for AFP printers is 30.
• The default value for PCLOut printers is 30.
• The default value for PDF printers is 30.
• If printer performance seems degraded, try reducing the number of concurrent jobs. If the printer is idle often, try increasing the number of concurrent jobs.
• You cannot change the value of this property if there is a job assigned to the printer.
• RICOH ProcessDirector automatically shuts down and restarts the AFP or PCLOut printer when you change the maximum number of concurrent jobs.

Values include a list of the media that is defined in the system and these special values:

All media objects

The printer supports all defined media.

Ready media objects (Default)

The printer supports the media that the printer reports as loaded.

Database name

Printer.Media

Usage notes:

• If this property is set to Ready media objects for a printer, only the media loaded in that printer is used. For example, if a printer is loaded with A4 media and a job requests Letter media, the job cannot be scheduled on that printer. If no media is loaded on the printer, jobs requesting any media can be scheduled on that printer.
• If this property is set to one or more specific media, only jobs that request that media can be scheduled to the printer. For example, if this value is A4, you cannot schedule a job that requests Letter paper to the printer.

System media is defined in RICOH ProcessDirector to represent all the media that jobs request. Printer media can be imported from the paper catalog on the printer or created manually in RICOH ProcessDirector. Printer media includes only the media that is used with a specific printer.

System media and printer media might have different names for the same physical media. If the media names are different, you can create a media mapping to indicate that they represent the same physical media.

Print jobs request media using system media names. If media mappings exist, RICOH ProcessDirector can send media information from the printer media to the printer along with the job.

Values:

Printer (default for Ricoh PDF, Ricoh TotalFlow, and Custom PDF printers)

RICOH ProcessDirector uses a media mapping to translate the requested system media to the printer media that it is linked to. The printer media information is sent to the printer. If a media mapping does not exist for a printer, the job does not schedule to that printer.

System (default for other printer types)

RICOH ProcessDirector sends system media information to the printer for jobs. Media mappings are not required.

Database name

Printer.MediaCatalog

Usage note:

• This property is only available for Ricoh PDF, Ricoh TotalFlow, and Custom PDF printers.
• AFP, PCLOut, and Passthrough printers only use System media.
• Xerox PDF and Kodak PDF support only System media.

Database name

Printer.MediaReady

Values:

Generic continuous form

The printer is a continuous forms printer that uses roll-fed paper.

Generic cut sheet

The printer is a cut sheet printer that uses individual sheets of paper loaded in drawers or trays in the printer.

Not set

No paper type is set for the printer.

Database name

Printer.Model

Usage note:RICOH ProcessDirector does no special processing for any of the values.

Format:

Restrictions

Case-sensitive

Default

Not set

Database name

Printer.Model.Specific

Usage note: Type exactly the same string for printers of the same model, making sure to use identical capitalization. If you install the Reports feature, you can group the data from all printers with the same Printer model value.

Database name

Printer.ModifiedBy

Values include:

Default Bins (Default)

If Printer model is set to a supported IBM or InfoPrint printer model, RICOH ProcessDirector assigns the supported bins based on output bins that the printer model supports. Otherwise, the printer supports all defined output bins.

All bins

The printer supports all defined output bins.

Database name

Printer.OutputBin

Values:

Yes

The printer can do perfect binding.

No

The printer cannot do perfect binding.

Not set (default)

RICOH ProcessDirector assumes that the printer can do perfect binding.

Database name

Printer.PerfectBindingCapable

Values:

Yes

The printer can punch jobs.

No

The printer cannot punch jobs.

Not set (default)

RICOH ProcessDirector assumes that the printer can punch jobs.

Database name

Printer.PunchCapable

Usage note: If a job specifies a punch pattern that the printer does not support, the printer applies its best equivalent.

Format:

Data type

Integer from 0-9999. 0 means that the printer never tries to connect again if the first try fails.

Default

1

Database name

Printer.Retry

Format:

Default

5 seconds

Database name

Printer.RetryInterval

Usage note: The printer remains in the Waiting to connect state for the duration of time that this property specifies.

Values:

Yes

The printer can do ring binding.

No

The printer cannot do ring binding.

Not set (default)

RICOH ProcessDirector assumes that the printer can do ring binding.

Database name

Printer.RingBindingCapable

Values:

• Not set (default)
• 12
• 24
• 36

Database name

Printer.S2VBarcode

Usage notes:

• If the value of this property is set to a number, the printer object checks its print queue after every job that it prints. If no additional jobs are scheduled to this printer, RICOH ProcessDirector sends the selected number of blank pages to the printer.

  The paper advances and moves the printed output out of the printer as far as needed to continue your process. It does not add pages to your print job and no new job appears in the Jobs table.

• If you use side verification marks on an InfoPrint 5000 to make sure that the colors line up correctly, use this property to push all pages of the last job in the queue through final color verification.

Default

500

Database name

Printer.SegmentSize

Usage notes:

• When you create a Ricoh PDF printer with Data stream to send set to JDF/PDF and you keep the default values for First PDF segment size and PDF segment size, RICOH ProcessDirector clears the values when you click OK. Jobs are not split into segments.

  If you right-click the Ricoh PDF printer and select Properties, the values for First PDF segment size and PDF segment size are blank. To split jobs into segments, enter values for First PDF segment size and PDF segment size. RICOH ProcessDirector does not clear the values when you click OK.

  When Data stream to send is set to JDF/PDF, we recommend that you do not set values for segment size when you print normal-size jobs.

• If a PDF job includes a JDF job ticket, both the job and the job ticket are split into segments.
• To get the best production from your printer, try different values for segment sizes until you discover which values work best.
• RICOH ProcessDirector adjusts segment sizes to account for duplex printing, page exception stapling, and other constraints. If the entire job must be stapled or bound, RICOH ProcessDirector does not segment the job.
• RICOH ProcessDirector reports printing status for the entire job, not for individual segments within the job.
• If the AFP Support feature is installed, the AFP segment size property is specified on the Print tab in the job properties notebook.

Database name

Printer.SerialNumber

Length

Up to 200 characters (bytes)

Restrictions

Do not use these characters in the name: \ (backslash) " (double quote) ` (backtick)

Database name

Printer.SetupName

Usage note:

• Sometimes presets are also referred to as setups.
• You can use this value to schedule a job that has the same value for its Preset name property.
• This value is not sent to the printer with print jobs. If your printer supports sending a preset request with a print job, do not use Preset name as a scheduling property; leave this property blank.

Values:

Connected

RICOH ProcessDirector uses SNMP to monitor the printer and is connected to SNMP.

Disconnected

RICOH ProcessDirector uses SNMP to monitor the printer, but cannot connect to SNMP. If the printer is a Passthrough or PCLOut printer, the Printer TCP/IP address or host name property might not be set.

Disabled

RICOH ProcessDirector does not use SNMP to monitor the printer.

Database name

Printer.SNMPStatus

Values:

Length

Up to 255 characters (bytes)

Database name

Printer.SNMP.AuthPassword

Usage notes:

• This value is required for the Medium and Maximum security levels.
• If you set the Privacy password, you must also set the SNMP password.

Values:

MD5 (default)

HMAC-MD5-96 authentication protocol.

SHA

HMAC-SHA-96 authentication protocol.

Database name

Printer.SNMP.AuthType

Usage notes:

• This value is required for the Medium and Maximum security levels.

Database name

Printer.SNMP.ContextName

Values:

No

If the SNMP v3 connection fails, do not connect to the printer.

Yes

If the SNMP v3 connection fails, use SNMP v1 to connect to the printer.

Database name

Printer.SNMP.Fallback

Values:

DES

CBC-DES privacy protocol.

AES-128

CBC-AES privacy protocol.

Database name

Printer.SNMP.PrivEncryptType

Usage notes:

• This value is required only for the Maximum security level.

Values:

Length

Up to 255 characters (bytes)

Database name

Printer.SNMP.PrivPassword

Usage notes:

• This value is required only for the Maximum security level.
• If you set the Privacy password, you must also set the SNMP password.

Values:

Minimum

The SNMP user name is required.

Medium

The SNMP user name and SNMP password are required.

Maximum

The SNMP user name, SNMP password, and Privacy password are required.

Database name

Printer.SNMP.SecurityLevel

Values:

Length

Up to 32 characters (bytes)

Database name

Printer.SNMP.UserName

Usage notes:

• This value is required for all security levels.

Values:

SNMP v1 (default)

SNMP v3

Database name

Printer.SNMP.Version

Values:

Yes

The printer can staple jobs.

No

The printer cannot staple jobs.

Not set (default)

RICOH ProcessDirector assumes that the printer can staple jobs.

Database name

Printer.StapleCapable

Usage notes:

• If a job specifies a staple pattern that the printer does not support, the printer applies its best equivalent.
• This property is valid only for cut sheet printers.

Values:

Disconnected

The connection between the server and the printer is not active. An authorized user can specify another server, if one is available, to establish a new connection.

Needs attention

An authorized user must perform an action at the printer before printing can resume.

Printing

The printer is currently printing a job.

Ready

The printer is ready and waiting for a job to print.

Stopped

An authorized user has stopped the printer through the RICOH ProcessDirector interface. A user must start the printer through the interface before the printer can receive and print new jobs.

Waiting to connect

A connection error occurred between the server and the printer. The printer is waiting the amount of time set in the Retry interval property before trying to connect again.

Database name

Printer.Status

Database name

Printer.SystemName

Format:

Length

Up to 255 characters (bytes)

Restrictions

All printer types support IPv4 addresses and host names. AFP printers also support IPv6 IP addresses and hostnames.

Database name

Printer.TCPIP.Address

Usage notes:

• If the Use SNMP property is Yes, but this value is not set, RICOH ProcessDirector does not try to connect to SNMP and the SNMP status is Disconnected.
• If a job is assigned to the printer, do not change the value of this property.
• RICOH ProcessDirector automatically shuts down and restarts the AFP or PCLOut printer when you change the TCP/IP address or host name.

Values:

Yes

Trailer pages print.

No (default)

No trailer pages print for jobs that are sent to this printer.

Database name

Printer.TrailerExit

Usage notes:

• To print trailer pages on Passthrough printers, this property must be set to Yes and the printer command must contain the correct options.
• The file that the Trailer page configuration file job property specifies controls the information that prints on the trailer page.
• The Trailer copies job property controls how many copies of the trailer page print.
• You cannot change the value of this property if there is a job assigned to the printer.
• RICOH ProcessDirector automatically shuts down and restarts the AFP or PCLOut printer when you enable or disable trailer pages.

Values:

Yes

RICOH ProcessDirector uses SNMP to monitor the printer. This is the default value.

No

RICOH ProcessDirector does not use SNMP to monitor the printer.

Database name

Printer.UseSNMP

Values:

No

RICOH ProcessDirector does not get tray information from the printer.

Yes (default)

RICOH ProcessDirector gets tray information from the printer.

Database name

Printer.UseSnmpUpdateMedia

Usage notes:

• For all printer types, RICOH ProcessDirector can use Simple Network Management Protocol (SNMP) to retrieve media that is loaded in the printer.
• For Ricoh PDF printers, RICOH ProcessDirector automatically requests the media information from the printer using Job Messaging Format (JMF). Based on the type and version of the controller on the printer, up to two media lists can be returned: catalog media and loaded media. If a loaded media list is not returned from the printer, RICOH ProcessDirector requests the loaded media information using SNMP.

Database name

Printer.Version

Database name

ReprintGroup.Pages

Values:

Red

Orange

Gray

Blue

Purple

Not set (default)

The color of the step matches the color of the phase it is in.

Database name

Step.Color

Usage note: If you specify a value other than Not set and you drag the step into a different phase, it retains the color you specified.

Format:

Length

Up to 1024 characters (bytes)

Default

The description of the step template on which the step is based.

Database name

Step.Description

When you add a step to a workflow, type a step name in the required field. By default, the name is the same as the step template name.

Length

1–32 characters (bytes)

Restrictions

Case-sensitive