Create URL Document Step

The Create URL Document step defines a document variable by referencing a URL you supply.

Create URL Document Customizer Window

The Create URL Document step does not issue the HTTP request. The actual request occurs when the document is used by another step, such as the Send Response step or the HTTP Forward step.

For a GET HTTP request, parameters are usually appended to a URL in an HTTP request to provide data required to execute the request. For example, the following HTTP request is made when the value of the total parameter is set to 500:

http://mybank.money.com/debit?amount=500

For POST, the parameters are passed in the body of the HTTP request as if entered in an HTML form.

The following table describes the properties of the Create URL Document customizer window:

Property

Description

URL

URL for the document.

Note	HTTPS certificate of the remote web service should be added to Unified CCX trust store when using HTTPS URLs.

Timeout

Variable indicating the amount of time in milliseconds that the system waits before time out.

Method

Method to use if the URL represents an HTTP request.

The GET method appends parameters to the URL. (This step is equivalent to using the document expression form: URL[url?name=value,name=value].)
The POST method includes the parameters as if they were entered in an HTML form.

Parameters (Names and Values)

Name and value pairs that form a parameter string to send to the web server.

The URL-encoded parameter string allows special characters.

Document

Variable in which the resulting document object is stored.

To use the Create URL Document customizer window to define a document variable, do the following procedure:

Procedure

	Command or Action	Purpose
Step 1	In the URL field, enter a value directly or take one of the following actions:	From the URL drop-down menu, choose the variable that stores the URL value. Click the Expression Editor (...) button and enter a relative or absolute URL.
Step 2	In the Timeout field, enter the time in milliseconds.
Step 3	In the Method field, click the Get radio button to append parameters to the URL, or click the Post radio button to include parameters as if they were entered in an HTML form.
Step 4	To map a parameter to a local variable, click Add.	The Parameter dialog box appears.
Step 5	In the Name text field, enter the name of the parameter you want to define.
Step 6	From the Value drop-down menu, choose the variable that stores the parameter value.
Step 7	Click OK.	The Parameter dialog box closes, and the names of the parameter and variable appear in the Name and Value columns of the Create URL Document window.
Step 8	Repeat Steps 4 to 7 as needed to add parameters and variables as desired.	(If you want to modify an existing parameter, click Modify. The Parameter dialog box appears again. Follow the same procedure you used to add parameters.)
Step 9	Click OK.	The Create URL Document customizer window closes.