Set up MBT

This topic describes the tasks for initially setting up MBT.


Before you begin, make sure you have the following:

  1. An MBT tenant.

  2. Space & Workspace admin rights to the above tenant.

Back to top

Step 1: Set up a Git repository

Set up a Git repository to store your UFT One scripts. This can be any Git-compliant system, whether on-premises or in the cloud.

Note: The following images show, but these concepts apply to any Git repository.

  1. The ADM Jenkins plugin requires that the Git default branch be named master. To verify, open the menu on the top level:

  2. If your default branch is main, change it to master using the following instructions:

  3. Upload your UFT One scripts to Git. They can reside in any directory level below master.

    For example, here we first created a directory called My MBT Test, and then uploaded two scripts.

Back to top

Step 2: Create an API key

To secure the connection between Jenkins and MBT you must generate a dedicated API Key.

Note: For more details, see API access. You generate the key for CI/CD Integration, and the user performing this operation must have Space Admin rights.

  1. In the Settings menu, select Spaces.

  2. Click on the space at the top of the list to open the Space Admin screen, and select the API ACCESS tab.

  3. Add a new API access. Provide a meaningful name, select the CI/CD integration role, and select one or more workspaces for this key.

  4. The newly generated key will appear.

    Note that for security reasons the key will never be presented again, so you must save it for future use.

Step 3: Configure the Jenkins plugin

In order for Jenkins to work with MBT, you need to install and configure the Application Automation Tools plugin.

  1. In Jenkins, download & install the latest plugin release. For details, see Application Automation Tools plugin.

  2. After you install the plugin and reboot Jenkins, open Manage Jenkins > Configure system. Scroll down until you see the ALM Octane CI section and add a new ALM Octane server:

    • Location is the full URL presented to you when you access MBT.

    • Client ID is taken from the API Key.

    • Client Secret is taken from the API Key.

    • Jenkins User is the Jenkins user that will run the MBT jobs.

  3. Click Test Connection to make sure Jenkins connects with MBT.

Back to top

Step 4: Configure MBT to get started

To complete the setup, you need to set up Jenkins connectivity from the MBT side, and define an MBT runner and release.

  1. In the Settings menu, select Spaces.

  2. Choose the relevant workspace and select the DevOps tab. From the CI Servers section, add a new CI server.

  3. Assign a meaningful name to the new CI server, and choose your Jenkins server from the dropdown list.

    Note: If your Jenkins server does not appear on this list, either the Jenkins side is not defined correctly (Test Connection on Jenkins has failed), or that this Jenkins server is already used by another MBT CI Server setup.

    The next step is to define the MBT Runner. This will tie the Jenkins server with the Git repository, generate the Git auto-discovery (mirroring) jobs, and define and launch MBT tests on the Jenkins server.

  4. In the DevOps tab, select the Test Runners section and add a new test runner.

  5. Define the following:

    • Name. Enter a meaningful name for this runner.

    • Framework. Select MBT.

    • CI server. Choose the name of the CI server you just defined.

    • Repository. Enter the URL for your Git repository.

    • Username and Password. Enter the credentials needed to connect to Git (read-only access).

    Use Test Connection to validate that all settings are correct.

    Note that in Github, you can find the repository URL here:

  6. In the Releases tab, make sure there is at least one release defined.

    Its details are not important, as MBT simply requires each test run to be associated with a release.

Back to top

See also: