Working with Free SQL Statement Process

Navigation:  How to Work with Processes > Working with the Remote Database Processes Group >

Working with Free SQL Statement Process

Previous pageReturn to chapter overviewNext page

 

Process Purpose

 

The "Free SQL Statement" process is used to execute free SQL statements to a remote database in a specific Host server.

 

The remote database profile you create within MCL-Designer V4 is responsible for the direct communication between your MCL-Designer project and a remote database.

Once the project is loaded into a device, that same profile can be used to allow communication between the device and the remote database/host server, via MCL-Net. Therefore, make sure that the connection string of the selected profile includes an OLE DB provider that is compatible with the intended remote database. Ex: If you intend to use an Oracle database, select a remote database profile with the corresponding Oracle OleDB driver.

 

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 "Free SQL Statement" process. This properties window is divided into two tabs - "General" and "Advanced".

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

 

"General" tab

 

 

Fill in the following options:

 

Host Name & Data Source

Host Name

Select a host profile from the drop-down OR  click to create a new host profile or edit an existing one.

See To Create a Host Profile OR To Edit a Host Profile OR The <Default> Host Profile.

 

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

See The Use of a Variable to Define a Host Name.

Data Source

Select a database from the drop-down OR  click to create one. See To Add a Data Source to MCL-Designer V4.

 

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

See The Use of a Variable to Define a Data Source.

 

Before using the “Variable Select” alternative, consider your choices in the “Remote Database” tab (see Remote Database tab in "Project Properties"):

 

If the “SQL Commands option” is set to “2. Server (Save SQL statement into MQD file for server)", the “Variable Select” option is NOT applicable/supported.

 

SQL Statement

Define the SQL statement. You can enter it and click to include variables anywhere in the statement. Ex: Select * from table where field = '&A1'

Return Value

Wait for Returned Value

Check this option to wait for an answer from the SQL statement. A time out should be defined (click and define a time out. See Time Out).

Store in Variable

Click to select the variable that will receive the return value. You can retrieve up to 80 values at once. See To Select/Create a Variable.

 

Use the editing icons to the right of the table to move the rows up and down and to delete or add more rows.

 

Proceed to the "Advanced" tab.

 

"Advanced" tab

 

 

Fill in the following options:

 

SQL request name (Must be unique)

SQL User Name

Define a unique name for the SQL request. One is always suggested.

Store Number of Record(s) in Variable

Variable

Click to select the variable that will receive the number of selected records. See To Select/Create a Variable.

Generate Result File

Generate Result File on Server

Check this option to create a result file. Once checked, it activates other options that relate to the "result file".

File Name

Define the name and path for the result file.

Record Format

Define the mask of the selected record.

Field Separator

Select the appropriate field separator for the "result file" from the drop-down.

Max. Record(s)

Define the maximum number of records for the "result file".

Add Record Number Field

Check this option to add a field, in the "result file", with the record number.

If … Go to

No Record

Select a target location from the drop-down or list, in case a "No Record" occurs. See Detail of a window below.

 

ONLY to be used if the intended SQL statement is expected to return data (ex: record selection). For any other SQL statements, maintain the default option “<continue>".

For instance, if you intend to use an “INSERT” statement, you do NOT expect a value to be returned, so the “No Record” situation does NOT apply - there is no need to attribute a location for it.

 

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.

 

ODBC Error

Select a target location from the drop-down or list, in case an "ODBC Error" occurs. 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.

 

Comm Error

Select a target location from the drop-down or list, in case a "Comm Error" occurs. 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 it to set up a time out. See Time Out.

 

Click it to edit a data file. See Editing a Data File.

 

Use it to test SQL scripts. See To Test SQL Scripts.

 

Use the icon 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.

 

 

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.