setBatch method

Class: ConfigurationPlatform: ImagesLanguage: JavaScript SDK:

Use this method to set the batch information for this test.

In the Test Manager, all the results of tests that were executed as a single batch are displayed together and can be managed and operated on as a group. See How to organize your tests with batches and How to group tests into batches using the SDK for details and an example.


let configval = config.setBatch(value);


An object that defines the batch configuration.

Type definitions

The type BatchInfoObject is defined as: {id:(string|undefined),name:(string|undefined),startedAt:(Date|string|undefined),sequenceName:(string|undefined),notifyOnCompletion:(boolean|undefined)}.

Return value

Type: Configuration
The value returned is the object that called the method. This allows you to use a fluent style to call the setXXXX methods of the Configuration class.