Working with HTTP Request Process

Navigation:  How to Work with Processes > Working with the HTTP/Web Services Processes Group >

Working with HTTP Request Process

Previous pageReturn to chapter overviewNext page

 

Process Purpose

 

The HTTP Request process is used to execute an HTTP request to a specific URL (call a web service).

 

 

When you add a process, you are required to define its settings. This occurs in the process's properties window which is displayed automatically after having added the HTTP request process.

If any subsequent edition is required, double-click the process to open its properties window and enter the necessary modifications.

 

 

Fill in the following options:

 

HTTP Request

URL

Enter the URL or click to access the URL Assistant. See Detail of URL Assistant.

Method

Define the desired HTTP method from the drop-down list or click and select a variable with that value. See Variable Definition.

Media

Define the desired media from the drop-down list or click and select a variable with that value.

Headers

Define the desired headers or click and select a variable with that value.

Send (Body)

Input Type

Define the type of input to send via the web service request body. Select one of the available options:

None

String - If checked, this option enables a field to insert the string to be sent. Enter it or click and select a variable with that value.

File - If checked, this option enables a field to define the data file to be sent. Select the name of the data file from the drop-down list.

If required, click to edit the selected data file. See Editing a Data File.

Response (Body/Header)

Store Result

Define what to receive via the web service response body. Select from “None”, “Variable” (enables the “Variable” field) or “File” (enables the “File” field).

None

Variable - If this option is checked, the "Variable" box is activated. Click to select the variable that will receive the result. See To Select/Create a Variable.

File - Checking this option, activates a "File" box. Enter the name of the data file to receive the result from the drop-down list or click to edit the selected data file. See Editing a Data File.

Status Code

Click to select the variable that will receive the web service status code. See To Select/Create a Variable.

Headers

Click to select the variable that will receive the web service status response headers.

If … Go to

Comm. Error

Select a target location from the drop-down or list, in case there is a communications error. See Detail of a window below.

HTTP Error

Select a target location from the drop-down or list, in case there is an "HTTP Error". See Detail of a window below.

 

Example

 

 

Detail of a window:

 

 

"S:Menu" is a screen included in the same program as the process.

"R:Routine_1" is a routine included in the same program as the process.

 

If required, use the icons on the upper right corner of the process window:

 

Click to define a timeout. See To Define a Time Out.

 

Click to attach any relevant notes to this process. Click it and enter your notes in the resulting text box. These notes will be displayed in the corresponding "Actions" tab or "Process" window (in the "Notes" field) and in the "Developer Report".

 

After filling in the required options, click to conclude or to abort the operation.

 

The added process is displayed in the corresponding "Actions" tab or "Process" window.

 

 

Use the right click in MCL-Designer's input boxes to access certain features regarding the input box's option as well as general actions such as "Copy"; "Paste"; "Search".

Ex: If you right-click the "Variable" input box (included in a "Conversion's" properties window), you are provided with the "Search..."and "Variable Select" options.

If you right-click another input box, it will provide other possibilities.