# Jenkins
Integrating Jenkins with SimplifyQA allows teams to automate their test execution as part of the CI/CD pipeline. This setup enables seamless execution of test suites post-code deployment, ensuring quality assurance at every stage of the development lifecycle.
### Prerequisites
* You have an active SimplifyQA subscription
* An agent is installed and running on the machine for execution
* You have an active Jenkins subscription
### Create a Pipeline in SimplifyQA
1. Log in to your SimplifyQA account
2. Navigate to the **Pipelines** section from the left-hand panel.
3. Click on **+Pipeline** to create a new one.
4. Enter a meaningful name for your pipeline.
5. Enter the required details and click on save to create the pipeline
#### Configure the pipeline details:
* **Pipeline Type:** Choose whether you want to run on **Test Case** or **Suite**
* **Execution Type:** Choose whether you want to run on **Local** or **Cloud**
* **Local Execution**
If you choose to run tests locally:
* Select **Local** under Execution Type.
* You must specify the **Local Machine Name** where the SimplifyQA Agent is installed and running.
* **Cloud Execution**
If you opt for Cloud Execution, you need to register your execution environment on the cloud first. This allows to spin up virtual machines or containers for remote execution. Refer to [Cloud Configuration](https://docs.simplifyqa.ai/marketplace/integrating-with-cloud-platforms/vm-based) to configure your cloud.
* **Test Case/Suite ID:** Select the test case or suite
* **Version & Execution Type:** Select the desired versions
* **Machine Name:** Specify the [machine](https://docs.simplifyqa.ai/simplifyqa-installation-and-setup/register-your-machine) for test execution
* **Environment:** Choose the target environment
* **Release and Sprint:** Define these for tracking purposes
### Install SimplifyQA Extension in Jenkins
1. Log in to your Jenkins account.
2. Go to **Manage Jenkins** from the sidebar.
3. Click on **Manage Plugins**.
4. Navigate to the **Available** tab.
5. In the search bar, type **SimplifyQA Automation Hub**.
6. Select the plugin and click **Install**.
7. Once installed, verify it appears under the **Installed** tab.
### Create a Jenkins Job
1. On the Jenkins dashboard, click on **New Item**.
2. Enter a name for your project.
3. Select **Freestyle project** and click **OK**.
4. This creates a new Jenkins job you can now configure with SimplifyQA.
### Configure SimplifyQA Automation Hub in Build Step
1. Go to the newly created Jenkins project and click **Configure**.
2. Scroll to the **Build** section.
3. Click **Add build step** → Select **SimplifyQA Pipeline Executor**.
### Fill in Required Fields in Build Configuration
You’ll be prompted to provide:
* **API URL** – Base API endpoint for SimplifyQA (e.g., `https://app.simplifyqa.com/api`)
* **API Key** – [Used for authentication](#generate-api-key-from-simplifyqa).
* **Pipeline ID** – The ID of the test pipeline you want to execute.
* **Threshold** – Minimum pass percentage required to mark the build as successful (e.g., `80`).
#### Generate API Key from SimplifyQA
* Log in to **SimplifyQA**.
* Navigate to **Settings → Security → Create & Manage API Token**.
* Click **Generate Token**, name your token, and click **Save**.
* Copy the generated API key and paste it into the Jenkins configuration.
### Save & Build
1. After entering all required details, click **Save** and **Apply**.
2. You can now trigger a Jenkins build to execute your test pipeline in SimplifyQA.
### Monitor Logs in Console Output
1. Trigger the build from Jenkins.
2. Click on the build number → **Console Output**.
3. The output will show:
1. API authentication success/failure
2. Pipeline execution status
3. Number of test cases passed/failed
4. You can also view detailed test execution in SimplifyQA under the **Execution** tab.
Integrating Jenkins with SimplifyQA allows teams to automate their test execution as part of the CI/CD pipeline. This setup enables seamless execution of test suites post-code deployment, ensuring quality assurance at every stage of the development lifecycle.
### Prerequisites
* You have an active SimplifyQA subscription
* An agent is installed and running on the machine for execution
* You have an active Jenkins subscription
### Create a Pipeline in SimplifyQA
1. Log in to your SimplifyQA account
2. Navigate to the **Pipelines** section from the left-hand panel.
3. Click on **+Pipeline** to create a new one.
4. Enter a meaningful name for your pipeline.
5. Enter the required details and click on save to create the pipeline
#### Configure the pipeline details:
* **Pipeline Type:** Choose whether you want to run on **Test Case** or **Suite**
* **Execution Type:** Choose whether you want to run on **Local** or **Cloud**
* **Local Execution**
If you choose to run tests locally:
* Select **Local** under Execution Type.
* You must specify the **Local Machine Name** where the SimplifyQA Agent is installed and running.
* **Cloud Execution**
If you opt for Cloud Execution, you need to register your execution environment on the cloud first. This allows to spin up virtual machines or containers for remote execution. Refer to [Cloud Configuration](https://docs.simplifyqa.ai/marketplace/integrating-with-cloud-platforms/vm-based) to configure your cloud.
* **Test Case/Suite ID:** Select the test case or suite
* **Version & Execution Type:** Select the desired versions
* **Machine Name:** Specify the [machine](https://docs.simplifyqa.ai/simplifyqa-installation-and-setup/register-your-machine) for test execution
* **Environment:** Choose the target environment
* **Release and Sprint:** Define these for tracking purposes
### Install SimplifyQA Extension in Jenkins
1. Log in to your Jenkins account.
2. Go to **Manage Jenkins** from the sidebar.
3. Click on **Manage Plugins**.
4. Navigate to the **Available** tab.
5. In the search bar, type **SimplifyQA Automation Hub**.
6. Select the plugin and click **Install**.
7. Once installed, verify it appears under the **Installed** tab.
### Create a Jenkins Job
1. On the Jenkins dashboard, click on **New Item**.
2. Enter a name for your project.
3. Select **Freestyle project** and click **OK**.
4. This creates a new Jenkins job you can now configure with SimplifyQA.
### Configure SimplifyQA Automation Hub in Build Step
1. Go to the newly created Jenkins project and click **Configure**.
2. Scroll to the **Build** section.
3. Click **Add build step** → Select **SimplifyQA Pipeline Executor**.
### Fill in Required Fields in Build Configuration
You’ll be prompted to provide:
* **API URL** – Base API endpoint for SimplifyQA (e.g., `https://app.simplifyqa.com/api`)
* **API Key** – [Used for authentication](#generate-api-key-from-simplifyqa).
* **Pipeline ID** – The ID of the test pipeline you want to execute.
* **Threshold** – Minimum pass percentage required to mark the build as successful (e.g., `80`).
#### Generate API Key from SimplifyQA
* Log in to **SimplifyQA**.
* Navigate to **Settings → Security → Create & Manage API Token**.
* Click **Generate Token**, name your token, and click **Save**.
* Copy the generated API key and paste it into the Jenkins configuration.
### Save & Build
1. After entering all required details, click **Save** and **Apply**.
2. You can now trigger a Jenkins build to execute your test pipeline in SimplifyQA.
### Monitor Logs in Console Output
1. Trigger the build from Jenkins.
2. Click on the build number → **Console Output**.
3. The output will show:
1. API authentication success/failure
2. Pipeline execution status
3. Number of test cases passed/failed
4. You can also view detailed test execution in SimplifyQA under the **Execution** tab.
