Integration with Team Support
TeamSupport.com is an integrated tool to manage customer service, product management, and bug/feature tracking. Beanstalk provides integration with TeamSupport so that each commit can be associated with one or more tickets in TeamSupport.
Once configured, when a new version is “committed” to Beanstalk, the tickets which that version addresses will have a new action associated with them that shows the version of software the ticket was addressed in, and a link to view the actual changes in code which happened in that version (note that you will have to have a Beanstalk account to view the code).
- Log into Beanstalk and browse to your repository, then select Setup -> Integration -> WebHooks.
- Click on Web Hooks, then on “Activate”
The Account URL you enter should look something like this:
What do each of these mean?
This is the URL of the service which communicates with Beanstalk. Whenever code is committed to Beanstalk, a message is sent (called a “WebHook”) to this address and TeamSupport processes it.
This is your company’s organization ID within TeamSupport. You can find it in the Admin-My Company page of TeamSupport and is typically a 4 to 5 digit number.
Each different repository in Beanstalk needs to be associated with a Product in TeamSupport. Each specific product in TeamSupport has a unique ProductID that goes with it. You can find this by going to Reports in TeamSupport and selecting the “Product List”. This will list all of your products and their ProductIDs.
This field is optional, but when implemented is highly useful. This is the link to the Repository in Beanstalk which houses this product, and will allow you to click on a hyperlink in an action within the ticket to view the source code in BeanStalk.
Typically the repository location will look something like:
- CCCC will be your company name that you login to BeanStalk with. For example, if you go to “mycompany.beanstalkapp.com” to get to your repository, then use “mycompany” here.
- PPPP is your product name In BeanStalk.
The easiest way to get the value for RepositoryLocation is simply to go to Beanstalk and click on a repository “changeset”. Copy the URL, minus the number at the end, and past that at the end of your webhook URL.
Please note that the trailing slash (“/”) should be included.
Once you have entered the WebHook, click “Confirm”, then review the WebHook and press the “Activate!” button.
Using the Integration
When you do a source commit, that information is sent from Beanstalk to TeamSupport. TeamSupport then parses the commit “description” text looking for certain keywords. The two primary keywords are “Version:” and “Tickets:”.
The Version keyword allows TeamSupport to associate the commit to a specific version, and the Tickets keyword is used to associate the ticket numbers.
A version keyword should look like:
Note the square brackets and the colon. In this case the version is “1.2a1” and will be associated with the commit.
The Tickets keyword looks like this:
Again, note the square brackets and the colon. Multiple tickets can be associated with a given commit, and in this example there are three. Each ticket needs to be separated by a comma.
What will you see in TeamSupport?
When you associate a commit with a particular ticket, a new action will be added as part of that ticket in TeamSupport. The action will look something like this:
This shows you who did the commit in Beanstalk, the time and date of the commit, and the revision and version numbers.
Also note that clicking on the hyperlink will take you directly to the changeset in Beanstalk so you can review the code changes made to fix this problem (assuming you have the correct login rights into Beanstalk).
If you need any assistance with the Beanstalk/TeamSupport integration, please call or e-mail the TeamSupport support group.