Ranorex Help Center How can we help you?

Instrumentation Wizard

Note 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 installation folder 

Start Instrumentation Wizard from installation folder

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 the Command Line

Using the following arguments, 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: androidchrome, firefox, flexiosjava 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: The name of the device to that the APK file shall be deployed. This parameter is not required if deploymode is set to 'NoDeploy'.

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, Auto. Default is Auto. Specifies how the apk file shall be deployed. Set to nodeploy if the file shall not be deployed to the device. Auto means the connection mechanism used to configure the device will be used.

o|outfile: Sets a custom output location for the instrumented file. This can be a directory or a file path. Read/Write permission is required for this path. If a directory was specified, (to specify a directory add a trailing '\') the process will place the APP file in it with the -instrumented suffix added to the source file name. If the file already exists it will be overwritten. This option only has an effect if an APP is instrumented (no skip).

android Advanced options: APK Signing

JdkBinPath: Full Path to your JDK installation bin folder.

KeyAlias: Alias of the keystore entity used for jarsigner.

KeyPass: Password of the key used for jarsigner. Warning: Please note that password is stored in plain text. Do not use production certificates.

KeyStore: Location (full path) of the keystore used for jarsigner.

KeyStorePass: Password of the keystore used for jarsigner. Warning: Please note that password is stored in plain text. Do not use production certificates.

Note For custom signing, Keystore, Keystore alias, Keystore password, Key password and JDK bin path have to be set.



android Advanced Options: Instrumentation Options

RIdClass: Provide a custom class name for locating resource ids (e.g. com.ranorex.demo.R). By default Ranorex will search id in <manifestpackage>.R.

EnableWebTesting: When set to true Ranorex shows DOM content of Web Views in UI-Hierarchy. Note that this feature has a huge performance impact on your app. Default is true.

FullImageComparison: When enabled, more robust image comparison is used to determine resource id's for images. This option decreases startup performance.

TreeSimplification: When set to false, no post processing of the UI-Tree takes place. This results in a larger UI-Tree which could be useful for automating 3rd party Android controls.

android

d|device: The name of the device to that the APK file shall be deployed. This parameter is not required if deploymode is set to 'NoDeploy'.

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, Auto. Default is Auto. Specifies how the apk file shall be deployed. Set to nodeploy if the file shall not be deployed to the device. Auto means the connection mechanism used to configure the device will be used.

o|outfile: Sets a custom output location for the instrumented file. This can be a directory or a file path. Read/Write permission is required for this path. If a directory was specified, (to specify a directory add a trailing '\') the process will place the APP file in it with the -instrumented suffix added to the source file name. If the file already exists it will be overwritten. This option only has an effect if an APP is instrumented (no skip).

chrome

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

firefox

e|enable: Required. Enable this switch to activate FireFox 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: Enable this switch to enable Internet Explorer Flex debug player. If the switch is disabled Internet Explorer Flex debug player will get deactivated.

ff|firefox: Enable this switch to enable the Firefox/Safari NPAPI Flex debug player. If the switch is disabled Firefox/Safari Flex debug player will get deactivated.

cr|chrome: Enable this switch to enable the Chrome PPAPI Flex debug player. If the switch is disabled the Chrome PPAPI Flex debug player will get deactivated.

o|other: Enable this switch to enable the Chrome *and* Firefox Flex debug player. If the switch is disabled the Chrome and Firefox Flex debug player will get deactivated. [Obsolete option use /cr and/or /ff instead.]

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.

d|disable: Default is True. Tells Ranorex that the instrumentation should be removed.

ios

u|udid: The unique device identifier for the device on that the application shall be installed (Note: instead of UDID the new option 'devicename' can be used). To get the UDID start Ranorex Studio open the manage devices dialog and select your device (that was added as a USB device) and click edit. In the meta data field you will find the UDID of the device.

dn|devicename: The name of the device. You can specify the name instead of the UDID. The name needs to exactly match the name, you set for your device in the settings app of that device.

ip|inputpath: The path to the application archive (*.ipa).

o|outfile: Sets a custom output location for the instrumented file. This can be a directory or a file path. Read/Write permission is required for this path. If a directory was specified, (to specify a directory add a trailing '\') the process will place the APP file in it with the -instrumented suffix added to the source file name. If the file already exists it will be overwritten. This option only has an effect if an APP is instrumented (no skip).

si|skipinstrumentation: Default is False. Set this switch to skip IPA file instrumentation.

sd|skipdeployment: Default is False. Set this switch to skip IPA file deployment.

k|keypath: The path to the p12 key file (*.p12).

pw|password: The password for the p12 key file.

pp|provisionpath: The path to the embedded mobile provision file (*.mobileprovision).

ai|appid: Default is . The application Id (bundle identifier of the app). This is required so that an application can be uninstalled prior to installing the new archive. Can be set to '[auto]' to resolve it automatically during instrumentation.

db|deploybrowser: Default is False. Set this switch to deploy Ranorex browser app.

ds|deployservice: Default is False. Set this switch to deploy Ranorex service app.

ub|uninstallbrowser: Default is False. Set this switch to uninstall Ranorex browser before deploy

us|uninstallservice: Default is False. Set this switch to uninstall Ranorex service before deploy

uf|uninstallfail: Default is False. Set this switch to throw exception when uninstalling an app fails.