The run configuration object

The run configuration object describes the execution configuration. A run configuration contains configuration information about the execution, such as associated test suites, the agent, and the execution commands.

Run configuration properties

{
    "id": 431605,
    "name": "Sample tests",
    "command": "",
    "projectId": xxx,
    "teamId": xxx,
    "testProjectId": 413209,
    "testSuiteId": 1021178,
    "executionProfileId": 103622,
    "timeOut": 60,
    "kobitonDeviceId": "",
    "configType": "TEST_SUITE",
    "testProject": {
      "id": 413209,
      "name": "testcloud-sample-projects",
      "description": "",
      "projectId": xxx,
      "teamId": xxx,
      "createdAt": "2022-11-04T04:02:14.799+0000",
      "type": "GIT",
      "dirty": false
    },
    "agents": [],
    "testCloudAgents": [{...}],
    "k8sAgents": [],
    "circleCIAgents": [],
    "testCloudTestSuiteCollectionAgents": [],
    "cloudType": "TEST_CLOUD_AGENT",
    "genericCommand": "",
    "ksVersion": "8.5.2",
    "ksLocation": "",
    "nextRunScheduler": {},
    "executionMode": "SEQUENTIAL",
    "enabledKobitonIntegration": false,
    "enabledTestCloudTunnel": false,
    "triggerMode": "TESTOPS_SCHEDULER",
    "browserType": "CHROME"
  }

A run configuration object contains the following properties:

PropertyTypeDescription
idintegerThe unique identifier of the run configuration.
namestringThe name of the test execution.
commandstringThe execution command to specify the behavior of the execution.
See Command-line syntax.
projectIdintegerThe ID of the project associated with this execution.
teamIdintegerThe ID of the team associated with this execution.
testProjectIdintegerThe ID of the script repository or zip repository that contains test cases.
releaseIdintegerThe ID of the release associated with the execution
testSuiteCollectionIdintegerThe ID of the test suite collections used in the execution.
testSuiteIdintegerThe ID of the test suite used in the execution.
executionProfileIdintegerThe execution profile configured in Katalon Studio.

See Execution Profile.
baselineCollectionGroupOrderintegerThe order of the Visual Testing baseline collection associated with the execution.

See Baseline collection.
timeOutintegerThe time limit for the execution.
kobitonDeviceIdstringThe Kobiton device ID to execute mobile tests, applied when Kobiton integration is enabled.
configTypestringConfiguration type: TSC, COMMAND, GENERIC_COMMAND, TEST_SUITE.
testProjecttestProject objectThe repository that contains the test cases.
agentsArray of Agent objectsThe local agents used in the execution.
testCloudAgentsArray of TestCloudAgent objectsThe TestCloud agents used in the execution.
k8sAgentsArray of K8SAgent objectsThe Kubernetes (K8s) agents used in the execution.
circleCIAgentsArray of CircleCIAgent objectsThe CircleCI agents used in the execution.
testCloudTestSuiteCollectionAgentsArray of testCloudTestSuiteCollectionAgent objectsThese agents are used for overriding individual test environments of test suites in a test suite collection.
cloudTypestringThe cloud execution type, associated with the agents in use: LOCAL_AGENT, TEST_CLOUD_AGENT, CIRCLE_CI_AGENT, K8S_AGENT, K8S.
latestJobJob objectThis object describes the latest execution.
genericCommandstringThe generic execution command configured for the execution.
ksVersionstringThe version of Katalon Runtime Engine used for the execution.
ksLocationstringThe location of Katalon Runtime Engine instance, applied when using local agent.
nextRunSchedulerscheduler objectThe scheduler object for the next execution.
releaserelease objectThe release object associated with the execution.
buildbuild objectThe build object associated with the execution.
executionModestringThere are two execution modes: SEQUENTIAL and PARALLEL.
enabledKobitonIntegrationbooleantrue if Kobiton integration is enabled.
enabledTestCloudTunnelbooleantrue if TestCould Tunnel is enabled.
triggerModestringHow the execution should be triggered: TESTOPS_SCHEDULER (triggered at the specified date and time) or MANUAL_TRIGGER (triggered manually by the user).
browserTypestringThe test environment used in the execution:

  • CHROME

  • FIREFOX

  • SAFARI

  • EDGE

  • EDGE_CHROMIUM

  • WEB_SERVICE

  • CHROME_HEADLESS

  • FIREFOX_HEADLESS

  • MOBILE_BROWSERS

  • MOBILE_NATIVE

  • ALL