Working with Get File from URL Process

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

Working with Get File from URL Process

Previous pageReturn to chapter overviewNext page

 

Process Purpose

 

The "Get File from URL" process is used to get/receive a file from a specific URL.

 

 

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 "Get File from URL" process. In this case, the properties window includes two tabs - "General" and "Error".

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

 

"General" tab

 

 

Proceed as follows:

 

HTTP Request

URL

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

As an alternative, you can use a variable to define the URL (use the "Variable Select" option that is accessed if you right-click this box).

Result File Name

Path + File Name

Insert the path and name of the file that will receive the result OR  click and select a variable with that value. See Variable Usage.

 

Do NOT use special characters. A file name should only contain alphabetic characters, numbers, and the underscore “_” character (the underscore character is commonly, used to indicate a space).

For more detailed information, register/log in to our MCL Community and access MCL's Knowledge Base ("File Name Best Practices").

 

Example

 

 

Proceed to the "Error" tab.

 

"Error" tab

 

 

Proceed as follows:

 

Store HTTP header response to Variable

Full Header

Click to select the variable that receives the full header from the URL. See To Select/Create a Variable.

Status Code

Click to select the variable that receives the status code from the URL.

Content Type

Click to select the variable that receives the content type from the URL.

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.

 

When defining a screen as a target destination (ex: via a “Go to” process), you CANNOT use variables to specify the name of that target screen. You must select the intended screen from the available drop-down/list.

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.

 

When defining a screen as a target destination (ex: via a “Go to” process), you CANNOT use variables to specify the name of that target screen. You must select the intended screen from the available drop-down/list.

 

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 properties window:

 

Click to define a time out. See 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.

 

 

You can use relative paths to refer the file(s) you want to use in your project. See Working with Aliases.

 

 

If you want to use a label as a target destination, you can use the "Auto-Label" mechanism. This alternative to the "Set Label" process allows you to create a label in the properties window of a process - specifically, in the fields used to define target destinations (ex: the "If Error..." type fields). See To Automatically Create a Label.

 

 

Use the right-click in MCL-Designer's input boxes to access some related options as well as the general "Cut", "Copy"; "Paste"; "Search" actions (active/inactive according to the current context).

Ex: If you right-click the "Variable" input box (included in a "Conversion's" properties window), you are provided with general editing/search actions and other more specific options such as "Variable Select" (see "Variable Select"); "Variable Insert" (see "Variable Insert"); "Insert Special Character" (see To Insert Special Characters into a Control's Text Input Field) and "Localization Select" (see Localization List).

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