JavaScript Functions > Alphabetical Listing of Web Functions > web.submitData

web.submitData

Performs an "unconditional" or "contextless" form submission.

Example Action Functions

Syntax

web.submitData( {object} ); 

JavaScript Object

{
    stepName: "<string>",
    action: "<string>",
    method: "<string>",
    encType: "<string>",
    recContentType: "<string>",
    encodeAtSign: "<string>",
    targetFrame: "<string>",
    referer: "<string>",
    mode: "<string>",
    userAgent: "<string>",
    snapshot: "<string>",
    itemData: [{"name":"<string>","value|encryptedValue":"<string>",
            "file":"<string>","contentType":"<string>","filePath":"<string>",
            "contentTransferEncoding":"<string>"}],,
    extraRes: [{url:"<string>",referer:"<string>"}]
}
Property Name Description
stepName The name of the step, as it appears in the graphical script.
action The HTTP address of the action to perform when submitting the data.
action: The ACTION attribute of the FORM element. The ACTION attribute specifies the address (URL) to be used to carry out the action of the form. You can also specify action/sfx, which indicates to search the form using the suffix of the action.
method The form submission method: POST or GET (default: POST).
encType The encoding method used.
recContentType The content type, for example, text/html.
encodeAtSign Encode the "@" sign as in its ASCII representation. The possible values are Yes or No.
targetFrame The name of the frame containing the current link or resource. Click targetframe for more information.
referer The URL of the referring Web page. The page that referred to the current page. If the location was explicitly expressed, this attribute is omitted.
mode The Recording Level: HTML or HTTP. Click Recording Level / mode (Web) for more information.
userAgent Identifies a component other than the browser that will execute the step, for example, an ActiveX component running under the browser. This user agent header is sent for the requests made by the step. No check is made to confirm that the user agent argument matches the browser's User-Agent Run-Time Setting. Non-browser steps do not affect the emulated browser context, nor do they build a new context from the result.
itemData The data fields used to define the form submission. Because the request is contextless, the list of data fields includes all hidden fields. The rules of data encoding for submission of forms apply. For a list of the possible entries in the list, see Item Data below in this topic.
name is the name attribute within an INPUT element of the field. It is the name of the field as it appears on the Web page.
extraRes

Resources generated by non–HTML mechanisms in the Web page.

Return Values

Not applicable

Parameterization

The following argument(s) can be parameterized using standard parameterization: action, method, List of Data Fields

General Information

The web.submitData function is an action function that performs an "unconditional" or "contextless" form submission. (Each Web action Function in a script causes the browser to display a new Web page or frame. All Web action functions can be recorded by VuGen.) This function allows you to generate GET and POST requests as made by the HTML forms. You do not need to have a form context to execute this request.

web.submitData is recorded only when VuGen is in either the url–based recording mode, or in the HTML–based recording mode with the A script containing explicit urls only option checked (see VuGen's Recording Options).

The method indicates how the data of the form is sent to the server, whether as a query within the url (GET), or as a request body (POST).

This function is generated when VuGen is set to record a Web session in HTTP (all requests from the server) recording mode. VuGen also records a web.submitData statement whenever a form is submitted and it is unable to generate a web.submitForm statement.

Examples of non–HTML–generated resources are .gif and .jpg images. The extraRes property is only inserted when the recording option for these resources is set at Record within the current script step. This is the default setting. See the Virtual User Generator User Guide.

The HTTP header can be modified to pass additional information about the request to the server. Using HTTP headers you can, for example, allow other content types in the response such as compressed files, or you can request a Web page only on certain conditions. To modify the HTTP header in the request see web.addHeader, or to modify all subsequent requests see web.addAutoHeader.

The encType attribute specifies a Content Type to be specified as the value of the "Content–Type" request header. It indicates the encoding type (either url–encoding or multi–part) to be used for generating an HTTP request from other arguments. Use one of the following:

An encType specification silently overrides any web.addHeader or web.addAutoHeader settings for "Content–Type". If encType is omitted, any applicable web.add[Auto]Header setting is used. If there is none, "method=POST", "application/x–www–form–urlencoded" is used. If method is not POST, no "Content–Type" request header is generated.

Example

web.submitData(
    {
        name : 'Correlation_ASP_welcome.asp', 
        action : 'http://kalimanjaro/Correlation_ASP_Project/Correlation_ASP_welcome.asp', 
        method : 'GET', 
        encType : '', 
        targetFrame : '', 
        recContentType : 'text/html', 
        referer : 'http://kalimanjaro/Correlation_ASP_Project/Correlation_ASP_setup.asp', 
        snapshot : 't5.inf', 
        mode : 'HTML', 
        itemData : 
            [
                {
                    name : 'first_field_name', 
                    value : 'param1'
                },
                {
                    name : 'use_2_fields', 
                    value : 'yes'
                },
                {
                    name : 'second_field_name', 
                    value : 'praram2'
                },
                {
                    name : 'first_sessionid_change_rate', 
                    value : 'three_times'
                },
                {
                    name : 'second_sessionid_change_rate', 
                    value : 'three_times'
                },
                {
                    name : 'use_links_forms', 
                    value : 'links_only'
                },
                {
                    name : 'form_method_is', 
                    value : 'GET'
                },
                {
                    name : 'frame_target', 
                    value : 'mainframe'
                },
                {
                    name : 'frameset_or_iframe', 
                    value : 'use_frameset'
                }
            ]
    }
);