You are not logged in. Click here to log in.

codebeamer Application Lifecycle Management (ALM)

Search In Project

Search inClear


This page provides a general introduction about the codebeamer wiki and its main features.

What is a Wiki?

A wiki is a collection of interconnected pages with a simple text based syntax for formatting. Wiki pages support hyperlinks to other pages. Wikis are also used as a knowledge sharing tool that allow users to add, remove, or otherwise edit and change all content.

To better understand the concept of the wiki, see Wiki.

See also Wiki Markup and Plugins

The codebeamer wiki implementation includes many source code modules and ideas from the Open Source JSPWiki system. It uses the same Wiki syntax, and many JSPWiki plugins were implemented and ported to codebeamer.

codebeamer Wiki

The wiki implementation built-into codebeamer is an enterprise-grade tool that helps users capture and manage knowledge in an open, scalable, secured and controlled way. Interrelated artifacts, such as trackers, office or wiki documents, or tasks, can be as structured to satisfy various user needs while allowing a large degree of artifact inter-connectedness.

The wiki can be customized by using the open-source codebeamer plugins and writing own plugins if necessary to create a more effective work environment. For example, a plugin could be created to identify the dependency structure, or a graph of artifact inter-relatedness, and so on.

codebeamer wiki allows, for example, the information-flow to be as democratic as a wiki system used by communities, but it also offers the setup of structured document approval mechanism to implement publication processes.

Efficient communication is a key factor in any successful development project, and the wiki can be used to collaborate and to prevent communication problems.

Each project has a separate wiki space accessible on the Wiki tab.

A wiki space consists of individual wiki pages that can be organized into a hierarchical structure, cross-referenced in various ways and also browsed by navigating along the links.

Besides maintaining the content of wiki pages, users can:

  • Set up access rights.
  • Set up approval workflows.
  • Set up notification settings.
  • Add comments.
  • Add attachments.
  • Check the page history and restore preceding versions of the content.
  • List child pages.
  • Change permissions based on roles or groups.

Wiki Page Structure

codebeamer wiki pages are built up of three main sections:

  • Wiki Structure Tree
  • Content
  • Fast Links

Structure Tree Section

The wiki structure tree:

  • Is located on the left-hand side of the page.
  • Can be closed or opened by clicking on or .
  • Displays the full wiki structure from the root wiki page of the project.
  • Allows users to expand or collapse parent wiki pages to show or hide child pages.
  • Is horizontally resizable by hovering the cursor over the right vertical separator line.
  • Supports horizontal and vertical scroll bars.
  • Has a Type to filter field to search for pages based on keywords.

Further settings can be applied by clicking on (Settings):

Highlight recently updated Wiki pages - if the Day limit field is empty, or its value is 0, the feature is disabled. In case the modification of a wiki page is not older than the specified day, the related wiki page is highlighted in green color.

Show heading numbers - headings are automatically numbered by codebeamer which are visible after saving the content on a wiki page. Select the checkbox to enable this feature.

Documents exported from the wiki do not contain the generated heading numbers regardless the feature is enabled or not.

Search In options (Wiki Page name, Wiki Content, Wiki id) - select the relevant checkbox to enable the coloring feature that highlights the results with different colors when searching within the wiki.Changes can be finalized by clicking on [Save].

Content Section

The content section is located in the middle part of the page.

A toolbar is available on the top left of the content section:

Icon Icon Function Description

Edit Compose a new document, or modify already existing wiki pages.

New Child Page Create a new child wiki page under the selected parent page.

New Child Dashboard Create a new child dashboard within the project dashboard.

More Further setting options.

Fast Links section

A navigation section on the right-hand side of the wiki page with various links to:

  • codebeamer Overview
  • codebeamer Knowledge Base
  • Services

Creating and Editing Content

The wiki content is saved in Wiki markup syntax which is a simple and flexible language to produce clean and structured online information.

Besides the basic text elements (for example, paragraphs, headings), codebeamer offers more advanced options (for example, tables, inline images) and additional markup constructs targeting the developer audience.

codebeamer allows the creation of new documents as well as the editing the contents of existing wiki pages.

Creating Content on New Wiki Pages

To create a new wiki page within a project, click on (New Child Page).

The Add new child Wiki page overlay is displayed where the title of the page and the content can be added.

The toolbar on the bottom left of the editor offers a number of formatting, inserting and view options. To save the changes made on the page, click on the [Save] button.

Editing Existing Wiki Pages

  • To edit the content of an existing wiki page, click on the name of the page in the Wiki Structure Tree section ► click on (Edit).
  • The Updating Wiki page overlay is displayed, allowing the editing of the content with various formatting, inserting and view options available via the toolbar.

  • To finalize the modifications, click on [Save].


The content of wiki pages can be edited, formatted with the help of the Toolbar located at the bottom left of the page being edited.

  • Formatting Options
  • Advanced Options
  • Link Options
  • Upload File
  • Emoticons
  • Rich Text Options
Formatting Options

Click on the icon to choose from the Formatting options available:

  • Bold
  • Italic
  • Underline
  • Strikethrough
  • Monospace
  • Paragraph Format
    • Normal
    • Heading 1
    • Heading 2
    • Heading 3
    • Heading 4
    • Heading 5
    • Preformatted
    • Blockquote
  • Background color
  • Text color
  • Unordered List
  • Ordered List
  • Decrease Indent
  • Increase Indent
  • Paste as text
  • Clear formatting
  • Undo
  • Redo

Advanced Options

Click on the icon to see the list of the advanced options available:

  • Insert Table
  • Create Work Item
  • Insert Wiki Markup - See also: Wiki Markup and Plugins
    • Insert Wiki Markup
    • Insert Information
    • Insert Warning
    • Insert Error
    • Insert Preformatted
    • Horizontal Line
    • Add Attached Image
    • Table of Contents
  • Add comments
  • Insert or Edit Diagram- See also: Diagram Editor
    • Insert or Edit Diagram
    • Insert from Documents

Link Options

Click on the icon to see the link options available:

  • Link
  • Artifact Link
  • Unlink
Upload File

Click on the icon for the Upload File function.

Since codebeamer 9.4.0, multiple files can be uploaded at the same time using drag and drop or the Upload File icon of the editor.


Click on the icon to see the Emoticons available to be added to the content:

Rich Text Options

Click on the icon to select from the Rich Text options available:

  • Rich Text - use for instant editing. It has familiar word-processing features and buttons to include images and links. It helps to add tables, images, links and easily edit text.
  • Markup - shows the raw text, links, plugins, etc. as stored and interpreted/compiled by the wiki engine.
  • Preview - allows a quick view of how the saved wiki page will look like. This view is not editable.

The Preview does not refresh the Table of Contents and other wiki plugin contents.

Mentioning Members, Teams, Areas

Since codebeamer 9.4.0, project Members, Teams, Areas can be mentioned within the rich text editor by adding the @ character and the first few characters of the name of the Area, Team or Member.

Performing the above, an autocomplete overlay is displayed where the designated Member, Team, Area can be chosen from:

Mentioning Members, Teams or Areas within the Rich Text editor area will not trigger email notifications.

Copying and Pasting Wiki Documents

Since codebeamer 5.3, wiki pages and the related children pages can be copied recursively.

To copy a wiki page and its children to the clipboard, select the (More) context menu at the top of the wiki page ► Copy.

To paste the wiki page and its children, go to the (More) context menu of the destination wiki page ► Paste.

The copied wiki page becomes a new child under the (destination) parent page. To see children pages, go to PropertiesChildren tab. Upon pasting, a pop-up window displays the hierarchy of pages to be pasted.

The pasted pages are added as children pages of the target page. Since the target page does not contain references to these new children page, the new children pages are not visible unless the references are added manually to the destination page.

The document numbers of the new children wiki pages are displayed in the URL field after clicking on the relevant child page, and also in a tooltip when hovering the cursor over the name of the child page on the Children tab.

Wiki Page Properties

The wiki page Properties menu can be used for the following purposes:

  • Adding comments and attachments
  • Adding associations
  • Adding links
  • Adding Children pages
  • Viewing page history
  • Viewing document approval
  • Changing permissions

To modify the properties of a wiki page, click on (More) context menu ► PropertiesEdit properties.

  • Name - the name of the wiki page.
  • Owner - the owner, content creator of the wiki page.
  • Status - the status of the page can be chosen from the drop-down list.
  • Description - the page description can be added here.
  • Lock - select the checkbox to lock the page and prevent amendments to be made by other users.
  • Max. Values - Maximum number of versions stored and displayed in the History tab. This value can be set in tab Wiki Max. Versions drop-down list.

By changing from All to another value, the versions excluded by the change will be deleted permanently from the database!

Commenting Pages and Attaching Files

Add questions, answers or notes as comments attached to any page by clicking on Comments & Attachments tab ► Add Comment.

The wiki editor-type pop-up window allows users to add comments and also to browse for documents to attach.

These attachments are used for sharing content with other users and to include in the owner page, for example to display inline images.

Click on the icon to save comments, or files uploaded.


Associations are used to list and add related artifacts (for example, wiki pages, tasks, bugs, functions, etc.).

The Incoming Links tab lists artifacts referring to the current wiki page:

The Outgoing Links tab lists artifacts which the current page contains references to:

Children Pages

Children pages can be organized into a tree hierarchy, using any grouping based on the user demands. When a project is created, only the root of the page tree exists, and it grows as new pages are created.

When editing a wiki page and a new child page is to be created, the simplest way to add a child page is to add the name of the child page between square brackets:


After saving the modifications, a link appears on the wiki page pointing to the not yet existent codebeamer child wiki page.

By clicking on the link, the Wiki Editor overlay is displayed allowing the user to add content to the page.

The wiki page number is assigned once the new child page has content, and the page is visible on the Children tab.

The children pages of a document are displayed on PropertiesChildren tab.


User can subscribe to individual wiki pages to keep track of the changes made by going to PropertiesNotifications.

  • Notify on Read - a notification email is sent each time the related page is read by any user.
  • Notify on Edit - a notification email is sent each time the related page is edited by any user.

Click on [Save] to confirm the subscription.


Wiki page Permissions can be set on user role and group level. Read and Edit permissions can be controlled for each wiki page in a way similar to that of the Document Manager.

To set page level Read and Edit permissions:

  1. Go to PropertiesPermissions tab
  2. Select or deselect the relevant checkboxes to control the Read and Edit permissions for each user roles.
  3. Click on [Save] to activate the settings.

  • To apply the permission settings of a parent page to the relevant children pages, select the Set same permissions recursively on all children. checkbox.
    Deselect to inactivate the function.


This applies to Document Approval feature which is not supported anymore and was completely removed in release 8.0.1.

The Document Approval Workflow approvals for the relevant page are listed on tab Approvals.


The page content is fully audited and versioned. To see details on the page history, click on PropertiesHistory tab.

The below details are displayed on the History tab:

  • Version - shows the version number of the wiki page. The latest version is shown at the top of the list.
  • Created - date and time of the creation of the related version.
  • Created by - the user the changes were performed by.
  • Comment - shows which part of the wiki page was changed.

To see a previous version of the wiki page, click on the relevant version number under the Version heading.

To compare the content of, and see the differences between two versions, select checkboxes of the page versions to be compared and click on the [Compare Selected Versions] button.

The new content is highlighted in green color, while the removed content is displayed with red background.

To restore the page content to a previous version, select the checkbox of the relevant version number ► (more) context menu ► Restore this version.

Click on Display this version to see the content of the page at that stage.

Click on Compare to latest version to compare the content to that of the current page.


To see the list of related Baselines, go to Properties ► Baselines tab.

Two different Baselines can be compared by selecting the related checkboxes and clicking on the [Compare Selected Baselines] button.

See also: Baselines

Importing Items and Wiki Pages from RTF

Importing Requirements from RTF

To create issues from RTF documents, select a requirement type tracker ► click on (More) context menu ► Import.

Rules of importation:

  • Each heading creates a new issue.
  • Heading texts are used as issue summaries.
  • Paragraphs between headings are used as issue descriptions.
  • The hierarchy of paragraphs of original document is preserved. If paragraph B has a smaller heading than paragraph A, issue B is treated as the child of issue A.

Importing Requirements from Non-RTF Documents

codebeamer allows to import .doc and .docx files.

A documentRTFWiki conversion is performed during the import. This requires OpenOffice or LibreOffice to be installed on the server.

The feature is available for importing requirements type trackers only.

  1. Select a requirements tracker.
  2. Go to (More) context menu ► Import.
  3. Select importing from Word or Excel.
  4. Select option Word/Office Documents or Rich Text Format.

Importing Wiki Pages from RTF (Microsoft Word Documents)

codebeamer can convert Rich Text Format files to wiki markup. Click on the Import From Word link to import.

Known Limitations of Importing RTF

  • RTF specification, version 1.9.1 is supported. Documents created in Microsoft Office Word 2003 or newer are supported.
  • Supported image formats: .gif, .png, .jpeg. Other image format (including vector graphics) are not converted.
  • Headings (paragraphs) are detected by their conventional style names: Heading 1, Heading 2, Heading 3, Heading 4, Heading 5. Other text, regardless of font size and style, is treated as a normal text body.
  • For tables, the converter does not support special cell styles (custom background and border color, border width, margins, spacing).
  • Text placed inside vector objects (for example, rectangles) is ignored.
  • Equation formulas are not supported.
  • Microsoft Office-specific list styles are not preserved. List a) b) c) will be converted to 1. 2. 3.

Generating Specification Documents

codebeamer can export issues from requirements trackers into .doc files.

Select the relevant requirements tracker ► moreExport to Word.

The generated document is in MHTML format - a multipart HTML document format that is natively supported by newer Microsoft Word version. The .doc extension makes Word the default editor for created file.

The following properties of the issues are exported to the document:

  • Summary
  • Description
  • Revision
  • Business value (priority)
  • Status
  • Issue references (associated issues, child and parent issues, etc.)

Customizing the Microsoft Word Output

It is possible to freely customize both the content and the formatting of the document generated from requirements.

The output document is in MHTML format.

The content is generated by rendering two Velocity templates. In order to customize the output, modify the following templates:

  • <cb tomcat dir/webapps/cb/config/templates/html/requirement-document-export-body.vm
  • <cb tomcat dir/webapps/cb/config/templates/html/requirement-document-export-headerfooter.vm

The following objects are available in the Velocity context and can be used in template:

Key Class Description
request HttpServletRequest
user UserDto
currentDate Date
project ProjectDto
requirementTracker TrackerDto
requirements SortedMap<ReleaseId, TrackerItemDto> ReleaseId class provides indexing and sorting for requirements.
Use ReleaseId.getRelease()
baseline Baseline Only available when exporting a baselined set of issues.
When exporting the HEAD (the latest revision), it is not available.
wikiMarkupProcessor WikiMarkupProcessor
incomingReferencesByIssue Map<Integer, Map<String, List<TrackerItemDto>>> Keyed first by the item ID, then by the field name and it maps to a list of tracker items.
outgoingReferencesByIssue Map<Integer, Map<String, List<TrackerItemDto>>> Same as the previous.

Generating Documents: Exporting Wiki Pages to PDF, RTF and HTML

The content of wiki pages can be exported to

  • PDF - Suited for printing to paper or for static export. To export a wiki page to .pdf, click on the (More) context menu ► Export to PDF.
    To export more pages to .pdf, use the ExportWiki plugin (see Printing to PDF), or click on the (More) context menu ► Export Multiple Pages to PDF.

  • RTF - To export artifacts wiki page to an .RTF file, use the ExportWiki plugin (Printing to PDF).

  • HTML - To export artifacts to a HTML document, click on the (More) context menu ► Export Multiple Pages to PDF ► select the HTML output

For example, generate a PDF Document from the wiki pages with IDs 1004 and 1005 using the ExportWiki plugin with the following statement put in a wiki:

[{ExportWiki id='1004,1005' format='pdf'}]

The above generates the Export as PDF link on the existing wiki page creating a document when selected:

You must login to see this link. Register now, if you have no user account yet.

Customizing the PDF Output

The ExportWiki plugin offers both content customization and formatting customization options beyond the parameter selections defined in the ExportWiki documentation, however, these require XSL-FO experience.

codebeamer relies on the open source Apache FOP project as print formatter.

codebeamer transforms the HTML output of a wiki page to XSL-FO using the INSTALL_DIR/tomcat/webapps/cb/WEB-INF/classes/xhtml2fo.xsl stylesheet which can be edited to fine tune the output.

Changing the Font Set to Support Asian and Eastern European Languages

For Asian or Eastern European language characters, the formatter needs to be switched to use character sets that support special Chinese, Korean, Japanese, Czech, Hungarian, etc. glyphs.

Four separate font families support such characters in addition to the default Helvetica.

Ensure that exactly one of the font families is activated.

To switch, uncomment the appropriate section in WEB-INF/classes/xhtml2fo.xsl (around line 65) and restart codebeamer:

<!-- Remove this if you want to use Eastern European, Chinese, Japanese or Korean character support -->
<xsl:attribute name="font-family">Helvetica</xsl:attribute>
<!-- Uncomment this for Eastern European support (arial*.ttf) -->
<xsl:attribute name="font-family">Arial</xsl:attribute>
<!-- Uncomment this for simplified Chinese serif character support (simsun.ttc) -->
<xsl:attribute name="font-family">SimSun</xsl:attribute>
<!-- Uncomment this for Japanese serif character support (msmincho.ttc) -->
<xsl:attribute name="font-family">MSMincho</xsl:attribute>
<!-- Uncomment this for Korean serif character support (batang.ttc) -->
<xsl:attribute name="font-family">Batang</xsl:attribute>

Known Limitations of the PDF/RTF Export

Cause Description
FOP limitation Glyphs in Asian .ttf files are available only as normal, no bold or italic. FOP will not render these, but will ignore formatting.
FOP limitation No implicit auto line-breaks for Asian text if there is no explicit whitespace character inserted.
FOP limitation FOP cannot fit table columns to the minimum necessary width but all columns of a table will be 100%/noOfColumns wide.
FOP bug FOP throws exceptions when <table>s have different cell count per row. This can be caused by both XLS plugin and regular wiki tables.
FOP limitation GIF export in RTF is not supported. It was added after FOP release 0.93.
FOP bug Horizontal rulers are not exported to RTF.
FOP bug Exporting structure of lists and ordered lists to RTF is buggy.
FOP limitation Images are never resized, so it is very likely they can flow beyond the right margin.

Editing Wiki Pages Using Microsoft Word

Edit wiki pages using Microsoft Word. See Editing Wiki Pages with Microsoft Word

Wiki as a Framework - Combine Content using Plugins

Using these enhanced features, users are able to reference codebeamer documents, tracker items, reports or forums, and also to add graphical charts, graphs or even UML class diagrams.

You must login to see this link. Register now, if you have no user account yet.

For detailed information about plugins and the wiki markup syntax, see Wiki Markup and Plugins.

Advanced Wiki Management

Most of the complex or dynamic content of a wiki page, (for example, reports, charts, Microsoft Excel or graphs) is served by plugins.

Internal codebeamer contents such as reports, documents, tasks, requirements, bugs and other artifacts can be embedded into wiki pages.

Embedding Documents into Wiki Pages

The document You must login to see this link. Register now, if you have no user account yet. can be embedded into this page

[{ExcelPlugin id='22950'}]

with the ExcelPlugin using the syntax above.


ExcelPlugin plugin failed: Failed to convert XLS to HTML: Document (id: 22950) not accessible by user (id: 2853)
(com.ecyrd.jspwiki.plugin.PluginException:Failed to convert XLS to HTML: Document (id: 22950) not accessible by user (id: 2853), com.ecyrd.jspwiki.plugin.PluginException:Document (id: 22950) not accessible by user (id: 2853))

Embedding Spreadsheets into Wiki Pages

Embedding the BestContentPlugin using the syntax:

[{BestContentPlugin max='5' projectId='37' entityType='WIKIPAGE' title='Best Wiki pages'}]


Best Wiki pages
General System Requirements
Average rating is 5 by 1 user(s).
Document Manager
Average rating is 5 by 1 user(s).
Using Subversion with codeBeamer
Average rating is 5 by 1 user(s).
Wiki Markup and Plugins
Average rating is 4 by 3 user(s).
Authentication and Access Control in codeBeamer
Average rating is 4 by 1 user(s).

By editing the embedded spreadsheet, the content of the wiki page changes.

Embedding Ratings into Wiki Pages

Ratings can also be embedded into a Table, using the following syntax:


|(vertical-align:top;) [{BestContentPlugin max='5' projectId='37' entityType='WIKIPAGE'
title='Best Voted Wiki pages'}] |(vertical-align:top;)[{BestContentPlugin  max='5'
projectId='37' title='Best Voted Forum
posts'}]|(vertical-align:top;)[{BestContentPlugin max='5' projectId='37' entityType='DOC'
title='Best Proposals in Documents'}]


Best Voted Wiki pages
General System Requirements
Average rating is 5 by 1 user(s).
Document Manager
Average rating is 5 by 1 user(s).
Using Subversion with codeBeamer
Average rating is 5 by 1 user(s).
Wiki Markup and Plugins
Average rating is 4 by 3 user(s).
Authentication and Access Control in codeBeamer
Average rating is 4 by 1 user(s).
Best Voted Forum posts
Fast Links
Average rating is 5 by 1 user(s).
General System Requirements
Average rating is 5 by 1 user(s).
Document Manager
Average rating is 5 by 1 user(s).
Using Subversion with codeBeamer
Average rating is 5 by 1 user(s).
Best Proposals in Documents
No pages rated.

To integrate with external systems or customize own wikis, the plug-in mechanism is the primary extension point.

See also: Wiki Markup and Plugins

Embedding Reports into Wiki pages

Embed reports into Wiki pages using the Report Wiki plugin.

For example:

[{Report id='22556'}]

Project and Key Fields

Two additional fields can be used for displaying and sorting in merged reports: Project and Key.

The Project field represents the codebeamer project which the tracker belongs to. The Key field is the internal tracker key in the system.

Collaborative Section Review

This function is available since codebeamer 10.0 release.
This feature only works in wikitext tracker fields.

codebeamer offers a simple way to collaboratively review blocks of texts within the wiki content. This function builds on the commenting capabilities of the platform.

Users can start a review from the WYSIWYG editor by selecting some text and creating the first comment. After that, other users can add further comments to the review comment thread.

Creating a Section Review

Any user with the following permissions can initiate section reviews:

  • Add comments in the tracker.
  • Edit items in the tracker.
  • Edit the wiki field.

Specific steps for the process are as follows:

  1. Initiate editing of a wiki field and select some text.

  2. Click on the Add Comment icon on the toolbar.

  3. Type the comment and click on Save icon.

    Saving the comment does not update other modified fields on tracker item edit page.
  4. Colored triangles are displayed in the wiki content, marking the start and the end of the text block.
    Furthermore a new comment appears on the Comments & Attachments tab.

Adding Comments

Further comments can be added to a section review.

Comments form a thread and are displayed as replies to the initial comment. The following permissions are required to add new comments:

  • Add comments in the tracker.
  • Edit items in the tracker.
  • Edit the wiki field.

Lacking the above permissions, the user sees a read-only list of the existing comments, and a warning message appears notifying the user about the missing permission.

  1. Open a page where the tracker item and the wiki field are displayed. (Details page of the tracker item, any kind of view, like Table View or Document View etc.)
    Make sure that wiki field is in read-only mode. The following function does not work on the editing screen, or if the inline editing is active for the field.
  2. Locate the start or end triangle in the wiki content which belongs to the section review.
  3. Click on the triangle. A dialog opens. It contains all the existing comments and a comment editor, if the user has proper permissions.
  4. Type some text and click on the Save icon.
    A new comment appears in the comment thread.

Ending a Section Review

Ending a review involves editing the tracker item. Users with permissions to edit both the tracker item and the wiki field can remove the triangles from the wiki content which closes the review.

Ending a review does not delete the comments created during the review. Comments are still displayed on the Comments & Attachments tab.

  1. Initiate editing of a wikitext field.
  2. Delete one of the triangles. This action removes its pair automatically.
  3. Save the changes.

Hiding Section Reviews

The triangle indicators can be hidden in the read-only mode of the tracker item by switching off the related option on the Preferences overlay.

For more information about the user preferences, see User Preferences.

Triangles always show up in the editing view of trackers and items, and also while inline editing the wiki field.