Welcome to the Codebeamer 3.2 Help Center
Release Notes
Release Notes for Codebeamer 3.2.0.2
Fixed Bugs
Release Notes for Codebeamer 3.2.0.1
Fixed Bugs
Release Notes for Codebeamer 3.2.0.0
What’s New
Fixed Bugs
Known Issues
System Requirements and Platform Updates
Codebeamer AI
Supported Feature Combinations
Codebeamer Critical Patch Sets
Swagger API Release Notes
Swagger API Changes - Codebeamer 3.2.0.0
Swagger API Changes - Codebeamer 3.1.0.0
Swagger API Changes - Codebeamer 3.0.0.0
Swagger API Changes - Codebeamer 2.2
Swagger API Changes - Codebeamer 22.10-LTS
Swagger API Changes - Codebeamer 22.04
Swagger API Changes - Codebeamer 21.09
Swagger API Changes - Codebeamer 21.04
Swagger API Changes - Codebeamer 20.11-SP4
Swagger API Changes - Codebeamer 20.11-LTS
About the User Guide
Codebeamer Overview
Glossary of Terms for the User’s Guide
Codebeamer: Common Concepts
User Accounts and Logging in to Codebeamer
Logging out of Codebeamer
User Preferences
Open Links in New Browser Tab
Email Delivery Customization
Codebeamer User Interface
My Start
My Wiki
My Account
My Items
My Starred
Star It function
System Monitoring
System Admin
Help Links
Projects, Users, Accounts, Members, Roles, and Groups
Access Control
Managing Projects
Project Browser
Cards on the Project Browser
Managing Project Categories
Managing Project Category Views
Managing Project Members
Creating a New Project
Project Wiki
Administering Projects
Settings (Drag & Drop) view
Adding Members To a Project
Adding a New Group
Remove Members from Project
Customizing Roles
Configuring Project Options
Meaning of Fields
Renaming Project Specific Tabs
Closing/Reopening Projects
Removing/Deleting Projects
Project Admin Calendar Tab
Project Admin Approval Workflows Tab
Project Audit Trail Tab
Project Admin SCM Settings
Administering External SCM Access
Configuring an External Subversion Repository
Configuring External Git and Mercurial Repository
External Repository Access Through SSH
Instrumenting External Repositories
Administering a Managed Subversion Repository
Synchronization with the SCM System
Code Parsing Options
Building Communities Around Your Projects
Project Groups
Project Import and Export
Exporting and Importing a Project as a Project Template
Project Configuration Deployment
Project Configuration Deployment - Technical Details
Step by Step Guide for Project Configuration Deployment
Full Project Configuration Deployment
Selective Project Configuration Deployment
Project Deployment via Swagger API
Project Configuration Deployment and Inheritance
Template Trackers in Project Deployment
Managing a Deployment
Template Environment Initialization From an Existing Configuration Environment
Best Practices for the Project Configuration Deployment
Troubleshooting Guide for the Project Configuration Deployment
Known Limitations for the Project Configuration Deployment
Wiki
Wiki as a Framework - Combine Content using Plugins
Wiki User Interface
Wiki Content Pane
Structure Tree Section
Editing in the Wiki
Formatting
Mentioning Members, Teams, Areas
Copying and Pasting Wiki Documents
Wiki Page Properties
Advanced Wiki Management
Collaborative Section Review
Creating a Section Review
Adding Comments
Ending a Section Review
Hiding Section Reviews
Dashboard
Widgets
Widget Types
Report Visualization
Project
Agile
Test
Personal
Others
Widget Development Documentation
External Widget Development
Supported External Dashboard Widget Attributes
Diagrams
Show or Hide External Widgets with Enabled Property
Getting Started with External Widgets
TypeScript Support
Self Registration for External Widgets
External Widget API Reference
Diagram Editor
Creating and Inserting Diagrams
Editing a Wiki Page with Microsoft Word
Froala Editor Limitations, Feature Requests and Bugs
Using Pictures in Edit via Office
Wiki Markup and Plugins
Basic Formatting
External Pictures
Links with Pictures
Slideshow with Thumbnails
Using Thumbnails to Automatically Resize and Shrink Wiki Images to Fit the Page
Pictures from Page- and Issue Attachments
Pictures from Documents
Bulleted Lists
Numbered Lists
Definition Lists
Advanced Formatting
Text Color
Text Size and Alignment
Custom Text Styles
Text Boxes
Tables
Title of the Box
Tabbed Sections
Collapsable Lists
Advanced Tables
Bar Graphs
Interwiki Links
Link Stereotypes
Global Stereotypes
Page Specific Stereotypes
Wiki Content
Project List Plugin
Project Info Plugin
Members Plugin
Tracker List Plugin
Most Active Projects Plugin
Project Activity Trends Plugin
Activity Stream Plugin
Artifact Activity Trends Plugin
Artifact Count Trends Plugin
Issue Count Trends Plugin
Issue Count By Field Plugin
Release Activity Trends Plugin
Release Gantt Chart Plugin
Risk Matrix Diagram Plugin
My Open Tracker Items Plugin
Tracker State Transition Chart Plugin
Tracker Class Diagram Plugin
Query
Tracker Item State History Plugin
Tracker History Audit Trail Plugin
Commit Statistics Plugin
Commit Trends Plugin
Committed Issues Plugin
Version Control
Requirements Management
Test Cases by Last Run Result Plugin
Test Runs by Configuration Plugin
Test Runs by Test Set Plugin
Test Runs by Assignee Plugin
User Profile Plugin
My Issue Summary Plugin
My Current Issues Plugin
My Subscriptions Plugin
My Reviews Plugin
Review List Plugin
Agile Content
Burn Down Chart Plugin
Burn Up Chart Plugin
Bubble Visualization Plugin
Velocity Trends Plugin
Sprint Break Down Plugin
Current Velocity Plugin
Remaining Time Plugin
Release Stats Plugin
Graphs
Horizontal Graph
Vertical Graph
Directed Acyclic Graph
Explorer Graph
Mindmap
Charts
Gantt Chart
Dynamic Gantt Chart
Pie Chart
Polar Chart
Scatter Plot Chart
Stacked Area Chart
Time Series Chart
Area Chart
Line Chart
Step Area Chart
Bar Chart
Stacked Bar Chart
Waterfall Chart
Multiple Pie Chart
Bubble Chart
Spider Web Chart
Gauge Chart
Speedometer Chart
Printing to PDF
Export Wiki Plugin
Excel Spreadsheet Plugin
Word Plugin
Jenkins Build Trends and Jenkins Performance Trends Plugin
Shockwave (SWF) Plugin
Google Maps Plugin
Feed Plugin
Color Code Plugin
Color Code Plugin Examples
Include Plugin
HTML Plugin
Math and Latex Plugins
Emoticons
Traceability Report Plugin
Risk Traceability Matrix
Example
Escaping
LaTex Plugin
Math plugin
Importing Items and Wiki Pages
Known Limitations of Importing RTF
Generating Specification Documents
Customizing the Microsoft Word Output
Customizing the PDF Output
Generating Documents: Exporting Wiki Pages to RTF and Word
Changing the Font Set to Support Asian and Eastern European Languages
Known Limitations of the PDF/RTF Export
Document Manager
Document Operations
Versioning and Access History
Document Tracker Configurations
MS Office and Windows Integration With WebDAV
Reports
Creating New Reports
Saving and Managing Report Permissions
Reports User Interface
Result Table
Opening in Table View
View Mode and Edit Mode
Editing Reports
Project and Tracker Selectors
Current Project Functionality
Filtering Report Results
Additional Filters
Grouping Report Results
Ordering Report Results
Traceability Report
Accessing Reports
Deleting Reports
Exporting Reports to Office
Finding Reports
Report Jobs
About Email 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
Searching Wiki Text Fields
Navigation History
cbQL
Structure
Projection
Filter
Date Values in cbQL
String Literal
Short Date Expression
Long Date Expression
Operators
BETWEEN
LIKE
IN
EXISTS, NOT EXISTS
Aggregation Function
min
max
avg
sum
count
Date functions
Include Expressions
Fields
project.id
project.name
tracker.id
tracker.name
item.id
submittedAt
modifiedAt
modifiedBy
startDate
endDate
assignedTo
assignedToIndirect
assignedToRole
assignedToRoleIndirect
assignedToGroup
assignedToGroupIndirect
assignedAt
owner
ownerRole
ownerGroup
hasAssociation
has Downstream Reference
hasSuspectedLink
has Upstream Reference
priority
reference From Tracker
reference ToId
reference To Name
reference From Id
reference From Name
reference To Tracker
release
resolution
severity
status
submitted By Email
submitted By
summary
work Item Status
work Item Resolution
type
escalation Date
fired Escalation Date
escalation Level
estimated Time
spent Time
subjectName, subjectId
team Name, team Id
release Method
parent Name, parent Id
child Name, child Id
fired Escalation Level
escalation
storyPoints
project Tag
trackerTag
tracker Item Tag
platformName, platformId
custom Field
description
has Review
under Review
upstream/downstream Reference
Grouping
Order
Current Item Placeholder
Filtering Performance Warnings
How to enable/disable the feature?
Availability
Indicators of Performance Issues and the Hints Displayed
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 and Items
Tracker Tree
Tracker Tree Configuration
Tracker Items
About Searching Work Items
In-place Edit of Work Items
Traceability
Copy or Paste Work Item
Field Mapping for Copy/Move Between Trackers
Tracker Item Details
Adding Comments
Adding Associations and Dependencies
Copy or Move Children Items
History
Reminders
Creating Items from Templates
Workflows
Tracker Dashboards
Create or Customize Trackers
Import Data into a Tracker
Navigating to Work Items
Remarking Table View Result
Selecting Work Items
Tracker Types
Area
Bug
Change Request
Component
Configuration Items
Contact
Document
Configuring the Lock Function
Requiring Notes before Checking in
Publish Documents to Another Tracker
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 Tracker Types
Review Hub Support by Tracker Types
Permissions by License Types
Tracker Relations
Tracker Item Reference Settings
Propagate Suspects: Reference
Setting Default Reference Settings Per Field
Reference History for Fields
Managing Associations
Propagate Suspects - Associations
Work Item Traceability
Tracker Inheritance
Changed Behavior in Inheritance
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
Organize Public Views
Tree Structure and Functions
Properties and Delete Icons
Save Public Tracker View into a Folder
Traceability Table View
Create a Traceability Table View
Edit a Traceability Table View
Delete a Traceability Table View
Traceability Tree View
Hierarchical Table View
Show More Function in Traceability Table View
Traceability Document View
Create a Traceability Document View
Edit a Traceability Document View
Delete a Traceability Document View
Traceability Document View Tree Drag and Drop Guide
Displaying Ancestor Items by Default in Document and Document Edit View
Traceability 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
General Tab
Permissions for Trackers and Items
Custom Fields
Choice Fields and Multiple Choice Fields
Creating a New Choice or Custom Field
Table Fields
Reference Fields
User and Project Reference Fields
Configuring Reference Fields for Trackers and Work/Config Items
Repository Reference Fields
Combined Choice Fields
Wiki Link or 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
Unsupported Functions in Reports and Filters
Computed Field Dependencies
Alternatives to Computed Fields
Locking a Tracker
Tracker Audit Trail
Adding Time Tracking to Existing Projects
Delete a Tracker
Item Details: Children and Associations
Mass Edit
Mass Edit Configuration
Effects of Configuration Parameters
Risk Matrix Diagram
Customizing Likelihood and Severity as Choice Fields in a Risk Tracker
Dynamic Pick-List Fields
Standard Distribution and Aggregation Rules
Recommended Combinations of Distribution and Aggregation Rules
Cascading Fields: Dependencies Between Different Fields of the Same Item
Initializing Fields of New Downstream References
Release Management with Codebeamer
The Release Dashboard
Adding, Updating and Deleting Releases
Creating Baselines from Releases
Breaking Releases into Sprints or Sub-releases
Tracking Releases: Progress Reports
Tracking Releases: Work Items
Completing Releases
Releases Roadmaps
Generating Release Notes
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
Create a New Baseline
Send a Custom Email to Specific Recipients
Remove Attachments from the Item
Assign Staff According to Selected Target Projects
Validate the User Signature
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
Trigger State Transition
Export a Tracker Item
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 for Work Items
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 Formulas
Copy Work Item Link
Reference Selector
About Streams
Main Concepts in Streams
Viewing Streams
Viewing Projects in a Stream
Access-Based User Interface Options for Streams
Creating Streams
Adding Projects to an Existing Stream
Adding Trackers to an Existing Stream
Editing Streams
Editing the Properties of a Stream
Copying a Configuration
Merging Trackers into Streams
Stream Baselines
User Interface Options for Stream Baseline
Stream Baseline Permissions
Creating Stream Baseline
Viewing Stream Baselines
Editing Properties of Stream Baseline
Deleting Stream Baselines
Browsing Stream Baselines
Baselines
Creating Baselines
Browsing Baselines
Sorting and Filtering Baselines
Editing Baseline Properties
Locking Baselines
Deleting Baselines
Comparing Baselines
Filtering and Exporting Tracker Differences
Requirements Interchange Format (ReqIF)
Exchanging Data via ReqIF
Import ReqIF into Streams as a Non-Administrator User
Import of ReqIF Data
Create a New Project from ReqIF Data
Email Notifications When Creating 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 Streams
Tracker View-Based ReqIF Export
Loading Saved Configurations
ID Definitions
Operation
Porting
Exporting from Doors into ReqIF File
Field Value Management During Round-Trip ReqIF Export and Import
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
About Review Hub
Merge Requests
Multi select stylesheet
About Page View
About Permanent Links
Hotkeys
Codebeamer RM: Requirements Management
Document View for Requirements
Navigating in Document Views
Organizing the Items
Linking Requirements with Test Cases
Configuring the Test Library
Generating Test Cases
Working with Releases
Working with Items
Item Properties
Creating Downstream References
Creating Downstream References Using Recently Used Trackers and Applicable Trackers
Transition Menu
Associations and References
Suspected Links
Context Menu
Compact Mode
Filtering
Tree Settings
Rating
Baselines
Limitations in the Document View
Requirements Library
Reviewing Suspected Links
Mass Processing Suspected Changes
Document Edit View
Requirements 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 from Excel
Automatic Mappings of Fields
Exporting and Importing Work Item Parent-Child Hierarchies
Multi-Language Support in Excel Round-Trip
Excel Round-Trip Limitations and Issues
FAQ-Excel Round Trip
Configuring Excel Export Default Settings
Round-Trip Editing TestCases in Excel, and Importing and Exporting TestCases from Excel or Word
Excel Multi-Choice and Multi-Value Import
Word Round-Trip
Word Round-trip Workflow
Known Limitations and Issues
Microsoft Project Export-Import and Roundtrip
Exporting to a Microsoft Project
Mapping of Codebeamer Fields to MS-Project Fields
Item Description and Hyperlink to Item
Scheduling: Dates, Durations, and Progress
Converting Between MS-Project Durations and Hours in Codebeamer
User and Role Assignments to Resources
Exporting Dependencies
Priority Mapping
Exporting Story Points
Export of Other Codebeamer Properties as Custom Fields
Known Limitations of Exporting to MS Project
Importing from Microsoft Project
Mapping Fields During Import
Creating New Work Items from MS Project Tasks
Scheduling Fields: Start and End Date, Planned Effort and Spent Effort
Importing Parent-Child Hierarchy
Importing Dependencies
Assignments
Traceability Report
Preset Migration
Import from Microsoft Word
Define Import Rules
Overwrite Rules
Import Work Items
Troubleshooting
Fixing a Failed Word Import
Importing WMF and EMF Content from Word
Importing Tables from Word Documents
Examples: Preparing Word Documents using Macros
Importing Multiple Items including Rich Content and Images from External Sources
Enabling Pure Variants Widget in Codebeamer
Viewing Pure Variants Restriction and Calculation Expressions in Codebeamer
Codebeamer QA: Test Management
Glossary
Creating Test Cases
Test Steps Editor
Custom Test Step Fields for Test Cases and Test Runs
Test Steps Attributes
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
Assigning Test Cases to the 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 the 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 a 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?
Rerunning Already Finished Tests
Re-running Tests
Rerunning Finished Tests Selectively
Test Parameterization
Overview of Test Results
Exporting Test Results to Microsoft Word
Analyzing Test Results and Coverage
Configure Coverage Browser Behavior
Test Coverage
Computation and Meaning of the Coverage Column
Filtering in the Test Coverage
Filtering in the Test Run Browser
Coverage Statistics
Sharing the Test 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 the Document Manager
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 Test Run
Running a Test Several Times Driven by Parameter-Values
Skipping Some Test Parameters and Partly Passed Result
Reporting Bugs for Parameterized Test Case Runs
Reviewing Results for Parameterized Tests
Parameterized Tests and the Test Coverage Browser
Configuring Existing Test Case and Test Set Trackers for Parameterization
Parameter Resolution Algorithm: 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 such as cbQL Results or Any Plugins' Result
Reference Test Cases and Test Step Reuse
Reusing Test Steps
Referencing 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
Pre-Action and Post-Action Reuse via Copy
Reference Test Case
Pre-Action and Post-Action Reuse with Global Stereotype
Running Tests Outside of Codebeamer: Run in Microsoft Excel
How to Run-in-Excel: Exporting the Tests for Running Outside
Limitations of Run-in-Excel Functionality
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
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 Existing Projects
Sharing Managed Repositories
Managing Access Permissions by Roles
Configuration Note
Customizing SCM Hook Scripts
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
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 Configure 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
Setting New SCM User Keys in the User Account
Webhook
Connecting External SCM Services in Codebeamer
Background Processes and UI Actions
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
Release, Sprint, and Backlog
Planner Scopes
Navigating between Planner, Kanban Board and Release 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 and 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 Kanban Board
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 Rational Publishing Engine (RPE)
Document Studio
Document Builder
RPE in 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
DOORS Bridge Installation
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 Customized Excel Templates
Managing Excel Templates
Writing Excel Templates
Accessing Custom or Customized Fields by Their Labels
Accessing and Formatting Custom Date Fields
Choice Option Fields
Multichoice Fields
Available Variables in Scripts
Explicit Processing of Collections and Content Filtering
Available Tags
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 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
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
Advanced Word Export
Tracker Item as a Template Configuration Parameter
Query 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 Behaviors and Issues of Word Export
Known issues of Word export on Docker
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
Codebeamer Administrator Guide
Codebeamer Maintenance
Managing Users and User Groups
Managing Groups
Managing Access to Personal Data
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
Limitations of the Anonymous User Access
Logged In User Information
User Registration Options
Encrypting Sensitive User Data
Synchronizing LDAP/Active Directory Groups
OAuth Consumer Keys
Maintaining Projects
Viewing All Existing Projects
Deleting Projects
Storage of Deleted Documents
Maintenance mode
Database Migration to PostgreSQL
Database Migration
Database Migration from PostgreSQL 12.x to PostgreSQL 16.x
Database Migration from PostgreSQL 16.x to PostgreSQL 17.x
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 Licensing
Licensing with FlexLM
Installing FlexNet Servers
Installing FlexNet Server on Windows OS
Installing FlexNet Server on Linux OS
Installing FlexNet License Server on Red Hat Distributions
Installing FlexNet License Server on Ubuntu
Obtaining Codebeamer Legacy Licenses
Activating and Editing Codebeamer Legacy Licenses
Assigning Licenses to User Accounts
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
Data Obfuscation Tool
Import and Export Codebeamer Database with Oracle
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
Data Inconsistency Corrector Module
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
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
Codebeamer Performance Test Result
Oracle General Performance Test
Document View Performance Test and comparison
Optimizing Codebeamer Performance
Performance Monitoring
Sequence Utilization Monitoring
Codebeamer Computational Statistics
Codebeamer Audit Trail
General Security Awareness
General Data Protection Regulation (GDPR)
Codebeamer Integrations with External Services
Codebeamer Integration with MATLAB Modeling Connector (MMC)
Requirements to Use MMC
Installing and Uninstalling the Codebeamer Toolbox in MATLAB
Codebeamer Project Setup
Configuring the Codebeamer Toolbox
Configuring SSO for MMC
Linking Codebeamer Requirements to Simulink or Stateflow
Linking Codebeamer Requirements to System Composer
Linking Codebeamer Requirements to Data Dictionary
Linking Simulink or System Composer Test Cases to Codebeamer Requirements
Creating or Updating Backlinks in Codebeamer
Checking Codebeamer Requirement Consistency in a Simulink Model
Handling Obsolete and Reused Simulink Blocks in Codebeamer
Batch Synchronizing Simulink Model and Test Data to Codebeamer
Limitations of the MMC Integration
Fixed Bugs for MMC
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
Deprecated Codebeamer Integration with Slack
Developer Guide
Codebeamer Architecture
Single Server Architecture
Benefits of Using Single Server
Start Codebeamer on a Single Node
Cluster Architecture
Benefits of Using a Cluster Architecture
When to Use a Cluster Architecture
System and Network Configuration
Configuring a Server as a Worker Node in a Cluster
Load Balancer Configurations
Cache Replication
Sharing Directories Using NFS
Setting up Cluster Environment
Running a Codebeamer Cluster with Docker-Compose
Sample Docker-Compose with One Load Balancer and No Worker Node
Sample Docker-Compose with Two Load Balancers and n Worker Nodes
Executing the Cluster Cache Configuration Test
Scaling and Recovery
Use Cases
Development
Single Node Vs Cluster
Session Replication
Cache Replication
Resource Lock
Application Logging
Transitioning Between Cluster and Single Node Setups
Debugging, Monitoring, and Upgrading Codebeamer
About the Read-only Replica Database
Configuring the Read-only Replica Database
Glossary
Codebeamer Development
Codebeamer Extension and Plugin Development Summary
REST API (v1)
Accessing resources
Data description
Data Interchange
System
Users and User Groups
Roles
Projects
Documents (Directories/Folders, Files)
Wiki Pages
CMDB
Category Views
Trackers
Tracker Views
Tracker/CMDB Items
Item Reviews
Test Management
Associations
Client side implementations
Java Sample Implementation
.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)
Setting Up Your IDE for Plugin Development
Implementing the Plugin Class
Compiling and Deploying the Plugin
Testing the Plugin
What is Next?
Developing Wiki Plugins: The AbstractCodeBeamerWikiPlugin Class (Part 2)
Open Source Wiki Plugin Samples
Deploying Wiki Plugins for Codebeamer
Debugging Wiki Plugins for Codebeamer
Compiling Wiki Plugins for Codebeamer
Dashboard API
Widget Development and Deployment Quickstart Guide
Computed Fields
About the Technical Details of the Expression Language in Computed Fields
Extending the Expression Language with Custom Functions
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
Key Considerations for Library Upgrades
Codebeamer Developer Tools
Docker
Building a Docker Image for Codebeamer
Docker Compose for Evaluation with PostgreSQL Service
Docker Compose for Testing OpenID Setup
Docker Compose with Oracle
How to Run Docker Container with External Volumes
Running Codebeamer and Pure Variants Using Common Docker Template
Configuring SSO to Run Codebeamer and Pure Variants Using Common Docker Template
Configuring External Services to Run Codebeamer and Pure Variants Using Common Docker Template
How to Set Up SSL for Codebeamer
How to Replace Log4j Jars in Docker Container
How to Add Arial Unicode MS and other Fonts to Docker Image
With Docker-Compose
How to Create a Backup
Designing APIs Using Swagger
Codebeamer Swagger APIs Usage Policy
Using the Swagger Documented - REST-Based API
Using the Swagger API
Swagger V3
Inheritance and Abstract Models
Swagger V3 Examples
Authentication
Web-based Authentication
Discovering the Project Structure
Project Information Example
Tracker Information Example
Tracker Field Information Example
Tracker Item Operations
Tracker Item Model Structure
Custom Fields Example
Modifying Tracker Items
Tracker Item Lock Operations
Other Tracker Examples
Report Operations
Association Operations
Test Case Management
Review Hub
Wiki Information
Swagger v3 Migrations
Swagger V3 General Concepts
Swagger v3 Export to Word Support
Swagger v3 Background Job API Changes
Swagger v3 Tracker API Changes
Swagger V3 Tracker Item API Changes
Swagger V3 Permission Changes
Swagger V3 Stream API Changes
Update the Branches of a Stream
Project-Level Stream Information
Stream Information
List the Trackers in a Stream
List Streams
Map Tracker Items to a Stream
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 V3 User API
Swagger V3 - Get User
Swagger V3 - Get User by Email Address
Swagger V3 - Get User by Name
Swagger V3 - Search Users
Swagger V2 Examples
Query a Tracker Item with a Specific cbQL Query
Date Related QueryString Examples
Create a Tracker Item with Commonly Used Fields
Create a Tracker Item with Custom Fields
Create a Tracker Item with Custom Table Field
Create a Tracker Item with Custom Positioning
How to update multiple fields of a tracker item
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
Review Hub Workflow Actions
Review Report Generator
Codebeamer Installation Guide
Codebeamer Installation
General Hardware Requirements
Important Files and Directories
Database Specific Configurations
Database Installation and Configuration
Preparing Oracle Database for Installation
Preparing PostgreSQL Database
Installing Codebeamer
Installing Critical Patch Sets
Configuring a Cryptography Key for Linux Installer
Migrating Codebeamer Encryption from DES to AES
Changing the Cryptography Key in Codebeamer
Changing the Encryption Configuration
Parameters for Linux Installer
Codebeamer Upgrade
Upgrading to Codebeamer 3.2.0.0
Upgrading to Codebeamer 3.2.0.0 Automatically with the Upgrade Script
Setting Omit Merge
Upgrading Working-Sets to Streams
Upgrading to Codebeamer 3.2.0.0 Manually
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)
Codebeamer Configuration
Updating the Codebeamer Configuration Properties File
Post-installation Configuration
Configuring Ant for Codebeamer: Builds in Separate JVMs
Configuring Math Plugin for Codebeamer: Mathematical Formulas
Configuring PhantomJS for Codebeamer
Configuring Tomcat for Codebeamer
Changing Tomcat Context Path
Changing the Context Path of Codebeamer
Upgrade Codebeamer with different context path
Generic Apache Specific Configuration
Configuring Apache: httpd Proxy on CentOS Without Using SSL
Example for Configuring Apache as a Reverse Proxy
Context Path
Websocket
Setting up SSL on Apache Server
Using Subversion with Codebeamer
Configuration Example of Installing Apache on Ubuntu
Configuring Apache on RHEL Linux
Configuration Using Docker-Compose
Configuring External Executable Paths
Configuring which Files can be Uploaded to Codebeamer
Installing a Missing JDBC Driver
Testing Active Directory Connection
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
Importing Data from Excel Files into Codebeamer
Preparing Your Excel Data for Import
Importing Data into a Tracker
Importing multiple sheets
Structure of the Import Data
Mapping Data to Codebeamer Fields
Automatic and Type-Safe Mapping
Updating Existing Work Items
Different Data Mapping for New and Existing Items
Default Date and Number Formats
Skipping Certain Cells
Value of Unmapped Fields
The Value of Empty Cells
Importing Hierarchies
Special Mapping: Importing Comments
Data conversions options
Previewing Converted Import Data and Correcting Issues
Data Conversions
Test Case and Test Step Import
Mapping Table fields' columns to Excel data
Converting HTML Table Data to Table Field
Reviewing if Mapping and Conversion is Correct for Table Cells
Specialized Converters for Table fields
Splitter table converter
OneColumnFromCSVCellLoader Table Converter
"OneColumnFromHTMLTableCellLoader" table converter
Importing Images from Excel
FAQ and Hints/Tips
Troubleshooting
Migrating an Existing Codebeamer Installation to a New Host
Service or Help Desk Computer Telephony Integration (CTI)
Application Configuration
"apiThrottling"
"applicationApi"
"audit"
"background"
"backgroundServers"
"breadcrumbs"
"cbSystemProperties"
"commentsAndAttachmentFieldPermissionConfig"
"computed-update"
"computedFieldStatistics"
"cryptography"
"CTI"
"database"
"date"
"dbperf"
"deployment"
"diffView"
"diskSpaceVolumes"
"document"
"documentManagement"
"drillDownIntoTracker"
"editInGoogleCloud"
"editInMicrosoftCloud"
"emailPreferences"
"excelExport"
"excelImport"
"externalScripts"
"features"
"fileCache"
"GeoIP"
"helpCenter"
"hierarchy"
"ie-strict-mode"
"installation"
"interactive"
"IPFilters"
"jiraRemoteServerConfig"
"jvm"
"latexPlugin"
"LDAP"
"licenses"
"listeners"
"login"
"mail"
"massEdit"
"metadatas"
"monitor"
"notification"
"officeedit"
"pageView"
"pagingConfig"
"pdfHandler"
"planner"
"projectAuditConfig"
"projectImport"
"projectsDir"
"pvWidgetConfig"
"query"
"referenceField"
"releaseDashboard"
"report"
"reports"
"ReqIF"
"review"
"scc"
"search" and "indexer"
"securityHttpHeaders"
"serviceDesk"
"session"
"signature"
"sql"
"sqlDebug"
"sysadmin"
"testCoverage"
"testManagement"
"traceability"
"tracker-filter"
"trash"
"uploads"
"urlValidator"
"validatorConfig"
"webSecurity"
"websocket"
"widget"
"wiki"
"wordExport"
"wordExport.pdfConvertMethod"
"workflowAction"
"workingset"
Application Configuration via Environment Variables
"env.properties" file
Application Logging
Database Connection Pool Parameters
SQL Database Timeout
Codebeamer Authentication with SiteMinder
Single Sign-On (SSO)
OpenID Connect (OAuth2)
OpenID SSO with Entra ID
OpenID SSO with PingFederate
OpenID SSO with Okta
SAML
Setting Up SAML with Azure AD (Azure Active Directory)
Setting Up SAML with PingFed
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
Codebeamer X Overview
Logging in to Codebeamer X
Switching between Codebeamer X and Codebeamer User Interfaces
Codebeamer X User Interface
Logging out of Codebeamer X
Open Links in New Browser Tab
Codebeamer X: Common Operations
Filtering
Standard Filter
Traceability Filter
Column Filter
Searching
History of Recently Viewed Items
cbQL
Managing Your Account
Managing Users and User Groups
Managing Groups
Managing Access to Personal Data
Dashboards
Dashboards User Interface
Widgets
Report Visualization
Project
Agile
Test
Others
Managing Projects
Role Based Access Control
Project Browser
Projects User Interface
Tabs
Cards on the Project Browser
Creating a New Project
Project Settings
Managing Project Categories
Adding a New Group to the Project
Managing Project Members
Administering Projects
Adding a New Member to a Project
Members and Roles
Customizing Roles
Remove Members from Project
Removing/Deleting Projects
Project Admin Approval Workflows Tab
Project Audit Trail Tab
Project Admin SCM Settings
Administering External SCM Access
Configuring an External CVS Repository
Configuring External Git Repository
External Repository Access Through SSH
Instrumenting External Repositories
Synchronization with the SCM System
Code Parsing Options
Building Communities Around Your Projects
Project Import and Export
Exporting and Importing a Project as a Project Template
Wiki
Wiki User Interface
Wiki Left Pane
Left Pane Context Menu
Wiki Content Pane
Content Pane Context Menu
Editing Wiki Page
Wiki Page Properties
Editing Wiki Pages with Microsoft Word
Froala Editor Limitations, Feature Requests and Bugs
Using Pictures in Edit via Office
Advanced Wiki Management
Diagram Editor
Creating and Inserting Diagrams
About Email Notifications: Receiving Emails from Codebeamer
Custom Email Processing Using Scripts
Email Delivery Customization
Email Integration: Sending Emails to Codebeamer
Configuring Codebeamer to Read Emails
Configuring Trackers and Forums to Read from Inboxes
Reports
Reports User Interface
Create a New Report
Saving the Report
Editing Reports
Result Table
Report Jobs
Filtering Reports
Additional Filters
Trackers
Access Control
Tracker Tree User Interface
Tracker Items List View
Table Operations in Trackers List view
Upstream and Downstream Reference Arrows in Tracker Views
Editing Reference View Settings
Create a Tracker
Details Panel
Submitting a New Work Item
About Searching Work Items
In-place Edit of Work Items
Editing Tracker Items
Tracker Item Children and Associations
Adding Comments and Attachments
Adding Associations and Dependencies
History
Associations
Propagate Suspects - Associations
Traceability
Edit via Office
Change Display Mode
Using Copy and Move Operation for Tracker Items
Selecting Work Items
Field Mapping for Copy/Move Between Trackers
Copy or Move Item Children
Navigating to Work Items
Workflows
Import Data into a Tracker
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 Tracker Types
Review Hub Support by Tracker Types
Permissions by License Types
Displaying Ancestor Items by Default in Document and Document Edit View
Traceability Document/Table View Limits
Tracker Configuration
General
Permissions
State Transitions
Add Status
Guard
Condition
Actions
Fields
Field Layout and Content
Creating New Fields
Field Permissions
Choice Fields and Multiple Choice Fields
Reference Fields
User and Project Reference Fields
Trackers Reference Fields
Repository Reference Fields
Combined Choice Fields
Wiki Link or URL fields
Date Fields
Shared Fields
Subscribe Tracker Notifications
Audit Trail
Layouts
Notifications
Risk Management
Adding Time Tracking to Existing Projects
Tracker Views
Manage Tracker Views Menu
Saving a New View Using Column Filters
Filter Widget on Baseline Mode
Pagination
Tracker Relations
Tracker Item Reference Settings
Propagate Suspects: Reference
Setting Default Reference Settings Per Field
Associations
Propagate Suspects - Associations
Tracker Inheritance
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
Unsupported Functions in Reports and Filters
Alternatives to Computed Fields
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
Cascading Fields: Dependencies Between Different Fields of the Same Item
Initializing Fields of New Downstream References
Release Management with Codebeamer X
The Release Dashboard
Adding, Updating and Deleting Releases
Breaking Releases into Sprints or Sub-releases
Tracking Releases: Progress Reports
Using Filters in Releases
Completing Releases
Releases Roadmaps
Tracker Item Children and Associations
Workflow Actions
Update Item Properties
Update Referring Items
Create New Upstream-Downstream Referring Items
Create a New Sequential Id
Create a New Baseline
Send a Custom Email to Specific Recipients
Remove Attachments from the Item
Validate the User Signature and 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 Use the Signature Generation
Mass Review
Trigger State Transition
Export a Tracker Item
State Transitions
Custom State Transition Predicates
Context Specific Predicates
Deploying State Transition Predicates
Requesting Authentication-User Signature for a State Transition - e-Signature
Workflow Events
Hide If and Mandatory If Formulas
Copy Work Item Link
Tracker Workflow
The Review Hub
Initiating Reviews
All Reviews Page
Permissions and Licensing
About Review Creation
Creating a Review
Editing a Review
Setting Item Status Thresholds
Filtering in Review Hub
Reviewing Items
Review Tab
References of Review Items
Comments Tab
Statistics Tab
History Tab
Signing a Review
Finishing the Review
Restarting a Review
Initiating Restart Review
Adding and Removing items from the Current Review
Rejecting a Review Item
Review Templates
Creating a Review Template
Editing a Review Template
Creating Actionable Items from Review Findings
Exporting Review
About Review Administration
Document Tracker
Accessing Document Tracker
Document Tracker User Interface
Document Tracker Toolbar
Document Tracker Content Pane
Document Operations
Versioning and Access History
Publish Documents to Another Tracker
Office Edit
Office Launcher Installation
Cloud Edit
Microsoft OneDrive Integration
Using the Microsoft OneDrive Integration
Troubleshooting Guide for the Cloud Edit Integration with Microsoft OneDrive
Limitations for the Cloud Edit Integration with Microsoft OneDrive
Google Drive Integration
Using the Google Drive Integration
Troubleshooting Guide for the Cloud Edit Integration with Google Drive
Limitations for the Cloud Edit Integration with Google Drive
Traceability Browser
Preset Migration
Baselines
Creating Baselines
Browsing Baselines
Deleting Baselines
Comparing Baselines
Exporting Tracker Differences
Baselines in Document View
Baseline Comparison in Document View
Baseline Comparison Details Panel in Document View
Requirements Interchange Format (ReqIF)
Exchanging Data via ReqIF
Importing ReqIF Data
Create a New Project from ReqIF Data
Email Notifications When Creating 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
Importing ReqIF Data
Asynchronous ReqIF Import in Background
ReqIF Import History
Export Data as ReqIF
Exporting Project Contents
Respond to a Previous Import
Asynchronous ReqIF Export in Background
ReqIF Export History
Tracker View-Based ReqIF Export
Loading Saved Configurations
Configurable ReqIF Base ID
ID Definitions
Operation
Porting
Exporting from Doors into ReqIF File
Field Value Management During Round-Trip ReqIF Export and Import
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
Codebeamer X DOORS Bridge
DOORS Bridge Installation
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
Codebeamer RM: Requirements Management
Document View for Requirements
Document View User Interface
Context Menu
Organizing the Items
Configuring the Test Library
Filtering
View Setup
Working with Requirements Item
Item Properties
Creating Downstream References
Transition Menu
Associations and References
Suspected Links
Reviewing Suspected Links
Requirement Coverage
Requirements Baselining
Requirements Library
Inspecting Changes
Limitations in the Document View
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 from Excel
Automatic Mappings of Fields
Exporting and Importing Work Item Parent-Child Hierarchies
Multi-Language Support in Excel Round-Trip
Excel Round-Trip Limitations and Issues
FAQ-Excel Round Trip
Configuring Excel Export Default Settings
Round-Trip Editing TestCases in Excel, and Importing and Exporting TestCases from Excel or Word
Excel Multi-Choice and Multi-Value Import
Word Round-Trip
Word Round-trip Workflow
Known Limitations and Issues
Import from Microsoft Word
Define Import Rules
Overwrite Rules
Import Work Items
Troubleshooting
Fixing a Failed Word Import
Importing WMF and EMF Content from Word
Importing Tables from Word Documents
Examples: Preparing Word Documents using Macros
Importing Multiple Items including Rich Content and Images from External Sources
Test Management
Glossary
Creating Test Cases
Test Steps Editor
Custom Test Step Fields For Test Cases and Test Runs
Test Steps Attributes
Test Steps Accordion for Test Cases in Document View
Generating Test Cases for Requirements
Organizing Test Cases to Test Sets
Filtering the Test Cases & Sets
Creating Test Sets
Adding or Deleting Tests Cases in Test 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
Assigning Test Cases to the Test Sets
Test Case Library
Test Case Libraries
Initiating Test Runs
Creating Test Runs directly from Test Cases (without Test Sets)
Options for Creating Test Runs
Distributing the Test Run Work Between Multiple Users or Roles
Adding Releases for Test Runs
Adding Configurations for Testing
Adding and Removing Test Cases from Test Runs
Adding Test Cases to a Test Run
Executing Test Runs
Using the 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
Reporting a New Bug during Test Run
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?
Rerunning Finished Tests
Re-running Tests
Rerunning Finished Tests Selectively
Test Parameterization
Overview of the Test Results
Exporting Test Results to Microsoft Word
Analyzing Test Results and Coverage
Configure Test Coverage Behavior
Test Coverage
Computation and Meaning of the Test Coverage Column
Filtering in the Test Coverage
Filtering Test Cases & Test Runs
Coverage Statistics
Sharing the Test Coverage
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 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 Test Run
Running a Test Several Times Driven by Parameter-Values
Skipping Some Test Parameters and Partly Passed Result
Reporting Bugs for Parameterized Test Case Runs
Reviewing Results for Parameterized Tests
Parameterized Tests and the Test Coverage
Configuring Existing Test Case and Test Set Trackers for Parameterization
Parameter Resolution Algorithm: 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
Reference Test Cases and Test Step Reuse
Reusing Test Steps
Referencing 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
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
Pre-Action and Post-Action Reuse via Copy
Reference Test Case
Pre-Action and Post-Action Reuse with Global Stereotype
Running Tests Outside of Codebeamer: Run in Microsoft 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
Exporting and Round-Trip Editing of Test Cases with Test Steps in Excel
Validation of Test Management Configuration
FAQ-QA Test Management
Agile Application Lifecycle Management
Agile Planning
Release, Sprint, and Backlog
Planner Scopes
Navigating between Planner, Cardboard and Release Statistics
Planner User Interface
The Product Backlog
Managing Releases in Planner
Managing Work Items in Planner
Editing Work Items in Planner
Prioritizing Work Items
Estimating Work Items
Assigning Work Items to Team Members
Coloring Items
Generating Sprint Schedule and Next Sprint
Best Practices for Agile ALM
Agile for the Portfolio
Investment Themes
Epics
Integrating Agile with Application Lifecycle Management
Recommended Reading for Agile ALM
Agile for the Program
Agile for the Team
User Stories
Sprints
Releases
Managing Releases and Sprints
Scrum and Kanban for the Enterprise
The Three Levels of Agile
Agile Process Frameworks
Executing Agile
What is a Kanban board
Viewing Items in Cardboards
Kanban Board User Interface
Analysis of a Card
Mapping Issues to Kanban Board
Editing an Item in Kanban
Using Swimlane List
Moving Cards Between Columns
Access Control in Cardboards
Propagating Status in Cardboards
Configuring Cardboards
Word and Excel Templates
Excel Templates
Getting Started: Exporting Customized Excel Templates
Managing Excel Templates
Writing Excel Templates
Accessing Custom or Customized Fields by Their Labels
Accessing and Formatting Custom Date Fields
Choice Option Fields
Multichoice Fields
Available Variables in Scripts
Explicit Processing of Collections and Content Filtering
Available Tags
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 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 References of the Item to Excel
How to Export Work Items Selecting by Status into Different Sheets
Word Templates
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
Word Export Placeholder Listing
Advanced Word Export
Tracker Item as a Template Configuration Parameter
Query Parameters
Template Parameters and 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 Behaviors and Issues of Word Export
Known issues of Word export on Docker
Key Considerations in Codebeamer X
Known Limitations in Codebeamer X
About Codebeamer OSLC DPT Integration
OSLC Overview and Codebeamer OSLC DPT Support
Codebeamer OSLC Server and Client
Server Guide
Requirements Management Domain
Change Management Domain
Common Configuration for Supported Domains
Using the Codebeamer Delegated UI
Tracker and Field Mapping
Configuring Codebeamer Tracker Fields for Preview
Working with External Linked Items
Client Guide
Codebeamer OSLC DPT Integration with IBM ETM
Configuring IBM ETM to Create Codebeamer Links
Binding an IBM Project Area to a Codebeamer Server
Configuring Codebeamer to Display IBM ETM External Linked Items
Configuring Codebeamer Tracker Fields for Preview in IBM ETM
Creating Links from IBM ETM to a Codebeamer Requirement Tracker
Creating Links from IBM ETM to a Codebeamer Requirement Tracker Item
Viewing Requirement Tracker-Linked Items in Codebeamer
Viewing IBM ETM-Linked Test Cases to a Requirement in Codebeamer
Identifying Task Items Marked as Suspect
OSLC DPT Issues and Solutions
Codebeamer Preview Pop-Up Stuck on Codebeamer Login Page in Firefox