Integration with trackers is useful when you introduce ALM in an organization that already uses a tracker. For example, you can develop Requirements in ALM and manage code development in the tracker you already use.
Different organizations that use ALM can exchange data on a shared project while continuing to work in their own systems.
ALM provides a very flexible way to exchange data with external trackers, based on mapping between the REST API and the tracker REST API. You can map the ALM data model to the tracker data model in whatever way suits you: choose the entities and attributes to synchronize. By default, the mapping can synchronize the following data (the scope depends on the specific tracker):
Data is exchanged periodically, in small batches, so the applications are not overloaded.
To configure synchronization or migration between ALM and a tracker, open the project settings and add the required integration. On the first tab, specify the connection parameters:
| JIRA |
URL, for example, https://jira.atlassian.com Project — a unique project identifier, for example JRASERVER User name and password for authentication. Some versions of JIRA do not support REST API authentication with a user name and password. In that case, generate an API Token, enter the user's email in the "User name" field, and enter the API Token in the "Password" field. |
| ALM |
URL, for example, http://localhost Project — the project code name. You can take it from the URL of project data pages, or from Settings — General Settings. API key for REST API authentication. You can get it on the Keys page in the profile of the user who will exchange the data. |
| Redmine |
URL, for example, https://redmine.openpne.jp Project — a unique project identifier, for example op3 HTTP headers. Copy the API key in Redmine (a separate key for each user) and place it after X-Redmine-API-Key: |
| YouTrack |
URL, for example, https://youtrack.jetbrains.com Project — a unique project identifier, for example JT User name and password for authentication. |
| Gitlab |
URL, for example, https://gitlab.com Project ID — the unique project identifier shown under the name on the project page: You can create an authentication token under User Settings, in the Access Tokens menu. To synchronize states and priorities, configure the correspondence between:
Because task priorities and states in Gitlab are defined by labels, you also need to store the list of labels. Create a custom attribute with the reference name GitlabLabels |
| TFS |
URL, for example https://instancename.visualstudio.com Project — the TFS project or collection name Personal token — can be generated in the TFS user profile settings |
Choose the synchronization direction. Start with "Read from the application". In this mode the integration does not change data in the external system.
For data to synchronize correctly, configure the mapping. The corresponding tab shows the mapping between ALM REST API and the REST API of the target system. To configure the mapping, you need to know what these APIs can do.