Printer Keys¶

The following keys are available in the Printer Configuration File. The keys and their values are stored in MongoDB.

The printers are imported, exported and managed via easyPRIMA.

Hint - bos2gyros

With the bos2gyros command line tool, the printer configuration provided by the Driver Database from SEAL Systems (DDB) is mapped to the configuration format known to PLOSSYS 5.

Units¶

Values with time specifications are specified in the following time units:

seconds (s, sec)
minutes (m, min)
hours (h, hr)
days (d)
weeks (w, wk)
months
years (y, yr)

Example - with time units

2 hours and 30 minutes: 2h30m

4 minutes and 2 seconds: 4m2s

Top Level Section¶

The top level section of a printer configuration file contains the following keys and sections:

printer Key
connection Key
config Key
jobMaxPostponedCount
lprFilter
monitorConnection Key
monitorMode Key
nativeQueue Key
pickup Key
Printer Settings Keys
template Section
type Section
useCopier Key
webUrl Key

`printer` Key¶

printer specifies the name of the output device in the PLOSSYS 5 system.

Caution - allowed characters

The printer name must not contain UTF-8 or apostrophes. Although the printer will be imported, jobs cannot be processed via this printer.

The key is mandatory.

Available values: String

Default: none

`connection` Key¶

connection specifies the URL of the printer connection. The URL includes the transfer protocol, the printer name and the port number. For a printer failover, more than one URL can be specified in connection. The URLs has to be separated by blank. If the connection to a URL cannot be established, the next URL is tried.

The key is mandatory.

Available values: String

connection:<protocol>://<printer_name>:<port>/<queue_name>?<options>

Default: none

Available values for <protocol>: String

lpr
socket

Available values for <port>: Integer

Default: 515 for lpr, 9100 for socket

Available values for <queue_name>: String

specifies the name of the printer in the spooler (mandatory).

Available options - only for lpr:

stream specifies whether the data is streamed

Available values: Boolean

Example - printer connection with socket

connection: socket://myprinter:9100

Example - printer connection with lpr

connection: lpr://myprinter:515?stream=true

Example - printer connection with failover

connection: lpr://myfirst.printerurl/myPrinter socket://myprinter:9100 lpr://mysecond.printerurl/myPrinter

`config` Key¶

config specifies the name of the printer configuration.

The key is optional.

Available values: String

Default: none

`jobMaxPostponedCount` Key¶

jobMaxPostponedCount specifies how often a job for this printer will be postponed by the service in case the next service is not available for example. After exceeding the specified maximum of postponements, the job will be considered erroneous. This printer key overwrites the system-wide JOB_MAX_POSTPONED_COUNT system key for the specific printer.

The key is optional.

Available values: Integer

Default: The system-wide JOB_MAX_POSTPONED_COUNT system key

`lprFilter` Key¶

When transmitting an output job via LPR, lprFilter specifies the filter to be used for processing the data by the receiver. For more information, refer to RFC 1179.

The key is optional.

Available values: String

f

Output the formatted file: RFC 1179 - 7.19
l

Output the file leaving control characters: RFC 1179 - 7.22
p

Output the file with pr formats: RFC 1179 - 7.25
r

Output the file with FORTRAN carriage control: RFC 1179 - 7.26

Default: l

`monitorConnection` Key¶

monitorConnection specifies the IPP URL of the printer for monitoring its status. The URL includes the transfer protocol, the printer name and the port number.

The key is optional.

Available values: String

monitorConnection:<protocol>://<printer_name>:<port>/<queue_name>?<options>

Available values for <protocol>: String

ipp
http
https

Default: The value of connection and various sensible modifications of it are used for state monitoring.

`monitorMode` Key¶

monitorMode specifies if and when the physical status of a printer is checked. The value overwrites the system-wide service key PRINTER_MONITOR_MODE.

The key is optional.

Available values: String

AFTER_PRINT

Check the status after printing a job
NEVER

Never check the status

Default: NEVER

`nativeQueue` Key¶

nativeQueue specifies if all jobs for this printer are treated as native jobs.

The key is optional.

Available values: Boolean

Default: none

`pickup` Key¶

pickup specifies if the queue is a pickup queue.

The key is optional.

Available values: Boolean

Default: false

Printer Settings Keys¶

The printer settings are key value pairs which describe printer settings. These printer settings can be used for further configuration.

Available values: String

<key>:<value>

Example - printer settings

adjustStapleType: true
adjustPunchType: true
rotateLandscapeA3: false

`template` Section¶

The template section contains the following keys and sections for the processing settings of the printer.

timeout Key
params Section
gyros Section

`timeout` Key¶

timeout specifies the time interval after which the conversion is aborted if the conversion does not provide any data. The time interval has to be specified including the unit. The available units are listed at the top of the page.

The key is optional.

Available values: String

Default: 120s

`params` Section¶

The params section contains the command line parameters for the conversion. For more information about the available command line parameters, refer to the documentation of the specific converter.

The key is mandatory.

Available values: Strings

Default: none

Example - conversion into PCL via Ghostscript

params:
  '-dBATCH',
  '-dNOPAUSE',
  '-dQUIET',
  '-dSAFER',
  '-sstdout=%stderr',
  '-sDEVICE=plspcl',
  '-sOutputFile=-',
  '-'

`gyros` Section¶

The gyros section contains objects with rule groups for an output device used in the rule management from SEAL Systems (Ghostscript YAML Rules Output System).

The key is optional.

Available values: String

Default: none

Example - Job Start UEL + Jobname + Username object

- name: Job Start UEL + Jobname + Username
  context: startJob
  prefix: Init=
  rules:
    - condition: true
      action: |
        Init=\\033%-12345X@PJL JOB NAME="${job.JOBNAME}"\\n
        Init=@PJL SET JOBNAME="${job.JOBNAME}"\\n
        Init=@PJL SET USERNAME="${job.USERNAME}"\\n

`name` Key (`gyros` Section)¶

name specifies the name of the rule group.

The key is mandatory.

Available values: String

Default: none

`context` Key¶

context specifies the context in which a role group is executed. The context depends on the current processing step of the output job.

The key is mandatory.

Available values: String

startJob
startSetup
endSetup
startPage
endJob

Default: none

`prefix` Key¶

prefix specifies the prefix inserted at the beginning of each line of the string specified in action.

The key is optional.

Available values: String

Default: empty string

`rules` Section¶

The rules section contains the implementation of the specific rule using condition, action, escape.

The section is mandatory.

Default: none

`type` Section¶

The type section contains the following keys and sections concerning the printer type.

name Key
manufacturer Key
model Key
pdl Section

`name` Key (`type` Section)¶

name specifies the complete name of the printer model.

The key is mandatory.

Available values: String

Default: none

Example - complete printer name

HP Laserjet 4050

`manufacturer` Key¶

manufacturer specifies the name of the printer manufacturer.

The key is mandatory.

Available values: String

Default: none

Example - manufacturer

Hewlett-Packard

`model` Key¶

model specifies the name of the printer model.

The key is mandatory.

Available values: String

Default: none

Example - printer model

4050

`pdl` Section¶

The pdl section contains the following keys for the printer description languge.

name Key
version Key

`name` Key (`pdl` Section)¶

name ìn the pdl section specifies the printer language.

The key is mandatory.

Available values: String

postscript
pcl
pdf

Default: none

`version` Key¶

version specifies the version of the printer description language.

The key is mandatory.

Available values: String

Default: none

Example - printer description language

    pdl: {
      name: 'postscript',
      version: '2.0'
    }

    pdl: {
      name: 'pcl',
      version: '5'
    }

`useCopier` Key¶

useCopier specifies if the seal-copier service is used for resolving the job copies by sending the document data multiple times to the printer. Normally, the job copies are resolved by the printer itself.

The key is optional.

Available values: String

Y

The seal-copier service resolves the job copies.
N

The seal-copier service does not resolve the job copies.

Default: N

`webURL` Key¶

webURL specifies the URL under which the printer can be reached.

The key is optional.

Available values: String

Default: none

Printer Keys¶

Units¶

Top Level Section¶

printer Key¶

connection Key¶

config Key¶

jobMaxPostponedCount Key¶

lprFilter Key¶

monitorConnection Key¶

monitorMode Key¶

nativeQueue Key¶

pickup Key¶

Printer Settings Keys¶

template Section¶

timeout Key¶

params Section¶

gyros Section¶

name Key (gyros Section)¶

context Key¶

prefix Key¶

rules Section¶

type Section¶

name Key (type Section)¶

manufacturer Key¶

model Key¶

pdl Section¶

name Key (pdl Section)¶

version Key¶

useCopier Key¶

webURL Key¶

`printer` Key¶

`connection` Key¶

`config` Key¶

`jobMaxPostponedCount` Key¶

`lprFilter` Key¶

`monitorConnection` Key¶

`monitorMode` Key¶

`nativeQueue` Key¶

`pickup` Key¶

`template` Section¶

`timeout` Key¶

`params` Section¶

`gyros` Section¶

`name` Key (`gyros` Section)¶

`context` Key¶

`prefix` Key¶

`rules` Section¶

`type` Section¶

`name` Key (`type` Section)¶

`manufacturer` Key¶

`model` Key¶

`pdl` Section¶

`name` Key (`pdl` Section)¶

`version` Key¶

`useCopier` Key¶

`webURL` Key¶