Subcommands

OFFSET rel-x rel-y [rel-x rel-y]

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

rel-x

Specifies the relative horizontal offset (negative or positive) 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.

The default unit is:

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

The default value is 0.1 IN.

rel-y

Specifies the relative vertical offset (negative or positive) 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. The default unit is:

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

The default value is 0.1 IN.

Note: The vertical offset for the 3800 must be 0.5 inch or greater.

REPLACE {NO | YES}

YES

Replace an existing form definition of the same name in the library if there is one. If a form definition with the same name does not exist in the library, then store this form definition.

NO

Do not replace an existing form definition of the same name. If a form definition with the same name does not exist in the library, then store this form definition. This is the default.

[BIN 1] | [BIN {n | MANUAL | ENVELOPE} 
   [MEDIANAME qstring] [COMPID m]]

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.

OUTBIN n

n

Specifies the output bin number.

CONSTANT {NO | BACK | FRONT | BOTH}

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.

CUTSHEET {NO | YES}

NO

Specifies the rotation data is not to be passed unless, of course, N_UP is coded.

YES

Specifies the rotation data is to be passed.

DIRECTION {ACROSS | DOWN | REVERSE}

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.

Here are some examples of FORMDEF finishing commands with PRESENT and DIRECTION:

FORMDEF fd00
    PRESENT portrait DIRECTION across ;
FORMDEF fd01
    PRESENT landscape DIRECTION across ;
FORMDEF fd02
    PRESENT portrait DIRECTION reverse ;
FORMDEF fd03
    PRESENT landscape DIRECTION reverse ;
FORMDEF fd04
    PRESENT portrait DIRECTION down ;
FORMDEFP fd05
    PRESENT landscape DIRECTION down ;

PRESENT {PORTRAIT | LANDSCAPE}

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 {NO | NORMAL | TUMBLE |RNORMAL | RTUMBLE}

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.

FINISH {SCOPE {PRINTFILE | ALL | n}[OPERATION Parameters]…

This option is to be used only on a document, set of documents, or an entire print file. Finishing operations are device dependent; check your printer documentation before using the FINISH subcommand.

SCOPE

Determines how 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 FORMDEF command. For example, only one SCOPE ALL is allowed in a FORMDEF FINISH command.

PRINTFILE

Determines that the specified finishing operations for the OPERATION subcommand are applied to the complete print file, excluding header pages, trailer pages, and message pages.

ALL

Determines that the specified finishing operations for the OPERATION subcommand are applied individually to all documents in the print file.

OPERATION Parameters

[[OPERATION CORNER AFP REFERENCE DEFAULT] | 
[OPERATION [AFP] {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.

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.

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 OPOFFSET 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 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.

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

OPERATION [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. This parameter can be used only for edge-type operations (for example, SADDLE, EDGE, FOLD, CFOLDIN, PUNCH, SADDLEIN, CUT, PERFORATE).

BOTTOM

Specifies that the reference edge is positioned along the bottom edge. This parameter can be used only for edge-type operations.

LEFT

Specifies that the reference edge is positioned along the left edge. This parameter can be used only for edge-type operations.

RIGHT

Specifies that the reference edge is positioned along the right edge. This parameter can be used only for edge-type operations.

TOPLEFT

Specifies that the reference corner is positioned at the top in the left corner. This 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.

Examples of Specifying Finishing Operations

To request scope as the entire print job with one corner staple in the top left corner, specify:

FINISH SCOPE PRINTFILE OPERATION CORNER REFERENCE TOPLEFT;

You can specify multiple finishing operations. To request that the fifth document in the job stream be finished using top left corner staple and the ninth document be edge stitched only at the print default location, specify:

FINISH SCOPE 5
         OPERATION CORNER
         REFERENCE TOPLEFT
SCOPE 9
         OPERATION EDGE;

The following example requests that SCOPE 5 (the fifth document in the job stream):

• Use the UP3i interface, be punched at the device default reference edge, and offset using the device default number and type of holes.
• Use the normal AFP interface to staple the top-left corner.

It also requests that SCOPE 9 (the ninth document in the job stream):

• Use the UP3i interface to be trimmed on the front.
• Use the normal AFP interface to be edge stitched at the printer default location and offset using the device default number and type of staples.

FORMDEF FinSm2 Replace Yes
   FINISH
      SCOPE 5 OPERATION UP3i XType X'0A'
              OPERATION      CORNER REFERENCE TOPLEFT
      SCOPE 9 OPERATION UP3i XType 6 XOper 1
              OPERATION AFP EDGE;

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 Note

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 n

n

The adjustment range can be set from 0 to 20 L-units. The default is 0. 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 {SHEET | NEXT | FRONT | BACK}

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 {YES | NO}

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 n

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')

CMRTAGFIDELITY {STOP | {CONTINUE | {NOREPORT | REPORT}

Specify the exception continuation and reporting rules for Color management resource (CMR) tag exceptions.

STOP

The CMR Tag exception rule is “Stop presentation at point of first CMR tag exception and report the exception.

CONTINUE

The CMR Tag exception rule is “Do not stop presentation because of CMR tag exceptions and do one of the following:

NOREPORT

Do not report the CMR tag exception to the print server. This is the default if neither NOREPORT nor REPORT is coded.

REPORT

Report the CMR tag exception.

PROCESSING [MEDIA_INFO {n… | PERFORATE| CUT}]…

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.

COMMENT qstring…

qstring

Specifies a quoted set of strings up to a total of 255 characters.

Note: In PPFA, a keyword or parameter (token) cannot extend across a line. Therefore, you must break the string into several strings in order to have a comment string that is longer than what fits on one line. Each string must be a complete token with beginning and ending quotes. For example:

FORMDEF replace yes
COMMENT 'first line of comment'
     'second line of comment';

PPFA composes the comment to be:

first line of comment second line of comment

and places it in a separate NOP structured field in the form definition.

COMPATPGP1

• The keyword COMPATPGP1 is coded on the form definition.
• The form definition is simplex.
• The form definition is not enhanced N_UP (with the PLACE subcommand).
• The form definition is not simple N_UP (with the PARTITION subcommand).

COMPIS3

Certain structured fields and keywords not compatible with the rules of the MO:DCA Interchange Set 3 are not allowed in the form definition. The following table indicates which PPFA parameters are not compatible with the rules of IS/3 and result in the error situations when COMPIS3 is requested. To use the function associated with these parameters, do not specify COMPIS3 on the FORMDEF command.

Follow these steps to update an existing form definition to IS/3 format:

1. Add COMPIS3 to the FORMDEF command.
2. Remove any parameters that are not compatible with IS/3 or that appear as IS/3 errors in the listing file messages.
3. Compile the form definition source using PPFA.

PELSPERINCH n

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.

PELSPERINCH Example

FORMDEF xmp01 replace yes
   PELSPERINCH 300 ;

   COPYGROUP C1
      offset 2 in 3 in;

   COPYGROUP C2
      offset 2 in 3 in
      PELSPERINCH 1200;

In Figure PELSPERINCH Example, the form definition xmp01 has specified L-Units as 300 pels per inch. Because the COPYGROUP C1 does not specify L-Units, it inherits 300 pels per inch. COPYGROUP C2 does specify L-Units as 1200 pels per inch.

The code in COPYGROUP C1 (offset 2 in 3 in) produces internal and structured field values for x and y of 600 and 900, whereas in COPYGROUP C2 the same code produces values of 2400 and 3600, because of the difference in L-Units.

BINERROR {STOP | CONTINUE}

This subcommand is displayed only on the FORMDEF command, not the COPYGROUP or the SUBGROUP commands, because the scope of the subcommand is throughout the form definition. Printing control is based on the status of the media loaded as it pertains to the BIN subcommand in effect at the time.

STOP

If the specified input bin is in error, stop the print job and hold it in a state from which it can be resubmitted.

CONTINUE

If the specified input bin is in error, continue printing using the printer default input bin.

COLORVALUERR {STOP | CONTINUE [NOREPORT | REPORT]}

STOP

Specifies that an error should be issued by the printer and the job terminated if the printer encounters a color exception. A color exception occurs if the color specification in the data stream cannot be rendered as specified. Also, a color exception occurs if the host print server supports color fidelity and the target printer does not.

CONTINUE

Specifies that an exception condition should be ignored. Also, the printer substitutes colors for any that it cannot render, and the job continues.

NOREPORT

Specifies that the printer should not report the error. NOREPORT is the default if COLORVALUERR CONTINUE is coded and neither REPORT nor NOREPORT is coded.

REPORT

Specifies that the printer should report the error.

FINERROR {STOP | CONTINUE [NOREPORT | REPORT]}

If both the host PSF and target printer support finishing fidelity, the FINERROR subcommand on the FORMDEF command lets you control job continuation and error reporting. If a form definition requests a finishing operation that is not available with the printer, you may request that the job continue processing or cause it to stop printing.

FINERROR only covers operations that the printer cannot process; for example, a stapling operation has been specified on a device that is not equipped with a stapler. It does not cover temporary exceptions that require operator intervention, such as an empty stapler.

STOP

Specifies that the job should be terminated when the printer detects a finishing exception. A finishing exception that stops presentation is reported and the print file is held to be resubmitted when the finishing operation can be performed.

CONTINUE

Specifies that an exception condition should be ignored and that the job should continue without applying the unavailable finishing operation.

NOREPORT

Specifies that the printer should not report the error. NOREPORT is the default if FINERROR CONTINUE is coded and neither REPORT nor NOREPORT is coded.

REPORT

Specifies that the printer should report the error.

Note: When the printer encounters a finishing exception, the following actions are taken:

• If the print server and the printer both support finishing fidelity and the FINERROR subcommand is coded, printing stops or continues as previously described.
• If the print server and the printer both support finishing fidelity and the FINERROR subcommand is not coded, the job is printed and the finishing operations that cannot be performed are not applied. Finishing exceptions are reported.
• If the print server supports finishing fidelity, but the printer does not, the following rules apply:
  • If you specify FINERROR STOP, the print server issues an error message and stops processing.
  • If you specify FINERROR CONTINUE, the print server prints the job and either issues a message if REPORT is specified or does not issue a message if NOREPORT is specified
• If the print server does not support finishing fidelity, the job is printed and the finishing operations that cannot be performed are not applied. Finishing exceptions are reported.

FINERROR Examples

FORMDEF xmp01 FINERROR STOP REPLACE YES;
   Copygroup X … ;

FORMDEF xmp02 FINERROR Continue NoReport;
   Copygroup Y … ;

Assuming that both the print server and the printer support finishing fidelity:

• In the first example, FORMDEF xmp01 specifies a STOP parameter. If the specified finishing operation is not available, the printer reports an error, does not print the job, and places the job on hold to be resubmitted when the finishing operation can be performed.
• In the second example, FORMDEF xmp02 specifies a CONTINUE NOREPORT parameter. If a specified finishing operation is not available, the printer continues processing the print job without applying the unavailable finishing operation or reporting the error.

FONTFID {NO | YES}

NO

Specifies that the print server will not enforce font fidelity. The print server does not check for a match of the specified resolution and metric with the font found on the system.

YES

Specifies that no substitution is allowed and the print server issues an error message if it cannot find the font that matches the specified resolution and metric.

TONERSAVER {DEVSETTING | OFF | ON}

Specifies whether or not the printer's toner saver mode should be activated.

DEVSETTING

Use the printer setting.

OFF

Do not activate toner saver mode.

ON

Activate toner saver mode.

N_UP {1 | 2 | 3 | 4] [OVERLAY Subcommand… | PLACE 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: This OVERLAY subcommand cannot be specified if the PLACE subcommand is specified. Use the OVERLAY parameter of the PLACE subcommand instead.

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

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.

[VFYSETUP verificationID… | VFYSETUPD decimal_verificationID…]

verificationID…

One or more 2-character (4-digit hexadecimal) identifiers that match the setup verification IDs defined at the printer operator's console for the specific print job. For example, if the setup verification IDs defined at the printer are X'012F', X'0521', and X'938A', specify the following:

FORMDEF vfy7 REPLACE YES VFYSETUP 012F 0521 938A;

decimal_verificationID…

One or more decimal numbers that match the setup verification IDs defined at the printer operator's console for the specific print job. For example, if the setup verification IDs defined at the printer are 303, 1313, and 37770, specify the following:

FORMDEF vfy7 REPLACE YES VFYSETUPD 303 1313 37770;

When the print server processes the print job, it compares the setup verification IDs in the form definition to the IDS that are active in the printer. If the active IDs in the printer do not match the IDs required by the form definition, or if the printer does not support FORMDEF setup verification IDs, the job is held.

TEXTERROR {STOP | CONTINUE [NOREPORT | REPORT]}

STOP

The printer terminates the job and reports the text exception. The print file is put into a state where it can be resubmitted when the text can be rendered without exceptions.

CONTINUE

The printer skips the text control sequence that it does not recognize and continues processing the print job.

NOREPORT

The printer does not report the error. This is the default.

REPORT

The printer reports the error.

[XMSIZE x [units]]
[YMSIZE y [units]]

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.

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.