Subcommands

OFFSET Subcommand
OFFSET rel-x rel-y [rel-x rel-y]
Specifies the relative offset of the logical page for both the front and back pages in reference to the media origin. The media origin is printer dependent. For more information about media origin, see your printer publications.

If you specify offset values for the back of the page, you must also specify the front offset values.

Note: The OFFSET subcommand does not affect the position of medium overlays.
rel-x
Specifies the relative horizontal offset of the logical page on the front or back side of the copy group relative to the media origin. The valid options for rel-x are described in the SETUNITS command for the horizontal value.

If no unit is specified, a default setting is:

  • Taken from the lastSETUNITS command
  • IN (inch) if no SETUNITS command has been issued

rel-y
Specifies the relative vertical offset for the logical page for the front or back side of the page. The valid options for rel-y are described in the SETUNITS command for the vertical value.
Note: The vertical offset for the 3800 must be 0.5 inch or greater.
If no unit is specified, a default setting is:
  • Taken from the last SETUNITS command
  • IN (inch) if no SETUNITS command has been issued
      Note:
    1. If OFFSET is not specified, the OFFSET default is 0.1 IN 0.1 IN
    2. You may specify this offset as negative in order to crop the top and/or left of an image.
BIN Subcommand
[BIN 1] | [BIN {n | MANUAL | ENVELOPE} 
   [MEDIANAME qstring] [COMPID m]]
Specifies the paper source. This subcommand should be used only for printers that have more than one paper source.
1
Selects the primary paper source.
n
Selects a paper source identified by an integer from 2–255. If the specified bin does not exist on your printer, the default paper source for that printer is used. For more information about paper sources on your printer, refer to your printer publications.
MANUAL
Selects manual feed as a paper source on those printers that support manual feed. For more information, refer to your printer publications.
ENVELOPE
Selects an envelope paper source on those printers that support this function. For more information, refer to your printer publications.
MEDIANAME
Selects a media source by specifying an agreed-upon name for the bin.
qstring
Up to 12 characters within single quotes, specifying the media source name. On some printers, this name is pre-set into the printer; on other printers, it can also be entered into the printer by the user. For a current list of the valid media names, see PPFA Media Names. Refer to your printer publications for further information.
COMPID
Selects a bin based on the component ID.
m
For a current list of component ids, see PPFA Media Names. Component ids from 12,288 to 268,435,455 are reserved for the user.
    Note:
  1. BIN selection is overridden by the printer if the form defined to each bin is the same form number. Only the primary bin is selected.
  2. The primary source usually contains either letter-size (U.S.) or A4 (I.S.O.) paper. Other paper sources are used for less common paper sizes (such as legal-size) and for special paper (such as colored stock or pre-printed letterhead on heavy bond).
  3. If duplexing is requested and you select from the front side from one bin and the back side from another bin, a warning message is issued and the printer takes the paper from the bin specified on the front side.
OUTBIN Subcommand
OUTBINn
Specifies the destination bin number for any pages directed by this COPYGROUP. Subgroups in this form definition that do not specify an output bin number inherit this one.
n
Specifies the output bin number.
CONSTANT Subcommand
CONSTANT {NO | BACK | FRONT | BOTH}
Specifies whether the constant-forms function is on or off and whether constant form is to be printed on the front or back sides of a sheet.
NO
Specifies that the constant forms function is off.
BACK
Specifies that a constant form is to be printed on the back side without variable data.
FRONT
Specifies that a constant form is to be printed on the front side without variable data.
BOTH
Specifies that a constant form is to be printed on both sides without variable data.
DIRECTION Subcommand
DIRECTION {ACROSS | DOWN | REVERSE}
Determines, along with the PRESENT subcommand, how data is oriented on printers whose media origin can be changed. See the list of printers N_UP Printing.

If you are printing line data, you usually specify the same value for the DIRECTION subcommand as is specified for the DIRECTION subcommand in the page definition.

ACROSS
Specifies that the pages are formatted in the ACROSS printing direction.
DOWN
Specifies that the pages are formatted in the DOWN printing direction.
REVERSE
Specifies that the pages are formatted in the REVERSE printing direction.

If the DIRECTION subcommand is specified, you must specify the PRESENT subcommand. The default for DIRECTION is determined by the value specified for PRESENT.

The direction default of PORTRAIT is ACROSS; the direction default of LANDSCAPE is DOWN. If neither PRESENT nor DIRECTION is specified, the default is PRESENT PORTRAIT and DIRECTION ACROSS.

PRESENT Subcommand
PRESENT {PORTRAIT | LANDSCAPE}
Specifies, along with the DIRECTION subcommand, how the data is oriented on printers whose media origin can be changed.

The PRESENT and DIRECTION subcommands are only supported by cut-sheet printers when you specify the N_UP subcommand or the CUTSHEET subcommand with the YES parameter. See Figure N_UP 1 Partition Numbering, Front Sheet-Side through Figure N_UP 4 Partition Numbering, Front Sheet-Side to determine the effect of the PRESENT and DIRECTION subcommands when you use them with the N_UP subcommand.

PORTRAIT
Specifies that the pages are printed in the portrait page presentation, with their short edges at the top and bottom and their long edges at the sides.
LANDSCAPE
Specifies that the pages are printed in the landscape page presentation, with their long edges at the top and bottom and their short edges at the sides.

DUPLEX Subcommand
DUPLEX {NO | NORMAL | TUMBLE |RNORMAL | RTUMBLE}
Specifies whether printing is done on both sides of the sheet. This subcommand should be used only for page printers that have duplex capability.
NO
Duplex printing is not performed.
NORMAL
Duplex printing is performed, with the tops of both sides printed along the same edge for side binding.
TUMBLE
Duplex printing is performed with the top of one side and the bottom of the other printed along the same edge of the sheet for top binding.
RNORMAL
Rotated normal. Duplex printing is performed with the tops of both sides printed along the same edge. Used with landscape pages, N_UP 2, and N_UP 3.
RTUMBLE
Rotated tumble. Duplex printing is performed with the top of one side printed along the same edge of the sheet as the bottom of the other. Used with landscape pages, N_UP 2, and N_UP 3.
CUTSHEET Subcommand
CUTSHEET {NO|YES}
If you are using a cut-sheet printer, this subcommand specifies whether the medium orientation information, using the DIRECTION and / or PRESENT subcommands, is to be passed to the printer. The default value is NO.
YES
Specifies the rotation data is to be passed.
NO
Specifies the rotation data is not to be passed unless N_UP is coded.
    Note:
  1. If you have a continuous form printer, the medium orientation information is passed. If you have a cut-sheet printer and N_UP is coded, the orientation information is passed.
  2. If you have a cut-sheet printer and CUTSHEET YES is coded, the orientation information is passed, providing you also have a level of the print server that supports that feature.
  3. You must have a printer that allows its media origin to be changed in order to use this subcommand.

Example:

In the following example, the CUTSHEET subcommand is coded on the form definition to give copygroups c1 and c2 CUTSHEET YES behavior and copygroup c3 CUTSHEET NO behavior. The copygroup c1 inherits its behavior from the form definition.

FORMDEF cut1 REPLACE YES CUTSHEET YES;
     COPYGROUP c1 ;
     COPYGROUP c2 CUTSHEET YES ;
     COPYGROUP c3 CUTSHEET NO ;

FINISH Subcommand
FINISH [[SCOPE SHEET OPERATION AFP ZFOLD REFERENCE DEFAULT] | 
   [SCOPE {SHEET | BEGCOLL | CONTCOLL} OPERATION 
   Operation Parameters]… ]
A finishing operation is to be performed on this COPYGROUP. This option is to be used only on a document, set of documents, or an entire print file.
SCOPE
Determines to which sheets the finishing operation is applied.
Note: SCOPE can be repeated within a FINISH subcommand, but only one SCOPE of a particular type is allowed in each COPYGROUP command. For example, only one SCOPE BEGCOLL is allowed in a COPYGROUP command.
Single Sheet Scope
Operations with this SCOPE are applied to a single sheet.
SHEET
Single sheet Medium-map level scope. The specified finishing operation is applied to each sheet individually.
Collection Scope
Collection/Medium-map level scope. All sheets generated by this medium map are collected and the specified finishing operations are applied to this collection.
Note: Some finishing operation combinations are not compatible. Compatible combinations are dependent upon the presentation-device.
BEGCOLL
Begin medium-map level collections. This causes a sheet eject and starts a medium-map-level media collection for the specified operation. If a collection for the same finishing operation is already in progress from a previous medium map, that collection is ended and its specified finishing operation is applied. The media collection started with BEGCOLL continues until:
  1. The end of the document is reached.
  2. A medium map is invoked that is not CONTINUE COLLECTION for this same operation command.
When a finishing collection is ended for any of the above reasons, the specified finishing operation is applied.
CONTCOLL
Continue medium-map level collection. This continues a medium-level media collection that was started for the same finishing operation by a previous medium map. The media collection started with CONTCOLL continues until:
  1. The end of the document is reached.
  2. A medium map is invoked that is not CONTINUE COLLECTION for this same operation command.
When a finishing collection is ended for any of the above reasons, the specified finishing operation is applied.
OPERATION Parameters
{[AFP] { ZFOLD | CFOLDIN | CORNER | CUT | EDGE | FOLD | 
PERFECTBIND | PERFORATE | PUNCH | RINGBIND | SADDLE[OUT] | SADDLEIN}}…
More OPERATION parameters
UP3I {XType {n | X'hh'} [XOper {X'FFFF | n | X'hhhh'}]}… 
More OPERATION parameters
Specifies the type of FINISH operation and parameters.
    Note:
  1. Compatible operations can be repeated with a specified SCOPE.
  2. Your print server may have a limit on the number of collection operations allowed at one time.
  3. The default for OPERATION is ZFOLD. It is necessary to code OPERATION only if REFERENCE is coded.
AFP
Specifies that these are Advanced Function Presentation (AFP) operations as defined in the Mixed Object Document Content Architecture Reference, SC31-6802 and the Intelligent Printer Data Stream Reference, S544-3417.
SHEET Operations
These operations operate on a single sheet of paper and are valid for SCOPE SHEET.
Note: The PAGE scope is obsolete. The SHEET subcommand should be used instead of PAGE subcommand. For compatibility purposes, the PAGE command is accepted as an alias for SHEET.
CFOLDIN
Center Fold In. Specifies that the media is folded inward along the center line that is parallel to the finishing operation axis. After this operation, the back side of the last sheet of the collection is outside. The OPCOUNT and OPPOS parameters are ignored for this operation. CFOLDIN is applied to collected media, not to individual media.
Note: The datastream pages must already be properly ordered for the CFOLDIN operation.
CUT
Specifies that a separation cut is applied to the media along the axis of the finishing operation. The OPCOUNT and OPPOS parameters are ignored for this operation.
FOLD
Specifies that the media is folded along the axis of the finishing operation. The folding is performed along the axis of the finishing operation. The OPCOUNT and OPPOS parameters are ignored for this operation. This operation is applied to collected media, not to individual media.
PERFORATE
Specifies that a perforation cut is applied to the media along the axis of the finishing operation. The OPCOUNT and OPPOS parameters are ignored for this operation.
PUNCH
Specifies that one or more holes are to be punched or drilled into the media along the finishing axis. PUNCH is applied to the collected media, not to individual media.
ZFOLD
Perform a ZFOLD operation along the finishing edge (axis). Z-Folding causes the sheet to first be folded in half inwards (the front side of the sheet is now inside the fold) along a line parallel to the reference edge. The half of the sheet originally furthest from the reference edge is again folded in half outwards along a line parallel to the reference edge. For example, when Z-Folding is applied to an 11 by 17 inch sheet with the reference edge along a short side, the result is an 8.5 by 11 inch fold-out. The OPOFFSET, OPCOUNT, and OPPOS parameters are ignored for this operation. This operation is applied to an individual sheet.
Note: REFERENCE is the only parameter allowed for ZFOLD and the only reference edges allowed are DEFAULT, TOP, BOTTOM, LEFT, and RIGHT.
AFP Collection Operations
These operations operate on a collection of sheets and are valid with BEGCOLL and CONTCOLL.
CFOLDIN
Center Fold In. Specifies that the media is folded inward along the center line that is parallel to the finishing operation axis. After this operation, the back side of the last sheet of the collection is outside. The OPCOUNT and OPPOS parameters are ignored for this operation. CFOLDIN is applied to collected media, not to individual media.
Note: The datastream pages must already be properly ordered for the CFOLDIN operation.
CORNER
Specifies that one staple is driven into the media at the reference corner (see REFERENCE parameter). For corner staples, the offset and angle of the staple from the selected corner is device dependent. The OPCOUNT and OPPOS parameters are ignored for this operation. This operation is applied to collected media, not to individual media.
CUT
Specifies that a separation cut is applied to the media along the axis of the finishing operation. The OPCOUNT and OPPOS parameters are ignored for this operation.
EDGE
Specifies that one or more staples are driven into the media along the axis of the finishing operation. This operation is applied to collected media, not to individual media.
FOLD
Specifies that the media is folded along the axis of the finishing operation. The folding is performed along the axis of the finishing operation. The OPCOUNT and OPPOS parameters are ignored for this operation. This operation is applied to collected media, not to individual media.
PERFECTBIND
This operation specifies a type of book binding that glues the sheets of the group together at the reference edge (spine). When you specify PERFECTBIND, the OPOFFSET, OPCOUNT, and OPPOS parameters are ignored.
PERFORATE
Specifies that a perforation cut is applied to the media along the axis of the finishing operation. The OPCOUNT and OPPOS parameters are ignored for this operation.
PUNCH
Specifies that one or more holes are to be punched or drilled into the media along the finishing axis. PUNCH is applied to the collected media, not to individual media.
RINGBIND
This operation specifies a type of book binding when the sheets of the group are loosely connected at the reference edge (spine) by first drilling or punching a set of holes along the reference edge and then inserting a wire pattern through the holes. When you specify RINGBIND, the OPOFFSET, OPCOUNT, and OPPOS parameters are ignored.
SADDLE or SADDLEOUT
Specifies that one or more staples are driven into the media along the axis of the finishing operation, which is positioned at the center of the media, parallel to the reference edge (see REFERENCE parameter). The OPOFFSET parameter is ignored for this operation. This operation also includes a fold of the media outward along the finishing operation axis so that the front side of the first sheet in the collection is on the outside of the media collection. This operation is applied to collected media, not to individual media.
SADDLEIN
Specifies that one or more staples are driven into the media along the axis of the finishing operation, which is positioned at the center of the media, parallel to the reference edge (see REFERENCE parameter). The OPOFFSET parameter is ignored for this operation. This operation also includes a fold of the media inward along the finishing operation axis so that the front side of the first sheet in the collection is on the inside of the media collection. This operation is applied to collected media, not to individual media.
Note: The datastream pages must already be properly ordered for the SADDLEIN operation.
UP3i
Specifies that these operations will be passed to the printer using the Universal Printer Pre- and Post-Processing Interface (UP3i) finishing interface as specified in the Form Finishing Operation Triplet in the UP3i specification document. UP3i is an open standard intelligent interface intended for printers, pre-processors, post-processors, and other related applications.
    Note:
  1. To use this function you must have printer server support as well as an attached UP3i device for the specified operation.
  2. The complete UP3i specification document which includes the Form Finishing Operation Triplet is available at https://www.afpconsortium.org/uploads/1/1/8/4/118458708/up3i-v1.20-3rd-party-specification.pdf.
XType
Specifies the explicit value for the Finishing Operation Type in the UP3i Form Finishing Operation Triplet. Specify in hexadecimal or a decimal equivalent number the Finishing Operation Type. A value of 0 specifies a No Operation/Pass through paper operation. When 0 is coded in this field, the XOper field is ignored. Enter 2 hexadecimal digits or a decimal number less than or equal to 255.
XOper
Specifies the explicit value for the Finishing Operation or the Finishing Operation Parameter in the UP3i Form Finishing Operation Triplet. Specify in hexadecimal or a decimal equivalent number the Finishing Operation Type. A value of X'FFFF' specifies the device default operation for the specified finishing operation for the specified Finishing Operation Type in the XType parameter. Enter 4 hexadecimal digits or a decimal number less than or equal to 65535.
    Note:
  1. PPFA does not check that the XType, XOper, or operation parameters are contextually correct. This allows new UP3i operations and parameters to be coded without having to install a new PPFA module. However, it also allows contextually incorrect operation and parameter values to be entered.
  2. See Table XType and XOper values for values of XType and XOper.
More OPERATION Parameters
[REFERENCE {DEFAULT | TOP | BOTTOM | LEFT | RIGHT | TOPLEFT | 
TOPRIGHT | BOTLEFT | BOTRIGHT}] 
[OPCOUNT n | OPPOS n…][OPOFFSET n
These operation parameters apply to both AFP and UP3i Operations with the noted exceptions.
REFERENCE
Selects the reference edge or corner for the finishing operation. The REFERENCE subcommand is optional and, when omitted, the DEFAULT attribute is the default.
DEFAULT
Specifies that the device default edge determines the reference edge.
TOP
Specifies that the reference is positioned along the top edge.
BOTTOM
Specifies that the reference edge is positioned along the bottom edge.
LEFT
Specifies that the reference edge is positioned along the left edge.
RIGHT
Specifies that the reference edge is positioned along the right edge.
TOPLEFT
Specifies that the reference corner is positioned at the top in the left corner. This REFERENCE parameter can be used only for CORNER operations.
TOPRIGHT
Specifies that the reference corner is positioned at the top in the right corner. This REFERENCE parameter can be used only for CORNER operations.
BOTLEFT
Specifies that the reference corner is positioned at the bottom in the left corner. This REFERENCE parameter can be used only for CORNER operations.
BOTRIGHT
Specifies that the reference corner is positioned at the bottom in the right corner. This REFERENCE parameter can be used only for CORNER operations.
OPCOUNTn
Use OPCOUNT to request a specific number of finishing operations; valid values are 1-122. Do not specify OPPOS values with OPCOUNT. If OPPOS is specified for corner staple, separation cut, perforation cut, or fold, this OPCOUNT value is ignored. The printer determines the positions of the operations. The default is 0 (zero).
OPPOSn
Use OPPOS to specify the offset of finishing operations along the finishing operations axis measured from the point where the finishing operation axis intersects the bottom edge or left edge of the medium toward the center of the medium. Each consecutive OPPOS parameter is used to position a single finishing operation centered on the specified point on the finishing operation axis.

For AFP the sub-parameter is an integer value in the range of 0-32,767 specified in millimeters.

For UP3i the sub-parameter is an integer value in the range of 0 to 999999999 specified in millipoints (1/72000 inch).

Do not specify the unit of measure. Do not specify OPCOUNT when you use OPPOS. If OPPOS is specified for corner staple, fold, separation cut, or perforation cut, the OPCOUNT value is ignored.

OPOFFSET n
Specifies the offset of finishing operation axis from the reference edge measured from the reference edge toward the center of the medium.

For AFP the sub-parameter is an integer value in the range of 0-32,767 specified in millimeters.

For UP3i the sub-parameter is an integer value in the range of 0 to 999999999 specified in millipoints (1/72000 inch).

Do not specify OPOFFSET for corner staple or saddle stitch; the corner staple or saddle stitch values are ignored when specified with OPOFFSET.

Table XType and XOper values shows how to specify finishing operations.

XType and XOper values

XType Finishing Operation XType Value XOper Finishing Operation Parameter XOper Value
No Operation / Pass through paper X'00' Not applicable  
Paper Input / Page Interpose (not used for AFP/IPDS) X'01' Interpose from bin xx Stock Number X'0001'X'00FE'
Default Bin/Stock X'FFFF'
Fold X'03' Folding parameters from fold catalog X'100D'
No Fold X'0000'
Default X'FFFF'
Staple / Stitch X'04' Corner Staple X'0001'
Saddle Stitch In X'0002'
Saddle Stitch Out X'0003'
Edge Stitch X'0004'
Default X'FFFF'
Cut X'05' Separation Cut X'0001'
Perforation Cut X'0002'
Cross Cut X'0003'
Default X'FFFF'
Trim X'06' Front Edge X'0001'
1 Edge X'0002'
3 Edge X'0003'
5 Edge X'0004'
Default X'FFFF'
Offset / Group Separator / Job Separator X'07' Offset to Left X'0001'
Offset to Right X'0002'
Device Default X'FFFF'
Stack X'08' Alternate Offset Stack X'0001'
Device Default X'FFFF'
Rotate X'09' 90° Clockwise X'0001'
180° Clockwise X'0002'
270° Clockwise X'0003'
Device Default X'FFFF'
Punch X'0A' Round Hole X'0001'
Rectangular Hole X'0002'
Device Default X'FFFF'
Bind X'0B' Device Default X'FFFF'
Merge X'0C' Handle Most Left Page First X'0001'
Handle Most Right Page First X'0002'
Device Default X'FFFF'
Banding X'0D' Single Band Wrap X'0001'
Double Band Wrap X'0002'
Crossing Band Wrap X'0003'
Device Default X'FFFF'
Shrink Wrap X'0E' Shrink Wrap X'0001'
Device Default X'FFFF'
Special Handling X'F0' Specific Parameter (undefined by UP3i) X'0000'X'FFFE'
Not Applicable X'FFFF'
    Note:
  1. Your printer must have the appropriate finishing hardware to perform finishing operations.
  2. The default OPERATION is ZFOLD, and the default REFERENCE is DEFAULT.
  3. Your print server may have a limit on the number of collection operations that can be open at one time.
  4. For the finishing operation, changing the orientation of the medium presentation space does not change the finishing position. For instance the finishing reference edge (corner) is not affected by DIRECTION or PRESENT values.
  5. If more than one finishing operation is specified, the operations are applied in the order in which they are specified. Identical finishing operations for the same SCOPE are not supported.

The following are examples of finishing operations:

  1. ZFOLD pages (for which the xyz COPYGROUP is in effect), specifying the left edge of the document as the reference edge:
    COPYGROUP xyz 
    FINISH OPERATION ZFOLD REFERENCE LEFT;
  2. Three examples of ZFOLD pages that specify the default edge of the document:
    COPYGROUP xyz FINISH;

    or

    COPYGROUP xyz FINISH OPERATION ZFOLD;

    or

    COPYGROUP xyz FINISH OPERATION ZFOLD REFERENCE DEFAULT;

  3. An example of a COPYGROUP finishing command where COPYGROUP 1 begins the finishing collection for corner stapling, folding, and separation cut. COPYGROUP 2 continues the fold, cut, and corner operations and stops all other operations. COPYGROUP 3 continues any corner stapling, begins a new punch and fold group, and stops all other operations.
    COPYGROUP 1
        FINISH
         SCOPE BEGCOLL  OPERATION corner REFERENCE topleft
                        OPERATION fold
                        OPERATION cut;
    
      COPYGROUP 2
        FINISH
         SCOPE CONTCOLL OPERATION fold
                        OPERATION cut
                        OPERATION corner;
    
      COPYGROUP 3
        FINISH
         SCOPE CONTCOLL OPERATION corner REFERENCE topleft
         SCOPE BEGCOLL  OPERATION punch
                        OPERATION fold;    
  4. An example of a COPYGROUP finishing command where COPYGROUP 1 begins a finishing collection for a punch, separation cut, and corner stapling (using the UP3i interface), and stops all other operations in progress. COPYGROUP 2 continues any UP3i corner stapling, but stops all other operations in progress. COPYGROUP 3 continues any UP3i corner stapling, stops all other operations in progress, and begins collecting sheets to punch and cut.
    FORMDEF FinXmp Replace Yes;
    
    COPYGROUP 1
        FINISH
         SCOPE BEGCOLL  OPERATION punch
                        OPERATION cut
                        OPERATION UP3i XType 4 XOper 1 REFERENCE topleft;
    
      COPYGROUP 2
        FINISH
         SCOPE CONTCOLL OPERATION UP3i XType 4 XOper 1 REFERENCE topleft;
    
      COPYGROUP 3
        FINISH
         SCOPE CONTCOLL OPERATION UP3i
                              UP3i XType X'04' XOper X'0001' REFERENCE 
                              topleft;
         SCOPE BEGCALL  OPERATION AFP punch
                        OPERATION cut;    
  5. Examples of COPYGROUP finishing commands with PRESENT and DIRECTION:
    FORMEDF MOGD01  replace yes
            PRESENT landscape   DIRECTION down ;
       COPYGROUP cg00
            PRESENT portrait    DIRECTION across ;
    
       COPYGROUP cg01
            PRESENT landscape   DIRECTION across ;
    
       COPYGROUP cg02
            PRESENT portrait    DIRECTION reverse ;
    
       COPYGROUP cg03
            PRESENT landscape   DIRECTION reverse ;
    
       COPYGROUP cg04
            PRESENT portrait    DIRECTION down ;
    
       COPYGROUP cg05
            PRESENT landscape   DIRECTION down ;

Finishing Operation Nesting Rules
When more than one finishing operation involving a collection of media is specified for some portion of the print file, a nesting of the operations is defined first by the scope of the operation and second by the order of the operation in the data stream.

Finishing operations with a broader scope are nested outside of finishing operations with a narrower scope. The following scopes are listed in descending order:

  1. Print-file level finishing (SCOPE PRINTFILE)
  2. Document-level finishing, each document in the print file (SCOPE ALL)
  3. Document-level finishing, a selected document in the PRINTFILE (SCOPEn)
  4. Medium-map-level finishing, a collection of sheets (SCOPE BEGCOLL)

Finishing Operation Implementation Notes
  1. AFP environments limit the number of finishing operations that can be nested at the medium map (COPYGROUP) level. Check your PSF documentation for these limits.
  2. In AFP environments, the nesting of identical finishing operations at the medium-map-level is not supported. Two finishing operations are identical if the OPERATION, REFERENCE, OPCOUNT or OPPOS, and OPOFFSET are the same.
  3. For some printers, the JOG function cannot be combined with a finishing operation. In this case, the JOG function is ignored. Check your printer documentation.
ADJUST Subcommand
ADJUST n
Establishes the range of horizontal adjustment for the print area on the sheet.
n
The adjustment range can be set from 0 to 20 L-units. After a value is set, it is the maximum amount available in both directions, plus and minus.
    Note:
  1. If you specify ADJUST, the maximum logical page size (in the horizontal direction) is reduced by the amount you specified here.
  2. The ADJUSTn subcommand used only on the IBM 3800 printers.
INVOKE Subcommand
INVOKE {SHEET | NEXT | FRONT | BACK}
Specifies where the next page of data is placed when this copy group is activated by conditional processing or by an Invoke Medium Map structured field.

INVOKE SHEET, which is the default, places the next page of data on a new sheet. The NEXT, FRONT, and BACK parameters place the next page in a subsequent partition on the same sheet or, if no partitions are available, on the next sheet. If FRONT or BACK is specified, INVOKE selects only partitions on the front or back, respectively.

The print server honors the NEXT, FRONT, and BACK values of the INVOKE subcommand only if the new copy group has the same medium modifications as the previous copy group. Some examples of medium modifications are duplexing, input bin, output bin, page offset, N_UP values, presentation, direction, medium (not page) overlays, text suppression, processing functions, print quality, finishing, jogging, and constant forms control. See the Media Eject Control Triplet (X'45') section in the Mixed Object Document Content Architecture Reference, SC31–6802 for a full description of the factors that allow a conditional eject to the next partition instead of the next sheet.

If any of these modifications differ, the print server ejects to a new sheet when the copy group is invoked. If you want to change overlays when ejecting to a new partition, use page overlays instead of medium overlays. See Medium Overlays and Page Overlays for information about page and medium overlays.

When you use PLACE subcommands, the NEXT, FRONT, and BACK parameters place the next page using the next sequential PLACE subcommand that matches the requirement (next, front, or back). For example, if you print using the second PLACE subcommand of copy group A, and then you change to copy group B, you start with the third PLACE subcommand of copy group B.

A CONSTANT parameter on the PLACE subcommand does not alter the selection process. The selection is complete, even though the selected PLACE subcommand does not place the data. N_UP performs the constant modification and continues until it finds a PLACE subcommand that does not specify CONSTANT. The data is placed with this subcommand. Observe that this PLACE subcommand need not match the FRONT or BACK specifications of the INVOKE subcommand.

SHEET
Specifies that data be placed in the first selected partition of the sheet.
NEXT
Specifies that data be placed in the next selected partition.
FRONT
Specifies that data be placed in the next selected front partition.
BACK
Specifies that data be placed in the next selected back partition.

JOG Subcommand
 JOG {YES | NO}
Specifies whether a JOG subcommand is sent to the printer when this COPYGROUP is selected by an IMM structured field, or through conditional processing. When the JOG subcommand is sent, a printer either offsets (jogs) or prints copymarks. For cut-sheet printers, or for continuous-forms printers with burster-trimmer-stacker enabled, the JOG subcommand causes the first sheet controlled by this COPYGROUP to be stacked offset from the previous sheets. For continuous forms printers without a burster-trimmer-stacker, the JOG subcommand causes an increment in the copymark printed on the carrier strip. JOG subcommands also are sent to the printer at the beginning of each data set or at the beginning of each job, depending on host parameters. For more information about copymarks, see the system programming guide for your host print server.
YES
Specifies that a JOG subcommand be sent to the printer. The first sheet printed is offset or the copymark is incremented.
NO
Specifies that no JOG subcommand be sent to the printer. The first sheet printed is not offset; the copymark is not incremented.
QUALITY Subcommand
QUALITY n
Specifies the print quality. This subcommand is recognized only on printers that can produce more than one level of print quality. The default is determined by the printer model. (On some printers, the default may be set at the printer itself.) For more information, refer to your printer publications.
n
You can select a level of print quality by entering any whole number from 1 to 10. Higher numbers correspond to higher levels of print quality; lower numbers correspond to lower levels. For more information, refer to your printer publications.

Print quality is determined by a numerical code in the range of 1 to 254 (hexadecimal X'01'–X'FE'). The codes corresponding to the possible QUALITY parameters are:

  • 1 = 15 (X'0F')
  • 2 = 40 (X'28')
  • 3 = 65 (X'41')
  • 4 = 90 (X'5A')
  • 5 = 115 (X'73')
  • 6 = 140 (X'8C')
  • 7 = 165 (X'A5')
  • 8 = 190 (X'BE')
  • 9 = 215 (X'D7')
  • 10 = 240 (X'F0')

PROCESSING Subcommand
PROCESSING [MEDIA_INFO {n… | PERFORATE| CUT}]…
Specifies additional post processing capabilities for selected printers and attached equipment. This option can only be used on a single sheet or collection of sheets. This subcommand expects 1 to 3 of the following keywords:
MEDIA_INFOn
This parameter specifies the ID of fixed medium information that a printer or printer-attached device applies to a sheet. Examples include color plates logos, letter heads, and other fixed images.

The numeric values that can be included are:

0–254
These numeric values select a particular fixed medium local ID that the printer or printer–attached device applies to a sheet. One or more IDs can be specified within this range.
255
This value selects all the current fixed medium local IDs that the printer or printer–attached devices applies to a sheet.

PERFORATE
Specifies a perforation cut at one or more fixed locations on the sheet according to the printer or printer–attached device.
CUT
Specifies a separation cut at one or more fixed locations on the sheet according to the printer or printer–attached device.
N_UP Subcommand
N_UP {1 | 2 | 3 | 4] [OVERLAY Subcommand… | PLACE Subcommand…]
Specifies the number of equal-size partitions into which the sheet is divided. See the list of printers that support the N_UP subcommand.

If you do not specify the N_UP subcommand in the COPYGROUP command, the N_UP subcommand from the FORMDEF command is the default for the COPYGROUP command. You can mix N_UP printing and non-N_UP printing by specifying or not specifying the N_UP subcommand in each copy group and by not specifying N_UP in the FORMDEF command.

OVERLAY Subcommand on N_UP Subcommand
OVERLAY name][rel-x rel-y][PARTITION]
[OVROTATE {0 | 90 | 180 | 270}][PFO]
    Note:
  1. This OVERLAY subcommand cannot be specified if the PLACE subcommand is specified. Use the OVERLAY parameter of the PLACE subcommand instead.
  2. You can specify a maximum of 254 OVERLAY subcommands in a copy group.
name
Specifies the user access name (up to six characters) of an overlay to be placed with every page in each of the N_UP partitions.
    Note:
  1. The prefix O1 is not part of the six-character user-access name. The overlay name can be an alphanumeric.
  2. This name is not related to names as defined on the OVERLAY command.
rel-xrel-y
Specifies the horizontal and vertical adjustment to the position of the overlay. This is in addition to any offset values built into the overlay. The x and y values may be positive (+) or negative (-). You can specify them in inches (IN), millimeters (MM), centimeters (CM), POINTS, or PELS. If you do not specify a unit value, PPFA uses the unit value specified in the last SETUNITS command or uses a default unit value of inches.
PARTITION
Specifies that the overlay is to be placed relative to the partition origin.
OVROTATE
Specifies the rotation of the placed overlay with respect to the x-axis of the page.
Example:
Assuming the overlay has ( 0,0 ) placement coordinates, this causes page overlay O1x2 to be placed 1.5 inches to the right and 2.7 inches below the beginning of the page and rotated 90 degrees clockwise with respect to the page.
Formdef xmp1
     N_UP 1   PLACE 1 FRONT
              OVERLAY x2  1.5 in  2.7 in
              OVROTATE 90;
PFO
Specifies that this overlay is invoked as a PMC Printed Form Overlay. Only one PFO is allowed in an N-UP command.
PLACE Subcommand
PLACE n [FRONT | BACK] [CONSTANT] 
[OFFSET rel-x rel-y] 
Overlay Subcommand
[ROTATION {0 | 90 | 180 | 270}]
[VIEW {YES | NO}]

Places a page of data or a constant modification relative to a partition. Each PLACE subcommand specifies the number n of a partition on either the front or back side of the sheet. You must specify the same number of PLACE subcommands as the number of partitions on the sheet. The sequence of the PLACE subcommands is the sequence in which incoming pages are placed in the partitions.

    Note:
  1. The use of the PLACE subcommand indicates enhanced N_UP printing.
  2. The PLACE subcommand is valid only on printers that support enhanced N_UP printing. If PLACE is not specified, pages are placed in partitions in the default partition sequence.
n
Specifies the numbered partition (1–4) into which the page of data is placed. See N_UP 1 Partition Numbering, Front Sheet-Side through N_UP 4 Partition Numbering, Front Sheet-Side for the locale of each numbered partition.
FRONT
Specifies that this partition be placed on the front side of the sheet. This is the default.
BACK
Specifies that this partition be placed on the back side of the sheet.
CONSTANT
Specifies that no page data is placed by this PLACE subcommand.

Use CONSTANT when you are placing overlays without user's data or are placing fewer data pages on the sheet than the number of partitions specified in the N_UP subcommand.

For an example of using the CONSTANT parameter with overlays and to understand how the ordering of the PLACE subcommand affects overlays, see Enhanced N_UP Example 3: Asymmetric Pages.

OFFSET
Specifies a relative offset of the page horizontally (x) and vertically (y) from the partition origin.
rel-xrel-y
The default value is 0.1 inch for both x and y offsets. This OFFSET parameter overrides any other OFFSET parameters specified on the FORMDEF or COPYGROUP command. You can specify the units in inches (in), millimeters (mm), centimeters (cm), points, or pels. If you do not specify a unit value, PPFA uses the unit value specified in the last SETUNITS command or uses a default unit value of inches.
Note: You may specify this offset as negative in order to crop the top and/or left of an image.
OVERLAY Subcommand on PLACE Subcommand
OVERLAY name][rel-x rel-y][PARTITION]
[OVROTATE {0 | 90 | 180 | 270}][PFO]
Specifies the user access name (up to six characters) of an overlay to be placed with this PLACE subcommand. The overlay is placed relative to the page origin or, if the PARTITION keyword is specified, to the partition origin. You can specify multiple OVERLAY parameters in each PLACE subcommand.
rel-xrel-y
Specifies the horizontal and vertical adjustment to the position of the overlay. This is in addition to any offset values built into the overlay. The x and y values may be positive (+) or negative (-). You can specify them in inches (in), millimeters (mm), centimeters (cm), points, or pels. If you do not specify a unit value, PPFA uses the unit value specified in the last SETUNITS command or uses a default value of inches.
PARTITION
Specifies that the previous offset is from the partition origin. If not present, the offset is from the page origin, which is subject to the OFFSET parameter.
OVROTATE {0 | 90 | 180 | 270}
Specifies the rotation of the placed overlay with respect to the X-axis of the page.
PFO
Specifies that this overlay is invoked as a PMC Printed Form Overlay. Only one PFO is allowed in a PLACE.
ROTATION {0 | 90 | 180 | 270}
Specifies the clockwise rotation of the page and associated page overlays placed by this PLACE command.

Rotation turns the page and its associated page overlays around their fixed origin points. If you rotate the page without moving its origin point, you might rotate it off the physical medium. To prevent this, always offset the page origin to the place you want it to be for the rotated page, as shown in the next figure.

Offsetting the Page Origin for Rotated Pages

Offsetting the Page Origin for Rotated Pages
VIEW
Determines if this N_UP PLACE page is viewable. VIEW is relevant only when the page is being presented on a display. VIEW is ignored if the page is being printed. If VIEW is not coded, it is equivalent to specifying VIEW YES.
YES
Specifies that this N_UP page is viewable and is presented.
NO
Specifies that this N_UP page is not to be presented.

PELSPERINCH Subcommand
PELSPERINCH n
Specifies the Logical Units in pels per inch for this COPYGROUP. Use the PELSPERINCH parameter to tell PPFA the pel resolution of your printer to generate more exact object placements.
n
Specifies an integer number between 1 and 3,276. This value determines the Logical Units in pels per inch.
Note: If the L-Units are not specified on the copy group, they are inherited from the form definition.
Form-size Parameters
[XMSIZE x [units]]
[YMSIZE y [units]]
Specifies the medium presentation space (also known as the medium size or form length and form width).
    Note:
  1. This function requires both printer server and printer support. See your print server and printer documentation.
  2. The printer will not adjust the size of your media-presentation space to be larger than the paper size (or what has been defined in the printer as the paper size).
  3. Some printers (such as the InfoPrint 1145 and the InfoPrint 4100) do not support the IPDS Set Media Size (SMS) command. The form size cannot be set with the form definition. Do not use the XMSIZE and YMSIZE subcommands for those printers that do not support the SMS commands.
  4. Other printers (such as the 6400, 4247, and 4230) do not support the Set Media Origin (SMO) command. The media origin does not change. For the 6400, 4247, and 4230 printers form length is always YMSIZE and form width is always XMSIZE.
  5. For all other printers, use the settings shown in Table Form Length (LEN) and Form Width (WID). For these other printers, whether the XMSIZE or YMSIZE is actually form length or form width depends on the medium presentation space orientation, type of form, and N_UP setting. The following examples are from Table Form Length (LEN) and Form Width (WID). See the table for other media combinations.
    • Wide fanfold paper, PRESENT=Landscape, DIRECTION=ACROSS, and no-NUP - The form length is YMSIZE.
    • Narrow fanfold paper, PRESENT=Landscape, DIRECTION=ACROSS, and no-NUP - The form length is XMSIZE.
    • Cutsheet paper, PRESENT=Landscape, DIRECTION=ACROSS, and no -NUP - The form length is XMSIZE.
  6. There are only two choices. If you try one that doesn't work, try the other. For example, if you try XMSIZE for the form length and it doesn't create a longer form, use YMSIZE.
XMSIZE
This specifies the medium presentation space along the X-axis (also known as the medium's size in the X-direction). If this subcommand is specified on the FORMDEF command, it becomes the default for all copygroups which do not specify XMSIZE on the COPYGROUP command. If this subcommand is not specified on the FORMDEF command, the printer's current default X-axis becomes the default for all copygroups which do not specify XMSIZE on the COPYGROUP command.
x
Enter a number with 0 to 3 decimal places and optional units.
YMSIZE
This specifies the medium presentation space along the Y-axis (also known as the medium's size in the Y-direction). If this subcommand is specified on the FORMDEF command, it becomes the default for all copygroups which do not specify YMSIZE on the COPYGROUP command. If this subcommand is not specified on the FORMDEF command, the printer's current default Y-axis becomes the default for all copygroups which do not specify YMSIZE on the COPYGROUP command.
y
Enter a number with 0 to 3 decimal places and optional units.
units
Enter IN for inches, CM for centimeters, MM for millimeters, or PELS for pels. If units is not specified, the default is to the most recent setting of the SETUNITS command or inches if no SETUNITS command is coded.

Form Length (LEN) and Form Width (WID)

CUTSHEET and NARROW FANFOLD PAPER
DIRECTION ACROSS DOWN REVERSE
PRESENT Portrait Landscape Portrait Landscape Portrait Landscape
  LEN WID LEN WID LEN WID LEN WID LEN WID LEN WID
No NUP Ym Xm Xm Ym Xm Ym Ym Xm Ym Xm Xm Ym
1-UP Ym Xm Xm Ym Xm Ym Ym Xm Ym Xm Xm Ym
2-UP Xm Ym Ym Xm Ym Xm Xm Ym Xm Ym Ym Xm
3-UP Xm Ym Ym Xm Ym Xm Xm Ym Xm Ym Ym Xm
4-UP Ym Xm Xm Ym Xm Ym Ym Xm Ym Xm Xm Ym
WIDE FANFOLD PAPER
DIRECTION ACROSS DOWN REVERSE
PRESENT Portrait Landscape Portrait Landscape Portrait Landscape
  LEN WID LEN WID LEN WID LEN WID LEN WID LEN WID
No NUP Xm Ym Ym Xm Ym Xm Xm Ym Xm Ym Ym Xm
1-UP Xm Ym Ym Xm Ym Xm Xm Ym Xm Ym Ym Xm
2-UP Ym Xm Xm Ym Xm Ym Ym Xm Ym Xm Xm Ym
3-UP Ym Xm Xm Ym Xm Ym Ym Xm Ym Xm Xm Ym
4-UP Xm Ym Ym Xm Ym Xm Xm Ym Xm Ym Ym Xm

Code Examples

FORMDEF FMSZX1   Replace Yes
    PRESENT Landscape Direction Across
    XMSIZE 8.5 in YMSIZE 11.0 in;
 COPYGROUP cp1;
 COPYGROUP cp2;

FORMDEF FMSZX2   Replace Yes YMSIZE 17.0 in;
 COPYGROUP cp3;
 COPYGROUP cp4;

In the previous example:

  • The printer is a 4400 thermal printer which supports both SMS and SMO IPDS commands. The form definition named FMSZX1 defines a form length of 8.5 inches and form width of 11.0 inches. Copygroups cp1 and cp2 inherit those sizes from the form definition.
  • The printer is a 6400 printer and you want to define the form length. The form definition named FMSZX2 defines form length as 17 inches and leaves the form width as the printer default. Copygroups cp3 and cp4 inherit those sizes from the form definition.
  • If this is run on an MVS platform which has FORMLEN defined in the JCL, the JCL definition is used.