CodeBeamer Web Administration Guide

This manual is intended for administrators who maintain the CodeBeamer server from the web. CodeBeamer Web Admin allows you to perform all the usual daily administrative tasks over the Web, as described in this document. For installation, setup please see codebeamer Configuration.

The CodeBeamer server portal can be administered from the Web UI.  Users must have System Administrator privileges in order to do administration functions as described here.

More system level administration/configuration related information can be found in Post-installation Configuration.  

To start system administration, login with System Administrator privileges and click on the System Admin tab.

Figure: System Administrator Site.

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

Groups, Users and Server Wide Access Permissions

Users are individual entities registered on the CodeBeamer server. Groups are collections of users with similar permissions. The scope of the group access permission is server-wide. With groups you can group users on the CodeBeamer server into logical sets, and you can assign them different sever-wide permissions, such as whether they are allowed to create projects or view the personal data of other users. You can use groups to grant different server-wide access permissions for corporate users, off-shore users, customers, partners and others.

With the New Group Link you can create a new custom group, and grant specific permissions. The selection from the Template Group combo box will influence what the proposed initial rights will be in the group you are about to create.

Managing Groups

Users are assigned to existing groups. Only users from the System Administrators group can administer group permissions. See Creating New Groups.

Figure: Managing User Groups and Accounts.

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

To edit a group access permissions:

1. Click on System Admin,
2. Click on User Accounts,
3. Click on the Edit link for the desired group, that is Edit in the tooltip beside the specific Group Name, in the Group column,
4. Change the permissions in the Edit Group screen,
5. Click on Save.

Figure: Edit Group Permissions.

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

Creating New Groups

Using groups you can assign similar sever-wide permissions to users (i.e. external, internal, customer, manager etc.).

New Groups cannot be created without a license.

To create a new group:

1. Click on System Admin,
2. Click on User Accounts,
3. Click on New Group,
4. Change the permissions,
5. Click on Create.

Figure: Creating a New Group.

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

Deleting a Group

To delete a group:

1. Click on System Admin,
2. Click on User Accounts,
3. Select the groups to be deleted and click on "edit"
4. Then click on the Delete... button.

Managing User Accounts

New Account

In the User Accounts link from the System Admin tab, you can also select New Account, to create accounts. The required fields have a red bar to the left, between the entry field and its title.

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

Field	Purpose, Example Values
License Type	1st entry field: specify Participate or CodeBeamer. 2nd entry field: specify Named User License, or Floating License
Status	Activated, Disabled, In activation
Member in Groups	Select from the Groups you have already defined, here.

For more information about licenses, please see You must login to see this link. Register now, if you have no user account yet.. For more information about Participate, please see You must login to see this link. Register now, if you have no user account yet.

Assign User to a Group

You can assign a user to a group manually or automatically when a new account has been created.

To manually assign a new account to a group, check the appropriate field(s) in the New Account form, as described above.

For automatic assignment (of a new account to a group) use the Miscellaneous link under the System Admin tab, and see the example under Managing Anonymous User Access Administrator's Guide.

To manually change the assignment of an existing account to a group:

1. Click on System Admin,
2. Click on User Accounts,
3. In the Groups section, click on the tooltip Assign for a group,
4. Choose the user accounts to assign to the group,
5. Click on Save.

Change User Account Upload Limits

You can set a maximum file-size for files that are uploaded by a user onto a server in the New Account form.  This is the maximum for one particular user.

The default maximum upload (1G) is automatically selected in the New Account form using the default entry -1 in the Upload Limit (in kB) field.

You can also change the upload limit for all users in: Post-installation Configuration

Delete a User Account

See "Disable a User Account" in the next section.

Disable a User Account

When you don't have sufficient named licenses in your system, you can disable user accounts. The license manager does not count disabled user accounts. It is better practice to disable a user account than to delete it. In some other systems you can delete accounts, however the disadvantage is that the user history, notification settings, permissions, roles will disappear from the system. In CodeBeamer you can't delete users, instead you disable them. Disabled users cannot log in, however the account remains on the server with all its related history, settings and references are preserved.

Import Users From Comma Delimited (CSV) Files

You can import a user list into CodeBeamer from a comma delimited data. The first step is to create a CSV file with user data.

The following requirements have to be met for a successful user import:

1. You must have sufficient free licenses on CodeBeamer server;
2. The CSV file should have at minimum four fields: account-name, first-name, last-name and e-mail. Each row must have the same number of field separators.

Figure: Semicolon Separated (;) File Containing User Data.

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

To import users from a CSV file:

1. Click on System Admin,
2. Click on User Accounts,
3. Click on Import Accounts to start the import wizard,
4. Select the CSV file name, the separators and the character set,
5. Assign the appropriate column with the appropriate field,
6. Check on the preview site if the column assignment is correct. By pressing the Back button you can go back and change the assignments.
7. Finalize the import (see below).

Figure: Importing Accounts -- Import Wizard (1).

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

Figure: Assign Columns to Match the Input Fields -- Import Wizard (2).

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

Figure: Import Preview -- Import Wizard (3).

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

To finalize the import:

1. Check the Overwrite/Update existing Accounts checkbox if you want to overwrite existing accounts,
2. Select a group from the Assign to Group combo box,
3. Click on the Import button to finalize the import.

When you have named licenses and the number of licenses you have after the import is insufficient, you can contact Intland to purchase more licenses (sales@intland.com), or you can log in as System Administrator and disable specific user accounts.

User authentication can also be managed by LDAP.  You can import and update user account information using an LDAP service.  See Post-installation Configuration for more information.

Managing Anonymous User Access

Also See Authentication and Access Control in codeBeamer

To provide anonymous user access on CodeBeamer for specific projects follow these steps.

Create an Anonymous Group

Go to System Admin select User Accounts and create an anonymous_group (New Group).

Figure: Creating an Anonymous Group.

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

Create an Anonymous User in the Anonymous Group

Create an anonymous user account, set the e-mail to an invalid address to avoid notifications and set the password (e.g. to supersecret). Choose Member in Groups: anonymous group.  The system admin can change the password later.

Figure: Creating an Anonymous User Account.

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

Assign New Accounts to Anonymous Group

From Miscellaneous, set Anonymous User: with the account anonymous. Select the anonymous group check-box so that all new accounts will be part of the anonymous group.

Figure: Specify Account Anonymous

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

Set Anonymous Role in a Project

Logout as "sysadmin" and Login with your normal account and create an anonymous role in your project and set the anonymous role permissions to be as restrictive as you wish for anonymous users.

Figure: Create “Anonymous” Role Permissions.

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

Assign the Anonymous Group to the Anonymous Role

From the Members tab, assign the anonymous group with the anonymous role in your project

Figure: Assign the Anonymous Group to the Anonymous Role.

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

Login as anonymous/supersecret and test the permissions you are granted. Change the password supersecret to your own password for security reasons.

Logged In User Information

In the System Admin tab, next to the User Accounts on the first line, is a Logged In link.  This reveals information about currently logged-in users, and those who have logged in over the past 14 days.

Managing Projects

System administrators can view the list of all projects on the server. The administrators can also delete unnecessary projects. For security reasons, if a system administrator is not a member of a project, then he/she will have no read or edit permissions on the project's contents.

For all projects, the system administrator can see the project name, creation date, creator, administrators and category.

View all Projects

Using this option the system administrators can view all project names and project owners on the server.

To view projects:

1. Click on System Admin,
2. Click on Projects.

Deleting Projects

Only users having the system administrator role can delete projects from the server.

To delete projects:

1. Click on System Admin,
2. Click on Projects,
3. Select the projects to be deleted,
4. Click on the Delete Projects... button.

Resetting SCM Access

When you click on the Reset Managed Repositories Access link, the access control files for all managed repositories are synced to codeBeamer.

Set Managed Repository Access URLs

Set the location of your managed repository in the Set Managed Repository Access URLs menu item's form. The prefixes shown are not real prefixes: use your own repository URL parent directories. The individual project repositories will subtend from the prefixes shown here, depending on the repository type that is selected for each project.

See also Using Managed Subversion, Git & Mercurial Repositories or
Using Subversion with codeBeamer or
Tracing Source Code Changes to Requirements, Task and Bugs or
Administering Projects.

Figure: Set Managed Repository Base URL

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

Managing Documents

The system administrator can view document statistics summarized by project.  The system administrator can delete unnecessary documents from the trash on the server.

Using External network storage

You can choose local or External network storage for project documents. Each project can store its documents using either local or network storage. See codebeamer Configuration for External network storage configuration. Network storage is the appropriate option when there is mirroring, backup or other file management services available.

Empty Documents From the Trash

To empty the documents from the trash:

1. Click on System Admin
2. Click on Documents
3. Click Empty Trash

View Document Statistics by Project

To review per-project document statistics:

1. Click on System Admin
2. Click on Documents

Indexing

Selecting Indexing causes the search database to be re-indexed.

Figure: Re-Index Function

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

Login and Welcome Text

CodeBeamer can be integrated into your corporate site, with your login and welcome text personalized for your business.

Figure: Logo and Slogan Customization Dialog.

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

Login Text	The text displayed on the login page
Welcome Text	The text displayed on the User's home page

Project Business Hours Calendar

Default business hours and exceptional workdays, such as holidays and/or required overtime may be defined in the 2 available calendar tabs. Project-specific exceptions can also be defined in Project Admin area. See Managing Projects.

Figure: Default Business Hours
You must login to see this link. Register now, if you have no user account yet.

Figure: Special Calendar Days
You must login to see this link. Register now, if you have no user account yet.

Miscellaneous Options

To set miscellaneous options:

1. Click on System Admin,
2. Click on Miscellaneous.

Figure: System Administration - Miscellaneous.

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

New Account

You can set the members (by whom) and the method (how) by which new accounts are created on the server.

Assign New Accounts to Groups

When a new account has been created (manual registration, import, LDAP), the new user account is assigned to a group based on this setting. A default group could be a standard one such as Regular User, Customer, Developer - External or a custom one.

Registration Message Sender

On new account registration, the registration confirmation mail will be sent from this address (i.e. codebeamer@intland.com).

Notify After Account Activation

This option specifies the e-mail address of the user who will be notified about new account registration events.

Disallowed User E-mail Addresses

When you don't want to accept registrations from particular email addresses, you can enter regular expressions here to filter them out, such as  (.*@t-online.ukr)|(.*@ru.net).

CodeBeamer uses the expression syntax available in the Java Standard Edition core library version 1.4 or greater. This package has support for Perl-like regular expressions so, if you are familiar with using regular expressions in Perl, you can use the same syntax. See http://java.sun.com/developer/technicalArticles/releases/1.4regex/, and a tutorial and overview of regular expressions in Mastering Regular Expressions, Jeffrey E. F. Friedl, O'Reilly and Associates, 1997, ISBN: 1-56592-257-3.

Registration Confirmation E-Mail Text

This is the automatic welcome e-mail sent to new accounts at registration time. The syntax used for defining the message is that of the Velocity macro engine (http://velocity.apache.org/).

Automatic Login

Allow or disable automatic login using HTTP cookies.

Single Sign-On by HTTP Request Header

Where the HTTP header exists, it can be used to allow automatic sign-on (SSO).  For example, see Novell's iChain http://www.novell.com/products/ichain/overview.html

Account Activity

Toggle to turn on and off the tool-tip display of a user account's last activity under the Logged In part of User Accounts in the System Admin toolset.

License Code

You can enter your CodeBeamer license code in this dialog. See You must login to see this link. Register now, if you have no user account yet. about how to obtain a license code, information about Named and Floating licenses, or how to find your host id.

Add License Code

Figure: Entering your License Code.

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

Configure E-mail Notification Server Access (SMTP)

To send e-mails and notifications, CodeBeamer needs the name of your outgoing e-mail server.

Figure: Configure Outgoing e-mail Notification Server Connection.

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

You need to set the values for the following fields:

• Outgoing SMTP Mail Server - to send e-mails CodeBeamer needs to know your outgoing SMTP mail server name. If you are not sure about your outgoing mail server name, please ask your system administrator.
• Server Name - the server name will appear in all e-mail notifications sent by CodeBeamer, including links and references to the server. The server name (i.e. http://www.codebeamer.com) must be known to all clients to reply that receive e-mails from the server.

GUI

CodeBeamer can be integrated into your corporate site, with your logos, colors, fonts and site specific HTML text. You can upload your logo and change your slogan. With CSS you can change the GUI colors and fonts.

Figure: Change GUI Form

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

Periodic Process Timer

To start periodic build processes you can use the periodic process timer.

Figure: Modify the Periodic Process Timer

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

Hour, Minute	Time of day when the Periodic Process Timer starts.
Period	Periodicity interval. The default value is 1440 = 24*60 and it starts the timer once a day. Example: to change it to start the build process every 2 hours the Period parameter should be set to 120.

iSQL  Interactive SQL Console

Query your database with the interactive SQL console.  Export the results in a variety of formats.

Figure: Example Interactive SQL Query and Results

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

Change Logging Configuration

Codebeamer uses Apache Log4j for logging. While the default logging levels are carefully selected, sometimes the defaults do not provide enough information for tracking down a more complex problem in CodeBeamer.  

Codebeamer administrators can now change these log4j settings without restarting their codebeamer server. This is done by the Change Logging Configuration page accessible from the System admin module. 

Figure: Change Logging Configuration

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

Usage:

To change some classes/packages log4j settings, paste in the new log settings in the "logging changes" box, using the same syntax as found in the installdir/tomcat/common/classes/log4j.properties file. Do not modify the log4j.properties file: change logging levels only through this System Admin interface.

For example the:

log4j.logger.com.intland.codebeamer.controller.admin.LoggingConfiguratorController=INFO

will change the LoggingConfigurationController's logger to INFO level.

Multiple log4j settings can be changed at once; just put them in multiple lines similar to the log4j.properties file.

Important notes:

• Be careful when changing log levels, since very verbose logging may severely degrade the server performance.
• The changes are not reverted automatically & the administrator has to change the log levels back to their defaults.
• These changes made on these pages are not persistent and they will be lost when the server is restarted.

Configure LDAP Access

CodeBeamer enables you to manage user authentication via LDAP and to import and update user account information such as user account, phone numbers, and e-mail addresses and other data from an LDAP service. See Post-installation Configuration.

Other System Administration Functions (Not Accessed by System Admin Tab)

Server Resources

You can use the codeBeamerResourceTrend data source to visualize memory usage. The wiki plugin

[{TimeSeriesChartPlugin title='Resources' width='1000' height='400'

[{DataSet since='1' data='codeBeamerResourceTrend' format='timeSeriesChart'}]}]

results in the chart:

Change System Administrator's Name and Password

You can change the system administrator's name and password. CodeBeamer is shipped with a default system administrator user with the name bond and 007 password. The account's name and password data is changed in the same way as a regular user account. Select Account Info, then Edit Account and edit the name and password fields, and save.