Parameters (Vision/Classic)

In testrun files and testConfig files you can set parameters below.

[type] R: tesrun file, C: config.json file

category property description default type remarks
OS os “android” or “ios” android R
Config android.configFile testConfig file for android R
Config android.profile profile for android R
Config ios.configFile testConfig file for iOS R
Config ios.profile profile for iOS R
Config android.statBarHeight statBarHeight(for Android) 66 R
Config ios.statBarHeight statBarHeight(for iOS) 46 R
Stub stubServerUrl Stub server url R/C
Test mode noLoadRun No-Load-Run(NLR) mode is enabled on true false R/C
Priority must Skip test function with @must on false true R
Priority should Skip test function with @should on false true R
Priority want Skip test function with @want on false true R
Priority none Skip test function without priority on false true R
Log logLanguage Language for logging ""(empty) R Default(empty) is English. “ja” is supported
Log enableSyncLog sync log is output on true true R
Log enableTestList TestList.xls is output on true true R
Log enableTestClassList TestClassList.txt is output on true true R
Log enableSpecReport Spec-Report is output on true true R
Log enableRelativeCommandTranslation Relative command is translated on true true R
Log enableInnerMacroLog Logging in macro is enabled on true false R For debugging
Log enableInnerCommandLog Logging in command is enabled on true false R For debugging
Log enableSilentLog Logging in silent is enabled on true false R For debugging
Log enableTapElementImageLog The image of tapped element is saved on true false R For debugging
Log enableXmlSourceDump XmlSourceDump is output on true true R For debugging
Log enableRetryLog info log is output on retrying on true true R For debugging
Log enableWarnOnRetryError warn log is output on true. info log is output on false. false R For debugging
Log enableWarnOnSelectTimeout warn log is output on true. info log is output on false. false R For debugging
Log enableGetSourceLog getSource log is output on true false R For debugging
Log enableTrace trace log is output on true false R For debugging
Log enableTimeMeasureLog Time measure log is output on true false R For debugging
Log enableStopWatchLog Stop watch log is output on true false R For debugging
Log enableShellExecLog Shell command exec is output on true false R For debugging
Log enableImageMatchDebugLog Image match debug log is output on true false R For debugging
Log enableIsInViewLog isInView log is output on true false R For debugging
Log enableIsSafeLog isSafe log is output on true true R For debugging
Log enableIsScreenLog isScreen log is output on true false R For debugging
Log testResults Directory path for output test results (userhome)/Downloads/TestResults R
Log testListDir Directory path for output TestList.xlsx ""(empty) R
Log reportIndexDir Directory path for output report index(html) ""(empty) R
String Comparing strictCompareMode Enable strict mode on comparing string false R
String Comparing keepZenkakuSpace(u+3000) Keep Zenkaku Space on string comparing true R
String Comparing keepLF Keep LF on string comparing false R
String Comparing keepTAB Keep TAB on string comparing false R
String Comparing waveDashToFullWidthTilde Replace WAVE_DASH to FULL_WIDTH_TILDE on string comparing true R
String Comparing compressWhitespaceCharacters Compress space characters to one space on string comparing true R
String Comparing trimString Trim on string comparing true R
Screenshot screenshotScale Reduce the size of screenshot (0.1 to 1.0) 0.5    1.0 (changed in 8.0.1) R
Screenshot screenshotIntervalSeconds Screenshot interval seconds 0.5 R
Screenshot autoScreenshot Takes screenshots automatically true R/C
Screenshot onChangedOnly Takes screenshots on changed only true R/C
Screenshot onCondition Takes a screenshot automatically on condition true R/C
Screenshot onAction Takes a screenshot automatically on action true R/C
Screenshot onExpectation Takes a screenshot automatically on expectation true R/C
Screenshot onExecOperateCommand Takes a screenshot automatically on before and after operate command (tap, swipe, etc.) true R/C
Screenshot onCheckCommand Takes a screenshot automatically on check command (screenIs, exist, etc.) true R/C
Screenshot onScrolling Takes a screenshot automatically on scrolling (tapWithScrollDown, scanElements, etc.) true R/C
Screenshot manualScreenshot Enable manual screenshot on true true R/C
Image Matching enableImageAssertion Enable image assertion true R
Image Matching imageMatchingScale Reduce the size of matching image (0 < x <= 1.0) 0.25 R
Image Matching imageMatchingThreshold Threshold for matching image 1.0 R
Image Matching imageMatchingCandidateCount Count of matched image candidates 20 R
Emulator/Simulator emulatorOptions emulator command options -no-boot-anim -no-snapshot R
Emulator/Simulator emulatorPort emulator port number 5554 R
Emulator/Simulator deviceStartupTimeoutSeconds Virtual device startup timeout seconds 60.0 R/C
Emulator/Simulator deviceWaitSecondsAfterStartup Virtual device wait seconds after startup 0.0 R/C
Emulator/Simulator enableWdaInstallOptimization Enable WDA install optimization true R Fos iOS Simulator
Emulator/Simulator androidLanguageAndRegion Android language and region (e.g. “日本語(日本)”) "" R Fos Android Emulator(bug workaround)
Appium appiumServerUrl Appium server URL (mandatory) R/C ex. http://127.0.0.1:4720/
Appium appiumPath Command or path of appium executable. R/C
Appium appiumArgs Arguments for appium command. Separator can be used. R/C
Appium appiumArgsSeparator Separator used for appiumArgs " " (space) R/C
Appium appiumServerStartupTimeoutSeconds Timeout seconds for starting Appium Server 30.0 R/C
Appium appiumSessionStartupTimeoutSeconds Timeout seconds for starting Appium session 30.0 R/C
Appium implicitlyWaitSeconds default timeout(sec) 5.0 R/C
Appium capabilities Desired capabilities of AppiumDriver (mandatory) C
Appium appPackageFile Package file to install R/C
Appium appPackageDir Directory that package files are placed (userhome)/Downloads R/C
Appium packageOrBundleId Test target app’s package(Android) or bundleId(iOS) (mandatory) R/C
Appium startupPackageOrBundleId Startup app’s package(Android) or bundleId(iOS) R/C
Appium startupActivity Startup app’s activity(Android) (mandatory) R/C
Appium enforceXPath1 Use XPath 1.0(Android) true R/C
Appium Proxy appiumProxyReadTimeoutSeconds Read timeout seconds 20.0 R/C
Appium Proxy appiumProxyGetSourceTimeoutSeconds getSource timeout seconds 60.0 R/C
TestDriver reuseDriver Reuse of TestDriver instance true R/C
TestDriver retryMaxCount Max count of retry 2 R/C
TestDriver retryTimeoutSeconds Retry timeout seconds 15.0 R/C
TestDriver retryIntervalSeconds Retry interval seconds 2.0 R/C
TestDriver enableHealthCheck Execute health check on initializing TestDriver(Android only) true R
TestDriver tapTestSelector Tap test selector on health checking .label R
TestDriver enableAutoSyncAndroid Auto syncing for Android. true improves capcuring elements. false is recommended because of performance problem. false R
TestDriver enableAutoSyncIos Auto syncing for iOS. true improves capcuring elements. false is recommended because of performance problem. false R
TestDriver enableLaunchOnScenario Launch App on starting scenario. true R
TestDriver launchAppMethod Method for launchApp function.
shell: adb or xcrun
tapAppIcon: Built in tapping behavior
[macro name]: e.g. [My Launch Macro]		 auto R shell is not depends on device, but unstable,
tapAppIcon is depends on device, but stable
[macro name] is customizable
TestDriver enableRerunScenario Rerun scenario on recoverable error. true R
TestDriver enableAlwaysRerunOnErrorAndroid Rerun always on error for Android. false R
TestDriver enableAlwaysRerunOnErrorIos Rerun always on error for iOS. false R
TestDriver scenarioTimeoutSeconds Scenario timeout seconds. 90 R
TestDriver scenarioMaxCount Scenario max count (1 or higher) 3 R
TestDriver enableRerunOnScreenshotBlackout Rerun on the screenshot is blacked out. true R
TestDriver screenshotBlackoutThreshold Threshold for screenshot blackout (0.9 to 1.0) 0.995 R
TestDriver enableRestartDeviceOnResettingAppiumSession Restart device on resetting Appium session. (emulator/simulator are supported) false R
TestDriver safeCpuLoad Safe CPU load (%) 70 R
TestDriver enableWaitCpuLoad Wait CPU load to be under safeCpuLoad true R
TestDriver enableWaitCpuLoadPrintDebug Print debug on enableWaitCpuLoad false R
App operation appIconName Name of the app icon R/C
App operation tapAppIconMethod “auto”, “googlePixel”, “swipeLeftInHome” auto R/C
App operation tapAppIconMacro Macro name for tapping app icon R/C
App operation shortWaitSeconds Default wait second for wait function 1.5 R/C
App operation waitSecondsForLaunchAppComplete Default wait seconds for launchApp complete 15.0 R/C
App operation waitSecondsForAnimationComplete Default wait seconds for animation complete 0.5 R/C
App operation waitSecondsOnIsScreen Default wait seconds for screen display 15.0 R/C
App operation waitSecondsForConnectionEnabled Default wait seconds for reconnecting network 8.0 R/C
App operation swipeDurationSeconds Swipe duration seconds 1.5 R/C
App operation flickDurationSeconds Flick duration seconds 0.25 R/C
App operation swipeMarginRatio Ratio of margin on swipe 0.0 R/C Consider momentum scrolling
App operation scrollVerticalStartMarginRatio Ratio of start margin on vertical scroll 0.15 R/C
App operation scrollVerticalEndMarginRatio Ratio of end margin on vertical scroll 0.1 R/C
App operation scrollHorizontalStartMarginRatio Ratio of start margin on horizontal scroll 0.2 R/C
App operation scrollHorizontalEndMarginRatio Ratio of end margin on horizontal scroll 0.1 R/C
App operation scrollToEdgeBoost Swipe times in one action on scrolling to the edge 1 R/C
App operation scrollIntervalSeconds Interval seconds before next scroll 0.5 R/C
App operation scrollMaxCount Max times of scrolling 20 R/C
App operation tapHoldSeconds Tap holding duration seconds 0.0 R/C
App operation enableCache Enable cache true R/C
App operation findWebElementTimeoutSeconds Default wait seconds for findWebElement 0.2 R/C
App operation syncWaitSeconds Syncing wait seconds 1.8 R/C
App operation syncMaxLoopCount Max loop count of syncing 5 R/C
App operation syncIntervalSeconds Interval seconds in syncing 0.5 R/C
Vision visionOCRLanguage Language for AI-OCR ""(empty) R Default(empty) is English
Vision visionOCRCustomWordsFile customWords file for AI-OCR ""(empty) R
Vision visionDirectory vision directory vision R
Vision visionBuildDirectory Working directory for learning build R
Vision visionForceLearningOnStartup Force leaning on startup false R
Vision visionServerUrl vision server url http://127.0.0.1:8081 R
Vision textMarginHorizontal Horizontal margin for segmenting text elements 20 R
Vision textMarginVertical Vertical margin for segmenting text elements 5 R
Vision segmentMarginHorizontal Horizontal margin for segmenting visual elements 5 R
Vision segmentMarginVertical Vertical margin for segmenting visual elements 5 R
Vision segmentCroppingMargin Cropping margin for segment 5 R
Vision visionFindImageThreshold Threshold of findImage in vision mode 0.15 R
Vision visionFindImageBinaryThreshold Threshold of getting binary image in findImage in vision mode 1 R
Vision visionFindImageAspectRatioTolerance Tolerance of aspect ratio for filtering image in findImage in vision mode 0.2 R
Vision visionTextIndexTrimChars Chars to trim on TextIndex R
Vision visionSyncImageMatchRate Screen image matching rate in syncing 0.995 R/C
Vision visionClassifierShardNodeCount Count of shard nodes in the classifier DefaultClassifier=1:ScreenClassifier=1 R
Vision visionLooseMatch Use loose text matching. true: cut off left(max:3 chars) and right(max:2 chars) false R
Vision visionRemoveVoicingMarks Remove voicing marks on text matching (U+3099,U+309A,U+309B,U+309C) true R
Vision visionMergeBoundingBox Match with merging BoundingBox true R
Vision visionLineSpacingRatio Ratio of line spacing on merging BoundingBox in multiline 2.5 R
Vision visionTextToLineHeightRatio Ratio of text to line height 2.0 R
Vision visionSafeAreaTopRatio Ratio of top of SafeArea 0.2 R
Vision visionSafeAreaBottomRatio Ratio of bottom of SafeArea 0.6 R
Vision visionSafePositionVertical Ratio of safe position 0.4 R
Vision visionHorizontalLineThreshold Threshold for image filter to delete horizontal lines 0.7 R
Vision visionVerticalLineThreshold Threshold for image filter to delete vertical lines 0.5 R
Vision visionColorScale Color scale name for image filter GRAY_32 R
Custom CustomObject.scan.dir Directory for searching custom objects src/test/kotlin R
Macro MacroObject.scan.dir Directory for searching macro objects src/test/kotlin R
Special Tags specialTags Any tags for conditional branch for test devices C
Spec-Report specReport.exclude.detail Exclude detail check item of Spec-Report　　 false R
Spec-Report specReport.SKIP.reason Set SKIP reason on supplement field R
Spec-Report specReport.EXCLUDED.reason Set EXCLUDED reason on supplement field R
misc android.swipeOffsetY Adjust y coordinate on swipe(for Android) -20 R For framework developer
misc ios.swipeOffsetY Adjust y coordinate on swipe(for iOS) -5 R For framework developer
misc xmlSourceRemovePattern Regex pattern for characters to remove R For framework developer
misc boundsToRectRatio Conversion ratio of bounds information to bitmap coordinate “1”(Android), “3”(iOS) R/C Depends on retina display
misc selectIgnoreTypes Ignores on selecting by default. This is optimization for iOS XCUIElementTypeCell, XCUIElementTypeApplication R For framework developer
misc titleSelector Selector template for screen title R For framework developer
misc webTitleSelector Selector template for web title R For framework developer
misc jquerySource URL for jQuery javascript file R For framework developer

Path macro

You can use Path macro for log directories.

Path macro description Usage
{USER_HOME} User’s home directory testResults={USER_HOME}/dir1
{DOWNLOADS} Downloads directory testListDir={DOWNLOADS}/dir1
{TEST_RESULTS} TestResults directory reportIndexDir={TEST_RESULTS}/dir1
{DIRECTORY_FOR_TEST_CONFIG} TestConfig directory under TestResults testListDir={DIRECTORY_FOR_TEST_CONFIG}/dir1
{DIRECTORY_FOR_LOG} Log directory under TestResults reportIndexDir={DIRECTORY_FOR_LOG}

Link