PDFOutputOptionsSpec

A complex data type that represents options and settings to generate a PDF document. PDFOutputOptionsSpec variables are used to configure the PDF Output Options property in the generatePDFOutput 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 PDFOutputOptionsSpec variables contain.

    charset

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

    fileURI

    A string value that represents the URI of a file to which the Output service writes the output.

    generateManyFiles

    A boolean value that specifies whether the Output service creates single output or multiple outputs. A value of true indicates that multiple outputs are generated and false indicates 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 indicates the locale that the Output service uses to render the PDF document. 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 used for search rules. This value is the number of bytes to use 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 URI of the Line Printer Daemon (LPD) to use when the network has an LP daemon running.

    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.

    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 represents the URI of the destination for the print output. The Output service sends a print stream to the printer specified by the URI for this data item (for example, \\PrintServer\Print1).

    recoredIDField

    A string value that represents the identifier value for the batch record.

    recordLevel

    An int value that represents the element level (located within the input data file) that contains data records. The root element is level 1. This value cannot be used with the recordName value.

    recordLevelMetaData

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

    recordName

    A string value that represents the element name that identifies the beginning of a record in the input data file. Any value indicates that the input data contains record batches. This value cannot be used with the recordLevel value.

    rules

    A list of string values that contains string values that represent search rules that scan the input data file for a pattern and associates the data with a specific form design.

    serverPrintSpec

    A string value that represents the print specification name. A print specification contains information that the Output service requires during each invocation request. When you configure a print specification, the Output service sends the output to a network printer, an email recipient as a file attachment, or a file such as a PostScript file.

    XCIURI

    A string value that specifies the XCI file to use when generating PDF document output. An XCI file is a configuration file that the Output service uses. By default, the Output service uses an XCI file named pa.xci. Specify a value for this data item to use a different file.

    Datatype specific settings

    Properties for configuring the rendering options for PDF document.

    General

    XCI URI

    Sets the URI of where the XCI file is located.

    Character Set

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

    <Use Server Default>:
    (Default) The Character Set setting that is configured on LiveCycle Server. This setting is configured using Administration Console. (See Adobe LiveCycle ES4 Administration Help.)

    <Use Custom Value>:
    Use a character set that is not in the list. After selecting this value, in the box beside the list, type the canonical name (Java.nio API) of the encoding set that is not in the list. 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 to use from the list or one of these values.

    <Use Server Default>:
    (Default) Use the Locale setting configured on LiveCycle Server. The Locale setting is configured using Administration Console. (See Adobe LiveCycle ES4 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 outputs. Select one of these values:

    True:
    Create multiple outputs.

    False:
    (Default) Create 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.

    A green plus sign.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, see Designer Help.

    Destination

    Output Location URI

    Sets the URI and name of the output file to save.

    Printer Name

    Sets the name of the printer for sending the output for printing.

    LPD URI

    Sets the 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) to use.

    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 for all records that are processed.