• Welcome to the Codebeamer Help Center
• User's Guide
  • About the User's Guide
    • Codebeamer Overview
    • About this Guide
    • Codebeamer: Common Concepts
      • User Accounts and Logging In to Codebeamer
        • User Preferences
          • Open Links in New Browser Tab
      • Codebeamer User Interface
      • My Start
        • My Wiki
        • My Account
        • My Items
        • My Starred
      • Basics: Projects, Roles, Groups, Members and Users
        • Access control
      • For Your Reference
        • Email Delivery Customization
        • Star It function
        • Logging out of Codebeamer
      • Managing Projects
        • Project Browser
        • Cards on Project Browser
        • Managing Project Categories
        • Managing Project Category Views
        • Managing Project Members
        • Creating a New Project
        • Project Wiki
        • Administering Projects
          • Adding Members To a Project
          • Adding a New Group
        • Building Communities Around Your Projects
        • Project Groups
        • Bi-directional Synchronization Between Atlassian JIRA© and Codebeamer
        • Project Import and Export Restrictions
          • Export Project Configuration File as Project Template
        • Project Configuration Merge and Staging
          • Prepare and Deploy Project Configuration
          • Download Project Mapping File
          • Automate Project Configuration Deployment using Swagger API
        • Project Configuration Deployment Across Codebeamer Instances
          • Project Configuration Deployment - Technical Details
          • Template Trackers in Project Deployment
          • Project Deployment via Swagger API
      • Wiki
        • Wiki as a Framework - Combine Content using Plugins
        • Embedding Reports into Wiki Pages
        • Project and Key Fields
        • Collaborative Section Review
          • Creating a Section Review
          • Adding Comments
          • Ending a Section Review
          • Hiding Section Reviews
        • Wiki User Interface
          • Wiki Content Pane
          • Structure Tree Section
        • Editing in the Wiki
        • Wiki Page Properties
        • Dashboard
          • Widgets
            • Widget Types
              • Report Visualization
              • Project
              • Agile
              • Test
              • Personal
              • Others
          • Widget Development Documentation
          • Dashboards: for Projects, for Teams, for Personal Use
          • External Widget Development
            • Diagrams
            • Show or hide external widgets with enabled property
            • Getting Started with External Widgets
              • TypeScript Support
            • External Widget API Reference
        • Diagram Editor
          • Inserting Diagrams
        • Editing Wiki Pages with Microsoft Word
          • Froala Editor Limitations, Feature Requests and Bugs
          • Using Pictures in Edit via Office
        • Wiki Markup and Plugins
          • LaTex Plugin
          • Math plugin
      • Document Manager
        • Office Editing Documents
        • Versioning and Access History
        • Document Tracker Configurations
          • Configuring the Lock Function
          • Requiring Notes before Checking in
          • Publish Documents to Another Tracker
          • Enabling the Document Tracker before Codebeamer 22.10-LTS (GINA) Version
        • MS Office and Windows Integration With WebDAV
      • Reports
        • Creating a New Report
        • Saving the Report
        • Current Project Functionality
        • Reports User Interface
        • Finding a Report
          • Report Jobs
        • Result Table
        • Editing Reports
        • Filtering Reports
          • Additional Filters
        • Traceability Report
        • Drill Down into Trackers
      • Notifications: Receiving Emails from Codebeamer
        • Custom Email Processing Using Scripts
        • Email Integration: Sending Emails to Codebeamer
          • Configuring Codebeamer to Read Emails
          • Configuring Trackers and Forums to Read from Inboxes
      • Searching
        • Advanced Search Syntax and Options
          • Search Using Boolean Operators
        • Navigation History
        • Queries (7.9)
        • cbQL
      • Office Edit
        • Editing Documents
        • Editing Documents in Document Trackers
        • Office Launcher Installation
      • Taxonomy: Categorizing Content with Tags
        • Assigning Tags to Entities
        • Public and Private Tags
        • Administering Tags
      • Trackers
        • Tracker Tree
        • Tracker Tree Configuration
        • In-place Edit of Work Items
        • Searching Work Items
        • Submitting a New Work Item
        • Adding Details to Trackers
          • Adding Comments
          • Adding Attachments
          • Adding Associations and Dependencies
        • History
        • Reminders
        • Editing Issues
          • Field Mapping for Copy/Move Between Trackers
          • Copy or Move Issue Children
        • Creating Issues from Tempaltes
        • Mass Editing
        • Deleting Issues
        • Tagging Issues
        • Workflows
        • Tracker Dashboards
        • Create or Customize Trackers
        • Import Data into a Tracker
        • Navigating to Work Items
        • Remarking for the Table View Result Table to the Last Position
        • Selecting Work Items
        • Grouping Work Items
        • Tracker Types
          • Area
          • Bug
          • Change Request
          • Component
          • Configuration Items
          • Contact
          • Epic
          • Issue
          • Platform
          • Release
          • Requirement
          • Risk
          • RPE Report
          • Task
          • Team
          • Test Case
          • Test Configuration
          • Test Run
          • Test Set
          • Time Recording
          • User Story
          • Document View by Tracer Types
          • Review Hub Support by Tracker Types
        • Permissions by License Types
        • Tracker Relations
          • Tracker Item Reference Settings
          • Propagate Suspects - Reference
          • Propagate Unresolved Item Dependencies
          • Setting Default Reference Settings Per Field
          • Reference History for Fields
          • Associations
          • Propagate Suspects - Associations
          • Work Item Traceability
        • Tracker Inheritance
          • Template Tracker
          • Inheritance
          • Overriding
          • Template Projects
        • Tracker Item Templates
          • Creating Tracker Item Templates
          • Creating Work Items Based on an Item Template
          • Managing Item Templates
          • Limitations of Item Template
        • Tracker Views
          • Filter Widget
          • Manage Tracker Views Menu
          • Save a New View
          • Filter Widget on Baseline Mode
          • Manage Fields
          • Paging - Show More../Show Less.. Buttons
          • Tracker Views (old)
          • Organize Public Views
            • Tree Structure and Functions
            • Properties and Delete Icons
            • Save Public Tracker View into a Folder
          • Intelligent Table View
            • Create an Intelligent Table View
            • Edit an Intelligent Table View
            • Delete an Intelligent Table View
            • Traceability Tree View
            • Hierarchical Table View
            • Show More Function in Intelligent Table View
          • Intelligent Document View
            • Create an Intelligent Document View
            • Edit an Intelligent Document View
            • Delete an Intelligent Document View
            • Intelligent Document View Tree Drag and Drop Guide
          • Displaying Ancestor Items by Default in Document and Document Edit View
          • Intelligent Document/Table View Limits
          • Upstream and Downstream Reference Arrows in Tracker Views
            • Displaying Upstream and Downstream Reference Arrows in Tracker Views on Hover Over
            • Editing Reference View Settings
          • Panel View
          • Column Filter
          • Copy Tracker Views
          • Private Views and Shared Private Views
        • Creating and Customizing Trackers
          • Create a Tracker
          • Customize a Tracker
          • Audit Trail
          • Adding Time Tracking to Existing Projects
          • Edit a Tracker
          • Delete a Tracker
          • Permissions - for Tracker and Issues
          • Issue Details Children and Associations
          • Fields - Custom Fields
          • Table Fields
          • Choice Fields and Multiple Choice Fields
          • Reference Fields
          • User and Project Reference Fields
          • Trackers Reference Fields
          • Repository Reference Fields
          • Combined Choice Fields
          • Wiki Link/URL fields
          • Date Fields
          • Shared Fields
          • Subscribe Tracker Notifications
        • Computed Fields
          • Using Computed Fields
          • Context Variables
          • Functions
            • String-Related Functions
            • List-Related Functions
            • Mathematical Functions
            • Net Working Time Functions
            • Date-Related Functions
            • User-Related and Group-Related Functions
            • User Permissions Functions
            • Suspected Reference Functions
            • Downstream Reference Functions
            • Special Functions
          • Function Examples
          • Computed Field Dependencies
        • Mass Edit
          • Mass Edit Configuration
          • Effects of Configuration Parameters
        • Dynamic Pick-List Fields
          • Standard Distribution and Aggregation Rules
          • Recommended Combinations of Distribution and Aggregation Rules
          • Dependencies Between Different Fields of the Same Item (Cascading Fields)
        • Initializing Fields of New Downstream References
        • Release Management with Codebeamer
          • Adding, Updating and Deleting Releases
          • Breaking Releases into Sprints or Sub-releases
          • Tracking Releases: Progress Reports
          • Tracking Releases: Work Items
          • Completing Releases
          • Roadmaps: Future Releases
          • Release History: Completed Releases
          • Generating Release Notes
          • Customizing the Default Release Workflow
          • Live Demo
        • State Transitions
          • Custom State Transition Predicates
            • Context Specific Predicates
            • Deploying State Transition Predicates
          • Requesting Authentication-User Signature for a State Transition - e-Signature
          • Automatic State Transitions
        • Workflow Actions
          • Update Item Properties
          • Update Referring Items
          • Create New Upstream-Downstream Referring Items
          • Create a New Sequential Id-Number
          • Create a New Baseline
          • Send a Custom Email to Specific Recipients
          • Remove Attachments of the Issue
          • Assign Staff According to Selected Target Projects
          • Validate the User Signature (Password)
          • Start a New Review
            • Application Configuration
            • Review Configuration
            • Review Execution
            • Automatic Reviewer Role Setting
            • Resolving Stuck Reviews
            • Generating Electronic Signature with SSO Login
              • Force Authenticate Users with SSO
              • Features that Are Using the Signature Generation
            • Mass Review
          • Add Release - Sprint Tags
          • Remove Release - Sprint Tags
          • Start a New Review - Before 20.11
          • Trigger State Transition
          • Export to Word Workflow Action
        • Workflow Events
        • Tracker Workflow
          • Planning/Scheduling
          • Work Progress
          • Flow of Responsibility
          • Permissions
          • Two-Man Rule
          • Staff
          • Forking Sub-Processes from Processes (Work Items)
          • Assign Subject Staff According to Selected Target Project
        • Synchronizing Trackers with Atlassian JIRA©
          • JIRA Synchronization Settings
          • JIRA References Synchronization
          • JIRA Fields Synchronization
          • JIRA Issue Links
          • JIRA Synchronization Interval and History
          • Re-Using JIRA Synchronization Settings
          • Removing JIRA Synchronization
          • JIRA Workflow Synchronization
          • Synchronize with JIRA
          • Known Limitations
          • Frequently Asked Questions
          • miniOrange plugin
          • Add Support for Special JIRA Custom Fields
            • Development Environment
              • CustomField
              • MetaData
              • ImportFieldValue
              • ImportFieldHistoryValue
              • ImportFieldChange
              • ResolveUpdateConflicts
              • ImportFinished
              • ExportFieldValue
              • Deployment
        • Synchronizing Trackers with Atlassian JIRA© Cloud
          • Migrating JIRA User Names/Keys to Atlassian Account ID
        • Hide If and Mandatory if Formula
        • Copy Work Item Link
        • Owner-Based Permission Control
          • Configuration Guide
        • Reference Selector
      • Baselines
        • Create Baselines
        • Browse Baselines
        • Sort and Filter Baselines
        • Edit Baseline Properties
        • Lock Baselines
        • Delete Baselines
        • Compare Baselines
        • Filtering and Exporting Tracker Differences
      • Requirements Interchange Format (ReqIF)
        • Exchanging Data via ReqIF
        • Import ReqIF into Working-Sets as a Non-Admin User
        • Import of ReqIF Data
          • Create a New Project from ReqIF Data
          • Target Tracker
          • Target Table
          • Target Qualifiers
          • Target Fields
          • Import Status
          • Remove or Restore Items
          • Relation Type Mapping
          • Disable Structural Changes
          • Import ReqIF Data into an Existing Project
          • Asynchronous ReqIF Import in Background
          • ReqIF Import History
        • Export Data as ReqIF
          • Select Project Baseline and Contents to Export
          • Respond to a Previous Import
          • Asynchronous ReqIF Export in Background
          • ReqIF Export History
          • ReqIF Export from Working-Sets
          • Tracker View-Based ReqIF Export
          • Loading Saved Configurations
        • Configurable ReqIF Base ID
        • ID Definitions
        • Operation
        • Porting
        • Field Value Management During Round-Trip ReqIF Export and Import
        • Exporting from Doors into ReqIF File
        • Stakeholder Request Clarification
          • Importing ReqIF
          • Post-Import Steps
          • Evaluating Requirements
          • Exporting Evaluation Results
          • Validation
          • Receiving Updates from the OEM
          • Common Problems
          • Validation and Cleanup
        • ReqIF Limitations
      • Service Desk
      • Review Hub
        • Review Hub Checklist
        • Starting a Review
        • The Review Page
        • Filters Tab
        • The Review Feedback Page
        • The Review Statistics Page
        • The History Page
        • Permissions and Licensing
        • Create a Review
        • Edit a Review
        • Review Items
        • Sign a Review
        • Finish a Review
        • Restart a Review
        • Export a Review
        • Create Review Templates
        • Edit Review Template
        • Use Review Template
      • Merge Requests
      • Multi select stylesheet
      • About Page View
      • About Permanent Links
      • Hotkeys
    • Codebeamer RM: Requirement Management
      • Document View for Requirements
        • Navigating in Document Views
        • Organizing the Issues
        • Link Requirements with Test Cases
        • Configuring the Test Library
        • Generating Test Cases
        • Working with Releases
        • Working with Issues
          • Issue Details
        • Associations and References
        • Suspected links
        • Context Menus
        • Compact Mode
        • Filtering
        • Tree Settings
        • Rating
        • Baselines
        • Limitations
        • Requirements Library
        • Reviewing Suspected Links
        • Mass Processing Suspected Changes
        • Document Edit View
      • Requirement Baselining
      • Excel Round-trip and Excel import
        • Round-trip Workflow
        • Content of the Export
          • The ID column
          • Exporting the Description of the items
        • Editing Data in the Round-trip Excel
        • Editing Various Field Types
        • Adding New Items Using Excel
        • Importing Round-Trip Changes Back from Excel
        • Automatic Mappings of Fields
        • Exporting and Importing Work Item Parent-Child Hierarchies
        • Multi-Language Support in Excel Round-trip
        • Excel Round Trip - Known Limitations and Issues
        • FAQ-Excel Round Trip
        • Configuring Excel Export Default Settings
        • Round-Trip editing TestCases in Excel, and importing/exporting TestCases from Excel or Word
        • Excel Multi-Choice And Multi-Value Import
      • Word Round-Trip
        • Round-trip Workflow
        • Known Limitations and Issues
      • Microsoft Project Export-Import and Roundtrip
        • Exporting to Microsoft Project
        • Mapping of Codebeamer Fields to MS-Project Tasks
        • Item Description and Hyperlink to Item
        • Scheduling: Dates, Durations and Progress
        • Converting Between MS-Project Durations and Hours in Codebeamer
        • User/Role Assignments to Resources
        • Exporting Dependencies
        • Priority Mapping
        • Exporting Story Points
        • Export of Other Codebeamer Properties as Custom Fields
        • Known limitations of Exporting
        • Importing from Microsoft Project
        • Mapping Fields During Import
        • Creating New Work Items from Tasks
        • Scheduling Fields: Start and End Date, Planned Effort and Spent Effort
        • Importing Parent-Child Hierarchy
        • Improting Dependencies
        • Assignments
      • Traceability Browser
        • Traceability Browser (10.1)
        • Traceabilty Browser (9.5)
        • Traceability Browser (7.9)
        • Preset Migration
      • Import from Microsoft Word
        • Define Import Rules
        • Overwrite Rules
        • Import Work Items
        • Troubleshooting
        • How to Fix if a Word Import Fails with an Error Message?
        • How to Import WMF and EMF Content from Word
      • Importing Tables from Word Documents
        • An Example How to Convert Wiki to Plain Text when Importing from Word or Excel Tables
        • Examples for Preparing Word Documents using Macros
        • Importing Multiple Items including Rich Content and Images from External Sources
      • Branching
        • Working with Branches
        • Example for Reference Rewriting During Branch Creation
        • Navigating Between Branches
        • Deleting and Editing branches
        • Viewing Branches
        • Modifications on the Branch
        • Merging Branches
      • Working-Sets
        • Copying Configurations into Working-Sets
        • Creating Working-Sets
        • Using Working-Sets
        • Modifying Working-Sets
        • Deleting Working-Sets
        • Reviewing and Merging Changes
        • Merging Working-Set Trackers
        • Working-Set Use Cases
          • Phased Development
          • Feature Driven Development
          • Maintenance Releases
          • Product Line or Variant Management
    • Codebeamer QA: Test Management
      • Glossary
      • Creating Test Cases
      • Test Steps Editor
      • Generating Test Cases for Requirements
      • HTML Mode for Table Fields when Comparing Tracker Items Versions
      • Organizing Test Cases to Test Sets
        • Filtering on the Test Cases & Sets Tab
        • Creating Test Sets
        • Adding or Deleting Tests in Sets, Ordering Them
        • Duplicated Test Cases in Test Sets
        • Test Set Report
        • Composing Test Sets from Other Included Test Sets
        • Running a Composed Test Set
        • Quick Assign of Test Cases to Test Sets
      • Initiating Test Runs
      • Creating Test Runs directly from Test Cases (without Test Sets)
      • Adding and Removing Test Cases from Test Runs
      • Adding Test Cases to a Test Run
      • Options for Creating Test Runs
      • Distributing the Test Run Work Between Multiple Users or Roles
      • Creating Releases for Testing
      • Creating Configurations for Testing
      • Executing Test Runs
      • Using Test Runner
      • Executing Test Steps and Recording Results
      • Finishing Run Without Completing the Remaining Tests
      • Reporting Bugs During Test Executions
      • Reporting Duplicate Bugs During Test Execution
      • Reporting Already Existing Bugs
      • Filling Bug's Properties from Test Run or Test Case
      • Finding Reported Bugs of a Test Case
      • Recording the Conclusion of Test Run
      • Test Case Execution
      • Finding Tests By Name in the Test Runner Dialog
      • Running Only Accepted or All Test Cases?
      • Re-running Already Finished Tests
      • Re-running Tests: How Does This Work?
      • Re-running Finished Tests Selectively
      • Test Parameterization
      • Overview of Test Results
      • Exporting Test Results to Microsoft Word
      • Analyzing Test Results and Coverage
      • Configure Coverage Browser Behavior
      • Coverage Browser
      • Computation and Meaning of the Coverage Column
      • Filtering in the Coverage Browser
      • Filtering in the Test Run Browser
      • Coverage Statistics
      • Sharing the Coverage Browser
      • Test Case Library and Test Set Library
      • FAQ-QA Test Management
      • Test Parameterization
        • Using Parameters in Test Cases
        • Providing Parameter Values in Test Cases or Test Sets
          • Providing Parameter Values As Name-Value Pairs
          • Providing Parameter Values as a Wiki Table
          • Providing Parameter Values in Excel Sheet in Document Management
          • Providing Parameter Values Dynamically from CBql or Any Other Sources
        • Sharing Parameter Values Between Test Cases and Test Sets: Parameter Inheritance
        • Reviewing and Managing Parameter Configurations
        • Parameterized Test Running
        • Providing Missing Parameter Values During the Run of a Test
        • Running a Test Several Times Driven by Parameter-Values
        • Skipping Some Test Parameters and Partly Passed Result
        • Reporting Bugs of Parameterized Test Case Runs
        • Reviewing Parameterized Tests' results
        • Parameterized Tests and the Coverage Browser
        • Configuring Existing Test Case and Test Set Trackers for Parameterization
        • Parameter Resolution: Inheritance and Merging
        • Runner Keeps only Used and Distinct Parameter from the Parameter-Values
        • Merging (joining) Parameter Values
        • Tip for using dynamic data as Test Parameters like cbQL Results or any Plugins' Result
      • Reference Test Cases and Test Step Reuse
        • Reusing Test Steps
        • Creating Reference or Copy Test Steps
        • Reference Test Step Management
        • Navigating between the Reference and Referenced Test Steps
        • Tracing Test Step References
        • Editing Reference Test Steps
        • Missing References and Error Handling in Test Runner
        • Test Case Libraries
        • Adding Support for Reusable Test Cases in Legacy Trackers
        • Detecting and Automatically Converting Test Step Duplicates to Step Reuses
        • Reusing Pre-Actions and Post-Actions
        • Check Test Step Reuse at Codebeamer Upgrade
      • Running Tests Outside of Codebeamer: Run in Excel
        • How to Run-in-Excel: Exporting the Tests for Running Outside
        • Run in Excel - Tips and Limitations
      • How to Import Test Cases with Test Steps from Excel
      • Importing from Excel into Several Trackers - How to Import Complex Test Set and Test Case Hierarchies
      • Importing and Round-Trip Editing of Test Cases with Test Steps in Excel
      • Risk Matrix Diagram
        • Customizing Likelihood and Severity as Choice Lists
      • Validation of Test Management Configuration
    • Codebeamer ALM: Application Lifecycle Management
      • Code Review with Codebeamer
        • Voting and Voting Workflow (Enforcing) for Pull Requests
        • Code Review and Commit Comments for Issues
      • Version Control: Subversion (SVN), Git, Mercurial
        • Using Managed Subversion, Git & Mercurial Repositories
          • Creating Managed Repositories For New and Existing Projects
          • Sharing Managed Repositories
          • Managing Access Permissions by Roles
          • Configuration Note
          • Setting Up SSH Authentication for Git and Mercurial
          • Using Git with Codebeamer
            • How to Use Git with Codebeamer
            • Converting an Existing Git Repository to a Managed One
            • Creating Bundles
            • Using Git in the Eclipse IDE with the EGit Plugin
            • Working with Git Submodules
              • What is a Git submodule
              • Working with Supermodules and Submodules
            • Manual Synchronization of External Git Repository Changes
          • Using Mercurial with Codebeamer
            • How to Use Mercurial with Codebeamer
            • Converting an Existing Mercurial Repository to a Managed One
            • Creating Bundles
            • Configuring Apache for Mercurial
              • How to Configuring Apache for Mercurial
              • Add Codebeamer User to Apache Group (gid)
              • Clone a Codebeamer Repository and Commit with an Associated Issue
            • Configuring Mercurial for Microsoft IIS
            • Using Mercurial in Eclipse with the MercurialEclipse Plugin
          • Using Perforce with Codebeamer
            • Creating a New Perforce Repository
            • Managing your Perforce Server with Codebeamer
            • Mapping of Perforce Users to Codebeamer Users and Managing Permissions
            • Streams and Branches
          • Using Subversion with Codebeamer
            • Using Subversion in Eclipse IDE with Subclipse plugin
            • Configuring Subversion for Work Item References in Commit Messages
            • URLs of Managed Subversion Repositories
            • How to Use Subversion with Codebeamer
            • Useful Subversion Commands
            • Directory-level Access Control for Subversion
            • Configuring Apache for Subversion
              • Check Out a Codebeamer Repository and Do a Commit
        • External SCM Services in Codebeamer
          • Enabling External SCM Projects
          • Background Processes and UI Actions
          • Webhook
          • Setting New SCM User Keys in the User Account
          • Connect External SCM Services
          • External SCM - Azure Repository
        • Webhook - Connect External SCM Services
          • Configure GitHub Webhook
          • Configure GitLab Webhook
          • Configure bitbucket.org Webhook
          • Configure Notifications for New External SCM Repositories
          • Configure Self Hosted Bitbucket Webhook
        • Collaborating with Version Control Systems
        • SCMLoop - Connect External Repositories
          • Instrumenting SCM Repositories
          • Instrumenting a Git Repository
          • Instrumenting a Subversion Repository
          • Instrumenting a Mercurial Repository
          • Instrumenting a Perforce Repository
        • Supported Version Control Systems
        • Tracing Source Code Changes to Requirements, Task and Bugs
          • How Does a Task-Based Process Work
            • Enabling a Task-Based Process for a Project
          • Committing Actions from IDEs
          • Accessing the SCM Commit History
          • Accessing SCM Modules Associated with Tracker Items
          • Reassign Commits to Tasks
        • Tracking Source Code Changes and Developer Team
        • Version Control Workflows
          • Integration Manager Workflows & Pull Requests with Git and Mercurial
            • Steps of the Integration Manager Workflow
            • Synchronizing Your Local Clone with the Upstream Repository
            • Advanced Integrator Workflows
    • Codebeamer Agile: Agile Application Lifecycle Management
      • Agile Planning
        • Definitions: Release, Sprint, Backlog
        • Planner Scopes
        • Navigating between Planner, Cardboard and Release (or Sprint) Statistics
        • Anatomy of Planner
        • Story Plan or Grouping Work Items
        • Grouping by Reference Field
        • Assign Items to Groups
        • The Product Backlog
        • Managing Releases in Planner
        • Managing Work Items in Planner
        • Creating New Work Items
        • Editing Work Items in Planner
        • Rating and Comments
        • Prioritizing Work Items
        • Estimating Work Items
        • Assigning Work Items to Team Members
        • Coloring Items
        • Using Relations to Categorize Items
        • Multiple Selection
        • Generating Sprint or Release History
        • Generating Sprint Schedule and Next Sprint
        • Release Gantt Chart
        • Setting the Default View for Releases
      • Team Management
      • Best Practices for Agile ALM
      • Integrating Agile with Application Lifecycle Management
      • Recommended Reading for Agile ALM
      • Scrum and Kanban for the Enterprise
        • The Three Levels of Agile
        • Agile Process Frameworks
        • Agile for the Team
          • User Stories
          • Sprints
          • Releases
          • Managing Releases and Sprints
        • Agile for the Program
        • Agile for the Portfolio
          • Investment Themes
          • Epics
        • Executing Agile
        • What is a Cardboard
          • Viewing Issues in Cardboards
          • Analysis of a Card
          • Mapping Issues to Cardboards
          • Filters in Cardboard
          • Grouping Cards
          • Editing in Cardboard
        • Create New Downstream Reference
        • Moving Cards Between Columns
        • Access Control in Cardboards
        • Propagating Status in Cardboards
        • Configuring Cardboards
    • Codebeamer IBM RPE
      • Document Studio
      • Document Builder
      • Codebeamer
    • Codebeamer Service Level Agreement (SLA) Management
      • Configuration Management Database (CMDB)
      • Escalation Management: Service Level Agreements (SLA)
        • Escalation Management - Configuration
        • Escalation Management: Examples
          • Example 1: Send Notification One Hour after Issue Submission
          • Example 2: Send a Notification upon Receipt of New High-Priority Issues
          • Example 3: Send Notification if Issue is Still Unconfirmed After 8 Hours
          • Example 4: Open Issue Still Unassigned and Supposed to Start within 30 Minutes
          • Example 5: Issue Is Not Started, and We Are Past "End Date" Minus "Estimated Hours", or Behind Schedule
          • Example 6: Recurring Escalation for Missed Deadlines
        • Issue Escalation Schedule
        • Issue Reminder
        • Working Time Calendars
      • Work Time Management
    • Codebeamer DOORS Bridge
      • Importing Requirements via the Codebeamer DOORS Bridge
      • DOORS Bridge Settings
      • Lock Module and Link Objects
      • DOORS User Handling
      • DOORS Attribute Mapping
      • DOORS Link Mapping
      • DOORS Import Interval and History
      • Re-Using DOORS Bridge Settings
      • Removing DOORS Bridge Settings
      • Import from DOORS
      • DOORS Known Limitations
      • Importing DOORS Projects, Folders and Baseline Sets via Codebeamer DOORS Bridge
      • Codebeamer DOORS Bridge REST API
      • Extending Imports from DOORS
    • Word and Excel Templates
      • Excel Templates
        • Getting Started: Exporting Using Customized Excel Templates
        • Managing Excel Templates
        • Writing Excel Templates
        • Accessing Custom or Customized Fields by Their Labels
        • Choice Option Fields
        • Multichoice Fields
        • Available Variables in Scripts (scope)
        • Explicit Processing of Collections and Content Filtering
        • Tags Available
        • Advanced Script Tags and Groovy and Velocity Scripts
        • Auto-sizing Columns
        • Advanced Functions and Expressions
        • Filtering by Dates
        • Example: Rendering Data in Multi-Row
        • Hyperlinks Back to Codebeamer
        • Executing SQL queries
        • Adding Charts
          • Export Source Data for Charts
          • Put Sample Data into the Excel Template for Charts
          • Create Named Ranges on Sample Data
          • Define Charts Using Named Ranges
          • Re-bind Named Ranges to the Real Data Being Exported
        • Exporting Charts and Example Template
        • Tips, Tricks, and FAQs
        • Export Test Cases with Test Steps Using MS Excel
        • Exporting Hierarchy of Work Items to Excel using Custom Templates
        • How to Export Excel with Headers-Footers using Excel Templates
        • How to Export Work Items with Comments to Excel Custom Export
        • How to Export a Partly Loaded Reference Field to Excel
        • How to Export All (Down-Up-In-Out) References of the Item to Excel
        • How to Export Work Items Selecting by Statuses into Different Sheets
      • Word Templates in CB 9.3 and Higher
        • Default Word Templates
        • Important Word Settings and Shortcuts
        • Merge Fields
        • Formatting Fields
        • Available Merge Fields
        • Bookmark Blocks
        • Rendering Table Fields of Trackers
        • Links to Codebeamer Resources
        • Heading Styles
        • Velocity Macros
        • Conditional Formatting
        • Convert to PDF
        • Conditional Templates
        • Custom Conditionals
        • Word Templates In Codebeamer: Known Limitations
        • Rendering Parameters
        • Truncate Long History Entries
        • Export Attachments to Word
        • System Admin Configuration of Word Export
        • Word Export Features — CB 9.4 and Higher
        • Word Export Placeholder Listing - CB 9.3 and Higher
        • Advanced Word Export
          • Tracker Item as a Template Configuration Parameter
          • Query Parameters
          • Template Parameters
            • Table Rendering
          • Advanced Word Export: Known Limitations
          • Impact on Previously Created Templates
        • Adding and Customizing Templates for Word and Excel Export
          • Security of the Export Templates
          • Storing Word and Excel Report Templates
          • Merging the Global Templates from File System and Document Management
        • How to — List of Values in One Table Cell
        • Avoid Security Notice Pop-ups when Opening Exported Document
        • Known Issues of Word Export
        • Known issues of Word export on Docker
      • Word Templates in CB 7.2 - 9.2
        • Word Export Customization
        • Managing Templates
        • Customizing Word Export's Look and Content
        • Structure of the Export Document and Template
        • Customizing Header and Footer
        • Customizing Overview and Introduction part
        • Customizing Exported Issues
        • List of Objects/Entities Available in the Export Scripts
        • Using properties of Objects/Entities Available in the Export Scripts
        • Using Microsoft Office Specific HTML or XML Tags
        • Customizing the Look and Style of the Export Document
          • Customizing Header and Footer and Using Your Company Logo
          • Customizing Styles in Word Template
          • Customizing Look of HTML Element Using CSS
          • Adjusting Default HTML and CSS Templates
          • Customizing HTML and CSS in the DOCX Template Documents
          • Advanced Styling and HTML Rewriting
          • Customizing the Proofing Language of the Export Documents
        • Legacy Word Export is disabled ?
        • Advanced Word Reporting: Customizing Table of Content and Assigning Word Style to Wiki Elements
        • Advanced Word Reporting: Post Processing Exported Content for Better Reports
        • An Example of Customizing Word Templates in Round-Trip Export
        • Customizing Export of History in Word
        • Customizing Export Template for Test Management: Exporting Test Runs
        • How to Access Choice or Reference Fields Inside Tables from Word Export
        • How to Add List of Items to the Exported Word Document
        • How to Export Test Cases with Test Steps
        • How to Export Custom Wiki Fields to Word as Rich Text with Images
        • How to Export from Multiple Trackers: An Example of Exporting Requirements and Test Cases
        • How to Filter Exported Work Items in Word Export
        • How to List Comments and Attachments of Requirements-Bugs and Other Kind of Exported Items
        • How to Export References with their Descriptions
        • Word Export Template: How to Export Multiple Tracker’s Item from a Project
        • Completely Customizing the Content of the Exported Word Document
        • FAQ : How to Fix if Word Export is Slow ? Might be a DNS Server Issue
        • How to Add Content to the End of the Word Document Generated from the Template
        • How to generate Table of Figures and Table of Tables in Word export
        • How to Insert List of Baseline to Word Export
        • How to Render Properties of the Exported Item in the Properties Part of the Word Template
        • Tip : Faster Development of Word Templates
        • Tip : Finding Errors in Your Word Templates
      • Word Templates in CB 7.1 and Older
        • List of Objects/Entities Available in the Export Context
      • How to Setup Word Export Server
        • How to Setup a Word Export Server on Linux
        • How to Setup a Word Export Server on Windows
      • How to Setup Excel Import Server
        • How to Setup a Excel Import Server on Linux
        • How to Setup a Excel Import Server on Windows
    • Offline Testing Mobile Application
• Administrator's Guide
  • Codebeamer Administrator's Guide
  • Codebeamer Maintenance
    • Managing Users and User Groups
      • Managing Groups
      • Creating New Groups
      • Deleting Groups
    • Managing Users Accounts
      • Assign a User to a Group in a New Account
      • Change User Account Upload Limits
      • Disable a User Account
    • Importing Users From Microsoft Excel (xls, xlsx) or CSV file in Microsoft Excel style
      • Finalize the Import of Users
    • Managing Anonymous User Access
      • Create an Anonymous Group
      • Create an Anonymous User in the Anonymous Group
      • Assign New Accounts to Anonymous Group
      • Set Anonymous Role in a Project
      • Assign the Anonymous Group to the Anonymous Role
    • Logged In User Information
    • User Registration Options
    • Encrypting Sensitive User Data
    • Synchronizing LDAP/Active Directory Groups
    • Maintaining Projects
      • Viewing All Existing Projects
      • Deleting Projects
    • Maintenance mode
    • Database Migration to PostgreSQL
      • Database Migration
      • Database Migration from PostgreSQL 12.x to PostgreSQL 15.x
    • Global Codebeamer Settings: Working Calendar, Periodic Process Timer
      • Calendar of Business Hours
      • Periodic Process Timer
      • Shared Fields
    • Branding: Company Logo, Colors and Texts
      • Upload Company Logo
      • Login and Welcome Texts
      • Customizing Login Page
    • Maintenance: Search (Indexes), Documents, Version Control Repositories
      • Create Full-Text Index on Tables
      • Codebeamer Active - Active Clustering Solution
        • Naming Codebeamer Cluster Nodes
      • Codebeamer Active - Passive Solution
        • Setup Requirements
        • Setup a new Codebeamer with Active / Passive configuration
        • Upgrade Codebeamer
        • Starting the Server
    • Managing Licenses
      • Licensing with FlexLM
      • Installing FlexNet Servers
      • Obtaining Licenses
      • Activating Licenses and Editing Licenses
      • Assigning Licenses to User Accounts
      • Codebeamer Licensing
    • Troubleshooting
      • How to Access the Physical Content of an Artifact
      • How to update SVN repository when user data is changed
      • How to use Codebeamer SFTP Server
        • Troubleshooting
      • How to turn off Deprecated password policy warning
      • How to fix out of memory issues with external services
    • Shared Fields
    • Export, Import and Obfuscate Database
      • Import and Export Codebeamer Database with Oracle
        • Obfuscate Sensitive Data
      • Create and Load MySQL Dumps
        • Create Dump
        • Import Dump
        • Obfuscate Sensitive Data
      • Create and Load PostgreSQL Dumps
        • Export and Import Dump without Binary Data
        • Obfuscate Sensitive Data
    • Updating Oracle schema statistics periodically
      • How to create the Gathering Statistics Job
      • How to Run the job Manually
      • How to Alter the Job
      • How Check Fragmentation
  • Codebeamer Monitoring
    • Monitoring, Logging & Profiling
      • Configuring System Logging
      • Configuring Groove Script Logging
      • Monitoring Server Resources: Memory Usage, Thread Count and Database Connections
    • Database Performance Monitoring Job
      • Results
      • Predefined Queries
      • Correlation
      • Performance CLI Tool
      • Index Integrity Checking
      • Database Health Check and Self-Healing
        • Common Self-healer Issues
        • Configuring Docker Health Checks Before Upgrading Large Instances
      • Performance CLI Tool
      • Table Analysis
      • Logging Plugin Incompatibility
    • Tests And Audits
      • Performance Tests
        • Requirements
        • Performance Monitoring
        • Performance Test Data Generation
        • Executing Performance Tests
        • Check Test Results
        • Intland's Performance Test Result
        • Oracle General Performance Test
        • Document View Performance Test and comparison
        • Performance Tests results for older versions
        • Optimizing Codebeamer Performance
          • Codebeamer ALM's Official Scalability Performance Test Report 2019
          • MySQL Server Tuning
          • Performance Monitoring
        • Performance results for previous versions
      • Codebeamer Audit Trail
    • General Security Awareness
      • General Data Protection Regulation (GDPR)
  • Codebeamer Integrations with External Services
    • Codebeamer - Simulink Integration
    • Connections with Atlassian JIRA© or IBM Rational DOORS©
    • Configuring External Services: Email (SMTP), LDAP
      • Configuring Kerberos SSO authentication
      • Configuring Kerberos SSO Authentication on Windows Server
    • Codebeamer Integration with Slack
• Developer's Guide
  • Developer's Guide
    • Codebeamer Architecture
      • Single Server Architecture
      • Cluster Architecture
        • Cluster Components
        • How to Setup Basic Codebeamer Cluster
        • How to Setup Cluster with Docker Compose
        • Constraints when Running a Cluster on ECS
    • Codebeamer Development
      • Codebeamer Extension and Plugin Development Summary
        • REST API (v1)
          • .NET Rest API client Example
          • Java Rest API client Example
        • External JavaScript Extensions
      • Codebeamer API - Extension and Plugins Guide
        • Listener API
          • File Upload Listener
          • Content Virus Scanner
          • Tracker Synchronization Listener
          • Add Users as Project Administrators to Each Newly Created Project
        • Wiki API
          • Developing Wiki Plugins: Hello World (Part 1)
          • Developing Wiki Plugins: The AbstractCodebeamerWikiPlugin Class (Part 2)
          • Open Source Wiki Plugin Samples: Compiling, Deploying and Debugging Wiki Plugins for Codebeamer
        • Dashboard API
          • Widget Development and Deployment Quickstart Guide
        • Debugging Codebeamer customizations
        • Entity Metadata
        • Integrations
          • Codebeamer - Enterprise Architect Integration
          • Open Source Jenkins Plugins and Jenkins Integrations
            • Codebeamer xUnit Uploader Plugin
              • How to Setup the Plugins
            • Codebeamer xUnit-jMeter Results Trend Publisher Plugin
            • Codebeamer Source Code Coverage Publisher Plugin
            • Codebeamer Test Result Integration - CBCI Jenkins Plugin
          • Send Log Files to SYSLOG Server
        • Adding Indexers to Codebeamer
      • SaaS based Evaluation
        • How to create a new project using a new Smart Template
        • How to invite your colleagues for the evaluation
        • How to extend your 30 days evaluation period
        • How to evaluate our Medical Template for IEC 62304
        • How to install the Medical Template for IEC 62304
      • Execute a custom script
        • A Most Basic Example to Test Custom Script Execution
        • An example scripted Workflow transition: How to configure Codebeamer to synchronize Leads tracker with others using a custom Workflow action
        • Example Custom Script to Find Items Having a Specific Field Value
      • Custom Workflow Actions
      • JavaForge Shutdown
    • Codebeamer Developer Tools
      • Amazon AWS Setup Guide
        • AWS Cloud - Deployment Guide
        • AWS Cloud - Elastic Container Service
          • Network Diagram
        • Amazon RDS: Tips for Using RDS Database with Codebeamer
      • Azure SaaS
        • Azure Private Cloud
      • Docker
        • Building a Docker Image for Codebeamer
        • Docker Compose for Evaluation with PostgreSQL Service
        • Docker Compose for Evaluation with MySql and Apache HTTP
        • Docker Compose for Testing OpenID Setup
        • Docker Compose with MySQL
        • Docker Compose with Oracle
        • Docker with MySql (without compose)
        • Docker with MySql and Apache (without compose)
        • How to Access the Latest Docker Snapshot
        • How to Run Docker Container with External Volumes
        • How to Set Up SSL for Codebeamer
        • How to Start Docker Container for Cluster Environment
        • How to Replace Log4j Jars in Docker Container
        • How to Start a Dockerized Codebeamer with MySQL
        • How to Add Arial Unicode MS and other Fonts to Docker Image
        • Test Upgrade with Docker
          • With Docker-Compose
          • Without Docker-Compose
          • How to Create a Backup
      • Docker - Codebeamer X
        • Docker Compose with MySql - Codebeamer X
        • How to Start a Dockerized Codebeamer X with MySQL
        • Troubleshooting - Codebeamer X
        • Codebeamer X Installation on a Fresh CentOS 7-8 Linux with Docker
      • OpenShift
        • Cluster Setup Guide
        • OpenShift - Disaster Recovery and Business Continuity Plan
        • OpenShift Template to Setup Codebeamer
      • Swagger
        • Swagger Documented - REST-Based API
          • OpenAPI Generator clients
          • Swagger V3
            • Inheritance and Abstract Models
            • Swagger V3 Examples
              • Authentication
              • Discovering the Project Structure
              • Tracker Item Operations
              • Report Operations
              • Association Operations
              • Test Case Management
              • Wiki Information
          • Swagger V3 Migrations
            • Swagger V3 Export to Word
            • Swagger V3 Background Job API Changes
              • Create a Background Job to Update a Working-Set
            • Swagger V3 General Concepts
            • Swagger V3 Tracker API Changes
            • Swagger V3 Tracker Item API Changes
            • Swagger V3 Permission Changes
            • Swagger V3 Working Set API Changes
              • Update the Branches of a Working-Set
              • Project-Level Working-Set Information
              • Working-Set Information
              • List the Trackers in a Working-Set
              • List Working-Sets
              • Map Tracker Items to a Working-Set
            • Highly Automated Project Provisioning
              • Swagger V3 Tracker Tree Endpoints
              • Swagger V3 Tracker Configuration Endpoints
            • Swagger V3 External Repository Item
              • Create an External SCM Repository Item
              • Update an External SCM Repository Item
          • Swagger V2 Examples
            • Creating a Test Case Tracker Item
            • Creating a Tracker Item With Attachments in Description
            • Logging Time on a Tracker Item
            • Updating the Results of a Test Run of a Test Case
          • API Throttling
• Installation Guide
  • Codebeamer Installation Guide
    • Codebeamer Installation
      • General System Requirements
        • Important Files and Directories
        • Important Files and Directories - v9.4+
        • Database Specific Configurations
        • Internet Explorer Compatibility View
      • Database Installation and Configuration
        • MySQL Database Installation
          • Preparing MySQL Database for Installation
            • Preparing MySQL Database for Installation - v10 and Later
            • Preparing MySQL Database for Installation - v9.5 and before
          • Installing MySQL Database on Windows
          • Installing MySQL Database on Red Hat or CentOS
          • Replacing MariaDB JDBC driver to MySQL JDBC Driver
          • Migrate MySQL Database to UTF8MB4 Character Encoding
            • Revert and fix faulty character encoding configuration
          • Installing MySQL on Linux
        • Oracle Database Installation
          • Preparing Oracle Database for Installation
        • PostgreSQL Database Installation
          • Preparing PostgreSQL Database
      • Installing Codebeamer
        • Installing Codebeamer Service Packs
        • Configuring a Cryptography Key
      • Deployment options for Git, Mercurial and SVN
      • Step by Step: How to Configure a Linux-Ubuntu Instance to Run with Codebeamer
        • Adding Codebeamer service (auto startup)
      • Step by step: how to configure a Linux-SUSE instance for running with Codebeamer
      • Step by step Installing-Preparing CentOS under ESX
      • Step by Step: How to Configure Codebeamer as Active-Active Cluster
      • Upgrading from older versions - simple - since 21.09 (Emma)
        • Upgrading from Older Versions - Advanced - Since 21.09 (EMMA)
          • Migrate MySQL 5.7 CB database to 8.0
      • Upgrading from older versions - simple - before 21.09 (Emma)
        • Upgrading from older versions - advanced - before 21.09 (Emma)
      • Fixing Invalid Views Caused by 'EMMA-Upgrade_026' Upgrade Script
      • Upgrade to 22.10-LTS Using Two-Phase Upgrading Procedure - Since 22.10-SP7
    • Codebeamer Configuration
      • Post-installation Configuration
        • Configuring Ant for Codebeamer: Builds in Separate JVMs
        • Configuring Graphviz for Codebeamer: Graph Visualization
        • Configuring Math Plugin for Codebeamer: Mathematical Formulas
        • Configuring PhantomJS for Codebeamer
        • Configuring Tomcat for Codebeamer
          • Installing Apache Webserver (Deprecated)
          • How to Configure HTTPS Site When Using Apache and Installing SSL Certificates (Deprecated)
          • Change Tomcat Context Path
          • Configuring Apache - httpd Proxy on CentOS
        • Configuring Search PATH where External Executables are Found
        • Configuring which Files can be Uploaded to Codebeamer
        • Installation of a missing JDBC driver
        • Testing Active Directory Connection
      • Builds: Continuous Integration
      • Authentication and Access Control in Codebeamer
      • Backing up Codebeamer installation
      • Customizing the Codebeamer User Interface
        • Customizing Remote Issue Reporting in the Footer
      • Customizing Notification Emails
      • Codebeamer Localization Guide
      • Enabling Test Management for Older Projects
      • Importing Data from CSV Files to Codebeamer
      • Importing Data from Excel to Codebeamer
      • Migrating an Existing Codebeamer Installation to a New Host
      • Service or Help Desk Computer Telephony Integration (CTI)
      • The General.xml Configuration File
      • Application Configuration
        • Application Configuration via Environment Variables
          • Database Connection Pool Parameters
          • SQL Database Timeout
      • Codebeamer Authentication with SiteMinder
      • Single Sign-On (SSO)
        • OpenID Connect (OAuth2)
        • SAML
          • How to set up SAML with Azure AD (Azure Active Directory)
          • How to Set Up Codebeamer as Service Provider
          • SSO FAQ and Troubleshooting
      • Importing and Exporting Encrypted Files
        • Setting up Import and Export
        • Accessing the Import and Export feature
        • File Importing and Exporting Formats
        • About the Interfaces
        • Example for Interface Implementations
    • Release Notes
      • Codebeamer Release Codenames
      • Codebeamer - 2.1.x (IMPALA)
        • Release Notes - Codebeamer 2.1.x (IMPALA)
        • Requirements - Codebeamer 2.1 (IMPALA)
        • Service Packs - Codebeamer 2.1.x (IMPALA)
        • What is New in Codebeamer 2.1 (IMPALA)
        • Guards Created on Older Versions Could Have Missing creationType Atributes
      • Swagger API changes since 20.11-LTS
• codebeamer DPT Integration
  • Codebeamer DPT Integration
    • DPT Overview
    • Server Guide
    • Client Guide
• Codebeamer X User Guide
  • Codebeamer X 4.3
    • Codebeamer X 4.3.1 Release Notes
    • Features and Fixes 4.3
    • Release Notes - 4.3
    • User's Guide - 4.3
      • Smart Copy Features
        • How to Guide for Advanced Smart Copy
          • Start Advanced Smart Copy setup
          • Setup one Smart Copy
          • Change the default configuration options
          • Extension of the copy operation
          • Review the reused work items
        • How to Guide for Library-Based Smart Copy
          • Define Source and Target Workspaces
          • Smart Copy Process
          • Predefined Settings and Limitation of the Library Based Smart Copy
        • Smart copy
• Codebeamer X Installation Guide
  • Codebeamer X Installation Guide
    • Installing Codebeamer X on Windows
    • Installing Codebeamer X on a Linux Distribution
    • Setup an Existing MySQL Database for Codebeamer X
    • Upgrade from a Previous Version