EventQ Overview

TeamForge EventQ is a TeamForge capability that provides traceability for product life cycle activities such as work items, SCM commits, continuous integration (CI) builds, and code reviews.

Problem Statement and Solution

Organizations currently tend to have modern mixed-vendor, heterogeneous environments with complex lifecycles including work item, commit, review, build/test, deploy, and other tasks that are monitored or managed by stand-alone tools. The tools may be vendor-supplied or open-source, and may reside on-premises or in private, public, or hybrid clouds. These tools, however, lack the ability to associate with one another and do not lend themselves to end-to-end traceability: organizations cannot easily see the connections between activities derived from disparate lifecycle tools. Yet to achieve traceability, organizations are often forced to use an all-in-one, monolithic solution that excludes popular point tools. TeamForge EventQ offers a traceability solution that preserves the advantages of your best-of-breed tools.

While TeamForge EventQ is extensible, this version provides the following packaged adapters for connecting lifecycle activities:

Type of Service

Products

SCM/Version Control

Git, Subversion

Code Review

ReviewBoard, Gerrit

Build/Test

Jenkins

Issue Tracker

CollabNet TeamForge, Atlassian JIRA

TeamForge EventQ Vision

In a modern and frequently fractured development environment employing tools from different vendors, TeamForge EventQ aims to provide:
Aggregation — Using packaged adapters and an extensible architecture, TeamForge EventQ obtains and stores metadata about key lifecycle activities like work items, commits, builds/tests, and code reviews across vendors and platforms.
Traceability — TeamForge EventQ draws associations between activities across the entire lifecycle and enables traceability through the various steps or stages of the lifecycle.

Feature Overview

TeamForge EventQ aims to aggregate lifecycle metadata across various tools and establishes networks of associations across those lifecycle activities. The use cases for TeamForge EventQ include visibility into development activities, visibility into associations between lifecycle activities, and requirements traceability for auditing purposes.

Activity Streams: Activity streams provide a “project chronology” showing the most recent activities at the top and the oldest at the bottom. See Activity Stream for more information.

Extensibility

While TeamForge EventQ ships with some adapters, its extensibility ensures that users can write custom adapters to extend TeamForge EventQ to other work item trackers, version control, CI, and code review systems. New product classes may also be extended using Extensible Data Sources (XDS). See Extend TeamForge EventQ for more information.

Install or Upgrade TeamForge-EventQ Integartion

You can install EventQ on the TeamForge Application Server or on a separate server. For more information about installing and upgrading EventQ, see TeamForge install and upgrade instructions.

SCM Commits in TeamForge with EventQ Integration

Consider the following while integrating TeamForge and EventQ.

Uploading the Event Handler JAR File

After adding EventQ to your site, it is mandatory to upload the custom event handler JAR file to get the pre and post commit notifications. Click here for steps to add a custom event handler.

Implications of TeamForge-EventQ Integration on SCM Commits and Associations

Pre and post commit notifications will be sent from TeamForge to EventQ only if the Association Required on Commit is enabled for the repository and if the require-scm-integration is set to true for the EventQ application.

Post TeamForge-EventQ integration, SCM commits will fail in TeamForge if all the following conditions are true and if the EventQ application is down or if there are errors while processing the commit request (on the EventQ’s side):

The Association Required on Commit is enabled for a repository.

The require-scm-integration is set to true.

The commit message contains the integrated application’s ID. In other words, the EventQ application’s ID in this case.

SCM commits can also fail if the custom event handler exists in the TeamForge even after the removal of the EventQ application from the TeamForge site. It is highly recommended to remove the custom event handler once you remove the EventQ application.