Subcommands

DEFAULT Subcommand
{DEFAULT | [C | X | A | E | U8 | U16]} 'record ID'
The DEFAULT subcommand defines a default record ID that is used only when the layout type is either PAGEHEADER or PAGETRAILER and no name is needed.
C’record ID'
A quoted name with a C for Character that are treated the same as a quoted name up to 250 characters. No folding or translation is done.
A’record ID'
A quoted name with an A for ASCII entered with up to 250 single-byte characters that are accepted as-is if on an ASCII platform or translated to ASCII if on an EBCDIC platform. The translation is made with no case folding.
E’record ID'
A quoted name with an E for EBCDIC entered with up to 250 single-byte characters that are accepted as-is if on an EBCDIC platform or translated to EBCDIC if on an ASCII platform. The translation is made with no case folding.
X’record ID'
A quoted name with an X for Hexadecimal entered with up to 500 hexadecimal characters. The characters are translated to hexadecimal, but no assumption of data type will be made.
Note: The values of all X'00' and all X'FF's are considered reserved and should not be used to specify the hexadecimal name value.
U8’record ID'
A quoted name with a U8 for UTF-8 entered with up to 250 single-byte characters that are translated to UTF-8.
U16’'record ID'
A quoted name with a U16 for UTF-16 entered with up to 125 single-byte characters that are translated to UTF-16.
BODY Subcommand
BODY 
    [NOGROUP | 
     GROUP] [XSPACE 0 | n {IN | MM | CM | POINTS | PELS }] | 
     PAGEHEADER | 
     PAGETRAILER |
     GRPHEADER [XSPACE 0 | n {IN | MM | CM | POINTS | PELS}]
The BODY subcommand defines the default layout type that is used for the majority of data in the user's database, normally printed line by line.
NOGROUP
The NOGROUP parameter indicates that the active group header record should be discarded and not reprinted on subsequent pages.
GROUP
The GROUP parameter indicates that the existing group header should be saved and used for subsequent pages.
XSPACE
XSPACE indicates the amount of extra space from the position of the layout to the bottom of the group header area. This allows the user to identify the amount of extra space in excess of one text line being used by the header so that the baseline moves down and the following group data is not placed on top of the header area. This space is not calculated by PPFA and must be explicitly defined by the user.
PAGEHEADER
This layout type specifies a header that is to be printed on each new page. The baseline position of this layout is normally in the top margin, but can be anywhere on a logical page. If RELATIVE is specified, the position is considered to be relative to the page origin. Usually contains customer's name, address, account number, and so forth. Only one default PAGEHEADER layout can be specified in a PAGEFORMAT and no input record data can be specified in a default layout.
PAGETRAILER
This layout type specifies a trailer that is to be printed on each new page. The baseline position of this layout is normally in the bottom margin, but can be located anywhere on a logical page and can be specified as RELATIVE. Only one default PAGETRAILER layout can be specified in a PAGEFORMAT and no input record data is processed with a default layout. It may contain the name of the form or a footnote.
GRPHEADER
This layout type specifies a header that is to be printed at the beginning of a group of data. If a logical page eject occurs before the group of data ends, the header is printed after the top margin on each new page until the group ends. The baseline position of this layout can be specified as RELATIVE. It may include column headings.
XSPACE
XSPACE indicates the amount of extra space from the position of the layout to the bottom of the group header area. This allows the user to identify the amount of extra space in excess of one text line being used by the header so that the baseline moves down and the following group data is not placed on top of the header area. This space is not calculated by PPFA and must be explicitly defined by the user. See example below (shaded space shows group header area):

Example Showing the Use of XSPACE.

Example Showing the Use of XSPACE.
Once a Group Header record is processed and is still active when leaving the PAGEFORMAT, the group header record is saved by the presentation services program. Whenever the same PAGEFORMAT is re-invoked, this saved group header record is presented again if the first body record after re-invoking the PAGEFORMAT selects a Body record that has the Group Indicator on.
NEWPAGE Subcommand 
NEWPAGE
This parameter indicates that a new page should be started with this layout name. If this is a header or trailer layout, the print position is moved to the start of a new page before this header or trailer becomes the active header or trailer.
DELIMITER Subcommand
DELIMITER {C | X} 'bytes'
Defines a delimiting character within the customer's database that is used to separate fields. PPFA translates the character data to the data type specified by the UDType subcommand on the PAGEDEF command.
C
The delimiter is specified as character data.
X
The delimiter is specified as hexadecimal data. Hex characters must be entered in uppercase within the quotation marks and are not translated.
'bytes'
The one- or two-byte delimiter code.
    Note:
  1. Delimiters specified after the Record ID are ignored.
  2. You cannot mix delimited and non-delimited fields on the same LAYOUT command.
PRINTDATA Subcommand
PRINTDATA {YES | NO}
Specifies whether the line of data associated with the current LAYOUT should be printed. The PRINTDATA subcommand is useful when the data stream is interspersed with lines of comments, blank lines, or lines without data that are not meant to be printed.
YES
Specifies the data for the current LAYOUT is printed. YES is the default.
NO
Specifies the data for the current LAYOUT
POSITION Subcommand
POSITION 
    [{SAME | =} | 
     LEFTMARGIN |
     horiz [IN | MM | CM | POINTS | PELS]] 
    [RELATIVE [NEXT | 
                     {SAME | = } | 
                     [(–)] vert [IN | MM | CM | POINTS | PELS]] |
     [ABSOLUTE] TOPMARGIN |
     ABSOLUTE [(–)] vert [IN | MM | CM | POINTS | PELS]]
The POSITION subcommand specifies the starting position of the layout in the printout. This is for use in positioning FIELD, DRAWGRAPHIC, and ENDGRAPHIC text and graphics. If RELATIVE is specified or POSITION is not specified, the baseline of the POSITION is relative to the previous LAYOUT position.
  1. For PAGEHEADER RCD: The baseline position can be anywhere on a logical page, but cannot be specified as Relative.
  2. For PAGETRAILER, GROUPHEADER and BODY RCDs: The baseline position can be anywhere on a logical page and can be specified as RELATIVE.
SAME
Specifies this line starts at the same horizontal offset position as the previously coded LAYOUT. If applied to the first LAYOUT of a logical page, the horizontal position is 0, which is the default.
=
Alternate for SAME.
horizontal position
x-pos
Specifies the horizontal offset from the left side of the logical page. The value is a number with up to three decimal places. The valid options for x-pos are described in the SETUNITS command for the horizontal value.
LEFTMARGIN
Specifies this line starts at the position specified as the horizontal (x) value in the previous LEFTMARGIN subcommand within this page definition.
RELATIVE
Specifies that the following vertical position value is to be processed as a relative value. The LAYOUT is positioned relative to the last LAYOUT placed on the page.
Note: If both TOP and RELATIVE are requested for the y-pos value, the RELATIVE request is ignored.

When using RELATIVE positioning, PPFA does not flag off-the-page conditions for the position of a LAYOUT or for any overlays, segments or objects placed relative to that LAYOUT. LAYOUTs that fall outside the bounds of the logical page are flagged by the print server at run time.

When specifying RELATIVE, use the minus sign to indicate any negative values for the LAYOUT vertical position; you may use the plus sign to indicate positive values. If no sign is used, a positive value is assumed.

The DIRECTION for a relative LAYOUT must be ACROSS. Fields associated with a relative LAYOUT must have the same DIRECTION as the LAYOUT and must match the PAGEFORMAT DIRECTION.

If RELATIVE is specified with SAME or = as the y value, the relative value in the LAYOUT is +0.

RELATIVE positioning is allowed on a LAYOUT command only if the LAYOUT and all its associated FIELD commands are formatted to print in the same direction as the PAGEFORMAT. That is, the DIRECTION parameter in the LAYOUT and any associated FIELD commands must specify (or default to) ACROSS. The DIRECTION in the PAGEFORMAT or PAGEDEF command may be any allowable value: ACROSS, DOWN, BACK, or UP.

vertical position
y-pos
Specifies the vertical offset from the top side of the logical page. The value options for y-pos are described in the SETUNITS command for the vertical value.
TOPMARGIN
Specifies that the LAYOUT is placed in the position specified as the vertical (y) value in the TOPMARGIN subcommand within this page definition.
NEXT
Specifies the layout is to be positioned down (on the logical page) one line (as defined in the LINESP subcommand of the last SETUNITS command) from the previous LAYOUT. The LINESP subcommand of the SETUNITS command establishes the distance from one line to the next.

When NEXT is specified for the first LAYOUT of a logical page, the starting position of the line is one line down from the top of the logical page, as defined by the TOPMARGIN subcommand.

Note: The down direction is determined by the direction of the logical page (as specified in the page format), not the LAYOUT direction. NEXT is, therefore, mainly useful in ACROSS LAYOUTs.

SAME
Specifies this LAYOUT starts at the same vertical position as the previous LAYOUT.
=
Alternate for SAME.
DIRECTION Subcommand
DIRECTION {ACROSS | DOWN | BACK | UP}
Specifies the print direction of the line relative to the upper-left corner as you view the logical page. Not all printers can print in all print directions. For more information about your printer, refer to your printer documentation.

If DIRECTION is not specified, the direction specified in the PAGEFORMAT command is used. Observe that this direction is additive to the direction specified in the PAGEFORMAT command. See PAGEFORMAT Command .

ACROSS
The layout direction is rotated 0 degrees relative to the direction specified in the PAGEFORMAT (the layouts are oriented in the same direction as the page).
DOWN
The layout direction is rotated 90 degrees relative to the direction specified in the PAGEFORMAT.
BACK
The layout direction is rotated 180 degrees relative to the direction specified in the PAGEFORMAT.
UP
The layout direction is rotated 270 degrees relative to the direction specified in the PAGEFORMAT.

ENDSPACE Subcommand
ENDSPACE n [IN | MM | CM | POINTS | PELS]

If the remaining body space is less than the value specified, ENDSPACE causes a logical page eject to be executed. This can be used, for example, on a GRPHEADER layout to ensure that a group header does not print at the end of a page without the first data record of the group. ENDSPACE does not include the space within the bottom margin (specified on the PAGEDEF or PAGEFORMAT command). This indicator is ignored on a PAGEHEADER or PAGETRAILER layout.

COLOR Subcommand
Specifies an OCA or defined color for the text of this field. This subcommand is recognized only by printers that support multiple-color printing. Refer to your printer publication for information about the colors that can printed. 
COLOR colorname
colorname
Values for colorname can be a defined color (see DEFINE COLOR Command), or an OCA colorname. Values for OCA colornames are:
  • NONE
  • DEFAULT
  • BLACK
  • BLUE
  • BROWN
  • GREEN
  • RED
  • PINK (or MAGENTA)
  • TURQ (or CYAN)
  • YELLOW
  • DARKBLUE (or DBLUE)
  • ORANGE
  • PURPLE
  • MUSTARD
  • GRAY
  • DARKGREEN (or DGREEN)
  • DARKTURQ (DTURQ, or DCYAN, or DARKCYAN)
The color choices depend on the printer.

If you do not enter one of these colors, the default color for that printer is used. NONE is the color of the medium, DEFAULT is the printer default color.

Note: In some printer manuals, the color turquoise (TURQ) is called cyan, and the color pink (PINK) is called magenta.

PPFA supports the following synonyms:

  • CYAN for TURQ
  • DARKCYAN for DARKTURQ
  • DBLUE for DARKBLUE
  • DCYAN for DARKTURQ
  • DGREEN for DARKGREEN
  • DTURQ for DARKTURQ
  • MAGENTA for PINK

Note: Do not specify both an OCA color with the COLOR sub-parameter and an extended color model on the same LAYOUT command. The output is device dependent and may not be what you expect.
Color Model Subcommands
[RGB rvalue gvalue bvalue} |
 HIGHLIGHT hvalue [COVERAGE cvalue] [BLACK bvalue] |
 CMYK cvalue mvalue yvalue kvalue |
 CIELAB lvalue [(–)] c1value [(–)] c2value]
These subcommands specify the color of print for this field supported in MO:DCA for the Red/Green/Blue color model (RGB), the highlight color space, the Cyan/Magenta/Yellow/Black color model (CMYK), and the CIELAB color model.
RGBrvalue gvalue bvalue
Three RGB integer values are used. The first (rvalue) represents a value for red, the second (gvalue) represents a value for green, and the third (bvalue) represents a value for blue. Each of the three integer values may be specified as a percentage from 0 to 100.
Note: An RGB specification of 0/0/0 is black. An RGB specification of 100/100/100 is white. Any other value is a color somewhere between black and white, depending on the output device.
HIGHLIGHThvalueCOVERAGEcvalueBLACKbvalue
Indicates the highlight color model. Highlight colors are device dependent.

You can use an integer within the range of 0 to 65535 for the hvalue.

Note: An hvalue of 0 indicates that there is no default value defined; therefore, the default color of the presentation device is used.

COVERAGE indicates the amount of coverage of the highlight color to be used. You can use an integer within the range of 0 to 100 for the cvalue. If less than 100 percent is specified, the remaining coverage is achieved with the color of the medium.

Note: Fractional values are ignored. If COVERAGE is not specified, a value of 100 is used as a default.

BLACK indicates the percentage of black to be added to the highlight color. You can use an integer within the range of 0 to 100 for the bvalue. The amount of black shading applied depends on the COVERAGE percentage, which is applied first. If less than 100 percent is specified, the remaining coverage is achieved with black.

Note: If BLACK is not specified, a value of 0 is used as a default.

CMYK cvalue mvalue yvalue kvalue
Defines the cyan/magenta/yellow/black color model. cvalue specifies the cyan value. mvalue specifies the magenta value. yvalue specifies the yellow value. kvalue specifies the black value. You can use an integer percentage within the range of 0 to 100 for any of the CMYK values.
CIELABLvalue(−)c1value(−)c2value
Defines the CIELAB model. Use a range of 0.00 to 100.00 with Lvalue to specify the luminance value. Use signed integers from -127 to 127 with c1value and c2value to specify the chrominance differences.

Lvalue, c1value, c2value must be specified in this order. There are no defaults for the subvalues.

    Note:
  1. Do not specify both an OCA color with the COLOR sub-parameter and an extended color model on the same LAYOUT command. The output is device-dependent and may not be what you expect.
  2. Do not specify two extended color model subcommands on the same LAYOUT command.

FONT Subcommand
FONT name1 [, name2]
Defines the font to be used for the layout.
name1
Specifies the name of a font used to print the data. This font must have been defined in a previous FONT command in this page definition.

If Shift-Out, Shift-In (SOSI) processing is used, name1 must be the single-byte font.

name2
Specify only when using Shift-Out, Shift-In (SOSI) processing to dynamically switch between a single-byte font and a double-byte font within the layout. name2 must be the double-byte font.
    Note:
  1. If this subcommand is not specified in the print data, the print server uses the font indicated. Otherwise, the print server selects a default font.
  2. name2 is only valid with EBCDIC data.
OBJECT Subcommand
OBJECT {lname [0 0 | relX relY] |
               VARIABLE VARIABLE Parameters [0 0 |relX relY]         
                   OBTYPE {PSEG | IOCA | BCOCA | GOCA | PTOCA |
                           OTHER OBID {comp-id | typename}}}  
 Other OBJECT Parameters
Specifies the name of an object that is to be positioned and oriented relative to the location specified in the LAYOUT command in which the OBJECT subcommand was named. The OBJECT, as identified by the lname parameter, must have been defined by an OBJECT command.
Note: Multiple page/image objects used without specifying a page using OBPAGE will default to using the first page in the object.

You may place multiple objects on the same LAYOUT command and you may place the same object multiple times. Each placement must have its own set of placement parameters, as follows:

lname
Specifies the local name of an object that is up to 16 alphanumeric characters in length. The lname is used to match the LAYOUT OBJECT subcommand to its definition from the OBJECT command. An object must be defined with this local name by the OBJECT command.
relative-xpos relative-ypos
Specifies the number of units (inches, mm, and so on) that are added to the position of the current LAYOUT to position the top-left corner of the object. The values for the horizontal and vertical positioning are limited by the type of printer used and the L-units specified with the PELSPERINCH parameter on the PAGEDEF or PAGEFORMAT command.

Each position specification can be a positive or negative number with up to three decimal places. The units specified can be one of the following: IN, MM, CM, POINTS, or PELS.

VARIABLE
Indicates that the actual name of the object is read from the data record. The Variable-Name-Locator field specifies where in the data to get the name.
    Note:
  1. Any object that is to be included in this manner should be defined in the PAGEDEF using the OBJECT command. Defining objects will enhance performance.
  2. If you specify VARIABLE for the OBJECT name and don't want to print the name, then you must have at least one field command, or code PRINTDATA NO on the LAYOUT command.

For VARIABLE parameters, see VARIABLE parameters.

OBTYPE
Used to specify the type of the object. Observe that each of the object types restricts the type of mapping option allowed in the placement of the object (OBMAP on the OBJECT subcommand on the PRINTLINE command.)
PSEG
Specifies a page segment object, as described in the Mixed Object Document Content Architecture (MODCA) Reference Manual. All mapping types (OBMAP) are allowed by PPFA, however, the print server issues an error if any of the objects contained in the page segment are not compatible with the coded OBMAP parameter.
GOCA
Specifies a graphic object, as described in the Graphics Object Content Architecture (GOCA) Reference Manual. GOCA allows you to specify TRIM, FIT, CENTER, REPEAT, and FILL parameters on the OBMAP subcommand.
BCOCA
Specifies a bar code object, as described in the Bar Code Object Content Architecture (BCOCA) Reference Manual. BCOCA allows you to specify only the LEFT parameter on the OBMAP subcommand.
IOCA
Specifies an image object, as described in the Image Object Content Architecture (BCOCA) Reference Manual. IOCA allows you to specify TRIM, FIT, CENTER, REPEAT, and FILL parameters on the OBMAP subcommand.
PTOCA
Specifies a presentation text object with Object Environment Group (OEG) as described in the Presentation Text Object Content Architecture (PTOCA) Reference Manual and the Mixed Object Document Content Architecture (MODCA) Reference Manual. The PTOCA object type allows you to specify the LEFT parameter in the OBMAP subcommand.
OTHER
Specifies other object data. The object data to be included is a paginated presentation object with a format that might or might not be defined by an AFP architecture. When you specify OTHER, you must also specify the OBID parameter. OTHER allows you to specify TRIM, FIT, CENTER, REPEAT, and FILL parameters on the OBMAP subcommand.
OBID
Specifies either a component identifier or a type name from Table NON-OCA Objects Supported by IOB. The OBID is translated into an Encoded OID and matched to the OID inside the object; they must match.
component-id
Specifies the component identifier.
type-name
The name chosen by PPFA as an alternative to coding a component identifier.

Non-OCA Objects Supported by IOB

Type Name Component ID Description of OBID Object Type
EPS 13 Encapsulated PostScript
TIFF or TIF 14 Tag Image File Format
WINDIB 17 Device Dependent Bit Map [DIB], Windows Version
OS2DIB 18 Device Dependent Bit Map [DIB], PM Version
PCX 19 Paint Brush Picture File Format
GIF 22 Graphics Interchange Format
JFIF, JPEG, or JPG 23 AFPC (AFP Consortium) JPEG Subset
PDFSPO 25 PDF Single Page Object
PCLPO 34 PCL Page Object
EPSTR 48 EPS with Transparency
PDFSPOTR 49 PDF Single Page Object with Transparency
MTIFF 61 TIFF Multiple Image File
MTIFFNT 62 TIFF Multiple Image without Transparency File
MPDF 63 PDF Multiple Page File
MPDFT 64 PDF Multiple Page with Transparency File
PNG 65 PNG File Format
AFPCTIFF 66 AFPC TIFF subset

Object Types that Can be Referenced as Secondary Resources

Type Name Component ID Description of OID Type-Name
PDFRO 26 PDF Resource Object (new)
RESCLRPRO 46 Resident Color Profile Resource Object
IOCAFS45RO 47 IOCA FS45 Resource Object Tile (new)
Other OBJECT Parameters
[OBSIZE [USEOBJ | wd  [unit] | hg [unit]]]
[OBMAP {LEFT | TRIM | FIT | CENTER | REPEAT | FILL}] 
[OBCHPOS [USEOBJ | x-pos]] 
[OBCVPOS [USEOBJ | y-pos]] 
[OBROTATE [0 | 90 | 180 | 270]]
[OBCOLOR colorname] 
[OBPAGE n]
[OBRESOLUTION x y {IN | CM}]
[OBCPSS PSS]
OBSIZE
Specifies the size of the object placement area. When no OBSIZE is specified, the default is the size specified in the object. If no size is specified in the object, the size of the page is used. The page width is as specified on the PAGEDEF or PAGEFORMAT commands, or it defaults to 8.3 inches by 10.8 inches.
wd
Specifies the width of an object placement area as a number with up to three decimal places. The allowable width may vary with the type of printer used and the L-units specified with the PELSPERINCH parameter on the PAGEDEF or PAGEFORMAT command.
unit
Specifies a unit of measurement for the width parameter. The choices are: IN, MM, CM, POINTS, or PELS.
Note: If no unit is specified, the default is the most recent SETUNITS command value or IN (inch) if a SETUNITS command has not been issued.
hg
Specifies the height of the object placement area as a number with up to three decimal places. The allowable height may vary with the type of printer used and the L-units specified with the PELSPERINCH parameter on the PAGEDEF or PAGEFORMAT command.
unit
Specifies a unit of measurement for the height parameter. The choices are: IN, MM, CM, POINTS, or PELS.
Note: If no unit is specified, the default is the most recent SETUNITS command value or IN (inch) if a SETUNITS command has not been issued.
USEOBJ
Specifies that the size measurements specified in the object are to be used. If no size is specified in the object, the size of the page is used, which is the length and width as specified on the PAGEDEF or PAGEFORMAT commands, or it defaults to 8.3 inches by 10.8 inches.
OBMAP
Specifies mapping options. The OBMAP parameter defines the mapping of the object to the object placement area. If OBMAP is not coded, the mapping option within the object is used. If the object does not contain a mapping option, then the print server sets it to the created default for the container type.

Each object type (OBTYPE on the OBJECT command) dictates the allowable mapping options for that type. When it can, PPFA issues a message when these rules are violated. However, in the case of an object type of page segment (OBTYPE=PSEG), PPFA does not know what types of objects are contained in it; therefore, PPFA cannot enforce the restrictions. See OBJECT Command for a description of the restrictions.

LEFT
Specifies that the object is positioned at the upper, left-hand corner of the object placement area, as defined or defaulted by the relative-xpos, relative-ypos, OBCHPOS, and OBCVPOS parameters. Any portion of the object that falls outside the object placement area as defined by the OBSIZE parameter is not trimmed and could cause an exception condition by the presentation system.
TRIM
Specifies position and trim. The object is positioned at the upper, left-hand corner of the object placement area, as defined or defaulted by the relative-xpos, relative-ypos, OBCHPOS, and OBCVPOS parameters. Any portion of the object that falls outside the object placement area as defined by the OBSIZE parameter is trimmed.
FIT
Specifies scale to fit; this is the default value if the OBMAP parameter is not coded. The object is to be scaled to fit within the object placement area, as defined by the OBSIZE parameter. The center of the object is placed in the center of the object placement area and the object is scaled up or down to fit the block. Scaling in the horizontal and vertical directions is symmetrical. The FIT parameter ensures that all of the data in the object is presented in the object placement area at the largest possible size. The object is not trimmed.
CENTER
Specifies that the center of the object be positioned at the center of the object placement area. Any portion of the object that falls outside the object placement area is trimmed.
REPEAT
Specifies that the origin of the data object be positioned with the origin of the object placement area. The object is then replicated in the X and Y directions. If the last replicated data does not fit in the object area, it is trimmed to fit.
FILL
Specifies that the center of the data object be positioned coincident with the center of the object placement area. The data object is then scaled, so that it totally fills the object placement area in both the X and Y directions. This may require that the object be asymmetrically scaled by different scale factors in the X and Y directions.
OBCHPOS
Specifies the horizontal offset of the object contents within the object placement area as a number.
x-pos
Specifies a positive or negative number. The valid options for x-pos are described in the SETUNITS command for the horizontal value.
USEOBJ
Specifies that the offset value from the object is to be used. If no value is set in the object, the value defaults to 0.
OBCVPOS
Specifies the vertical offset of the object contents within the object placement area, as defined by the OBSIZE parameter. If OBCVPOS is not specified, it defaults to USEOBJ and uses the value set in the object. If no value is set in the object, the value defaults to 0. The OBCHPOS parameter is used only in LEFT and TRIM mapping of the object into the object placement area.
y-pos
Specifies a positive or negative number. The valid options for y-pos are described in the SETUNITS command for the vertical value.
USEOBJ
Specifies that the offset value from the object is to be used. If no value is set in the object, the value defaults to 0.
OBROTATE { 0 | 90 | 180 | 270}
Specifies the object rotation with respect to the current LND's coordinate system.
OBCOLORcolorname
Specifies the color to be used as the default color or initial color for the object placement area. The OBCOLOR parameter is used only for objects of the PSEG, GOCA, BCOCA, IOCA, PTOCA and OTHER type.
colorname
Values for colorname can be a defined color (see DEFINE COLOR Command) or one of the OCA color spaces listed below.
  • NONE
  • DEFAULT
  • BLACK
  • BLUE
  • BROWN
  • GREEN
  • RED
  • PINK (or MAGENTA)
  • TURQ (or CYAN)
  • YELLOW
  • DARKBLUE (or DBLUE)
  • ORANGE
  • PURPLE
  • MUSTARD
  • GRAY
  • DARKGREEN (or DGREEN)
  • DARKTURQ (DTURQ, or DCYAN, or DARKCYAN)

In Figure Example of PPFA Support for IOB in a PAGEDEF, the page definition pd1 has defined an object with an external name of PSEGxyz, of object type PSEG. The object has an internal name of xyzintname. The internal name identifies the object for the LAYOUT OBJECT subcommand when the object is placed. Observe that case is not significant on either the internal nor the external names.

Example of PPFA Support for IOB in a PAGEDEF

PAGEDEF pd1 Replace Yes
  COMMENT 'this is my program';
  FONT XF1 ;

  OBJECT xyzIntName
    OBXNAME PSEGxyz
    OBTYPE  PSEG ;

PAGEFORMAT pf1;
  LAYOUT 'abc' POSITION 2 in  1 in;
    OBJECT xyzintname 1.1 in 2.1 in
    OBSIZE 3 in  5 in
     OBMAP FILL
     OBCOLOR BLUE ;

The LAYOUT in PAGEFORMATpf1 places the object on the page 1.1 inches to the left and 2.1 inches below the current LAYOUT position. It also maps the object into the object area with the FILL parameter, which centers the object in the object area and totally fills the area, possibly with different scaling factors in the X and Y directions. It has an area size of 3 by 5 inches, and overrides the default presentation space color to BLUE.

OBPAGE
Specifies the page number of a multipage object or file to be presented. n is the page number. A number from 1 to 999999999 (9 digits) is valid.
OBRESOLUTION
Specifies the resolution and unit of measurement of an image. If the resolution is already specified inside the image, this information is ignored by the printer. Use this subcommand for images that do not or may not contain their resolution. Specify resolution of an image so that the printer can print the image correctly.

To specify object resolution, you must have a printer and a print server (PSF or IPM) that support this capability.

If not specified, the default is to assume that the image resolution is the same as the printer. If the image does not print at the size you expect, use OBRESOLUTION to identify the image's resolution. With the resolution information, the printer will then be able print the image at the expected size.

x-res
Specifies the number to be used for the horizontal resolution of an image. Specify an integer value in the range of 1–3276.
y-res
Specifies the number to be used for the vertical resolution of an image. Specify an integer value in the range of 1–3276.
unit
Specifies a unit of measurement. The choices are:
IN
Inch
CM
Centimeter

Code Example:

In the following example, the OBJECT subcommand is used to define a JFIF object (which may be specified as JPG). This object has a a resolution of 300 pels per inch in both the x and y directions. 

Pagedef  obres2 replace yes;
 
 PRINTLINE  OBJECT VAR  .4 .5 start 2 length 6
            OBTYPE OTHER OBID JPG
            OBRESOLUTION 300 300 IN;

OBCPSS
Specifies the presentation space size to be used for the object. OBCPSS may be specified once. If OBCPSS is specified but no PSS value is entered, an error message will be issued.

PSS
Specifies the presentation space size. Values for PSS can be:
  • mediabox — Specifies MediaBox
  • cropbox — Specifies CropBox
  • bleedbox — Specifies BleedBox
  • trimbox — Specifies TrimBox
  • artbox — Specifies ArtBox

OVERLAY Subcommand
OVERLAY {name | VARIABLE VARIABLE Parameters} 
   [0 0 | rel. x-pos rel. y-pos]
Specifies the name of an overlay that is to be positioned relative to the location specified in the LAYOUT command in which the OVERLAY subcommand was named. The PAGEFORMAT OVERLAY command may contain the named overlays. The maximum number of overlays specified for a PAGEFORMAT including the LAYOUT OVERLAY subcommand is 254.
name
Specifies the user-access name as defined in the OVERLAY command.
    Note:
  1. PPFA checks for duplication of local names. If there is a duplication, the page definition is generated, but a warning message is issued.
  2. PPFA does not check for duplicate user-access names.
relative-xpos relative-ypos
Specifies the number of units (inches, mm, and so on) that are added to the position of the layout to position the top-left corner of the overlay. The values for horizontal and vertical may be (+) or (-). The maximum value is + or - 32760 L-units. For example: 
OVERLAY NAME1 2 in 1 in
OVERLAY NAME1 2 in 1 in
Note: Any offset coded in the overlay itself is added to this offset.
VARIABLE
Indicates that the actual name of the overlay, including the O1 prefix, is read from the data record. The Variable-Name-Locator field specifies where in the data to get the name.
    Note:
  1. Any overlay that is to be included in this manner must be defined in the PAGEFORMAT using the OVERLAY command. Any overlay included but not defined will cause a run time print error for a missing MPO structured field, for example APS263I.
  2. If you specify VARIABLE for the OVERLAY name and don't want to print the name, then you must have at least one field command, or code PRINTDATA NO on the LAYOUT command.
Variable Parameters
{[START n] LENGTH n |
 FLDNUM n [START n] [LENGTH n] |
 RECID [START n] [LENGTH n]}
STARTn
The starting position in the data record to get the overlay name. The first data byte position of the input record is 1. If START is not coded, 1 is assumed.
LENGTHn
Length of field. Specifies the number (n) of bytes to process from the data record, beginning with the position specified in START. The maximum length is 8.
FLDNUMn [STARTn] [LENGTHn]
The field number. This is the same as in the FIELD command. The overlay name is taken from the n field of the input data record. STARTn and LENGTHn describe which portion of the n field is used. If omitted, the entire field is used to form the overlay name.
RECIDn [STARTn] [LENGTHn]
Gets the name from the record ID. This is the same as in the FIELD command. Use STARTn and LENGTHn to use only a portion of the record ID, or leave them out to use the entire record field.
OVROTATE {0 | 90 | 180 | 270}
Specifies the rotation of the placed overlay with respect to the x-axis of the page.

See FORMDEF Command for an OVROTATE example, which is presented in the FORMDEF description.

SEGMENT Subcommand
SEGMENT {name | VARIABLE VARIABLE Parameters} 
   [0 0 | rel. x-pos rel. y-pos]}
Specifies the name of a segment that is to be positioned relative to the location specified in the LAYOUT command in which the SEGMENT subcommand was named. The PAGEFORMAT SEGMENT command may contain the named segments. The maximum number of segments specified for a PAGEFORMAT, including the LAYOUT SEGMENT subcommand, is 127.
name
Specifies the user-access name as defined in the SEGMENT command.
    Note:
  1. PPFA checks for duplication of local names. If there is a duplication, the page definition is generated, but a warning message is issued.
  2. PPFA does not check for duplicate user-access names.
relative-xpos relative-ypos
Specifies the number of units (inches, mm, and so on) that are added to the position of the layout to position the top-left corner of the page segment. The values for horizontal and vertical may be (+) or (-). The maximum value is + or - 32760 L-units. For example: 
SEGMENT MYSEG1 2 in 1 in
SEGMENT MYSEG1 2 in 1 in
VARIABLE
Indicates that the actual name of the segment, including the S1 prefix, is read from the data record. The Variable-Name-Locator field specifies where in the data to get the name.
Note: If you specify VARIABLE for the SEGMENT name and don't want to print the name, then you must have at least one field command, or code PRINTDATA NO on the LAYOUT command.

For VARIABLE parameters, see VARIABLE parameters.

Parent topic: LAYOUT Command (Record Format)