Integrating Jenkins with Zoho QEngine | Zoho QEngine Help

Integrating Zoho QEngine with Jenkins

1. Overview 

Zoho QEngine supports integrations that enable users to streamline their testing processes by connecting with external services.  

The Jenkins integration with Zoho QEngine automates testing within a CI/CD pipeline. By leveraging Jenkins' orchestration capabilities alongside Zoho QEngine's testing expertise, users can seamlessly integrate automated test plans into their continuous integration process. This ensures that every test case change is validated through rigorous testing, enabling early detection of defects and accelerating delivery of efficient applications or services.


Zoho QEngine offers a plugin to automate test execution within the Jenkins Pipeline. This document provides detailed instructions on setting up Jenkins to integrate it with Zoho QEngine, configuring the plugin, and customizing it to meet your specific testing requirements.

2. Pre-requisites 

Before setting up Jenkins integration with Zoho QEngine, ensure the following:

2.1: Install the Zoho QEngine Test Plan Execution plugin
  1. Open Jenkins and navigate to the Manage Jenkins > Plugins section.



  2. Search for the Zoho QEngine Test Plan Execution Plugin from the Plugins tab or the Jenkins Plugin Marketplace.


  3. Install the plugin and restart Jenkins if prompted.


Alternatively, you can deploy the plugin manually by following these steps:
  1. Download the plugin .hpa file from this link: URL 
  2. Navigate to Manage Jenkins > Plugins > Advanced settings tab.



  3. Click Choose File in the upload section.

  4. Select the downloaded .hpi file and click Deploy.

 2.2: Generate an API Key in Zoho QEngine  

Navigate to Setup > API Keys in Zoho QEngine to generate and securely copy the API key. For detailed instructions, refer to the document Generate API Keys within Zoho QEngine

2.3: Retrieve the Execution URL from Test Plans in Zoho QEngine  

Navigate to the Test Plans section in your Zoho QEngine project to fetch the execution URL. For more detailed steps, refer to the document Test Plans

3. Steps to Integrate Zoho QEngine with Jenkins 

Log into your Jenkins Instance after starting it. You will be directed to the Jenkins Dashboard, as shown below:


Step 1: Create a New Pipeline
  1. On the Dashboard, click + New Item from the left menu.



  2. Provide an item name for the pipeline, select Freestyle project as the project type, and click OK to create it.


Once the project is created, you'll be navigated to the project's configuration page.

Step 2: Add a Build Step with the Zoho QEngine Plugin
  1. Navigate to Configuration > Build Steps.



  2. Click Add build step to configure executions of the test plans on Zoho QEngine.



  3. From the options, select Zoho QEngine Test Plan Execution to use the Zoho QEngine plugin.



  4. Provide the following details to setup the build steps:
    1. Test Plan Execution URL: Enter the execution URL fetched from the Test Plan.
    2. API Key: Provide the API key generated in Zoho QEngine.
    3. Maximum Wait Time: Specify the maximum estimated time (in minutes) that the associated test plan takes to complete execution. If execution exceeds this limit, the build automatically terminates and is marked as failed.
    4. Build Name: Provide a name for the build.


  1. Click Save to apply and save your changes. You will be redirected to the Status page of the project.

     

Step 4: Execute the Build
  1. Click Build Now to manually trigger the pipeline for testing. This action starts the build process, and a new build will be listed in the Builds section with a unique build number.


Step 5: View Logs
You can view the logs once the build process is completed.
  1. Click on the build number (e.g., #12) corresponding to the build you triggered.



NotesNote: You can also utilize permalinks for quick access to specific builds.

  1. Click on Console Output on the left pane to view the logs for the execution.



  2. Finally, you'll see the logs that indicate details about the test execution and its results.

     

4. Related links 

5. What's next

Next step
Previous step
Next step
To learn more about viewing and analyzing test results in Zoho QEngine, refer to the Results documentation.
Previous step
Learn how to generate API Keys and fetch the Execution URL in Zoho QEngine by referring to the documents Generate API Keys within Zoho QEngine and Test Plans.
 



        Create. Review. Publish.

        Write, edit, collaborate on, and publish documents to different content management platforms.

        Get Started Now


          Access your files securely from anywhere

            Zoho CRM Training Programs

            Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

            Zoho CRM Training
              Redefine the way you work
              with Zoho Workplace

                Zoho DataPrep Personalized Demo

                If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

                Zoho CRM Training

                  Create, share, and deliver

                  beautiful slides from anywhere.

                  Get Started Now


                    Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                    BOOK A SESSION







                                Quick LinksWorkflow AutomationData Collection
                                Web FormsEnterpriseOnline Data Collection Tool
                                Embeddable FormsBankingBegin Data Collection
                                Interactive FormsWorkplaceData Collection App
                                CRM FormsCustomer ServiceAccessible Forms
                                Digital FormsMarketingForms for Small Business
                                HTML FormsEducationForms for Enterprise
                                Contact FormsE-commerceForms for any business
                                Lead Generation FormsHealthcareForms for Startups
                                Wordpress FormsCustomer onboardingForms for Small Business
                                No Code FormsConstructionRSVP tool for holidays
                                Free FormsTravelFeatures for Order Forms
                                Prefill FormsNon-Profit

                                Intake FormsLegal
                                Mobile App
                                Form DesignerHR
                                Mobile Forms
                                Card FormsFoodOffline Forms
                                Assign FormsPhotographyMobile Forms Features
                                Translate FormsReal EstateKiosk in Mobile Forms
                                Electronic Forms
                                Drag & drop form builder

                                Notification Emails for FormsAlternativesSecurity & Compliance
                                Holiday FormsGoogle Forms alternative GDPR
                                Form to PDFJotform alternativeHIPAA Forms
                                Email FormsFormstack alternativeEncrypted Forms

                                Wufoo alternativeSecure Forms

                                TypeformWCAG


                                    All-in-one knowledge management and training platform for your employees and customers.

                                              Create. Review. Publish.

                                              Write, edit, collaborate on, and publish documents to different content management platforms.

                                              Get Started Now




                                                                You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                                    Manage your brands on social media


                                                                      • Desk Community Learning Series


                                                                      • Digest


                                                                      • Functions


                                                                      • Meetups


                                                                      • Kbase


                                                                      • Resources


                                                                      • Glossary


                                                                      • Desk Marketplace


                                                                      • MVP Corner


                                                                      • Word of the Day


                                                                      • Ask the Experts


                                                                        Zoho Sheet Resources

                                                                         

                                                                            Zoho Forms Resources


                                                                              Secure your business
                                                                              communication with Zoho Mail


                                                                              Mail on the move with
                                                                              Zoho Mail mobile application

                                                                                Stay on top of your schedule
                                                                                at all times


                                                                                Carry your calendar with you
                                                                                Anytime, anywhere




                                                                                      Zoho Sign Resources

                                                                                        Sign, Paperless!

                                                                                        Sign and send business documents on the go!

                                                                                        Get Started Now




                                                                                                Zoho TeamInbox Resources





                                                                                                          Zoho DataPrep Demo

                                                                                                          Get a personalized demo or POC

                                                                                                          REGISTER NOW


                                                                                                            Design. Discuss. Deliver.

                                                                                                            Create visually engaging stories with Zoho Show.

                                                                                                            Get Started Now








                                                                                                                                • Related Articles

                                                                                                                                • Configuring Zoho Sprints in Zoho QEngine

                                                                                                                                  1. What does this page cover This document guides you on how to configure Zoho Sprints within Zoho QEngine. Before you begin, it's essential to understand how Zoho Sprints integration works. 2. Steps to configure integration with Zoho Sprints Note: ...
                                                                                                                                • Configuring Zia for Zoho QEngine

                                                                                                                                  What does this page cover Learn how to configure an AI model for Zia, Zoho QEngine's AI assistant, to enable capabilities such as generating manual test cases and test data. This page explains how to set up Zoho GenAI or connect external AI models ...
                                                                                                                                • Integrating Zoho QEngine with Zoho Sprints

                                                                                                                                  In a nutshell Zoho QEngine integrates effortlessly with Zoho Sprints, an agile project management tool. With this integration, users can report bugs from test case executions in Zoho QEngine directly to Zoho Sprints. This ensures smooth tracking and ...
                                                                                                                                • Migrating from Postman to Zoho QEngine

                                                                                                                                  1. Overview Zoho QEngine has a dedicated API testing platform that enables you to test third-party applications' APIs efficiently. With its powerful testing abilities, you can streamline your API validation processes. Learn more For users migrating ...
                                                                                                                                • Generate API keys in Zoho QEngine

                                                                                                                                  1. Overview Zoho QEngine provides secure methods to authenticate its interactions with external services. To facilitate this, QEngine supports API key generation, allowing users to create unique keys for secure communication between external services ...
                                                                                                                                  Wherever you are is as good as
                                                                                                                                  your workplace

                                                                                                                                    Resources

                                                                                                                                    Videos

                                                                                                                                    Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                                    eBooks

                                                                                                                                    Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                                    Webinars

                                                                                                                                    Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                                    CRM Tips

                                                                                                                                    Make the most of Zoho CRM with these useful tips.



                                                                                                                                      Zoho Show Resources