RenderOptionsSpec-FormsService

A complex data type that represents run-time options that control how the Forms service handles form submissions. RenderOptionsSpec-FormsService variables are used to configure the Submission Options property in the processFormSubmission operation operation of the Forms 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 RenderOptionsSpec-FormsService variables contain.

acrobatVersion

An AcrobatVersion value that represents the PDF version required for a client.

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 the form is cached and false indicates it is not cached.

CB

A boolean value that determines whether the generation of HTML-template initiating content, or guided forms content. True indicates to generate the HTML-template initiating content and False indicates to generate guided forms content.

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 these values, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.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 the timestamps are the same, the PDF form is retrieved from the client cache. Retrieving PDF forms from the client cache 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.

clientFrame

A string value that represents the client frame to use for HTML transformations. This value is not applicable for PDF forms.

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.

digSigCSSURI

A string value that represents the URI of a custom style sheet for a digital signature user interface in HTML forms.

exportDataFormat

A string value that indicates the data format that the Forms service uses to export data to a client application. These values are valid:

XDP:
Returns the data with XDP packaging.

XDPtoXFAData:
Returns the data with XDP packaging and data in the xfa:datasets packet (xfdf is converted to xfa data).

XDPDataOnly:
XDP format but without an embedded PDF or XFA template packet.

XMLData:
Returns the data without XDP or xfa:datasets packaging.

Auto:
Automatically determines the format based on the submitted data:
  • If XDP data is submitted, then XFA data is returned.

  • If XML data is submitted, then XML data is returned.

  • If URL-encoded data is submitted, then XMLdata is returned.

fontMapURI

A string value that represents the URI of the font mapping file. Font mapping defines which fonts are used in a form in place of a specified font that is not available. If the root of the URI is not specified, the file is assumed to reside in the EAR file.

formModel

A FormModel value that represents the location where the form is processed.

guideAccessible

A boolean value that indicates whether the form guide is accessible. A value of true indicates the form guide is created to be accessible and false indicates that it is not.

guideCBURL

A string value that represents the URL for a custom override implementation of the callback servlet.

guideName

A string value that represents the name of the guide within the generated form guide.

guidePDF

A boolean value that determines whether the output is rendered in the form guide and PDF form. A value of true indicates that both the form guide and PDF form are rendered and false indicates that only the form guide is rendered.

guideRSL

A boolean value that determines whether to use run-time shared libraries when compiling a form guide. A value of true indicates that shared libraries are used and false indicates they are not used.

guideStyle

A string value that represents the name of the style sheet that the form guide uses. The style sheet is also embedded in the form guide. The application container contains the style sheet, or the style sheet can be referenced.

guideSubmitAll

A boolean value that determines whether the form guide submits all data including hidden panels. A value of true indicates that all data is submitted and false indicates that all data is submitted except for data from hidden panels.

ifModifiedSince

For internal use only.

imageURL

A string value that represents the URL that receives image requests from the target device. This URL is inserted into the transformed output to facilitate retrieval of embedded images, such as images embedded within an XDP form.

This value is required only when authentication is required to retrieve the images.

If the value is not an absolute URL, the value of ApplicationWebRoot is combined with this value to construct an absolute URL. (See URLSpec .)

injectFormBridge

A boolean value that indicates whether the Forms service inserts special JavaScript code into a PDF form. The code performs operations on a PDF form when rendering guided forms. A value of true indicates the Forms service inserts the JavaScript code and false indicates it does not.

internalOptionMap

A map of string values that is for internal use only.

linearizedPDF

A boolean value that indicates whether the Forms service produces a linearized PDF form (optimized for web applications). A linearized PDF document is organized to enable 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 form is linearized and false indicates it is not linearized.

locale

A string value that indicates the locale that the Forms service uses to send validation messages to client devices, such as web browsers, when an HTML form is rendered. For a complete list of supported locale codes, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.doc.html .

options

A string value that represents the options that are set.

outputType

An int value that specifies how a form that is rendered as HTML is displayed. These values are valid:

0:
The form is rendered within <HTML> elements.

1:
The form is rendered within <body> elements.

pageNumber

An int value that represents the initial page number to render in a multipage HTML form. This option is not applicable to PDF forms.

PDF2XDP

A boolean value that determines whether the Forms service produces XDP output from submitted PDF content. By default, the Forms service returns the PDF content that is submitted.

If XDP output is produced, it contains the following elements:

  • A PDF data (base64-encoded).

  • A datasets packet that contains form data if the PDF content is XFA-based.

  • An XFDF packet that stores annotations. If the PDF content is an Acrobat PDF form, the XFDF also contains elements that represent form fields.

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.
Note: Acrobat 6.0 supports PDF version 1.5. Acrobat 7.0 and Acrobat 8.0 support PDF version 1.6.

propertyMap

A map of string values that is for internal use only.

re2DBarcode

A boolean value that determines whether the Forms service renders forms that contain two-dimensional (2D) barcodes and enables a user to fill the form using Adobe Reader. A value of true indicates that 2D barcodes can be rendered and false indicates that 2D barcodes cannot be rendered.

When a user fills an interactive form that contains a barcode, the barcode is updated automatically to encode the user-supplied data.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties.

reCommenting

A boolean value that determines whether the Forms service renders forms that allow users to add comments to the PDF form using Adobe Reader. A value of true indicates the service does render these forms and false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties.

reCreatePages

A boolean value that indicates whether the Forms service renders PDF forms that allow users to dynamically add pages within Adobe Reader. A value of true indicates that the service does render these forms and a value of false indicates it does not.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties

reCredentialAlias

A string value that represents the alias of the credential that grants Acrobat Reader DC extensions usage rights.

reCredentialPassword

A string value that represents the password for the alias that is specified for the reCredentialAlias property.

reDigSig

A boolean value that determines whether the Forms service renders PDF forms that allow users to digitally sign the form using Adobe Reader. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties

reEmbeddedAttachments

A boolean value that determines whether the Forms service renders PDF forms that allow users to add attachments to the form using Adobe Reader. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available and you need to set values for both the reCredentialAlias and reCredentialPassword properties.

reExpImp

A boolean value that determines whether the Forms service renders PDF forms that allow users to import and export form data using Adobe Reader. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties.

reFillIn

A boolean value that determines whether the Forms service renders PDF forms that allow users to fill form fields and save the PDF form using Adobe Reader. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties.

reFormFieldMod

A boolean value that determines whether the Forms service renders PDF forms that allow users to modify form fields and save the PDF form using Adobe Reader. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available.You must also set values for both the reCredentialAlias and reCredentialPassword properties.

renderAtClient

A RenderAtClient value that determines whether forms are rendered to PDF content on the server or on the client (Acrobat). When the value is auto and the acrobatVersion property is Acrobat_7_0_5 or Acrobat_8 , a form is rendered to a client once, which improves the performance of the Forms service. The rendered form behaves as a non-interactive form. (See AcrobatVersion .)

reOnlineCommenting

A boolean value that determines whether the Forms service renders the PDF form to allow users to add comments using Adobe Reader while online. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties.

reOnlineForms

A boolean value that determines whether the Forms service renders PDF forms that allow users to interact with forms while online using Adobe Reader. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available. You must also set values for both the reCredentialAlias and reCredentialPassword properties.

reReaderMessage

A string value that represents the message that appears in Adobe Reader that informs users that the form contains Acrobat Reader DC extensions usage rights.

reStandaloneSubmit

A boolean value that determines whether the Forms service should render PDF forms that allow users to submit information from within Adobe Reader. A value of true indicates that these forms can be rendered and a value of false indicates these forms cannot be rendered.

When you set this property value to true , the Acrobat Reader DC extensions service must be available and the reCredentialAlias and reCredentialPassword properties are set to True.

rootLocale

A string value that is for internal use only.

seedPDF

A string value that represents the name and location of the PDF document to use as the shell PDF (seedPDF) document.

A shell PDF contains only an XFA stream, font and image resources, and one page that is either blank or contains a warning that the document must be opened using Acrobat 7 or later or Adobe Reader 7. The shell PDF is used with PDF transformation to optimize delivery of PDFForm transformations only.

serviceId

A string value that is for internal use only.

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 instead of on the client, and the form contains JavaScript code that is executed.

A value of true indicates that the 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 is produced and a value of false indicates the PDF is not tagged.

Tags in a PDF form define a set of standard structure types and attributes. These standard types and attributes allow page content (text, graphics, and images) to be extracted and reused for other purposes. 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.

Tagged PDF files are not supported in PDF versions earlier than version 1.4.

toolbarMenu

A HTMLToolbar value that represents the appearance of an HTML toolbar that is rendered with an HTML form.

validationBorder

A string value that represents the validation border size, in pixels, when using frames in an HTML form.

validationReporting

An int value that represents the position within the frame where validation reporting is displayed if the ValidationUI option is 0 (list). This value specifies whether the list appears within a frame, and the location of the list relative to the form. This property is valid for forms that are rendered as HTML. These values are valid:

0:
The error is specified on the left of the form in a separate frame.

1:
The error is specified on the right of the form in a separate frame.

2:
The error is specified at the top of the form in a separate frame.

3:
The error is specified at the bottom of the form in a separate frame.

4:
The error is specified on the left of the page without a frame.

5:
The error is specified on the right of the page without a frame.

6:
The error is specified at the top of the page without a frame.

7:
The error is specified at the bottom of the page without a frame.

8:
No error reporting is provided.

9:
The error is logged but is not provided to the user interface.

10:
The error is not displayed if a form is within the frame.

validationUI

An int value that represents how errors are displayed. These values are valid:

0:
list

1:
message box

XCI

(Optional) A string value that represents XCI run-time options that are executed for renderForm and processFormSubmission operation operations. These XCI options override configuration values that are located within the XCI configuration file that the Forms service uses. The value has the following format:

[XPath-expression]=[value];[XPath-expression]=[value];...
  • [path-expression] is an XPath expression that resolves to the element in the XCI file to update. The XPath expression is relative to the root element of the XCI file. Only simple XPath expressions that contain "/" and "@" characters are supported.

  • [value] is the value to assign to the path expression. If the value is omitted, the element is cleared.

The following example changes the default typeface to Myriad® Pro:

present/pdf/fontInfo/defaultTypeface=MyriadPro 

Setting XCI options can affect the resulting PDF form. For example, consider the following XCI options:

present/pdf/fontInfo/embed=1&PDFVersion=1.6 
present/pdf/fontInfo/embed=1 

The size of the resulting files is different. When you set the PDF version to 1.6 the Forms service embeds the fonts as a subset. When you do not set the PDF version, the Forms service fully embeds the font. The PDF that contains the fully embedded font is at least twice as large as the file that has the fonts embedded as subset. Specify the PDF version to embed the font as a subset.

The following XCI elements can be configured:

  • acrobat/acrobat7/dynamicRender

  • data/outputXSL/uri (child of outputXSL element)

  • data/range

  • data/record

  • data/startNode

  • data/xsl/debug/uri (child of debug element; descendant of data element)

  • data/xsl/uri (child of xsl element; descendant of data element)

  • destination

  • fontInfo/defaultTypeface

  • locale

  • pdf/compression/compressLogicalStructure

  • pdf/compression/level

  • pdf/compression/type

  • pdf/encryption/encrypt

  • pdf/encryption/encryptionLevel

  • pdf/encryption/masterPassword

  • pdf/encryption/permissions/accessibleContent

  • pdf/encryption/permissions/contentCopy

  • pdf/encryption/permissions/documentAssembly

  • pdf/encryption/permissions/formFieldFilling

  • pdf/encryption/permissions/modifyAnnots

  • pdf/encryption/permissions/plaintextMetadata

  • pdf/encryption/permissions/print

  • pdf/encryption/permissions/printHighQuality

  • pdf/encryption/permissions/change

  • pdf/encryption/userPassword

  • pdf/fontInfo/embed

  • pdf/fontInfo/encodingSupport

  • pdf/fontInfo/map/equate

  • pdf/fontInfo/subsetBelow

  • pdf/interactive

  • pdf/openAction/destination

  • pdf/submitFormat

  • pdf/tagged

  • pdf/xdc/uri

  • present/pdf/linearized

  • present/pdf/renderPolicy

  • temp/uri (descendant of pdf element)

  • template/base (descendant of temp element)

XCIURI

A string value that represents 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 EAR file.

XDCURI

A string value that represents the URI location of an alternative XDC file to use for rendering. This property can be set to a valid URI, an absolute URI with protocols, or a file location. An alternative XDC file is typically used when the Forms service cannot locate an XDC file. For example, there is a network issue.

XMLData

A boolean value that indicates whether the Forms service produces the form’s XML data based on its current processing state. A value of true indicates that the current processing state is used and false indicates that some other state is used.

Datatype specific settings

Properties for configuring the rendering options when processing a submission to the Forms service.

HTML Output Type

Set whether to wrap the rendered page with Full HTML Tags or Body Tags. The default value is <Use Server Default>. Select one of these string values:

<Use Server Default>:
Use the default Output type setting configured on AEM forms Server. The Output type setting is configured using Forms in Administration Console. (See AEM forms administration help .)

Full HTML tags:
The rendered page is wrapped with <HTML> tags.

Body Tags:
The rendered page is wrapped with <BODY> tags.

Character Set

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

<Use Server Default>:
Use the Character Set setting configured on AEM forms Server. The Character Set setting is configured using Forms in administration console. (See AEM forms administration help .)

<Use Custom Value>:
Use a character set not available in 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 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 AEM forms Server. The Locale setting is configured using Forms in administration console. (See AEM forms 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 .

Display Validation Messages

Set whether to display messages in the web page or as a separate message box. The default value is <Use Server Default>. Select one of these string values:

<Use Server Default>:
Use the Reporting setting configured on AEM forms Server. The Reporting setting is configured using Forms in administration console. (See AEM forms administration help .)

In The Page:
Specifies that errors are returned as a list within the web page.

In The Message Box:
Specifies that errors are returned in a message box.

Validation Reporting

Sets a value to specify the position within the frame where validation reporting is displayed. This property is used when the Display Validation Messages option is set to In The Page. The default value is <Use Server Default>. Select one of these string values:

<Use Server Default>:
Use the Position setting configured on AEM forms Server. The Position setting is configured using Forms in administration console. (See AEM forms administration help .)

Frame Left:
The error is specified on the left of the form in a separate frame.

Frame Right:
The error is specified on the right of the form in a separate frame.

Frame Top:
The error is specified at the top of the form in a separate frame.

Frame Bottom:
The error is specified at the bottom of the form in a separate frame.

No Frame Left:
The error is specified on the left of the page without a frame.

No Frame Right:
The error is specified on the right of the page without a frame.

No Frame Top:
The error is specified at the top of the page without a frame.

No Frame Bottom:
The error is specified at the bottom of the page without a frame.

None:
No error reporting is provided.

No UI:
The error is logged but is not provided to the user interface.

No UI With Form:
The error is not displayed if a form is within the frame.

Validation Border

Type a value to specify the validation border size in pixels when using Frames in the Validation Reporting option. Use any integer value. When a value is not provided, the Border Size setting configured on AEM forms Server is used. The Border Size setting is configured using Forms in administration console. (See AEM forms administration help .)

Populate XML Data

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

False:
Specifies not to produce the XML data.

True:
Specifies to produce the XML data.

PDF to XDP

Select a value to specify whether to generate XDP output from submitted PDF content. The default value is False. Select one of these values.

True:
Generate the XDP output from the PDF content.

False:
Do not generate XDP output.

Export Data Format

Select a value to specify the format of the data that is exported to a client application. The default value is XDP. Select one of these string values:

<Use Form Template Default>:
Specifies to automatically determine the format based on the data that is submitted:
  • If XDP data is submitted, then XFA data is exported.

  • If XML data is submitted, then XML data is exported.

  • If URL-encoded data is submitted, then XML data is exported.

XDP:
Export the data with XDP packaging.

XDP to XFA Data:
Export the data with XDP packaging and data in the xfa:datasets packet (xfdf is converted to xfa data).

XDP Data Only:
Export the data with XDP packaging but without an embedded PDF or XFA template packet.

XML Data:
Export the data without XDP or xfa:datasets packaging.

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 AEM forms EAR files are deployed.

// Ethnio survey code removed