Subcommands

OBXNAME
Read syntax diagramSkip visual syntax diagram
|--OBXNAME--+-x-name------+-------------------------------------|
            +-'x-name'----+   
            +-C'x-name'---+   
            +-E'x-name'---+   
            +-A'x-name'---+   
            +-X'hhhh'-----+   
            +-U8'x-name'--+   
            +-X8'hhhh'----+   
            +-U16'x-name'-+   
            '-X16'hhhh'---'   

Specifies the external user access name of the resource object. The name indicates where on the file system the object is located.

Notes:
  1. As a file system name, it must adhere to the rules of the operating system where the object is located. For example, the x-name in z/OS® is the member name of the object in the object library, so it must be 8 characters or less and in uppercase EBCDIC code page 500.
  2. All the translations assume code page International #5 (code page 500) for EBCDIC and LATIN1 ISO/ANSI 8-bit (code page 819) for ASCII.
x-name
Unquoted name up to 250 characters long is folded to uppercase and translated into EBCDIC if necessary.
'x-name'
Quoted name up to 250 characters long is accepted as-is with no case folding or translation.
C'x-name'
Quoted name with a "C" for Character is treated the same as a quoted name up to 250 characters. No folding or translation is done.
A'x-name'
Quoted name with an "A" for ASCII entered with up to 250 single-byte characters is accepted as-is if on an ASCII operating system or converted to ASCII if on an EBCDIC operating system. The conversion is made with no case folding.
E'x-name'
Quoted name with an E for EBCDIC entered with up to 250 single-byte characters is accepted as-is if on an EBCDIC operating system or converted to EBCDIC if on an ASCII operating system. The conversion is made with no case folding.
X'hhhh'
Quoted name with an X for hexadecimal is entered with up to 500 hexadecimal characters. The characters are converted to hexadecimal, but no assumption of data type is made.
U8'x-name'
Quoted name with an U8 for UTF-8 entered with up to 250 single-byte characters is translated to UTF-8.
X8'hhhh'
Quoted name with an X8 for UTF-8 HEX entered with up to 500 single-byte hexadecimal characters is translated to hexadecimal and assumed to be data type UTF-8. A multiple of two hexadecimal characters must be entered.
U16'x-name'
Quoted name with a U16 for UTF-16 entered with up to 125 single-byte characters is translated to UTF-16.
X16'hhhh'
Quoted name with an X16 for UTF-16 HEX is entered with up to 500 single-byte hexadecimal characters. The characters are translated to hexadecimal and assumed to be data type UTF-16. A multiple of four hexadecimal characters must be entered.
To have portability across older versions of print servers in multiple system environments, it is recommended that resource object names use EBCDIC encoding with code page 500.
OBTYPE
Read syntax diagramSkip visual syntax diagram
|--OBTYPE--+-PSEG--------------------------+--------------------|
           +-IOCA--------------------------+   
           +-BCOCA-------------------------+   
           +-GOCA--------------------------+   
           +-PTOCA-------------------------+   
           '-OTHER--OBID--+-component-id-+-'   
                          '-type-name----'     

Used to specify the type of the object. Observe that each of the object types restricts the type of mapping option that is allowed in the placement of the object (OBMAP on the OBJECT subcommand on the PRINTLINE command (Traditional) or the LAYOUT command (Record Format and XML)).

PSEG
Specifies a page segment object, as described in the Mixed Object Document Content Architecture Reference. All mapping types (OBMAP) are allowed by PPFA; however, the print server issues an error if any of the objects that are contained in the page segment is not compatible with the coded OBMAP parameter.
GOCA
Specifies a graphics object, as described in the Graphics Object Content Architecture Reference. You use GOCA 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 Reference. You use BCOCA to specify only the LEFT parameter on the OBMAP subcommand.
IOCA
Specifies an image object, as described in the Image Object Content Architecture Reference. You use the IOCA object type 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 Reference and the Mixed Object Document Content Architecture Reference. You use the PTOCA object type to specify the LEFT parameter in the OBMAP subcommand.
OTHER
Specifies other object data. The object data that is included is a paginated presentation object with a format that might be defined by an AFP presentation architecture. When you specify OTHER, you must also specify the OBID parameter. You use the OTHER object type 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 1. 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
Type-name is a name that is chosen by PPFA as an alternative to coding a component identifier.
Table 1. 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 Paintbrush 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
Table 2. 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)
RENDER
Read syntax diagramSkip visual syntax diagram
|--RENDER--+-PERCEPTUAL-+---------------------------------------|
           +-SATURATION-+   
           +-RELCM------+   
           '-ABSCM------'   

Subcommand on the OBJECT command to specify the rendering intent (RI) for an object within a page definition.

RI is used to modify the final appearance of color data and is defined by the International Color Consortium (ICC). For more information about RI, see the current level of the ICC Specification.

Not all object types have rendering intent; in that case, rendering intent is ignored. The following list shows object types that can be specified as parameters on the OBTYPE subcommand, and the resulting rendering intent object type:
  • PSEG - rendering intent that is specified on a PSEG is used for all object types
  • IOCA - supported
  • BCOCA - not supported. Rendering intent for BCOCA objects is fixed as media-relative colorimetric (RELCM).
  • GOCA - supported
  • PTOCA - supported
  • OTHER - supported
rendering intent parameter
Specify the rendering intent for the preceding object type.
PERCEPTUAL
Perceptual rendering intent. It can be abbreviated as PERCP. With this rendering intent, gamut mapping is vendor-specific, and colors are adjusted to give a pleasing appearance. This intent is typically used to render continuous-tone images.
SATURATION
Saturation rendering intent. It can be abbreviated as SATUR. With this rendering intent, gamut mapping is vendor-specific, and colors are adjusted to emphasize saturation. This intent results in vivid colors and is typically used for business graphics.
RELCM
Media-relative colorimetric rendering intent. In-gamut colors are rendered accurately, and out-of-gamut colors are mapped to the nearest value within the gamut. Colors are rendered in regard to the source white point and are adjusted for the media white point. Therefore, colors that are printed on two different media with different white points do not match colorimetrically, but might match visually. This intent is typically used for vector graphics.
ABSCM
ICC-absolute colorimetric rendering intent. In-gamut colors are rendered accurately, and out-of-gamut colors are mapped to the nearest value within the gamut. Colors are rendered only in regard to the source white point and are not adjusted for the media white point. Therefore, colors that are printed on two different media with different white points must match colorimetrically, but might not match visually. This intent is typically used for logos.
CMYKSWOP | CMYKEURO
Read syntax diagramSkip visual syntax diagram
|--+----------+-------------------------------------------------|
   +-CMYKSWOP-+   
   '-CMYKEURO-'   

Indicates the color profile if it is required by the object.

OBNOKEEP
Read syntax diagramSkip visual syntax diagram
   .-OBNOKEEP-----------------------------------------------.   
|--+--------------------------------------------------------+---|
   |         .-NOPRELOAD----------------------------------. |   
   '-OBKEEP--+--------------------------------------------+-'   
             |          .-NOPRERIP----------------------. |     
             '-PRELOAD--+-------------------------------+-'     
                        '-PRERIP--| PreRip Parameters |-'       

This object name is not included in a Map Data Resource structured field so that the object is loadable each time the object is placed on the page.

OBKEEP
This object is included in a Map Data Resource at the beginning of the PAGEDEF making a hard object at the beginning of the page and then available throughout without reloading.
Note: Only objects with OBTYPE IOCA and OTHER can be kept; otherwise, OBKEEP is ignored.
NOPRELOAD
Do not preload this object.
PRELOAD
Preload this object before processing the print job.
NOPRERIP
Do not PreRip this object.
PRERIP
Prepare an object for printing by rasterizing it with its presentation parameters — object area size, object mapping option, object content offset, and object rotation in regard to the media leading edge.
PreRip Parameters
These parameters are used to specify the exact rasterization of the object, its size, offset, mapping, and rotations.
Notes:
  1. To specify multiple pages, rip sizes, mappings, and offsets for the same object, code multiple object commands.
  2. Mapping an object (also known as KEEPing) enhances throughput by allowing the printer to download an object once and use it on subsequent pages of the same print job or possibly on subsequent print jobs. Secondary objects are always mapped.
  3. Preloading an object consists of loading the object into the printer memory before the print job is started. This enhances throughput because it removes the downloading time from print-time to page build time.
  4. Preripping further enhances throughput because it allows the object and its secondary objects to be rasterized (RIPped) at the proper size and rotation when they are preloaded. When a primary object is preripped, all its secondary objects are also preloaded and preripped.
RIPSIZE
Read syntax diagramSkip visual syntax diagram
|--+-----------------------------------------+------------------|
   |          .-USEOBJ---------------------. |   
   '-RIPSIZE--+----------------------------+-'   
              '-wd--+------+--hg--+------+-'     
                    '-unit-'      '-unit-'       

Specifies the size of the object placement area. When no RIPSIZE is specified, the default is the size that is specified in the object. If no size is specified in the object, the size of the page is used. The page width is specified on the PAGEDEF or PAGEFORMAT commands, or it defaults to 8.3 inches by 10.8 inches.

USEOBJ
Specifies that the size measurements that are 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.
wd
Specifies the width of an object placement area as a number with up to three decimal places. The allowable width can vary with the type of printer that is used and the L-units that are specified with the PELSPERINCH parameter on the PAGEDEF or PAGEFORMAT command.
hg
Specifies the height of an object placement area as a number with up to three decimal places. The allowable height can vary with the type of printer that is used and the L-units that are 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 is not issued.
RIPMAP
Read syntax diagramSkip visual syntax diagram
|--+--------------------+---------------------------------------|
   '-RIPMAP--+-LEFT---+-'   
             +-TRIM---+     
             +-FIT----+     
             +-CENTER-+     
             '-FILL---'     

Specifies mapping options. The RIPMAP parameter defines the mapping of the object to the object placement area. If RIPMAP is not coded, the mapping option within the object is used. If the object does not contain mapping option, then the print server sets it to the created default for container type. Each object type (OBTYPE on the OBJECT command) specifies the allowable mapping options for that type. See the OBJECT OBTYPE parameter for a description of the restrictions.

FIT
Specifies scale to fit. This is the default value of the RIPMAP parameter is not coded. The object is to be scaled to fit within the object placement area, as defined by the RIPSIZE 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.
FILL
Specifies that the center of the data object is 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 might require that the object is asymmetrically scaled by different scale factors in the X and Y directions.
LEFT
Specifies that the object is positioned at the upper, left corner of the object placement area, as defined or defaulted by the relative-xpos, relative-ypos, and RIPOFFSET parameters. Any portion of the object that falls outside the object placement area as defined by the RIPSIZE parameter is not trimmed and might cause an exception condition by the presentation system. This mapping type is invalid with an IOCA object.
TRIM
Specifies position and trim. The object is positioned at the upper, left corner of the object placement area, as defined or defaulted by the relative-xpos, relative-ypos, and RIPOFFSET parameters. Any portion of the object that falls outside the object placement area as defined by the RIPSIZE parameter is trimmed.
CENTER
Specifies that the center of the object is positioned at the center of the object placement area. Any portion of the object that falls outside the object placement area is trimmed.
RIPOFFSET
Read syntax diagramSkip visual syntax diagram
|--+---------------------------------------------+--------------|
   '-RIPOFFSET--rel x--+------+--rel y--+------+-'   
                       '-unit-'         '-unit-'     

Object Content Offset - Specifies the horizontal and vertical offset of the object contents within the object placement area, as defined by the RIPSIZE parameter. If RIPOFFSET is not specified, the object is preprocessed and cached at its full size. The content offset specified at Include time is then used to place and possibly trim the object to the object area, with an associated performance penalty.

The RIPOFFSET parameter is used only in LEFT and TRIM mapping of the object into the object placement area.

rel x
Specifies the offset along the X-axis of the object area coordinates system. This can be a positive or negative number.
rel y
Specifies the offset along the Y-axis of the object area coordinates system. This can be a positive or negative number.
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 is not issued.
RIPROTATE { 0 │ 90 │ 180 │ 270 }
Read syntax diagramSkip visual syntax diagram
   .-RIPROTATE--0-----------.   
|--+------------------------+-----------------------------------|
   |            .---------. |   
   |            V         | |   
   '-RIPROTATE----+-0---+-+-'   
                  +-90--+       
                  +-180-+       
                  '-270-'       

Specifies the object rotation in regard to the leading edge of the media. Up to four rotations can be specified.

Note: Many factors, such as media selection, media side, media loading media orientation, page orientation, and object area rotation affect the orientation of an object in regard to the media leading edge. Therefore, proper specification of this parameter might require visual inspection of physical output.
RIPPAGE
Read syntax diagramSkip visual syntax diagram
|--+------------------+-----------------------------------------|
   '-RIPPAGE--+-n---+-'   
              '-ALL-'     

Specifies the page number of a multipage object or file to be pre-RIPped. n is the page number. A number 1 - 999999999 (9 digits) is valid. ALL specifies to pre-RIP all objects in a multipage object.

OB2RESOURCE
Read syntax diagramSkip visual syntax diagram
   .------------------------------------------------------------------------------------------------.   
   V                                                                                                |   
|----+--------------------------------------------------------------------------------------------+-+--|
     |                                                                              .-NOPRELOAD-. |     
     '-OB2RESOURCE--+-----------+--OB2XNAME--+-x2name------+--OB2ID--+-n---------+--+-----------+-'     
                    +-i2name----+            +-'x2name'----+         '-type-name-'  '-PRELOAD---'       
                    +-'i2name'--+            +-C'x2name'---+                                            
                    +-C'i2name'-+            +-E'x2name'---+                                            
                    +-E'i2name'-+            +-A'x2name'---+                                            
                    +-A'i2name'-+            +-X'hhhh'-----+                                            
                    '-X'hhhh'---'            +-U8'x2name'--+                                            
                                             +-U16'x2name'-+                                            
                                             +-X8'hhhh'----+                                            
                                             '-X16'hhhh'---'                                            

If the primary object contains a reference to one or more secondary objects, you must identify them. Specify the internal name for the secondary resource as specified in the primary resource. If the internal name contains special characters such as periods or blanks, then quotation marks must surround the name.

i2name
Unquoted name up to 250 characters long is folded to uppercase and translated into EBCDIC if necessary.
'i2name'
Quoted name up to 250 characters long is accepted as-is with no case folding or translation.
C'i2name'
Quoted name with a "C" for Character is treated the same as a quoted name of up to 250 characters. No folding or translation is done.
A'i2name'
Quoted name with an "A" for ASCII entered with up to 250 single-byte characters is accepted as-is if on an ASCII operating system or translated to ASCII if on an EBCDIC operating system. The translation is made with not case folding.
E'i2name'
Quoted name with an "E" for EBCDIC entered with up to 250 single-byte characters is accepted as-is if on an EBCDIC operating system or translated to EBCDIC if on an ASCII operating system. The translation is made with not case folding.
X'hhhh'
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 is made.
OB2XNAME
Read syntax diagramSkip visual syntax diagram
|--+---------------------------+--------------------------------|
   '-OB2XNAME--+-x2name------+-'   
               +-'x2name'----+     
               +-C'x2name'---+     
               +-E'x2name'---+     
               +-A'x2name'---+     
               +-X'hhhh'-----+     
               +-U8'x2name'--+     
               +-U16'x2name'-+     
               +-X8'hhhh'----+     
               '-X16'hhhh'---'     

Specifies the external name for a secondary resource object. The name can be up to 250 characters. If the name contains special characters or blanks, it must be enclosed in blanks.

Note: A file system name must adhere to the rules of the operating system where the object is located. This might further restrict the following sizes.
x2name
Unquoted name up to 250 characters long is folded to uppercase and translated into EBCDIC if necessary.
'x2name'
Unquoted name up to 250 characters long is accepted as-is with no case folding or translation.
C'x2name'
Quoted name with a C for Character is treated the same as a quoted name up to 250 characters. No folding or translation is done.
A'x2name'
Quoted name with an A for ASCII entered with up to 250 single-byte characters is accepted as-is if on an ASCII operating system or translated to ASCII if on an EBCDIC operating system. The translation is made with no case folding.
E'x2name'
Quoted name with an E for EBCDIC entered with up to 250 single-byte characters is accepted as-is if on an EBCDIC operating system or translated to EBCDIC if on an ASCII operating system. The translation is made with no case folding.
X'hhhh'
Quoted name with an X for Hexadecimal entered with up to 500 hexadecimal characters. The characters is translated to hexadecimal, but no assumption of data type is made.
U8'x2name'
Quoted name with an U8 for UTF-8 entered with up to 250 single-byte characters is translated to UTF-8.
X8'hhhh'
Quoted name with an X8 for UTF-8 HEX entered with up to 500 single-byte hexadecimal characters is translated to hexadecimal and assumed to be data type UTF-8. A multiple of two hexadecimal characters must be entered.
U16'x2name'
Quoted name with an U16 for UTF-16 entered with up to 125 single-byte characters is translated to UTF-16.
X16'hhhh'
Quoted name with an X16 for UTF-16 HEX entered with up to 500 single-byte hexadecimal characters is translated to hexadecimal and assumed to be data type UTF-16. A multiple of four hexadecimal characters must be entered.

All specified secondary resources are kept. See OBKEEP for more information.

OB2ID n | type-name
Read syntax diagramSkip visual syntax diagram
|--+----------------------+-------------------------------------|
   '-OB2ID--+-n---------+-'   
            '-type-name-'     

Component type identifier for secondary resource. Use an object type number as specified in Object type list adjustments. Use an object type number from the Component-ID column or a type name from the Type-Name column of Table 2.

NOPRELOAD | PRELOAD
Read syntax diagramSkip visual syntax diagram
|--+---------------+--------------------------------------------|
   | .-NOPRELOAD-. |   
   '-+-----------+-'   
     '-PRELOAD---'     

All specified secondary resources are kept. If you want the secondary object to be preloaded before the running of this job, specify it here.

OB2CMR
Read syntax diagramSkip visual syntax diagram
   .---------------------------------------------.   
   V                               .-NOPRELOAD-. |   
|----OB2CMR--cmr-lname--+-AUDIT-+--+-----------+-+--------------|
                        +-INSTR-+  '-PRELOAD---'     
                        '-LINK--'                    

Specify a Color management resource (CMR) and its process mode for a data object within the PAGEDEF. CMRs are secondary objects when used at this level. Multiple OB2CMR subcommands are allowed on the OBJECT command.

Note: See AFP Color Management for more information about using the CMR subcommand.
cmr-lname
The CMR local name. This name must be defined with a DEFINE CMRNAME command.
processing mode parameter
Specify the processing mode for the CMR.
AUDIT
CMRs with the audit processing mode refer to processing that is already applied to a resource. In most cases, audit CMRs describe input data and are similar to ICC input profiles.

The audit processing mode is used primarily with color conversion CMRs. In audit processing mode, those CMRs indicate which ICC profile must be applied to convert the data into the Profile Connection Space (PCS).

INSTR
CMRs with the instruction processing mode refer to processing that is done to prepare the resource for a specific printer by using a certain paper or another device. Generally, instruction CMRs refer to output data and are similar to ICC output profiles.

The instruction processing mode is used with color conversion, tone transfer curve, and halftone CMRs. In instruction processing mode, these CMRs indicate how the system must convert a resource so it prints correctly on the target printer. The manufacturer of your printer must provide ICC profiles or various CMRs that you can use. Those ICC profiles and CMRs might be installed in the printer controller, included with the printer on a CD, or available for download from the manufacturer's website.

LINK
This CMR defines a direct color conversion from an input color space to a device output color space; process the CMR as a link CMR. This processing mode is only valid for device link (DL) CMRs. The PPFA command RENDER is not used with device link (DL) CMRs as such CMRs specify the intended rendering intent internally. This function requires print server (PSF) and printer support, which is in addition to the original CMR support.
NOPRELOAD|PRELOAD
All specified secondary resources are kept. If you want the CMR object to be preloaded before the running of this job, specify it here.
Example: In the following code example, an object with CMR is defined. The following LAYOUT commands place the object on the page. The CMR name is defined and referenced by the CMR local name. See the DEFINE CMRNAME command for examples and instructions on defining CMR names.
PAGEDEF cmr89   replace yes;
    FONT  varb  gt10   ;           /*Variable data          */
    SETUNITS  LINESP .25 in ;      /* Line spacing          */

 DEFINE srgb CMRNAME
  'sRGBicc_CC001.000@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@'
   '@@@@@@';
 
 Object  oc1  obxname 'Flowers_with_sRGB_profile'
    obtype  other obid 23 OBKEEP
    ob2cmr srgb audit
    
    PAGEFORMAT  rept1   TOPMARGIN 1 in BOTMARGIN  2 in;
      LAYOUT 'startpage' BODY  NEWPAGE POSITION 1 in NEXT
        font varb
      object oc1 0 in 3 in obsize 6.5 in 8.5 in;
      LAYOUT 'basicline' BODY  POSITION SAME NEXT font varb;
OBRESOLUTION
Read syntax diagramSkip visual syntax diagram
|--+----------------------------+-------------------------------|
   '-OBRESOLUTION--x--y--+-IN-+-'   
                         '-CM-'     

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 might 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 is then able print the image at the expected size.
x
Specifies the number to be used for the horizontal resolution of an image. Specify an integer value in the range of 1 - 3276.
y
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
In the following code example, the OBJECT command is used to define two JFIF objects. One is pre-ripped and the other is not. One has a resolution of 300 pels per inch in both the x and y directions. The other has a resolution of 600 pels per inch in both the x and y directions.
SETUNITS 2 in 2 in;
Pagedef obxres
 
OBJECT obres1 OBXNAME xpseg23 OBTYPE other OBID JFIF
       OBRESOLUTION 300 300 IN;
OBJECT obres2 OBXNAME xpseg24 OBTYPE other OBID JFIF
       OBRESOLUTION 600 600 IN;
 
PRINTLINE OBJECT obres1
 23 PELS 01 PELS  OBMap TRIM  OBSIZE  1.2 in 1.3 in ;
PRINTLINE OBJECT obres2
 34 PELS 01 PELS  OBMap TRIM  OBSIZE  1.2 in 1.3 in ;

Examples

Example 1
In the following page definition, several examples of long names are shown, which is for illustration only.
  • OBU8 — The primary object name is specified in U8 format, which means that it is specified as a character string and translated to UTF-8 encoding.

    The secondary object that is defined on object OBU8 is referenced in the primary object with an identifier that is the equivalent of hexadecimal X'ABF8'. The external name for that object is specified in C format, which means that the name is accepted as it with no translation or folding of case.

  • OBU16 — This object name is specified in U16 format, which means that it is specified as a character string and translated to UTF-16 encoding.
  • OBX16 — This object name is specified in X16 format, which means that it is specified as a hexadecimal string that represents the UTF-16 encoding. It is not translated. The only check that PPFA makes is that its length is a multiple of 4.
    PAGEDEF LNNG2P  REPLACE YES;
      FONT FN1 GT10;
      OBJECT obU8 OBXNAME u8'A Long Object Name in UFT8'
      ' Which is continued on a second line'
      ' And could also be continued on a subsequent line'
             OBTYPE IOCA   OBKEEP PRELOAD
      OB2RESOURCE X'ABF8' OB2XNAME C'A plain old Character '
      ' type Secondary Object name which will be used as typed'
      ' in the code page of the User'  OB2ID PDFRO PRELOAD;
    
      OBJECT OBU16 OBXNAME U16'abcdef4'
             OBTYPE IOCA   OBKEEP PRELOAD;
    
      OBJECT obx16 OBXNAME X16'006100620063'
                              '0064006500660034'
             OBTYPE IOCA   OBKEEP PRELOAD;
    
      printline object obU8 FONT fn1;
      printline object obU16;
      printline object obX16;
Example 2
In the following page definition, an IOCA object is defined and placed. The object is to be mapped, preloaded, and preripped in 3 orientations (0, 90, 270). Object area size and offset mapping are specified. TRIM mapping specifies that the object is to be placed in the upper-left corner of the object area, as defined by the PRINTLINE position and RIPOFFSET parameters, and, if necessary, trimmed to the object area size, as defined by RIPSIZE.
PAGEDEF RipXml Replace Yes;
 OBJECT ripit OBXNAME FS45pic OBTYPE IOCA
        OBKEEP PRELOAD
        PRERIP
          RIPSIZE   3.0 in 4.0 in
          RIPMAP    trim
          RIPOFFSET 1.0 in 1.5 in
          RIPROTATE 0,90,270
        ;
 PRINTLINE OBJECT ripit;
Example 3
In the following page definition, multiple page objects are defined and placed. To specify the page number, see the descriptions of the parameters RIPPAGE and OBPAGE.
/*---------------------------------------------------------*/
/* MULTIEX2 multipage objects - Printline                  */
/* Examples                                                */
/*                                                         */
/*---------------------------------------------------------*/
 setunits 1 in 1 in linesp 6 lpi;                            
 pagedef multx2 replace yes pelsperinch 600                  
          width 8.5 height 11.0;                             
                                                             
 font f1 gt10;                                               
/*---------------------------------------------------------*/
/* Define objects                                          */
/*---------------------------------------------------------*/

/*---------------------------------------------------------*/
/* Multipage objects OBID type name                        */
/*---------------------------------------------------------*/
 object npt02 obxname TIFFNT1  obtype other obid MTIFFNT;    

/*---------------------------------------------------------*/
/* PRERIP ALL Multipage objects OBID component id          */
/*---------------------------------------------------------*/
 object pac03 obxname MPDF6 obtype other obid 63             
          OBKEEP PRELOAD PRERIP RIPPAGE ALL;                 
/*---------------------------------------------------------*/
/* PRERIP  page Multipage objects OBID type name           */
/*---------------------------------------------------------*/
 object ppt04 obxname MPDFT7  obtype other obid MPDFT        
          OBKEEP PRELOAD PRERIP RIPPAGE 6;                   
                                                             
/*---------------------------------------------------------*/
/* pgfmt01:                                                */
/*---------------------------------------------------------*/
 pageformat pfmt01 ;                                         
                                                             
/*---------------------------------------------------------*/
/* Layout for placing objects                              */
/*---------------------------------------------------------*/
/* type name no prerip, pages 1, 2, 3                      */
/*---------------------------------------------------------*/
 printline                                                   
    object npt02 obpage 1                                    
    object npt02 obpage 2                                    
    object npt02 obpage 3;                                   
                                                             
/*---------------------------------------------------------*/
/* pgfmt02:  PRERIP ALL                                    */
/*---------------------------------------------------------*/
 pageformat pfmt02 ;                                         
                                                             
/*---------------------------------------------------------*/
/* Layout for placing objects PRERIP                       */
/*---------------------------------------------------------*/
                                                             
/*---------------------------------------------------------*/
/* component id rip all, pages 4, 5, 6                     */
/*---------------------------------------------------------*/
 printline                                                   
    object pac03 obpage 4                                    
    object pac03 obpage 5                                    
    object pac03 obpage 6;                                   
                                                             
/*---------------------------------------------------------*/
/* pgfmt03: PRERIP page 6                                  */
/*---------------------------------------------------------*/
 pageformat pfmt03 ;                                         
                                                             
/*---------------------------------------------------------*/
/* Layout for placing objects PRERIP                       */
/*---------------------------------------------------------*/
                                                             
/*---------------------------------------------------------*/
/* type name rip 6, page 6                                 */
/*---------------------------------------------------------*/
 printline                                                   
    object ppt04 obpage 6;