xfaForm

Note: This variable type was deprecated in LiveCycle ES2.

A complex data type that you can use to store XML data in XDP format and the location of a file in the repository.

xfaForm variables are useful when used in human-centric processes so that the form can be delivered in one of several formats. The variable stores the location of the form and the XDP form data that is captured with the form.

forms workflow provides several processes that can be used as render and submit services for this variable type. The services you use depend on the type of form that you are using. (See Advanced settings .)

For information about how to configure the General and Enduser UI Items properties, see Common variable properties .

For information about data that can be accessed using Xpath Expressions, see Data items .

For information about configuring default properties, see Datatype specific settings .

For information on configuring the render and submit services, see Advanced settings .

For information on configuring schema settings, see Schema Settings .

Data items

The data items that xfaForm variables contain.

data

XML-based information that contains form data. The actual form data is stored several levels below this node. The following XPath expression shows the path to the form field data: 

/process_data/variable_name/xdp/datasets/data/FSFIELDS_

variable_name is the name of the xfaForm variable

FSFIELDS_ is a default name used for the root element of the form data when the schema of the form data is unknown. If the form schema is known, the actual root element is shown, followed by data elements that represent form fields. The data for each field is accessible using XPath expressions.

The following XPath expression returns all of the form data: 

/process_data/variable_name/xdp/datasets/data/*

templateUrl

A string value that represents the URL of a form that resides in the repository.

Datatype specific settings

Properties for specifying the form and initial form data.

Template Url

The URL of the form that is associated with the form data that this xfaForm variable holds. The form resides in the repository. The form must be one of these types:

  • Adobe PDF form

  • Adobe Acrobat form

  • Adobe XML form

Default Data

(Optional) Form data to use to populate the form if no other data is stored in the variable. This data is stored in the data data item.

Advanced settings

Properties for configuring the render and submit services.

You use the following default services to post-process a form after a user submits it:

Submit Form Guide

Submit HTML Form

Submit PDF Form

Render Service

Properties for configuring the processing of form data before it is sent to the web application or servlet that delivers the form to end users to open in client software.

Enable Render Service

Select Enable Render Service to render the form before it is sent to the web application or servlet that delivers the form to client applications. The render operation is specified using the Operation Name property. (See Service Name and Operation Name .)

If this option is not selected, no processing of the data is performed before it is sent to the client.

Service Name and Operation Name

The service and operation to use to render the form and form data that the xfaForm holds.

Process Management provides several processes that can be used as render and submit services. The services you use depend on the type of form that you are using.

Type of form

Render service to use

Acrobat PDF form

The following processes that forms workflow provides:

Default Render

Render PDF Form

Adobe PDF form

The following processes that forms workflow provides:

Render Form Guide

Render HTML Form

Render PDF Form

Adobe XML form

The following operations that the Forms service provides:

renderFormGuide

renderHTMLForm operation (deprecated)

renderPDFForm operation

The following processes that forms workflow provides:

Render Form Guide

Render HTML Form

Render PDF Form

Service Input

The input properties of the operation that is selected as the render service. The properties that appear depend on the render service that is selected.

The default value of each of the properties is determined by the Assign Task operation from the User service that uses the xfaForm variable as its input form.

Service Output

The output properties of the operation that is selected as the render service. The properties that appear depend on the render service that is selected.

For information about the input and output properties for the specified render service, see Service reference .

For information about the default render service, see Read Resource Content operation .

Submit Service

Properties for configuring the submit service, which processes the form data after it is submitted by the end user.

Enable Submit Service

Determines whether the form data is processed after the form is submitted. When selected, a submit service is used. When not selected, no processing of the data is performed after it is submitted.

Service Name and Operation Name

The service and operation to use to process the form data after it is submitted. There is no default submit service.

forms workflow provides several processes that can be used as render and submit services. The services you use depend on the type of form that you are using.

Type of form

Render service to use

Acrobat PDF form

The Submit PDF Form ES Update1 process that forms workflow provides.

Adobe PDF form

The following processes that forms workflow provides:

  • Submit Form Guide ES Update1

  • Submit HTML Form ES Update1

  • Submit PDF Form ES Update1

Adobe XML form

The processFormSubmission operation operation that the Forms service provides.

The following processes that forms workflow provides:

  • Submit Form Guide ES Update1

  • Submit HTML Form ES Update1

  • Submit PDF Form ES Update1

Service Input

The input properties of the operation that is selected as the submit service. The properties that appear depend on the submit service that is selected.

Service Output

The output properties of the operation that is selected as the submit service. The properties that appear depend on the submit service that is selected.

For information about the input and output properties for the specified submit service, see Service reference .

Schema Settings

The XML schema that the form data conforms to. The schema enables XPath Builder to represent the form data in the process data model at run time. Seeing the form data in the model is useful for creating XPath expressions using XPath Builder.

Click Schema Settings to view the schema or select a schema file from the local file system.

// Ethnio survey code removed