| 10.5. Integration | ||
|---|---|---|
|
Chapter 10. Configure |  |
| 10.5. Integration | ||
|---|---|---|
|
|
Chapter 10. Configure | |
On the Integration page, external systems are connected and their settings are managed. It features six tabs, Issue Management, Requirements Management, E-Mail, Network, LDAP and CAS.
An issue management system (also called issue tracker or bug tracker) is an application for managing issues that occur during the testing process. Issues can contain information and reports about errors in a software system.
Issues can be created retrieved and assigned to failed test case results. It is possible to configure and use multiple issue management systems simultaneously.
Klaros-Testmanagement supports the following issue management systems:
http://www.bugzilla.org/).
http://github.com/)
http://gitlab.com/).
http://www.atlassian.com/).
http://www.mantisbt.org/).
http://www.redmine.org/).
http://trac.edgewall.org/).
https://www.jetbrains.com/youtrack/).
![[Caution]](images/caution.png) |
External Configuration Required |
|---|---|
|
Some issue management systems need to be configured before they can be successfully connected to Klaros-Testmanagement. For more information, see Section 3.14, “Configuring External Issue-Management-Systems”. |
![[Important]](images/important.png) |
Token based authentication |
|---|---|
|
Some issue management systems like Jira, GitHub, GitLab, Redmine and YouTrack require access via token-based authentication. Authentication via username and password is not supported in this case. Klaros-Testmanagement is supporting a token based authentication scheme as well. Just use the required username and the token as password. |
The table shows the following values:
|
ID |
Assigned automatically. |
|
Additional Information |
A tooltip appears when the cursor is placed over the icon shown here. no credentials for background synchronization has been provided. |
|
System |
The used issue management system (Bugzilla, Jira (Version 4.3 or higher), Jira Legacy (Version 4.2 or lower), GitHub, GitLab, Mantis, Redmine and Trac). |
|
URL |
The link to the issue management system. |
|
External Project ID |
Die Projekt-ID des Issue-Management-Systems. See Section 10.5.1.1, “External Project ID”. |
|
Description |
Additional information on the issue management system. |
|
Projects |
The projects in which the issue management system is used. |
|
Actions |
The executable actions. |
If the issue management system organizes issues in projects, the project ID is required to address the specific project. Jira, Redmine, Mantis, Bugzilla and YouTrack use such a project id. With GitHub, GitLab, and Trac, the URL is used to address different projects.
The valid project ID values can be found in the issue management systems at the following locations:
The Bugzilla project id consists of the Product field value.
The Jira project id consists of the Key field value.
The Mantis project id consists of the Project Name field value.
The Redmine project id consists of the Identifier field value.
By clicking on the button a new empty table row will appear. Attributes of the issue management system can be defined here.
With the issue management system saved. The ID of the issue management system (IM00001) is automatically assigned by Klaros-Testmanagement.
With several table rows can be created and edited at the same time. Only when clicking on the data is stored in the database.
With all changes are undone.
![[Note]](images/note.png) |
Red IDs |
|---|---|
|
All rows with red IDs have been changed and are not yet saved! |
The following actions can be performed in the action column:
The following operations can be performed in the line above the table on the right:
All operations are described in detail in Section 5.2.3.1, “Overview Page”.
In the Action column, click the icon to check whether a connection to the issue management system can be established.
![[Tip]](images/tip.png) |
Trailing Slashes of URLs |
|---|---|
|
In case of an authentication error, first check whether the addition or deletion of a trailing slash to the URL resolves the problem. |
Each issue management system created has its own detail page with further subviews. By clicking on the ID of the respective issue management system or on the icon on the right side of the action column you will get to the last selected detail view. When called for the first time, this is the Properties tab.
The following tabs are available: Properties, Projects, Attachments and Changes.
On the detail pages there are more icons in the upper right corner. The following actions can be performed here:
|
Open external link |
Shows the request in the external source. |
|
Browse |
Use the green arrows at the very top right to switch between the issue managements systems present on the previous page. |
The Properties view is divided into three sections: Issue Management System, Authentication, Status Names
Issue-Management-System
|
System |
A drop-down menu can be used to select the desired system. |
|
URL |
The URL where the system can be reached. |
|
Project |
The name of the project. |
|
Description |
An optional description of the system. |
Below this is the "Authentication" section. Here you enter the login information for the background synchronization. The user entered here must have full access to the entered project.
|
Username |
The valid username. |
|
Password |
The valid password. |
The button can be used to check whether the entries are correct.
|
Important |
|---|---|
|
The credentials entered here will solely be used for background synchronization. If users creates or updates an issue, their personal credentials will be used to authenticate against the issue management system. If credentials are missing or not valid, then users are prompted to enter them. |
The last section is "Status names". The status names listed in the following table correspond to a completed issue. The specified value must exactly match the status name in the connected system.
The button can be used to add a new status name.
The button resets the fields to the default values.
All entries are transferred to the database with the button. The button deletes the entries. The button . takes you to the overview page with the created issue management systems.
You can add any files as attachments to an issue management System. For more information, see Section 5.2.3.2.6, “Attachments”.
The Projects view displays all projects to which the Issue-Management-System has been assigned.
The tab Changes shows the change history of this issue management system.
For a detailed description of the Changes view, see Section 5.2.3.2.8, “Change History”.
Each issue has a status field that documents its current state (e.g. "In progress" or "Fixed"). The individual statuses and their naming vary according to the issue management system used. Klaros-Testmanagement only distinguishes between open and resolved issues. An issue is considered closed when no further work needs to be done on it (e.g. "Closed", "Rejected"), otherwise it is still open.
Resolved issues are displayed in green, open ones in red. Section 9.6.5, “Details Page”
The resolved issue states must be named exactly as they are in the issue management system, otherwise they will not be properly identified and will be counted as open issues.
|
|
 |
|
| 10.4. System |  |
10.5.2. Requirements Management |
