processFormSubmission operation

Processes the content from a form submitted by a client to the Forms service. This operation can determine the processing state of the form that was submitted, such as the button clicked by a user. You get one of the following results from completing this operation:

  • The same content type that was submitted to the Forms service if the form did not complete processing

  • XML data or PDF data

    If the content type of the form passed to this operation is not supported, no processing occurs and the data is returned. Use the processFormSubmission operation to retrieve and process the data from a submitted form.

    For example, your application must determine whether the user clicked the submit button and extract the data to save to a process variable from the submitted form. Use the processFormSubmission operation to determine whether the user clicked the submit button by retrieving the value from the Action property after the operation completes execution. Also, use this operation to extract the XML data from the Output XML property and save it to a process variable.

    For information about the General and Route Evaluation property groups, see Common operation properties.

Input properties

Properties for specifying form data for submission.

Submitted Form Data

A document value that represents the content that is submitted to the Forms service.

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

Environment Variables

Common ones that you can include are Accept-Language, CONTENT_LENGTH, CONTENT_TYPE, HTTP_FS_REQUEST, and SERVER_NAME. Environment variables are useful for communicating information for server-side scripts or CGI scripts on the client application. For example, specify the CONTENT_TYPE environment variable to specify the types of content that can be submitted.

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.

Form Submission Options properties

Property for configuring options for submitting a form.

Submission options

No Styles: Use any CSS an inline or internal styling.

Output properties

Properties for storing the form data submission result.

Process Form Submission Result Document

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

Additional Output properties

Properties for storing additional information from processing the form submission.

Clicked Button

The location in the process data model to store the last button that the user clicked. The value is XFA Scripting Object Model (SOM) expression. The data type is document.

Output XML

The location in the process data model to store the XML or HTML data. The result is stored as well-formed XML that can be retrieved. The data type is document.

Validation Errors List

The location in the process data model to store a list of validation errors that is retrieved as UTF8-encoded XML. The data type is document.

Action

The location in the process data model to store the processing state associated with the form submission. The data type is short. One of these values is returned:

  • 0: The form is in a Submit state, and validated XML data is ready to be processed.

  • 1: The form is in a Calculate state, and calculation results must be written to the web browser.

  • 2: The form is in a Validate state, and calculations and validations must be written to the web browser.

  • 3: The form is in a Next state, and the current page has changed with results that must be written to the web browser. Valid only for HTML forms.

  • 4: The form is in a Previous state, and the current page has changed with results that must be written to the web browser. Valid only for HTML forms.

Attachments

The location in the process data model to store the list of attachments that are posted with the form submission. The data type is list of document values.

For information about retrieving values from a list, see Accessing data in data collections.

Forms Result

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

Exceptions properties

This operation throws a ProcessFormSubmissionExceptionexception when an error occurs processing a form submit request.