Welcome to Change Integration for Jira, integrating Subversion, Git and Mercurial with the Jira change management system.
This guide covers a typical installation and configuration of the product. For more detailed instructions, please refer to Server Administration or Java Client User Guide.
For a Linux installation, please replace all references to c:\Program Files with /opt (or /usr/local if you prefer) and use a terminal window where it refers to 'DOS' below.
Before you start please ensure you have the following set up and available:
Please note that Jira, Subversion, the Change Integration server and client can be located on any machine in the network, provided they can see each other through the network. However, there is no reason why the various elements cannot all be located on the same host, e.g. for evaluation purposes.
Evaluation licenses can be requested from the clearvision website: http://www.clearvision-cm.com
A link to the license request form for a product can be found on the product's download page. To request a license we need some information about the machine that you will be running the server on. To get this information, you can run the get_license_info program on the machine you want to use as the server (the get_license_info program can be found within the tools directory of the installation directory). This will retrieve and present system information from the machine.
Once the license request form has been completed and submitted, an email will be sent to the registered email address containing the license infomation. This information will need to be inserted into the server config file.
Note that this license will only work on a particular server machine, on a particular port, and will allow a maximum number of users. The license is time-limited so it is recommended that Evaluation licenses are not requested until needed.
Once a license has been purchased, you will receive an email containing a link to the online full license generator. A similar form will need to be filled in as for an evaluation license. Once the form has been completed and confirmed a full license will be emailed. Any evaluation license details in the config file will need to be replaced by the full license.
Licenses are tied to the hardware as well as the IP address of the machine used for the server. It is therefore necessary to ensure these details will not change as this will leave the license invalid.
License Request for Clearvision Jira2SVN:
Evaluation: yes/no
IP Address: 192.168.64.1
Port: 54322
MAC Address: 00-50-56-C0-00-05
Users: 50
Company: Your Company name here
Email Address: yourco@yourco.com
Expiry Date: 2008-03-31
Product: JIRA2SVN
The get_license_info executable is run from a Command Prompt.
Enable the XML-RPC and SOAP remote JIRA APIs as described in the Jira documentation. In summary the steps are as follows:
Create a filter to get the list of issues that would be relevant to a typical Change Integration user. For example, you could create a filter to return all outstanding bugs or features assigned to the 'Current User'.
Make sure that this filter is usable by everyone who will use Change Integration (for example by 'sharing' the filter to everyone).
Write down the id of the filter, which is a number such as '10001'. You can find the id at the end of the URL after creating a new filter or when viewing a filter.
Add a custom field (Administration tab->Custom Fields->Add a custom field) with the following settings:
Note the numerical part of the customer field id, something like 10010. You can find the id within the URL in your browser once you have created the field (e.g. fieldId=customfield_10010) or at the end of the URL when you edit the field.
Associate the field with the Default Screen.
Unpack the jira2svn zip file and copy the jira2svn.jar file from C:\Program Files\Clearvision\jira2svn\jira_plugin to your application server (eg WEB-INF\lib for Tomcat)
On your Change Integration Server machine:
[JIRA] filter_id=10010 jira2svn_custom_field_id=10000 jira_server=http://issues.mycompany.com:8080 [License] company_name=Your Company Plc licence_email=admin@yourcompany.com expiry_date=2008-12-31 users=999 license_key=PLEASE_ADD_YOUR_LICENCE_key_HERE license_certificate=PLEASE_ADD_YOUR_LICENCE_certificate_HERE [Server] server_ip=192.168.1.2 server_port=54322
cd c:\Program Files\Clearvision\jira2svn\server jira2svn_server.exe
On each of the machines used by Change Integration users:
Change Integration for Jira requires hooks to be installed on the repository server. You can integrate with Subversion, Git or Mercurial repositories.
On your Subversion and/or Git/Mercurial Server machine:
[Server] server_ip=192.168.1.2 server_port=54322
By now you should have:
You are now ready to test the system by committing a change to Subversion, Git or Mercurial.
On the machine that is running the Change Integration Client:
svn commit myfile.txt --username joe_bloggs
You should see the Change Integration client GUI popup to allow you to select the list of issues that were resolved by this change. Select one and select OK to close the popup window.
To check that Change Integration for Jira worked fully, open up the issue you selected and see the change note in the Jira2Svn tab of your issue. Then, in the case of Subversion, check the link back to JIRA by looking at the 'clearvision:change_id' revprop with this command:
svn proplist -rHEAD --verbose --revprop .
Copyright (c) 2011 Clearvision CM All Rights Reserved Registered in England No. 5643578 VAT Registration No. UK881364801 Registered Address Laurel Farm, Winters Hill, Durley Southampton, SO32 2AH