Database property names for jobs
Some messages about jobs refer to job properties by their database names, which begin
with Job. You can use the database property names for job properties in symbol formulas that
you specify for RICOH ProcessDirector external programs. You can also specify symbol formulas for job properties in RICOH ProcessDirector control files.
Some of the values that you see in lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you make some requests using web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.
In the Editable column:
- Yes means that you can change the value after the job has been submitted.
- No means that you cannot change the value.
In the Job ticket column:
- Yes means that the property can be set from one or more values in the job ticket that is used to submit the job.
- No means that the property cannot be set from values in the job ticket.
Job properties
Database name | Notebook tab: field name | Brief description | Internal values | Editable | Job ticket |
---|---|---|---|---|---|
Job.Add.BlankPage | Add blank page | Adds a blank page at the end of each PDF file with an odd number of pages when combining PDF files contained in a ZIP file. |
|
Yes | No |
Job.Collate | Print: Collation | Specifies the type of collation that the printer uses when printing multiple copies of the job. |
|
Yes | No |
Job.Binding | Binding | Set the binding settings for the job you are printing. |
|
Yes | Yes |
Job.Cjfx.FailOnMissingXpath | XML: Stop when no matching elements | Specifies whether a step based on the CreateJobsFromXML step template puts a job in the error state when no elements match the XPath expression. |
|
Yes | No |
Job.Cjfx.FileToSplit | XML: XML input file | Specifies the name of the XML file that a step based on the CreateJobsFromXML step template uses as input to create jobs. | Yes | No | |
Job.Cjfx.TypeOfJob | XML: Create as child job | Specifies whether a step based on the CreateJobsFromXML step template creates child jobs or independent jobs from the original job. |
|
Yes | No |
Job.Cjfx.Workflow | XML: Workflow for new jobs | Specifies the workflow that a step based on the CreateJobsFromXML step template submits new XML jobs to. | Yes | No | |
Job.Cjfx.Xpath | XML: XPath expression to create jobs | Specifies an XPath expression that identifies an element. Each time a step based on the CreateJobsFromXML step template finds a matching element in the XML input file, it creates an XML file and submits it as a job. | Yes | No | |
Job.CompressAllFiles | Job Defaults tab of RetainCompletedJobs step template property notebook: Compress all files | Specifies whether to compress all spool and checkpoint files for the job when the job is retained. | Yes | No | |
Job.CompressFilePatterns | Job Defaults tab of CompressFiles step template property notebook: Compress file patterns | Specifies the job files that the step compresses. | Yes | No | |
Job.Copies | General and Status: Job copies requested | Contains the number of job copies that have been requested. | Yes | Yes | |
Job.CopiesStacked | Status: Job copies stacked | Contains the current number of job copies that have completed printing and that have reached the output stacker of the printer device. | No | No | |
Job.CreateJobFromFiles.JobType | Create Job: Workflow | Specifies the workflow to use for the child job. | Yes | No | |
Job.CreateJobFromFiles.JobName | Create Job: Job name | Specifies the name of the child job. | Yes | No | |
Job.CreateJobFromFiles.DestUsage | Create Job: Group ID | Specifies the role of the destination file. | Yes | No | |
Job.CreateJobFromFiles.DestType | Create Job: Group size | Specifies the destination file type. | Yes | No | |
Job.CreateJobFromFiles.Source1 | Create Job: First source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CreateJobFromFiles.Source2 | Create Job: Second source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CreateJobFromFiles.Source3 | Create Job: Third source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CreateJobFromFiles.Source4 | Create Job: Fourth source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CreateJobFromFiles.Source5 | Create Job: Fifth source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CreateJobFromFiles.Source6 | Create Job: Sixth source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CreateJobFromFiles.Source7 | Create Job: Seventh source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CreateJobFromFiles.Source8 | Create Job: Eighth source file | Specifies the full path and name of the input file used to create the job. | Yes | No | |
Job.CurrentPrinter | Status: Assigned printer | Contains the name of the printer that RICOH ProcessDirector has assigned to print this job. | No | No | |
Job.CustomerName | Scheduling: Customer name | Identifies the customer who is associated with this job. | Yes | Yes | |
Job.Description | General: Job description | Contains text that describes the job. | Yes | Yes | |
Job.DownloadFile | URL for download file | Specifies the URL of the file to download. | Yes | No | |
Job.DownloadFileToCreate | Path to downloaded file | Specifies the file name and location where RICOH ProcessDirector saves the file. | Yes | No | |
Job.Duplex | General: Duplex | Indicates whether duplexed printing is active for the job and, if so, the type of duplexed printing. |
|
Yes | Yes |
Job.EJB.SMTPserver | SMTP server type | Specifies whether you want this step to use the system default email server or an alternate email server. |
|
Yes | No |
Job.EmailAddressBCC | Blind copy address | One or more email addresses to send a blind copy of the email to. | Yes | No | |
Job.EmailAddressCC | Copy address | One or more email addresses to send a copy of the email to. | Yes | No | |
Job.EmailAddressTo | Recipient address | One or more email addresses to send the job to. | Yes | No | |
Job.EmailMessage | Message | Specifies text to include in the body of the email. | Yes | No | |
Job.Email.PageRange | Page range to send | Shows a numeric string that describes which pages in the print file are extracted, made into a separate file, and attached to the email. | Yes | No | |
Job.Email.RangeData Stream | Page range data stream | Specifies the data stream of the print file used to create the file with the page range indicated in the Page range to send property. |
|
Yes | No |
Job.Email.Secure Connection | Secure connection | Specifies whether the connection with the mail server should use SSL or TLS security. |
|
Yes | No |
Job.EmailSendFrom | Sender address | The email address used in the From: field of the email. | Yes | No | |
Job.EmailSubject | Subject line | Specifies the text to include in the subject line of the email. | Yes | No | |
Job.External.CodePage | External: External program code page | Specifies the code page to use to write the contents of the files that are sent to the external command for processing, such as the control file template. This code page is also used to read messages that the external command writes to stderr and stdout, as well as other files that the external command might create. |
|
Yes | No |