Home » Support » User Guide » Instrumentation Wizard

Instrumentation Wizard

Ranorex supports the testing of many different UI technologies, however some technologies need to be instrumented correctly to guarantee the best possible automation results. The Ranorex Instrumentation Wizard is a tool which helps you instrumenting these technologies to ensure optimal object recognition and consequently robust test automation projects.

The Ranorex Instrumentation Wizard can be started either from 'Tools' menu in Ranorex Studio, from the pop-up dialog triggered by a technology limitation, from the start menu, or directly from the binary folder of your Ranorex installation (<Ranorex Installation Folder>\bin\Ranorex.InstrumentationWizard.exe). The last method is useful if you are going to automatically instrument a technology. Have  a look at the section 'Running Instrumentation Wizard from Command Line' for further details.

The wizard is used to instrument the following technologies:

Start Instrumentation Wizard from Ranorex Tools Menu
Start Instrumentation Wizard from Ranorex Tools Menu
Start Instrumentation Wizard from Technology Limitation
Start Instrumentation Wizard from Technology Limitation
Start Instrumentation Wizard from Start Menu
Start Instrumentation Wizard from Start Menu
By starting the wizard from the 'Tools' menu, from the start menu or from the 'bin' folder, you can choose which kind of technology you want to instrument, whereas the technology limitation pop-up leads you directly to the instrumentation of the technology with limited identification capabilities.
Instrumentation Wizard
Instrumentation Wizard

Running Instrumentation Wizard from Command Line

Using the following, you can execute the instrumentation Wizard from the command line. This is required for automated command line based instrumentation.

Ranorex.Instrumentation.exe /<arguments>

p|pagename:

Default is Select. Set this option to directly navigate to a specific page. Is also required for automated command line based instrumentation.

Pages are: android, chrome, firefox, flex, java and safari.

Note: The default 'Select' is not supported in the command line.

?|help:

Default is False. Displays command line arguments help.

Pagename specific arguments:

android

d|device: Required. The name of the device to that the APK file shall be deployed.

a|apkfile: Required. The path where the APK file resides

s|skip: Default is False. Set this switch to skip APK file instrumentation prior to deploying.

dm|deploymode: Possible Values: WiFi, Usb, NoDeploy. Default is WiFi. Specifies how the apk file shall be deployed. Set to 'NoDeploy' if the file shall not be deployed to the device.

chrome

a|activate: Required. Enable this switch to activate Chrome browser addon. If the switch is disabled the addon will be deactivated.

firefox 

a|activate: Required. Enable this switch to activate Chrome browser addon. If the switch is disabled the addon will be deactivated.

safari 

a|activate: Required. Enable this switch to activate Chrome browser addon. If the switch is disabled the addon will be deactivated.

flex 

pl|preloader: Required. Enable this switch to enable the Ranorex preloader. If the switch is disabled the preloader will get deactivated.

ie: Required. Enable this switch to enable Internet Explorer Flex debug player. If the switch is disabled Internet Explorer Flex debug player will get deactivated.

o|others: Required. Enable this switch to enable FireFox/Chrome/Safari Flex debug player. If the switch is disabled FireFox/Chrome/Safari Flex debug player will get deactivated.

ft|flextrace: Default is False. Enable this switch to enable Flash tracelog. If the switch is disabled flash trace log will get deactivated.

java 

jp|javapath: Required. System path to the JRE that shall be instrumented.

e|enable: Default is True. Tells Ranorex if the instrumentation shall be enabled or disabled.