renderHTMLForm operation (deprecated)

Form To Render

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

If you provide a literal value, the name of the form must be typed in the box below the Form To Render 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 To Render property and repository:///formdesigns in the Content Root URI property. The absolute path created is repository:///formdesigns/form.xdp, which is required to access the form design.

Transform To

A TransformTo value specifies the type of HTML form to generate.

If you provide a literal value, no default is provided. Select one of these values:

AUTO:

The Forms service determines the optimal transformation to perform.

XHTML:

Generates HTML that is XHTML standard-compliant.

NoScriptXHTML:

Generates HTML that is compatible with the CSS2 specification and compliant with XHTML 1.0. The HTML output does not contain client-side JavaScript but can still include server-side JavaScript.

HTML4:

Generates HTML that is compatible with older browsers that do not support absolute positioning of HTML elements.

MSDHTML:

Generates HTML that is compatible with dynamic HTML for Internet Explorer 5.0 or later.

AHTML:

Generates HTML that is compatible with accessibility-enhanced browsers (Internet Explorer 5 or later).

StaticHTML:

Generates HTML that does not allow users to enter data in the fields of HTML forms. Static HTML is useful in processes that are for displaying information.

AccessibleXHTML:

Generates HTML that is XHTML 1.0 standard-complaint. Elements in the HTML form are positioned by using the relative units em. Using relative units helps to ensure that an HTML form appears correctly when tools are used to make content accessible to users with visual impairment.

NoScriptAccessibleXHTML:

Generates HTML that is compliant with the XHTML 1.0 standard and CSS2 specification. The XHTML also does not contain client-side JavaScript, although server-side JavaScript can be included. Elements in the HTML form are positioned by using the em tag, which is a relative unit. Using relative units helps to ensure that an HTML form appears correctly when tools are used to make content accessible to users with visual impairment.

Form Data

A document value that represents the data to merge with the form during rendering. Form data that is provided as XML must be deserialized using the deserialize function. (See deserialize in the LiveCycle Workbench 9 Help .)

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

HTML Render Options

An HTMLRenderSpec value that represents run-time options for rendering an HTML form.

If you provide a literal value, you can modify the following fields that appear:

HTML Output Type:

Sets whether to wrap the rendered page with HTML or BODY tags. Render the HTML with BODY tags if you want the rendered HTML page to be part of another HTML page. Select one of these values:

Use Server Default:

(Default) Use the default Output type setting that is configured on the LiveCycle Server. The Output type setting is configured using Administration Console. (See 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. Select the character set to use or 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 Administration Console. (See Forms Administration Help.)

Use Custom Value:

After selecting this value, 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.

Start Page Number:

Sets the first page number to start to render in a multi-page HTML form. Page numbering is zero-based, which means that the first page is zero. The default value is 0.

Locale:

Sets the language used to send validation messages to client applications, such as web browsers, when an HTML form is rendered. Select a language from the list or select one of these values:

Use Server Default:

(Default) Use the Locale setting that is configured on the LiveCycle Server. The Locale setting is configured using Forms in Administration Console. (See Forms Administration Help.)

Use Custom Value:

After selecting this option, type the Locale ID of the locale code that is not in the list. For a 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 rendered form is cached on the server to improve performance. Processing instructions that are embedded into the form design and the Form Rendering Cache Enabled option determines how caching is performed. For information about configuring the Rendering Cache Enabled option in Administration Console. (See Configuring Forms.)

False:

The form is not cached on the server.

True:

The form is cached on the server.

Populate XML Data:

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

False:

(Default) Do not produce the XML data.

True:

Produce the XML data.

Stand Alone Rendition:

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

False:

(Default) The form is rendered without state information and without embedded JavaScript that runs on the client web browser. The Forms service renders the form after server-side calculations are performed and the results are displayed in the rendered form. Because of the required interaction with the Forms service, the form cannot be used when 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 into the form are executed. Select one of these values:

Use Form Template Default:

(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:

Sets 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. For example, in a JBoss turnkey installation, you can see default XCI files in the [Install folder]/jboss/server/lc_turnkey/svcdata/XMLFormService folder. [Install folder] is the location where the LiveCycle is installed. For information about creating XCI files, see Designer Help .

Digital Signature CSS URI:

Sets the URI, such as C:\\customds.css, for a custom style sheet to use for digital signature user interfaces in HTML forms. The LiveCycle Server must have access to the location of the URI.

Note: To create a custom CSS file, use the FormsIVS sample to generate a custom CSS based on the form design and output type you provide.

Custom CSS URI:

Sets the URI, such as C:\customcss.css, for a custom cascading style sheet to use instead of the internal one emitted as part of the HTML form. Review the custom CSS file for changes when changes are made to the form design.

• A new type of form object is added to the form design, such as button, text, text field, or check box.

• A form object is removed from the form design.

• Moving a form object, such as label or field, from a child subform to its parent or another subform.

  The LiveCycle Server must have access to the location of the URI.

  Note: To create a custom CSS file, use the FormsIVS sample to generate a custom CSS based on the form design and output type you provide.

HTML Toolbar:

Sets the type of toolbar that is rendered for HTML forms. Select one of these values:

Disabled:

(Default) The HTML toolbar is disabled.

Vertical:

The HTML toolbar appears in a vertical position.

Horizontal:

The HTML toolbar appears in a horizontal position.

HTML Toolbar URI:

Sets the URI location of the HTML toolbar resources to include in the rendered HTML form.

Generate Tab Index

Sets whether to create a tab index for each field in the rendered HTML form. When an HTML form with tab indexes is embedded into another HTML page that does not have tab indexes, tabbing inconsistencies can occur. Select one of these values:

True:

(Default) Tab indexes are created for each field in the rendered HTML form.

False:

Tab indexes are not created for each field in the rendered HTML form. Use this option when you embed the HTML form into another HTML form that does not have tab indexes.

Style Generation Level:

Sets the styling to output for the rendered HTML form. Internal styles are used for spacing and positional CSS styles. Inline styles are used for appearance styles, such as color, font, and background color. Select one of these values:

Inline And Internal Styles:

(Default) Use both inline and internal CSS styles. Internal styles use spacing and positional CSS styles. Inline styles use appearance styles, such as color, font, and background color.

Only Inline Styles:

Use only inline CSS styles from the custom CSS file.

No Styles:

Use any CSS an inline or internal styling.

User Agent

A string value that provides information about the client application, such as a web browser. If USER_AGENT is specified as a value in Environment Variables property in this operation, the value specified in this property overrides it. The default value is Mozilla/3.*.

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

Use Server Default:

(Default) Use Mozilla/3.*. The User Agent setting is not configurable on the server.

Internet Explorer 6.0:

The target application is Microsoft Internet Explorer 6.0.

Mozilla Firefox 2.0:

The target application is Mozilla Firefox 2.0.

Mozilla Firefox 3.0:

The target application is Mozilla Firefox 3.0.

Use Custom Value:

After selecting this option, type the client application on the target device. For example, type Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1) for Microsoft Internet Explorer 7.0.

URL Options

A URLSpec value that specifies the URI run-time information required to render an HTML form.

If you provide a literal value, you can modify the following fields that appear:

Application Web Root:

Sets the URL that represents the root location that is used to access application-specific web content. This value is combined with the value of the Target URL option to construct an absolute submit URL.

Target URL:

Sets the URL to access a web service or Java servlet that receives data from the client application when a user submits the form. Setting a value in this option sets the target URL in the form design to the value specified by this property. If this option is not an absolute URL, it is combined with the value from the Application Web Root option to construct an absolute URL.

Note: The Target URL property must be left empty for form designs created in Designer 8.2 to use the URL that is configured for the Submit button. Form designs created in Designer 9 and later with a Target Version set to Acrobat and Adobe Reader 9.1 or later, always use the URL configured in the Submit button.

For Workspace, type the value of http://[server name]:[port]/workspace-server/submit, where [server name] is the name of the server where LiveCycle is deployed, and [port] is the port that the application server uses to provide HTTP access for client software. The following ports are the default ports for the supported application servers.

• JBoss: 8080

• WebLogic: 7001

• WebSphere: 9080

Content Root URI:

Sets the URI or an absolute reference, which specifies the location in the repository to retrieve a form design. This value is combined with the value of the Form To Render property in this operation to construct an absolute path to the form.

You can 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. For example, the documents folder is created below the root of the repository.

• Directory in the file system of the LiveCycle Server: You can specify a location on the LiveCycle Server, such as C:\[folder name]. Using a location on the server is not recommended if you want to ensure portability of your application.

• Network directory: You can specify a location on the network such as \\[folder name.]

• Web location that is accessible by using HTTP: After uploading a file to a web server, you can specify the location by using a URL, such as http://[server name]:[port number]/[folder name].

  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 To Render property and repository:///formdesigns in the Content Root URI property. The absolute path that is created is repository:///formdesigns/form.xdp, which is required to access the form design.

Base URL:

Sets the URL, which is the HTTP-equivalent of the Content Root URI. This value is required only when you render HTML forms (renderHTMLForm operation (deprecated) and renderHTMLForm operation operations) that include HREF references to external dependencies, such as images or scripts. When a dependency path is absolute, this value is ignored.

Attachments

A map of document values that specifies the attachments that are rendered with the form.

Rendered Form

The location in the process data model to store the results of the rendered form. The data type is document.

Output XML

The location in the process data model to store the well-formed XML that represents the content generated by the operation. The data type is document.

Page Count

The location in the process data model to store the number of pages. The data type is long.

Locale

The location in the process data model to store the locale code of the rendered HTML form. The data type is string.

HTML Output Type

The location in the process data model to store the generated HTML data that includes only the BODY element and its contents. The data type is string.

Forms Result

The location in the process data model to store all the output results as a combined complex value. The data type is FormsResult.