Database property names for printers

Messages about printers might refer to properties by their database names. Not all properties are applicable to all types of printers.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that Ricoh ProcessDirector uses internally. When you make some requests using Web services or set values using an overrides file, you must use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that an authorized user can change the value after the printer has been created.
  • No means that an authorized user cannot change the value.

Printer properties

Database name Notebook tab: field name Brief description Internal values Editable
CustomPDFPrinter.ImportPrinter General: Custom PDF Printer Server Select the printer server where you want to define a Custom PDF printer device.   No
CustomPDFPrinter.PrinterType General: Custom printer type Specifies the type of printer to define as a Custom PDF printer object.   Yes
JdfDirectPrinter.VPName General: Virtual printer name Specifies the name of the virtual printer as defined on the Ricoh TotalFlow printer object.   Yes
JdfOutputPrinter.PrinterType General: Type of printer Specifies the printer type. The list of all printers that can be connected as Ricoh PDF printers. Yes
JdfOutputPrinter.BannerPage.Tray Banner Pages: Banner page input tray Specifies the printer’s input tray that holds the paper for header and trailer pages.   Yes
JdfOutputPrinter.JobStatusPolling General: Job status polling interval Defines how frequently the Ricoh PDF or Custom PDF printer requests updates about the status of a job.   Yes
JdfOutputPrinter.MergeBanner Banner Pages: Merge banner pages into PDF print file Specifies whether or not header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
JdfOutputPrinter.Port General: Printer port Specifies the communications port for the printer.   Yes
JdfOutputPrinter.URL General: Printer URL Specifies the host name or TCP/IP address that is used to communicate with the printer.   Yes
PassThroughPrinter.CodePage General: Code page Specifies the code page that the printer uses to interpret the printer command.   Yes
PassThroughPrinter.Command General: Printer command The command that is used to submit jobs to the printer.   Yes
PassThroughPrinter. ControlFileTemplate General: Control file template Specifies the full path name of the control file template that maps job properties to printer command parameters.   Yes
PassThroughPrinter.MergeBanner Banner Pages: Merge banner pages into PDF print file Specifies whether or not header and trailer banner files are merged into the PDF print file or sent to the printer as separate files.
  • No
  • Yes
Yes
PassThroughPrinter.ValidRCs General: Valid return codes Contains a list of return code values that the printer command can issue to indicate that the job printed successfully.   Yes
Printer.CommunityName SNMP: Community name Specifies the name of the Simple Network Management Protocol (SNMP) community to which the printer belongs.   Yes
Printer.CurrentJobID Status: Current job number Specifies the job number of the job that is currently assigned to the printer.   No
Printer.CurrentJobName Status: Current job name Specifies the name of the job that is currently assigned to the printer.   No
Printer.CurrentJobPagesStacked Status: Current job pages printed Shows the number of pages that have been printed for the job that is currently assigned to the printer.   No
Printer.CurrentJobProgress Status: % Printed Shows the current page that is printing for the job that is currently assigned to the printer, as a percentage of the total pages in the job.   No
Printer.CurrentJobTotalPages Status: Total pages in current job Shows the total number of pages in the job that is currently assigned to the printer.   No
Printer.CurrentStatus Status: Last status message If the printer status is Disconnected or Needs attention, contains the most recent error or warning message received about the printer. Otherwise, contains the most recent informational message received about the printer.   No
Printer.CustomerName Scheduling: Customer name Specifies the customer name that is assigned to the printer.   Yes
Printer.Description General: Printer description Contains text that describes the printer object.   Yes
Printer.Enabled Status: Enabled status Specifies whether Ricoh ProcessDirector can schedule jobs to the printer.   No
Printer.FirstSegmentSize General: PDF first segment size Specifies the size, in pages, of the first PDF job segment that is sent to the printer.   Yes
Printer.FoldCapable Scheduling: Folding capable Specifies whether the printer can fold pages in different ways depending on the job assigned.   Yes
Printer.HeaderExit Banner Pages: Enable header pages Controls whether the printer prints a header page at the beginning of each job.
  • No
  • Yes
Yes
Printer.ID Displayed in the properties notebook title: Printer name Contains the name of the printer.   No
Printer.Instance General: Printer server Specifies the name of the Ricoh ProcessDirector server that sends jobs to this printer.   Yes
Printer.JobSize Scheduling: Job size supported Specifies the size of the jobs in sheets that Ricoh ProcessDirector can schedule to the printer.   Yes
Printer.Language General: Printer language Indicates what language the printer driver component uses when it returns messages to Ricoh ProcessDirector.   Yes
Printer.LastModified General: Last modified The date and time that the printer was last changed.   No
Printer.Locations Scheduling: Printer location Specifies the location of the printer.   Yes
Printer.MaxConcurrentJobs General: Maximum concurrent jobs Specifies the maximum number of jobs that the printer driver component of Ricoh ProcessDirector can control at the same time.   Yes
Printer.Media Scheduling: Media supported Specifies the media that the printer supports.   Yes
Printer.Model General: Printer paper type Contains the type of the printer; for example, continuous-form or cut sheet.   Yes
Printer.Model.Specific General: Printer model Contains the model number of the printer.   Yes
Printer.ModifiedBy General: Modified by user Specifies the user name of the user who made the last change to this printer.   No
Printer.OutputBin Scheduling: Output bins available Lists the output bins that can be installed on the printer.   Yes
Printer.OutputFormat Scheduling: Output format Specifies whether the printer is set up to print the first page or the last page of a job first, usually based on finishing or other post-processing requirements. The value can also indicate that the job must be transformed to a different datastream before it can be printed.
  • AtoZforAFP
  • AtoZforPDF
  • ZtoAforAFP
  • ZtoAforPDF
  • Transform
Yes
Printer.PerfectBindingCapable Scheduling: Perfect binding capable Specifies whether the printer can glue a cover onto the binding edge of paper.   Yes
Printer.PunchCapable Scheduling: Punch capable Specifies whether a finisher attached to the printer can punch holes in the output.   Yes
Printer.Retry Connection: Printer connection retry count Specifies how many times Ricoh ProcessDirector tries to connect to the printer if an earlier attempt failed.   Yes
Printer.RetryInterval Connection: Retry interval Specifies how often Ricoh ProcessDirector tries to connect to the printer if an earlier attempt failed.   Yes
Printer.RingBindingCapable Scheduling: Ring binding capable Specifies whether the printer can insert rings along the binding edge of paper.   Yes
Printer.S2VBarcode AFP: Send blank pages after job Specifies the number of blank pages to send to the printer after the last job that is queued to the printer prints.   Yes
Printer.SegmentSize General: PDF segment size Specifies the size, in pages, of PDF job segments that are sent to the printer.   Yes
Printer.SerialNumber Status: Serial number Contains the serial number of the printer.   No
Printer.SNMPStatus Status: SNMP status Indicates whether SNMP is connected, disconnected, or disabled.   No
Printer.StapleCapable Scheduling: Staple capable Specifies whether a finisher attached to the printer can staple the output.   Yes
Printer.Status Status: Printer status Contains the current status of the printer.   No
Printer.TCPIP.Address General: Printer TCP/IP address or host name Specifies either the network TCP/IP address or the fully qualified host name of the printer hardware.   Yes
Printer.TrailerExit Banner Pages: Enable trailer pages Specifies whether the printer prints a trailer page at the end of each job.
  • No
  • Yes
Yes
Printer.UseSNMP SNMP: Use SNMP Specifies whether Ricoh ProcessDirector uses SNMP to monitor the printer.   Yes
Printer.UseSnmpUpdateMedia SNMP: Get tray information from printer Specifies whether Ricoh ProcessDirector uses the Simple Network Management Protocol (SNMP) to update media.
  • No
  • Yes
Yes
Printer.Version Status: Version Contains the printer version returned by SNMP.   No
 
Copyright © 2006, 2018