Installation and Configuration

Overview

The FBSG Sugar - JIRA Integration Application gives users the ability to monitor and track Jira issues from within the Sugar Ecosystem. CRM users can use dashboards and other standard Sugar tools to stay abreast of critical project developments from within Sugar, being able to look at issues by account, by type, and by priority. A Critical Issues Dashboard has been created for the Sugar home screen to allow users to be alerted when any issue becomes in danger of going over budget or past due.

Key Benefits

• CRM users now have complete visibility of project status by account without having to access JIRA.
• CRM users can enter issues through Sugar and have them update JIRA.
• Eliminate double entry of issues in both systems.
• CRM users have dashboard visibility of critical status issues.

Table of Contents

1. Installation
2. Configuration

1. Installation

Before installing Jira to your SugarCRM instance please make sure you have the following items at hand:

• FBSG_Sugar_-_JIRA_Integration-<version number>.zip

Please follow the steps in this guide to install the package.

2. Configuration

Note: You may have to log out and log back in order for the Sugar – JIRA Integration Control Panel to appear on the Admin screen (see the below screenshot).

 

 

1. Navigate to the Admin screen, scroll to the bottom, and click on the Sugar – JIRA Integration Control Panel.

 

Note: If you see a blank page instead of the Sugar – JIRA Integration Control Panel just click on the Back button in your browser and the Sugar – JIRA Integration Control Panel will load.

 

 

2. The Sugar – JIRA Integration Control Panel has three tabs:

• Basic Settings
• Mapping
• Advanced

 

 

3. In the Basic Settings tab enter your JIRA URL, User Name, Password/API Token, and the FBSG Product Key. Click on the Test button to test the connection, then click Save.

To retrieve your API token for Jira cloud users go to the following URL: API tokens - Atlassian account
Once there create an API token by clicking on the Create API Token button, when completed copy the token in the Password/API Token box.

 

Note: The URL must contain https://

Note: To retrieve your APO

 

 

4. The Mapping tab allows you to modify the mapping between JIRA and Sugar. You may send information from other Sugar modules linked to the JIRA Issues module to fields in JIRA.

 

 

Note: You can always revert back to the default field mapping by clicking on the Revert to Default Mapping button at the bottom of the Issue Mapping section.

 

 

5. The JIRA integration also allows JIRA Issues to be linked to an Account in Sugar using the Issue – Account Matching section at the bottom of the Mapping tab. The integration will, for example, link a JIRA issue with an account when the Sugar Account Name and JIRA Project Key are equal to each other.

 

Note: If you are NOT going to use the Account Matching feature you will need to make sure that there are NO fields in this section.

 

6. If there are custom fields in JIRA that you would like to use in Sugar you will need to click on the Retrieve button in the Custom Field Retrieval section at the top of the Mapping tab.

 

7. If at any point you want to return to using just the default JIRA fields just click on the Revert button in the Custom Field Retrieval section at the top of the Mapping tab.

 

8. If you make any changes in the Mapping tab you will need to click the Save button at the bottom for the changes to persist.

 

 

9. The Advanced tab has five additional settings that can help you manage your JIRA issues.

 

• The Don’t create issues in Sugar from JIRA checkbox when checked, will not sync any issues to Sugar that DO NOT already exist in Sugar. Issues that DO exist in Sugar will continue to be updated. This can be a useful feature if you have any issues in your JIRA instance that are not relevant to Sugar.
• The Create new JIRA tickets automatically from the JIRA Issues module in Sugar checkbox, if unchecked you will need to click on the Send to JIRA button.
• The Send updates to JIRA automatically when the ticket is updated in Sugar, if unchecked the integration will ask if you want to send an update.
• The Project Settings / Exclude Project from Sync checkbox setting will allow you to choose which projects you would like to exclude, or include, and their related issues. When the checkbox is checked additional settings will appear:

 

- The Only include select projects checkbox when checked, will set the integration to only Sync the selected project (instead of excluding them).

- In the Project Section you can select a project or multiple projects, and then click on the Add Project button to add it to the list to be either excluded or included in the JIRA issue sync.

 

• The Run Issue Sync Now button will run a JIRA issue sync and sync all JIRA issues based on your settings. This process may take a very long time depending on the number of issues you have in JIRA that are not synced with Sugar.

Note: This process is handled automatically by the Scheduler. You only need to manually Run a JIRA issue sync if you need the issues right away or after installing the integration.

Refer to pages 28 - 32 for more information on the Scheduler.

• The Last Sync Date will show the most recent Updated date retrieved from JIRA during the issue sync. If you would like to force a sync of older issues you may set this to a date in the past.The Sugar – JIRA Integration logs all interactions with JIRA and detailed information in the case of an error. If there are any problems with the sync one of the first things you will want to do is to change the Log Level to Info or Error.
• The Log Level dropdown menu has five settings (Fatal, Error, Warning, Info, and Debug) for which kind of log event to record. By default, the Log Level is set to Fatal.