Adding Zephyr Servers in Bamboo global settings

After installation, configure Bamboo global settings to establish connection with Zephyr Server(s). Follow the below steps:

1. Launch Bamboo and access it via a web browser
2. Click on "Overview" from the Bamboo administration menu as illustrated in the below screenshotImage Removed
3. Locate and click "Zephyr Server Configuration" from the left side panel under "Add-ons" section
   Image Removed
4. Click "Add New Zephyr Server" button. You can add more than one Zephyr Server through this method
   1. Enter Zephyr Server URL and user credentials. Note that the user credentials must be that of Zephyr "Test Manager" or "Test Lead". Click on "Test Configuration" to validate connection to Zephyr Server.                                                  Image Removed
   2. Please wait while Bamboo is validating Zephyr Server and credentials                                                                                                                                                               Image Removed
   3. Bamboo will display the validation success message upon successful test. Click the "Save" button to save the configuration changes made.                                   Image RemovedImage Removed
   4. Zephyr Server configurations are now saved                                          Image Removed

 After you have installed the Zephyr add-on for Bamboo, you need to add your Zephyr Enterprise server in Bamboo settings. You can add one or more Zephyr servers.

Anchor
token token

1. Generate Zephyr API Token for Bamboo

Bamboo add-on needs a Zephyr API token in order to connect to your Zephyr Enterprise instance. The API token must be generated in the account of the Test Manager or Test Lead.

1. Log in to Zephyr Enterprise as the Test Manager or Test Lead.
2. In the header, click the username and select API Token.
3. Click Create API Token.
4. Enter Bamboo as the label and click Create.
5. Click Copy to Clipboard to copy the generated token. You will not be able to see it later.

You will need to specify this token later in Bamboo settings.

2. Add your Zephyr Server in Bamboo settings

1. In Bamboo, go to Image Added > Overview.
   
   Image Added
   
   
2. In the sidebar, under Manage Apps, click Zephyr Server Configuration.
   
   Image Added
   
   
3. Click Add New Zephyr Server.
   
   Image Added
   
   
4. Specify your Zephyr Enterprise server information:
   
   
   • URL - https://<subdomain>.yourzephyr.com if you use Zephyr Enterprise Cloud, or https(s)://<zephyr_host>:<port> if you use an On-Premise installation.
     
     
   • Authentication method - Basic or Token.
     
     • Token is the recommended method and is supported for Zephyr Enterprise 6.6 and later.
     • If your Zephyr server uses single sign-on, you MUST use Token.
     • Basic should only be used with older Zephyr Enterprise instances (up to v. 6.5.2) that use internal authentication.
       
       
   • If you use Token authentication, enter the token you have generated earlier. Optionally specify a description for this token.
     Image Added
     
     
   • If you use Basic authentication, enter the username and password of the Test Manager or Test Lead user.
     Image Added
     
     
5. Click TestConfig to check the connection to your Zephyr server using the provided credentials.
   Please wait until the test has completed.
   
   Image Added
   
   Image Added
    
6. After a successful test, click Save.
7. The added Zephyr server appears in the list:
   
   Image Added

If you need to integrate Bamboo with several Zephyr Enterprise instances, repeat the steps to add your other Zephyr servers.