Table of Contents
Internet Printing Protocol (IPP) attributes and values are registered by IANA. See the IANA site or the PWG site for a full list.
SavaPage uses two types of extensions:
Internal extensions, which are intrinsic to SavaPage.
External extensions, as defined in implementation specific configuration files.
Internal IPP Extension attributes are intrinsic
to SavaPage. To distinguish them from IANA registrations, their
names have a org.savapage-
prefix. Attribute value extensions
with “type2 keyword” syntax are int.
prefixed.
Attributes and values are summarized in the sections below. Attribute values are
IANA registered, and the semantics can be found in the Reference documents.
Attribute value int.
extensions are described separately.
These Internal IPP extensions are used to map vendor specific PPD options to an independent common denominator. They are never send to CUPS as print job descriptor as such.
Staple positions are specified with respect to portrait media orientation. See RFC3806.
Attribute | Value | Name | Syntax | Reference |
---|---|---|---|---|
org.savapage-finishings-staple | 3 | none | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 20 | staple-top-left | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 21 | staple-bottom-left | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 22 | staple-top-right | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 23 | staple-bottom-right | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 24 | edge-stitch-left | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 25 | edge-stitch-top | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 26 | edge-stitch-right | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 27 | edge-stitch-left-bottom | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 28 | staple-dual-left | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 29 | staple-dual-top | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 30 | staple-dual-right | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 31 | staple-dual-bottom | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-staple | 32 | staple-triple-left | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-staple | 33 | staple-triple-top | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-staple | 34 | staple-triple-right | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-staple | 35 | staple-triple-bottom | 1setOf type2 enum | PWG5100.1 |
Table L.1. Internal IPP Attribute: org.savapage-finishings-staple
Punch positions are specified with respect to portrait media orientation. See RFC3806.
Attribute | Value | Name | Syntax | Reference |
---|---|---|---|---|
org.savapage-finishings-punch | 3 | none | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-punch | 70 | punch-top-left | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 71 | punch-bottom-left | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 72 | punch-top-right | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 73 | punch-bottom-right | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 74 | punch-dual-left | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 75 | punch-dual-top | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 76 | punch-dual-right | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 77 | punch-dual-bottom | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 78 | punch-triple-left | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 79 | punch-triple-top | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 80 | punch-triple-right | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 81 | punch-triple-bottom | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 82 | punch-quad-left | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 83 | punch-quad-top | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 84 | punch-quad-right | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-punch | 85 | punch-quad-bottom | 1setOf type2 enum | PWG5100.1 |
Table L.2. Internal IPP Attribute: org.savapage-finishings-punch
Attribute | Value | Name | Syntax | Reference |
---|---|---|---|---|
org.savapage-finishings-fold | 3 | none | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-fold | 90 | fold-accordion | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 91 | fold-double-gate | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 92 | fold-gate | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 93 | fold-half | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 94 | fold-half-z | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 95 | fold-left-gate | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 96 | fold-letter | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 97 | fold-parallel | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 98 | fold-poster | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 99 | fold-right-gate | 1setOf type2 enum | PWG5100.1 |
org.savapage-finishings-fold | 100 | fold-z | 1setOf type2 enum | PWG5100.1 |
Table L.3. Internal IPP Attribute: org.savapage-finishings-fold
Attribute | Keyword Value | Syntax | Reference |
---|---|---|---|
org.savapage-finishings-booklet | none | type2 keyword | RFC8011 |
org.savapage-finishings-booklet | toleft-totop | type2 keyword | PWG5100.3 |
org.savapage-finishings-booklet | toright-tobottom | type2 keyword | PWG5100.3 |
Table L.4. Internal IPP Attribute: org.savapage-finishings-booklet
Also see Section K.2.2.2, “Booklet Imposition”
For the right booklet cost calculation, make sure to activate the Booklet SPConstraint Set.
A finishing that shifts Each Set in the output-bin from the previous one by a small amount which is device dependent (PWG5100.1).
Attribute | Value | Name | Syntax | Reference |
---|---|---|---|---|
org.savapage-finishings-jog-offset | 3 | none | 1setOf type2 enum | RFC8011 |
org.savapage-finishings-jog-offset | 14 | EachSet | 1setOf type2 enum | PWG5100.1 |
Table L.5. Internal IPP Attribute: org.savapage-finishings-jog-offset
The internal IPP extension
org.savapage-requesting-user-name
is the equivalent
of IPP PRINT_JOB operation attribute
requesting-user-name
. In the example below it is mapped
to PPD Option VENRequestingUserName
.
*VENRequestingUserName org.savapage-requesting-user-name
org.savapage-requesting-user-name
can be used
to pass the value of requesting-user-name
as
option in a *JCLOpenUI
section of a PPD
file.
These options specify actions performed on a single printed copy. Each option
is prefixed with *SPJob/Copy:
See Section K.4.1, “Job Copy Options”.
This attribute indicates whether front covers are wanted for a printed copy and which sides of the cover must contain print-stream pages.
Attribute | Keyword Value | Syntax | Reference |
---|---|---|---|
org.savapage-cover-front-type | no-cover | type2 keyword | PWG5100.3 |
org.savapage-cover-front-type | print-none | type2 keyword | PWG5100.3 |
org.savapage-cover-front-type | print-front | type2 keyword | PWG5100.3 |
org.savapage-cover-front-type | print-back | type2 keyword | PWG5100.3 |
org.savapage-cover-front-type | print-both | type2 keyword | PWG5100.3 |
Table L.6. Internal IPP Attribute: org.savapage-cover-front-type
For example:
The IPP media-source the cover is printed from.
For example:
This attribute indicates whether back covers are wanted for a printed copy and which sides of the cover must contain print-stream pages.
Attribute | Keyword Value | Syntax | Reference |
---|---|---|---|
org.savapage-cover-back-type | no-cover | type2 keyword | PWG5100.3 |
org.savapage-cover-back-type | print-none | type2 keyword | PWG5100.3 |
org.savapage-cover-back-type | print-front | type2 keyword | PWG5100.3 |
org.savapage-cover-back-type | print-back | type2 keyword | PWG5100.3 |
org.savapage-cover-back-type | print-both | type2 keyword | PWG5100.3 |
Table L.7. Internal IPP Attribute: org.savapage-cover-back-type
The IPP media-source the cover is printed from. Also see Section L.1.2.2, “org.savapage-cover-front-media-source”.
Internal IPP Job Copy options can be mapped to PPD with SPExtra rules as illustrated in the example below.
*SPExtra/org.savapage-cover-front-media-source/tray-3: cover-front-tray-3 \ org.savapage-cover-front-type/!no-cover \ *FrontCover/Yes \ *FrontCoverPrintTray/TRAY3 *SPExtra/org.savapage-cover-front-media-source/tray-4: cover-front-tray-4 \ org.savapage-cover-front-type/!no-cover \ *FrontCover/Yes \ *FrontCoverPrintTray/TRAY4
Copy Cost is charged per job copy, and
specified for a combination of SPJob/Copy
and other
(media*
) attribute values. Each cost rule is prefixed
with *SPJob/Copy/Cost:
and formatted like this:
For example:
*SPJob/Copy/Cost: 0.0200 cost-cover-front-A4 \ org.savapage-cover-front-type/!no-cover \ media/iso_a4_210x297mm *SPJob/Copy/Cost: 0.0400 cost-cover-front-A3 \ org.savapage-cover-front-type/!no-cover \ media/iso_a3_297x420mm
These Internal IPP extensions are used in Job Ticketing Cost Rules. See Section K.5, “Job Ticket Extensions”.
This attribute represents a finishing action, on a set of pages (a copy), executed externally by an operator, on the printed output.
Attribute | Keyword Value | Syntax | Reference |
---|---|---|---|
org.savapage-finishings-ext | none | type2 keyword | RFC8011 |
org.savapage-finishings-ext | laminate | type2 keyword | PWG5100.1 |
org.savapage-finishings-ext | bind | type2 keyword | PWG5100.1 |
org.savapage-finishings-ext | adhesive | type2 keyword | Candidate Standard PWG 5100.1-2014: “sheets are bound using glue or adhesive.” |
Table L.8. Internal IPP Attribute: org.savapage-finishings-ext
This attribute is intended for externally printed Job Tickets only.
The same PDF document must be printed twice with different page ranges:
The first page(s) are printed on a single cover page. The cost for this action is calculated according to the Job Ticket Copy Cost Rules.
The rest of the pages are printed on selected media. The cost for this action is calculated according to the Job Ticket Media Cost Rules.
Attribute | Keyword Value | Syntax | Reference |
---|---|---|---|
org.savapage-cover-type | no-cover | type2 keyword | PWG5100.3 |
org.savapage-cover-type | int.printfront | type2 keyword | SavaPage Extension: a single-sided printed cover page. |
org.savapage-cover-type | int.printboth | type2 keyword | SavaPage Extension: a double-sided printed cover page. |
Table L.9. Internal IPP Attribute: org.savapage-cover-type
For example:
The color of the cover can be specified with org.savapage-cover-type-color
Thias attribute specifies the color of the org.savapage-cover-type. For example:
This attribute determines which Job start/end sheet(s), if any, must be
printed with a Job. Contrary to the IPP job-sheets
definition, where sheets are part of the job,
org.savapage-job-sheets
are printed as a separate job. In this way sheets can be printed
from a different media-source
with distinctive org.savapage-job-sheets-media and
media-color
.
A job sheet is a single monochrome
page with job detail
information.
Attribute | Keyword Value | Syntax | Reference |
---|---|---|---|
org.savapage-job-sheets | none | type2 keyword | RFC8011 |
org.savapage-job-sheets | job-start-sheet | type2 keyword | PWG5100.3: “A job sheet MUST be printed to indicate the start of the job”. |
org.savapage-job-sheets | job-end-sheet | type2 keyword | PWG5100.3: “A job sheet MUST be printed to indicate the end of the job”. |
Table L.10. Internal IPP Attribute: org.savapage-job-sheets
The IPP media
for org.savapage-job-sheets. Multiple keyword values are allowed, like
iso_a4_210x297mm
,
iso_a3_297x420mm
, etc.
These Internal IPP extensions are used to add a special marker to a print job.
They are never send to CUPS as such, but
translated by SavaPage to "real" IPP or CUPS options. IPP marker names
have a org.savapage.int-
prefix.
SavaPage creates IPP print jobs that are printed according to LandscapeOrientation
Minus90
. This is convenient most of the time. For
example, when a landscape oriented PDF is 4-up printed, and
staple-top-right
and
punch-dual-right
are available as finishing. But,
what if staple-top-left
and
punch-dual-left
are the only options available? In
that case a 180 degrees rotation of the "Finished-Page" is needed. This is
where the org.savapage.int-page-rotate180
boolean option
comes in. This marker is added to each proxy printer as option to make the
printed result "Rotate by 180 degrees", and translated by SavaPage to
the proper CUPS orientation-requested
and
number-up-layout
values.
Attribute | Keyword Value | Syntax | Description |
---|---|---|---|
org.savapage.int-page-rotate180 | 0 | boolean | Do not rotate. |
org.savapage.int-page-rotate180 | 1 | boolean | Rotate by 180 degrees. |
Table L.11. Internal IPP Marker Attribute: org.savapage.int-page-rotate180
org.savapage.int-page-rotate180
can be used in
SPConstraint rules.