Documentation
Tutorials
Company
Contact

Schedule a Discovery Briefing →

Documentation/DOC

Generate Documentation

Browse documentation

All documentation Tutorials

Getting Started

How-to use Shared Repository Path Tuner
How to run the application on the USB connected device
How to encrypt password in Type method
How to setup VirtualBox on Mac for ZAPTEST
How to use Auto-Anchoring
How to use RDP Connections
How to use transactions
License Management
M-RUN Debug Mode
Repository Explorer
Step Emulator How To
Troubleshooting ‘Application Not Found’
What’s New in ZAPTEST 17
ZAP License Server Overview
ZAP Namespace
ZAPTEST Command Line Execution
ZAPTEST Object Recognition (ZOE) Introduction
Auto E-Mailing of Test Results
How to Scan Applications with GUI Map
How to Scan Application on the USB connected device
How to Duplicate Object View
HotKeys – Pause/Stop Execution
Generating PDF and HTML Reports
GUI Map Recalculate Position of OCR Objects
GUI Map Object Highlighting
GUI Map Debug Mode
GUI Map Controls Overview
File Operations – New, Open, Save
Exception Handling Usage
Exception Handling Overview
Exception Handling
Dynamic Table Overview
Differences between OCR Modes

REC

REC Studio – Working with a Recorded Video
REC Studio – Recording a Video
REC Studio – Controls Overview

M-Run

Basic Usage
Connect Devices
Multiview
Run Scripts
Script and Step Views
Advanced
Keyboard/Mouse Control
Local Variables per Device
Mobile Application Configuration
Settings
FARM Integration

Utilities

View Menu
Debug Menu
Edit Menu
File Menu
Help Menu
Integrations Menu
Run Menu
Tools Menu

Datatable Methods

Method ExportCSV
Method ExportExcel
Method ImportCSV
Method ImportExcel
Method SetValue
Method Value

Keyboard Methods

Method Keyboard.SetLocalAfterTypeMethodDelay
Method Keyboard.SetLocalBeforeTypeMethodDelay
Method Keyboard.SetLocalCharacterTypeDelay
Method Keyboard.SetRemoteAfterTypeMethodDelay
Method Keyboard.SetRemoteBeforeTypeMethodDelay
Method Keyboard.SetRemoteCharacterTypeDelay
Method Keyboard.SetTypeDelay

SystemUtil Namespace

Method SystemUtil.CloseProcessByHwnd
Method SystemUtil.CloseProcessById
Method SystemUtil.CloseProcessByName
Method SystemUtil.CloseProcessByWndTitle
Method SystemUtil.EndOfStream
Method SystemUtil.HasExited
Method SystemUtil.
Method SystemUtil.ProcessExitCode
Method SystemUtil.ProcessId
Method SystemUtil.ReadLine
Method SystemUtil.ReadToEnd
Method SystemUtil.Run
Method SystemUtil.Write
Method SystemUtil.WriteLine

HPALM Namespace

Method HPALM.SubmitAlmStepResult
Property HPALM.CurrentRunName
Property HPALM.CurrentTestName
Property HPALM.CurrentTestSetName

Options Namespace

Property Options.ForceCoordinatesRecognition
Property Options.GlobalStepDelay
Property Options.GlobalTimeout

API

ZAPTEST – API Correlation Manager Overview
ZAPTEST – API REC Editor Overview
ZAPTEST – API REC Overview

LOAD

Data Allocation Settings
Execution and Limitation Settings
Remote Generator – Settings
Environment Manager Overview
Module Controls Overview
Test Results Overview
SLA Settings
Test Data Settings
Common Settings
Runtime Statistics Overview
Load Generator Settings

Methods

ZAP Namespace Methods

Method RestartIteration
Type WindowStates
Method msgbox / alert
Method Wait
Method TestPath
Method TestName
Method StopTest
Method StopIteration
Method StartTransaction
Method SetLocalVar
Method SetGlobalVar
Method SetClipboard
Method Runtest
Method RestartTest
Method MakeColorFromRGB
Method ClearLocalVar
Method MakeColorFromName
Method Iteration
Method InputPasswordBox
Method InputBox
Method Include
Method ImportGlobalVars
Method HideText
Method GetLocalVar
Method GetGlobalVar
Method GetClipboard
Method ExportGlobalVars
Method EndTransaction

TestParameters Namespace

Method TestParameters.Add
Method TestParameters.Clear / RemoveAll
Method TestParameters.Contains
Method TestParameters.Item
Method TestParameters.Key
Method TestParameters.Remove
Method TestParameters.SetItem
Method TestParameters.ToString

API Methods

WebDriver

Working with WebDriver Inspector and active sessions
ZAPTEST WebDriver Quick Start Guide and Overview
How-to WebDriver Options
How-to WebDriver Explorer Overview
WebDriver Session Overview
How-to WebDriver Locators
WebDriver Methods Overview
WebDriver Working With Windows And Tabs
WebDriver Working With iFrames
How-to Updating WebDriver for Chrome browser

Options

Auto-Update Options
Function Libraries
GUI Map Options
General Options
Global Variables
GlobalStepDelay Option
GlobalTimeout Option
License Options
Runtime Options
Test Settings, Datatable Iterations
Test Settings, Repository Location
Test Settings, Scripting Language
Auto-Save Options
Account Options
Auto-Saving of Test Results

DOC

Advance Usage
Basic Usage
Export Documentation
Generate Documentation
Regenerate Doc on Script Changes

Device Manager

iOS & Android
How to connect Android device
How to connect iOS device
How to connect to application
How to get the device logs
How to install Android application
How to install Android drivers
How to install iOS application
How to remove installed application
How to restart the device
Mac OS X
Connecting with ZAP-fiX Mac Viewer
OS X Configuration
Unix
Connecting with ZAP-fiX Unix Viewer
Unix/Linux Configuration

Integrations

CA Rally Integration
How to use ALM connections
JIRA Integration

Object Properties

Activate Window Property
Allowed Characters Property
Appearance Property
Area Type
Coordinates Recognition Type Property
Font Size Calibration Property
Gamma Property
List Type
OCR Templates Property
Object Type
Object Types
Precision Property
Recognition Type Property
Scalability Property
Swiper Type
Table Type

Jira Integration Namespace

Method JiraIntegration.Enable
Method JiraIntegration.LoadDefaultConfiguration
Method JiraIntegration.SaveAsDefaultConfiguration
Method JiraIntegration.SetComponents
Method JiraIntegration.SetCredentials
Method JiraIntegration.SetProject
Method JiraIntegration.SetServer

Common Namespace

Method Common.GenerateRandomNumberAsString
Method Common.GetFormattedDateValue
Method Common.ReplaceSubString
Method Common.ShowMessageBox
Method Common.StringConcat
Method Common.ColorGetBlueChannel
Method Common.ColorGetGreenChannel
Method Common.ColorGetRedChannel
Method Common.ColorMakeFromRGB
Method Common.ConvertBooleanToString
Method Common.ConvertDoubleToString
Method Common.ConvertIntToString
Method Common.ConvertStrToBoolean
Method Common.ConvertStrToDouble
Method Common.ConvertStrToInteger
Method Common.GenerateRandomNumber

Report Namespace

Method Report.DisableEmailReporting
Method Report.EnableEmailReporting
Method Report.EndSection
Method Report.GetFailedStepsCount
Method Report.GetInformationStepsCount
Method Report.GetPassedStepsCount
Method Report.GetWarningStepsCount
Method Report.SetActiveSectionName
Method Report.StartSection
Type Report.ResultStatuses

CommandLineArguments Namespace

Property CommandLineArguments.DatatablePath
Property CommandLineArguments.SheetName

ZAPFARM

FARM groups
FARM user management
FARM main UI Overview
How to install FARM
FARM Private Cloud
FARM Private Cloud Overview

Troubleshooting

Error: Incorrect Syntax Used For The Method
Error: Not Found In The Repository
Error: Object Doesn’t Support This Property or Method
Error: Type Mismatch: “sleep”

Watch on YouTube

PreviousExport Documentation NextRegenerate Doc on Script Changes

ZAPTEST, Inc.
1395 Brickell Ave, Suite 800
Miami, FL 33131
(800) 795-3552

ZADS

AI Digital Specialists · zads.io
AI Digital Soldiers · zads.us
Schedule a Discovery Briefing

ZAPTEST Enterprise

Documentation
Download
Customer login
Pricing

Company

Our story
Leadership
LinkedIn
YouTube

© 2026 ZAPTEST, Inc. All rights reserved. · EULA · Privacy PolicyU.S. Owned & Operated · Miami, Florida · Since 1999