Working with File Read a Record Process

Navigation:  How to Work with Processes > Working with the Data File Processes Group >

Working with File Read a Record Process

Previous pageReturn to chapter overviewNext page

 

Process Purpose

 

The "File Read a Record" process is used to read a record from a data file.

 

 

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 "File Read a Record" process.

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

 

 

Proceed as follows:

 

File

File Name

Select the desired data file from the drop-down. This automatically fills in the “Fields” column in the “Fields to Read” table. If necessary, click to edit the selected data file.

See Editing a Data File.

This button only becomes active after a data file has been selected. It opens a "Condition" window with the purpose of specifying which record to read.

See Detail of the "Condition" window.

Fields to Read

Fields column

This column automatically displays the fields included in the selected data file.

Variable to Update column

Click to select the variable that will receive the data from the field. See To Select/Create a Variable.

If … Go to

Record Found

Select a target location from the drop-down or list, in case of a “Record Found”. 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.

 

Not Found

Select a target location from the drop-down or list, in case a record is “Not Found”.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 process properties window:

 

Click this icon to create a new data file. Go to Creating a Data File to see how to fill in the several options available.

 

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 "Read a Record" process.

 

 

Detail of the "Condition" window

 

 

a. Fill in the following options.

 

Conditions

Search criteria

Select the search criteria from the drop-down (which record to read). If the selected option is “Record Number”, it will activate the “Record #” option.

Record Number

This option is enabled if the selected search criteria is “Record Number”. Define the number of the record to be read OR  click and select a variable with the intended value.

 

Before defining "record number" as a search criteria, consider the number of records involved - it may have a performance impact, in terms of speed. To improve performance, we recommend a data look up based on field values (ex: "Search criteria" - "first record" / "Where Field Name" - X  /"Equal Value" - Y).

 

Where Field Name column

Specify the field name that will be used to match the search criteria through a "Where" condition from the drop-down.

Equal Value column

Define the value to be searched. Either enter it OR  click and select the variable with the intended value.

Partial column

Check the “Partial” option, if the purpose is to include a partial string value from the beginning of the string to be searched and not just the complete string value in the "Where" condition.

 

If your project requires the use of partial string values that are not necessarily located at the beginning of a string, we recommend you use the Local Database to manage the data instead of a data file. See Working with the Local Database Processes Group.

 

If record found, store record number into variable

Click to select the variable that will receive the number of the record found (pointer). SeeTo Select/Create a Variable.

 

b. Click to apply the options that were filled in and go back to the "File Read a Record" window to finish the setting up of the process.

 

 

Use the editing icons to the right of each table (in the "Condition" or the "File Read Record" windows) to move the rows up and down and to delete or add more rows.

 

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.