# Appvance IQ Jenkins plugin configuration example

# About Jenkins plugin configuration example

- Information within illustrates how to configure and run scenarios from Jenkins
- Applicable for both Jenkins installed locally as well as in the cloud, such as using Cloudbees-Jenkins
 
## Local Jenkins Install Prerequisites

1. Install Jenkins using [https://jenkins.io](https://jenkins.io)
2. After install, Jenkins automatically launches using port **8080**. To change the port number, locate **Jenkins/jenkins.xml** and modify the -**-httpPort** argument  
    For example: -Xrs -Xmx256m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -jar "%BASE%\\jenkins.war" --httpPort=**8081**
3. Restart Jenkins  
    From a Windows Server machine, go to Server Configuration and select Restart Jenkins Service
4. Install ANT using [http://ant.apache.org/bindownload.cgi](http://ant.apache.org/bindownload.cgi)
5. Open **Jenkins**
6. Click **Manage Jenkins**
7. Click **Configure System**
8. Scroll to **Global Properties**
9. Check **Environment variables**
10. Enter **PATH** in the **Name** box
11. Enter the **Java** and **Antpaths** in the **Value** box as illustrated below  
    ![](https://docs.appvance.net/uploads/images/gallery/2026-07/scaled-1680-/7hCcS5VGE7wkpjUM-31c82bae542b.jpg)
12. Click **Save (Changes)**
 
## Configure Project to Point to Plugin

1. Create a new, or open and existing, Jenkins project
2. Locate **Source Code Management**
3. Options based on Jenkins Plugin location
    1. If hosted by Appvance, select **Git** and enter **https://gitlab.com/Appvance-Public/Jenkins-Plugin.git** in the **Repository URL** box  
        ![](https://docs.appvance.net/uploads/images/gallery/2026-07/scaled-1680-/OFgDDWw1oRccaVKn-d267e6c71746.jpg)  
        NOTE: Please make sure to install git on the machine where Jenkins is installed, once installed please restart Jenkins service.  
        Download git from [https://git-scm.com/downloads](https://git-scm.com/downloads) based on your operation system.
    
    
    1. If self-hosted
        1. Select your source code management provider and enter the URL to your hosted plugin in the **Repository URL** box
 
## Configure Scenario to Run

1. Locate **Invoke Ant** in the **Build** options
2. Enter **run** in the **Targets** box
3. Click **Advanced**
4. Enter **CloudBees/build.xml** in the **Build File** box (may vary if plugin self-hosted)
5. Enter the following in the **Properties** box:  
    ServerURL=<urlToAppvanceUTPServerIncludingPort>  
    Path=REPOSITORY/<pathToScenarioFileIncludingScenarioNameAndFileExtension>  
    Username=<appvanceUserName>  
    Password=<appvancePassword>  
      
    ![](https://docs.appvance.net/uploads/images/gallery/2026-07/scaled-1680-/KtgHLZQu6JDWqsmQ-188a23051f7d.jpg)  
      
    Notice the **Path** value contains **REPOSITORY**. Using the cloud version of Jenkins, users should specify scenarios available from a repository (i.e. SVN or GIT)  
    To run scenarios using local files, Jenkins must be installed on a local machine, after which local paths can be specified in place of REPOSITORY paths using SERVER.
6. Click **Save**
 
## Running a Scenario

Appvance IQ logging, and a URL to further results, appear in **Console Output** as part of the project build logs.

<div id="bkmrk-last-updated%3A-june-2">---

Last updated: <span class="mc-variable General.NewDateTimeVariable variable">June 26, 2023</span>

If you have any feedback on this topic, please contact us at <documentation@appvance.ai>

</div>