Jenkins plugin

The Jenkins plugin enables you to submit Jenkins jobs and check build results from Deployment Automation.

Jenkins is an application that monitors executions of repeated jobs, such as building and testing software projects continuously and monitoring executions of externally-run jobs.

To use the available steps, open the process designer and select Integration > Jenkins in the Tools pane.

Note: The Jenkins plugin is different from the Jenkins source configuration type. Source configuration types are special integrations for importing component versions into Deployment Automation. For details, see Source configuration types.

For information about Jenkins, see https://www.jenkins.io.

Jenkins Get Build Changes step

This step returns build changes in the result.build.changes output property.

The following table describes the step's properties:

Property Description
Job name The job name for which build changes should be returned.
Server Url The URL where Jenkins is installed, for example, http://host:8080/jenkins.
Build number (Optional) The build number for which build changes should be returned. If empty, the last build will be used.
Username (Optional) The user name that has permission to run the job.
Password (Optional) The password of the user with permission to run the job.

Back to top

Jenkins Get Build Status step

This step returns the result of a build in the result.build.changes output property.

The following table describes the step's properties:

Property Description
Job name

The job name for which the build result should be returned.

Server Url The URL where Jenkins is installed, for example: http://host:8080/jenkins.
Build number (Optional) The build number for which the result should be returned. If empty, the last build will be used.
Username (Optional) The user name that has permission to run the job.
Password (Optional) The password of the user with permission to run the job.

Back to top

Jenkins Submit Job step

Use this step to submit a Jenkins job with the provided parameters. The job can run in synchronous (waiting for job result) or asynchronous mode.

The following table describes the step's properties:

Property Description
Job name The name of the job to run.
Server Url The URL where Jenkins is installed, for example, http://host:8080/jenkins.
Parameters (Optional) Job parameters. Enter each parameter on a new line in the following format:

name=value
File Parameters (Optional) Files to use as job parameters. Enter each file parameter on a new line in the following format:

parameterName=C:/filePath.txt
Username (Optional) The user name that has permission to run the job.
Password (Optional) The password of the user with permission to run the job.
Wait for result (Optional) Use this option if the step should wait for the job results. By default, this option is selected.
Waiting timeout (Optional) The time in seconds that the step will wait for a job completion message before failing. Empty or negative values mean infinite waiting.

Back to top

See also: