setDontCloseBatches method

Class: VisualGridRunnerPlatform: AppiumLanguage: Java SDK:

Call this method to disable the runner Auto close batch feaure.

Introduction

The Test Manager displays test results in batches. The article Grouping tests into batches with the SDK explains how tests are associated with batches based on a batch ID, and how you can use the SDK to control which tests will be part of a particular batch.

Here, we will focus on understanding the notions of an active batch and closing a batch.

A batch is created and becomes active when a test is started with a batch ID that does not match an existing active batch. As long as a batch is active, new tests that have a matching batch ID will be added to the batch.

Batches are closed automatically in one of two ways. By default, runner-based SDKs implement the Auto batch closure feature. This feature closes the batches associated with the runner's test after the tests have completed. In addition, in order to prevent large batches that could cause performance issues, the Eyes server closes active batches that have not been used for several hours, or if they have been in continuous use for more than a few days.

When a batch is closed, the Eyes server can send the user a batch completion notification. This feature must be enabled explicitly, see Batch completion notifications for details.

You can manage Auto batch closure by:

Syntax

runner.setDontCloseBatches(dontCloseBatches);

Parameters

dontCloseBatches
Type:boolean
Pass a value of true to disable Auto batch closure.

Return value

Type: void

Example

=setdontclosebatches.batchcloseexample