# How to use Katalon TestOps Agent to schedule and remotely execute a Katalon Studio project **URL:** \ **Category:** Test management\ **Tags:** katalon-testops\ **Created:** [June 29, 2020, 6:22am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031 "2020-06-29T06:22:27Z")\ **Posts on this page:** 20\ **Page:** 1
**Author:** ![devalex88](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/devalex88/32/336_2.png) [@devalex88](https://forum.katalon.com/u/devalex88)\ **Post date:** [June 29, 2020, 6:22am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/1 "2020-06-29T06:22:27Z")
Hi everyone, In this tutorial, I’ll show you how to use Katalon TestOps Agent to schedule and remotely execute a Katalon Studio project. Katalon TestOps Agent will help you: - Install and manage multiple versions of Katalon Runtime Engine on your test machines without any manual intervention. - Retrieve the latest version of your Katalon Studio projects that are stored on Katalon TestOps or Git to execute, and submit the test results back to Katalon TestOps for review. - Keep the number of concurrent executions under a configurable limit. Katalon TestOps will distribute jobs among Agents to balance their workload. This feature is especially helpful if you only have a limited number of licenses and want to queue your executions periodically. ## Prepare a sample Katalon Studio project You can find the sample project here [GitHub - katalon-studio-samples/test-project-sample · GitHub](https://github.com/katalon-studio-samples/test-project-sample). This project contains a single test case (`Form`) that fills information into a form. The test case is put in a Test Suite (`Simple Test Suite`) and this test suite is put in a Test Suite Collection (`Simple Test Suite Collection`). ![image](https://europe1.discourse-cdn.com/katalon/original/2X/4/495f5ce043bc6de5c2c87a644639a1767bf7e996.png) ## Integrate with Katalon TestOps Connect this sample project to a Katalon TestOps project. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/e/e8c417f60e0d37677c685973aed4eaba90846252.png) This way execution results will be submitted back to Katalon TestOps. It also helps monitor the progress of long-running executions. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/9/953ea17b234a1be9fcd66b641a00f2ebda3d14cc.png) ## Install Katalon TestOps Agent on a test machine Navigate to Katalon TestOps CI. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/4/4390fe779eb7291dbbaa30fce223e82af219a427.png) From here, navigate to the **Agent Setup** wizard. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/3/3fe90052a0173f7946a5588c37cd07b13472c7c3.png) In this wizard, provide my machine’s OS (Windows x64) and download the package from the link ([https://github.com/katalon-studio/katalon-agent/releases/download/v1.4.1/katalon-agent-win-x64-v1.4.1.zip](https://github.com/katalon-studio/katalon-agent/releases/download/v1.4.1/katalon-agent-win-x64-v1.4.1.zip)). In this tutorial, I will use `Alex laptop` as my Agent’s name, and select an API key. Next, unzip the Agent package and open the folder in the CMD window. Copy the two commands shown on the wizard and run them one by one. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/2/2574ae98208f938a7db9051b73bb03cc085b4d68.png) After about a minute, the new Test Environment should be added. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/0/03dad8263e1ba2d904dbf5fe9456f7c3a401e540.png) ## Submit the Katalon Studio project to Katalon TestOps CI Click on the “Cloud” button, set the Test Project name, and click **Upload**. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/1/1cf0d0268ddc8082faf295e7b6f5ef7a6b80ec04.png) You can navigate to **Test Projects** in Katalon TestOps CI to see the newly uploaded Test Project. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/a/a48108af460030e928c12d4e91c4eb125714cf48.png) ## Create a Test Plan on Katalon TestOps CI Navigate to **Test Plan** in Katalon TestOps CI and click on the **Create Plan** button. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/6/64d8f580c66212d0d62903e58b60f8c1ec87ec86.png) Next, fill out the information in the wizard. After that, click on the **Create** button. It’s possible to select multiple Test Environments - the workload will be distributed evenly between them. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/0/0d78b646970f92242737dbb585ff6e668cc1bc3f.png) To verify my configuration, click on the **Run** button. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/f/fc37f99a486991daea43804286bfecb129905364.png) ![image](https://europe1.discourse-cdn.com/katalon/original/2X/e/e71474bb36fddc407e4955f0898eb1b7a99e1830.png) Navigate to the detail page of the newly created Job, and it shows that the Agent is running the Job. You can monitor the Job via the logs that are pushed on-the-fly by the Agent. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/c/c292a80ef97269cf633fd170b61e411830db9208.png) The running execution can also be monitored in Katalon TestOps Center. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/9/9fbc104b282944b47b20a413caf277cc7ac65388.png) ## Use Git repository as a Test Project Alternatively, Github repository can be used as a Test Project. Since this is a public Github repository, I will left **Username** and **Password** empty. For private repositories, an account with username and password (or personal access token in case they are hosted on Github) is required. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/4/42d4aee5a667203647664f1daed625eeb4b92c32.png) The wizard to create a Plan will change a bit. Note that `-apiKey` and `-projectPath` are unnecessary since they will be appended by the Agent. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/c/c697c9d74b673cfb46d0d11a5e97fbff6a95503a.png) ## Limit Agent’s capacity based on the number of Katalon Runtime Engine licenses Katalon TestOps provide a way to impose a limit on how many jobs an Agent can run at the same time. Exceeding jobs will not be canceled - they are put into a queue and will be executed when slots are available. **This is a very handy feature. Say, you have two Katalon Runtime Engine licenses. In this case, there is no point running three executions at the same time, since Katalon Runtime Engine will cancel the third session.** ![image](https://europe1.discourse-cdn.com/katalon/original/2X/a/a2ffc05003b1c879878e26d7c04dabdd7839b17f.png) ## Next step You can keep the Agent always running by installing it as a service. > [@How to install Katalon TestOps Agent as a service on Ubuntu](http://forum.katalon.com/t/how-to-install-katalon-testops-agent-as-a-service-on-ubuntu/49793): > > Hi everyone, In this tutorial, I will show you how to install Katalon TestOps Agent as a service on Ubuntu. Running as a service ensures that Katalon TestOps Agent is always running even after the machine is restarted. If you are not familiar with Katalon TestOps Agent, please go through the following tutorial first. Katalon TestOps Agent will help you: Install and manage multiple versions of Katalon Runtime Engine on your test machines without any manual intervention. Retrieve the latest ve… Thank you for all the feedback and suggestions for the features. Happy testing! ---
**Author:** ![puneethm](https://avatars.discourse-cdn.com/v4/letter/p/f07891/32.png) [@puneethm](https://forum.katalon.com/u/puneethm)\ **Post date:** [November 16, 2020, 12:30pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/5 "2020-11-16T12:30:25Z")
Hi Everyone, I created a Katalon TestOps Agent to schedule and remote execution of katalon studio project stored on Git. Able to create the Git Project successfully in Katalon TestOps. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/0/0fa0f8cb135acf8345293c091614deb229dc39e1.png) but Unable to fetch the Test Suite Collection/Test Suite from the Git Project repository. I tried to execute the project using Katalon Command in Test Plan of TestOps which throws the following error. ![image](https://europe1.discourse-cdn.com/katalon/original/2X/2/248bbd8146339a590a40bf4de22c54aa52fecaee.png) Could someone Please help on this ---
**Author:** ![Beo](https://avatars.discourse-cdn.com/v4/letter/b/6de8d8/32.png) [@Beo](https://forum.katalon.com/u/Beo)\ **Post date:** [November 17, 2020, 3:06am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/6 "2020-11-17T03:06:35Z")
Hi @puneethm, Thank you for your feedback. We are working on this issue and will let you know as soon as it’s ready. Cheers, Beo ---
**Author:** ![sonpham](https://avatars.discourse-cdn.com/v4/letter/s/3bc359/32.png) [@sonpham](https://forum.katalon.com/u/sonpham)\ **Post date:** [November 17, 2020, 4:20am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/7 "2020-11-17T04:20:22Z")
Hi @puneethm, Please add or update the `logLevel` property in the `agentconfig` file to `logLevel=ALL` to enable all log levels in the `debug.log`. Then, rerun the plan. Also, if possible, please send us the `app.log` and `errors.log` files in the `log` directory of the Agent’s setup location. Thank you! ---
**Author:** ![puneethm](https://avatars.discourse-cdn.com/v4/letter/p/f07891/32.png) [@puneethm](https://forum.katalon.com/u/puneethm)\ **Post date:** [November 19, 2020, 11:34am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/8 "2020-11-19T11:34:52Z")
> [@sonpham](#): > > logLevel=ALL Hi sonpham, As mentioned, I have added the logLevel=ALL in agentconfig file to enable all log levels in debug.log and tried to execute even then I am getting the same in debug.log ![image](https://europe1.discourse-cdn.com/katalon/original/2X/a/a96baa8f7ba7ff9261cdaf53ee88025e2c1c3f1a.png) app.log and errors.log [app.log](https://forum.katalon.com/uploads/short-url/Agn9a8vqojrwSQzGyv0aI8s0EyP.log) (139.8 KB) [errors.log](https://forum.katalon.com/uploads/short-url/pnaxwDKVzMKrbBI8qbwp1tlXgS2.log) (68.5 KB) Could someone help on this. Thanks in advance. ---
**Author:** ![sonpham](https://avatars.discourse-cdn.com/v4/letter/s/3bc359/32.png) [@sonpham](https://forum.katalon.com/u/sonpham)\ **Post date:** [November 20, 2020, 9:48am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/9 "2020-11-20T09:48:02Z")
Hi @puneethm, It looks like your test project cannot be checked out due to file path length restriction on Windows. Please try enabling long path configuration for Git following this [thread](https://stackoverflow.com/questions/22575662/filename-too-long-in-git-for-windows#:~:text=The%20better%20solution%20is%20enable%20the%20longpath%20parameter%20from%20Git.&text=You%20could%20also%20try%20to,then%20set%20LongPathsEnabled%20to%201). Hope it helps! ---
**Author:** ![puneethm](https://avatars.discourse-cdn.com/v4/letter/p/f07891/32.png) [@puneethm](https://forum.katalon.com/u/puneethm)\ **Post date:** [November 23, 2020, 1:57pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/10 "2020-11-23T13:57:57Z")
Thanks! it worked. ---
**Author:** ![puneethm](https://avatars.discourse-cdn.com/v4/letter/p/f07891/32.png) [@puneethm](https://forum.katalon.com/u/puneethm)\ **Post date:** [November 26, 2020, 12:36pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/11 "2020-11-26T12:36:44Z")
Hi @sonpham Expecting the below features in Katalon TestOps 1. Unable to find the Test Suite collection in TestPlan. While configuring/creating the TestPlan, Option to select the Test Suite collection for git project. If it already exists helps me how to find it. 2. While creating/Configuring a TestPlan in TestOps, In Katalon Command mode-\>Dropdown for Changing the parameters like browserType and executionProfile, so it makes more flexible for selction of parameters or adding new parameters. 3. If we buy katalon license, is perfecto plugin will be accessed? Please help me with the above details. Thanks! ---
**Author:** ![Beo](https://avatars.discourse-cdn.com/v4/letter/b/6de8d8/32.png) [@Beo](https://forum.katalon.com/u/Beo)\ **Post date:** [December 2, 2020, 8:40am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/12 "2020-12-02T08:40:22Z")
Hi @puneethm, Please find below the information on your feature requests. > [@puneethm](#): > > - Unable to find the Test Suite collection in TestPlan. While configuring/creating the TestPlan, Option to select the Test Suite collection for git project. If it already exists helps me how to find it. > - While creating/Configuring a TestPlan in TestOps, In Katalon Command mode-\>Dropdown for Changing the parameters like browserType and executionProfile, so it makes more flexible for selction of parameters or adding new parameters. We are working on these features and they will be available in the next release. > [@puneethm](#): > > If we buy katalon license, is perfecto plugin will be accessed? Yes, you can access all plugins if you purchase the Enterprise package. Hope this helps. ---
**Author:** ![Cedar67](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/cedar67/32/15684_2.png) [@Cedar67](https://forum.katalon.com/u/Cedar67)\ **Post date:** [January 12, 2021, 12:51pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/14 "2021-01-12T12:51:59Z")
Hi team, Can Katalon Testops Agent support Webhook to trigger test execution? For example, push code on GitHub to trigger the automatic execution of test cases on the Katalon Testops CI. Thank you very much! ---
**Author:** ![Thong](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/thong/32/999_2.png) [@Thong](https://forum.katalon.com/u/Thong)\ **Post date:** [January 13, 2021, 2:50am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/15 "2021-01-13T02:50:14Z")
Hi @Cedar67, Thanks for your suggestion, we are working on this item and will release it soon. ---
**Author:** ![Cedar67](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/cedar67/32/15684_2.png) [@Cedar67](https://forum.katalon.com/u/Cedar67)\ **Post date:** [January 14, 2021, 2:46am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/16 "2021-01-14T02:46:05Z")
@Thong Thanks for your reply! We are looking forward to it. ---
**Author:** ![ashraf.madina](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/ashraf.madina/32/20464_2.png) [@ashraf.madina](https://forum.katalon.com/u/ashraf.madina)\ **Post date:** [February 10, 2021, 5:53pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/17 "2021-02-10T17:53:48Z")
is this still supported? This can be done without runtime engine license? I did all the steps above but my test doesn’t run - the execution just has the spinner but nothing happens ---
**Author:** ![Lisa1](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/lisa1/32/16103_2.png) [@Lisa1](https://forum.katalon.com/u/Lisa1)\ **Post date:** [February 12, 2021, 4:39am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/18 "2021-02-12T04:39:06Z")
Hello! I’ve scheduled a test run and I can see it’s failed, but it still has the blue wheel with the message ‘this test run is in progress’. ![image](https://europe1.discourse-cdn.com/katalon/original/3X/d/1/d141d7f4bd6641246a8710998039b9074cac3dd3.png) Can anyone explain why this is happening? I know I can stop it myself, but I don’t understand why it won’t automatically stop by itself. I’m still fairly new to Katalon, so apologies if it’s a simple solution that I may not yet know. 🙂 I’m still on the trial version, if this makes any difference. ---
**Author:** ![devalex88](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/devalex88/32/336_2.png) [@devalex88](https://forum.katalon.com/u/devalex88)\ **Post date:** [February 19, 2021, 9:58am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/19 "2021-02-19T09:58:38Z")
@Lisa1, Thank you for let us know. This is a known issue when the agent encounters an error. We will fix it soon. I’ve checked your Test Run and the error happened because your machine did not have `git` installed. Please install `git` and try again. ---
**Author:** ![devalex88](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/devalex88/32/336_2.png) [@devalex88](https://forum.katalon.com/u/devalex88)\ **Post date:** [February 19, 2021, 9:59am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/20 "2021-02-19T09:59:16Z")
@ashraf.madina KRE license is required for this function. ---
**Author:** ![ashraf.madina](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/ashraf.madina/32/20464_2.png) [@ashraf.madina](https://forum.katalon.com/u/ashraf.madina)\ **Post date:** [February 19, 2021, 5:27pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/21 "2021-02-19T17:27:41Z")
We have KSE, was asking if Runtime engine license was needed…but i don’t think it does. I got mostly thru the instructions here…but the test run does not execute in the laptop that I set as agent. ---
**Author:** ![wolczoskar](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/wolczoskar/32/16812_2.png) [@wolczoskar](https://forum.katalon.com/u/wolczoskar)\ **Post date:** [March 12, 2021, 4:13pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/22 "2021-03-12T16:13:38Z")
Is it possible to choose which profile test suites should be using when running the tests? ---
**Author:** ![ThanhTo](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/thanhto/32/697_2.png) [@ThanhTo](https://forum.katalon.com/u/ThanhTo)\ **Post date:** [March 15, 2021, 8:28am UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/23 "2021-03-15T08:28:59Z")
Yes, you can generate the command line from Katalon Studio which includes an option to specify a profile. > **[Global Variables and Execution Profile](https://docs.katalon.com/katalon-studio/docs/execution-profile-v54.html#use-a-profile)** > > Execution Profile Execution Profile helps cover multiple and different environments to execute your automation test scripts with ease. You can configure the testing environment in terms of data and behaviors... ---
**Author:** ![wolczoskar](https://dub1.discourse-cdn.com/katalon/user_avatar/forum.katalon.com/wolczoskar/32/16812_2.png) [@wolczoskar](https://forum.katalon.com/u/wolczoskar)\ **Post date:** [April 13, 2021, 2:55pm UTC](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031/25 "2021-04-13T14:55:40Z")
Anyone could help with this error ? ![image](https://europe1.discourse-cdn.com/katalon/original/3X/5/b/5bfb6a8d899a95db4d879b8848c9721f35e96ad6.png) Do i need to have Katalon Enteprise license to use the agent? It was working fine a couple days ago [Next page](https://forum.katalon.com/t/how-to-use-katalon-testops-agent-to-schedule-and-remotely-execute-a-katalon-studio-project/45031.md?page=2)