TrendIC B.V., Waddinxveen | The Netherlands | +31 182 613945 | https://www.trendic.nl | support@trendic.nl

This document describes the ICDefine Test Case Editor Control Functions.
Both the functions and the associated options will be explained. The example values used to create this document represent values that actually can be used within the program.

Refer to the ICDefine Quick Test Case Build Guide for directions to get started building your own test cases.

In addition to the description of the ICDefine functions itself, you will also find explanations of the Editor functions that assist you in building and maintaining your test cases.

The following list provides a quick reference to various help topics.

• Advanced Image Manager
• Build your own functions
• Menu buttons, short-keys and function keys
• Multiple Font Support
• On Pass / On Fail GoTo
• Parameter Support
• Quick Build functionality
• Record Movie functionality
• Select Color Table
• Select Global
• Select Testscript
• SUT-Tree Help

In the section below a full description can be found of all available Test Case Editor Function Properties one possibly needs to set when configuring a TestStep (Function).

One or more TestSteps can be grouped together in a Segment. Refer to the Segment Properties paragraph for more information.

Each Function is configured by the use of its associated Function Properties, of which many can be set by using drop-down menus.

For every Teststep a user adds to the test case, one or more Function Properties need to be set to meet the specific demands of the selected Function. Only those Function Property fields that are concerned with the Function will be displayed, for example:

As you can see, for the function CheckText you can only enter properties that are related to the function CheckText, i.e. the Text to be checked, the Font in which the text is displayed, and - optionally - a Color Table and a Search area.

In the remainder of this section the general purpose of any of the possible Function Property fields will be described.

Although it is not a property of any function but merely a function of the editor itself, a short explanation of the Show help and Hide help buttons follows, as it can be closely related to the selected function:

Shows the additional Editor pane containing the Help, TestReport, Errors and Movie tabs.
Hides the above mentioned pane.

You can find the button at the top-right above the Properties frame.

The Function field is mandatory. Use the Function field drop-down menu to select the desired Function. Some of the possible values are: CheckAndClick, ClickImageLeft, Delay, Enter, Global, Key, ListBox, Tab, WaitAndClick, etcetera.
In the next chapter all available Test Case Editor Functions will be fully described including their specific Property field(s).

Pressing the ? question mark, when it is enabled, displays the Help pane, showing on-line help information about the selected function.
If no on-line help is available, alternatively an offline pdf help file or an on-premise document server can be configured to provide the Help info instead. Contact TrendIC Support for more information.

This field is used to give the Teststep a name or description. We recommend to give a description that refers to the action that’s being performed.
Depending a configuration setting, the Teststep field can also be automatically filled with the Function name and additionally with the value of the object item, e.g. the function CheckAndClick on the text ICTestAutomation could result in the Teststep field description Check and Click ICTestAutomation.
The Teststep description is also used for reporting.

This field contains a text value, specific to the selected teststep’s Function. For instance, it will contain the text to be checked, clicked on, or entered.
The + browse button (if present) will open a selection window showing variables known to the test case. Select a variable and click the OK button to insert the variable name at the cursor location in the Text field. Double-click the variable name to replace any existing entry in the Text field.
You may combine multiple text fragments and variables into one text string, e.g.:

+%countrycode% (0)%areacode% %subscriber%, ext. %extension% 

So if countrycode=31, areacode=182, subscriber=613945 and extension=123, the above will result in the text string:

+31 (0)182 613945 ext. 123

The Script name field is used in the RunTestScript function, used to specify the full path and name of the CitraTest Testscript that is to be run.

The X- and Y-coordinate fields are related to the ClickMouse function. They specify the exact screen location (in pixels) where to perform a mouse action (specified in the Click field in combination with the Mouse Clicks and Mouse Buttons options).

The Click field is related to the ClickMouse function; it may specify the mouse button Up, Down or the default N/A (no action, in which case the Mouse Clicks and Mouse Buttons are considered).

The X- and Y-axis fields relate to the MoveMouse function and specify the number of pixels the mouse is to move on either axis.

The Argument field is related to the Compare function. From the drop down list either Equal (default), Not Equal, Greater, Greater or Equal, Less, or Less or Equal can be selected.

Text related functions will show the Font property, to identify the font in which a text is displayed.
Press the arrow down to display the font list, as defined in the tft_citratest.ini file, and select the desired font. If the desired font is not present, add it to the tft_citratest.ini file, return to the editor window and press the F5 key to refresh the font list.

ICDefine version 5.9 introduces Multiple Font Support, which allows to specify more than one font for the text to check against. Also the ability to specify a font variable from the tft-citratest.ini file has been added. Please refer to Multiple Font Support for more information.

When a smoothed font is selected in a text function, a Color Table can be specified in addition to the function's Font specification. Press the + browse button to display the Select Color Table dialog, from which you can select the applicable color table.

The Comp. Type field specifies the comparison mode in the Compare function. The dropdown field offers the choice Alphabetic (default) or Numeric.

The Parameter field is used in the RunTestScript function. Optionally you can enter command line switches that will be passed to the CitraTest script to be executed.

The Parameter(s) field is related to the Global function. Optionally you may enter a value that will be passed to the Global test case, selected in the Teststep field.
Multiple parameters may be entered by separating them with commas.
Values can also be entered using the %<variable name>% construction, as described in Passing parameters to Global functions.

This field will contain a number, that will identify the number of times a function is to be performed, e.g. Enter, Esc, Tab, or the number of (milli)seconds, e.g. Delay, WaitStatic, or the number of cursor movements, e.g. Cursor.

The Direction field is related to the Cursor function. Click the arrow down to display the possible directions and select your choice.

The Function Key field is related to the FKey function. Click the arrow down to display the possible function keys and select your choice.

The Option field will specify a value that influences the behavior of the function. E.g. specify Option 1 in the Tab function to perform a forward tab, specify 2 to perform a backward tab.

The Image or Image(s) field is used to specify one or more .bmp image files, which subsequently can be used with a variety of Functions.
The image file name may consist of a variable name, or a combination of text fragment(s) and variable(s).
Note that the .bmp file name must be fully stated, i.e. the extension .bmp must be included.
Multiple file names need to be separated using a comma (,) without spaces.
Press the + browse button to open the Advanced Image management capabilities, which are explained separately in the chapter on Advanced Image Manager.

The Search Area field is used to indicate a specific on-screen area. For example to limit a search for a .bmp image or on-screen text to a specific screen area. Either a “fixed” or “relative” search area can be specified.
The Search Area file name may consist of a variable name, or a combination of text fragment(s) and variable(s).
Press the + browse button to open the Select Search Area window, from which you can select an existing Search Area, or capture a new Search Area.
For more information on capturing a Search Area from within the ICDefine Editor, please refer to Capture Search Area.

If no text area is specified the default value is “NONE”, which means the entire screen is read.
Note that the .ini file name must be fully stated, i.e. including the extension .fixed.ini or .relative.ini.

When this field is marked, the Teststep is not executed during runtime and will become green colored.

Usually a Test case is aborted when a Test case fails. In some situations however, it may be justified to ignore a fail condition, and to continue the Test case. When this field is marked, a Test case will continue with the next step despite a failure of this Teststep.

Optionally, you can either mark the On Pass GoTo checkbox or the On Fail GoTo checkbox, which will then show an additional property field On Pass Goto or On Fail Goto, depending the checkbox marked. Here you can select the Segment from where the test case will continue if the completion status of the current step matches the marked status checkbox.
Refer to the On Pass / Fail GoTo paragraph for a more detailed explanation of this option.

Dependent on the selected Function this field is optional. Use the checkboxes to add one or a combination of the following control keys to a corresponding Function: Shift, Ctrl, Alt or Windows.

If selected, this option will be applied to the various text functions.

Dependent on the selected Function this field is optional. Check the desired radio button to determine the number of mouse clicks (No Clicks, a Single Click or Double Click) the Function is executed with. No Clicks acts like hovering over a designated item, e.g. to activate a (sub)menu.

Dependent on the selected Function this field is optional. This field determines wether the Function being called is executed with a Left, Middle or Right mouse click.

This option will influence the amount of wait time for an image or text to be displayed on screen. The Short, Standard and Long TimeOut will be determined from the CitraTest Playback Options General Timeout settings; the Custom TimeOut can be specified manually (in seconds).

Dependent on the selected Function this field is optional. Use the checkboxes to set Ignore Flags to the Function called. For example, Ignore Flags can be used to ignore certain (or all) colours of a .bmp image file or a specified text when executing a bitmap resp. text related Function.