Basic Functionality
Codebeamer X operates with User Accounts. A user must have an account before logging in and participating in a Project. When creating an account, the user's name, password and email address are required, and other optional data may also be entered. The email address is used by Codebeamer X’s notification service and is not visible to other users, unless the other user has certain (user view) permissions. The optional data that can be entered includes telephone number, mobile number, organization name, time-zone, and location. These personal data fields are visible to other registered users with appropriate permissions.
Licensing
Codebeamer X offers three licensing options: ALM, Reviewer, and Viewer. With these license types, the user has different capabilities in the system. To set a selected license type for a user, go to User Accounts on the System Administrator page. With system administrator rights, click on the user's name to edit the License type. By default, the ALM license is selected. Check the number of free and used licenses under the Licenses tab.
Authentication
To access Codebeamer X, it is required to authenticate your account.
To first create an account:
1. Click the Register now link.
2. Fill in the registration form.
3. Click Registration.
You can access Codebeamer X with an activated user account from the Login page.
Login With Valid Credentials
To login to Codebeamer X, enter your username and password and click on Login from the Login page. To log in with a different username, make sure you are logged out and log in with the new username. After successfully logging in, you are taken to Codebeamer X’s default dashboard page.
Login With Invalid Credentials
If either your username or your password is invalid, an Invalid user credentials! error message is displayed.
If you forgot your password, click Forgot password? to request a password reset with your username or email address.
Login With LDAP/AD Credentials
If there is an LDAP/Active Directory server configured on Codebeamer X, a user from the AD server can login to Codebeamer X without registering.
Email Notifications
Codebeamer X sends notifications emails about Project items, documents, wiki pages, workflow transitions, status changes, and more.
Item Notifications
When an item is submitted or modified in a Tracker, email notifications are sent to users subscribed to the Tracker. Modify email settings for a Tracker in the Notifications tab under the Configuration menu. Under the Any notifications section,add or delete users by name or role (users are notified of any updates).
Under the Status change notifications section, set subscribed users to receive notifications only with status changes on items. Under the Notifications by Tracker section, set subscribed users to receive notifications only for selected statuses.
Full-Text Search
Use full-text search to search tasks, bugs, Wiki pages, users, attachments, and Projects. The search finds items within seconds, based on indexing and taking place in the background. The search automatically syncs with any changes made. Place tags or labels on relevant items found, and share with your team.
Full-text search is provided for:
• Documents: Includes Microsoft Word, Microsoft Excel, RTF, PDF, HTML, wiki, and text documents.
• Projects: Name, description and category fields.
• Tracker items: All fields, comments, and attachments (same file formats in document search are supported).
• Reports: Name and description fields.
Simple Search
A simple syntax is used for word based searches. The simple search field is found at the upper right corner of every Codebeamer X page. By default, prefix search is used (e.g., search for "org" and find items containing "org" and organizations).
Use ID numbers to find items easily (e.g., search for ID number "#2000" and find items related to the ID.)
System Audit Trail
With system administrator rights, use the Audit tool to analyze and export these user interactions:
• User logins, logouts (including system logouts)
• Item or artifact modification actions (create, update, delete)
• Permission changes (Trackers, Tracker fields, roles, user groups)
Logins
Find login and logout times by users under the Logins tab.
Display Logins
To display login/logout information, set the filter values and click Go.
Results are displayed in three columns:
• User: Link to the user's account.
• Event type: User login, user logout, user system logout.
• Created at: Time of the event.
Filter Logins
Filter logins by:
• User: Select one or more users.
• Event type: (all options can be combined)
◦ User login
◦ User logout
◦ User system logout
• Range : Date range can be defined by predefined constants or custom dates.
Artifact
Create, update, or delete artifact actions.
Display Action
To display item actions and information, set the filter values and click Go.
Results are displayed in seven columns:
• User: Link to the user's account
• Artifact: Link to the artifact
• Event type: Type of the current action
• Project: Name of the related Project
• Tracker: Name of the relate Tracker
• Message: Link to the diff viewer
• Created at: Time of the event
Filter Action
Filter actions by:
• User: Select one or more users
• Event type: (all options can be combined)
◦ Artifact create
◦ Artifact delete
◦ Artifact remove
◦ Artifact restore
◦ Artifact update
◦ Create
◦ Delete
◦ Remove
◦ Restore
◦ Update
• Project: Select one or more Projects.
• Tracker : Select one or more Trackers.
• Range : Date range can be defined by predefined constants or custom dates.
Permissions
Create, update, or delete permissions for Trackers, Tracker fields, roles, or user groups.
Display Permissions
To display permissions, set the filter values and click Go.
Results are displayed in seven columns:
• User: Link to the user's account.
• Artifact: Link to the artifact.
• Event type: Type of the current action.
• Project: Name of the related Project, if possible.
• Tracker: Name of the related Tracker, if possible.
• Message: Link to the diff viewer, if available.
• Created at: Time of the event.
Filter Permissions
Filter permissions by:
• User: Select one or more users
• Event type: (all options can be combined)
◦ Artifact permission create
◦ Artifact permission delete
◦ Artifact permission update
• Project: Select one or more Projects
• Tracker: Select one or more Trackers of the selected Projects
• Range: Date range can be defined by predefined constants or custom dates
Audit Configuration
In audit configuration, control which event to log.
Login event types:
• User login
• User logout
• User system logout
Item event types:
• Item update
• Item create
• Item remove
• Item restore
• Item delete
Artifact event types:
• Artifact update
• Artifact create
• Artifact remove
• Artifact restore
• Artifact delete.
Permission event types:
• Artifact permission create
• Artifact permission delete
• Artifact permission update.