---
tags: English
---
# SideeX Plugin for Jenkins
## Step 1 - Install [SideeX WebService](https://hackmd.io/@sideex/book/%2F%40sideex%2Fwebservice)

## Step 2 - Install SideeX Plugin for Jenkins
1. Start Jenkins and click `Manage Jenkins`
2. Click `Manage Plugins`
3. Click `Available` -> `Filter` and search for `SideeX`

## Step 3 - Create a Testing Job
1. Click `New Item`
2. enter the item's name, then choose `Freestyle project` and click `ok`

3. Click `Build` -> `Add build step` -> `Execute SideeX Web Testing` to create a `SideeX Web Testing`
4. Input the fields of `Execute SideeX Web Testing`

- `Protocol`: Select the protocol type for connecting the SideeX WebServer server
- For the type `HTTPS (Enable certificate checking)`, the field `Certificate file path` should be set to the path to the file [cert.pem](https://hackmd.io/@sideex/webservice#Appendix-A---SideeX-WebService-Config-File-Format).
- `SideeX WebService base URL`: The URL to the SideeX WebService server, that is, the value of the attribute `webservice`.`publicURL` defined in [serverconfig.json](https://hackmd.io/@sideex/webservice#Appendix-A---SideeX-WebService-Config-File-Format).
- `Checking report periodically every (ms)`: The time interval in which the WebService will be checked if it has completed the test execution, e.g. 2000 milliseconds.
- `Test case file path`：Path to the test case file. The internal stucture of the file is defined in [SideeX WebService - Step4](https://hackmd.io/@sideex/book/%2F%40sideex%2Fwebservice#Step-4---Prepare-a-test-case-zip-file).
- Case 1: The test case file/folder is put on the Jenkins server
- If the test case file is a zip file, the field should be the absolute or relative path to the file, e.g., `<some dir>/testcase.zip`.
- If the test case is a folder (not zipped yet), the file should be the absolute or relative path to the folder, e.g., `<some dir>/testcasedir`.
- Case 2: The test case file/folder is pushed to `git`
- If the test case file is a zip file, the field should be the local location of the file pulled from `git`. For example, if the file is pulled by Jenkins, the field should be `./testcase.zip`.
- If the test case is a folder (not zipped yet), the field should be the local location of the folder pulled from `git`. For example, if the folder is pulled by Jenkins, the field should be `./testcasedir`.

## Step 4. Run Build and Watch the Report.
1. Click `Save` -> `Build Now`

2. Click Console Output

3. View the current status of the execution

4. After running the job, click `Back to Project` and select `SideeX View Report`

5. View the test report