PDFFormRenderSpec

acrobatVersion

An AcrobatVersion value that represents the Acrobat version that is required to view the PDF form that the Forms service renders.

cacheEnabled

A boolean value that indicates whether the Forms service caches a PDF form to improve performance. When caching is used, each form is cached after it is generated for the first time. On a subsequent render, if the cached form is newer than the form design’s timestamp, the form is retrieved from the cache. A value of true indicates that caching is used and false indicates caching is not used.

charset

A string value that represents the character set used to encode the output byte stream. The Forms service supports character encoding values defined by the java.nio.charset package for HTML transformations. For a complete list of character sets, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html

clientCache

A boolean value that determines whether the form is cached in the client web browser cache. Only forms that are rendered as interactive PDF forms can be stored in the client web browser cache.

When client caching is used and subsequent requests for the PDF form are made, a timestamp located in the cached PDF form is compared with the timestamp of the PDF form that is generated by the Forms service and stored in the server cache. If they are the same, the PDF form is retrieved from the client cache. This results in reduced bandwidth usage and improves performance because the Forms service does not have to redeliver the same content to the client web browser.

A value of true indicates that client caching is used and false indicates client caching is not used.

debugEnabled

A boolean value that determines whether debug-level logging is performed. Debug-level logging provides more information in the J2EE application server's log file. A value of true indicates that debug-level logging is performed, and false indicates that the default level of logging is performed.

formModel

A FormModel value that represents where the form processing is performed.

generateServerAppearance

A boolean value that determines whether the appearance, such as layout of PDF pages and other graphical elements, for the PDF form are generated on the server. When you generate the appearance on the server, the form is rendered on the server and merged with data. A value of true specifies to generate the appearance on the server.

linearizePDF

A boolean value that indicates whether the Forms service produces a linearized PDF form, which is a form that is optimized for web applications. A linearized PDF document enables incremental access in a network environment. For example, a linearized PDF document can be displayed in a web browser before the entire PDF document is downloaded. A value of true indicates the PDF is linearized and false indicates it is not linearized.

locale

A string value that represents the locale to use.

PDFVersion

A string value that represents the PDF version of the PDF form that is rendered. These string values are valid:

PDFVersion_1_5:

Represents PDF version 1.5.

PDFVersion_1_6:

Represents PDF version 1.6.

PDFVersion_7:

Represents PDF version 1.7.

renderAtClient

A RenderAtClient value that determines whether PDF content is rendered on the client application using Acrobat 7.0 or later, or on the server.

seedPDF

A string value that represents the location of a shell PDF (seed PDF) to use for optimizing the delivery of transformed PDF documents. The shell PDF document specifies a customized PDF document (contains only fonts) that is appended with a form design and data. The form is rendered by Acrobat 7.0 or later and applies to PDF form transformations.

standAlone

A boolean value that specifies whether the form is rendered without state information. This value is useful when the rendering of an interactive form occurs on the server and the form contains JavaScript code to execute.

A value of true indicates that the JavaScript code that the form contains runs on the client with no interaction with the server. A value of false indicates that state information is used to render an interactive form to an end user who then enters information into the form and submits the form back to the Forms service. The Forms service then performs a calculation operation and renders the form back to the user with the results displayed in the form.

taggedPDF

A boolean value that determines whether the Forms service produces a tagged PDF form. A value of true indicates a tagged PDF form is produced and a value of false indicates the PDF form is not tagged. A tagged PDF form defines a set of standard structure types and attributes that support the extraction of page content and reuse for other purposes. It is intended for tools that perform simple extraction, automatic redirection of flows, processing of text for searching or indexing, conversion to other common file formats, and making content accessible to users with visual impairment.

XCIURI

A string value that represents the URI of the XCI file to use for rendering. If the root of the URI is not specified, the file is assumed to reside in the LiveCycle EAR file.

XMLData

A boolean value that specifies to the Forms service to create XML data after the operation executes. A value of True specifies to produce the XML form’s data based on its current processing state and a value of False specifies not to produce XML data.

Character Set

Sets the character set used to encode the output byte stream. The default value is <Use Server Default>. Select the character set to use or one of these values.

<Use Server Default>:

Use the Character Set setting configured on the LiveCycle server. The Character Set setting is configured using LiveCycle Forms ES2 in LiveCycle Administration Console. (See LiveCycle ES2.5 Administration Help .)

<Use Custom Value>:

Use a character set that is not available in the list. After selecting this value, in the text box beside the list, type the canonical name (Java.nio API) of the encoding set to use. For a complete list of character sets, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html .

Locale

Sets the language used to send validation messages to client devices, such as web browsers, when an HTML form is rendered. The default value is <Use Server Default>. Select either a language from the list or one of these values.

<Use Server Default>:

Use the Locale setting configured on the LiveCycle server. The Locale setting is configured using LiveCycle Forms ES2 in LiveCycle Administration Console. (See LiveCycle ES2.5 Administration Help .)

<Use Custom Value>:

Use a locale that is not available in the list. After selecting this value, in the text 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 .

Cache Form On Server

Sets whether the form design is cached on the server. Caching forms on the server improves performance for forms that are rendered on the server. When no value is selected, the Form Cache Control settings are used. The Form Cache Control Settings are configured using LiveCycle Forms 9 in LiveCycle Administration Console. (See LiveCycle ES2.5 Administration Help .) Select one of these values:

False:

The form is not cached on the server.

True:

The form is cached on the server.

Acrobat Version

Sets the minimum version of Acrobat and Adobe Reader version required to open the rendered PDF form and the PDF Version used to create the PDF form. The default value is <Use Form Template Default>. Select one of these values:

<Use Form Template Default>:

The minimum version of Acrobat or Adobe Reader version is specified by the Target Version setting in the form design. The PDF Version that is used is determined by form design settings.

Acrobat and Adobe Reader 6 or later:

Acrobat or Adobe Reader 6 and later can open the PDF form. PDF Version 1.5 is used.

Acrobat and Adobe Reader 7.0 or later:

Acrobat or Adobe Reader 7.0 and later can open the PDF form. PDF Version 1.6 is used.

Acrobat and Adobe Reader 7.0.5 or later:

Acrobat or Adobe Reader 7.0.5 and later can open the PDF form. PDF Version 1.65 is used.

Acrobat and Adobe Reader 8 or later:

Acrobat or Adobe Reader 8 and later can open the PDF form. PDF Version 1.7 is used.

Acrobat and Adobe Reader 8.1 or later:

Acrobat or Adobe Reader 8.1 and later can open the PDF form. PDF Version 1.7-ADBE-1 is used.

Acrobat and Adobe Reader 9 or later:

Acrobat or Adobe Reader 9 and later can open the PDF form. PDF Version 1.7-ADBE-3 is used.

Populate XML Data

Sets whether the XML data is produced from the form design based on the its current processing state. The default value is False. Select one of these values:

False:

Do not produce the XML data.

True:

Produce the XML data.

Tagged PDF

Sets whether to create a tagged Adobe PDF form. A tagged PDF form defines a set of standard structure types and attributes that support the extraction of page content and reuse for other purposes. It is intended for tools that perform simple extraction, automatic redirection of flows, processing of text for searching or indexing, conversion to other common file formats, and making content accessible to users with visual impairment. It is intended for use by tools that perform the following types of operations:

• Simple extraction of text and graphics for pasting into other applications.

• Automatic reflow of text and associated graphics to fit a page of a different size than was assumed for the original layout.

• Processing text for such purposes as searching, indexing, and spell-checking.

• Conversion to other common file formats (such as HTML, XML, and RTF) with document structure and basic styling information preserved.

• Making content accessible by screen reader software.

The default value is True. Select one of these values:

False:

Do not render a tagged PDF form.

True:

Render a tagged PDF form.

Linearized PDF

Sets whether to render a linearized PDF form. A linearized PDF form is organized so that it supports incremental access in a network environment. For example, a linearized PDF can be displayed in a web browser before the entire PDF document is downloaded. The default value is False. Select one of these values:

False:

Do not render a linearized PDF form. It is best to use this option for non-web applications.

True:

Render a linearized PDF form. It is best to use this option for optimized web applications.

Seed PDF

Sets the name of the initial PDF form that is used in a PDF form to optimize delivery. The seed PDF form specifies a customized PDF form (contains only fonts) that is appended with a form design and data. The form design is rendered by Acrobat 7.0 or later and applies to the PDFForm and PDFMerge transformations.

Render At Client

Sets whether to enable the delivery of PDF content by using the client-side rendering capability for Acrobat 7.0 or Adobe Reader and later. Client-side rendering improves the performance of LiveCycle Forms 9 and only applies to PDF, PDFForm, or PDFMerge transformations. The default value is <Use Server Default>. Select one of these values:

<Use Server Default>:

Use the Render At setting to specify the version of Acrobat and Adobe Reader required to open a PDF Forms. The Render At setting is configured in LiveCycle Administration Console. (See LiveCycle ES2.5 Administration Help .)

<Use Form Template Default>:

The Forms service determines the form rendition based on the setting in the form design.

Yes:

A dynamic PDF form is generated. Rendering of a dynamic PDF form occurs only in Acrobat 7.0 or later.

No:

A static PDF form is generated. No rendering on the client occurs.

Stand Alone Rendition

Sets whether the form can be rendered without state information. State information is used for rendering interactive forms that require user interaction with the server for submissions.The default value is False. Select one of these values:

False:

The form is rendered without state information and without embedded JavaScript that runs on the client web browser. This means that the Forms service is used to render the form back to the user when performing actions such as calculations. The results of the calculation are displayed in the rendered form. Because of the required interaction with the Forms service, the form cannot be used offline.

True:

The form is rendered with state information and with embedded JavaScript. The JavaScript code runs on the client with no interaction with the server. In addition, the form can be used offline.

Form Model

Sets the location where scripts embedded in the form are to be executed. The default value is <Use Form Template Default>. Select one of these values:

<Use Form Template Default>:

The Forms service checks the form design to determine whether to render on the client or server.

<Client Side>:

The form is rendered on the client. Do not use scripts that run on the server. When this value is selected, scripts that run on the server generate a warning on the LiveCycle server.

<Server Side>:

The form is rendered on the server.

<Both Server and Client side>:

The form is rendered on both the server and the client.

XCI URI

Type a value to specify the URI location of the XCI file to use for rendering. If the root is not specified, the file is assumed to reside in the location where the LiveCycle EAR files are deployed.

Client Cache

Sets whether the rendered PDF form is cached on the client web browser. Only forms that are rendered as interactive PDF forms can be stored in the client web browser cache.

When client caching is used, the timestamps of the cached PDF form is compared with the timestamp of the PDF form generated on the server. If the timestamps are the same, the PDF form is retrieved from the client cache. When the compared timestamps are different, the server redelivers the PDF form. Using the cache on the client results in reduced bandwidth usage and improves performance. Performance improves because the Forms service does not have to redeliver PDF form to the client application. The default value is False. Select one of these values:

False:

Do not cache the form on the client.

True:

Cache the form on the client.

Generate Server Appearance

Sets whether the appearance for the PDF form is generated on the server. Appearances include the layout of fields and graphical elements in the PDF form. When you generate the appearance on the server, the form is rendered on the server and merged with data. Generate the appearance on the server to use the rendered PDF form in a subsequent operation.

False:

(Default) Do not generate the appearance on the server.

True:

Generate the appearance of the rendered PDF form on the server.