zt-docs

Documentation

Our comprehensive documentation covers everything you will need to know when using ZAPTEST.

Quick links for popular resources

Getting Started

Methods

Options

API Methods

FARM

LOAD

Getting Started

Auto E-Mailing of Test Results

Differences between OCR Modes

Dynamic Table Overview

Exception Handling

Exception Handling Overview

Exception Handling Usage

File Operations - New, Open, Save

GUI Map Controls Overview

GUI Map Debug Mode

GUI Map Object Highlighting

GUI Map Recalculate Position of OCR Objects

Generating PDF and HTML Reports

HotKeys - Pause/Stop Execution

How to Duplicate Object View

How to Scan Application on the USB connected device

How to Scan Applications with GUI Map

How to encrypt password in Type method

How to run the application on the USB connected device

How to setup VirtualBox on Mac for ZAPTEST

How to use Auto-Anchoring

How to use RDP Connections

How to use Recorder

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

ZAPTEST Command Line Execution

ZAPTEST Object Recognition (ZOE) Introduction

M-Run

Basic Usage

Connect Devices

Script and Step Views

Advanced

Keyboard/Mouse Control

Local Variables per Device

Mobile Application Configuration

FARM Integration

Utilities

Integrations Menu

Datatable Methods

Method ExportCSV

Method ExportExcel

Method ImportCSV

Method ImportExcel

Method SetValue

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 Studio Overview

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

Test Data Settings

Common Settings

Runtime Statistics Overview

Load Generator Settings

Methods

Method GetAverageColorName

Method GetAverageColorRGB

Method GetCellColor

Method GetCellColumn

Method GetCellRow

Method GetCellText

Method GetColumns

Method GetPlatformName

Method GetPlatformType

Method GetProperty

Method GetRowText

Method GetRuntimeHeight

Method GetRuntimePosition

Method GetRuntimeWidth

Method GetRuntimeX

Method GetRuntimeY

Method Highlight

Method KeyPress

Method LaunchMobileWeb

Method LeftBlock

Method MouseMove

Method NotExist

Method ReportText

Method RightBlock

Method RightClick

Method ScrollTo

Method ScrollWheel

Method SetPlatformName

Method SetPlatformType

Method SetProperty

Method SetWindowLocation

Method SetWindowSize

Method SetWindowState

Method TopBlock

Method TypeCell

Method TypeEncrypted

Method BottomBlock

Method CaptureBitmap

Method ClickCell

Method ClickRow

Method CompareAverageColorName

Method CompareAverageColorRGB

Method Contains

Method CustomReport

Method CustomReportEx

Method DblClick

Method DblClickCell

Method DblClickRow

Method ExistTransactionStop

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

Method SetRequestXmlNamespace

Method GetRequestXmlNamespace

Method GetRequestGetParameter

Method SetRequestGetParameter

Method SetRequestRawBody

Method GetRequestRawBody

Method GetRequestBodyItem

Method SetRequestBodyItem

Method SetRequestHeader

Method GetRequestHeader

Method GetCheckListItem

Method ExecuteAndCheckResponseByList

Method CheckResponseByList

Method GetHeaderNames

Method GetRequestBody

Method GetHeaderValue

Method GetHeaderValues

Method GetHeaderValueByIndex

Method CheckHeaderValue

Method GetProperty (API)

Method SetProperty (API)

Method GetLastError

Method GetResponseStatusCode

Method GetMemberResponse

Method CheckMemberResponse

Method GetArrayResponse

Method GetStringResponse

Method ResponseContains

Method HasResponse

Method GetExecutionTime

Method SetRequestAttachment

Method GetRequestAttachmentPath

Method GetRequestAttachmentType

Method SetCheckListItem

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

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

Coordinates Recognition Type Property

Font Size Calibration Property

OCR Templates Property

Precision Property

Recognition Type Property

Scalability Property

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 user management

FARM main UI Overview

How to install FARM

FARM Private Cloud

FARM Private Cloud Overview

Privacy Overview

This website uses cookies to improve your experience while you navigate through the website. Out of these, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may affect your browsing experience.

Necessary

Always Enabled

Necessary cookies are absolutely essential for the website to function properly. These cookies ensure basic functionalities and security features of the website, anonymously.

Cookie	Duration	Description
cookielawinfo-checkbox-analytics	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checkbox-functional	11 months	The cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checkbox-necessary	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-others	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-performance	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
viewed_cookie_policy	11 months	The cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.

Others