generatePrintedOutput operation (deprecated)

Print Format

A PrintFormat value that specifies the page description language to use, when an XDC file is not provided, to generate the output stream.

If you provide a literal value, select one of these values:

Custom PCL:

Use the default XDC file for PCL or specify a custom XDC file for PCL. The default XDC file is hppc5e.xdc.

Custom PostScript:

Use the default XDC file for PostScript or specify a custom XDC for PostScript. The default XDC file is ps_plain.xdc.

Custom ZPL:

Use the default XDC file for ZPL or specify a custom XDC file for ZPL. The default XDC file is zpl203.xdc.

Generic Color PCL (5c):

Use a generic color PCL (5c). The hppcl5c.xdc file is used.

Generic PostScript Level3:

Use generic PostScript Level 3. The ps_plain_level3.xdc file is used.

ZPL 300 DPI:

Use ZPL 300 DPI. The zpl300.xdc is used.

ZPL 600 DPI:

Use ZPL 600 DPI. The zpl600.xdc file is used.

Custom IPL:

Use a custom IPL. The default XDC file is ipl203.xdc.

IPL 300 DPI:

Use IPL 300 DPI. The ipl300.xdc is used.

IPL 400 DPI:

Use IPL 400 DPI. The ipl400.xdc file is used.

Custom TPCL:

Use the default XDC file for TPCL or specify a custom XDC file for TPCL. The default XDC file is tpcl203.xdc.

TPCL 305 DPI:

Use TPCL 300 DPI. The tpcl305.xdc file is used.

TPCL 600 DPI:

Use TPCL 600 DPI. The tpcl600.xdc file is used.

Custom DPL:

Use the default XDC file for DPL or specify a custom XDC file DPL. The default XDC file is dpl203.xdc.

DPL300DPI:

Use DPL 300 DPI. The dpl300.xdc file is used.

DPL406DPI:

Use DPL 400 DPI. The dpl406.xdc is used.

DPL600DPI:

Use DPL 600 DPI. The dpl600.xdc is used.

Form

A string value that specifies the name of the form design. This value is combined with the value of the Content Root property in this operation to construct an absolute path to the form design.

If you provide a literal value, the name of the form must be typed in the box below the Form property.

For example, a folder in the repository named form designs contains the form design named form.xdp . To access the form design, type /form.xdp in the Form property and repository:///formdesigns in the Content Root property. The absolute path that is created is repository:///formdesigns/form.xdp , which is required to access the form design.

Content Root

A string value that specifies the URI, absolute reference, or location in the repository to retrieve a form design and XDC files. This value is combined with the value of the Form property in this operation to construct an absolute path to the form design. No default value is provided.

When you pick an asset from your application, the Content Root URI path must have the correct structure. For example, if a form is picked from an application named SampleApp, and is placed at SampleApp/1.0/forms/Test.xdp, the Content Root URI must be specified as repository://administrator@password/Applications/SampleApp/1.0/forms/ , or repository:/Applications/SampleApp/1.0/forms/ (when authority is null). When the Content Root URI is specified this way, the paths of all of the referenced assets in the form will be resolved against this URI.

Use the following sources for a URI or absolute reference:

Repository:

The repository contains assets that you upload to the LiveCycle server. The value repository:/// references the root of the repository. The first two forward slashes are part of the protocol (repository://) and the third forward slash represents the root of the repository.

Directory in the file system of the LiveCycle ES2 server:

A location on the LiveCycle server, such as C:\[folder name] . Using a location on the server is not recommended if you want to maximize the portability of an application.

Network directory:

A location on the network, such as \\[folder name] .

Web location that is accessible by using HTTP:

After uploading a file to a location on a web server, you can specify the location by using a URL. For example, type http:// [server name] :[port number]/ [folder name] . The value [server name] is the name of the web server, [port number] is the port number, and [folder name] is the name of the folder.

For example, a folder in the repository named formdesigns contains the form design named form.xdp . To access the form design, type /form.xdp in the Form property and repository:///formdesigns in the Content Root property. The absolute path that is created is repository:///formdesigns/form.xdp, which is required to access the form design.

XDC URI

(Optional) A string value that specifies the XDC file to use. XDC files are printer description files in XML format. The Output service uses XDC files to output documents to formats such as PostScript, PCL, DPL, TPCL, and ZPL. You can specify custom XDC files that are created using the LiveCycle ES2 XDC Editor. (See LiveCycle ES2 XDC Editor Help ). The XDC file that is provided as the default depends on the value selected for the Print Format property.

If you provide a literal value, type the name of the XDC file. This property is editable only when you select Custom PCL, Custom PostScript, Custom ZPL, Custom IPL, Custom TPCL, or Custom DPL in the Print Form property for this operation.

Printed Output Options

(Optional) A PrintedOutputOptionsSpec value that represents printer output options. Label printer formats (ZPL, DPL, TPCL, and IPL) only support copies. You specify the label printer formats using the Print Format property.

If you provide a literal value, set values for these properties.

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 the number of copies, whether duplex printer is used, or stapler options.

• Character Set : Sets the character set that is used to encode the rendered form. Select the character set to use or select one of these values:

  <Use Server Default>: (Default) Use the Character Set setting that is configured on the LiveCycle server. The Character Set setting is configured using LiveCycle Administration Console. (See Output Administration Help .)

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

  <Use Server Default>: (Default) Use the Locale setting configured in the form design. If a locale setting is not provided in the form design, the locale setting is used from the operating system where LiveCycle ES2.5 is installed.

  <Use Custom Value>: Use a locale that is not available 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 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 below the element specified by the Record Name property.

• Generate Multiple Streams : Sets whether the operation creates a single output or multiple outputs. Select one of these values:

• True: Create multiple outputs. Multiple outputs are useful to send each output after a record is completed processing.

• False: (Default) Create a single output. A single output is useful when sending all the processed records at the same time.

• Enable Lazy Loading: Sets whether incremental (lazy) loading is used when processing multi-record data sets. When incremental loading is used, it helps to reduce the amount of memory used on the LiveCycle server. The use of incremental loading limits XLST options specified in the XCI file because transformations can only be applied to only one record. Select one of these values:

  True: Multi-record data sets are loaded and merged one record of data at a time.

  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. For information about working with search rules, see Designing Forms for Output ES .

• Pattern Matching Rules : Sets rules for scanning the input data file for a pattern and associates the data with a specific form design. Click one of these buttons to add or delete an entry from the list.

  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 example, you can specify a pattern such as car , and specify the operation to use for the form design named AutoInsurance.xdp . The form AutoInsurance.xdp is used when the text car is in the data. For information about working with search rules, see Designing Forms for Output ES .

Destination

When you want to send output to printer, use the sendToPrinter operation operation. The sendToPrinter operation operation provides more flexibility for printing the output.

• Output Location URI : Sets the URI of path and file to save the output file to. If you create multiple files, the filenames are suffixed with a numeric value. For example, if you specify C:\forms\Loan.pdf, the Output service creates the filenames Loan0001.pdf, Loan0002, Loan0003, and so on, in the C:\forms folder on the LiveCycle server.

• Printer Name : Sets the name of the printer for sending the output for printing. The LiveCycle server must be connected to the specified printer. The value must be formatted as \\ [print server] \ [printer name] . The value [print server] is the name of a printer server and [printer name] is the name of the printer.

• LPD URI : Sets the URI of the Line Printer Daemon (LPD) to use when an LP daemon is running on the network. You can provide the value of an LPD, such as lpd://[ host name] , where [host name] is the name of the LPD host.

• LPD Printer Name : Sets the name of the printer on the specified Line Printer Daemon (LPD) URI when the network has an LP daemon running. The value must be formatted as [printer name] , where [print name] is the name of the printer.

Printer

• Duplex Printing : Sets whether duplex printer is used. Select one of these values:

  • duplexLongEdge : Use two-sided printing and print using long edge pagination.

  • duplexShortEdge : Use two-sided printing and print using short edge pagination.

  • simplex : Use single-sided printing.

• Staple : Sets whether to staple the output on printer. This value is used for printers that support PostScript and PCL. 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 distance of offset the page 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 distance of offset the page 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 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. No default value is provided.

For example, a metadata spec file can be created as follows:

<metadata-spec> 
<system> 
        <map xpath="$fileName" name="fName"/> 
        <map xpath="$format" name="docType"/> 
    </system> 
    <user> 
        <map xpath="header/txtOrderedByCompanyName" name="companyName"/> 
        <map xpath="header/txtOrderedByAddress" name="address"/> 
        <map xpath="header/txtOrderedByCity" name="city"/> 
        <map xpath="header/txtOrderedByStateProv" name="state"/> 
        <map xpath="header/txtOrderedByZipCode" name="zipCode"/> 
        <map xpath="header/txtOrderedByCountry" name="country"/> 
        <map xpath="header/txtOrderedByPhone" name="phone"/> 
        <map xpath="header/txtOrderedByFax" name="fax"/> 
    </user> 
</metadata-spec>

A metadata file is created with the data that is extracted from each record. The structure of the metadata file that is created is based on the metadata spec file. The resultant metadata file based on the previous metadata spec file is as follows:

<root><record id='null'> 
    <system> 
        <data name='fName'>c:\cumulativedata0001.pdf</data> 
        <data name='docType'>PDF</data> 
    </system> 
    <user> 
        <data name='companyName'>Any Company Name</data> 
        <data name='address'>555, Any Blvd.</data> 
        <data name='city'>Any City</data> 
        <data name='state'>Alabama</data> 
        <data name='zipCode'>12345</data> 
        <data name='country'>United States</data> 
        <data name='phone'>(123) 456-7890</data> 
        <data name='fax'>(123) 456-7899</data> 
    </user> 
</record>

Record ID XPath:

Sets the root level node to use for XPath expressions. The root level node specifies the starting point for XPath expressions. For example, consider a data schema as follows:

<batch_100> 
    <purchaseOrder> 
        <header> 
            <txtPONum>1of100</txtPONum>  
            <dtmDate>2004-02-08</dtmDate>  
            <txtOrderedByCompanyName>Any Company Name</txtOrderedByCompanyName>  
            <txtOrderedByAddress>555, Any Blvd.</txtOrderedByAddress>  
            <txtOrderedByCity>Any City</txtOrderedByCity>  
            <txtOrderedByStateProv>Alabama</txtOrderedByStateProv>  
        </header> 
        </detail 
            <txtPartNum>580463116</txtPartNum>  
            <txtDescription>Electric Fuel Pump</txtDescription>  
            <numQty>1</numQty>  
            <numUnitPrice>149.95</numUnitPrice>  
            <numAmount>149.95</numAmount>  
        </detail> 
    </purchaseOrder> 
</batch_100>

To reference the <purchaseOrder> tag as the first level in your XPath expression, set this property to value of 2. To set < batch_100> as the first level, set this property to 1.

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.

Input Data

A document value that represents the data that is merged with the form design.

If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset .)

Printed Output

The location in the process data model to store the printed output. The data type is document .

Meta Data Document

The location in the process data model to store the metadata. The data type is document .

Status Document

The location in the process data model to store the status result of the operation. The data type is document .

Output Result

The location in the process data model to store the results of the operation. The data type is OutputResult .