Skip to main content
Support
Corporate logotype
    Corporate logotype
    • Welcome to Zephyr Enterprise
      • Zephyr Enterprise
        • What's New in Zephyr Enterprise Release 8.4.0
          • 8.3.0 Release Notes
            • 8.2.0 Release Notes
            • 8.1.0 Release Notes
            • 8.0.1 Release Notes
            • 7.21.1 Release Notes
            • Version History
            • Zephyr Installation and Upgrade Guides
              • Zephyr System Requirements
                • Zephyr Supported Platforms
                  • Zephyr Usage Requirements
                    • Zephyr Cloud Requirements
                      • Zephyr Server Requirements
                        • Zephyr Data Center Requirements
                        • Zephyr Enterprise Trial
                          • Zephyr Trial Installation for Window
                            • Installation of Zephyr Enterprise Trial via Docker
                              • Docker Trial Troubleshooting
                              • Zephyr On-Premise Production Installation
                                • Zephyr Production Installation for Windows
                                  • Zephyr Production Installation for Linux
                                    • Set Up Zephyr Data Center Cluster
                                      • 1. Connect to an External Database
                                        • 2. Install and Configure Elasticsearch
                                          • Install Zephyr Enterprise on Nodes
                                            • On Windows
                                              • On Linux
                                              • 4. Set Up a Shared Directory
                                                • 5. Configure Load Balancer
                                                  • 6. Bring Up the Whole System
                                                    • Further Steps
                                                    • Connecting to an External Database
                                                      • MySQL
                                                        • Microsoft SQL
                                                          • Oracle
                                                            • Steps to Follow to Change the Database Password
                                                          • Elastic Search
                                                            • Elasticsearch 8.6.2
                                                              • Elasticsearch Single Node - On Windows
                                                                • Elasticsearch Single Node - On Linux
                                                                  • Elasticsearch Cluster
                                                                    • Additional Information - ES 8.6.2
                                                                  • JDBC.Properties File Field
                                                                    • Zephyr Enterprise Services
                                                                      • ZE Services with RabbitMQ
                                                                        • ZE - Webhook Deployment
                                                                          • ZE-Consumer Deployment
                                                                            • ZE-AuditService Deployment
                                                                              • ZE-AuditProcessor Deployment
                                                                              • RabbitMQ Deployment
                                                                                • RabbitMQ and ZE Service Usage and Requirement
                                                                                  • RabbitMQ Deployment (Ubuntu)
                                                                                    • RabbitMQ Deployment (RHEL)
                                                                                      • RabbitMQ Deployment (Windows)
                                                                                    • ZE Services with Artemis
                                                                                      • Artemis Cluster Setup
                                                                                        • ZE - Webhook Deployment (Artemis)
                                                                                          • ZE - Consumer Deployment (Artemis)
                                                                                            • ZE - Audit Service Deployment (Artemis)
                                                                                              • ZE - Audit Processor Deployment (Artemis)
                                                                                          • Upgrade Zephyr Enterprise
                                                                                            • Zephyr On-Premise Upgrade Instructions
                                                                                              • Upgrade Embedded MYSQL 5.7 to MYSQL 8.0.41
                                                                                                • Steps to change the JDBC Driver
                                                                                                  • Take Database Backup
                                                                                                  • Zephyr On-Premise Rollback Process
                                                                                                    • Special SSL Consideration
                                                                                                    • Change Ownership to Non-Root User
                                                                                                      • Upgrading Data Center
                                                                                                        • Upgrade Steps on Windows
                                                                                                          • Upgrade Steps on Linux for Root to Root User
                                                                                                            • Upgrade Steps for Linux from Root to Non-root User
                                                                                                          • Post-upgrade Steps for Zephyr SaaS/Cloud
                                                                                                            • Upgrading from Version 8.0.1 and Below to the Latest Version
                                                                                                            • Enabling Jira sync for a Closed Release
                                                                                                          • Troubleshoot
                                                                                                        • Zephyr Administration Guides
                                                                                                          • System Setup
                                                                                                            • System Config
                                                                                                              • SSL Setup in Zephyr
                                                                                                                • Integrate JIRA SSO with Zephyr OAuth
                                                                                                                  • Email Notifications
                                                                                                                    • About Zephyr
                                                                                                                      • Login Limit
                                                                                                                        • Support ZIP File
                                                                                                                      • Authentication
                                                                                                                        • Setting Up Single Sign-On (SSO) with AWS
                                                                                                                        • SSO Setup with Okta in Zephyr
                                                                                                                          • Okta LDAP Configuration
                                                                                                                            • SSO Setup with Azure AD in Zephyr
                                                                                                                              • SSO Setup with Auth0
                                                                                                                                • SSO Setup with Google (G-Suite)
                                                                                                                                  • SSO Setup with Active Directory - ADFS
                                                                                                                                  • Jira Integration
                                                                                                                                    • Setting up Jira Integration
                                                                                                                                      • Increase the OAuth 2.0 Token Expiry Time
                                                                                                                                      • Configure OAuth 2.0 Connection for Jira Cloud
                                                                                                                                        • Configure OAuth Connection
                                                                                                                                          • Configure Basic (cookie-based) Connection
                                                                                                                                            • Creating Jira Webhooks
                                                                                                                                              • Using Jira Webhooks
                                                                                                                                              • Connection Between Server and Cloud Instances
                                                                                                                                                • Configure OAuth 2.0 Connection for Jira Data Center (DC)
                                                                                                                                                  • Jira Integration SSL Troubleshooting
                                                                                                                                                • Caching Jira Data
                                                                                                                                                  • Jira Management Preferences
                                                                                                                                                    • Migrating From Jira Server to Jira Cloud
                                                                                                                                                      • Jira Integration: Zephyr Enterprise
                                                                                                                                                        • Jira Troubleshooting
                                                                                                                                                      • Customizations
                                                                                                                                                        • Customize Roles
                                                                                                                                                          • Customize Project Fields
                                                                                                                                                            • Customize Requirement Fields
                                                                                                                                                              • Customize Testcase Fields
                                                                                                                                                                • Customize Testcase Estimated Time
                                                                                                                                                                  • Customize Testcase and Test Step Execution Status
                                                                                                                                                                    • Customize Test Repo Configuration
                                                                                                                                                                      • Customize Bulk Status Update
                                                                                                                                                                        • Customize Test Case Priority Field
                                                                                                                                                                          • Customize Trend Data Collection
                                                                                                                                                                            • Indexing Process
                                                                                                                                                                              • Advanced
                                                                                                                                                                                • Customize Gadget Refresh Rate
                                                                                                                                                                                • External Storage
                                                                                                                                                                                • User Setup
                                                                                                                                                                                  • Delete Disable User's
                                                                                                                                                                                  • Adding a User
                                                                                                                                                                                    • Editing a User
                                                                                                                                                                                      • Enabling and Disabling Users
                                                                                                                                                                                        • Exporting a List of Users
                                                                                                                                                                                          • Reset User Password
                                                                                                                                                                                            • Change an Account Password
                                                                                                                                                                                              • Project assigned Via Group
                                                                                                                                                                                            • Group Setup
                                                                                                                                                                                              • Adding a Group
                                                                                                                                                                                                • Editing a Group
                                                                                                                                                                                                  • Delete a Group
                                                                                                                                                                                                    • Import Groups
                                                                                                                                                                                                    • Project Setup
                                                                                                                                                                                                      • Adding a Project
                                                                                                                                                                                                        • Editing a Project
                                                                                                                                                                                                          • Deleting a Project
                                                                                                                                                                                                            • Project Test Repository Backup and Restore
                                                                                                                                                                                                            • Defect Admin
                                                                                                                                                                                                              • Zephyr Defect Tracking Customizations
                                                                                                                                                                                                                • Groups and Permissions
                                                                                                                                                                                                                  • Projects
                                                                                                                                                                                                                    • Workflow
                                                                                                                                                                                                                      • Zephyr Internal Preferences
                                                                                                                                                                                                                        • Customization
                                                                                                                                                                                                                        • JIRA Defect Tracking Customizations
                                                                                                                                                                                                                        • Zephyr Server/Data Center Backups and Restore
                                                                                                                                                                                                                          • Zephyr Cloud Backups and Restore
                                                                                                                                                                                                                            • Zephyr Audit Logs
                                                                                                                                                                                                                            • Zephyr User Guide
                                                                                                                                                                                                                              • Release Setup
                                                                                                                                                                                                                                • Adding a Release
                                                                                                                                                                                                                                  • Editing a Release
                                                                                                                                                                                                                                    • Deleting a Release
                                                                                                                                                                                                                                      • Cloning a Release
                                                                                                                                                                                                                                        • Mapping Requirements to a Test Case
                                                                                                                                                                                                                                        • Requirements
                                                                                                                                                                                                                                          • Project and Release Requirement Repository
                                                                                                                                                                                                                                            • Adding a Folder in Requirements
                                                                                                                                                                                                                                              • Adding a Requirement
                                                                                                                                                                                                                                                • Editing a Requirement
                                                                                                                                                                                                                                                  • Cloning a Requirement
                                                                                                                                                                                                                                                    • Deleting a Requirement
                                                                                                                                                                                                                                                      • Mapping Requirements to a Test Case
                                                                                                                                                                                                                                                        • Allocating and Deallocating a Requirement
                                                                                                                                                                                                                                                          • Importing Requirements
                                                                                                                                                                                                                                                            • Import Requirements via Excel Spreadsheets
                                                                                                                                                                                                                                                              • Import Requirements From Jira
                                                                                                                                                                                                                                                              • Exporting Requirements
                                                                                                                                                                                                                                                                • Jira Requirements Sync
                                                                                                                                                                                                                                                                  • Requirements Traceability
                                                                                                                                                                                                                                                                  • Test Repository
                                                                                                                                                                                                                                                                    • Global Test Repository Overview
                                                                                                                                                                                                                                                                      • Move Ownership of Test Case from Test Repository to Global Repository
                                                                                                                                                                                                                                                                      • Project and Release Test Case Repository
                                                                                                                                                                                                                                                                        • Adding a Folder in Test Repository
                                                                                                                                                                                                                                                                          • Adding a Test Case
                                                                                                                                                                                                                                                                            • About Adding an Attachment
                                                                                                                                                                                                                                                                            • Editing a Test Case
                                                                                                                                                                                                                                                                              • Test Step Copying and Deleting
                                                                                                                                                                                                                                                                                • Test Case Versioning
                                                                                                                                                                                                                                                                                  • Bulk Edit Test Cases
                                                                                                                                                                                                                                                                                  • Cloning a Test Case
                                                                                                                                                                                                                                                                                    • Deleting a Test Case
                                                                                                                                                                                                                                                                                      • Mapping Test Cases to a Requirement
                                                                                                                                                                                                                                                                                        • Tracking Automation
                                                                                                                                                                                                                                                                                          • Importing Test Cases
                                                                                                                                                                                                                                                                                            • Auto-Creating Directory Structure when Importing Test Cases
                                                                                                                                                                                                                                                                                            • Exporting Test Cases
                                                                                                                                                                                                                                                                                              • Test Case Usage History
                                                                                                                                                                                                                                                                                                • Test Case Reordering
                                                                                                                                                                                                                                                                                                  • Copying Test Cases
                                                                                                                                                                                                                                                                                                    • Sharing Test Cases
                                                                                                                                                                                                                                                                                                      • Call to Test
                                                                                                                                                                                                                                                                                                        • Parametrization and Data Set
                                                                                                                                                                                                                                                                                                        • Test Planning
                                                                                                                                                                                                                                                                                                          • Managing Cycles
                                                                                                                                                                                                                                                                                                            • Managing Phases
                                                                                                                                                                                                                                                                                                              • Assigning Test Cases to Users
                                                                                                                                                                                                                                                                                                                • Adding and Deleting Test Cases in a Test Phase
                                                                                                                                                                                                                                                                                                                  • Synchronization of Test Cases in Planning
                                                                                                                                                                                                                                                                                                                  • Hiding and Unhiding Test Cycles
                                                                                                                                                                                                                                                                                                                    • Copy and Move Test Cycle Folders
                                                                                                                                                                                                                                                                                                                    • Test Execution
                                                                                                                                                                                                                                                                                                                      • Executing Manual Test Cases
                                                                                                                                                                                                                                                                                                                        • Logging Test Run Results
                                                                                                                                                                                                                                                                                                                        • Executing Automated Test Cases
                                                                                                                                                                                                                                                                                                                          • Linking Defects
                                                                                                                                                                                                                                                                                                                            • Sync Test Case Versions
                                                                                                                                                                                                                                                                                                                              • Test Case Execution History
                                                                                                                                                                                                                                                                                                                                • Exporting Test Executions
                                                                                                                                                                                                                                                                                                                                  • Editing Test Cases During Test Execution
                                                                                                                                                                                                                                                                                                                                  • Defect Tracking
                                                                                                                                                                                                                                                                                                                                    • Creating Defects
                                                                                                                                                                                                                                                                                                                                      • Searching for Defects
                                                                                                                                                                                                                                                                                                                                        • Editing Defects
                                                                                                                                                                                                                                                                                                                                          • Creating Sub-Tasks
                                                                                                                                                                                                                                                                                                                                            • Exporting Defects
                                                                                                                                                                                                                                                                                                                                              • Supported Jira Custom Fields
                                                                                                                                                                                                                                                                                                                                              • Reporting and Dashboards
                                                                                                                                                                                                                                                                                                                                                • Zephyr Dashboards
                                                                                                                                                                                                                                                                                                                                                  • Managing Dashboards
                                                                                                                                                                                                                                                                                                                                                    • Gadgets
                                                                                                                                                                                                                                                                                                                                                    • Reports
                                                                                                                                                                                                                                                                                                                                                      • Custom Export Report Wizard
                                                                                                                                                                                                                                                                                                                                                      • Search
                                                                                                                                                                                                                                                                                                                                                        • Global Sorting
                                                                                                                                                                                                                                                                                                                                                          • Zephyr Test Automation
                                                                                                                                                                                                                                                                                                                                                            • Zephyr Vortex
                                                                                                                                                                                                                                                                                                                                                              • Script Automation
                                                                                                                                                                                                                                                                                                                                                                • Suite Automation
                                                                                                                                                                                                                                                                                                                                                                  • Folder Watcher
                                                                                                                                                                                                                                                                                                                                                                    • Vortex Job Execution Events
                                                                                                                                                                                                                                                                                                                                                                    • API Operations for Automation Jobs
                                                                                                                                                                                                                                                                                                                                                                      • ZBot Overview
                                                                                                                                                                                                                                                                                                                                                                        • Installing and Getting Started with ZBots
                                                                                                                                                                                                                                                                                                                                                                        • Integration with TestComplete
                                                                                                                                                                                                                                                                                                                                                                          • Integration with ReadyAPI
                                                                                                                                                                                                                                                                                                                                                                            • Robot Framework Integration
                                                                                                                                                                                                                                                                                                                                                                              • NUnit Framework Integration
                                                                                                                                                                                                                                                                                                                                                                                • Parser Templates
                                                                                                                                                                                                                                                                                                                                                                                  • Create, Edit and Delete Templates
                                                                                                                                                                                                                                                                                                                                                                                    • Create Parser Templates
                                                                                                                                                                                                                                                                                                                                                                                      • Get List of Available Parser Templates
                                                                                                                                                                                                                                                                                                                                                                                        • Edit Parser Templates
                                                                                                                                                                                                                                                                                                                                                                                          • Delete Parser Templates
                                                                                                                                                                                                                                                                                                                                                                                          • Parser Template Syntax
                                                                                                                                                                                                                                                                                                                                                                                        • Zephyr Enterprise Jira Plugin
                                                                                                                                                                                                                                                                                                                                                                                          • Zephyr Enterprise Traceability
                                                                                                                                                                                                                                                                                                                                                                                            • Zephyr Enterprise Feature Content
                                                                                                                                                                                                                                                                                                                                                                                            • FAQ
                                                                                                                                                                                                                                                                                                                                                                                            • Zephyr REST API
                                                                                                                                                                                                                                                                                                                                                                                              • Create and Manage API Tokens in Zephyr
                                                                                                                                                                                                                                                                                                                                                                                                • Update Testcase API
                                                                                                                                                                                                                                                                                                                                                                                                  • Search API
                                                                                                                                                                                                                                                                                                                                                                                                    • Import & Synchronize LDAP/Crowd Groups
                                                                                                                                                                                                                                                                                                                                                                                                  • Migrating to Zephyr Enterprise
                                                                                                                                                                                                                                                                                                                                                                                                    • From HP ALM
                                                                                                                                                                                                                                                                                                                                                                                                      • Planning
                                                                                                                                                                                                                                                                                                                                                                                                        • Key Points
                                                                                                                                                                                                                                                                                                                                                                                                        • Preliminary Steps
                                                                                                                                                                                                                                                                                                                                                                                                          • Migration Steps
                                                                                                                                                                                                                                                                                                                                                                                                            • Migrate a Single Project
                                                                                                                                                                                                                                                                                                                                                                                                              • Migrate Multiple Projects in Parallel
                                                                                                                                                                                                                                                                                                                                                                                                                • 1. Migrate HP ALM Users
                                                                                                                                                                                                                                                                                                                                                                                                                  • 2. Migrate Projects
                                                                                                                                                                                                                                                                                                                                                                                                                • Post-Migration Steps
                                                                                                                                                                                                                                                                                                                                                                                                                  • FAQ
                                                                                                                                                                                                                                                                                                                                                                                                                  • Via REST API
                                                                                                                                                                                                                                                                                                                                                                                                                    • Create a Role
                                                                                                                                                                                                                                                                                                                                                                                                                      • Create a User
                                                                                                                                                                                                                                                                                                                                                                                                                        • Create a Project
                                                                                                                                                                                                                                                                                                                                                                                                                          • Create a Custom Field
                                                                                                                                                                                                                                                                                                                                                                                                                            • Create a Release
                                                                                                                                                                                                                                                                                                                                                                                                                              • Create a Test Case Tree
                                                                                                                                                                                                                                                                                                                                                                                                                                • Add an Attachment
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Test Planning (cycles and phases)
                                                                                                                                                                                                                                                                                                                                                                                                                                    • Execute the Test Case
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Create Requirements
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Access Tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Import the Test Case
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Via Excel Spreadsheets
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Zephyr Enterprise Product Development and Process and Roadmap
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Log In to SmartBear Community Portal
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Zephyr End-of-Life Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                            • Developer Zone
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Zephyr Enterprise Test Management Add-on for Bamboo
                                                                                                                                                                                                                                                                                                                                                                                                                                                • Bamboo Add-on Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Add Zephyr Servers in Bamboo
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Configure Zephyr Add-On
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Publish Results to Zephyr
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Zephyr Enterprise Test Management Plugin for Jenkins
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Support and Troubleshooting
                                                                                                                                                                                                                                                                                                                                                                                                                                                    print
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Prev
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Next
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Zephyr Enterprise Documentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Zephyr Enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Zephyr Administration Guides

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Zephyr Administration Guides

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • System Setup

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • User Setup

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Group Setup

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Project Setup

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Defect Admin

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Zephyr Server/Data Center Backups and Restore

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Zephyr Cloud Backups and Restore

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Zephyr Audit Logs

                                                                                                                                                                                                                                                                                                                                                                                                                                                    In this section:
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Zephyr Administration Guides

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search results

                                                                                                                                                                                                                                                                                                                                                                                                                                                      No results found

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Prev
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Next
                                                                                                                                                                                                                                                                                                                                                                                                                                                      © 2025
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Publication date:

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Contact us

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • USA +1 617-684-2600
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • EUR +353 91 398300
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AUS +61 391929960

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Company

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • About
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Careers
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Contact Us
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Newsroom
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Partners
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Responsibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Resources

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Academy
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Community
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Resource Center
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Support

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Products

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • API Hub
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Insight Hub
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • TestComplete
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ReadyAPI
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Zephyr Enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • View All Products

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Legal

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Privacy
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Security
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Terms of Use
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Website Terms of Use
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Facebook Instagram Linkedin X YouTube

                                                                                                                                                                                                                                                                                                                                                                                                                                                      © 2025 SmartBear Software. All Rights Reserved.