Document Form

Note: This variable type was deprecated in LiveCycle ES2.

A complex data type that holds form data (in binary format) and the URL of a PDF or XML form. The form can be merged with the data when the form is rendered at run time.

Document Form variables are typically used in human-centric processes where a PDF document must be created from the data and the form, and saved unaltered. In this case, the form is usually a PDF file. For example, a process requires that a user digitally signs a PDF form. The form is saved as a PDF document that is not altered thereafter.

By default, the render service that is used for Document Form variables is the invoke operation that the Default Render service provides. This service is a process that forms workflow provides. The process merges the variable’s form data with the associated form.

No default submit service is configured.

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 about configuring properties for render and submit services, see Advanced Settings .

Data items

The data items that Document Form variables contain.

document

A document value that represents form data that can be merged with the PDF form that the formURL references.

If the Call The Render Service Only Once option is selected, this value is the PDF document that is created from the PDF form and the form data.

formURL

A string value that represents the URL of the PDF form.

Forms that are used with the Document Form data type must be designed to submit the PDF form rather than the XDP or XML data. (See “Preparing form designs for forms workflow” in Designer Help .)

Clients that use Adobe Reader must have the form rights-enabled to submit a PDF file. (See Acrobat Reader DC extensions .)

Datatype specific settings

Properties for specifying the form.

URL

The URL of the PDF form that resides in the repository. This value is stored in the formURL data item.

Advanced Settings

Properties for configuring the render and submit services.

Data items

Properties for configuring the render service, which processes the form data before it is sent to Workspace.

Enable Render Service

Determines whether the form data is rendered upon task creation. When selected, a render service is used. When not selected, no processing of the data is performed before it sent to the client.

This option is selected by default.

Call The Render Service Only Once

Determines whether a PDF document is created from the data and the form. When selected, the render service is called only once to prevent the PDF document from being altered.

This option is selected by default.

Service Name and Operation Name

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

The default service is the Default Render service, and the default operation is the invoke operation.

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 Document Form variable as its input form variable.

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 ES Update1 service, see Default Render .

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.

This option is not selected by default.

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.

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 .

// Ethnio survey code removed