JIRA & Swiftkanban Integration

SwiftSync (Integration manager) service installation

http://www.opshub.com/main/index.php/products/oim

6.9 JIRA

It is mandatory to have Jira Remote API Calls enabled to access Jira web service API. Refer appendix Enable Remote API

1. Create one user of Jira System, dedicated to OpsHub Integration Manager. User should not be used to do any operations from System’s User-Interface.

2. User should be member of following groups:

• jira-developers
• jira-users

The OpsHub OIM manager requires one special field to be defined on the entity that is being synchronized. These must be set up so that OpsHub can track the integration status of each item:

For Version >= 5.0 and <6.2

• Property Name Type

• OH_Created_By Text Field (< 255 characters)

6.9.1.5 Jira Field Mapping Precaution

It is imperative to map only those fields(both system and custom) while creating field mapping which are visible on the screen at the time of creating/editing an issue on Jira UI, because even though it might appear in the list of fields provided for mapping, it might result into an erroneous situation once the integration starts. Fields which are exception to the above precaution are “Status” and “Resolution” which can be mapped at the time of issue creation.

6.9.2 System Configuration

OIM Integration Configuration requires Systems to be created on which synchronization should be done. User can also create systems from Administration -> System Configuration ->Create System. This section shows Jira System
Configuration steps in detail. Following are steps to create Jira System:

1. Set System Name to name you would like to give. Note, System Name should be unique.

2. Set Version to version of Jira instance you want to integrate. E.g. 6.0, 6.1, 6.2. For more details please refer appendix section Find Version.

3. Set Enable OIM to Yes.

4. Select Access To Jira Database?  NO

6. Set Jira Web Service URL to the base URL of JIRA instance https://jira.example.com/rpc/soap/jirasoapservice-v2

7. Set Jira User Name and Jira User Password to the user that has administrative privilege to access Jira web services.

6.9.3.1 Jira As Source System

Default Integration Parameters

1. Select JIRA Project(s) To Sync to the projects of which entities you want to synchronize by selecting it from the dialog by clicking “Select Project(s)”.
2. Set Jira Entity Type (Type of Issue) to which you want to synchronize.
3. Set Start Polling Time to a date in the near or recent past. OpsHub integration will use this as the start date for when data will be pulled over from the source system. Polling Time should be as per Jira Server Time Zone. To find Jira Server Time zone refer appendix Find Jira Time zone.

Advance Configuration Parameters

Advance Configuration is required in highly customized integration mode. To override source system’s parameters for read operation, open Source Configuration tab inside Advance Configuration on integration form.

1. Override Parameters For Read Operations

• a. Set the Jira User Name, Jira User Password to the user who will be used in the synchronization process.
  NOTE: Make sure this user has appropriate security privileges to the selected entities on Jira. These parameters are not required if you want to use same user that is given at time of system configuration.
• b. Set Maximum Retry Count to number of times OIM failed event should be retried. Preferable range is 1-5. If not set, by default it will be set to 3.

2. Other Configurations

• a. Set ‘Configure Criteria’ to as per requirement of Integration. If you want to configure criteria, then set this option as ‘Yes’ and refer topic Criteria Configuration under Appendix.
• b. Sync Confirmation automatically sets synchronization status of entity in custom field of source system, if sync is successful. To enable this functionality, select Sync Confirmation Field Name from drop down, displaying the custom fields of type text/html.
• c. Select Associate Schedule from the drop down list to a polling time that you are comfortable with.
• d. Select appropriate choice from ‘Both (Failed and New events)’, ‘New Events’ and ‘Failed Events’ in ‘Sync’. We recommend to configure integration with ‘Both (Failed and New events)‘ option, as it will synchronized both new & failed events.

3. Override Parameters For Write Operations

• a. Set the Jira User Name and Jira User Password to the user who will be used in the sync process to write to Jira system.
  NOTE: Make sure this user has appropriate security privileges to the selected entities on Jira. These parameters are not required if you want to use same user that is given at time of system configuration.
• b. Select Remote Entity Link Field Name from the drop down containing display name of custom fields of type text/html in the system. Refer Custom Field section, to know how to create custom fields. Note: This field will contain the URL of the entity created/updated in destination system.

6.9.3.1 Jira As Destination System

Default Integration Parameters

1. Select JIRA Project Name to the project of which entities you want to synchronize.
2. Select JIRA Issue Type to the SmartBear issue you want to synchronize during integration.

Advance Configuration Parameters

Advance Configuration is required in highly customized integration mode. To override destination system’s parameters for write operation, open Destination Configuration tab inside Advance Configuration on integration form

1. Override Parameters for Write Operations
   1. Set the Jira User Name and Jira User Password to the user who will be used in the sync process to write to Jira system.
      NOTE: Make sure this user has appropriate security privileges to the selected entities on Jira. These parameters are not required if you want to use same user that is given at time of system configuration.
   2. Jira Workflow will appear only if you don’t have access to Jira database (based on Jira system configured through system configuration). Select the ‘Browse…’ button and select the downloaded JIRA workflow file. And now press the ‘Upload’ button. (Is the XML of the Workflow)
      NOTE: Please refer appendix section Download Jira Workflow for details on how to download workflow
   3. Select Remote Entity Link Field Name from the drop down containing display name of custom fields of type text/html in the system. Refer Custom Field section, to know how to create custom fields.
      Note: This field will contain the URL of the entity created/updated in source system.
   4. Press the Save button

9.3.8 JIRA Checklist

System Configuration
1. If “Do you have access to jira database?” Field is enabled then create the database connection for Jira system by following the steps mentioned under Database Configuration and select that database connection for Database Connection input.
Integration Configuration
1. Appropriate projects should be selected from the List box, if All Projects option is set to No. These projects will be used for synchronization process.
2. In integration configuration, if destination system is Jira without database, then Jira Status workflow should be uploaded which is available from Jira system itself