π Overview
This guide explains how to create and upload a batch CSV file to run multiple tests automatically in kapptivate. A CSV batch file contains:
- DESCRIPTION β general metadata about the batch
- OPTIONS β optional execution parameters
- TESTS β the list of tests to run
Each section must start with its corresponding header:
__DESCRIPTION__ __OPTIONS__ __TESTS__
π DESCRIPTION section
This section defines the name of the batch and the variable_group_id associated with your environment. The batch will use the variables defined inside that group.
How to find your variable_group_id:
- Open the product where your tests belong.
- Go to Configurations β Variables groups.
- Select the variable group you want to use.
- Look at the end of the URL:
https://example.kapptivate.com/customer/project/env/groups/363
The number (363) is your variable_group_id.
Example DESCRIPTION block:
__DESCRIPTION__ name;Long Test Suite variable_group_id;363
βοΈ OPTIONS section
The OPTIONS section contains parameters that modify how kapptivate executes the batch. All options are optional. You can include any number of them.
Example table of available options:
Option Example value sms_observation_delay 0 timeout_sms 30 timeout_ussd_push 30 send_result_by_mail True send_result_by_sms False send_result_by_call False run_later True run_datetime 2025-07-27T09:36:54.653Z organizationGroup kapptivate product product1 ignore_errors False email_recipients john.doe@company.com sms_recipients +33010000000 call_recipients +33010000000 ignore_failed Example OPTIONS block:
__OPTIONS__ ignore_errors;True send_result_by_mail;True email_recipients;user@example.com
π§ͺ TESTS section
The TESTS section lists the tests that will be executed. Each line contains:
- The test ID
- Optional variables in
key;valuepairs
How to find a test ID:
Open the test in kapptivate β the ID is the number at the end of the URL:
https://app.kapptivate.com/.../test/edit/246You can pass as many variables as needed, following the structure:
TEST_ID;key1;value1;key2;value2
Example:
__TESTS__ 187;AGENT;R58M92A1MYY 187;AGENT;XPH5T19823002962 190
π Full CSV example
__DESCRIPTION__ name;Long Test Suite variable_group_id;363 __OPTIONS__ ignore_errors;True send_result_by_mail;True email_recipients;john.doe@example.com __TESTS__ 187;AGENT;R58M92A1MYY 187;AGENT;XPH5T19823002962 190
π Run a batch of tests
Once your CSV file is ready, follow these steps:
- Go to the Tests page in kapptivate.
- Click on Upload CSV inside the run queue.
- Select your file.
- Click Run tests.
You will be redirected to the batch execution page automatically.