Jenkins File Reference for AIQ Integrations

AboutLast reviewed: September 24, 2026

Use this page to explain what the Jenkins files are for when AIQ test execution is triggered or coordinated from a CI pipeline.

What changed in this article

• Clarify which files define build parameters, which call AIQ, and fromwhich wherepublish toor downloadcollect themresults.
• Keep

  Allcustomer-specific job names, tokens, and workspace paths out of the filesshared relateddocumentation.

• Point users to the CICDJenkins job configuration article when they need step-by-step pipeline setup.

Validation workflow

1. Identify the Jenkinsfile or helper script used by the project.
2. Confirm required parameters such as AIQ project, scenario, environment, and result handling.
3. Run the job in a non-production folder before adopting it for scheduled execution.

Review note: Made the article a file-purpose reference instead of a loose Jenkins note, so it fits with the Jenkins integration can be downloaded from the >GITRepo, Please check with an Appvance team member to get access to the Repository.pages.

Following are the files that are available in the folder and what configuration changes need to be made.

Build.xml

Build.xml files hold the configuration settings and also all the defined ANT tags.

Some of the ant tags are explained below:

deps - Downloads the required AppvanceRestClientWithDeps.jar

startNode - Starts the mentioned EC2 instance using the file ec2.creds and controller.json files which holds details about account and instance details.

setupEnvironment - Depending on the parameters, we could use this to set up the environment.

executeScenario - Executes the mentioned scenarios.

stopNode - Stops the instance once the execution is done.

createScenariosDashboard - This tag will create the Scenario Dashboard once execution is complete.

createScenariosDashboard - This tag will create the Scenario Dashboard once execution is complete.

AISG Related Targets

blueprintCreation - Starts the creation of the AISG.

reportUpload - uploads the smoke test report, timing report, and a BlueprintReport.html which is a human-readable report.uploads the smoke test report, timing report, and a BlueprintReport.html which is human-readable report.

blueprintDashboard: this target generates an HTML report that includes the history of all previous build reports and uploads it to an S3 bucket.

checkResult: this target checks the AISG generated report and it will fail the build if the number of failures surpasses a user-defined parameter.

generateRegressionScenario - Generates the Regression scenarios.

Details about all the ant targets can be found in CICD- AntTags.

controller.json File

Basically has details about the controller machine and the credentials. Above can be used when we have the EC2 setup.

When we are running AIQ local builds, instances in the 2nd line could be replaced with "URL" and the full URL of the AIQ controller could be provided.

{"controller": {
"url": "http://<replace_IP>:8080",
"instances": ["<replace_instanceID>"],
"ec2Creds": "ec2.creds",
"timeOut": 180,
"username": "<replace_username>",
"password": "<replace_password>",
"workFolder": "<replace_path/to/AIQ/resources>"
}
}

ec2.creds

ec2.creds will have details of the AWS account: This can be used when we are using AIQ Controller on the EC2 machine and when your tests are run in the AWS cloud.

AWS_ACCESS_KEY_ID=<replace_awsKEYIDE>

AWS_SECRET_ACCESS_KEY=<replace_awsSecretAccessKey>