Synchronization Workitems JIRA V1 - techtalk/SpecLog-Resources GitHub Wiki

Warning: SpecLog provides two different plugins for synchronising issues with JIRA. Migrating from SpecLog.JiraPlugin.V1 to SpecLog.JiraPlugin.V2 is currently unsupported. If you have a project using the SpecLog.JiraPlugin.V1, do not change the JIRA plugin to SpecLog.JiraPlugin.V2. Support for migrating between plugin versions is planned in a future release.

The synchronisation requires the following core fields in the template:

• Summary: Synchronised with the field specified as the header in the card template (only SpecLog -> JIRA)
• Description: Synchronised with the fields and prefixes specified in the card template to be displayed on the card (only SpecLog -> JIRA)
• Original Estimate: Synchronised with the estimate specified for the requirement (SpecLog -> JIRA and JIRA -> SpecLog)
• Remaining Estimate: Synchronised with the estimate specified for the requirement (only SpecLog -> JIRA, updates in JIRA are NOT synchronised back to SpecLog)
• Labels: Synchronised with the tags specified for the requirement (SpecLog -> JIRA and JIRA -> SpecLog)

For example, a requirement synchronized to an issue looks like this in the JIRA client:

To configure the service:

1. Copy the service plugin assembly to the server's /Plugins folder (note: JIRA plugins are already there after installation).
2. Select Manage Repositories from the menu and connect to the server.
3. Select Configure plugins for the repository you want to synchronize work items with:
   
4. Select Configure for the plugin you want to configure from the menu on the right:
   
5. Enter the necessary information to allow the service to access the JIRA project:
   
6. Create the association link type in JIRA (see below).

• "Server URL": the base URL of the JIRA service
• "Project code": the JIRA Key of the project (project page: Summary, Description - Key)
• "Issue type": the type of the issue, SpecLog requirements should be synchronized to (e.g. Story, which exists already in JIRA)
• "Link type": association link type (use any existing link type, e.g. Relates, or see below how a new type Refinement can be created for the project)
• "User name": the user name and password, which the plugin will use to connect to JIRA. Read the notes below regarding required permissions.
• "Update interval": interval in minutes, which the plugin uses for synchronizing changes back from JIRA into SpecLog. See Workitem Synchronization Mechanism for further details.
• "User name": the synchronizing user (needs to have jira-developers membership for the project)

Requirement relationhips in SpecLog (parents, refinements) are synchronised as issue links in JIRA. You can either use an existing JIRA link type (e.g. `Relates'), or create a new JIRA link type in JIRA, as follows:

1. Log in as admin, and open "JIRA Administration - System".
2. Under "General Configuration/Issue Features" select "Issue Linking".
3. Add a new Link type with Name=Refinement, Outward Link Description=refined by, Inward Link Description=is based on

The user used by the plugin to perform the synchronisation with JIRA should have jira-developers membership for the project.