Codebeamer

Stages supports Codebeamer tracker of type Document

There are two modes how the adapter can be configured: “direct download” or “link to codebeamer”. This mode defines what happens when the user clicks on Codebeamer file in Stages (download action). The following sections show example configurations for each mode.

Stages downloads the file from Codebeamer and presents the file directly to the Stages user.

<cms-type name="codebeamer">
    <!-- Global Properties -->
    <cms-host ident="codebeamer1" name="https://codebeamer.example.com/cb" displayName="Codebeamer Example Server">
        <!-- Host Properties -->
        <cms-property name="user" value="codebeamer_username" />
        <cms-property name="password" value="codebeamer_password" />
        <cms-property name="tracker" value="30289" />
    </cms-host>
</cms-type>

Stages sends the user to Codebeamer on the correct item.

<cms-type name="codebeamer">
    <!-- Global Properties -->
    <cms-host ident="codebeamer1" name="https://codebeamer.example.com/cb" displayName="Codebeamer Example Server">
        <!-- Host Properties -->
        <cms-property name="user" value="codebeamer_username" />
        <cms-property name="password" value="codebeamer_password" />
        <cms-property name="tracker" value="30289" />
        <cms-property name="link" value="true"/>
        <cms-property name="use.system.account.for.download" value="true"/>
    </cms-host>
</cms-type>

This integration provides users with two ways to access a file: Download the file via Stages and open it in Codebeamer.

• Download via Stages: Stages handles the download for the user. To ensure Codebeamer permissions, the user must authenticate via Stages. This behavior can be overwritten by the use.system.account.for.download setting (see below).
• Open in Codebeamer: The user is taken to the item view in Codebeamer. User authentication is handled by Codebeamer.

The default option is download and can be changed by preferred.file.access setting (see below).

These configuration properties affect the behavior of one Codebeamer server.

user

• Description: You may enter the Codebeamer username for the Stages system account here instead of the corresponding field Username in the cms profile. If both values exist, the username from the cms profile is preferred.

password

• Description: You may enter the Codebeamer password for the Stages system account here instead of the corresponding field Password in the cms profile. If both values exist, the password from the cms profile is preferred.

tracker

• Description: You may enter the ID of the tracker to connect to here instead of the corresponding field tracker ID in the cms profile. If both values exist, the tracker ID from the cms profile is preferred.
• Example Value: 30289

revisionprefix (optional)

• Default Value: v
• Description: The revision of the document will be part of the comment section in Stages. With this setting you can define the prefix. By default the prefix is “v” so the revisions will be shown as “v1.0” in Stages.

link (optional)

• Default Value: false
• Description:
  • If unset or set to “false” the user will get a file download in Stages.
  • If set to “true” the user will be redirected to Codebeamer issue in the browser. In this case we recommend to set “use.system.account.for.download” to “true”, so the user is not asked for credentials. The user has to login to Codebeamer anyway.

use.system.account.for.download (optional)

• Default Value: false
• Description: When set to true, files will be downloaded using the system account.

preferred.file.access

• Default Value: download
• Description: When set to link, the user will be linked directly to Codebeamer. The download option can be chosen from the sub-menu.

Access to Codebeamer projects can be configured in Stages processes via “Management > File Management > Repositories”.

Name: The name of this Codebeamer configuration. This name will be used by Stages to refer to this repository configuration (e.g. in repository plan)

Codebeamer Server: This selection field contains an entry for each cms-host section in the Stages configuration file (config.xml). You can select the host for this repository configuration.

Tracker ID: The ID of the tracker to connect. This overwrites the tracker from the configuration file (config.xml).

Username: Define a username for this repository configuration. This overwrites the property username from the configuration file (config.xml).

Password: Define a username for this repository configuration. This overwrites the property password from the configuration file (config.xml).

Default Lifecycle: Select a lifecycle from the process metamodel as default for files from this repository.

• The connector is read only
• Only tracker of type Document are supported
• The test connection button in CMS configuration is not working