You are not logged in. Click here
to log in.
codebeamer Application Lifecycle Management (ALM)
codebeamer X 4.0 User's Guide
Please update based on new features and changes. Table of Contents
1 Manage Workspaces And PermissionsA Workspace is a secure place for teams to collaborate and achieve a particular goal. In codeBeamer MX, you get an unlimited number of Workspaces to set up different teams, workflows, and permissions. View and manage Workspaces with filtering options (e.g. name, color, status, category) and grouping them by business or function. A Workspace shows up as a blue card and globe icon, as well as an arrow icon at the top right corner of your dashboard. Hover over them to see quick information about your Workspace.
1.1 Create WorkspaceWith administrator rights, create a Workspace by clicking “Create New Workspace” from your dashboard. Get started with any of the four options: 1) blank Workspace, 2) your own template, 3) previous template, or 4) Intland’s Smart Template. Each Workspace has a unique key assigned by its prefix and category. A SCM Repository (Git, Mercurial, Subversion, CVS) can also be added. Easily change your Workspace categories with drag and drop.
1.1.1 Create Blank WorkspaceCreate a new blank Workspace that doesn’t use a template. This is your standard Workspace that generates a default wiki page, permissions, and different types of Trackers (e.g. requirements, risks, tasks, change requests, bugs, test cases, releases) where relevant links are stored.
1.1.2 Remove WorkspaceTo delete a Workspace, follow these steps:
When you remove a Workspace, its content will no longer be accessible. Only users with administrator rights can see them by clicking the Removed Workspaces icon next to the search function at the top right corner of your Workspace page. Other notes:
1.1.3 Modify Workspace SettingsModify general options under your Workspace settings with these steps:
With administrator rights, edit these settings:
1.1.4 Create Workspace With Your Own TemplateCreate a new Workspace with your own template by uploading a file (e.g. Son, .bson, .zip compressed, .reqif, .reqifz). Copy items like calendars, documents, Trackers, wiki pages, users, and other settings from another template. To allow an existing Workspace to be used as a template, set template availability in the Workspace settings.
1.1.4.1 Export Workspace Template As FileExport a Workspace template as a file with these steps:
1.1.4.2 Mark Workspace As TemplateTo use a previous Workspace as a template, it needs to be marked as a template. Go to Admin, then Workspace Settings, and switch on template availability for the Workspace you’d like to use.
1.1.4.3 Create Workspace With Previous TemplateTo create a new Workspace with a previous template, click My Templates from the dropdown menu. Choose from the available Workspace templates.
1.1.4.4 Create Workspace And Inheritance Configuration From TemplateTo set up a live inheritance configuration of items from a template, click Use Template. This allows for real-time updates from the template’s Tracker and notification settings including workflow and permission settings. Reference fields refer to newly created Trackers.
This function is no longer supported in Retina 3.2!
1.1.4.5 Create Workspace And Copy Configuration From TemplateTo copy configuration items, users, and wiki pages, click Use Template. Tracker configurations are copied with their workflow, permission, and notification settings. Reference fields refer to newly created Trackers. Wiki pages are copied along with the same permission settings. Users are copied along with the same roles. This type of configuration is not connected live like inheritance.
1.1.4.6 Unmark Template Usage And Modify WorkspaceDisable a Workspace template by unmarking the "Available as template" checkbox in Workspace Settings. Disabled templates will no longer appear in the list of available templates.
1.1.4.7 Delete Workspace That Uses A TemplateWhen deleting a Workspace that uses a template, it will also be deleted from any inheritance configuration. When deleting, confirm your action to move the Tracker to trash. To remove your Tracker forever, delete it from the trash.
1.1.4.8 Create Workspace By Re-Using Template FileTo re-use a template file you previously exported, select Upload New Template when creating a new Workspace. The file may include Workspace configurations, items, documents, wiki pages, and dashboards. To create a Workspace without certain items, unmark them from the checkboxes.
1.1.5 Create Workspace With Intland’s Smart TemplateIntland’s Smart Templates consist of preconfigured Trackers, workflows, documents, roles, and permissions that can be copied easily. Use templates designed for Agile Scrum, Hybrid, Document Management, and Test Management. Use templates for industries like Automotive, Medical, Pharmaceutical, and Avionics. Create your own Smart Template and re-use items by exporting an existing Workspace. Exports can be done under the Admin page of Workspace Settings.
1.2 Manage User AccountA user can have multiple roles in a Workspace with relevant permissions. Users are additionally associated with groups that use a different set of permissions. In the System-Admin tab, create a new user account manually or assign a user to a group automatically.
1.2.1 Create User AccountA user must have a codeBeamer MX account to participate in a Workspace. Creating a user account requires information like name, organization, email, and more. A user’s email address is used by codeBeamer MX’s notification center and is not visible to other users, unless the other user has “user view” permissions. A user may include optional data like phone number, organization name, time zone, and location visible to other users with relevant permissions. To create an account:
1.2.2 Modify User AccountMake changes to your personal details, preferences, groups, and password under User Profile. System Administrators can edit the email address of any user. To make changes under User Profile:
1.2.3 Deactivate User AccountA user account can not be deleted in codeBeamer MX, but can be disabled. With a disable account, a user can not log in to codeBeamer MX. However, the account and its relevant history remain on the server. A disabled account is not counted by codeBeamer MX’s license managers. It also can’t be reactivated due to compliance rules. Only System Administrators can disable a user account under the System Admin page. To disable an account, open User Accounts and switch “Disabled” under Personal details. A disabled user account loses:
1.2.4 Password RecoveryTo retrieve a forgotten pattern when logging in to codeBeamer MX, click “Forgot password?”. Enter your user name or email address to request a password reset by email.
1.3 Manage Workspace RolesRoles can reflect organizational positions or task-based structures in a Workspace (e.g. Developer, Tester, Stakeholder). To manage roles and related permissions in a Workspace, go to the Users tab of a Workspace. Find all roles on the left side of the page. Add, edit, or delete roles and permissions. With administrator rights, re-use existing permissions. By default, the administrator role for a Workspace holds all permissions.
1.3.1 Add New Workspace RoleTo set up your team in a Workspace, add a role with these steps:
Tip: set up roles and permissions in advance when initially creating your Workspace.
1.3.2 Create Workspace Role By Re-using Existing RoleWhen creating a new Workspace role, re-use an existing one with pre-defined permissions. Follow these steps:
1.3.3 Modify Workspace RoleModify user roles to control group level visibility and access to Workplace information like Trackers, forums, documents, builds, SCM, and source codes. Internal teams and business partners can only see and access information set by roles. Users of the same role share the same level of access to Workspace information. To customize a role:
1.3.4 Modify Workspace Administrator RoleIn codeBeamer MX, there is no way to modify permissions under the Workspace administrator role.
1.3.5 Delete Workspace Administrator RoleIn codeBeamer MX, there is no way to delete the Workspace administrator role.
1.3.6 Delete Workspace RoleIn the same location for modifying Workspace roles, delete user roles except for the administrator role. Double click the role you’d like to delete on the Users & Roles page, and then click the bin icon on the editor.
1.3.7 Assign User To Workspace RoleUse two ways to assign a user to a Workspace role. Double click the user’s name on the Members & Roles page and select the desired role. Or drag and drop the role itself to the user’s name.
1.4 TemplatingWhen creating a new Workspace, choose from existing templates. Save time by copying or inheriting items like tasks, bugs, requirements, and more. With Intland's Smart Templates, use preconfigured templates with predefined Trackers, workflows, and documents. Create your own Smart Template by exporting an existing Workspace.
1.5 Manage GroupsUser groups are categorized by common traits like job title, skill, title, or organization (e.g. Marketing, Sales, Development). Each group has its own permissions within a Workspace. Under your Workspace, go to User Groups to assign a group with one or more role(s). This can be used instead of assigning roles to individual users. Only users with administrator rights can define, add, delete, and manage groups. LDAP group synchronization is available.
1.5.1 Add New GroupTo create a new group:
1.5.2 Create New Group From Existing GroupTo create a group by duplicating an existing one, select “Based on”. Group permissions are copied automatically. Edit as needed.
1.5.3 Modify GroupTo modify a group, open System Administrator, go to User Groups, then select the group you’d like to update. Click “Edit” at the top of the page. After making your changes, hit Save.
1.5.4 Delete GroupTo delete a group, open System Administrator, go to User Groups, then select the group you’d like to delete. Open its details page. Click “Delete” at the top left corner of the page.
1.5.5 Assign User To GroupTo assign a user to a group, open System Administrator, go to User Groups, then select the group you’d like to add a user to. Click “Assign users” at the top of the page.
1.5.6 Assign Role To GroupTo assign a role to a group, open System Administrator, go to User Groups, then select the group you’d like to assign a role to. Open Users & Roles, then drag and drop a role to a group. This is a convenient way to manage more users with different roles and groups in Workspaces.
1.6 Workspace CategoriesWorkspace categories are used to represent a hierarchy of concepts. Administrators with permissions can create Workspace categories.
1.6.1 Category Administrator PermissionAn administrator with the Workspace Category role can manage categories. To set this permission, open System Administrator, then go User Groups.
1.6.2 Create, Modify, And Delete CategoriesWorkspace categories can be created, modified, and deleted by Workspace Category Administrators. To create a category, open the Workspace and click the + icon. To delete a category, click the three dots next to the category’s name. To modify a category, click “Edit category”.
2 Manage Workspace Wikis And DashboardsA Workspace comes with built-in wiki pages for storing knowledge in a transparent, secure, and collaborative way. They capture all information related to existing roles such as comments between users. Wiki pages can be specified with role-based permissions. To set limits and permissions, open your wiki’s Properties, then click Permissions.
2.1 Create New Wiki PageTo create a new wiki page, open your Workspace, and then click “Add New Wiki Page”. A wiki consists of a structural page tree, property section, navigation, and content. It can be restructured via drag and drop. In the property section, define permissions, comments, and attachments.
2.1.1 Rearrange Wiki Page TreeThe wiki page tree contains the entire structure including personal and Workspace pages. Click on any wiki page name to load its content. Use drag and drop to easily rearrange the hierarchy of the tree.
2.1.2 Change Wiki Page PermissionsWiki page permissions are based on the user role and group level, and can be controlled at each page level. To set page level permissions:
2.2 Edit Wiki Page With WYSIWYG Or Office-EditDirectly edit a wiki page with the “What you see is what you get” editor (WYSIWYG) or Office-Edit. Office-Edit lets you edit on a Microsoft Office Word document. When doing so, the changes automatically syncs with the wiki page after saving. Headers, tables, links, bullets, and other document items are automatically converted. To edit a wiki page, click Edit and choose your edit mode from the dropdown menu.
2.2.1 Lock Wiki Page In Edit ModeDuring a wiki edit, the document is locked so that another user can not apply changes at the same time. When in edit mode, a message appears at the top of the page for other users: "Currently locked by @username". It unlocks after the user saves the page or closes the editor.
2.2.2 Save Wiki Page ModificationsAfter making modifications to a wiki page, hit save. Click the History tab under Properties to see changes. To restore your page to a previous version, select the down arrow next to a version in the History page.
2.3 Wiki Page Versions In HistoryWiki pages are fully audited. Each modification creates a new version, archived in the History tab under Properties.
2.3.1 Compare Wiki Page VersionscodeBeamer MX highlights differences between wiki versions for easy comparisons.
2.4 Link Wiki Page With Items Via AssociationTo link items to a wiki page, open the Link tab under the properties section. See incoming and outgoing links to documents. Create new associations in the Associations tab.
2.5 Out-Of-The-Box Plugins In Knowledge BaseCustomize a wiki page with numerous out-of-the-box plug-ins from the Knowledge Base, also known as the Activity Stream or “My Current Items”.
2.6 Wiki ComparisonTo compare wiki pages with codeBeamer MX’s baseline, open a wiki page, then click the three dots (More Functions) at the middle of the page. Select pages to compare with different versions or baselines. On the left tree, see the following comparisons:
2.7 Manage DashboardsOn a wiki dashboard, find widgets for managing permissions, exporting content, adding child pages, and more. Unlike a wiki page, you don’t need to type in the content, but rather choose from available widgets with user-selectable layouts. Drag and drop widgets to create your dashboard layout.
2.7.1 Add New Widget To DashboardOn a dashboard, create informative boards with helpful widgets. Find widgets for managing permissions, exporting content, adding child pages, and more. Unlike a wiki page, you don’t need to type in the content, but rather choose from available widgets with user-selectable layouts. Drag and drop widgets to create your dashboard layout. To add a new widget to your dashboard, click the Analytics tab at the top of the page. Similar to a wiki page, access a customizable dashboard. Set the dashboard to private or public. Use widgets to visualize data by clicking the + icon (Add widget) at the top of the page.
2.7.1.1 Report VisualizationOn a dashboard, visualize previously saved reports. These visualized widgets include Calendar, Chart, Simple, and Table. The data source is specified by selecting a previously saved report from the dropdown menu. Define the name, size, color, and other settings. Hit Save to make it go live.
2.7.1.1.1 ChartA chart widget visualizes previous standalone reports in one view. Switch between chart types. The configuration options for each widget type stay the same.
2.7.1.1.2 TableA table widget visualizes the result of any report in a tabular form. Special fields include:
2.7.1.2 WorkspaceThere are three types of widgets: Activity Stream, Item Count Trends, and Risk Matrix diagram. These enable the user to visualize Workspace-related data.
2.7.1.2.1 Activity StreamThe Activity Steam widget provides an aggregated view of all recent activities in a Workspace, including wiki pages and item submissions.
2.7.1.2.2 Item Count TrendsThe Item Count Trends widget displays the number of items created versus the number of items resolved over a period of time.
2.7.1.2.3 Risk Matrix DiagramThe Risk Matrix Diagram widget shows the number of requirements, user stories, risks, or epic items related to the likelihood and severity of the risk(s).
2.7.1.3 AgileThe Agile widget helps plan, track, and manage Agile development. Users can monitor, improve, and predict the team’s Agile performance.
2.7.1.3.1 Burn Down ChartThe Burn Down Chart widget displays the burn down chart based on open items for a release or sprint. The chart can be filtered by teams.
2.7.1.3.2 Current VelocityThe Current Velocity widget displays the velocity of the last known work day within a release or sprint. Velocity (the number of items your team can complete) can be filtered by teams.
2.7.1.3.3 Release StatsThe Release Stats widget displays the statistics of a release. Data for these stats are pulled from the release dashboard.
2.7.1.3.4 Remaining TimeThe remaining time widget displays the number of days left until the planned release date of a release or sprint.
2.7.1.3.5 Sprint Break Down WidgetThe Sprint Break Down widget displays the status distribution of all items in a release or sprint. This gives a quick overview of the progress made.
2.7.1.4 TestThe Test widget displays the progress of tests and test results.
2.7.1.4.1 Requirements CoverageThe Requirements Coverage widget displays the test or other item coverage of requirements.
2.7.1.4.2 Test Runs By AssigneeThe Test Runs By Assignee widget displays a bar chart based on all test runs in a Workspace or selected test run Trackers. The chart contains a bar for each user that executed a test run and another bar for a test run with no assignee. The bars show the distribution of results of a given user.
2.7.1.4.3 Test Runs By Test SetThe Test Runs By Test Set widget shows a bar chart of all or selected test runs in a Workspace. Each test set is represented by a bar. The chart shows the distribution of results of a selected test set.
2.7.1.5 OtherUnder the Other tab, find additional widgets for displaying data like reviews, wiki markups, and more.
2.7.1.5.1 My Current ItemsThe My Current Items widget displays a list of items assigned to the current user (items that are not closed or resolved). Items are ordered by priority and the last modification date (descending).
2.7.1.5.2 My ReviewsThe My Reviews widget displays a list of the specified user's reviews.
2.7.1.5.3 TileThe Tile widget displays data (title, subject) and previously defined hyperlinks for navigation purposes.
2.7.1.5.4 Wiki MarkupThe Wiki Markup widget makes a wiki markup reusable on the dashboard.
2.7.2 Change Dashboard LayoutA dashboard can render widgets in grids. Choose from predefined configurations with different number of columns and sizes. This setting (called Responsive) is found in the Widget's editor. The options are:
2.7.3 Dashboard PermissionsTo limit access permissions on a dashboard, open the dashboard’s properties, select related roles in the Workspace, and grant read or write access.
3 Manage Documents In Integrated Documents Management ModuleWith the Documents Management module, store documents and secure role-based access for users to share, download, upload, and track documents. Information about users, dates, and actions are displayed. Prior versions can be restored as well. With the live-edit mode, directly edit Excel, Word, and PPT documents.
3.1 Upload DocumentUpload different types of files in the Documents Management module with the built-in browser or drag and drop. The maximum size of a document you can upload is currently 5 GB. Create directories to structure your data within the module’s directory tree, navigation, and property sections. In the property section, define document permissions and notifications.
3.1.1 Allow DuplicatesTo allow duplications of documents with the same name, open the Document Tracker, and head under the General tab. Check “Allow item name duplications” and hit save. From now on upload multiple documents with the same name. If this option is not allowed, define the upload method by selecting “Create new documents” at the bottom:
3.1.2 Upload Zip FileTo upload a zip file, choose from two upload methods:
3.1.3 Upload ManagerThe Upload Manager is a visible log of uploaded documents. It displays the upload’s file name and the action taken. When uploading, click the bottom right corner of the module to minimize the upload screen. The upload runs uninterrupted after you close the Upload Manager window. Choose to pause, restart, or cancel during your upload.
3.2 Edit Document With Office EditDirectly edit documents with Office Edit.
3.3 Document Versions in ArchiveWhen making edits with Office Edit, saving your document automatically archives the previous version in the history.
3.3.1 Restore Older Document VersionOlder document versions are stored separately and can be restored. To restore a document version, open the editor by clicking the document’s ID. Go to the History tab and select "Revert state of field(s) back to this version".
3.4 Link Document To Items Via AssociationTo link items to one or more documents, open the properties section under the Link tab. Items can be linked to one or several documents. See incoming links and outgoing links to documents. Create new associations in the Associations tab.
3.5 Search In Document ContentBeyond the general search option, search in document content. Click the gear icon in the header of the tree panel to open Settings. Select the document content option, fill in your keywords, and hit save to search.
3.6 Download Documents As Zip FileTo download documents as a zip file, right-click document files on the left panel of your Document view. Click “Download selected”. The tree structure is kept with its content zipped as a file.
3.7 Download Selected DocumentsFrom the document Tracker's tree structure, download items by making your selection and right clicking on one of them. Select “Download selected” from the dropdown menu. You can also download documents by clicking on the item’s ID on the main panel, then selecting the name of the document.
3.8 Document Tracker Content Folder On Main PanelTo see the content of a folder, click the folder name in the document Tracker. View the content on the main panel of your Tracker.
3.9 Store Document In Document TrackerWhen exporting a Tracker's content to office, store the document in the document Tracker. Select the Store option, and then select your Workspace and document type Tracker. In the case of an existing document with the same name, select Overwrite to update the existing document. Or select Rename to keep both files.
3.10 Send Document To RequirementSend a reviewed document to Requirement to transform its requirement(s). Open the Details tab of the reviewed document item. Select "Send document to requirement", and then choose your target Workspace and document type Tracker. See results in Preview, and then hit Finish.
3.11 Copy And Move DocumentTo move your document to another document type Tracker, open the Details tab of your document item. Select “Move to…”, and then choose your target Workspace and Tracker. In the dropdown menu, only a document type Tracker can be selected.
3.12 Sort DocumentsFor folders and document items, the default ordering is A-Z. For Z -A, click "Documents name" at the top of the page. If name duplication is allowed, order duplicated items by different fields.
3.13 Share Folder And ItemsTo share a folder and its content or selected items from a document type Tracker, create a permanent link. Select "Share with others" at the top right of the page. The previous result and the URL can be copied or shared with other users, groups, and email addresses with set configurations. Sharing a folder from a document type Tracker makes its content visible. A shared folder is highlighted in the tree and its content visible on the main panel.
4 TrackersTrackers are essential item containers or tables in relational databases and classes via object oriented programming. Trackers define properties (fields), reference fields related to items in other Trackers, and similar foreign keys. They also define behaviors, permissions, workflows, escalation rules, and notifications. Other Tracker types include requirements, tasks, bugs, change requests, releases, risks, test cases, and more. Easily create and manage Tracker types in codeBeamer MX.
4.1 Manage Trackers-- 4.1.1 Create Tracker And Define PermissionsWith Workspace administrator rights, set up Trackers and permissions defined by roles. Create Trackers and set default properties, workflows, and permissions according to Tracker types.
4.1.2 Customize Tracker AttributesWith administrator rights, customize Tracker attribute. On the Fields tab, add custom fields (type text, integer, date, boolean), calculated fields with syntax, fields with different data sources (options, work/configuration items (CMDB), users, Workspaces), or tables with individual width and height. Define role-based permissions for fields that are unrestricted, single, or different per status. Standard fields for managing Trackers are not removable, including summary, description, and status. Dynamic pic-list fields with dependencies for parent and child hierarchies are defined via association and distribution rules.
4.1.2.1 Create New Tracker FieldUse the Fields management page to create, remove, and customize a Tracker and its preconfigured fields. Create computations as well. Newly created fields are listed or hidden, and can be categorized on the Layouts page.
4.1.2.1.1 Create New Custom FieldTo create a new custom field, open your Tracker’s Configuration page under More Functions. Click “New choice field” at the middle of the Fields page. From the dropdown menu, select “New custom field.” In the editor, add fields like label, description, data source, and more. The "List" checkbox is used to configure which fields should be displayed (as table or list columns).
4.1.2.1.2 Create New Choice FieldA choice field allows selection from a list of choices. To create a choice field, open your Tracker’s Configuration page under More Functions. Click “New choice field” at the middle of the Fields page. In the editor, customize your choice field settings. The "List" checkbox is used to configure which fields should be displayed (as table or list columns).
4.1.2.2 Modify Custom FieldTo modify a custom field, open your Tracker's Configuration page. Select the Fields tab and find custom fields in the Type column. Hover over the field's name and click the down arrow at the right side of the Layout and Content column. Click Edit to update.
4.1.2.3 Delete Custom FieldTo delete a custom field, open your Tracker’s Configuration page. Hover over the field's name and click the down arrow at the right side of the Layout and Content column. Hit Remove to delete. Check audit trails by selecting the Audit Trail tab from your Configuration page.
4.1.2.4 Set Displayed Field LabelsTo configure a displayed field label, open your Tracker's Configuration page. Hover over the field's name and click the down arrow at the right side of the Layout and Content column. Select the Fields tab and click Edit to customize your label of a specific field.
4.1.2.5 Set List View Field VisibilityTo make a field visible, click the eye icon at the right side of the page. Select a field from the dropdown menu to display at the top of the page. To save your view, click the Filter icon, then hit Save in the Standard filter tab.
4.1.2.6 Set Field As Mandatory In Specific StatusWith permissions, set a field as mandatory in a specific status. Open the Fields tab in your tracker's Configuration page, and then click the field’s name you’d like to set as mandatory.
4.1.2.7 Set Allowed Field Values Per StatusTo limit field values based on different statuses, open the Field Configuration page. In the case of pre-configured options for selected fields, set the options per status in the Allowed value column by opening "Allowed/default field values".
4.1.2.8 Set Default Field Values Per StatusTo set default field values per status, open the Field Configuration page. In the case of pre-configured options for selected fields, set the options per status in the Default value column by opening "Allowed/default field values".
4.1.2.9 Set Permission Model To FieldsTo limit access to specific fields, open the Field Configuration page to modify permissions.
4.1.2.9.1 Set Field Permissions To UnrestrictedTo set unrestricted field permissions, open the Field Configuration page and locate the Permissions column. When creating a new custom or choice field, permissions are always set to single. This can be changed by selecting the unrestricted option from the dropdown menu.
4.1.2.9.2 Set Field Permissions To SingleTo set field permissions to single, open the Field Configuration page and locate the Permissions column. Click the permission name, and then select the single option from the dropdown menu.
4.1.2.9.3 Set Field Permissions To Per StatusTo set field permissions to per status by specific roles, open the Field Configuration page and locate the Permissions column. Click the permission name, and then select the per status option from the dropdown menu. When selecting this option, statuses are displayed based on the Tracker's State Transition diagram. By default, users are assigned edit permissions. Change this to special permissions for different statuses by clicking the down arrow next to the default label.
4.1.2.10 Set Field Permissions By RolesTo limit field permissions by specific roles, open the Field Configuration page and locate the Permissions column. Click the permission name to assign roles. If the status-based field is set to special, click the grey space to assign users in different statuses. You can also set default value permissions at the top of the page for each status and role.
4.1.2.11 Set Field Distribution RulesFor users with parent/child hierarchies of configuration and work items, define dependencies between parent and child field values. To ensure that parent items are not closed until all child items are closed, use distribution rules under the Distribution rule column on the Field Configuration page. See standard distribution rules below:
4.1.2.12 Set Field Aggregation RulesSet aggregation rules when an item’s parent field values depend on child values. Aggregation rules can be set under the Aggregation rule column on the Field Configuration page. See standard aggregation rules below:
4.1.2.13 Set Field DependenciesTo define field dependencies between different fields of the same item, open a field by clicking its name under Data source. Create dependencies between selected fields.
4.1.2.14 Set Computed FieldA custom field can be computed by specifying an expression or formula. It defines read-only Tracker fields calculated from other Tracker item fields.
4.1.2.14.1 Calculate Field ValueTo help search and filter your database, calculated field values are stored immediately.
4.1.2.15 Static DependencyTo create static dependency: Create two choice fields “A” and “B” under the Tracker configuration‘s Fields tab. Set available options for field A. In field B, set field A as “Depends on” under Data source. Set available options for field B. Hit Save. Note: options chosen for field B are forbidden for field A. To set static dependency, go to the Fields table under the Layout and content column, and then click the Depends on <fieldName> link. When choosing an option from field A in the first column, add one or more options from field B in the second column.
4.1.3 Workflow ConfigurationEach Tracker has its own customizable BP (business process) along with codeBeamer MX's workflow BPM (Business Process Management). The workflow can be configured in the Tracker customization section under the State Transition tab. When creating a new Tracker, a standard workflow is provided. There are two basic workflow elements: 1) states equivalent to concept of nodes and 2) transitions equivalent to directed edges in a graph. When there are no additional status options, add new status options or delete existing ones. To set a status transition on the user interface, you can select the initial status, target status, and name your transition. With a Graphviz installation on codeBeamer MX, transitions are visualized on a UML state diagram. For each transition, permissions per role, optional conditions, and guards can be defined. Conditions define the context or which Trackers they are for. Guards allow users to pass transitions if the items match specific criteria. Optional workflow actions are defined for automatic implementation.
4.1.3.1 Workflow DiagramA workflow provides better control for critical tasks or requirements where changes have strong impacts on resources and deliverables. To access a workflow diagram, open the Tracker’s Configuration page and head under the State Transitions tab. Trackers use a simple and flexible process to model business process workflows. View your work progress under Item status. There are different status meanings that indicate which phase an item is in:
There can be different statuses in the same phase. Each status is indicated by its own color. Statuses reflect a progressive direction from open to closed. In a workflow diagram, it’s important to mention actions that call for specific events in specific tasks. Actions can be displayed as parameters, improving reusability and transparency.
4.1.3.2 Default Workflow TrackerBy default, Trackers consist of a configurable workflow diagrams (except for test runs and teams Trackers). In test run Trackers, workflow diagrams are not configurable. In team Trackers, there are no workflow diagrams.
4.1.3.3 Add New StatusView your work progress under Item status. To create a new status, open the Tracker’s Configuration page. Under the State Transitions tab, click “Add status”. There are different status meanings that indicate which phase an item is in:
4.1.3.4 Modify StatusTo modify a status, open the Tracker’s Configuration page. Under the State Transitions tab, click “Add status”. Select a status name to modify ID, name, color, description, and meaning of the status.
4.1.3.5 Delete StatusTo delete a status without items in that specific status, open the Tracker’s Configuration page. Under select the State Transitions tab, click “Remove option”.
4.1.3.6 Add New State TransitionTrackers hold state transitions where workflows are enabled. This allows for smooth control over Tracker item lifecycles (business processes) and associated workflows. To define a new state transition, open the Tracker’s Configuration page, and head under the State Transitions tab. Click “More” for the dropdown menu, and then select State Transition. In the open dialog, enter transition specifications. To specify transitions, you must add the statuses From and To:
4.1.3.6.1 Set Transition From StatusTo set a transition in a specified status, open the Tracker’s Configuration page, and select the State Transitions tab. Click “More” for the dropdown menu, and then select the State Transition option. Select a status in the From field.
4.1.3.6.2 Set Transition To StatusTo set a transition in a specified status, open the Tracker’s Configuration page, and select the State Transitions tab. Click “More” for the dropdown menu, and then select the State Transition option. Select a status in the To field.
4.1.3.6.3 Name TransitionTo name a transition, open the Tracker’s Configuration page, and select the State Transitions tab. Click “More” for the dropdown menu, and then select the State Transition option. Add name.
4.1.3.6.4 Set Transition DescriptionTo set a description for a transition, open the Tracker’s Configuration page, and select the State Transitions tab. Click “More” for the dropdown menu, and then select the State Transition option. Add description.
4.1.3.6.5 Set Transition PermissionTo set permissions for a state transition, open the Tracker’s Configuration page, and select the State Transitions tab. Click “More” for the dropdown menu, and then select the State Transition option. Add permissions under Permitted.
4.1.3.6.6 Add Transition ConditionTo add conditions to a state transition, open the Tracker’s Configuration page, and select the State Transitions tab. Click “More” for the dropdown menu, and then select the State Transition option. Add conditions. You can choose from the following options:
4.1.3.6.7 Add Transition GuardTo add guards for a state transition, open the Tracker’s Configuration page, and select the State Transitions tab. Click “More” for the dropdown menu, and then select the State Transition option. Click “Add” to define guards under the Guard section.
4.1.3.6.8 Add Transition ActionWorkflow actions can be associated with a state transition. Choose from the following actions:
4.1.3.7 Modify Status TransitionTo modify general properties, permissions, conditions, or guards of a state transition, open the Tracker’s Configuration page. Go to the State Transitions tab, and then click the transition name to edit properties. You can also edit a transition by clicking the transition’s arrow icon on the workflow diagram.
4.1.3.7.1 Add, Edit, Delete Workflow ActionTo add, edit, and delete workflow actions, open the Tracker’s Configuration page. Go to the State Transitions tab, and then click the transition name to edit actions.
4.1.3.7.1.1 Workflow Action - Update Item PropertiesWhen you update item properties for a workflow action, the field selector shows all Tracker items you can update, including source/subject of the triggering event. For each selected field, you can choose whether to:
4.1.3.7.1.2 Workflow Action - Update Referring ItemsWhen you update referring items with the action selector, you also have to set:
There are two types of updates for referring items:
4.1.3.7.1.3 Workflow Action - Create New Referring ItemsThis workflow action creates new referring items. Head under the Tracker Item Details page and select from the Create Downstream Reference menu. When you update referring items with the action selector, you also have to set:
4.1.3.7.1.4 Workflow Action - Create New Sequential ID/NumberThis workflow action is used to store Tracker specific sequential and consecutive ID/numbers in custom fields (source/subject of the triggering event). Example: With the Orders Tracker, you want the order items to have sequential and consecutiveordering numbers. To do so, define your Order No as a custom Orders field with a type Integer (or Text).
4.1.3.7.1.5 Workflow Action - Execute Custom ScriptThis workflow action executes a script on a workflow transition. A System Administrator must carefully review and approve the workflow transition script. Then, upload the script file to the "config/scripts/workflow" directory below codeBeamer MX’s installation. The action has three parameters:
These script languages are currently supported:
Writing the workflow action as a script has advantages:
There are a few disadvantages:
4.1.3.7.1.6 Workflow Action - Create New BaselineThis workflow action creates a new Baseline. The action has three parameters:
Scope can be: Tracker: create a new Baseline for the tracker item (subject/source of the triggering event) Workspace: create a new Baseline for the entire Workspace item (subject/source of the triggering event) Name and description includes:
4.1.3.7.1.7 Workflow Action - Add New Workspace BaselineThis workflow action creates a new Workspace Baseline. The action has three parameters:
Of the new Workspace baseline. The scope can create a new Baseline in the entire Workspace of the item (subject/source of the triggering event). Name and description includes:
4.1.3.7.1.8 Workflow Action - Add New Tracker BaselineThis workflow action creates a new Tracker Baseline. The action has three parameters:
It can create a new Baseline in the entire Workspace of the item (subject/source of the triggering event). Name and description includes:
4.1.3.7.1.9 Workflow Action - Remove Item AttachmentThis workflow action removes an item’s attachment. To open this action, go to guard conditions and click “Add”. The guard has three parameters:
4.1.3.7.1.10 Workflow Action - Send Custom Email To RecipientsThis workflow action sends a custom email to specified recipients. The action has three parameters:
4.1.3.7.1.11 Workflow Action - Start New ReviewThis workflow action starts a new review process that gives control over:
To set a review status, add workflow action “Start a new review” to status entries or incoming state transitions to trigger the review.
4.1.3.7.1.12 Workflow Action - Validate User Signature (Password)This workflow action is for state transitions. It enforces regulatory requirements with the use of electronic signatures. To use this action, first define a custom Tracker text field to hold the user signature and password. The name or label of the field should be Signature or Password. Use either and the GUI’s input field will be a plain text field instead of a password field.
4.1.3.8 Delete State TransitionTo delete a state transition, open the Tracker’s Configuration page, and then select the State Transitions tab. Click the Remove icon next to the transition you’d like to delete.
4.1.3.9 Suspect GuardAdd suspected support for state transition guards, conditions, and calculated fields. Set whether an item has suspicions in calculated fields or guards and conditions in workflow actions. "Suspected reference" guard has:
4.1.3.10 Review GuardWith a review guard, set restrictions on a Tracker’s state transitions. Require that an item is reviewed before it gets moved to a specific status. To add a guard, open the Tracker’s Configuration page, and then select the State Transitions tab. Click Edit on a transition, then click Add link next to the guard list. After the guard is set up, codeBeamer MX checks for any review on the item in the Review Hub whenever you’d like to execute the transition.
4.1.4 Tracker History Audit TrailThe Audit Trail displays the history of configurations made in a customized Tracker. Tracked changes include general Tracker, field related, and state transition changes. The Audit Trail includes the following:
Figure: Field Changes in Audit Trail
4.1.4.1 Tracker ChangesTo check for Audit Trails of a specific Tracker, open the Tracker’s Configuration page, and select the Audit Trail tab. Select the Tracker option.
4.1.4.2 Field ChangesTo check for Audit Trails of a specific field, open the Tracker’s Configuration page, and select the Audit Trail tab. Select the Field option.
4.1.4.3 Workflow ChangesTo check for Audit Trails of a specific workflow, open the Tracker’s Configuration page, and select the Audit Trail tab. Select the Workflow option.
4.1.4.4 Transition DiagramsTo check for Audit Trails of a specific transition diagram, open the Tracker’s Configuration page, and select the Audit Trail tab. Select the Transition Diagram option.
4.1.4.5 PermissionsTo check for Audit Trails of a specific permission, open the Tracker’s Configuration page, and select the Audit Trail tab. Select the Permissions option.
4.1.4.6 Export Audit TrailTo export Audit Trails, open the Tracker’s Configuration page, and select the Audit Trail tab. Select the Export to Word option.
4.1.5 Workspace Configuration DiagramTo visualize reference relations between Trackers as a diagram, go to the Tools tab and select Workspace Configuration Diagram. To change the visibility of Trackers, click on Trackers in the left tree. When opening the configuration diagram, the last selected Tracker list is displayed.
4.1.6 Delete TrackerTo delete a Tracker, open the Tracker’s Configuration page, and select the General tab. Select the delete option for your Tracker at the bottom of the page.
4.1.7 Modify Tracker General PropertiesTo modify the general settings of a Tracker, open the Tracker’s Configuration page, and select the General tab.
4.1.7.1 Modify Tracker NameTo change the name of a Tracker, open the Tracker’s Configuration page, and select the General tab. Find the option to modify under the Name section.
4.1.7.2 Modify Tracker KeyTo modify the key of a Tracker, open the Tracker’s Configuration page, and select the General tab. Find the option to modify under the Key (short name) section.
4.1.7.3 Modify Tracker Default LayoutTo modify the default layer of a Tracker, open the Tracker’s Configuration page, and select the General tab. Find the option to modify from the dropdown menu.
4.1.7.4 Modify Tracker DescriptionTo modify the description of a Tracker, open the Tracker’s Configuration page, and select the General tab. Find the option to modify under the Description section.
4.1.7.5 Enable/Disable Tracker WorkflowTo enable or disable the workflow of a Tracker, open the Tracker’s Configuration page, and select the General tab. Find checkbox options to enable or disable workflow and transition actions.
4.1.7.6 Enable/Disable Tracker VisibilityTo enable or disable the visibility of a Tracker, open the Tracker’s Configuration page, and select the General tab. Under the Tracker’s overview, find checkbox options to hide or display a Tracker next to “Visible”.
4.1.8 Create Tracker From TemplateEasily create a new Tracker based on another Tracker template. First mark the Tracker you’d like to use as “Available as template” in the Tracker’s Configuration page under the General tab. Then go to Workspaces to create a new Tracker. Select the template Tracker from the dropdown menu. When using a template, the entire configuration is copied.
4.1.9 Change Tracker TemplateWhen changing the template of a Tracker, you get a warning message that the new template will replace all current settings of the Tracker. This causes a loss in data, configurations, and references. These modifications can not be reversed.
4.1.10 Modify Tracker Permissions In Permission-Role MatrixTo modify permissions of a Tracker, open the Tracker’s Configuration page, and select the Permissions tab. Only permitted users can edit the permissions of specific roles.
4.1.11 PermissionsBy setting Permissions for each Tracker, users decide which roles should have access to different actions. Actions include:
4.2 Manage Tracker ViewsA tracker’s document view displays items as paragraphs of a single document, available for requirements, risks, change requests, user stories, and test case Trackers. There are three panels: 1) node tree in the left, 2) document in the middle, and 3) properties, libraries, and releases in the right. Items can be organized and restructured via drag and drop. The table view shows Tracker items ordered in a tree. Parent items can be expanded to show its children items. The cardboard view focuses on work progress with items presented in the form of cards. Each column represents a different work status. The test coverage browser view gives a quick overview of requirements verified by test cases plus information like how. The traceability browser view shows the correlation of any number of Trackers in a desired order, with a visualized focus on dependencies. It displays corresponding items to selected Trackers and Tracker types. For every Tracker, codeBeamer MX provides out-of-the-box views for browsing items (e.g. all items, all open items, all items assigned to me). Subsets of items are filtered in a table view. Any user with administrator Tracker permissions can edit and delete public views. Define personal or public viewing access (set/unset default), choose layout displays (e.g. Table, Document View), and select the visibility of field conditions. The criteria for conditions can be added by using the condition tree or grouping operators.
4.2.1 Document ViewFor document view, find the dropdown option at the top of the page. Change the Tracker view by clicking the chevron down icon and selecting a desired view. By selecting a different view, the page loads automatically.
4.2.2 Cardboard ViewFor cardboard view, find the dropdown option at the top of the page. Change the Tracker view by clicking the chevron down icon and selecting a desired view. By selecting a different view, the page reloads automatically.
4.2.3 List ViewFor list view, find the dropdown option at the top of the page. Change the Tracker view by clicking the chevron down icon and selecting a desired view. By selecting a different view, the page reloads automatically.
4.2.4 Default Field Filter In Tracker ViewEvery Tracker view has a filter icon at the top right section of the page. Click to display a filter panel with different attributes and values. Click the + icon for an overlay of fields with default options. Select any and set the value(s) to filter. Hit Go to reload the page based on the new filters.
4.2.5 Common Reference Field Filter In Tracker ViewEvery Tracker view has a filter icon at the top right section of the page. Click to display a filter panel with different attributes and values. Click the + icon for an overlay of fields with common reference fields. Select any along with Workspaces and Trackers where reference items can be found. Start typing a reference name in the field box at the bottom of the page; auto complete finds matching items. Add as many needed. Hit Go to reload the page based on the new filters.
4.2.6 Custom Fields Filter In Tracker ViewEvery Tracker view has a filter icon at the top right section of the page. Click to display a filter panel with different attributes and values .Click the + icon for an overlay of fields with custom, default, and common reference options. Grouped by Workspace and Tracker names, select any and set the value(s) to filter. Hit Go to reload the page based on the new filters.
4.2.7 AND/OR Logic FilterIf you filter with more than two attributes, you can add AND/OR logic filters. By default, conditions use the AND logic. To add logic filters on two conditions, click the -/+ icon next to Add filter. See conditions numbered in the open dialog. Use this numbering to identify conditions with 1 AND 2 or 1 OR 2 to define your logical phrase. Hit Go to reload the page based on the new filters.
4.2.8 Complex AND/OR Logic FilterIf you filter with more than two attributes, you can add AND/OR logic filters. By default, conditions use the AND logic. To add logic filters on two conditions, click the -/+ icon next to Add filter. See conditions numbered in the open dialog. Use this numbering to identify conditions with AND, OR, and round brackets to define your logical phrase. Hit Go to reload the page based on the new filters.
4.2.9 Order Options In List ViewTo order options in list view, click the column’s header. The first click displays items in ascending order. The second click displays items in descending order.
4.2.10 Order Options In Cardboard ViewTo order options in cardboard view, select Order in the dropdown menu at the top of the page. By default, options are in ascending order.
4.2.11 Group Options In List ViewTo group options in list view, click the filter icon at the top right corner of the page to display the filter panel. At the bottom of the panel, find Group by section and select any field to group items. Hit Go to reload the page. Groups are highlighted in the list.
4.2.12 Group Options In Cardboard ViewTo group options in cardboard view, click Swimlane in the dropdown menu at the top of the page. Cards are grouped by selected options, displayed as swimlanes that you can expand and collapse. After selecting options, three new swimlane elements are displayed next to the dropdown menu – use to define the order of cards. Click the arrow button to expand or collapse all swimlanes at once.
4.2.13 Create Tracker ViewTo create your own Tracker view, click the filter icon at the top right corner of the page. Create conditions, define logic (optional), set visible columns (for list and document view), and hit Save. Name your Tracker, set to public or private, add description (optional), and hit Save. After saving, your new Tracker is selected and active, also displayed in the View dropdown menu. To set it to default, click the pipe icon next to its name.
4.2.14 Default ViewTo select a view, find the View dropdown at the top left section of a Tracker. Select a view to reload your page instantly. To set a view to default, click the pipe icon next to its name.
4.2.15 Modify View To Public/PrivateTo modify a view, select from the View dropdown at the top left section of a Tracker. Click the filter icon at the top right corner of the page. In the view settings, modify these conditions at any time. Hit Go to reload the page based on the new filters. When modifying a default view, save it as a custom view. The default view itself doesn’t change. When modifying a custom view, modify the current view or create a new view based on the current view. Find either in the dropdown menu of the Save button. Change the properties of the current custom view by selecting Properties in the dropdown menu of the Save button.
4.2.16 Delete Public/Private ViewYou can delete custom views, but not default views. To delete a custom view, select and the view and click the filter icon at the top right corner of the page. On the filer panel, find the dropdown menu of the Save button and hit Delete.
4.2.17 Reference Filter In Tracker ViewClick the filter icon at the top right corner of the page to display the filter panel. Under Reference Filters, select upstream/downstream references. To filter by a specific reference, select reference item(s) on the filter panel.
4.2.18 Traceability Filter In Document And List ViewClick the filter icon at the top right corner of the page to display the filter panel. Select the Traceability filter tab to choose initial levels, filters, order by, visible columns, and ancestor/descendant item visibilities. Set levels, filters for these levels, and hit Go. The traceability is displayed in a list or document view. In list view, select horizontal or vertical displays by selecting view mode at the top of the filter panel.
4.2.19 Resize And Reorder Columns In List ViewIn list view, resize and reorder columns. Hover over the header row between two columns to trigger the resize cursor. Click and drag the column separator to resize the column’s width. Reorder displayed columns by dragging and dropping the headers.
4.2.20 Historical Filter In Tracker ViewFind historical filters at the bottom of the filter panel. With historical view, display items by a Baseline or date. Other options include the Release and Sprint start or end date. Hit Go to reload the page based on the new filters.
4.2.21 Manage Information Type For Folder And ItemFilter items with the Type attribute by selecting folders and/or information meanings by values.
4.2.22 Manage Hidden Field In Saved Report Or ViewHide a field to make it unavailable from the filter list. Saved filters and views with hidden fields operate the same as before.
4.3 Manage Tracker ItemA Tracker holds work and configuration items. Work items consist of requirements, tasks, or user stories – where users can work on these items on a daily basis. Configuration items are where you manage and handle items like releases.
4.3.1 Create ItemIn a Tracker, users with Item-Add permissions can create new items in document, list, cardboard, and out-of-the-box views.
4.3.2 Edit Work Item With Froala Or Office-EditWork and configuration items can be directly edited with the built-in “What you see is what you get” editor (Froala). You can also edit items with Office-Edit. To do so, open your item and select "Edit via Office" from the More Functions dropdown menu. Hit Save to apply changes automatically.
4.3.3 Item Versions In HistoryItem modifications are stored as different versions in the History tab. Find detailed item versions with highlighted differences for comparison.
4.3.3.1 Compare Versions In HistoryTo compare different versions of an item, open the modified item and head under the History tab. Select any two of the item versions, then click Compare Tracker to see highlighted differences.
4.3.4 Associations And ReferencesReferences are relations bound to Reference Fields of Tracker items. Reference fields are similar to foreign keys in relational databases. They can:
Associations are ad hoc relations between Tracker items and any of the following:
Unlike a reference, an association does not have a defined value set, severity, or permissions.
4.3.4.1 AssociationWhen using an association, an item can be linked to any document, wiki, or other ad hoc. Ad-hoc links can be created by anyone and show suspected links. To add an association to an item, either 1) drop the item into the center panel from another work location in document view, or 2) go to the item’s details and click “Add Association”.
4.3.4.1.1 Modify AssociationOpen the Tracker item details and select the Associations tab. Item associations are displayed in a table. At the end of every row there is a caret down icon where you can select Edit to modify an association. Modify:
4.3.4.1.2 Delete AssociationOpen the Tracker items details and select the Associations tab. Item associations are displayed in a table. At the end of every row there is a caret down icon where you can select Edit to modify an association.
4.3.4.1.3 Activate Suspect LinkWhen you create or modify an association, check for suspect links by activating the suspect link function. Check the Reverse direction box to reverse suspect direction.
4.3.4.2 ReferenceWhen using a reference, establish a link between Tracker items and control role-based permissions for each reference field. Define a reference in the property section under the Fields tab. Each Tracker has a reference field with the property name “subjects”. Additional reference fields can be added by a user with Tracker administrator rights. To add more reference fields, select a choice field and change the data source to “work/config items”. Create a foreign key in the target Tracker to generate the source Tracker of a Workspace. Select “new referring item” in the target Tracker to link it automatically. If you create the item independently in the target Tracker, you may link the source Tracker manually.
4.3.4.2.1 Modify ReferenceTo modify a reference, switch to edit mode and click the arrow icon next to the reference name. Modify by:
Restore predefined settings of a reference by selecting “Set default values“
4.3.4.2.2 Delete ReferenceTo delete a reference, switch to edit mode and click the X icon next to the reference name.
4.3.4.2.3 Create New Referring ItemTo create a new referring item, open the Tracker item details and click “Add downstream reference” or “new item” at the top left corner. Any Tracker in the Workspace referring to another Tracker is listed on the displayed panel. After creating a new referring item, it automatically links to the previous item in the reference field.
4.3.4.2.4 Suspected And Reverse Suspected Relation In ReferenceTo set up a suspected and reverse suspected relation in a reference, switch to edit mode and click the arrow icon next to the reference name. To set up a suspected reference, check the Propagate suspects option. To change a suspected direction, check the Reverse or Bi-directional option.
4.3.4.3 Suspected LinksWith the traceability matrix, define dependencies between Tracker items. Check "Propagate suspects" to change the dependency of item A (A <- B). B is marked as suspected. In document view, suspected links are displayed in three places:
Re-use requirements from the Library by copying items linked to the original item via association. When an original requirement is changed, it gets flagged as a suspected, notifying the user for review. When an item is linked to another item via association, the user can decide whether codeBeamer MX should propagate a suspected link. When an associated target item is changed, it gets flagged as a suspected link, notifying the user. Accept or reject changes by clicking the suspected link.
4.3.4.3.1 Mass Merge Of Suspected ChangesIf two related items have the same Tracker type, you can merge the values of one item to another. Click the suspected badge to open the merge dialog. Merge attributes one-by-one, or use the switch button in the table header to merge all attributes together. Hit Save to apply your merges.
4.3.5 Work Item CollaborationsAdd comments and attachments and/or delete Tracker items with the right permissions.
4.3.5.1 Add Comment/AttachmentA comment can be added in three places:
Click the editor in any of these pages to make a comment instantly. Add an attachment to either a description or comment. Use the editor toolbar to browse or drag and drop an item.
4.3.5.2 Modify Comment/AttachmentTo modify a comment or attachment, hover your mouse over an existing comment. With permissions to edit the comment, a pencil icon appears. Click the pencil icon to edit, then hit Save on the editor toolbar to update the comment.
4.3.5.3 Delete Comment/AttachmentTo delete a comment or attachment, hover your mouse over an existing comment. With permissions to delete the comment, a trash icon appears. Click the trash icon to delete. To delete an attachment, click the down arrow and hit Delete.
4.4 Document ViewIn document view, read and edit items in the form of paragraphs. Each item is displayed as a numbered paragraph. The numbers mirror the hierarchy of items.
4.4.1 FilteringIn document view, click the filter icon at the top right corner of the page to display the filter panel. Define your criteria and hit Go to see the filtered item list. Use the Traceability filter to create Personal or Public views specific to the tracker. Saved and predefined views are found under the View dropdown menu at the top of the page. When a Tracker item is displayed after filtering, parent items are displayed even if they don't satisfy the filter conditions.
4.4.1.1 Filter By StatusTo filter by status, click Add filter on the filter panel. Under Default fields, select Status. Filter a status by Tracker specification or meaning. A status meaning can contain more than one status depending on the field configuration.
4.4.1.2 Filter By Last Modified DateTo filter by last modified date, click Add filter on the filter panel. Under Default fields, select Modified. Filter by:
Hit Go to apply modifications.
4.4.1.3 Filter By Suspected AlertTo filter by suspected alert, click Add filter on the filter panel. Select the option under Suspected references. Filter by:
4.4.1.4 Filter By Existence Of ReferencesTo filter by existence of references, click Add filter on the filter panel. Select the option under References. Filter by:
4.4.2 Navigating Document ViewA document view contains the following three panels:
All items in a Tracker appear in the requirement tree and document itself. Use the report query in the action bar control to find specific items. The requirement tree shows parent-child hierarchy with Tracker names. Easily navigate by clicking on an item in the document. Clicking an item in the tree automatically loads the corresponding paragraph. Open the Properties tab by clicking "Show right panel" next to the item's summary. Resize the panel width between the tree and document by moving the gray separator. To hide the requirement tree, click the left arrow icon “Hide left panel” next to Search. To close the right panel, click the X at the top right of the panel.
4.4.2.1 Collapse/Expand Left TreeTo collapse and expand nodes, click the arrow icons. Another option is to open the node’s menu by right-clicking a tree node. Use the displayed options to collapse or expand your current node. If your node holds child items, the option to expand all child items is available from the context menu.
4.4.2.2 Change Width of Left TreeChange the width of the left tree by dragging the gray bar between the tree and main panel.
4.4.2.3 Left Tree ConfigurationTo configure the left tree, click the gear icon on the tree panel’s header. Under Settings, configure what to display and what search results to indicate. Choose to show or hide:
When you search in the tree, choose to highlight with predefined colors:
Hit Save to apply modifications and reload the page.
4.4.2.3.1 Show Item IDs In Left TreeTo display item IDs in the left tree, open the tree settings and select from the item IDs checkboxes.
4.4.2.3.2 Show Numbering In Left TreeTo show numbering in the left tree, open the tree settings and select from the numbering checkboxes.
4.4.2.3.3 Show Suspected Alerts In Left TreeTo show suspected alerts in the left tree, open the tree settings and select from Marked items with suspected links.
4.4.2.3.4 Show Child Counts In Left TreeTo show child counts in the left tree, open the tree settings and select from Show child counts.
4.4.2.4 Filter Left TreeWithout filtering the main panel, filter the left tree by typing in the filter field on the header of the tree panel. Click the gear icon to open settings and choose what fields you want to search in. Matching items are highlighted by predefined colors which you can set in settings.
4.4.3 Organize Items In TreeOrganize items in your tree by:
4.4.3.1 Create Item In Left Tree Context MenuTo create a new item in your tree, right-click on a Tracker item to open the context menu. Click “In New...” to create:
4.4.3.2 Copy/Paste Item In Left Tree Context MenuTo copy and paste an item in your tree, right-click on a Tracker item to open the context menu. Choose from these options:
With successful cut and copy, an on-screen notification confirms the item is copied to a clipboard. Paste options include:
4.4.3.3 Change Item Order In Left Tree Via Drag And dropChange the order of items in your tree easily with drag and drop. After dragging one or more items, possible drop areas are highlighted in green. Dropping an item to a new area reloads the page with the new updates.
4.4.3.4 Delete Item In Left TreeTo delete an item in the left tree, right-click on the item to open the context menu and hit Delete.
4.4.4 View And Edit ItemTo view and edit an item, click the item’s description or name. The item then becomes editable on the main panel of the page. Double click the item’s name in the tree to open a detailed editor.
4.4.4.1 Perform State Transition Via Status FieldTo change an item’s status in document view, click the down arrow next to the status badge. Click on an available transition listed in the panel. If the item has all required fields filled, the transition is executed immediately. If the item has any empty required fields, a dialog opens. Set the required fields and hit Apply to activate your transition.
4.4.4.2 Edit Item Summary And DescriptionWith proper permissions, edit the summary and description of an item on the main panel. To edit the summary, click to switch to edit mode. After your modifications, click outside of the field to save. To edit the description, click to display the editor. After your modifications, hit Save on the editor toolbar.
4.4.4.3 Rename Item In Left TreeTo rename an item in the left tree, right-click on the item to open the context menu and select Rename. Hit the save icon next to the item name.
4.4.4.4 Drag And Drop Item On Main Panel To Create Association And ReferenceAdd a relation to an item by using drag and drop from another browser page. Open two pages (A and B). Drag the item from page A with the 6-points icon. Move it over to another item on page B. There are three options when dropping an item:
4.4.4.5 Add Quick Comment On Main PanelTo add a quick comment on the main panel, hover your mouse over a Tracker item. Click the comment icon that shows up next to the item.
4.4.5 Create Reference In MenuIn the references menu you can:
4.4.5.1 Create Referring Items With + IconTo create referring items easily, hover your mouse over a Tracker item on the main panel. Click the + icon that shows up on the left of the item. Click Add downstream reference or the + icon to display an overlay. Select a Tracker to create a new downstream reference. The newly created item will contain a reference to the current one.
4.4.5.2 Create New Item With + IconTo create a new item easily, hover your mouse over a Tracker item on the main panel. Click the + icon that shows up on the left of the item. Click Add downstream reference or the + icon to display an overlay. Select a Tracker to create a new item.
4.4.6 Panel PropertiesView and modify item details in the properties panel by double clicking an Item in the left tree. Or click “Show right panel” next to the item's summary.
4.4.6.1 Display Fields In Details TabTo display fields in the Details tab, hover your mouse over a Tracker item on the main panel. Click “Show right panel”. Find these tabs:
The right panel can be closed with the X icon at the top right side. Click on another item on the main panel to refresh the right panel and display updated data.
4.4.6.2 Edit Field Values In Details TabWith permissions, modify items that are editable on the right panel. Simply click the field to make edits. To save, click outside of the field. Edit wiki fields (e.g. pre-action, description, test parameters) by clicking a field. Hit Save on the editor to apply modifications.
4.4.6.3 View Reference And Association In Relations PanelView item relations on the relations panel. They are grouped as:
4.4.6.4 Add Association In Relations PanelTo add a new association, click New association at the top of the relations panel. In the dialog, set the association type, suspect link, comment, and items.
4.4.6.5 View Comment, Attachment, Status Change, And Worklog In Timeline PanelOn the timeline panel, view comments, attachments, status changes, and worklogs. Search for timeline items with the input field at the top of the panel. Start typing to filter items. Use the Sort button to list items in ascending or descending order. To make items visible, click the filter button and select from the following:
4.4.7 Document Traceability ViewDisplay upstream and downstream references of Tracker items (including custom Trackers) from any Workspace by using the Traceability Browser filter in Document Traceability view. Upstream and downstream references are any type of items added from your selected Trackers. Save your view as public or personal.
4.5 Document View ComparisonVisually compare differences between Baselines in document view. Click the three dots at the top right of the page (next to the eye icon) and select "Compare Baselines" from the dropdown menu. The differences are highlighted.
5 Requirement ManagementHandle Tracker requirements by types in the same Workspace. Edit requirements in table or document view.
5.1 MS Office Import, Export, And Round-TripWith Microsoft Office (Word, Excel, MS Project) import items into Trackers. On a Tracker’s action bar, find the “more” menu and select “Attach a file” or drag and drop to upload your document. When importing a Word document, your file should be structured using Word formats. Make sure to use appropriate header styles for headers and normal text styles for descriptions. Different header styles generate parent-child relationships between items. A preview is shown before finalizing your import. codeBeamer MX generates three panels: 1) tree structure in the left, 2) content in the middle, and 3) import rules for conditions plus statistics in the right. Define import rules with actions, filters, conditions, and logic selectors like AND/OR. Default rules can be added, modified, or deleted. Overwrite actions by using the switch toggle during your import. When importing an Excel document, your file should be structured using Excel formats. Make sure the first row contains header information like property or field names. During the import, codeBeamer MX automatically pairs headers to the closest matching fields in the target Tracker. Use the option to map cell-data from the Excel to Tracker fields. Add hierarchies by structuring your Excel with columns and indented data. Use advanced data conversion with scripts like JavaScript, Groovy, and JEXL. The import can be aborted at any time. Export an entire Tracker or selected items into MS Office. For Word and Excel, generate a simple data document or a Round-trip document. Exporting data using a Round-trip document allows you to make changes offline. It also allows external users to collaborate on the document with changes made back into codeBeamer MX. Notifications are sent when there are any changes in the document. Modified items are highlighted where users can decide to apply or decline before being reflected into codeBeamer MX. Use customized templates for Word and Excel in Documents Management. These templates contain scripts and special tags in order to control what content should be exported and how the exports should look. In the Export to Office dialog, upload a template file from local files or from a specific directory available in Documents Management. The Word export template uses Apache velocity scripts. The Excel export template uses JETT, an open-source engine for handling templates.
5.1.1 Import With WordImport items into a Tracker with Microsoft Word. Your Word document should be structured using Word formats. Make sure to use appropriate header styles for headers and normal text styles for descriptions. Different header styles generate parent-child relationships between items. On a Tracker’s action bar, find the “more” menu and select “Attach a file” or drag and drop to upload your document. codeBeamer MX generates three panels: 1) tree structure in the left, 2) content in the middle, and 3) import rules for conditions plus statistics in the right. Rules are what you’d like items to do if defined conditions are met. Define import rules with actions, filters, conditions, and logic selectors like AND/OR. Default rules can be added, modified, or deleted. Overwrite actions by using the switch toggle during your import. A preview is shown before finalizing your import.
5.1.2 Import With ExcelImport items into a Tracker with Microsoft Excel. Major features include:
Before importing an Excel file, it should follow these rules:
To start your import, go to your Tracker’s action bar. Find the “more” menu and select “Attach a file” or drag and drop to upload your file. Configure the details in the import process that follows.
5.1.3 Simple Export To Word/ExcelExport several work items (requirements, tasks, bugs) with a simple export. Open your Tracker, switch to list view, find the "more" menu, and select "Export to Office”. This export includes fields available in View and items that match your current view.
5.1.4 Round-Trip Export To Word/ExcelExport several work items (requirements, tasks, bugs) with Round-trip export:
To export items from codeBeamer MX to a Round-trip document, open your target Tracker. Find the “more” menu and select "Export to Office". Choose "Selection" to export only selected items. In the next dialog, select “Round-trip”. A Word document is generated with the items displayed in the current view – the file is downloaded automatically. The file name contains the current Workspace and Tracker names.
5.1.5 Re-Import Modified Round-Trip FileAfter editing a Round-trip Word document, import changes back to codeBeamer MX by selecting "Import from Word or Excel" under the More Functions menu of your Tracker.
5.1.6 Upload Customized Template In Documents ManagementWord and Excel Templates use scripts (e.g. Groovy). With administrator rights, review these templates and scripts to ensure there are no malfunctions, malicious attacks, or security problems. You can create customized templates to show up under codeBeamer MX’s custom templates. Select “Export to Office” under the More Functions menu and fill in export details. Click “Manage custom template” to upload your own template.
5.1.7 Export Word/Excel With Customized TemplateTo export a Word or Excel document using a customized template, the template should be uploaded in codeBeamer MX. Select “Export to Office” under the More Functions menu and fill in export details. Click “Manage custom template” to upload your own template.
5.2 LibraryThe Library stores requirement Trackers that can be used to build a product. When the original item changes, the suspected link function and diff tool helps you decide on applying changes to copied requirements. Access the Library by clicking the book icon at the right side of your page in document view, next to the filter icon.
5.2.1 Expand/Collapse Tree In LibraryTo expand or collapse a tree in the Library, head under the Configuration page. Select items in different Workspace Trackers to list. Hit Save to make the items visible in the tree. To remove items, select from the checkboxes.
5.2.2 Filter Expanded Requirement With Text FilterFilter expanded requirements in the Library by using text filters. Simply select “Type to filter” at the top of the Library page.
5.2.3 Filter Expanded Requirement With Status FilterFilter expanded requirements in the Library by using status filters. Find the "All" dropdown menu, and select the meaning of different statuses: Open, Resolved/Closed, Closed, Resolved.
5.2.4 Insert Item In Requirement LibraryUnder the requirement section in the Library, insert items to a Tracker by opening the Configuration page. Select requirements then hit Save for them to appear in the tree. Re-use Tracker requirements with drag and drop.
5.3 Link Requirement With Test CaseUnder the requirement section in document view, easily link requirements with test cases. Open the Library at the top-right of the page, then head under the Configuration page. There are three options:
Use drag and drop to set association types. The Tracker is loaded on the right side of the page.
6 Traceability BrowserThe Traceability Browser offers end-to-end traceability down to the source code, needed to meet compliance with regulatory standards. The Traceability Browser is a table that correlates Trackers and Tracker types in a desired order. It visualizes the dependencies between items with neighboring Trackers. Find the Traceability Browser in any Tracker from the “more” menu. Or select the Traceability Browser from the Tools menu as an initial Tracker. Set dependency links for associations, references, and current item statuses. In an initial Tracker, a custom Tracker view can be applied to filter for relevant item dependencies. Selected Trackers in the result table can be saved as permanent links, reloaded, and shared with other Workspace users. With administrator rights, store and delete configuration presets. Export to Excel for management and store for audit and regulatory purposes.
6.1 Select Trackers And Tracker TypesThe Traceability Browser is a table that organizes Trackers and Tracker types in a desired order. It visualizes the dependencies between items with neighboring Trackers. Set downstream and/or upstream associations and references. With initial Trackers, you can:
In Level 1, you can:
After setting Trackers and Tracker types in all levels, select “show dependencies” to see table results. The first column belongs to selected initial Tracker(s); other columns represent other levels.
6.2 Share Permanent Link And Save PresetCreate a permanent link of your table results by clicking "Share with others" at the top right of the page. The page reloads with previous results and an updated URL. Copy and share the URL with other users, groups, or email addresses. Workspace administrators can store Traceability Browser configuration presets at the Workspace level. To do so, hit Save Current Settings on the action bar. Name your preset with a unique name.
6.3 Load PresetTo load a preset in the Traceability Browser, click Load/Manage Presets.
6.4 Delete PresetTo delete a preset in the Traceability Browser, click Load/Manage Presets and view a list of previously stored presets. As a Workspace administrator, click Delete Preset to remove a stored preset.
6.5 Export Traceability BrowserTo export a Traceability Browser table into MS Office, click “Export to Office” located above and under the table.
6.6 Item TraceabilityFind the Traceability tab in every page of an item by double clicking the item. Under the Traceability tab, three levels of downstream and upstream traceability loads by default. Reload the page with other options:
7 Risk ManagementcodeBeamer MX's Risk Management helps identify, analyze, mitigate, and reduce risks during crucial processes for developing safety-critical and complex embedded products. It facilitates compliance with ISO 14971. Identify risks and potential failures in the early development and engineering process to avoid user risks while saving development costs and time.
7.1 Risk Management LifecyclePlan your Risk Management Lifecycle by using codeBeamer MX's BPM. Use a standard workflow for identifying, planning, reducing, and mitigating risks. Use standard attributes such as hazard, triggering event, harm, likelihood, severity, risk, planned risk mitigation, likelihood after mitigation, severity after mitigation, and risk after mitigation.
7.2 Risk Matrix DiagramThe Risk Matrix Diagram displays the number of requirement items according to related risks. In the risk Tracker, the risk property is a preconfigured computed field that calculates the risk value automatically by multiplication of likelihood and severity values. The diagram is drawn as a matrix: Y Axis for Likelihood and X Axis for severity. The diagram can be configured, and the axis can be reversed.
7.2.1 Configuration InheritanceTo configure the matrix, use special custom fields in the risk Tracker or via the Risk Management tab in the tracker customization page. Newly created risk Trackers contain these fields by default:
Set these intervals as background colors of the matrix under the Risk Management tab in the tracker customization page.
8 Test ManagementcodeBeamer MX's quality assurance and testing module enables controlled testing of software, hardware, products, and systems. It ensures you meet compliance with even the most complex industry standards typically found in safety-critical industries.
8.1 Requirements-Based TestingUse requirements-based testing in codeBeamer MX manually. With a requirements node, derive and link to multiple test cases either recursively for each child requirement or for the selected node. This works only if the “verifies” field is configured. The “verifies” field is a reference field in the test case Tracker, linking the selected requirement.
8.1.1 Create Test Case From RequirementGenerate test cases under the requirements section in document view. Click the + icon (add downstream reference or new item) next to the requirement and select the target test case Tracker from the dropdown menu. This immediately generates a test case for the requirement in the selected Tracker of the Workspace.
8.2 Create Test Step, Test Case, Test SetA test case is a detailed procedure that fully tests a feature or an aspect of a feature. A test case consists of detailed descriptions, pre-actions, test steps, post-actions, and test parameters. Use a test case Tracker item found in the Test Cases Tracker. Execute pre-actions before test steps to initialize the environment and populate test data. Execute post-actions after test steps to close open resources and clean up the environment. Post-actions should be executed regardless of the actual result of the test case, unless documented otherwise. Test parameters are a solid way to enhance testing scenarios. A test step is the first step in a test case procedure and includes an action, expected results, and actual results. A test set logically contains related test cases and test steps. It is associated with a list of releases to for implementation and a list of configurations to be used during implementation. Test sets are maintained in the “Test Sets” CMDB category. A test configuration is one possible configuration under product testing. Tests can lead to different results depending on configurations used. Configurations should be recorded for effective testing. They are stored in the "Test Configurations" CMDB category. A test run is the actual execution of a test set or test case using a specific release and test configuration. All test cases or test sets that have been executed are maintained in the “Test Runs” Tracker.
8.2.1 Modify Test Step, Test Case, Test SetTo modify a test step, test case, or test set, use the proper test case or test set Tracker. Double click the item to open the editor and make modifications.
8.2.2 Delete Test Step, Test Case, Test SetTo delete a test step, test case, or test, use the proper test case or test set Tracker. Right click on the item in document view. You can also delete from the table view. Select the items, click Actions, and then hit Delete.
8.2.3 Create Test Set From Selected Test CaseA test set run is stored in a test run Tracker. It holds information about a single run of a test set on a certain platform and version. To create a test set, use the proper test case or test set Tracker. Click "New Item" to add a name for the test set. At the bottom of the page, add a test case from the test plans library on the right side of the page with drag and drop. After saving, your test set is ready to run.
8.2.4 Add Test Case To Selected Test SetTo add a test case to an existing test set, use the proper test case or test set Tracker. Find test cases and sets at the bottom of the page. Select Edit to add a test case by selecting from the right tree.
8.3 Re-use Test Step, Test Case, Test SetTo re-use a test step, test case, or test set, find the library on the right panel and use drag and drop. Decide whether to create a copy or maintain a reference to the original item. If there is a reference to the original test item that changes, the copied test item updates automatically. Break the reference relation by editing your test item.
8.4 Test ParameterUse a test parameter when editing the definition of a test case or test set. Parameter values can be displayed as a wiki table. Define a parameter by using ${parameterName} in the wiki text of a test case. Parameters can be used in the following:
8.4.1 Provide Parameter Values In Wiki TableProvide parameter values to a wiki table by adding a wiki formatted table in the wiki editor. The table contents are used as parameter values. The values are taken from a wiki table if:
You can define a table as a multi-row parameter set. When running a test case, it runs multiple times, one for each row with a value.
8.5 Test ExecutionCreate a new test run out of a test case and test set by choosing the specific release and test configuration. When creating a test run, decide how to distribute your run with other users by either creating a shared single test run or multiple test runs with roles/groups. Roles/groups are not expanded to individual users. When a test case, test set, or test run includes a test parameter, a “Using parameter…” side bar appears in the test execution. The test execution displays:
Choose a different parameter set manually by clicking “Select”. In the open dialog, see parameter sets yet to be executed. Select the next parameter to run and/or decide to skip parameters in the test execution if needed. When skipped, a special result “Partly Passed” is used. Review each test execution in the Test Run tab by clicking "Show detailed view". Once a test run is completed, re-run the tests if needed:
8.5.1 Test Runner WindowThe Test Runner is your primary interface for running tests. It helps guide you through tests and steps for implementation. It also records the result of every step (passed or failed) until completion. If any defects are identified during test runs, conveniently report bugs with the Test Runner. On the Test Runner, the top area shows your progress for the entire test set and/or test case run (with the number of passed and failed tests). Find configuration and release information of the current run, navigation buttons to easily move through tests, and the browser to see outstanding test cases. This works if the test is not marked as sequential, which forbids random execution order. Main functions include:
8.5.2 Test Run In ExcelManage test case results (=the Test Runs) with the Test Runner. When executing a set of tests, the Test Runner shows up next to the test. Use it to enter test results and close completed test runs. Export your test run in an Excel document to execute your test outside of codeBeamer MX:
8.6 Bug ReportWhen executing a test run, report a bug at any point. To do so, click the “Report Bug” button to suspend the Test Runner and display the bug reporting dialog. Choose a bug Tracker to report your bug in. A bug report captures details like:
8.6.1 Re-Use Bug In Test RunnerWhen reporting a bug in the Test Runner, select from previously reported bugs.
8.7 Test Coverage BrowserThe Test Coverage Browser is a metric that shows verified test requirements and user stories of a product. It shows the number of test cases and the overall coverage status. Use it to analyze the results of latest test runs and the test coverage of requirements/user stories. Access the Test Coverage in the Tools menu by clicking "Test Coverage". The Test Coverage Browser has three main sections: 1) requirement/user story tree of a selected Tracker, 2) assigned test cases, and 3) test runs. Find information such as statuses by color, coverage, number of verified test cases, requirements/user stories, and coverage analysis. Filtering options include:
The Statistics section shows aggregated coverage statistics. This information is computed based on filters, matched with the coverage tree. Statistics are grouped by Trackers. Export the test coverage to Office Word or Excel, containing information from the tree, statistics table, and filters.
9 SCM RepositoriescodeBeamer MX supports GitHub, GitLab, and Bitbucket for external Version Control Systems. Get full traceability and source code links for requirements and tasks. In the Tracker item details under the SCM Commits tab, find associated SCM commits. Each SCM Commit is stored in the repository. When installing a SCMLoop, the following syntax in the commit message can associate the SCM Commit to any Tracker item. E.g. codeBeamer MX #1234 Comment (1234 is the unique Tracker item ID) (Annex D – SCR).
9.1 Connect GitHub RepositoryConnect your GitHub repository with these two actions:
To configure a secret token in codeBeamer MX, go to the System Administrator page and open Application Configuration:
After, configure the GitHub webhook.
9.2 Connect GitLab RepositoryConnect your GitLab repository with these two actions:
To configure a secret token in codeBeamer MX, go to the System Administrator page and open Application Configuration:
After, configure the GitHub webhook.
9.3 Connect Bitbucket RepositoryConnect your Bitbucket repository with these two actions:
To configure a secret token in codeBeamer MX, go to the System Administrator page and open Application Configuration:
Save configuration to encrypt your password. After, configure the Bitbucket webhook.
10 Release ManagementRelease (Version) Management maintains and tracks different versions of project deliverables, the planned and release schedule, and issues to resolve in each version. Use Release Management for effective project management supported by various methodologies, such as Agile. Release Management is not only applicable to software development, but any type of project with milestones to reach, manage, and report. Configure with Hybrid methodologies like traditional Waterfall, V-Model, Waterfall with overlapping phases, or Waterfall/V-Model methodologies with Agile implementation. codeBeamer MX releases are modeled as configuration items, leveraging CMDB functions.
10.1 Define And Create Release/MilestoneDefine and create a release or milestone in codeBeamer MX with specific properties by selecting “New Sprint” in the release configuration Tracker. codeBeamer MX’s sprint is a type of release development that uses the Scrum framework. In codeBeamer MX, view a list of all sprints indented under their parent. Sprints consist of metrics like the number of outstanding or finished items under parent releases. They display statistical aggregation of parent to children information. More functions:
10.2 Release DashboardAccess the Release dashboard by clicking the Releases view for each release or sub-release. On the dashboard, find a statistical overview of releases. Monitor the overall progress of your development with releases and sprints in real time. To see a list of items associated with a particular version, expand the details by clicking the icon next to the release name. Items are color coded: green indicates resolved, white indicates outstanding. See overdue items and apply various filters like status, users, priority, type, and Workspace. Access burn-down charts to monitor velocity, a prediction of how much a development team can successfully complete in a fixed period of time.
10.2.1 Display Associated Release/Sprint/MilestoneExpand a release to see detailed information about sub-releases, sprints, and milestones. See three charts with sprints, story points, and the item number process. Next to them, find status activity and progress of the release. Click “Show details” next to the sprint name to open your dashboard. Navigate release planner, cardboard, and coverage pages.
10.2.2 Burn-Down ChartTo display the burn-down chart for a release, open the Release dashboard and find the option above the filters. Individually configure your chart – it does not affect the Release dashboards of other users. Choose to display or hide:
10.2.3 Move Open Items To Release/SprintTo move an open item to a release or sprint, click the down arrow at the top right corner of a release/sprint summary. On the menu, send an open item to another sprint or backlog. Open item numbers are indicated in brackets.
10.2.4 Change Release StatusTo change a release status, open the Release dashboard and click the down arrow next to the status badge. Select the transition option.
10.3 Release PlannerClick the Release planner view for a release or sub-release. The Release planner is where a Workspace is planned with daily task estimation, release, and sprint management. Prioritize items or assign specific releases via drag and drop (e.g. move an item from a Workspace backlog to sprint). Use the Agile method to estimate the complexity of items expressed as story points Assign a user with responsibilities under a release in two ways:
10.3.1 Item Assignment To Release/Sprint/Milestone From BacklogTo assign a user to a specific release or sprint, open the Product backlog under the release planner page. Drag and drop a release or sprint – possible drop areas are highlighted. To move all items from a sprint or release, find the option from the sprint’s context menu.When you assign an item to a selected sprint, the page reloads with the applied changes.
10.3.2 Item PrioritizationWith administrator rights, prioritize items manually by changing the ordering via drag and drop in the Planner. Use options Send to top, Send to middle, and Send to move items around in the list.
10.3.3 Work Assignment And Story PointsThe planner helps balance the workload of your team, especially when using the Agile method with story points. Assign users to items in two ways:
See item numbers and story points next to each user.
10.3.4 Multiple Assignments To Sprint Or Members From Grouped PlannerOn the filter panel, group items by properties. Items are listed under highlighted group names on the main panel. On the left panel, use the 6-point icon to drag and drop highlighted groups on a sprint or user in one go.
10.3.5 Use Table Header In PlannerThe planner’s main panel holds a table and sticky header. Easily change the visibility of columns by clicking the eye icon at the right-side of the panel. Under the context menu, remove or re-order table items with drag and drop.
10.3.6 Filter Options In PlannerUse filters on planner items with Workspace and Trackers related to the current release. Filter by any default, references, custom fields, and other options similar to the Tracker view. To set filter conditions, click Add filter, then select your field to set its value. Hit Go on the main panel to reload your page.
10.3.7 Order Options In PlannerTo set ordering options in a planner, open the filter panel. Select one or more fields to order by, ascending or descending, and hit Go. If you select order by, ordering via draganddrop is not possible.
10.3.8 Group Options In PlannerTo set group options in a planner, open the filter panel. Select functions or fields to group. Grouped items are highlighted on the main panel. Use the 6-point icon to drag and drop items and assign groups in one go.
10.3.9 AND/OR Logic Option In PlannerAdd AND/OR logic to refine your filtering for more than two attributes. By default, conditions use the AND logic.Open the filter panel and add two conditions by clicking the -/+ icon next to Add filter. Use the given conditions and numbering – enter your values. Define your logical phrase by using 1 AND 2 or 1 OR 2. Hit Go to activate the changes.
10.3.10 Default View In PlannerSelect a default view in a planner from the View dropdown menu at the top leftsection of your page. Selecting a view reloads the main panel instantly. To set a view to default, click the pipe icon next to the view's name. Click the X icon to remove from default.
10.3.11 Create Custom Public/Private View In PlannerTo create a custom public or private view in a planner, open the filter panel. Set conditions like name, public or private, and an optional description. At the top of the filter panel, hit Save to apply the filters as its own view.
10.3.12 Modify Custom View In View ManagerTo select your own custom view from the View dropdown, click the filter icon at the top right corner of the page.Modify conditions under the displayed settings. Hit Go to apply and view your changes. When modifying a custom view, choose to modify the current view or create a new view based on the custom view. From the Save dropdown menu, hit Save. Change the properties of the current custom view by selecting Properties on the Save dropdown menu.
10.3.13 Delete Custom ViewWhile you can not delete default views , you can delete custom views .Open the filter panel by clicking the filter icon at the top right corner of the page. Select the custom view you’d like to delete. From the Save dropdown menu, hit Delete.
10.3.14 Switch View In Planner To Kanban BoardIn Release Management, easily switch between release, planner, and cardboard dashboards. To change your view, use the view buttons at the top right corner next to the filter button.
10.3.15 Create Reference Item In PlannerCreate a new downstream reference for an item by using the context menu next to the summary field. Select a Tracker under the Downstream reference menu.
10.3.16 Use Multiple Selection Option In PlannerSelect multiple items to manage them in one go. Select checkboxes by hovering your mouse over the items. Select your items and use drag and drop to assign them to releases, sprints, teams, and users.
10.3.17 Release And Sprint VisibilityOpen a planner under a specific release/sprint to see all of its sub-releases, sub-sprints, along with the product backlog. Click a sub-sprint on the left panel to display assigned items on the main panel.
10.4 CardboardUse the Kanban methodology to help visualize and manage your workflow. Track and move items, trigger status changes, and define your workflow. Use the cardboard view to easily manage items assigned to different releases, sub-releases, and Trackers. Get an overview of expended resources and WIP (Work in Progress) limits, important for understanding current gaps. Configure swimlanes and more filter options.
10.4.1 Work In Progress (WIP) LimitsWork in Progress (WIP) at each workflow stage is limited, pulling new work only when there is available capacity within the local WIP limit. Set WIP minimum and maximum column conditions under the cardboard page. Click the gear icon at the top right under the filter icon to display cardboard configuration options. Set your conditions and hit Save to apply modifications. Free capacity and overloaded values are indicated at the top of the column.
10.4.2 Group And Filter Options In CardboardIn cardboard, find the swimlane dropdown at the top right corner of the page. Select the option to group cards in a field. These groups become swimlanes you can expand and collapse.When selecting an option for a swimlane, three new elements are displayed next to the dropdown field. Define the order of cards in a swimlane. Switch button to turn visibility on and off. Arrow button to expand or collapse all swimlanes at once Filter general options on the filter panel.
10.4.3 Manage Views In CardboardAt the top left section of the Tracker view , select any default view in the View dropdown .Selecting a view reloads the page with the changes instantly. Set a view as default by clicking the pipe icon next to the view's name. Click the X icon to remove from default. From the View dropdown, select your view. Click the filter icon at the top right corner of the page to open the settings .Modify conditions and hit Go to see applied changes. When modifying a default view, hit Save to save a custom view based on the modified default view. The default view itself won't be changed. When modifying a custom view, choose to modify the current view or create a new view based on your custom view. From the Save dropdown menu to save, hit Save. You can also change the properties of the current custom view by selecting Properties on the Save dropdown menu. While you can not delete default views, you can delete custom views. To delete, open the filter panel by clicking the filter icon at the top right corner of the page. Select the custom view you’d like to delete. From the Save dropdown menu, hit Delete.
10.5 BacklogscodeBeamer MX’s backlog is an ordered list of open items to be addressed. There are different types of backlogs: Product backlog: consists of open items not scheduled to a release or sprint. In every release planner, find the product backlog tab at the bottom of the left panel. Release backlog: consists of open items scheduled to a specific release, but no sprint. Prioritize items in this backlog via drag and drop. Sprint backlog: consists of open items scheduled to a specific sprint, but not yet executed.
10.6 Large Scale Scrum (LeSS) SupportLarge Scale Scrum (LeSS) teams are supported with codeBeamer MX’s teams and Tracker types. Cross-assign items in areas, teams, and team users. Use @team and @area to mention team users.
11 BaselineA Baseline is a snapshot of a Workspace at a particular point in time, including digital content such as: requirements, Tracker items, wiki pages, documents, comments, or attachments. It configures and saves your content across Workspaces. It also lets you go back in time to an earlier version of your Workspace. Compare Baselines and get statistics on what changed over time. Changes are highlighted with information on when the change was made and by whom. Baselines are signed with a unique electronic signature by each user. Create and compare Baselines for specific Trackers and document directories. codeBeamer MX’s BPM Workflow engine automatically creates a new Baseline with default workflow actions.
11.1 Baseline ContentA Baseline captures the state of your digital content in a particular time, such as marking a particular state of a source code in a Version Control System. Creating a new Baseline creates a snapshot of your requirements, Tracker items, wiki pages, documents, comments, and attachments. It lets you go back in time to an earlier version of your Workspace. Compare Baselines and get statistics on what changed over time. Changes are highlighted with information on when the change was made and by whom. Baselines are signed with a unique electronic signature by each user. A Baseline is useful for audit purposes, including any deviations in previous versions. It’s also useful for a certification of approval and maintaining wiki pages for multiple product releases. A Baseline is a read-only directory of all documents and revisions in a document tree branch, including hierarchy and structure.
11.1.1 Baseline Wiki PageA Baseline wiki page stores all its content, documents, references, and revisions. When browsing a wiki page on a Baseline, references are resolved even if target documents have been modified or deleted.
11.1.2 DocumentA Baseline is read-only because it stores references to specific document revisions that already exist; it does not copy document data. A document revision can be referenced by any number of Baselines at the same time. A document revision referenced in a Baseline is not deleted unless the Baseline holding the reference is deleted. The same goes for deleting a document in a document tree branch or Workspace. After creating a Baseline, you can not edit or remove items from it. You can not define permissions for individual items. Item permissions in a Baseline are solely controlled by the Baseline.
11.1.3 TrackerTo create a new Baseline on the item Tracker, set subject/source of the triggering event.
11.1.4 Tracker ItemWhen creating a new Baseline, a snapshot of the requirements and Tracker items is saved.
11.1.4.1 Comment And AttachmentWhen creating a new Baseline, a snapshot of the comments and attachments is saved.
11.1.4.2 AssociationWhen creating a new Baseline, a snapshot of the associations is saved.
11.1.4.3 Suspected AlertWhen opening a Baseline, suspected alerts are activated. These can not be cleared by users.
11.2 Create Baseline Without Electronic SignatureWhen creating a new Baseline, choose to not use an electronic signature – simply leave the signature textbox empty.
11.3 Create Baseline With Electronic SignatureWhen creating a new Baseline, choose to leave an electronic signature by using your user password in the signature textbox. After saving, the username and signature's date is visible.
11.4 Create Workspace Level BaselineWhen creating a new Baseline at a Workspace level, a snapshot of the entire Workspace is saved.
11.5 Create Tracker Level BaselineTo create a new Baseline at a Tracker level, open your selected Tracker, click the More Functions menu, and then select "Create Baseline".
11.6 Browse BaselineTo browse a Baseline, click the Baseline’s name on the Baseline list. A new window is loaded with the Baseline’s content.
11.7 Compare BaselinesTo compare two Baselines, select the Baseline names and click “Select Button to Compare” at the top of the Baseline page. The loaded view displays differences between the two Baselines separated into categories. View detailed modifications under each category tab in the result view.
11.8 Delete BaselineTo delete a Baseline, select the Baseline and hit Delete at the button of the Baseline page.
12 Reports And QueriescodeBeamer MX supports reporting across Workspaces and available Trackers. When a Workspace is configured, it can run for an unlimited amount of time. Customize conditions, fields, criteria, and more for every Tracker. Export your report to various formats like Excel, PDF, and XML. A query’s independent ad-hoc search and filter mechanisms use cbQL across Workspaces. Filter Tracker items including texts, number fields, or reference conditions. Use the query widget for defining the most useful queries without having to know the cbQL language. An advanced mode is also possible for defining cbQL expressions. Save new queries and find existing ones on the query interface. When creating a new query, add a name and optionally add roles from Workspaces to share the query plus its description.
12.1 Create Report And QueryCreate a report and query with codeBeamer MX’s Analytics, Reports, and New Report functions. A report can be created as a Simple report with several options on the visual user interface. Or use the cbQL query language with Advanced report.
12.1.1 Simple ReportThe Simple report option lets you create reports on a visual interface without having to enter queries in the cbQL language. The Simple report builder generates a cbQL query in the background. To reveal underlying cbQL query, switch to Advanced mode. A Simple report lets you select multiple Workspaces as long as you are a user of the Workspace. With proper role permissions, select multiple Trackers from a list using the Tracker selector. By default, no Workspace and Tracker is selected. To create a Simple report, define at least one condition. It’s possible to click Go with no Workspace and Tracker selected – as long as there is one condition defined, a preview with a review of the item and permission is displayed. It’s also possible to click Go with no Workspace, Tracker, or condition defined. In the Fields section, find Default and Common Reference fields based on the Workspace and Tracker selected. Find available fields by typing in the Search field. Add fields with drag and drop:
Click the + icon to add a condition. By default, multiple conditions are applied with the AND logic. To set AND/OR logic, find the option under the Conditions section. Define a valid logic phrase, meaning numbers that represent filter conditions (e.g. 1 AND (2 OR 3). Hit Go to preview your newly added conditions. Hit Save to apply changes to the previously saved report. Group report results with set conditions. In the “Group by” section, click the + icon. Hit Go to preview, and then hit Save to apply changes to the previously saved report. Order report results with set conditions. In the “Order by” section, click the + icon. Hit Go to preview, and hit Save to apply changes to the previously saved report.
12.1.2 Advanced ReportUse the Advanced report option to enter a query that is Workspace independent with ad-hoc search and filter mechanisms across multiple Workspaces using the cbQL query language. The cbQL query language makes it possible to create reusable queries. Its syntax is similar to the SQL. The cbQL has four different parts:
Switch from Simple to Advanced report where Workspaces, Trackers, and conditions are already defined, revealing underlying cbQL query.
12.1.3 Edit Item Details In Result TableEdit item details in the result table by permissions. Simply click on the result table to open the right panel. View item details and choose to edit with inline edit. Items are editable based on user role permissions.
12.2 Save ReportTo save a configured report, click “Save As”. Mandatory field:
Optional fields:
12.2.1 Shared ReportSave a report as private or shared. To share a report, the creator of the report has to define “read” or “write” permissions for user roles in a Workspace. Open your Workspace to view available roles. You can set multiple roles to have permissions to read, write, and edit a report. Define the access level “read” or “write” for each role. By default, every role is set to ”read”.
12.3 Modify Report And QueryWith the “write” access, modify a previously saved report and query. To edit, open the report’s result page and click “Edit report” to load the report editor. After making edits, hit Save to overwrite the existing report configuration.
12.4 Delete Report And QueryWith the “write” access, delete a previously saved report and query. To delete, open the report’s result page and then the dropdown menu next to “Edit report”. Select “Delete report”.
12.5 Find/Load ReportFind a previously saved report by opening the “Analytics/Reports/Find reports” menu. Search based on the report name. Order the list of reports based on name, description, modified by, and modified at. Filter based on report type:
To open a report, click on the report’s name.
12.6 Export ReportWith the “read” or “write” access, export a previously saved report and query. To export, open the report’s result page, click More Options, and then select “Excel export”. Choose to download the report or store it in codeBeamer MX as a Document.
12.7 Working With Report JobUse the report job function to send a report to a predefined and automated list of recipients. Open a previously saved report and click “+ Add Job”. Define the job’s name, frequency, and recipients. You can define a report only if the number of items is more than the user-defined integer value. Recipients:
Report frequency:
Manage (edit, disable, stop, delete) previously saved jobs:
13 Integration And Data Exchange With Existing ToolsAccess codeBeamer MX’s resources and exchange data with tools via the REST API and various formats. According to ISO 26262, codeBeamer MX’s tool qualification does not integrate further third party tools like MS Office or LDAP. The end user must evaluate the usage of any third party tools within the safety lifecycle.
13.1 Import ProcesscodeBeamer MX does support the import of various data formats. The user must evaluate the product for importing files within the safety lifecycle.
13.1.1 Import TrackerTo import a Tracker item in a Tracker page, click More Functions next to the View selector. Select “Import”. Import items with:
When importing a Word document, your file should be structured using Word formats. Make sure to use appropriate header styles for headers and normal text styles for descriptions. Different header styles generate parent-child relationships between items. When importing an Excel document, your file should be structured. The first row of your Excel should hold header information. The rows below should hold the rest of your data (customizable). Major features include:
When importing a CSV file, it’s a similar process to using Excel. There are a few differences and constraints to know:
13.1.2 Import WikiTo import a wiki document from Microsoft Word, click More Options at the top of the Wiki page. Select “Import from Word” and choose a method:
13.1.3 Import UserWith appropriate permissions, import user information with Excel. Open the System Administrator page, head under User Accounts, and click “Import from Excel”.
13.2 Export ProcessExport various formats in codeBeamer MX. The user must evaluate the products used to open exports within the safety lifecycle.
13.2.1 Export ItemTo export a single item, open the Tracker item details page. Find the hamburger icon, then select “Export to Office”. In the dialog, export an item as Microsoft Word or Microsoft Excel formats.
13.2.2 Export Tracker AuditTo export audit information from all tabs to Microsoft Word, open the Tracker Audit from the Tracker Configuration page. Select “Export to Word” at the top of the page.
13.2.3 Export To PDFTo export to PDF, open the More Functions menu of your Tracker. Find the PDF option under the “Export with” section.
13.2.4 Export TrackerTo export a Tracker its items (requirements, tasks, bugs), open the More Functions menu of your Tracker. Select “Export to Office”. See fields and items matching the current view. To view and export items a different way (e.g. change exported fields or ordering), create a custom view for the Tracker. To export specified items, select “Export to Office” from the More Functions menu. This exports previously selected items.
13.2.5 Export WorkspaceExport a Workspace configuration file to use as a project template. Below the Administrator menu, open Workspace Settings. Under the Export tab, select artifacts to include in the template file, and then click Export. To export only a subset of Trackers, select Trackers via checkboxes. This generates a list which you can manually export.
13.2.6 Export WikiTo export a wiki page, open More Options, select the wiki page, and then click "Export to Word". Decide if you’d like to download the document or store in a document Tracker.
13.2.7 Export UserTo export users, open the System Administrator page. Under User Accounts, export users to an Excel file.
13.2.8 Round-Trip Export And ImportUse a Round-trip Word document to export or import items. Open your Tracker and select “Export to Office” in the “more” menu. Choose “Selection” to export only selected items. In the dialog, select “Round-trip”. codeBeamer MX generates a Word document with items displayed in the current view – the download starts immediately. The generated file name contains the current Workspace and Tracker name. After editing the Round-trip document, import the changes back to codeBeamer MX by clicking “Import from Word or Excel” in the “more” menu of your Tracker. In the dialog, select the Round-trip option and upload. Review the updated areas indicated in your Round-trip document. Hit Save to apply the changes and see the summary of changes.
13.2.9 Template-Based Word ExportTo export to Word or Excel with a customized template, the template should be uploaded in Manage Custom Templates. Click “Export to Office”, review the details, and then select the template previously uploaded under the Template section.
13.2.9.1 Traceability Browser Word ExportTo export the traceability table to Word or Excel, click “Export to Office” above and below the traceability table.
13.2.9.2 Review Word ExportExport a review in Review Hub. Open the review page and select the Export icon. Select your template. Convert the tile to PDF by selecting the Convert to PDF checkbox. When ready, hit Export.
13.2.9.3 Coverage Browser Word ExportExport a test coverage under the Test Coverage page. Open the Tools tab at the top of the page and select Test Coverage. Click “Export to Office” above or below the coverage table.
13.2.9.4 Risk Matrix Word ExportExport all risk matrix to Word or Excel. Open the Risk Matrix Diagram under the More Functions menu. Find the option to export.
13.2.9.5 Test Run Word ExportExport a test run report to Word. Open the dropdown menu at the top of the test run’s editor, then select “Export to Office”.
13.2.9.6 Test Case Word ExportExport a test case to Word. Open the test case type Tracker, select More Functions at the top of the page, then select “Export to Office”. Choose a template to export for review. The file can be converted to PDF by selecting the Convert to PDF checkbox. After specifying your export settings, hit Export.
13.3 JIRA ConnectorcodeBeamer MX provides bi-directional synchronization with Atlassian JIRA. Import projects from JIRA into codeBeamer MX by creating a new Workspace. Provide the JIRA’s URL, username, and password to retrieve a list of available projects in JIRA to import, including roles, users, project versions, components, and items. To continue using JIRA with codeBeamer MX, set up a manual or automatic synchronization system. By default, JIRA and codeBeamer MX synchronizes in one direction – it can be changed to bi-directional. Set up a synchronization interval in the job interval. The smallest allowed value is 10 minutes. An empty interval disables automatic periodic synchronization. Execute the job manually by clicking the run job symbol. The user must evaluate JIRA usage within the safety lifecycle.
13.3.1 Connect To JIRA In Tracker LevelTo connect a JIRA instantly in a Tracker level, open the Tracker page and select “Synchronize with JIRA” under the More Functions menu. Under JIRA Connector Settings, configure your JIRA server details. Click the pencil icon at the bottom of the dialog to display a list of JIRA projects. Select the JIRA project and item type to synchronize.
13.3.1.1 Connect To JIRA In Tracker Level - Import DirectionUnder JIRA Connector Settings, select the Import Data option. This imports only the modifications from JIRA into codeBeamer MX. Modifications from codeBeamer MX are not uploaded into JIRA.
13.3.1.2 Connect To JIRA In Tracker Level - Export DirectionUnder JIRA Connector Settings, select the Export Data option. This imports only the modifications from codeBeamer MX into JIRA. Modifications from JIRA are not uploaded into codeBeamer MX.
13.3.1.3 Connect To JIRA In Tracker Level - Bi-DirectionalUnder JIRA Connector Settings, select the Synchronization Data option. This synchronizes modifications between codeBeamer MX and JIRA bi-directionally.
13.3.2 Import Users From JIRA In Workspace LevelUnder JIRA Connector Settings, check the users under the References section to display JIRA users including users not in codeBeamer MX.
13.3.3 JIRA Credential ValidationWhen setting up a JIRA connector, make sure to have your:
13.3.4 JIRA Permission Validation In ConnectorJIRA synchronization is permitted for expressed references. Under JIRA Connector Settings, verify the references section. By default, users, groups, epics, and teams are disabled.
13.3.5 Store Historical Entries For Synchronization DataUnder JIRA Connector Settings, set synchronizations (import, export, date, time, user, changes) to keep in the history. After a successful sync, view your history by clicking the JIRA Connector history icon.
13.3.6 Workflow Synchronization From JIRA To codeBeamer MXcodeBeamer MX can synchronize workflows automatically if the JIRA user has “Administrator projects” permissions. Otherwise, sync your workflow manually by:
13.3.7 Disable JIRA SynchronizationTo disable synchronization, open JIRA Connector Settings and hit Remove at the bottom footer.
13.3.8 Periodic SynchronizationUnder JIRA connector settings, set run periods for syncing imports and exports. The minimum value is 10 seconds. After setting your value, manually start the sync. After the sync time is calculated, it runs automatically.
13.3.9 Save/Load Synchronization SetupUnder JIRA Connector Settings, map your desired fields. Click “Save as link” to download your settings in a json file. To reuse the settings, use the link to load your settings. When saving the json file, mappings load instantly.
13.4 User Authentication With LDAPManage user authentication with an existing LDAP/Active Directory server. Or head under User Accounts to import and update user information from the LDAP/Active Directory. Configure your settings in User Authentication under the System Administrator page. When logging into codeBeamer MX for the first time with successful LDAP authentication, a codeBeamer MX account is created automatically with LDAP attributes (email address, name, phone number, etc.) stored and mapped in codeBeamer MX. The user must evaluate Active Directory/LDAP usage within the safety lifecycle.
14 Review HubcodeBeamer MX’s Review Hub is a snapshot of Tracker items, releases, or reports at a specific point in time. When a set of items like tasks and requirements is ready for review, you can invite contributors (reviewers and moderators) to approve and decline items. Set up notifications to alert users when an item is under review. Decide to restart a review in the case of newer item modifications. Choose to restart all review items or only those that were modified.
General ConceptsA review in codeBeamer MX consists of a set of items. A review always contains a specific version of the item (depending on when the review was created). Review contributors can discuss an under review. There are two options to take:
The Review page makes it easy to hold discussions, and approve or reject items. There are two types of contributors in a review:
14.1 Start and Edit a ReviewInitiate a review with the following options:
14.1.1 Tracker ReviewcodeBeamer MX’s Tracker Review is a snapshot of Tracker items at a specific point in time. When a set of items like tasks and requirements is ready for review, you can invite contributors (reviewers and moderators) to approve and decline items.
14.1.1.1 Select Multiple WorkspacesWhen creating a new review in the Review Hub, select multiple Workspaces from the dropdown menu.
14.1.1.2 Select Multiple TrackersWhen creating a new review in the Review Hub, select multiple Trackers from the dropdown menu.
14.1.1.3 Work Item HierarchyWhen sending a single Tracker for review in the Review Hub, maintain the hierarchy of your items.
14.1.2 Report ReviewTo start a review for items returned by a specific report, head under More Options and select “Send to review”. Or head under the Review Hub and select “Report review” from the review types.
14.1.3 Release ReviewTo start a review for items assigned to a specific sprint or release, open the Review Hub and select “Release review” from the review types. Choose your Workspace and specific sprint or release to start a review.
14.1.4 Send To ReviewTo start a review for all selected items in a specific Tracker, report, or release, open the Review Hub and select “Send to review”.
14.1.4.1 Send All Items In Tracker To ReviewWhen creating a review for all items in a Tracker, child-parent hierarchies are reflected from the original items. Hierarchies do not update when restarting a review.
14.1.4.2 Send Selected Items In Tracker To ReviewTo start a review for specific items in a Tracker, head to List view in your document view and choose “Selection to Review”.
14.1.5 BaselineTo start a review for your Workspace Baseline, open the Review Hub and select your Baseline when creating a review. Any item modifications are visible as Baseline versions in the review.
14.1.6 Contributors In ReviewThere are two types of contributors in a review:
A closed review is read only, meaning reviewers can no longer accept or reject items. When restarting a review, items can be set to read only. The purpose of restarting a review is to incorporate any modifications made after the original review was initiated, displaying item versions at the time of the restart.
14.1.6.1 Multiple ReviewersWhen creating a review, invite multiple contributors to review items. Under the Review Hub’s “Select reviews” page, select more than one reviewer for your current review. Reviewers can make reviews but need specific permissions to update reviews.
14.1.6.2 Mandatory Electronic SignatureWhen creating a review, electronic signatures can be set as mandatory for all users or a number of users in the Review Hub. Select checkboxes for “Requires signature to finish the review" or "Requires signature from reviewers”. With these requirements, the user is asked to use the account’s password to sign the review in the Signature field. Select the “Sign with username and password” checkbox to allow signing with a username. Set the minimum number of signatures needed for an item.
14.1.6.3 User Group And Role As ReviewerWhen creating a review in the Review Hub, choose users, groups, and roles as reviewers.
14.1.6.4 Replace Individual Review ContributorIf a review contributor is unable to participate in a review, replace the contributor in the Review Hub. Open the Editor to remove and add reviewers.
14.1.7 Edit ReviewTo edit a review, open the Review Hub and select the review you’d like to edit. Click the Edit icon at the top of the page. Modify your review properties and hit Save.
14.1.7.1 Edit Review NameWith moderator rights, edit the name of a review. Open the Review Hub, select your review, and then click Edit to rename.
14.1.7.2 Edit Reviewer In Existing ReviewWith moderator rights, edit the reviewers in an existing review. Open the Review Hub, select your review, and then click Edit to modify reviewers.
14.1.7.3 Edit Moderator In Existing ReviewWith moderator rights, edit the moderators in an existing review. Open the Review Hub, select your review, and then click Edit to modify moderators.
14.1.7.4 Edit Deadline In Existing ReviewWith moderator rights, edit the deadline in an existing review. Open the Review Hub, select your review, and then click Edit to modify the deadline.
14.1.7.5 Edit Signature Requirement In Existing ReviewWith moderator rights, edit the signature requirement in an existing review. Open the Review Hub, select your review, and then click Edit. Choose from "Requires signature to finish the review" and "Requires signature from reviewers" checkboxes.
14.2 Find ReviewWith user permissions, find reviews made by reviewers and moderators in the Review Hub. Under the dropdown menu, select to display all reviews or only open reviews. Group reviews by Workspace or Tracker.
14.2.1 Default View: Open ReviewsThe Review Hub’s default view is set to “Open Reviews”.
14.2.2 All ReviewsUnder the dropdown menu at the top of the Review Hub page, click “All Reviews” to display all reviews whether open or closed.
14.2.3 Group Reviews By Workspace And TrackerTo group reviews by Workspace and Tracker, select Grouping from the dropdown menu at the top of the Review Hub page. Choose from three options:
14.3 Restart ReviewA moderator can restart a completed review. When restarting, items can be set to read only. The purpose of restarting a review is to incorporate any modifications made after the original review was initiated, displaying item versions at the time of the restart. Click the restart icon at the top menu bar to open the Restart review dialog. Select multiple options to restart your review:
In the dialog, find options to modify reviewers, moderators, and viewers. Add or remove items one-by-one if needed.
14.3.1 Restart Review For Not Reviewed Item OnlyOn the Restart review dialog, find the checkbox for “only not reviewed”. Select this option for your new review to contain only the items not reviewed previously.
14.3.2 Restart Review For Item Updated After Last Review OnlyOn the Restart review dialog, find the checkbox for “only items that were updated or became suspected after starting the last review”. Select this option for your new review to contain only the items that were updated after starting the previous review, or if a reference became suspected.
14.3.3 Restart Review For All Items That Need More WorkOn the Restart review dialog, find the checkbox for “all items that need more work”. Select this option for your new review to contain all items that were marked as “needs more work” in the previous release.
14.3.4 Restart Review For All ItemsOn the Restart review dialog, find the checkbox for “all items in the current review”. Select this option for your new review to contain all items from the previous review with their current versions.
14.3.5 Restart Review With Multiple OptionsWhen restarting a review with multiple options, conditions are merged.
14.4 Review ItemTo review (accept or reject) items in the Review Hub, follow these steps:
14.4.1 Display Review Item As "Summary Not Readable" Without Read PermissionIf a user does not have permissions to read a review item, the item is indicated with “Summary not readable”.
14.4.2 Filter Review ItemAt the top left corner of the review page, find the dropdown filter. Filter review items by:
14.4.3 Approve Review ItemTo approve a review item, click the Approve icon next to the review item on the main panel. Withdraw your approval at any time before finalizing the review.
14.4.4 Reject Review ItemsTo reject a review item, click the X icon (“This item needs more work”) next to the review item on the main panel. When rejecting an item, it is mandatory to add a comment. Add your comment in the dialog, then hit Save. Withdraw your rejection at any time before finalizing the review.
14.4.5 Different Types Of Review Item CommentsDisplay the Comments panel by selecting the comment icon next to the review item on the main panel. Add different types of comments on a review item:
After adding your comment or feedback, click the Save icon on the editor.
14.4.6 Version-Related ReviewWhen creating a review item, select a Baseline to connect your current version or different item versions.
14.4.7 Relation And Reference In Review ItemDisplay relation and reference items of a review on the main panel.
14.4.8 Display Badge For Content Change After Review StartedIn the case of a newer item version after a review has started, the item is indicated by “New version available” under the item summary on the main panel. Click the badge to view the changes.
14.4.9 Review Details In Right PanellReview details of your item versions by clicking “Show right panel” next to the review item summary on the main panel. Properties are not editable, only visible. Relations are listed under the Relations tab at the top of the panel. Click the X icon at the top right corner to close the panel.
14.4.10 Approve All Review Items At The Same TimeTo approve all review items in one go, click the check icon at the top menu bar. Withdraw your approval at any time before finalizing the review.
14.4.11 Reject All Review Items At The Same TimeTo reject all review items in one go, click the X icon at the top menu bar. Withdraw your rejection at any time before finalizing the review. When rejecting all items, it is mandatory to add a comment in the dialog.Your comment is applied to all review items.
14.4.12 Enter Mandatory Reject CommentWhen rejecting an item, it is mandatory to add a comment in the dialog. Hit Save after adding your comment.
14.5 Finish ReviewTo finish a review, follow these steps:
14.5.1 Change Work Item Status When Finalizing ReviewOn the Finish Review dialog, modify item statuses by selecting approved, rejected, or mixed/not reviewed. Click “Set Statuses” to apply the changes. Status options are set in the Tracker configuration page. E.g. If you select “Completed” for approved items, the status of all approved items automatically updates to “Completed”.
14.5.2 Execute Valid State Transition When Finalizing ReviewWhen finalizing a review, click the "Execute only valid transitions" checkbox to change the status of a review item only if the Tracker’s workflow configuration allows a transition.
14.6 View ReviewReview Feedback PageAccess the Feedback page by clicking the Feedback icon above the main panel. The Feedback page lists all comments added to review items on the Review page and before the review started (e.g. when an item is part of another review or if a finished review is restarted). Add, review, or reply to comments on the Feedback page. Add these types of comments:
Comments and replies are listed in hierarchical orders with the most recent comments appearing at the top. Review Statistics PageAccess the Statistics page by clicking the Statistics icon above the main panel. At the top section of the Statistics page, find general information about a review: who started the review, signatures, Baselines, start date, close date, and more. The “Overall reviewer statistics” chart provides an overview of votes received by reviewers. See the progress of each reviewer under the Review result section. See how many reviewers approved, rejected, or have yet to review items under the Items section. History PageAccess the History page by clicking the History icon above the main panel. The History page provides a summary of the review's life cycle: start date, close date, and list of contributors.
14.6.1 Feedback PageAccess the Feedback page by clicking the Feedback icon above the main panel. The Feedback page lists all comments added to review items on the Review page and before the review started (e.g. when an item is part of another review or if a finished review is restarted). Add, review, or reply to comments on the Feedback page. Add these types of comments:
Comments and replies are listed in hierarchical orders with the most recent comments appearing at the top.
14.6.1.1 Add Different Types Of Comments In ReviewAt the top of the review’s feedback page, find “Add comment” to add a comment to the review. Click the down arrow to select from these options:
After selecting, write your comment in the dialog.
14.6.1.2 Filter By Comment TypeAt the top of the review's feedback page, find the Filter dropdown menu. Filter by:
After selecting, the feedback table reloads instantly.
14.6.1.3 Feedback Page: Display Comment From Original ItemIf an item has any comments added before the start of a review, comments are displayed on the feedback page.
14.6.1.4 Feedback Page: Display Comment From Previous ReviewIf an item has any comments added from a previous review, comments are displayed on the feedback page.
14.6.2 Display Overall Reviewer Statistics As Pie Chart In Statistics PageThe “Overall reviewer statistics” chart provides an overview of all votes received by reviewers.See the number of:
14.6.3 Display Link/Photo Of User Who Closed Or Signed Review In Statistics PageAt the top of the review’s Statistics page, see user information of the main review data. The started, finished, and signed rows contains the user’s name, photo, and link to the user’s details page if given by the user.
14.6.4 Display Progress Bar Per Reviewer In Statistics PageSee the progress bar per reviewer in the Review result section of the Statistics page. In the table, see the reviewer’s username, photo, signature date, and progress of review items.
14.6.5 Statistics PageReview items are listed under the Items section of the Statistics page. Columns consist of:
14.6.6 Review History PageThe Review History page displays all changes made to the review. Columns consist of:
14.6.7 Use Comments Stream In ReviewWhen reviewing an item in Review Hub, use the comments stream on the right side of the review page. By default, only review comments are displayed. Click “Show item comments” at the top to display item comments. With the comments stream, filter for different comment types in a review (e.g. comment, question) and accept, reject, or open comments. Important rules:
Mention a Workspace user in a comment to invite the user via the “Viewer” role. The invited user gets a notification with the content and review link. With the “Viewer” role, the user can comment or reply to the review. Visualize review comments by selecting “Show review comments” under Filters.
14.7 Exporting ReviewTo export a review, follow these steps:
The export takes a few seconds. When done, download the file.
14.7.1 Export Review Item To ExcelTo export a review to Microsoft Excel, select the option on the Exporting review dialog. Other options include:
14.7.2 Export Review Item To WordTo export a review to Microsoft Word, select the option on the Exporting review dialog. Other options include:
15 Basic FunctionalitycodeBeamer MX operates with User Accounts. A user must have an account before logging in and participating in a Workspace. 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 MX’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.
15.1 LicensingcodeBeamer MX 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.
15.2 AuthenticationTo access codeBeamer MX, it is required to authenticate your account. To first create an account:
You can access codeBeamer MX with an activated user account from the Login page.
15.2.1 Login With Valid CredentialsTo login to codeBeamer MX, enter your username and password and click “Login” from the Login page. To log in with a different username, make sure you’re logged out and log in with the new username. After successfully logging in, you are taken to codeBeamer MX’s default dashboard page.
15.2.2 Login With Invalid CredentialsIf 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.
15.2.3 Login With LDAP/AD CredentialsIf there is an LDAP/Active Directory server configured on codeBeamer MX, a user from the AD server can login to codeBeamer MX without registering.
15.3 Email NotificationscodeBeamer MX sends notifications emails about Workspace items, documents, wiki pages, workflow transitions, status changes, and more.
15.3.1 Item NotificationsWhen 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..
15.4 Full-Text SearchUse full-text search to search tasks, bugs, Wiki pages, users, attachments, and Workspaces. 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:
15.4.1 Simple SearchA simple syntax is used for word based searches. The simple search field is found at the upper right corner of every codeBeamer MX 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.)
15.5 System Audit TrailWith system administrator rights, use the Audit tool to analyze and export these user interactions:
15.5.1 LoginsFind login and logout times by users under the Logins tab.
15.5.1.1 Display LoginsTo display login/logout information, set the filter values and click Go. Results are displayed in three columns:
15.5.1.2 Filter LoginsFilter logins by:
15.5.2 ArtifactCreate, update, or delete artifact actions.
15.5.2.1 Display ActionTo display item actions and information, set the filter values and click Go. Results are displayed in seven columns:
15.5.2.2 Filter ActionFilter actions by:
15.5.3 PermissionsCreate, update, or delete permissions for Trackers, Tracker fields, roles, or user groups.
15.5.3.1 Display PermissionsTo display permissions, set the filter values and click Go.Results are displayed in seven columns:
15.5.3.2 Filter PermissionsFilter permissions by:
15.5.4 Audit ConfigurationIn audit configuration, control which event to log. Login event types:
Item event types:
Artifact event types:
Permission event types:
|
codebeamer Overview codebeamer Knowledge Base Services by Intland Software |
This website stores cookies on your computer. These cookies are used to improve your browsing experience, constantly optimize the functionality and content of our website, furthermore helps us to understand your interests and provide more personalized services to you, both on this website and through other media. With your permission we and our partners may use precise geolocation data and identification through device scanning. You may click accept to consent to our and our partners’ processing as described above. Please be aware that some processing of your personal data may not require your consent, but you have a right to object to such processing. By using our website, you acknowledge this notice of our cookie practices. By accepting and continuing to browse this site, you agree to this use. For more information about the cookies we use, please visit our Privacy Policy
.Your preferences will apply to this website only.
anonymous
Hotkeys