ReadMe for Borland Connect – Jira sample connector

• Version: @Connect_buildnumber.
• Last Updated: September 24, 2014

Please refer to the Borland Community and Borland Connect Release Notes for further configuration instructions.

This connector requires at least build 1.0.3.45 of Borland Connect. The latest version of Borland Connect can be downloaded from Micro Focus SupportLine (http://supportline.microfocus.com).

Required Libraries

All of the below files, along with the JiraConnector.jar file, must be copied to the root folder of the Borland Connect installation in order for the Jira Connector to execute.  When installing this, remove the existing httpclient-4.2.1.jar file. The one provided by Atlassian below (httpclient-4.2.1-atlassian-2.jar) will work with the Rally Connector, but provides extra needed functionality for the Jira Connector.

The following jar files are provided by Atlassian.

• atlassian-event-2.2.0.jar
• atlassian-httpclient-apache-httpcomponents-0.13.2.jar
• atlassian-httpclient-api-0.13.2.jar
• atlassian-httpclient-spi-0.13.2.jar
• atlassian-util-concurrent-2.4.0-M9.jar
• httpasyncclient-4.0-beta3-atlassian-1.jar
• httpasyncclient-cache-4.0-beta3-atlassian-1.jar
• httpclient-4.2.1-atlassian-2.jar
• httpclient-cache-4.2.1-atlassian-2.jar
• jira-rest-java-client-api-2.0.0-m19.jar
• jira-rest-java-client-core-2.0.0-m19.jar

These jar files can be found on the central maven, http://search.maven.org/ and easily found by searching for the specific name and version of each Jar file.

• activation-1.1.jar
• aopalliance-1.0.jar
• commons-codec-1.6.jar
• commons-lang-2.4.jar
• commons-logging-1.1.1.jar
• guava-10.0.1.jar
• httpcore-4.2.2.jar
• httpcore-nio-4.2.2.jar
• httpmime-4.1.2.jar
• jackson-core-asl-1.5.5.jar
• jackson-jaxrs-1.5.5.jar
• jackson-mapper-asl-1.5.5.jar
• jackson-xc-1.5.5.jar
• jaxb-api-2.2.2.jar
• jaxb-impl-2.2.3.jar
• jersey-client-1.5.jar
• jersey-core-1.5.jar
• jersey-json-1.5.jar
• jettison-1.1.jar
• joda-time-1.6.jar
• jsr305-1.3.9.jar
• sal-api-2.7.0.jar
• slf4j-api-1.6.4.jar
• spring-beans-2.5.6.jar
• spring-context-2.5.6.jar
• spring-core-2.5.6.jar
• stax-api-1.0-2.jar
• stax-api-1.0.1.jar

Alternatively, Maven can be used to gather all of the dependencies quickly. To do so:

1. Download and install Maven.
2. The POM.xml file is supplied with the Jira connector.  Put this in any directory on the machine with Maven installed. 
3. Open a Command line, navigate to the directory with the POM.xml file, and run the following command: mvn  dependency:copy-dependencies

This will download all of the dependencies automatically and place them in the ./target/dependencies directory from where the command was run.

Required Connection Information

In order to use this connector, you will need to collect and enter this information in the Borland Connect user interface or in the <datasource> element in the Connect.xml file:

• Name - Borland Hub option. Enter a unique name for the data source.
• Product - Borland Hub option. Select the data source product name.
• TimeOffset - Borland Hub option. Number of seconds the data source time differs from the Borland Connect process time.
• User - Enter the user name.
• Password - Enter the password for the user.
• URL - Enter the Jira URL to connect to.

The Connector maps Jira Epics and Jira Stories into StarTeam stories and uses the value of the StoryType property in the StarTeam story to logically separate the different types. The Borland Hub Sync Criteria for mappings StarTeam stories to Jira Stories should be:

The Borland Hub Sync Criteria for mappings StarTeam stories to Jira Epics should be:

Known Limitations

• Jira Sprints must be owned and updated by Jira.  They are not bi-directional.
• Changing of IssueTypes (e.g. from a Story to an Epic in Jira) is not currently supported.
• All required fields, as setup in the Jira Issue Type schema, must be mapped and values filled in before a Jira item may be created.
• In order to update a field, that field must be setup on a Jira Screen.
• Required Jira permissions:
  • Create issue.
  • Update rights to an issue.
  • Browse users that can view issues for a given project.
  • For Sprints, the Sync User must have rights to read sprints.
• For Agile items, such as sprints, the Agile Board name must be specified in Connect.xml. In the project mapping for the Jira Project, the format is <Project Key>:<AgileBoardName>, without the angle brackets.
• For IssueTypes, Rank is not a syncable field because the value is internal to Jira to establish a relative rank.
• Borland Connect does not verify that the mapped types are supported by the selected project/board pair.