Jenkins integration

XDM natively integrates into Jenkins with a separate plugin. This section describes how the plugin is obtained and installed into the Jenkins system.

Prerequisites

To install the XDM Jenkins plugin you have to be sure that you run the minimum required Jenkins version. XDM needs Jenkins version 2.440 or higher.

Installation

The XDM Jenkins plugin is part of the XDM installation package. The plugin file is called xdm3-jenkins-plugin.hpi and can be directly installed in Jenkins.

To install the plugin you need to run through the following steps:

  1. In Jenkins, you need to navigate to Jenkins → Manage Jenkins → Manage Plugins

  2. Navigate to the tab Advanced and choose the Browse button in the Upload Plugin section

  3. Select the plugin file xdm3-jenkins-plugin.hpi and upload the plugin. Jenkins will now install the plugin automatically.

Configuration

After the plugin has been installed, it needs to be configured. The configuration specifies the XDM core server that is used to execute tasks. Hence, the URL and the credentials to access the XDM core needs to be configured.

This configuration can be accessed as follows:

  1. In Jenkins, you need to navigate to Jenkins → Manage Jenkins → Configure system

  2. In the section XDM core service configuration you need to specify the following settings:

    HTTP URL

    Specifies the HTTP URL of the XDM-API. This should be the HTTP URL of the web-ui with suffix "/api". The URL must be reachable from the Jenkins build server. The XDM plugin will connect to this server during the build process.

    Web UI URL

    Specifies the Web HTTP URL of the XDM web user interface. The URL must be reachable from the Jenkins build server. The XDM plugin will provide a link to the XDM execution in the log of the Jenkins job executions. This link points directly to the execution of the started task or workflow in the XDM web user interface.

The URL should be the URL specified in the users browser.
User

Specifies the user that accesses the XDM core server. This user is used to read the task definition and to execute the task during the build process. Hence, the user needs access to all objects that are related to the executable task.

Password

The password of the specified user.

After all the above settings have been specified you can use the Test connection button to verify your settings. XDM will try to establish a connection to the specified XDM core server and will verify the user/password setting.

If everything is configured correctly the test connection will succeed. Otherwise, you should double-check your settings and check if the XDM core service is running.

You can now use the plugin in your builds by adding a build step Run XDM task, Run XDM task template, Run XDM workflow or Run XDM workflow template.