Codebeamer Process Documentation

What it does

Organizations using PTC Codebeamer for Application Lifecycle Management often struggle to provide process documentation where teams actually need it - directly within their daily workflow. Important work instructions, compliance guidelines, and process descriptions typically live in separate documentation systems, requiring users to switch context and search for the right information manually.

NANGA Codebeamer Process Documentation (NCPD) solves this by embedding context-aware process documentation directly into Codebeamer’s tracker item view. Relevant documentation is automatically displayed based on configurable rules, ensuring that every team member has access to the right guidance at the right time without leaving Codebeamer.

Quick overview

• Context-aware documentation widgets embedded in Codebeamer’s document view
• Rule-based targeting by project, tracker type, and tracker key
• Rich content rendering with full Codebeamer wiki markup support
• Seamless integration using Codebeamer’s built-in authentication
• Docker-ready deployment with minimal configuration

Problem

In many organizations, process documentation is maintained separately from the tools where work actually happens. Teams working in Codebeamer must leave their current context to find relevant work instructions, compliance requirements, or process guidelines. This leads to:

• Reduced productivity due to constant context switching
• Inconsistent adherence to processes because documentation is not easily accessible
• Difficulty ensuring that the right documentation reaches the right people
• No way to target documentation to specific project contexts, tracker types, or workflows

Solution

NCPD extends Codebeamer with two embedded widgets that work together to deliver process documentation directly where it is needed.

Settings Widget

Displayed on items within designated documentation trackers, the Settings Widget allows administrators to define rules that control which tracker items should display a specific piece of documentation. Rules can filter by project, tracker type, and tracker key, and are combined with AND logic for precise targeting.

Documentation Widget

Displayed on all other tracker items, the Documentation Widget automatically queries the system for all documentation entries whose rules match the current item. Matching documentation is presented as expandable cards with rich content rendering, making process guidance immediately accessible.

Example

A documentation administrator creates a tracker item titled “Code Review Process” in a designated documentation tracker. Using the Settings Widget, they configure a rule that targets all items in the “Development” project with tracker type “Task”.

When any developer opens a Task in the Development project, the Documentation Widget automatically displays the “Code Review Process” documentation entry. The developer can expand the card to read the full process description with formatted text, links, and structured content without ever leaving Codebeamer.

Key features and technical specifications

• Native Codebeamer document view widget integration
• Rule-based documentation targeting (project, tracker type, tracker key)
• AND/OR rule combination logic for precise targeting
• Rich content rendering with Codebeamer wiki markup support
• Automatic documentation matching with no manual user action required
• Expandable and collapsible documentation cards
• Seamless authentication via Codebeamer Widget API (JWT)
• Docker container deployment
• Configuration via environment variables
• REST API for rule management and item matching

Contact

NANGA SYSTEMS GmbH (Germany), Luise-Ullrich-Straße 20, 82031 Grünwald, Germany
NANGA SYSTEMS Ltd. (UK), Unit 4 Riverside Court, Beaufort Park, Chepstow NP16 5UH, United Kingdom
NANGA SYSTEMS GmbH (Austria), Auhofstraße 63-65, 1130 Vienna, Austria
www.nanga-systems.com