PrintedOutputOptionsSpec

Data items
Datatype specific settings

A complex data type that represents Output service options for tasks such as sending output to a network printer, an email recipient as a file attachment, or a file such as a PostScript file. PrintedOutputOptionsSpec variables are used to configure the Printed Output Options property in the generatePrintedOutput operation (deprecated) operation of the Output service.

For information about data that can be accessed using Xpath Expressions, see Data items.

For information about configuring default properties, see Datatype specific settings.

Data items

The data items that PrintedOutputOptionsSpec variables contain.

charset

A string value that represents the character set to use. For a list of character sets, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

copies

An int value that represents the number of copies that the Output service creates during printing. A positive integer must be specified. The default value is 1. If an invalid value is provided, the default value of 1 replaces the invalid value.

debug

A boolean value that determines whether debug-level logging is performed. A value of true indicates that debug-level logging is performed, and false indicates that the default level of logging is performed.

fileURI

A string value that represents the URI of a file to send the output.

generateManyFiles

A boolean value that specifies whether the Output service creates single or multiple output. A value of true indicates that multiple output are generated and false indicates a single output is generated.

lazyloading

A boolean value that specifies whether incremental (lazy) loading is used when processing multi-record data sets. When set to the a value of true, multi-record data sets are loaded and merged one record of data at a time. Processing one record at a time helps to avoid running out of memory. The use of incremental loading limits XLST options specified in the XCI file because transformations can only be applied to only one record.

locale

A string value that represents the locale to use. For a list of supported locale codes, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.doc.html.

lookAhead

An int value that represents the number of bytes that are used from the beginning of the input data file to scan for the pattern strings. The default value is 500.

lpdURI

A string value that represents the Line Printer Daemon (LPD) URI of an LPD that is running on the network.

metaDataSpecFile

A boolean value that indicates whether metadata is generated. A value of true indicates that metadata is generated and false indicates that metadata is not generated.

outputBin

A string value that represents the XCI value that is used to enable the print driver to select the appropriate output bin.

outputJog

A OutputJog value that indicates which output pages are physically shifted in the output tray. This data item is for use with PS and PCL printers only.

pageOffsetX

A string value that represents the page offset to use in the X-direction of the paper on which the output is printed. This value is useful when for printing on preprinted paper. This value overrides the page offsets defined in the XDC file, which represents non-printable area for any PCL device. This option is for PCL devices only.

pageOffsetY

A string value that represents the page offset to use in the Y-direction of the paper that the output is printed on. This value is useful for printing on preprinted paper. This value overrides the page offsets defined in the XDC file, which represents non-printable area for any PCL device. This option is for PCL devices only.

pagination

A Pagination value that represents the pagination to use for the output.

printerQueueName

A string value that represents the name of the printer queue that is used with the Line Printer Daemon (LPD) URI.

printerURI

A string value that specifies a destination for the print output. A value that represents the name of a network printer causes the Output service to send the print stream to a printer.

recordIdField

A string value that represents the name of the element that contains a batch record in the input data file.

recordLevel

An int value that represents the level of the XML element that contains a batch record. The batch record level is the element level (located within the input data file) that contains data records. The root element of the XML document is level 1. Do not specify a value for this data item if you specify a value for the recordName property.

recordLevelMetaData

A boolean value that specifies whether the Output service generates metadata. A value of true indicates metadata is generated and false indicates that metadata is not generated.

recordName

A string value that represents the element name that identifies the beginning of a batch of records. The element name is located within the input data file. Any value indicates that the input data contains record batches. Do not specify a value for this data item if you specify a value for the recordLevel item.

rules

A list of string values that represents search rules that scan the input data file for a pattern. This data item also associates the data with a specific form design.

serverPrintSpec

A string value that represents the filename of a print specification.

staple

A Staple value that specifies whether a stapler is used for printer output. Use this option for only PS and PCL printers.

XCIURI

A string value that specifies the XCI file to use. By default, the Output service uses an XCI file named pa.xci. The value in this data item overrides the default file.

Datatype specific settings

Properties to configure the options to use for rendering a printed PDF document.

General

XCI URI

Sets the XCI file to use. XCI files are used to describe fonts that are used for elements in a form design. XCI files are also useful for specifying print options such as number of copies, whether duplex printer is used, or stapler options.

Character Set

Sets the character set used to encode the rendered form. Select the character set to use or one of these values.

<Use Server Default>:: (Default) Use the Character Set setting that is configured on LiveCycle Server. The Character Set setting is configured using Administration Console. (See Adobe LiveCycle ES3 Administration Help.)
<Use Custom Value>:: Use a character set that is not in the list. After you select this value, in the box beside the list, type the canonical name of the encoding set that is not available. For a list of character sets, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

Locale

Sets the language used for generating the PDF document. Select a language from the list or one of these values.

<Use Server Default>:: (Default) Use the Locale setting that is configured on LiveCycle Server. The Locale setting is configured using Administration Console. (See Adobe LiveCycle ES3 Administration Help.)
<Use Custom Value>:: Use a locale that is not in the list. After selecting this value, in the box beside the list, type the Locale ID of the locale code to use. For a complete list of supported locale codes, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.doc.html.

Batch

Record Name

Sets the name of the element that identifies the beginning of a batch of records.

Record Level

Sets the XML element level that contains the record data. The default is 1, which represents the first level of the record that contains data. The first level is typically below the element specified by the Record Name property.

Generate Multiple Streams

Sets whether the operation creates a single or multiple output for each record that is merged with a form design. Select one of these values:

True:: Creates multiple outputs.
False:: (Default) Creates a single output.

Enable Lazy Loading

Sets whether incremental (lazy) loading is used when processing multi-record data sets. Select one of these values:

True:: Multi-record data sets are loaded and merged one record of data at a time. Processing one record at a time helps to avoid running out of memory, but limits the use of XSLT in the XCI file. The use of incremental loading limits XLST options specified in the XCI file because transformations can only be applied to only one record.
False:: All records are loaded and merged at one time because the entire data file is loaded.

Rules

Pattern Match Size

Sets the number of bytes to use from the beginning of the input data file to scan for the pattern strings. The default is 500.

Pattern Matching Rules

Sets rules for scanning the input data file for a pattern and associates the data with a specific form design.

Add A List Entry:: Adds a new rule. After you click this button, a new entry is created in the list. In the Pattern field for the new entry, type a pattern to search for. In the Form field, type the name of the form design for the matching pattern. All the form designs that you specify must be available at the location specified by the Content Root property in this operation.
Delete A Selected List Entry:: Removes the selected rule from the list.
For information about working with search rules, Designer Help.

Destination

Output Location URI

Sets the URI of the path and file to save the output file to. If you create multiple files, the filenames are suffixed with a numeric value.

Printer Name

Sets the name of the printer to send the output to for printing.

LPD URI

Sets URI of the Line Printer Daemon (LPD) to use.

LPD Printer Name

Sets the name of the printer on the specified Line Printer Daemon (LPD) URI to use.

Printer

Duplex Printing

Sets to use single-sided or two-sided printing. Select one of these values:

No (Simplex):: Use single-sided printing.
Duplex Long Edge:: Use two-sided printing and print using long-edge pagination.
Duplex Short Edge:: Use two-sided printing and print using short-edge pagination.

Staple

Sets whether to staple the output on printer. Select of these values:

Off:: Do not use the stapler on the printer.
On:: Use the stapler on the printer.
Use Printer Setting:: Use printer stapler settings.

Page Offset X

Sets the page offset in the horizontal direction. This value is useful when you print the job on preprinted paper and change the origin (for example, the default page offsets for that particular job). This value overrides the page offsets defined in the XDC file. The XDC file settings represent a non-printable area for any PCL device. This option is for PCL devices only.

Type a value and beside the box, select in (inches), mm (millimeters), cm (centimeters), or pt (points).

Page Offset Y

Sets the page offset in the vertical direction. This value is set when you print the job on preprinted paper and change the origin (for example, the default page offsets for that particular job). This value overrides the page offsets defined in the XDC file. The XDC file represents a non-printable area for any PCL device. This option is for PCL devices only.

Output Bin

Sets the output tray on the printer. For example, type outputtray1 to specify the first output tray on a printer. This value is used to enable the print driver to select the appropriate output bin.

Output Jog

Sets that the output pages that are physically shifted in the output tray. This option is only for printers that support PS and PCL. Select one of these values:

Use Printer Setting:: Use the jog option setting configured on the printer.
None:: Do not use jogging.
PageSet:: Use jog each time a set of pages are printed.

MetaData

Meta Data Spec File

Sets the URI of the metadata spec file to use. A metadata spec file is used to generate metadata from the provided data file.

Record ID XPath

Sets the root level node to use for XPath expressions. The root level node specifies the starting point for XPath expressions.

Generate Record Level Meta Data

Sets whether to generate a metadata file for each record. Select one of these values:

True:: Generate a metadata file for each record that is processed.
False:: (Default) Generate one metadata file all records that are processed.