Collaborator provides advanced support for JIRA issue-tracking and Team Foundation Server work item systems, giving you the possibility to easily integrate these products into your work processes. It automatically synchronizes reviews and the issues/work items addressed in those reviews, appends the issues to the review's Remote System Links section and retrieves the item's current status.
For other issue-tracking systems, your Collaborator administrator should establish integration as described in General Approach to Issue-Tracking Integrations.
Setup and configure integration - Your Collaborator administrator should create a new Remote System Integration configuration for your issue-tracking/work item system. The configuration defines what server to use, access credentials, list of projects to track and so on. Each single configuration instance tracks changes on a single server. To track multiple issue-tracker/work item servers, your administrators should create a separate configuration for each server. For detailed instructions on how to setup integration, see Configuring Issue-Tracking Integrations.
Collaborator checks if the uploaded review materials are associated with any tickets/work items. Depending on system, Collaborator either retrieves this information from the changelist service data or parses review title, custom fields, changelist comments, comments and defects to match ticket/work item identifiers.
Once Collaborator finds that the review materials are associated with some ticket or work item, it performs the following:
Item statuses in the Remote System Links are updated upon webhook events (if a remote system supports webhooks), or periodically (default interval is every 2 minutes and can be adjusted via VM option).
The Project List field of JIRA configurations can contain up to 2000 characters, whereas for JIRA (Legacy) configurations it can contain only 255 characters.
Connections established by JIRA integrations do respect proxy settings if they are specified for Collaborator server.
Team Foundation Server work items do not have unique identifier except for their ordinal number. Because of this, Collaborator cannot determine work item identifiers within review's text fields (title, custom fields, comments and others) and, consequently, cannot automatically convert them into hyperlinks.
Currently, creating tickets for external defects is only available for JIRA issue-tracking systems.
When creating tickets for external defects on JIRA servers, the dialog may display additional fields depending on server's custom fields configuration. Currently, integration is able to retrieve and display standard custom fields. Advanced custom fields are not supported yet. If advanced custom fields are mandatory for creating new tickets, Collaborator will fail to create it.
This topic describes general approach to integration with any issue-tracking system. Integration can be done in several ways depending on your needs.