Skip to Content

Jenkins connection

Introduction

A Jenkins connection, created using the Jenkins connector, establishes access to Jenkins. Once a connection is configured, you can create instances of Jenkins activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Note

This connector supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Host or Username in this connection requires users to re-enter the API Token for the connection.

Create or edit a Jenkins connection

A new Jenkins connection is created using the Jenkins connector from one of these locations:

An existing Jenkins connection can be edited from these locations:

Configure a Jenkins connection

Each user interface element of the Jenkins connection configuration screen is described below.

Jenkins connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each Jenkins connection and must not contain forward slashes / or colons :. This name is also used to identify the Jenkins endpoint, which refers to both a specific connection and its activities.

  • Host: Enter the host for the Jenkins instance. This can be found in the Jenkins dashboard by navigating to Jenkins > Manage Jenkins > Configure System. The host name is provided under Jenkins Location.

  • Username: Enter the username for the Jenkins instance.

  • API Token: Enter the API token for the Jenkins instance.

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Jenkins connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Stop Job: Stops a job in a Jenkins automation server and is intended to be used as a target in an operation.

  • Start Job: Starts a job in a Jenkins automation server and is intended to be used as a target in an operation.

  • Delete Job: Deletes a job from a Jenkins automation server and is intended to be used as a target in an operation.

  • Get Job: Retrieves a job from a Jenkins automation server and is intended to be used as a source in an operation.