codebeamer

Key Features and Benefits

• Allows codebeamer users to find all their work in codebeamer (rather than switching to other applications) — saving time, reducing frustration, and leading to happier, more productive team members
• Synchronizes artifacts across the lifecycle, allowing information to flow freely between codebeamer and other tools
• Supports cross-tool traceability and reporting, removing the need for manual processes and spreadsheets
• Maintains relationships between artifacts, comments, and attachments, as artifacts flow between codebeamer and external tools

Common Integration Patterns

• Populating Requirements into PLM Tools
• Providing Developers with Early Visibility into Requirements
• Associating Planning Items to Implementation Artifacts
• Sharing Stories and Defects between Dev and Test
• Reporting Known Defects to the Help Desk
• Escalating Help Desk Problems to Developers
• Aligning Testing Teams across Testing Tools

Demo Videos

codebeamer X

Planview's codebeamer connector supports both codebeamer and codebeamer X (formerly Intland Retina).

Minimal User Permissions & Hub User

We recommend that you create a new user within your external tool, to be used only for your Hub integration. This is the user information you will enter when setting up your repository connection within Planview Hub. By creating a new user, you will ensure that the correct permissions are granted, and allow for traceability of the modifications that are made by the synchronization. 

In general, your user account should have sufficient permissions to create, read, and update artifacts in your repository. However, depending on the use case, your user may need different permissions. For example, if you are only interested in flowing data out of your repository, your user may not need to have full CRUD access, as the 'create' and 'update' permissions may not be needed.

Your user should have a secure password or token. Please be aware that Hub will not allow you to save a repository connection utilizing a weak password/token, such as 'tasktop.'

See codebeamer documentation to learn how to create a custom user in codebeamer.

List of minimal user permissions:

• Project admin role

Connecting to the codebeamer Repository

Standard Authentication

Required Fields:

• Location/Connection URL
  • Example Format: https://saas.codebeamer.com or http://example.com:8080/cb
• Username
• Password

Optional Fields:

• Throttling Settings: This field indicates the number of API calls that can be made per minute. See details here.
  • Note: This field should only be set under the guidance of Tasktop support as the ideal value is highly dependent on each customer's unique environment. 
• Connection Security: If checked, insecure connections to this repository will be allowed. See details here.

SSO Authentication

Additionally, codebeamer supports the following SSO implementations:

• Script (HTTP cookies)
• X.509 Certificate

Learn more about how to set up your repository in Planview Hub here.

Rich Text

At present, the connector supports only Wiki formatting for rich text fields. Some, but not all, of codebeamer's rich text markup elements are supported.

Supported elements are: 

• headings
• italics
• bold
• monospaced
• superscript
• subscript
• bulleted lists
• numbered lists
• bulleted lists (in a table)
• numbered lists (in a table)
• hyperlinks (including labels; external links only)
• images (external images only)
• image links (external images and links only)

Comments

At present, codebeamer comments will be stored as Wiki type only. Neither author impersonation nor public/private comments are currently supported.

Learn more about how to configure comment flow in Planview Hub here. 

Attachments

codebeamer uses comments to store attachments. Impersonation of authors is not supported.

Learn more about how to configure attachment flow in Planview Hub here.

State Transitions

In codebeamer, state transitions can have a condition and/or guard. These prevent the transition from being performed if a given set of conditions aren't met (e.g., there could be a condition on the 'Start Progress' transition that will prevent it from being executed unless the ticket has been assigned).

If a guard is set on a transition and the transition is executed, but the guard's conditions are not met, then an error will appear, stating, "Start guard yields false!"

If a condition is set on a transition, but its conditions are not met, then the user will receive an error stating that the transition is not available. 

Learn more about how to configure state transitions in Planview Hub here.

Person Reconciliation

For person reconciliation, the following fields are available:

The person-id can be found on the Personal Details screen for a particular user, in the 'Account ID' field. To find the person-id, take the 'Account ID' number and append it to '/user/'. For example: if the Account ID of a user is 1, then that user's person-id will be /user/1.

Learn more about how to configure person reconciliation in Planview Hub here.

Full Scan

Due to third party API limitations, updates to the following fields may not trigger change detection or cause a synchronization immediately. To ensure these updates synchronize, a high fidelity full scan must occur or another qualifying change must be made to the artifact:

• Associations (Internal)
• Associations (Web Links)
• Downstream References (Relationships)
• Absolute Position
• Predecessor
• Successor

Learn more about how to configure change detection and full scan intervals in Planview Hub here. 

Requirements Ordering

Note: Requirements ordering is only supported for DOORS-codebeamer integrations.

In codebeamer, requirements ordering is supported for tracker types where Document View is supported. 

To function properly, the following fields must be mapped in your integration:

• Absolute Position

• Parent

• Predecessor

• Successor

Additionally, the field flow for the above fields must be set to always update to the target side and conflict resolution must be set to the source side. 

Note: During integration, you may see a large number of errors with the message “Predecessor and Successor are not in the right place yet..." These exceptions should clear with sufficient retries. If not, you will need to trigger a full scan through the “Process All Artifacts” button.

API Rate Limiting

In Planview Hub version 21.4, a new Throttling Settings field was added to limit the number of API calls that can be made per minute to a repository.

By default, the codebeamer repository implements an API rate limit of 120 API calls per minute. To prevent performance issues as described here, you should adjust the limit in codebeamer and the Throttling Settings field in Hub or disable rate limiting.

Special Features Supported

Supported Work Items

Learn about the difference between containers and work items in Planview Hub here.

Supported Containers